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