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