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