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