init.c

   1 /*
   2  * This file contains job initialization and setup functions.
   3  */
   4 #include <stdio.h>
   5 #include <stdlib.h>
   6 #include <unistd.h>
   7 #include <ctype.h>
   8 #include <string.h>
   9 #include <errno.h>
  10 #include <sys/ipc.h>
  11 #include <sys/types.h>
  12 #include <dlfcn.h>
  13 #ifdef CONFIG_VALGRIND_DEV
  14 #include <valgrind/drd.h>
  15 #else
  16 #define DRD_IGNORE_VAR(x) do { } while (0)
  17 #endif
  18
  19 #include "fio.h"
  20 #ifndef FIO_NO_HAVE_SHM_H
  21 #include <sys/shm.h>
  22 #endif
  23
  24 #include "parse.h"
  25 #include "smalloc.h"
  26 #include "filehash.h"
  27 #include "verify.h"
  28 #include "profile.h"
  29 #include "server.h"
  30 #include "idletime.h"
  31 #include "filelock.h"
  32 #include "steadystate.h"
  33 #include "blktrace.h"
  34
  35 #include "oslib/asprintf.h"
  36 #include "oslib/getopt.h"
  37 #include "oslib/strcasestr.h"
  38
  39 #include "crc/test.h"
  40 #include "lib/pow2.h"
  41 #include "lib/memcpy.h"
  42
  43 const char fio_version_string[] = FIO_VERSION;
  44
  45 #define FIO_RANDSEED            (0xb1899bedUL)
  46
  47 static char **ini_file;
  48 static bool dump_cmdline;
  49 static bool parse_only;
  50 static bool merge_blktrace_only;
  51
  52 static struct thread_data def_thread;
  53 struct thread_segment segments[REAL_MAX_SEG];
  54 static char **job_sections;
  55 static int nr_job_sections;
  56
  57 bool exitall_on_terminate = false;
  58 int output_format = FIO_OUTPUT_NORMAL;
  59 int eta_print = FIO_ETA_AUTO;
  60 unsigned int eta_interval_msec = 1000;
  61 int eta_new_line = 0;
  62 FILE *f_out = NULL;
  63 FILE *f_err = NULL;
  64 char *exec_profile = NULL;
  65 int warnings_fatal = 0;
  66 int terse_version = 3;
  67 bool is_backend = false;
  68 bool is_local_backend = false;
  69 int nr_clients = 0;
  70 bool log_syslog = false;
  71
  72 bool write_bw_log = false;
  73 bool read_only = false;
  74 int status_interval = 0;
  75
  76 char *trigger_file = NULL;
  77 long long trigger_timeout = 0;
  78 char *trigger_cmd = NULL;
  79 char *trigger_remote_cmd = NULL;
  80
  81 char *aux_path = NULL;
  82
  83 static int prev_group_jobs;
  84
  85 unsigned long fio_debug = 0;
  86 unsigned int fio_debug_jobno = -1;
  87 unsigned int *fio_debug_jobp = NULL;
  88 unsigned int *fio_warned = NULL;
  89
  90 static char cmd_optstr[256];
  91 static bool did_arg;
  92
  93 #define FIO_CLIENT_FLAG         (1 << 16)
  94
  95 /*
  96  * Command line options. These will contain the above, plus a few
  97  * extra that only pertain to fio itself and not jobs.
  98  */
  99 static struct option l_opts[FIO_NR_OPTIONS] = {
 100         {
 101                 .name           = (char *) "output",
 102                 .has_arg        = required_argument,
 103                 .val            = 'o' | FIO_CLIENT_FLAG,
 104         },
 105         {
 106                 .name           = (char *) "latency-log",
 107                 .has_arg        = required_argument,
 108                 .val            = 'l' | FIO_CLIENT_FLAG,
 109         },
 110         {
 111                 .name           = (char *) "bandwidth-log",
 112                 .has_arg        = no_argument,
 113                 .val            = 'b' | FIO_CLIENT_FLAG,
 114         },
 115         {
 116                 .name           = (char *) "minimal",
 117                 .has_arg        = no_argument,
 118                 .val            = 'm' | FIO_CLIENT_FLAG,
 119         },
 120         {
 121                 .name           = (char *) "output-format",
 122                 .has_arg        = required_argument,
 123                 .val            = 'F' | FIO_CLIENT_FLAG,
 124         },
 125         {
 126                 .name           = (char *) "append-terse",
 127                 .has_arg        = optional_argument,
 128                 .val            = 'f',
 129         },
 130         {
 131                 .name           = (char *) "version",
 132                 .has_arg        = no_argument,
 133                 .val            = 'v' | FIO_CLIENT_FLAG,
 134         },
 135         {
 136                 .name           = (char *) "help",
 137                 .has_arg        = no_argument,
 138                 .val            = 'h' | FIO_CLIENT_FLAG,
 139         },
 140         {
 141                 .name           = (char *) "cmdhelp",
 142                 .has_arg        = optional_argument,
 143                 .val            = 'c' | FIO_CLIENT_FLAG,
 144         },
 145         {
 146                 .name           = (char *) "enghelp",
 147                 .has_arg        = optional_argument,
 148                 .val            = 'i' | FIO_CLIENT_FLAG,
 149         },
 150         {
 151                 .name           = (char *) "showcmd",
 152                 .has_arg        = no_argument,
 153                 .val            = 's' | FIO_CLIENT_FLAG,
 154         },
 155         {
 156                 .name           = (char *) "readonly",
 157                 .has_arg        = no_argument,
 158                 .val            = 'r' | FIO_CLIENT_FLAG,
 159         },
 160         {
 161                 .name           = (char *) "eta",
 162                 .has_arg        = required_argument,
 163                 .val            = 'e' | FIO_CLIENT_FLAG,
 164         },
 165         {
 166                 .name           = (char *) "eta-interval",
 167                 .has_arg        = required_argument,
 168                 .val            = 'O' | FIO_CLIENT_FLAG,
 169         },
 170         {
 171                 .name           = (char *) "eta-newline",
 172                 .has_arg        = required_argument,
 173                 .val            = 'E' | FIO_CLIENT_FLAG,
 174         },
 175         {
 176                 .name           = (char *) "debug",
 177                 .has_arg        = required_argument,
 178                 .val            = 'd' | FIO_CLIENT_FLAG,
 179         },
 180         {
 181                 .name           = (char *) "parse-only",
 182                 .has_arg        = no_argument,
 183                 .val            = 'P' | FIO_CLIENT_FLAG,
 184         },
 185         {
 186                 .name           = (char *) "section",
 187                 .has_arg        = required_argument,
 188                 .val            = 'x' | FIO_CLIENT_FLAG,
 189         },
 190 #ifdef CONFIG_ZLIB
 191         {
 192                 .name           = (char *) "inflate-log",
 193                 .has_arg        = required_argument,
 194                 .val            = 'X' | FIO_CLIENT_FLAG,
 195         },
 196 #endif
 197         {
 198                 .name           = (char *) "alloc-size",
 199                 .has_arg        = required_argument,
 200                 .val            = 'a' | FIO_CLIENT_FLAG,
 201         },
 202         {
 203                 .name           = (char *) "profile",
 204                 .has_arg        = required_argument,
 205                 .val            = 'p' | FIO_CLIENT_FLAG,
 206         },
 207         {
 208                 .name           = (char *) "warnings-fatal",
 209                 .has_arg        = no_argument,
 210                 .val            = 'w' | FIO_CLIENT_FLAG,
 211         },
 212         {
 213                 .name           = (char *) "max-jobs",
 214                 .has_arg        = required_argument,
 215                 .val            = 'j' | FIO_CLIENT_FLAG,
 216         },
 217         {
 218                 .name           = (char *) "terse-version",
 219                 .has_arg        = required_argument,
 220                 .val            = 'V' | FIO_CLIENT_FLAG,
 221         },
 222         {
 223                 .name           = (char *) "server",
 224                 .has_arg        = optional_argument,
 225                 .val            = 'S',
 226         },
 227         {       .name           = (char *) "daemonize",
 228                 .has_arg        = required_argument,
 229                 .val            = 'D',
 230         },
 231         {
 232                 .name           = (char *) "client",
 233                 .has_arg        = required_argument,
 234                 .val            = 'C',
 235         },
 236         {
 237                 .name           = (char *) "remote-config",
 238                 .has_arg        = required_argument,
 239                 .val            = 'R',
 240         },
 241         {
 242                 .name           = (char *) "cpuclock-test",
 243                 .has_arg        = no_argument,
 244                 .val            = 'T',
 245         },
 246         {
 247                 .name           = (char *) "crctest",
 248                 .has_arg        = optional_argument,
 249                 .val            = 'G',
 250         },
 251         {
 252                 .name           = (char *) "memcpytest",
 253                 .has_arg        = optional_argument,
 254                 .val            = 'M',
 255         },
 256         {
 257                 .name           = (char *) "idle-prof",
 258                 .has_arg        = required_argument,
 259                 .val            = 'I',
 260         },
 261         {
 262                 .name           = (char *) "status-interval",
 263                 .has_arg        = required_argument,
 264                 .val            = 'L' | FIO_CLIENT_FLAG,
 265         },
 266         {
 267                 .name           = (char *) "trigger-file",
 268                 .has_arg        = required_argument,
 269                 .val            = 'W',
 270         },
 271         {
 272                 .name           = (char *) "trigger-timeout",
 273                 .has_arg        = required_argument,
 274                 .val            = 'B',
 275         },
 276         {
 277                 .name           = (char *) "trigger",
 278                 .has_arg        = required_argument,
 279                 .val            = 'H',
 280         },
 281         {
 282                 .name           = (char *) "trigger-remote",
 283                 .has_arg        = required_argument,
 284                 .val            = 'J',
 285         },
 286         {
 287                 .name           = (char *) "aux-path",
 288                 .has_arg        = required_argument,
 289                 .val            = 'K',
 290         },
 291         {
 292                 .name           = (char *) "merge-blktrace-only",
 293                 .has_arg        = no_argument,
 294                 .val            = 'A' | FIO_CLIENT_FLAG,
 295         },
 296         {
 297                 .name           = NULL,
 298         },
 299 };
 300
 301 void free_threads_shm(void)
 302 {
 303         int i;
 304
 305         for (i = 0; i < nr_segments; i++) {
 306                 struct thread_segment *seg = &segments[i];
 307
 308                 if (seg->threads) {
 309                         void *tp = seg->threads;
 310 #ifndef CONFIG_NO_SHM
 311                         struct shmid_ds sbuf;
 312
 313                         seg->threads = NULL;
 314                         shmdt(tp);
 315                         shmctl(seg->shm_id, IPC_RMID, &sbuf);
 316                         seg->shm_id = -1;
 317 #else
 318                         seg->threads = NULL;
 319                         free(tp);
 320 #endif
 321                 }
 322         }
 323
 324         nr_segments = 0;
 325         cur_segment = 0;
 326 }
 327
 328 static void free_shm(void)
 329 {
 330 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 331         if (nr_segments) {
 332                 flow_exit();
 333                 fio_debug_jobp = NULL;
 334                 fio_warned = NULL;
 335                 free_threads_shm();
 336         }
 337
 338         free(trigger_file);
 339         free(trigger_cmd);
 340         free(trigger_remote_cmd);
 341         trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
 342
 343         options_free(fio_options, &def_thread.o);
 344         fio_filelock_exit();
 345         file_hash_exit();
 346         scleanup();
 347 #endif
 348 }
 349
 350 static int add_thread_segment(void)
 351 {
 352         struct thread_segment *seg = &segments[nr_segments];
 353         size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
 354         int i;
 355
 356         if (nr_segments + 1 >= REAL_MAX_SEG) {
 357                 log_err("error: maximum number of jobs reached.\n");
 358                 return -1;
 359         }
 360
 361         size += 2 * sizeof(unsigned int);
 362
 363 #ifndef CONFIG_NO_SHM
 364         seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
 365         if (seg->shm_id == -1) {
 366                 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
 367                         perror("shmget");
 368                 return -1;
 369         }
 370 #else
 371         seg->threads = malloc(size);
 372         if (!seg->threads)
 373                 return -1;
 374 #endif
 375
 376 #ifndef CONFIG_NO_SHM
 377         seg->threads = shmat(seg->shm_id, NULL, 0);
 378         if (seg->threads == (void *) -1) {
 379                 perror("shmat");
 380                 return 1;
 381         }
 382         if (shm_attach_to_open_removed())
 383                 shmctl(seg->shm_id, IPC_RMID, NULL);
 384 #endif
 385
 386         nr_segments++;
 387
 388         memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
 389         for (i = 0; i < JOBS_PER_SEG; i++)
 390                 DRD_IGNORE_VAR(seg->threads[i]);
 391         seg->nr_threads = 0;
 392
 393         /* Not first segment, we're done */
 394         if (nr_segments != 1) {
 395                 cur_segment++;
 396                 return 0;
 397         }
 398
 399         fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
 400         *fio_debug_jobp = -1;
 401         fio_warned = fio_debug_jobp + 1;
 402         *fio_warned = 0;
 403
 404         flow_init();
 405         return 0;
 406 }
 407
 408 /*
 409  * The thread areas are shared between the main process and the job
 410  * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
 411  * segment has no more room, add a new chunk.
 412  */
 413 static int expand_thread_area(void)
 414 {
 415         struct thread_segment *seg = &segments[cur_segment];
 416
 417         if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
 418                 return 0;
 419
 420         return add_thread_segment();
 421 }
 422
 423 static void dump_print_option(struct print_option *p)
 424 {
 425         const char *delim;
 426
 427         if (!strcmp("description", p->name))
 428                 delim = "\"";
 429         else
 430                 delim = "";
 431
 432         log_info("--%s%s", p->name, p->value ? "" : " ");
 433         if (p->value)
 434                 log_info("=%s%s%s ", delim, p->value, delim);
 435 }
 436
 437 static void dump_opt_list(struct thread_data *td)
 438 {
 439         struct flist_head *entry;
 440         struct print_option *p;
 441
 442         if (flist_empty(&td->opt_list))
 443                 return;
 444
 445         flist_for_each(entry, &td->opt_list) {
 446                 p = flist_entry(entry, struct print_option, list);
 447                 dump_print_option(p);
 448         }
 449 }
 450
 451 static void fio_dump_options_free(struct thread_data *td)
 452 {
 453         while (!flist_empty(&td->opt_list)) {
 454                 struct print_option *p;
 455
 456                 p = flist_first_entry(&td->opt_list, struct print_option, list);
 457                 flist_del_init(&p->list);
 458                 free(p->name);
 459                 free(p->value);
 460                 free(p);
 461         }
 462 }
 463
 464 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
 465 {
 466         struct flist_head *entry;
 467
 468         if (flist_empty(&src->opt_list))
 469                 return;
 470
 471         flist_for_each(entry, &src->opt_list) {
 472                 struct print_option *srcp, *dstp;
 473
 474                 srcp = flist_entry(entry, struct print_option, list);
 475                 dstp = malloc(sizeof(*dstp));
 476                 dstp->name = strdup(srcp->name);
 477                 if (srcp->value)
 478                         dstp->value = strdup(srcp->value);
 479                 else
 480                         dstp->value = NULL;
 481                 flist_add_tail(&dstp->list, &dst->opt_list);
 482         }
 483 }
 484
 485 /*
 486  * Return a free job structure.
 487  */
 488 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
 489                                        bool preserve_eo, const char *jobname)
 490 {
 491         struct thread_segment *seg;
 492         struct thread_data *td;
 493
 494         if (global)
 495                 return &def_thread;
 496         if (expand_thread_area()) {
 497                 log_err("error: failed to setup shm segment\n");
 498                 return NULL;
 499         }
 500
 501         seg = &segments[cur_segment];
 502         td = &seg->threads[seg->nr_threads++];
 503         thread_number++;
 504         *td = *parent;
 505
 506         INIT_FLIST_HEAD(&td->opt_list);
 507         if (parent != &def_thread)
 508                 copy_opt_list(td, parent);
 509
 510         td->io_ops = NULL;
 511         td->io_ops_init = 0;
 512         if (!preserve_eo)
 513                 td->eo = NULL;
 514
 515         td->o.uid = td->o.gid = -1U;
 516
 517         dup_files(td, parent);
 518         fio_options_mem_dupe(td);
 519
 520         profile_add_hooks(td);
 521
 522         td->thread_number = thread_number;
 523         td->subjob_number = 0;
 524
 525         if (jobname)
 526                 td->o.name = strdup(jobname);
 527
 528         if (!parent->o.group_reporting || parent == &def_thread)
 529                 stat_number++;
 530
 531         return td;
 532 }
 533
 534 static void put_job(struct thread_data *td)
 535 {
 536         if (td == &def_thread)
 537                 return;
 538
 539         profile_td_exit(td);
 540         flow_exit_job(td);
 541
 542         if (td->error)
 543                 log_info("fio: %s\n", td->verror);
 544
 545         fio_options_free(td);
 546         fio_dump_options_free(td);
 547         if (td->io_ops)
 548                 free_ioengine(td);
 549
 550         if (td->o.name)
 551                 free(td->o.name);
 552
 553         memset(td, 0, sizeof(*td));
 554         segments[cur_segment].nr_threads--;
 555         thread_number--;
 556 }
 557
 558 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 559 {
 560         unsigned long long bs = td->o.min_bs[ddir];
 561
 562         assert(ddir_rw(ddir));
 563
 564         if (td->o.rate[ddir])
 565                 td->rate_bps[ddir] = td->o.rate[ddir];
 566         else
 567                 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
 568
 569         if (!td->rate_bps[ddir]) {
 570                 log_err("rate lower than supported\n");
 571                 return -1;
 572         }
 573
 574         td->rate_next_io_time[ddir] = 0;
 575         td->rate_io_issue_bytes[ddir] = 0;
 576         td->last_usec[ddir] = 0;
 577         return 0;
 578 }
 579
 580 static int setup_rate(struct thread_data *td)
 581 {
 582         int ret = 0;
 583
 584         for_each_rw_ddir(ddir) {
 585                 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
 586                         ret |= __setup_rate(td, ddir);
 587                 }
 588         }
 589         return ret;
 590 }
 591
 592 static int fixed_block_size(struct thread_options *o)
 593 {
 594         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
 595                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
 596                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
 597                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
 598                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
 599 }
 600
 601 /*
 602  * <3 Johannes
 603  */
 604 static unsigned int gcd(unsigned int m, unsigned int n)
 605 {
 606         if (!n)
 607                 return m;
 608
 609         return gcd(n, m % n);
 610 }
 611
 612 /*
 613  * Lazy way of fixing up options that depend on each other. We could also
 614  * define option callback handlers, but this is easier.
 615  */
 616 static int fixup_options(struct thread_data *td)
 617 {
 618         struct thread_options *o = &td->o;
 619         int ret = 0;
 620
 621         if (read_only && (td_write(td) || td_trim(td))) {
 622                 log_err("fio: trim and write operations are not allowed"
 623                          " with the --readonly parameter.\n");
 624                 ret |= 1;
 625         }
 626
 627 #ifndef CONFIG_PSHARED
 628         if (!o->use_thread) {
 629                 log_info("fio: this platform does not support process shared"
 630                          " mutexes, forcing use of threads. Use the 'thread'"
 631                          " option to get rid of this warning.\n");
 632                 o->use_thread = 1;
 633                 ret |= warnings_fatal;
 634         }
 635 #endif
 636
 637         if (o->write_iolog_file && o->read_iolog_file) {
 638                 log_err("fio: read iolog overrides write_iolog\n");
 639                 free(o->write_iolog_file);
 640                 o->write_iolog_file = NULL;
 641                 ret |= warnings_fatal;
 642         }
 643
 644         if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
 645                 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
 646                 ret |= 1;
 647         }
 648
 649         if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
 650                 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
 651                 ret |= 1;
 652         }
 653
 654         if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
 655                 if (o->zone_size)
 656                         o->zone_mode = ZONE_MODE_STRIDED;
 657                 else
 658                         o->zone_mode = ZONE_MODE_NONE;
 659         }
 660
 661         /*
 662          * Strided zone mode only really works with 1 file.
 663          */
 664         if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
 665                 o->zone_mode = ZONE_MODE_NONE;
 666
 667         /*
 668          * If zone_range isn't specified, backward compatibility dictates it
 669          * should be made equal to zone_size.
 670          */
 671         if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
 672                 o->zone_range = o->zone_size;
 673
 674         /*
 675          * Reads can do overwrites, we always need to pre-create the file
 676          */
 677         if (td_read(td))
 678                 o->overwrite = 1;
 679
 680         for_each_rw_ddir(ddir) {
 681                 if (!o->min_bs[ddir])
 682                         o->min_bs[ddir] = o->bs[ddir];
 683                 if (!o->max_bs[ddir])
 684                         o->max_bs[ddir] = o->bs[ddir];
 685         }
 686
 687         o->rw_min_bs = -1;
 688         for_each_rw_ddir(ddir) {
 689                 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
 690         }
 691
 692         /*
 693          * For random IO, allow blockalign offset other than min_bs.
 694          */
 695         for_each_rw_ddir(ddir) {
 696                 if (!o->ba[ddir] || !td_random(td))
 697                         o->ba[ddir] = o->min_bs[ddir];
 698         }
 699
 700         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
 701             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
 702             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
 703             !o->norandommap) {
 704                 log_err("fio: Any use of blockalign= turns off randommap\n");
 705                 o->norandommap = 1;
 706                 ret |= warnings_fatal;
 707         }
 708
 709         if (!o->file_size_high)
 710                 o->file_size_high = o->file_size_low;
 711
 712         if (o->start_delay_high) {
 713                 if (!o->start_delay_orig)
 714                         o->start_delay_orig = o->start_delay;
 715                 o->start_delay = rand_between(&td->delay_state,
 716                                                 o->start_delay_orig,
 717                                                 o->start_delay_high);
 718         }
 719
 720         if (o->norandommap && o->verify != VERIFY_NONE
 721             && !fixed_block_size(o))  {
 722                 log_err("fio: norandommap given for variable block sizes, "
 723                         "verify limited\n");
 724                 ret |= warnings_fatal;
 725         }
 726         if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
 727                 log_err("fio: bs_unaligned may not work with raw io\n");
 728
 729         /*
 730          * thinktime_spin must be less than thinktime
 731          */
 732         if (o->thinktime_spin > o->thinktime)
 733                 o->thinktime_spin = o->thinktime;
 734
 735         /*
 736          * The low water mark cannot be bigger than the iodepth
 737          */
 738         if (o->iodepth_low > o->iodepth || !o->iodepth_low)
 739                 o->iodepth_low = o->iodepth;
 740
 741         /*
 742          * If batch number isn't set, default to the same as iodepth
 743          */
 744         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 745                 o->iodepth_batch = o->iodepth;
 746
 747         /*
 748          * If max batch complete number isn't set or set incorrectly,
 749          * default to the same as iodepth_batch_complete_min
 750          */
 751         if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
 752                 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
 753
 754         /*
 755          * There's no need to check for in-flight overlapping IOs if the job
 756          * isn't changing data or the maximum iodepth is guaranteed to be 1
 757          * when we are not in offload mode
 758          */
 759         if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
 760             (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
 761             o->io_submit_mode != IO_MODE_OFFLOAD)
 762                 o->serialize_overlap = 0;
 763
 764         if (o->nr_files > td->files_index)
 765                 o->nr_files = td->files_index;
 766
 767         if (o->open_files > o->nr_files || !o->open_files)
 768                 o->open_files = o->nr_files;
 769
 770         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
 771             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
 772             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
 773             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
 774                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 775                 ret |= 1;
 776         }
 777         for_each_rw_ddir(ddir) {
 778                 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
 779                     (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
 780                         log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
 781                         ret |= 1;
 782                 }
 783         }
 784
 785         if (!o->timeout && o->time_based) {
 786                 log_err("fio: time_based requires a runtime/timeout setting\n");
 787                 o->time_based = 0;
 788                 ret |= warnings_fatal;
 789         }
 790
 791         if (o->fill_device && !o->size)
 792                 o->size = -1ULL;
 793
 794         if (o->verify != VERIFY_NONE) {
 795                 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
 796                     (o->filename ||
 797                      !(o->unique_filename &&
 798                        strstr(o->filename_format, "$jobname") &&
 799                        strstr(o->filename_format, "$jobnum") &&
 800                        strstr(o->filename_format, "$filenum")))) {
 801                         log_info("fio: multiple writers may overwrite blocks "
 802                                 "that belong to other jobs. This can cause "
 803                                 "verification failures.\n");
 804                         ret |= warnings_fatal;
 805                 }
 806
 807                 /*
 808                  * Warn if verification is requested but no verification of any
 809                  * kind can be started due to time constraints
 810                  */
 811                 if (td_write(td) && o->do_verify && o->timeout &&
 812                     o->time_based && !td_read(td) && !o->verify_backlog) {
 813                         log_info("fio: verification read phase will never "
 814                                  "start because write phase uses all of "
 815                                  "runtime\n");
 816                         ret |= warnings_fatal;
 817                 }
 818
 819                 if (!fio_option_is_set(o, refill_buffers))
 820                         o->refill_buffers = 1;
 821
 822                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
 823                     !o->verify_interval)
 824                         o->verify_interval = o->min_bs[DDIR_WRITE];
 825
 826                 /*
 827                  * Verify interval must be smaller or equal to the
 828                  * write size.
 829                  */
 830                 if (o->verify_interval > o->min_bs[DDIR_WRITE])
 831                         o->verify_interval = o->min_bs[DDIR_WRITE];
 832                 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
 833                         o->verify_interval = o->min_bs[DDIR_READ];
 834
 835                 /*
 836                  * Verify interval must be a factor of both min and max
 837                  * write size
 838                  */
 839                 if (!o->verify_interval ||
 840                     (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
 841                     (o->max_bs[DDIR_WRITE] % o->verify_interval))
 842                         o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
 843                                                         o->max_bs[DDIR_WRITE]);
 844         }
 845
 846         if (o->pre_read) {
 847                 if (o->invalidate_cache)
 848                         o->invalidate_cache = 0;
 849                 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
 850                         log_info("fio: cannot pre-read files with an IO engine"
 851                                  " that isn't seekable. Pre-read disabled.\n");
 852                         ret |= warnings_fatal;
 853                 }
 854         }
 855
 856         if (o->unit_base == N2S_NONE) {
 857                 if (td_ioengine_flagged(td, FIO_BIT_BASED))
 858                         o->unit_base = N2S_BITPERSEC;
 859                 else
 860                         o->unit_base = N2S_BYTEPERSEC;
 861         }
 862
 863 #ifndef CONFIG_FDATASYNC
 864         if (o->fdatasync_blocks) {
 865                 log_info("fio: this platform does not support fdatasync()"
 866                          " falling back to using fsync().  Use the 'fsync'"
 867                          " option instead of 'fdatasync' to get rid of"
 868                          " this warning\n");
 869                 o->fsync_blocks = o->fdatasync_blocks;
 870                 o->fdatasync_blocks = 0;
 871                 ret |= warnings_fatal;
 872         }
 873 #endif
 874
 875 #ifdef WIN32
 876         /*
 877          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
 878          * so fail if we're passed those flags
 879          */
 880         if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
 881                 log_err("fio: Windows does not support direct or non-buffered io with"
 882                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
 883                                 " with 'direct=1' and 'iodepth=1' instead.\n");
 884                 ret |= 1;
 885         }
 886 #endif
 887
 888         /*
 889          * For fully compressible data, just zero them at init time.
 890          * It's faster than repeatedly filling it. For non-zero
 891          * compression, we should have refill_buffers set. Set it, unless
 892          * the job file already changed it.
 893          */
 894         if (o->compress_percentage) {
 895                 if (o->compress_percentage == 100) {
 896                         o->zero_buffers = 1;
 897                         o->compress_percentage = 0;
 898                 } else if (!fio_option_is_set(o, refill_buffers)) {
 899                         o->refill_buffers = 1;
 900                         td->flags |= TD_F_REFILL_BUFFERS;
 901                 }
 902         }
 903
 904         /*
 905          * Using a non-uniform random distribution excludes usage of
 906          * a random map
 907          */
 908         if (o->random_distribution != FIO_RAND_DIST_RANDOM)
 909                 o->norandommap = 1;
 910
 911         /*
 912          * If size is set but less than the min block size, complain
 913          */
 914         if (o->size && o->size < td_min_bs(td)) {
 915                 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
 916                         (unsigned long long) o->size, td_min_bs(td));
 917                 ret |= 1;
 918         }
 919
 920         /*
 921          * O_ATOMIC implies O_DIRECT
 922          */
 923         if (o->oatomic)
 924                 o->odirect = 1;
 925
 926         /*
 927          * If randseed is set, that overrides randrepeat
 928          */
 929         if (fio_option_is_set(o, rand_seed))
 930                 o->rand_repeatable = 0;
 931
 932         if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
 933                 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
 934                 ret |= 1;
 935         }
 936
 937         if (fio_option_is_set(o, gtod_cpu)) {
 938                 fio_gtod_init();
 939                 fio_gtod_set_cpu(o->gtod_cpu);
 940                 fio_gtod_offload = 1;
 941         }
 942
 943         td->loops = o->loops;
 944         if (!td->loops)
 945                 td->loops = 1;
 946
 947         if (o->block_error_hist && o->nr_files != 1) {
 948                 log_err("fio: block error histogram only available "
 949                         "with a single file per job, but %d files "
 950                         "provided\n", o->nr_files);
 951                 ret |= 1;
 952         }
 953
 954         if (o->disable_lat)
 955                 o->lat_percentiles = 0;
 956         if (o->disable_clat)
 957                 o->clat_percentiles = 0;
 958         if (o->disable_slat)
 959                 o->slat_percentiles = 0;
 960
 961         /*
 962          * Fix these up to be nsec internally
 963          */
 964         o->max_latency *= 1000ULL;
 965         o->latency_target *= 1000ULL;
 966
 967         return ret;
 968 }
 969
 970 static void init_rand_file_service(struct thread_data *td)
 971 {
 972         unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
 973         const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
 974
 975         if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
 976                 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
 977                 zipf_disable_hash(&td->next_file_zipf);
 978         } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
 979                 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
 980                 zipf_disable_hash(&td->next_file_zipf);
 981         } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
 982                 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
 983                 gauss_disable_hash(&td->next_file_gauss);
 984         }
 985 }
 986
 987 void td_fill_verify_state_seed(struct thread_data *td)
 988 {
 989         bool use64;
 990
 991         if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
 992                 use64 = true;
 993         else
 994                 use64 = false;
 995
 996         init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
 997                 use64);
 998 }
 999
1000 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1001 {
1002         uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1003         uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1004         uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1005         int i;
1006
1007         /*
1008          * trimwrite is special in that we need to generate the same
1009          * offsets to get the "write after trim" effect. If we are
1010          * using bssplit to set buffer length distributions, ensure that
1011          * we seed the trim and write generators identically. Ditto for
1012          * verify, read and writes must have the same seed, if we are doing
1013          * read verify.
1014          */
1015         if (td->o.verify != VERIFY_NONE)
1016                 write_seed = read_seed;
1017         if (td_trimwrite(td))
1018                 trim_seed = write_seed;
1019         init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1020         init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1021         init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1022
1023         td_fill_verify_state_seed(td);
1024         init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1025
1026         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1027                 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1028         else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1029                 init_rand_file_service(td);
1030
1031         init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1032         init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1033         init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1034         init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1035         init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1036         init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1037         init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1038         init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1039         init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1040
1041         if (!td_random(td))
1042                 return;
1043
1044         if (td->o.rand_repeatable)
1045                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1046
1047         init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1048
1049         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1050                 struct frand_state *s = &td->seq_rand_state[i];
1051
1052                 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1053         }
1054 }
1055
1056 void td_fill_rand_seeds(struct thread_data *td)
1057 {
1058         bool use64;
1059
1060         if (td->o.allrand_repeatable) {
1061                 unsigned int i;
1062
1063                 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1064                         td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1065                                 + i;
1066         }
1067
1068         if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1069                 use64 = true;
1070         else
1071                 use64 = false;
1072
1073         td_fill_rand_seeds_internal(td, use64);
1074
1075         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1076         frand_copy(&td->buf_state_prev, &td->buf_state);
1077 }
1078
1079 /*
1080  * Initializes the ioengine configured for a job, if it has not been done so
1081  * already.
1082  */
1083 int ioengine_load(struct thread_data *td)
1084 {
1085         if (!td->o.ioengine) {
1086                 log_err("fio: internal fault, no IO engine specified\n");
1087                 return 1;
1088         }
1089
1090         if (td->io_ops) {
1091                 struct ioengine_ops *ops;
1092                 void *dlhandle;
1093
1094                 /* An engine is loaded, but the requested ioengine
1095                  * may have changed.
1096                  */
1097                 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1098                         /* The right engine is already loaded */
1099                         return 0;
1100                 }
1101
1102                 /*
1103                  * Name of file and engine may be different, load ops
1104                  * for this name and see if they match. If they do, then
1105                  * the engine is unchanged.
1106                  */
1107                 dlhandle = td->io_ops->dlhandle;
1108                 ops = load_ioengine(td);
1109                 if (!ops)
1110                         goto fail;
1111
1112                 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
1113                         return 0;
1114
1115                 if (dlhandle && dlhandle != td->io_ops->dlhandle)
1116                         dlclose(dlhandle);
1117
1118                 /* Unload the old engine. */
1119                 free_ioengine(td);
1120         }
1121
1122         td->io_ops = load_ioengine(td);
1123         if (!td->io_ops)
1124                 goto fail;
1125
1126         if (td->io_ops->option_struct_size && td->io_ops->options) {
1127                 /*
1128                  * In cases where td->eo is set, clone it for a child thread.
1129                  * This requires that the parent thread has the same ioengine,
1130                  * but that requirement must be enforced by the code which
1131                  * cloned the thread.
1132                  */
1133                 void *origeo = td->eo;
1134                 /*
1135                  * Otherwise use the default thread options.
1136                  */
1137                 if (!origeo && td != &def_thread && def_thread.eo &&
1138                     def_thread.io_ops->options == td->io_ops->options)
1139                         origeo = def_thread.eo;
1140
1141                 options_init(td->io_ops->options);
1142                 td->eo = malloc(td->io_ops->option_struct_size);
1143                 /*
1144                  * Use the default thread as an option template if this uses the
1145                  * same options structure and there are non-default options
1146                  * used.
1147                  */
1148                 if (origeo) {
1149                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1150                         options_mem_dupe(td->io_ops->options, td->eo);
1151                 } else {
1152                         memset(td->eo, 0, td->io_ops->option_struct_size);
1153                         fill_default_options(td->eo, td->io_ops->options);
1154                 }
1155                 *(struct thread_data **)td->eo = td;
1156         }
1157
1158         if (td->o.odirect)
1159                 td->io_ops->flags |= FIO_RAWIO;
1160
1161         td_set_ioengine_flags(td);
1162         return 0;
1163
1164 fail:
1165         log_err("fio: failed to load engine\n");
1166         return 1;
1167
1168 }
1169
1170 static void init_flags(struct thread_data *td)
1171 {
1172         struct thread_options *o = &td->o;
1173         int i;
1174
1175         if (o->verify_backlog)
1176                 td->flags |= TD_F_VER_BACKLOG;
1177         if (o->trim_backlog)
1178                 td->flags |= TD_F_TRIM_BACKLOG;
1179         if (o->read_iolog_file)
1180                 td->flags |= TD_F_READ_IOLOG;
1181         if (o->refill_buffers)
1182                 td->flags |= TD_F_REFILL_BUFFERS;
1183         /*
1184          * Always scramble buffers if asked to
1185          */
1186         if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1187                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1188         /*
1189          * But also scramble buffers, unless we were explicitly asked
1190          * to zero them.
1191          */
1192         if (o->scramble_buffers && !(o->zero_buffers &&
1193             fio_option_is_set(o, zero_buffers)))
1194                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1195         if (o->verify != VERIFY_NONE)
1196                 td->flags |= TD_F_DO_VERIFY;
1197
1198         if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1199                 td->flags |= TD_F_NEED_LOCK;
1200
1201         if (o->mem_type == MEM_CUDA_MALLOC)
1202                 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1203
1204         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1205                 if (option_check_rate(td, i)) {
1206                         td->flags |= TD_F_CHECK_RATE;
1207                         break;
1208                 }
1209         }
1210 }
1211
1212 static int setup_random_seeds(struct thread_data *td)
1213 {
1214         uint64_t seed;
1215         unsigned int i;
1216
1217         if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1218                 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1219                 if (!ret)
1220                         td_fill_rand_seeds(td);
1221                 return ret;
1222         }
1223
1224         seed = td->o.rand_seed;
1225         for (i = 0; i < 4; i++)
1226                 seed *= 0x9e370001UL;
1227
1228         for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1229                 td->rand_seeds[i] = seed * td->thread_number + i;
1230                 seed *= 0x9e370001UL;
1231         }
1232
1233         td_fill_rand_seeds(td);
1234         return 0;
1235 }
1236
1237 enum {
1238         FPRE_NONE = 0,
1239         FPRE_JOBNAME,
1240         FPRE_JOBNUM,
1241         FPRE_FILENUM,
1242         FPRE_CLIENTUID
1243 };
1244
1245 static struct fpre_keyword {
1246         const char *keyword;
1247         size_t strlen;
1248         int key;
1249 } fpre_keywords[] = {
1250         { .keyword = "$jobname",        .key = FPRE_JOBNAME, },
1251         { .keyword = "$jobnum",         .key = FPRE_JOBNUM, },
1252         { .keyword = "$filenum",        .key = FPRE_FILENUM, },
1253         { .keyword = "$clientuid",      .key = FPRE_CLIENTUID, },
1254         { .keyword = NULL, },
1255         };
1256
1257 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1258                            const char *jobname, int jobnum, int filenum)
1259 {
1260         struct fpre_keyword *f;
1261         char copy[PATH_MAX];
1262         size_t dst_left = PATH_MAX - 1;
1263
1264         if (!o->filename_format || !strlen(o->filename_format)) {
1265                 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1266                 return buf;
1267         }
1268
1269         for (f = &fpre_keywords[0]; f->keyword; f++)
1270                 f->strlen = strlen(f->keyword);
1271
1272         snprintf(buf, buf_size, "%s", o->filename_format);
1273
1274         memset(copy, 0, sizeof(copy));
1275         for (f = &fpre_keywords[0]; f->keyword; f++) {
1276                 do {
1277                         size_t pre_len, post_start = 0;
1278                         char *str, *dst = copy;
1279
1280                         str = strcasestr(buf, f->keyword);
1281                         if (!str)
1282                                 break;
1283
1284                         pre_len = str - buf;
1285                         if (strlen(str) != f->strlen)
1286                                 post_start = pre_len + f->strlen;
1287
1288                         if (pre_len) {
1289                                 strncpy(dst, buf, pre_len);
1290                                 dst += pre_len;
1291                                 dst_left -= pre_len;
1292                         }
1293
1294                         switch (f->key) {
1295                         case FPRE_JOBNAME: {
1296                                 int ret;
1297
1298                                 ret = snprintf(dst, dst_left, "%s", jobname);
1299                                 if (ret < 0)
1300                                         break;
1301                                 else if (ret > dst_left) {
1302                                         log_err("fio: truncated filename\n");
1303                                         dst += dst_left;
1304                                         dst_left = 0;
1305                                 } else {
1306                                         dst += ret;
1307                                         dst_left -= ret;
1308                                 }
1309                                 break;
1310                                 }
1311                         case FPRE_JOBNUM: {
1312                                 int ret;
1313
1314                                 ret = snprintf(dst, dst_left, "%d", jobnum);
1315                                 if (ret < 0)
1316                                         break;
1317                                 else if (ret > dst_left) {
1318                                         log_err("fio: truncated filename\n");
1319                                         dst += dst_left;
1320                                         dst_left = 0;
1321                                 } else {
1322                                         dst += ret;
1323                                         dst_left -= ret;
1324                                 }
1325                                 break;
1326                                 }
1327                         case FPRE_FILENUM: {
1328                                 int ret;
1329
1330                                 ret = snprintf(dst, dst_left, "%d", filenum);
1331                                 if (ret < 0)
1332                                         break;
1333                                 else if (ret > dst_left) {
1334                                         log_err("fio: truncated filename\n");
1335                                         dst += dst_left;
1336                                         dst_left = 0;
1337                                 } else {
1338                                         dst += ret;
1339                                         dst_left -= ret;
1340                                 }
1341                                 break;
1342                                 }
1343                         case FPRE_CLIENTUID: {
1344                                 int ret;
1345                                 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1346                                 if (ret < 0)
1347                                         break;
1348                                 else if (ret > dst_left) {
1349                                         log_err("fio: truncated filename\n");
1350                                         dst += dst_left;
1351                                         dst_left = 0;
1352                                 } else {
1353                                         dst += ret;
1354                                         dst_left -= ret;
1355                                 }
1356                                 break;
1357                                 }
1358                         default:
1359                                 assert(0);
1360                                 break;
1361                         }
1362
1363                         if (post_start)
1364                                 strncpy(dst, buf + post_start, dst_left);
1365
1366                         snprintf(buf, buf_size, "%s", copy);
1367                 } while (1);
1368         }
1369
1370         return buf;
1371 }
1372
1373 bool parse_dryrun(void)
1374 {
1375         return dump_cmdline || parse_only;
1376 }
1377
1378 static void gen_log_name(char *name, size_t size, const char *logtype,
1379                          const char *logname, unsigned int num,
1380                          const char *suf, int per_job)
1381 {
1382         if (per_job)
1383                 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1384         else
1385                 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1386 }
1387
1388 static int check_waitees(char *waitee)
1389 {
1390         struct thread_data *td;
1391         int i, ret = 0;
1392
1393         for_each_td(td, i) {
1394                 if (td->subjob_number)
1395                         continue;
1396
1397                 ret += !strcmp(td->o.name, waitee);
1398         }
1399
1400         return ret;
1401 }
1402
1403 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1404 {
1405         int nw;
1406
1407         if (!o->wait_for)
1408                 return true;
1409
1410         if (!strcmp(jobname, o->wait_for)) {
1411                 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1412                                 jobname, o->wait_for);
1413                 return false;
1414         }
1415
1416         if (!(nw = check_waitees(o->wait_for))) {
1417                 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1418                 return false;
1419         }
1420
1421         if (nw > 1) {
1422                 log_err("%s: multiple waitees %s found,\n"
1423                         "please avoid duplicates when using wait_for option.\n",
1424                                 jobname, o->wait_for);
1425                 return false;
1426         }
1427
1428         return true;
1429 }
1430
1431 /*
1432  * Treat an empty log file name the same as a one not given
1433  */
1434 static const char *make_log_name(const char *logname, const char *jobname)
1435 {
1436         if (logname && strcmp(logname, ""))
1437                 return logname;
1438
1439         return jobname;
1440 }
1441
1442 /*
1443  * Adds a job to the list of things todo. Sanitizes the various options
1444  * to make sure we don't have conflicts, and initializes various
1445  * members of td.
1446  */
1447 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1448                    int recursed, int client_type)
1449 {
1450         unsigned int i;
1451         char fname[PATH_MAX + 1];
1452         int numjobs, file_alloced;
1453         struct thread_options *o = &td->o;
1454         char logname[PATH_MAX + 32];
1455
1456         /*
1457          * the def_thread is just for options, it's not a real job
1458          */
1459         if (td == &def_thread)
1460                 return 0;
1461
1462         init_flags(td);
1463
1464         /*
1465          * if we are just dumping the output command line, don't add the job
1466          */
1467         if (parse_dryrun()) {
1468                 put_job(td);
1469                 return 0;
1470         }
1471
1472         td->client_type = client_type;
1473
1474         if (profile_td_init(td))
1475                 goto err;
1476
1477         if (ioengine_load(td))
1478                 goto err;
1479
1480         file_alloced = 0;
1481         if (!o->filename && !td->files_index && !o->read_iolog_file) {
1482                 file_alloced = 1;
1483
1484                 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1485                         add_file(td, jobname, job_add_num, 0);
1486                 else {
1487                         for (i = 0; i < o->nr_files; i++)
1488                                 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1489                 }
1490         }
1491
1492         if (setup_random_seeds(td)) {
1493                 td_verror(td, errno, "setup_random_seeds");
1494                 goto err;
1495         }
1496
1497         if (fixup_options(td))
1498                 goto err;
1499
1500         /*
1501          * Belongs to fixup_options, but o->name is not necessarily set as yet
1502          */
1503         if (!wait_for_ok(jobname, o))
1504                 goto err;
1505
1506         flow_init_job(td);
1507
1508         /*
1509          * IO engines only need this for option callbacks, and the address may
1510          * change in subprocesses.
1511          */
1512         if (td->eo)
1513                 *(struct thread_data **)td->eo = NULL;
1514
1515         if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1516                 struct fio_file *f;
1517
1518                 for_each_file(td, f, i)
1519                         f->real_file_size = -1ULL;
1520         }
1521
1522         td->sem = fio_sem_init(FIO_SEM_LOCKED);
1523
1524         td->ts.clat_percentiles = o->clat_percentiles;
1525         td->ts.lat_percentiles = o->lat_percentiles;
1526         td->ts.slat_percentiles = o->slat_percentiles;
1527         td->ts.percentile_precision = o->percentile_precision;
1528         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1529         td->ts.sig_figs = o->sig_figs;
1530
1531         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1532                 td->ts.clat_stat[i].min_val = ULONG_MAX;
1533                 td->ts.slat_stat[i].min_val = ULONG_MAX;
1534                 td->ts.lat_stat[i].min_val = ULONG_MAX;
1535                 td->ts.bw_stat[i].min_val = ULONG_MAX;
1536                 td->ts.iops_stat[i].min_val = ULONG_MAX;
1537                 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1538                 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1539         }
1540         td->ts.sync_stat.min_val = ULONG_MAX;
1541         td->ddir_seq_nr = o->ddir_seq_nr;
1542
1543         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1544                 prev_group_jobs = 0;
1545                 groupid++;
1546                 if (groupid == INT_MAX) {
1547                         log_err("fio: too many groups defined\n");
1548                         goto err;
1549                 }
1550         }
1551
1552         td->groupid = groupid;
1553         prev_group_jobs++;
1554
1555         if (setup_rate(td))
1556                 goto err;
1557
1558         if (o->write_lat_log) {
1559                 struct log_params p = {
1560                         .td = td,
1561                         .avg_msec = o->log_avg_msec,
1562                         .hist_msec = o->log_hist_msec,
1563                         .hist_coarseness = o->log_hist_coarseness,
1564                         .log_type = IO_LOG_TYPE_LAT,
1565                         .log_offset = o->log_offset,
1566                         .log_gz = o->log_gz,
1567                         .log_gz_store = o->log_gz_store,
1568                 };
1569                 const char *pre = make_log_name(o->lat_log_file, o->name);
1570                 const char *suf;
1571
1572                 if (p.log_gz_store)
1573                         suf = "log.fz";
1574                 else
1575                         suf = "log";
1576
1577                 gen_log_name(logname, sizeof(logname), "lat", pre,
1578                                 td->thread_number, suf, o->per_job_logs);
1579                 setup_log(&td->lat_log, &p, logname);
1580
1581                 gen_log_name(logname, sizeof(logname), "slat", pre,
1582                                 td->thread_number, suf, o->per_job_logs);
1583                 setup_log(&td->slat_log, &p, logname);
1584
1585                 gen_log_name(logname, sizeof(logname), "clat", pre,
1586                                 td->thread_number, suf, o->per_job_logs);
1587                 setup_log(&td->clat_log, &p, logname);
1588
1589         }
1590
1591         if (o->write_hist_log) {
1592                 struct log_params p = {
1593                         .td = td,
1594                         .avg_msec = o->log_avg_msec,
1595                         .hist_msec = o->log_hist_msec,
1596                         .hist_coarseness = o->log_hist_coarseness,
1597                         .log_type = IO_LOG_TYPE_HIST,
1598                         .log_offset = o->log_offset,
1599                         .log_gz = o->log_gz,
1600                         .log_gz_store = o->log_gz_store,
1601                 };
1602                 const char *pre = make_log_name(o->hist_log_file, o->name);
1603                 const char *suf;
1604
1605 #ifndef CONFIG_ZLIB
1606                 if (td->client_type) {
1607                         log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1608                         goto err;
1609                 }
1610 #endif
1611
1612                 if (p.log_gz_store)
1613                         suf = "log.fz";
1614                 else
1615                         suf = "log";
1616
1617                 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1618                                 td->thread_number, suf, o->per_job_logs);
1619                 setup_log(&td->clat_hist_log, &p, logname);
1620         }
1621
1622         if (o->write_bw_log) {
1623                 struct log_params p = {
1624                         .td = td,
1625                         .avg_msec = o->log_avg_msec,
1626                         .hist_msec = o->log_hist_msec,
1627                         .hist_coarseness = o->log_hist_coarseness,
1628                         .log_type = IO_LOG_TYPE_BW,
1629                         .log_offset = o->log_offset,
1630                         .log_gz = o->log_gz,
1631                         .log_gz_store = o->log_gz_store,
1632                 };
1633                 const char *pre = make_log_name(o->bw_log_file, o->name);
1634                 const char *suf;
1635
1636                 if (fio_option_is_set(o, bw_avg_time))
1637                         p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1638                 else
1639                         o->bw_avg_time = p.avg_msec;
1640
1641                 p.hist_msec = o->log_hist_msec;
1642                 p.hist_coarseness = o->log_hist_coarseness;
1643
1644                 if (p.log_gz_store)
1645                         suf = "log.fz";
1646                 else
1647                         suf = "log";
1648
1649                 gen_log_name(logname, sizeof(logname), "bw", pre,
1650                                 td->thread_number, suf, o->per_job_logs);
1651                 setup_log(&td->bw_log, &p, logname);
1652         }
1653         if (o->write_iops_log) {
1654                 struct log_params p = {
1655                         .td = td,
1656                         .avg_msec = o->log_avg_msec,
1657                         .hist_msec = o->log_hist_msec,
1658                         .hist_coarseness = o->log_hist_coarseness,
1659                         .log_type = IO_LOG_TYPE_IOPS,
1660                         .log_offset = o->log_offset,
1661                         .log_gz = o->log_gz,
1662                         .log_gz_store = o->log_gz_store,
1663                 };
1664                 const char *pre = make_log_name(o->iops_log_file, o->name);
1665                 const char *suf;
1666
1667                 if (fio_option_is_set(o, iops_avg_time))
1668                         p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1669                 else
1670                         o->iops_avg_time = p.avg_msec;
1671
1672                 p.hist_msec = o->log_hist_msec;
1673                 p.hist_coarseness = o->log_hist_coarseness;
1674
1675                 if (p.log_gz_store)
1676                         suf = "log.fz";
1677                 else
1678                         suf = "log";
1679
1680                 gen_log_name(logname, sizeof(logname), "iops", pre,
1681                                 td->thread_number, suf, o->per_job_logs);
1682                 setup_log(&td->iops_log, &p, logname);
1683         }
1684
1685         if (!o->name)
1686                 o->name = strdup(jobname);
1687
1688         if (output_format & FIO_OUTPUT_NORMAL) {
1689                 if (!job_add_num) {
1690                         if (is_backend && !recursed)
1691                                 fio_server_send_add_job(td);
1692
1693                         if (!td_ioengine_flagged(td, FIO_NOIO)) {
1694                                 char *c1, *c2, *c3, *c4;
1695                                 char *c5 = NULL, *c6 = NULL;
1696                                 int i2p = is_power_of_2(o->kb_base);
1697                                 struct buf_output out;
1698
1699                                 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1700                                 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1701                                 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1702                                 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1703
1704                                 if (!o->bs_is_seq_rand) {
1705                                         c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1706                                         c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1707                                 }
1708
1709                                 buf_output_init(&out);
1710                                 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1711                                                         td->groupid,
1712                                                         ddir_str(o->td_ddir));
1713
1714                                 if (o->bs_is_seq_rand)
1715                                         __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1716                                                         c1, c2, c3, c4);
1717                                 else
1718                                         __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1719                                                         c1, c2, c3, c4, c5, c6);
1720
1721                                 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1722                                                 td->io_ops->name, o->iodepth);
1723                                 log_info_buf(out.buf, out.buflen);
1724                                 buf_output_free(&out);
1725
1726                                 free(c1);
1727                                 free(c2);
1728                                 free(c3);
1729                                 free(c4);
1730                                 free(c5);
1731                                 free(c6);
1732                         }
1733                 } else if (job_add_num == 1)
1734                         log_info("...\n");
1735         }
1736
1737         if (td_steadystate_init(td))
1738                 goto err;
1739
1740         if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1741                 goto err;
1742
1743         if (merge_blktrace_only) {
1744                 put_job(td);
1745                 return 0;
1746         }
1747
1748         /*
1749          * recurse add identical jobs, clear numjobs and stonewall options
1750          * as they don't apply to sub-jobs
1751          */
1752         numjobs = o->numjobs;
1753         while (--numjobs) {
1754                 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1755
1756                 if (!td_new)
1757                         goto err;
1758
1759                 td_new->o.numjobs = 1;
1760                 td_new->o.stonewall = 0;
1761                 td_new->o.new_group = 0;
1762                 td_new->subjob_number = numjobs;
1763                 td_new->o.ss_dur = o->ss_dur * 1000000l;
1764                 td_new->o.ss_limit = o->ss_limit;
1765
1766                 if (file_alloced) {
1767                         if (td_new->files) {
1768                                 struct fio_file *f;
1769                                 for_each_file(td_new, f, i)
1770                                         fio_file_free(f);
1771                                 free(td_new->files);
1772                                 td_new->files = NULL;
1773                         }
1774                         td_new->files_index = 0;
1775                         td_new->files_size = 0;
1776                         if (td_new->o.filename) {
1777                                 free(td_new->o.filename);
1778                                 td_new->o.filename = NULL;
1779                         }
1780                 }
1781
1782                 if (add_job(td_new, jobname, numjobs, 1, client_type))
1783                         goto err;
1784         }
1785
1786         return 0;
1787 err:
1788         put_job(td);
1789         return -1;
1790 }
1791
1792 /*
1793  * Parse as if 'o' was a command line
1794  */
1795 void add_job_opts(const char **o, int client_type)
1796 {
1797         struct thread_data *td, *td_parent;
1798         int i, in_global = 1;
1799         char jobname[32];
1800
1801         i = 0;
1802         td_parent = td = NULL;
1803         while (o[i]) {
1804                 if (!strncmp(o[i], "name", 4)) {
1805                         in_global = 0;
1806                         if (td)
1807                                 add_job(td, jobname, 0, 0, client_type);
1808                         td = NULL;
1809                         sprintf(jobname, "%s", o[i] + 5);
1810                 }
1811                 if (in_global && !td_parent)
1812                         td_parent = get_new_job(true, &def_thread, false, jobname);
1813                 else if (!in_global && !td) {
1814                         if (!td_parent)
1815                                 td_parent = &def_thread;
1816                         td = get_new_job(false, td_parent, false, jobname);
1817                 }
1818                 if (in_global)
1819                         fio_options_parse(td_parent, (char **) &o[i], 1);
1820                 else
1821                         fio_options_parse(td, (char **) &o[i], 1);
1822                 i++;
1823         }
1824
1825         if (td)
1826                 add_job(td, jobname, 0, 0, client_type);
1827 }
1828
1829 static int skip_this_section(const char *name)
1830 {
1831         int i;
1832
1833         if (!nr_job_sections)
1834                 return 0;
1835         if (!strncmp(name, "global", 6))
1836                 return 0;
1837
1838         for (i = 0; i < nr_job_sections; i++)
1839                 if (!strcmp(job_sections[i], name))
1840                         return 0;
1841
1842         return 1;
1843 }
1844
1845 static int is_empty_or_comment(char *line)
1846 {
1847         unsigned int i;
1848
1849         for (i = 0; i < strlen(line); i++) {
1850                 if (line[i] == ';')
1851                         return 1;
1852                 if (line[i] == '#')
1853                         return 1;
1854                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1855                         return 0;
1856         }
1857
1858         return 1;
1859 }
1860
1861 /*
1862  * This is our [ini] type file parser.
1863  */
1864 static int __parse_jobs_ini(struct thread_data *td,
1865                 char *file, int is_buf, int stonewall_flag, int type,
1866                 int nested, char *name, char ***popts, int *aopts, int *nopts)
1867 {
1868         bool global = false;
1869         bool stdin_occupied = false;
1870         char *string;
1871         FILE *f;
1872         char *p;
1873         int ret = 0, stonewall;
1874         int first_sect = 1;
1875         int skip_fgets = 0;
1876         int inside_skip = 0;
1877         char **opts;
1878         int i, alloc_opts, num_opts;
1879
1880         dprint(FD_PARSE, "Parsing ini file %s\n", file);
1881         assert(td || !nested);
1882
1883         if (is_buf)
1884                 f = NULL;
1885         else {
1886                 if (!strcmp(file, "-")) {
1887                         f = stdin;
1888                         stdin_occupied = true;
1889                 } else
1890                         f = fopen(file, "r");
1891
1892                 if (!f) {
1893                         int __err = errno;
1894
1895                         log_err("fio: unable to open '%s' job file\n", file);
1896                         if (td)
1897                                 td_verror(td, __err, "job file open");
1898                         return 1;
1899                 }
1900         }
1901
1902         string = malloc(OPT_LEN_MAX);
1903
1904         /*
1905          * it's really 256 + small bit, 280 should suffice
1906          */
1907         if (!nested) {
1908                 name = malloc(280);
1909                 memset(name, 0, 280);
1910         }
1911
1912         opts = NULL;
1913         if (nested && popts) {
1914                 opts = *popts;
1915                 alloc_opts = *aopts;
1916                 num_opts = *nopts;
1917         }
1918
1919         if (!opts) {
1920                 alloc_opts = 8;
1921                 opts = malloc(sizeof(char *) * alloc_opts);
1922                 num_opts = 0;
1923         }
1924
1925         stonewall = stonewall_flag;
1926         do {
1927                 /*
1928                  * if skip_fgets is set, we already have loaded a line we
1929                  * haven't handled.
1930                  */
1931                 if (!skip_fgets) {
1932                         if (is_buf)
1933                                 p = strsep(&file, "\n");
1934                         else
1935                                 p = fgets(string, OPT_LEN_MAX, f);
1936                         if (!p)
1937                                 break;
1938                 }
1939
1940                 skip_fgets = 0;
1941                 strip_blank_front(&p);
1942                 strip_blank_end(p);
1943
1944                 dprint(FD_PARSE, "%s\n", p);
1945                 if (is_empty_or_comment(p))
1946                         continue;
1947
1948                 if (!nested) {
1949                         if (sscanf(p, "[%255[^\n]]", name) != 1) {
1950                                 if (inside_skip)
1951                                         continue;
1952
1953                                 log_err("fio: option <%s> outside of "
1954                                         "[] job section\n", p);
1955                                 ret = 1;
1956                                 break;
1957                         }
1958
1959                         name[strlen(name) - 1] = '\0';
1960
1961                         if (skip_this_section(name)) {
1962                                 inside_skip = 1;
1963                                 continue;
1964                         } else
1965                                 inside_skip = 0;
1966
1967                         dprint(FD_PARSE, "Parsing section [%s]\n", name);
1968
1969                         global = !strncmp(name, "global", 6);
1970
1971                         if (dump_cmdline) {
1972                                 if (first_sect)
1973                                         log_info("fio ");
1974                                 if (!global)
1975                                         log_info("--name=%s ", name);
1976                                 first_sect = 0;
1977                         }
1978
1979                         td = get_new_job(global, &def_thread, false, name);
1980                         if (!td) {
1981                                 ret = 1;
1982                                 break;
1983                         }
1984
1985                         /*
1986                          * Separate multiple job files by a stonewall
1987                          */
1988                         if (!global && stonewall) {
1989                                 td->o.stonewall = stonewall;
1990                                 stonewall = 0;
1991                         }
1992
1993                         num_opts = 0;
1994                         memset(opts, 0, alloc_opts * sizeof(char *));
1995                 }
1996                 else
1997                         skip_fgets = 1;
1998
1999                 while (1) {
2000                         if (!skip_fgets) {
2001                                 if (is_buf)
2002                                         p = strsep(&file, "\n");
2003                                 else
2004                                         p = fgets(string, OPT_LEN_MAX, f);
2005                                 if (!p)
2006                                         break;
2007                                 dprint(FD_PARSE, "%s", p);
2008                         }
2009                         else
2010                                 skip_fgets = 0;
2011
2012                         if (is_empty_or_comment(p))
2013                                 continue;
2014
2015                         strip_blank_front(&p);
2016
2017                         /*
2018                          * new section, break out and make sure we don't
2019                          * fgets() a new line at the top.
2020                          */
2021                         if (p[0] == '[') {
2022                                 if (nested) {
2023                                         log_err("No new sections in included files\n");
2024                                         ret = 1;
2025                                         goto out;
2026                                 }
2027
2028                                 skip_fgets = 1;
2029                                 break;
2030                         }
2031
2032                         strip_blank_end(p);
2033
2034                         if (!strncmp(p, "include", strlen("include"))) {
2035                                 char *filename = p + strlen("include") + 1,
2036                                         *ts, *full_fn = NULL;
2037
2038                                 /*
2039                                  * Allow for the include filename
2040                                  * specification to be relative.
2041                                  */
2042                                 if (access(filename, F_OK) &&
2043                                     (ts = strrchr(file, '/'))) {
2044                                         if (asprintf(&full_fn, "%.*s%s",
2045                                                  (int)(ts - file + 1), file,
2046                                                  filename) < 0) {
2047                                                 ret = ENOMEM;
2048                                                 break;
2049                                         }
2050                                         filename = full_fn;
2051                                 }
2052
2053                                 ret = __parse_jobs_ini(td, filename, is_buf,
2054                                                        stonewall_flag, type, 1,
2055                                                        name, &opts,
2056                                                        &alloc_opts, &num_opts);
2057
2058                                 if (ret) {
2059                                         log_err("Error %d while parsing "
2060                                                 "include file %s\n",
2061                                                 ret, filename);
2062                                 }
2063
2064                                 if (full_fn)
2065                                         free(full_fn);
2066
2067                                 if (ret)
2068                                         break;
2069
2070                                 continue;
2071                         }
2072
2073                         if (num_opts == alloc_opts) {
2074                                 alloc_opts <<= 1;
2075                                 opts = realloc(opts,
2076                                                 alloc_opts * sizeof(char *));
2077                         }
2078
2079                         opts[num_opts] = strdup(p);
2080                         num_opts++;
2081                 }
2082
2083                 if (nested) {
2084                         *popts = opts;
2085                         *aopts = alloc_opts;
2086                         *nopts = num_opts;
2087                         goto out;
2088                 }
2089
2090                 ret = fio_options_parse(td, opts, num_opts);
2091
2092                 if (!ret && td->o.read_iolog_file != NULL) {
2093                         char *fname = get_name_by_idx(td->o.read_iolog_file,
2094                                                       td->subjob_number);
2095                         if (!strcmp(fname, "-")) {
2096                                 if (stdin_occupied) {
2097                                         log_err("fio: only one user (read_iolog_file/job "
2098                                                 "file) of stdin is permitted at once but "
2099                                                 "more than one was found.\n");
2100                                         ret = 1;
2101                                 }
2102                                 stdin_occupied = true;
2103                         }
2104                 }
2105                 if (!ret) {
2106                         if (dump_cmdline)
2107                                 dump_opt_list(td);
2108
2109                         ret = add_job(td, name, 0, 0, type);
2110                 } else {
2111                         log_err("fio: job %s dropped\n", name);
2112                         put_job(td);
2113                 }
2114
2115                 for (i = 0; i < num_opts; i++)
2116                         free(opts[i]);
2117                 num_opts = 0;
2118         } while (!ret);
2119
2120         if (dump_cmdline)
2121                 log_info("\n");
2122
2123         i = 0;
2124         while (i < nr_job_sections) {
2125                 free(job_sections[i]);
2126                 i++;
2127         }
2128
2129         free(opts);
2130 out:
2131         free(string);
2132         if (!nested)
2133                 free(name);
2134         if (!is_buf && f != stdin)
2135                 fclose(f);
2136         return ret;
2137 }
2138
2139 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2140 {
2141         return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2142                         0, NULL, NULL, NULL, NULL);
2143 }
2144
2145 static int fill_def_thread(void)
2146 {
2147         memset(&def_thread, 0, sizeof(def_thread));
2148         INIT_FLIST_HEAD(&def_thread.opt_list);
2149
2150         fio_getaffinity(getpid(), &def_thread.o.cpumask);
2151         def_thread.o.error_dump = 1;
2152
2153         /*
2154          * fill default options
2155          */
2156         fio_fill_default_options(&def_thread);
2157         return 0;
2158 }
2159
2160 static void show_debug_categories(void)
2161 {
2162 #ifdef FIO_INC_DEBUG
2163         const struct debug_level *dl = &debug_levels[0];
2164         int curlen, first = 1;
2165
2166         curlen = 0;
2167         while (dl->name) {
2168                 int has_next = (dl + 1)->name != NULL;
2169
2170                 if (first || curlen + strlen(dl->name) >= 80) {
2171                         if (!first) {
2172                                 printf("\n");
2173                                 curlen = 0;
2174                         }
2175                         curlen += printf("\t\t\t%s", dl->name);
2176                         curlen += 3 * (8 - 1);
2177                         if (has_next)
2178                                 curlen += printf(",");
2179                 } else {
2180                         curlen += printf("%s", dl->name);
2181                         if (has_next)
2182                                 curlen += printf(",");
2183                 }
2184                 dl++;
2185                 first = 0;
2186         }
2187         printf("\n");
2188 #endif
2189 }
2190
2191 /*
2192  * Following options aren't printed by usage().
2193  * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2194  * --latency-log - Deprecated option.
2195  */
2196 static void usage(const char *name)
2197 {
2198         printf("%s\n", fio_version_string);
2199         printf("%s [options] [job options] <job file(s)>\n", name);
2200         printf("  --debug=options\tEnable debug logging. May be one/more of:\n");
2201         show_debug_categories();
2202         printf("  --parse-only\t\tParse options only, don't start any IO\n");
2203         printf("  --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2204         printf("  --output\t\tWrite output to file\n");
2205         printf("  --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2206         printf("  --minimal\t\tMinimal (terse) output\n");
2207         printf("  --output-format=type\tOutput format (terse,json,json+,normal)\n");
2208         printf("  --terse-version=type\tSet terse version output format"
2209                 " (default 3, or 2 or 4)\n");
2210         printf("  --version\t\tPrint version info and exit\n");
2211         printf("  --help\t\tPrint this page\n");
2212         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
2213         printf("  --crctest=[type]\tTest speed of checksum functions\n");
2214         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2215                 " them\n");
2216         printf("  --enghelp=engine\tPrint ioengine help, or list"
2217                 " available ioengines\n");
2218         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
2219                 " cmd\n");
2220         printf("  --showcmd\t\tTurn a job file into command line options\n");
2221         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
2222         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
2223         printf("  --eta-newline=t\tForce a new line for every 't'");
2224         printf(" period passed\n");
2225         printf("  --status-interval=t\tForce full status dump every");
2226         printf(" 't' period passed\n");
2227         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
2228                 " writes\n");
2229         printf("  --section=name\tOnly run specified section in job file,"
2230                 " multiple sections can be specified\n");
2231         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
2232                 " (def 16384)\n");
2233         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
2234         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2235         printf("  --server=args\t\tStart a backend fio server\n");
2236         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
2237         printf("  --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2238         printf("  --remote-config=file\tTell fio server to load this local job file\n");
2239         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2240                 "\t\t\t(option=system,percpu) or run unit work\n"
2241                 "\t\t\tcalibration only (option=calibrate)\n");
2242 #ifdef CONFIG_ZLIB
2243         printf("  --inflate-log=log\tInflate and output compressed log\n");
2244 #endif
2245         printf("  --trigger-file=file\tExecute trigger cmd when file exists\n");
2246         printf("  --trigger-timeout=t\tExecute trigger at this time\n");
2247         printf("  --trigger=cmd\t\tSet this command as local trigger\n");
2248         printf("  --trigger-remote=cmd\tSet this command as remote trigger\n");
2249         printf("  --aux-path=path\tUse this path for fio state generated files\n");
2250         printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2251 }
2252
2253 #ifdef FIO_INC_DEBUG
2254 const struct debug_level debug_levels[] = {
2255         { .name = "process",
2256           .help = "Process creation/exit logging",
2257           .shift = FD_PROCESS,
2258         },
2259         { .name = "file",
2260           .help = "File related action logging",
2261           .shift = FD_FILE,
2262         },
2263         { .name = "io",
2264           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2265           .shift = FD_IO,
2266         },
2267         { .name = "mem",
2268           .help = "Memory allocation/freeing logging",
2269           .shift = FD_MEM,
2270         },
2271         { .name = "blktrace",
2272           .help = "blktrace action logging",
2273           .shift = FD_BLKTRACE,
2274         },
2275         { .name = "verify",
2276           .help = "IO verification action logging",
2277           .shift = FD_VERIFY,
2278         },
2279         { .name = "random",
2280           .help = "Random generation logging",
2281           .shift = FD_RANDOM,
2282         },
2283         { .name = "parse",
2284           .help = "Parser logging",
2285           .shift = FD_PARSE,
2286         },
2287         { .name = "diskutil",
2288           .help = "Disk utility logging actions",
2289           .shift = FD_DISKUTIL,
2290         },
2291         { .name = "job",
2292           .help = "Logging related to creating/destroying jobs",
2293           .shift = FD_JOB,
2294         },
2295         { .name = "mutex",
2296           .help = "Mutex logging",
2297           .shift = FD_MUTEX
2298         },
2299         { .name = "profile",
2300           .help = "Logging related to profiles",
2301           .shift = FD_PROFILE,
2302         },
2303         { .name = "time",
2304           .help = "Logging related to time keeping functions",
2305           .shift = FD_TIME,
2306         },
2307         { .name = "net",
2308           .help = "Network logging",
2309           .shift = FD_NET,
2310         },
2311         { .name = "rate",
2312           .help = "Rate logging",
2313           .shift = FD_RATE,
2314         },
2315         { .name = "compress",
2316           .help = "Log compression logging",
2317           .shift = FD_COMPRESS,
2318         },
2319         { .name = "steadystate",
2320           .help = "Steady state detection logging",
2321           .shift = FD_STEADYSTATE,
2322         },
2323         { .name = "helperthread",
2324           .help = "Helper thread logging",
2325           .shift = FD_HELPERTHREAD,
2326         },
2327         { .name = "zbd",
2328           .help = "Zoned Block Device logging",
2329           .shift = FD_ZBD,
2330         },
2331         { .name = NULL, },
2332 };
2333
2334 static int set_debug(const char *string)
2335 {
2336         const struct debug_level *dl;
2337         char *p = (char *) string;
2338         char *opt;
2339         int i;
2340
2341         if (!string)
2342                 return 0;
2343
2344         if (!strcmp(string, "?") || !strcmp(string, "help")) {
2345                 log_info("fio: dumping debug options:");
2346                 for (i = 0; debug_levels[i].name; i++) {
2347                         dl = &debug_levels[i];
2348                         log_info("%s,", dl->name);
2349                 }
2350                 log_info("all\n");
2351                 return 1;
2352         }
2353
2354         while ((opt = strsep(&p, ",")) != NULL) {
2355                 int found = 0;
2356
2357                 if (!strncmp(opt, "all", 3)) {
2358                         log_info("fio: set all debug options\n");
2359                         fio_debug = ~0UL;
2360                         continue;
2361                 }
2362
2363                 for (i = 0; debug_levels[i].name; i++) {
2364                         dl = &debug_levels[i];
2365                         found = !strncmp(opt, dl->name, strlen(dl->name));
2366                         if (!found)
2367                                 continue;
2368
2369                         if (dl->shift == FD_JOB) {
2370                                 opt = strchr(opt, ':');
2371                                 if (!opt) {
2372                                         log_err("fio: missing job number\n");
2373                                         break;
2374                                 }
2375                                 opt++;
2376                                 fio_debug_jobno = atoi(opt);
2377                                 log_info("fio: set debug jobno %d\n",
2378                                                         fio_debug_jobno);
2379                         } else {
2380                                 log_info("fio: set debug option %s\n", opt);
2381                                 fio_debug |= (1UL << dl->shift);
2382                         }
2383                         break;
2384                 }
2385
2386                 if (!found)
2387                         log_err("fio: debug mask %s not found\n", opt);
2388         }
2389         return 0;
2390 }
2391 #else
2392 static int set_debug(const char *string)
2393 {
2394         log_err("fio: debug tracing not included in build\n");
2395         return 1;
2396 }
2397 #endif
2398
2399 static void fio_options_fill_optstring(void)
2400 {
2401         char *ostr = cmd_optstr;
2402         int i, c;
2403
2404         c = i = 0;
2405         while (l_opts[i].name) {
2406                 ostr[c++] = l_opts[i].val;
2407                 if (l_opts[i].has_arg == required_argument)
2408                         ostr[c++] = ':';
2409                 else if (l_opts[i].has_arg == optional_argument) {
2410                         ostr[c++] = ':';
2411                         ostr[c++] = ':';
2412                 }
2413                 i++;
2414         }
2415         ostr[c] = '\0';
2416 }
2417
2418 static int client_flag_set(char c)
2419 {
2420         int i;
2421
2422         i = 0;
2423         while (l_opts[i].name) {
2424                 int val = l_opts[i].val;
2425
2426                 if (c == (val & 0xff))
2427                         return (val & FIO_CLIENT_FLAG);
2428
2429                 i++;
2430         }
2431
2432         return 0;
2433 }
2434
2435 static void parse_cmd_client(void *client, char *opt)
2436 {
2437         fio_client_add_cmd_option(client, opt);
2438 }
2439
2440 static void show_closest_option(const char *name)
2441 {
2442         int best_option, best_distance;
2443         int i, distance;
2444
2445         while (*name == '-')
2446                 name++;
2447
2448         best_option = -1;
2449         best_distance = INT_MAX;
2450         i = 0;
2451         while (l_opts[i].name) {
2452                 distance = string_distance(name, l_opts[i].name);
2453                 if (distance < best_distance) {
2454                         best_distance = distance;
2455                         best_option = i;
2456                 }
2457                 i++;
2458         }
2459
2460         if (best_option != -1 && string_distance_ok(name, best_distance))
2461                 log_err("Did you mean %s?\n", l_opts[best_option].name);
2462 }
2463
2464 static int parse_output_format(const char *optarg)
2465 {
2466         char *p, *orig, *opt;
2467         int ret = 0;
2468
2469         p = orig = strdup(optarg);
2470
2471         output_format = 0;
2472
2473         while ((opt = strsep(&p, ",")) != NULL) {
2474                 if (!strcmp(opt, "minimal") ||
2475                     !strcmp(opt, "terse") ||
2476                     !strcmp(opt, "csv"))
2477                         output_format |= FIO_OUTPUT_TERSE;
2478                 else if (!strcmp(opt, "json"))
2479                         output_format |= FIO_OUTPUT_JSON;
2480                 else if (!strcmp(opt, "json+"))
2481                         output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2482                 else if (!strcmp(opt, "normal"))
2483                         output_format |= FIO_OUTPUT_NORMAL;
2484                 else {
2485                         log_err("fio: invalid output format %s\n", opt);
2486                         ret = 1;
2487                         break;
2488                 }
2489         }
2490
2491         free(orig);
2492         return ret;
2493 }
2494
2495 int parse_cmd_line(int argc, char *argv[], int client_type)
2496 {
2497         struct thread_data *td = NULL;
2498         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2499         char *ostr = cmd_optstr;
2500         char *pid_file = NULL;
2501         void *cur_client = NULL;
2502         bool backend = false;
2503
2504         /*
2505          * Reset optind handling, since we may call this multiple times
2506          * for the backend.
2507          */
2508         optind = 1;
2509
2510         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2511                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2512                         parse_cmd_client(cur_client, argv[optind - 1]);
2513                         c &= ~FIO_CLIENT_FLAG;
2514                 }
2515
2516                 switch (c) {
2517                 case 'a':
2518                         smalloc_pool_size = atoi(optarg);
2519                         smalloc_pool_size <<= 10;
2520                         sinit();
2521                         break;
2522                 case 'l':
2523                         log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2524                         do_exit++;
2525                         exit_val = 1;
2526                         break;
2527                 case 'b':
2528                         write_bw_log = true;
2529                         break;
2530                 case 'o': {
2531                         FILE *tmp;
2532
2533                         if (f_out && f_out != stdout)
2534                                 fclose(f_out);
2535
2536                         tmp = fopen(optarg, "w+");
2537                         if (!tmp) {
2538                                 log_err("fio: output file open error: %s\n", strerror(errno));
2539                                 exit_val = 1;
2540                                 do_exit++;
2541                                 break;
2542                         }
2543                         f_err = f_out = tmp;
2544                         break;
2545                         }
2546                 case 'm':
2547                         output_format = FIO_OUTPUT_TERSE;
2548                         break;
2549                 case 'F':
2550                         if (parse_output_format(optarg)) {
2551                                 log_err("fio: failed parsing output-format\n");
2552                                 exit_val = 1;
2553                                 do_exit++;
2554                                 break;
2555                         }
2556                         break;
2557                 case 'f':
2558                         output_format |= FIO_OUTPUT_TERSE;
2559                         break;
2560                 case 'h':
2561                         did_arg = true;
2562                         if (!cur_client) {
2563                                 usage(argv[0]);
2564                                 do_exit++;
2565                         }
2566                         break;
2567                 case 'c':
2568                         did_arg = true;
2569                         if (!cur_client) {
2570                                 fio_show_option_help(optarg);
2571                                 do_exit++;
2572                         }
2573                         break;
2574                 case 'i':
2575                         did_arg = true;
2576                         if (!cur_client) {
2577                                 exit_val = fio_show_ioengine_help(optarg);
2578                                 do_exit++;
2579                         }
2580                         break;
2581                 case 's':
2582                         did_arg = true;
2583                         dump_cmdline = true;
2584                         break;
2585                 case 'r':
2586                         read_only = 1;
2587                         break;
2588                 case 'v':
2589                         did_arg = true;
2590                         if (!cur_client) {
2591                                 log_info("%s\n", fio_version_string);
2592                                 do_exit++;
2593                         }
2594                         break;
2595                 case 'V':
2596                         terse_version = atoi(optarg);
2597                         if (!(terse_version >= 2 && terse_version <= 5)) {
2598                                 log_err("fio: bad terse version format\n");
2599                                 exit_val = 1;
2600                                 do_exit++;
2601                         }
2602                         break;
2603                 case 'e':
2604                         if (!strcmp("always", optarg))
2605                                 eta_print = FIO_ETA_ALWAYS;
2606                         else if (!strcmp("never", optarg))
2607                                 eta_print = FIO_ETA_NEVER;
2608                         break;
2609                 case 'E': {
2610                         long long t = 0;
2611
2612                         if (check_str_time(optarg, &t, 1)) {
2613                                 log_err("fio: failed parsing eta time %s\n", optarg);
2614                                 exit_val = 1;
2615                                 do_exit++;
2616                                 break;
2617                         }
2618                         eta_new_line = t / 1000;
2619                         if (!eta_new_line) {
2620                                 log_err("fio: eta new line time too short\n");
2621                                 exit_val = 1;
2622                                 do_exit++;
2623                         }
2624                         break;
2625                         }
2626                 case 'O': {
2627                         long long t = 0;
2628
2629                         if (check_str_time(optarg, &t, 1)) {
2630                                 log_err("fio: failed parsing eta interval %s\n", optarg);
2631                                 exit_val = 1;
2632                                 do_exit++;
2633                                 break;
2634                         }
2635                         eta_interval_msec = t / 1000;
2636                         if (eta_interval_msec < DISK_UTIL_MSEC) {
2637                                 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2638                                 exit_val = 1;
2639                                 do_exit++;
2640                         }
2641                         break;
2642                         }
2643                 case 'd':
2644                         if (set_debug(optarg))
2645                                 do_exit++;
2646                         break;
2647                 case 'P':
2648                         did_arg = true;
2649                         parse_only = true;
2650                         break;
2651                 case 'x': {
2652                         size_t new_size;
2653
2654                         if (!strcmp(optarg, "global")) {
2655                                 log_err("fio: can't use global as only "
2656                                         "section\n");
2657                                 do_exit++;
2658                                 exit_val = 1;
2659                                 break;
2660                         }
2661                         new_size = (nr_job_sections + 1) * sizeof(char *);
2662                         job_sections = realloc(job_sections, new_size);
2663                         job_sections[nr_job_sections] = strdup(optarg);
2664                         nr_job_sections++;
2665                         break;
2666                         }
2667 #ifdef CONFIG_ZLIB
2668                 case 'X':
2669                         exit_val = iolog_file_inflate(optarg);
2670                         did_arg = true;
2671                         do_exit++;
2672                         break;
2673 #endif
2674                 case 'p':
2675                         did_arg = true;
2676                         if (exec_profile)
2677                                 free(exec_profile);
2678                         exec_profile = strdup(optarg);
2679                         break;
2680                 case FIO_GETOPT_JOB: {
2681                         const char *opt = l_opts[lidx].name;
2682                         char *val = optarg;
2683
2684                         if (!strncmp(opt, "name", 4) && td) {
2685                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2686                                 if (ret)
2687                                         goto out_free;
2688                                 td = NULL;
2689                                 did_arg = true;
2690                         }
2691                         if (!td) {
2692                                 int is_section = !strncmp(opt, "name", 4);
2693                                 int global = 0;
2694
2695                                 if (!is_section || !strncmp(val, "global", 6))
2696                                         global = 1;
2697
2698                                 if (is_section && skip_this_section(val))
2699                                         continue;
2700
2701                                 td = get_new_job(global, &def_thread, true, NULL);
2702                                 if (!td || ioengine_load(td)) {
2703                                         if (td) {
2704                                                 put_job(td);
2705                                                 td = NULL;
2706                                         }
2707                                         do_exit++;
2708                                         exit_val = 1;
2709                                         break;
2710                                 }
2711                                 fio_options_set_ioengine_opts(l_opts, td);
2712                         }
2713
2714                         if ((!val || !strlen(val)) &&
2715                             l_opts[lidx].has_arg == required_argument) {
2716                                 log_err("fio: option %s requires an argument\n", opt);
2717                                 ret = 1;
2718                         } else
2719                                 ret = fio_cmd_option_parse(td, opt, val);
2720
2721                         if (ret) {
2722                                 if (td) {
2723                                         put_job(td);
2724                                         td = NULL;
2725                                 }
2726                                 do_exit++;
2727                                 exit_val = 1;
2728                         }
2729
2730                         if (!ret && !strcmp(opt, "ioengine")) {
2731                                 if (ioengine_load(td)) {
2732                                         put_job(td);
2733                                         td = NULL;
2734                                         do_exit++;
2735                                         exit_val = 1;
2736                                         break;
2737                                 }
2738                                 fio_options_set_ioengine_opts(l_opts, td);
2739                         }
2740                         break;
2741                 }
2742                 case FIO_GETOPT_IOENGINE: {
2743                         const char *opt = l_opts[lidx].name;
2744                         char *val = optarg;
2745
2746                         if (!td)
2747                                 break;
2748
2749                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
2750                         break;
2751                 }
2752                 case 'w':
2753                         warnings_fatal = 1;
2754                         break;
2755                 case 'j':
2756                         /* we don't track/need this anymore, ignore it */
2757                         break;
2758                 case 'S':
2759                         did_arg = true;
2760 #ifndef CONFIG_NO_SHM
2761                         if (nr_clients) {
2762                                 log_err("fio: can't be both client and server\n");
2763                                 do_exit++;
2764                                 exit_val = 1;
2765                                 break;
2766                         }
2767                         if (optarg)
2768                                 fio_server_set_arg(optarg);
2769                         is_backend = true;
2770                         backend = true;
2771 #else
2772                         log_err("fio: client/server requires SHM support\n");
2773                         do_exit++;
2774                         exit_val = 1;
2775 #endif
2776                         break;
2777                 case 'D':
2778                         if (pid_file)
2779                                 free(pid_file);
2780                         pid_file = strdup(optarg);
2781                         break;
2782                 case 'I':
2783                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
2784                                 /* exit on error and calibration only */
2785                                 did_arg = true;
2786                                 do_exit++;
2787                                 if (ret == -1)
2788                                         exit_val = 1;
2789                         }
2790                         break;
2791                 case 'C':
2792                         did_arg = true;
2793                         if (is_backend) {
2794                                 log_err("fio: can't be both client and server\n");
2795                                 do_exit++;
2796                                 exit_val = 1;
2797                                 break;
2798                         }
2799                         /* if --client parameter contains a pathname */
2800                         if (0 == access(optarg, R_OK)) {
2801                                 /* file contains a list of host addrs or names */
2802                                 char hostaddr[PATH_MAX] = {0};
2803                                 char formatstr[8];
2804                                 FILE * hostf = fopen(optarg, "r");
2805                                 if (!hostf) {
2806                                         log_err("fio: could not open client list file %s for read\n", optarg);
2807                                         do_exit++;
2808                                         exit_val = 1;
2809                                         break;
2810                                 }
2811                                 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2812                                 /*
2813                                  * read at most PATH_MAX-1 chars from each
2814                                  * record in this file
2815                                  */
2816                                 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2817                                         /* expect EVERY host in file to be valid */
2818                                         if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2819                                                 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2820                                                 do_exit++;
2821                                                 exit_val = 1;
2822                                                 break;
2823                                         }
2824                                 }
2825                                 fclose(hostf);
2826                                 break; /* no possibility of job file for "this client only" */
2827                         }
2828                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2829                                 log_err("fio: failed adding client %s\n", optarg);
2830                                 do_exit++;
2831                                 exit_val = 1;
2832                                 break;
2833                         }
2834                         /*
2835                          * If the next argument exists and isn't an option,
2836                          * assume it's a job file for this client only.
2837                          */
2838                         while (optind < argc) {
2839                                 if (!strncmp(argv[optind], "--", 2) ||
2840                                     !strncmp(argv[optind], "-", 1))
2841                                         break;
2842
2843                                 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2844                                         break;
2845                                 optind++;
2846                         }
2847                         break;
2848                 case 'R':
2849                         did_arg = true;
2850                         if (fio_client_add_ini_file(cur_client, optarg, true)) {
2851                                 do_exit++;
2852                                 exit_val = 1;
2853                         }
2854                         break;
2855                 case 'T':
2856                         did_arg = true;
2857                         do_exit++;
2858                         exit_val = fio_monotonic_clocktest(1);
2859                         break;
2860                 case 'G':
2861                         did_arg = true;
2862                         do_exit++;
2863                         exit_val = fio_crctest(optarg);
2864                         break;
2865                 case 'M':
2866                         did_arg = true;
2867                         do_exit++;
2868                         exit_val = fio_memcpy_test(optarg);
2869                         break;
2870                 case 'L': {
2871                         long long val;
2872
2873                         if (check_str_time(optarg, &val, 1)) {
2874                                 log_err("fio: failed parsing time %s\n", optarg);
2875                                 do_exit++;
2876                                 exit_val = 1;
2877                                 break;
2878                         }
2879                         if (val < 1000) {
2880                                 log_err("fio: status interval too small\n");
2881                                 do_exit++;
2882                                 exit_val = 1;
2883                         }
2884                         status_interval = val / 1000;
2885                         break;
2886                         }
2887                 case 'W':
2888                         if (trigger_file)
2889                                 free(trigger_file);
2890                         trigger_file = strdup(optarg);
2891                         break;
2892                 case 'H':
2893                         if (trigger_cmd)
2894                                 free(trigger_cmd);
2895                         trigger_cmd = strdup(optarg);
2896                         break;
2897                 case 'J':
2898                         if (trigger_remote_cmd)
2899                                 free(trigger_remote_cmd);
2900                         trigger_remote_cmd = strdup(optarg);
2901                         break;
2902                 case 'K':
2903                         if (aux_path)
2904                                 free(aux_path);
2905                         aux_path = strdup(optarg);
2906                         break;
2907                 case 'B':
2908                         if (check_str_time(optarg, &trigger_timeout, 1)) {
2909                                 log_err("fio: failed parsing time %s\n", optarg);
2910                                 do_exit++;
2911                                 exit_val = 1;
2912                         }
2913                         trigger_timeout /= 1000000;
2914                         break;
2915
2916                 case 'A':
2917                         did_arg = true;
2918                         merge_blktrace_only = true;
2919                         break;
2920                 case '?':
2921                         log_err("%s: unrecognized option '%s'\n", argv[0],
2922                                                         argv[optind - 1]);
2923                         show_closest_option(argv[optind - 1]);
2924                         fallthrough;
2925                 default:
2926                         do_exit++;
2927                         exit_val = 1;
2928                         break;
2929                 }
2930                 if (do_exit)
2931                         break;
2932         }
2933
2934         if (do_exit && !(is_backend || nr_clients))
2935                 exit(exit_val);
2936
2937         if (nr_clients && fio_clients_connect())
2938                 exit(1);
2939
2940         if (is_backend && backend)
2941                 return fio_start_server(pid_file);
2942         else if (pid_file)
2943                 free(pid_file);
2944
2945         if (td) {
2946                 if (!ret) {
2947                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2948                         if (ret)
2949                                 exit(1);
2950                 }
2951         }
2952
2953         while (!ret && optind < argc) {
2954                 ini_idx++;
2955                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2956                 ini_file[ini_idx - 1] = strdup(argv[optind]);
2957                 optind++;
2958         }
2959
2960 out_free:
2961         return ini_idx;
2962 }
2963
2964 int fio_init_options(void)
2965 {
2966         f_out = stdout;
2967         f_err = stderr;
2968
2969         fio_options_fill_optstring();
2970         fio_options_dup_and_init(l_opts);
2971
2972         atexit(free_shm);
2973
2974         if (fill_def_thread())
2975                 return 1;
2976
2977         return 0;
2978 }
2979
2980 extern int fio_check_options(struct thread_options *);
2981
2982 int parse_options(int argc, char *argv[])
2983 {
2984         const int type = FIO_CLIENT_TYPE_CLI;
2985         int job_files, i;
2986
2987         if (fio_init_options())
2988                 return 1;
2989         if (fio_test_cconv(&def_thread.o))
2990                 log_err("fio: failed internal cconv test\n");
2991
2992         job_files = parse_cmd_line(argc, argv, type);
2993
2994         if (job_files > 0) {
2995                 for (i = 0; i < job_files; i++) {
2996                         if (i && fill_def_thread())
2997                                 return 1;
2998                         if (nr_clients) {
2999                                 if (fio_clients_send_ini(ini_file[i]))
3000                                         return 1;
3001                                 free(ini_file[i]);
3002                         } else if (!is_backend) {
3003                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
3004                                         return 1;
3005                                 free(ini_file[i]);
3006                         }
3007                 }
3008         } else if (nr_clients) {
3009                 if (fill_def_thread())
3010                         return 1;
3011                 if (fio_clients_send_ini(NULL))
3012                         return 1;
3013         }
3014
3015         free(ini_file);
3016         fio_options_free(&def_thread);
3017         filesetup_mem_free();
3018
3019         if (!thread_number) {
3020                 if (parse_dryrun())
3021                         return 0;
3022                 if (exec_profile)
3023                         return 0;
3024                 if (is_backend || nr_clients)
3025                         return 0;
3026                 if (did_arg)
3027                         return 0;
3028
3029                 log_err("No job(s) defined\n\n");
3030                 usage(argv[0]);
3031                 return 1;
3032         }
3033
3034         if (output_format & FIO_OUTPUT_NORMAL)
3035                 log_info("%s\n", fio_version_string);
3036
3037         return 0;
3038 }
3039
3040 void options_default_fill(struct thread_options *o)
3041 {
3042         memcpy(o, &def_thread.o, sizeof(*o));
3043 }
3044
3045 struct thread_data *get_global_options(void)
3046 {
3047         return &def_thread;
3048 }