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  * Treat an empty log file name the same as a one not given
1423  */
1424 static const char *make_log_name(const char *logname, const char *jobname)
1425 {
1426         if (logname && strcmp(logname, ""))
1427                 return logname;
1428
1429         return jobname;
1430 }
1431
1432 /*
1433  * Adds a job to the list of things todo. Sanitizes the various options
1434  * to make sure we don't have conflicts, and initializes various
1435  * members of td.
1436  */
1437 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1438                    int recursed, int client_type)
1439 {
1440         unsigned int i;
1441         char fname[PATH_MAX];
1442         int numjobs, file_alloced;
1443         struct thread_options *o = &td->o;
1444         char logname[PATH_MAX + 32];
1445
1446         /*
1447          * the def_thread is just for options, it's not a real job
1448          */
1449         if (td == &def_thread)
1450                 return 0;
1451
1452         init_flags(td);
1453
1454         /*
1455          * if we are just dumping the output command line, don't add the job
1456          */
1457         if (parse_dryrun()) {
1458                 put_job(td);
1459                 return 0;
1460         }
1461
1462         td->client_type = client_type;
1463
1464         if (profile_td_init(td))
1465                 goto err;
1466
1467         if (ioengine_load(td))
1468                 goto err;
1469
1470         file_alloced = 0;
1471         if (!o->filename && !td->files_index && !o->read_iolog_file) {
1472                 file_alloced = 1;
1473
1474                 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1475                         add_file(td, jobname, job_add_num, 0);
1476                 else {
1477                         for (i = 0; i < o->nr_files; i++)
1478                                 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1479                 }
1480         }
1481
1482         if (setup_random_seeds(td)) {
1483                 td_verror(td, errno, "setup_random_seeds");
1484                 goto err;
1485         }
1486
1487         if (fixup_options(td))
1488                 goto err;
1489
1490         /*
1491          * Belongs to fixup_options, but o->name is not necessarily set as yet
1492          */
1493         if (!wait_for_ok(jobname, o))
1494                 goto err;
1495
1496         flow_init_job(td);
1497
1498         /*
1499          * IO engines only need this for option callbacks, and the address may
1500          * change in subprocesses.
1501          */
1502         if (td->eo)
1503                 *(struct thread_data **)td->eo = NULL;
1504
1505         if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1506                 struct fio_file *f;
1507
1508                 for_each_file(td, f, i)
1509                         f->real_file_size = -1ULL;
1510         }
1511
1512         td->sem = fio_sem_init(FIO_SEM_LOCKED);
1513
1514         td->ts.clat_percentiles = o->clat_percentiles;
1515         td->ts.lat_percentiles = o->lat_percentiles;
1516         td->ts.percentile_precision = o->percentile_precision;
1517         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1518         td->ts.sig_figs = o->sig_figs;
1519
1520         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1521                 td->ts.clat_stat[i].min_val = ULONG_MAX;
1522                 td->ts.slat_stat[i].min_val = ULONG_MAX;
1523                 td->ts.lat_stat[i].min_val = ULONG_MAX;
1524                 td->ts.bw_stat[i].min_val = ULONG_MAX;
1525                 td->ts.iops_stat[i].min_val = ULONG_MAX;
1526         }
1527         td->ts.sync_stat.min_val = ULONG_MAX;
1528         td->ddir_seq_nr = o->ddir_seq_nr;
1529
1530         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1531                 prev_group_jobs = 0;
1532                 groupid++;
1533                 if (groupid == INT_MAX) {
1534                         log_err("fio: too many groups defined\n");
1535                         goto err;
1536                 }
1537         }
1538
1539         td->groupid = groupid;
1540         prev_group_jobs++;
1541
1542         if (setup_rate(td))
1543                 goto err;
1544
1545         if (o->write_lat_log) {
1546                 struct log_params p = {
1547                         .td = td,
1548                         .avg_msec = o->log_avg_msec,
1549                         .hist_msec = o->log_hist_msec,
1550                         .hist_coarseness = o->log_hist_coarseness,
1551                         .log_type = IO_LOG_TYPE_LAT,
1552                         .log_offset = o->log_offset,
1553                         .log_gz = o->log_gz,
1554                         .log_gz_store = o->log_gz_store,
1555                 };
1556                 const char *pre = make_log_name(o->lat_log_file, o->name);
1557                 const char *suf;
1558
1559                 if (p.log_gz_store)
1560                         suf = "log.fz";
1561                 else
1562                         suf = "log";
1563
1564                 gen_log_name(logname, sizeof(logname), "lat", pre,
1565                                 td->thread_number, suf, o->per_job_logs);
1566                 setup_log(&td->lat_log, &p, logname);
1567
1568                 gen_log_name(logname, sizeof(logname), "slat", pre,
1569                                 td->thread_number, suf, o->per_job_logs);
1570                 setup_log(&td->slat_log, &p, logname);
1571
1572                 gen_log_name(logname, sizeof(logname), "clat", pre,
1573                                 td->thread_number, suf, o->per_job_logs);
1574                 setup_log(&td->clat_log, &p, logname);
1575
1576         }
1577
1578         if (o->write_hist_log) {
1579                 struct log_params p = {
1580                         .td = td,
1581                         .avg_msec = o->log_avg_msec,
1582                         .hist_msec = o->log_hist_msec,
1583                         .hist_coarseness = o->log_hist_coarseness,
1584                         .log_type = IO_LOG_TYPE_HIST,
1585                         .log_offset = o->log_offset,
1586                         .log_gz = o->log_gz,
1587                         .log_gz_store = o->log_gz_store,
1588                 };
1589                 const char *pre = make_log_name(o->hist_log_file, o->name);
1590                 const char *suf;
1591
1592 #ifndef CONFIG_ZLIB
1593                 if (td->client_type) {
1594                         log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1595                         goto err;
1596                 }
1597 #endif
1598
1599                 if (p.log_gz_store)
1600                         suf = "log.fz";
1601                 else
1602                         suf = "log";
1603
1604                 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1605                                 td->thread_number, suf, o->per_job_logs);
1606                 setup_log(&td->clat_hist_log, &p, logname);
1607         }
1608
1609         if (o->write_bw_log) {
1610                 struct log_params p = {
1611                         .td = td,
1612                         .avg_msec = o->log_avg_msec,
1613                         .hist_msec = o->log_hist_msec,
1614                         .hist_coarseness = o->log_hist_coarseness,
1615                         .log_type = IO_LOG_TYPE_BW,
1616                         .log_offset = o->log_offset,
1617                         .log_gz = o->log_gz,
1618                         .log_gz_store = o->log_gz_store,
1619                 };
1620                 const char *pre = make_log_name(o->bw_log_file, o->name);
1621                 const char *suf;
1622
1623                 if (fio_option_is_set(o, bw_avg_time))
1624                         p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1625                 else
1626                         o->bw_avg_time = p.avg_msec;
1627
1628                 p.hist_msec = o->log_hist_msec;
1629                 p.hist_coarseness = o->log_hist_coarseness;
1630
1631                 if (p.log_gz_store)
1632                         suf = "log.fz";
1633                 else
1634                         suf = "log";
1635
1636                 gen_log_name(logname, sizeof(logname), "bw", pre,
1637                                 td->thread_number, suf, o->per_job_logs);
1638                 setup_log(&td->bw_log, &p, logname);
1639         }
1640         if (o->write_iops_log) {
1641                 struct log_params p = {
1642                         .td = td,
1643                         .avg_msec = o->log_avg_msec,
1644                         .hist_msec = o->log_hist_msec,
1645                         .hist_coarseness = o->log_hist_coarseness,
1646                         .log_type = IO_LOG_TYPE_IOPS,
1647                         .log_offset = o->log_offset,
1648                         .log_gz = o->log_gz,
1649                         .log_gz_store = o->log_gz_store,
1650                 };
1651                 const char *pre = make_log_name(o->iops_log_file, o->name);
1652                 const char *suf;
1653
1654                 if (fio_option_is_set(o, iops_avg_time))
1655                         p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1656                 else
1657                         o->iops_avg_time = p.avg_msec;
1658
1659                 p.hist_msec = o->log_hist_msec;
1660                 p.hist_coarseness = o->log_hist_coarseness;
1661
1662                 if (p.log_gz_store)
1663                         suf = "log.fz";
1664                 else
1665                         suf = "log";
1666
1667                 gen_log_name(logname, sizeof(logname), "iops", pre,
1668                                 td->thread_number, suf, o->per_job_logs);
1669                 setup_log(&td->iops_log, &p, logname);
1670         }
1671
1672         if (!o->name)
1673                 o->name = strdup(jobname);
1674
1675         if (output_format & FIO_OUTPUT_NORMAL) {
1676                 if (!job_add_num) {
1677                         if (is_backend && !recursed)
1678                                 fio_server_send_add_job(td);
1679
1680                         if (!td_ioengine_flagged(td, FIO_NOIO)) {
1681                                 char *c1, *c2, *c3, *c4;
1682                                 char *c5 = NULL, *c6 = NULL;
1683                                 int i2p = is_power_of_2(o->kb_base);
1684                                 struct buf_output out;
1685
1686                                 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1687                                 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1688                                 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1689                                 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1690
1691                                 if (!o->bs_is_seq_rand) {
1692                                         c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1693                                         c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1694                                 }
1695
1696                                 buf_output_init(&out);
1697                                 log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1698                                                         td->groupid,
1699                                                         ddir_str(o->td_ddir));
1700
1701                                 if (o->bs_is_seq_rand)
1702                                         log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1703                                                         c1, c2, c3, c4);
1704                                 else
1705                                         log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1706                                                         c1, c2, c3, c4, c5, c6);
1707
1708                                 log_buf(&out, "ioengine=%s, iodepth=%u\n",
1709                                                 td->io_ops->name, o->iodepth);
1710                                 log_info_buf(out.buf, out.buflen);
1711
1712                                 free(c1);
1713                                 free(c2);
1714                                 free(c3);
1715                                 free(c4);
1716                                 free(c5);
1717                                 free(c6);
1718                         }
1719                 } else if (job_add_num == 1)
1720                         log_info("...\n");
1721         }
1722
1723         if (td_steadystate_init(td))
1724                 goto err;
1725
1726         /*
1727          * recurse add identical jobs, clear numjobs and stonewall options
1728          * as they don't apply to sub-jobs
1729          */
1730         numjobs = o->numjobs;
1731         while (--numjobs) {
1732                 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1733
1734                 if (!td_new)
1735                         goto err;
1736
1737                 td_new->o.numjobs = 1;
1738                 td_new->o.stonewall = 0;
1739                 td_new->o.new_group = 0;
1740                 td_new->subjob_number = numjobs;
1741                 td_new->o.ss_dur = o->ss_dur * 1000000l;
1742                 td_new->o.ss_limit = o->ss_limit;
1743
1744                 if (file_alloced) {
1745                         if (td_new->files) {
1746                                 struct fio_file *f;
1747                                 for_each_file(td_new, f, i) {
1748                                         if (f->file_name)
1749                                                 sfree(f->file_name);
1750                                         sfree(f);
1751                                 }
1752                                 free(td_new->files);
1753                                 td_new->files = NULL;
1754                         }
1755                         td_new->files_index = 0;
1756                         td_new->files_size = 0;
1757                         if (td_new->o.filename) {
1758                                 free(td_new->o.filename);
1759                                 td_new->o.filename = NULL;
1760                         }
1761                 }
1762
1763                 if (add_job(td_new, jobname, numjobs, 1, client_type))
1764                         goto err;
1765         }
1766
1767         return 0;
1768 err:
1769         put_job(td);
1770         return -1;
1771 }
1772
1773 /*
1774  * Parse as if 'o' was a command line
1775  */
1776 void add_job_opts(const char **o, int client_type)
1777 {
1778         struct thread_data *td, *td_parent;
1779         int i, in_global = 1;
1780         char jobname[32];
1781
1782         i = 0;
1783         td_parent = td = NULL;
1784         while (o[i]) {
1785                 if (!strncmp(o[i], "name", 4)) {
1786                         in_global = 0;
1787                         if (td)
1788                                 add_job(td, jobname, 0, 0, client_type);
1789                         td = NULL;
1790                         sprintf(jobname, "%s", o[i] + 5);
1791                 }
1792                 if (in_global && !td_parent)
1793                         td_parent = get_new_job(true, &def_thread, false, jobname);
1794                 else if (!in_global && !td) {
1795                         if (!td_parent)
1796                                 td_parent = &def_thread;
1797                         td = get_new_job(false, td_parent, false, jobname);
1798                 }
1799                 if (in_global)
1800                         fio_options_parse(td_parent, (char **) &o[i], 1);
1801                 else
1802                         fio_options_parse(td, (char **) &o[i], 1);
1803                 i++;
1804         }
1805
1806         if (td)
1807                 add_job(td, jobname, 0, 0, client_type);
1808 }
1809
1810 static int skip_this_section(const char *name)
1811 {
1812         int i;
1813
1814         if (!nr_job_sections)
1815                 return 0;
1816         if (!strncmp(name, "global", 6))
1817                 return 0;
1818
1819         for (i = 0; i < nr_job_sections; i++)
1820                 if (!strcmp(job_sections[i], name))
1821                         return 0;
1822
1823         return 1;
1824 }
1825
1826 static int is_empty_or_comment(char *line)
1827 {
1828         unsigned int i;
1829
1830         for (i = 0; i < strlen(line); i++) {
1831                 if (line[i] == ';')
1832                         return 1;
1833                 if (line[i] == '#')
1834                         return 1;
1835                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1836                         return 0;
1837         }
1838
1839         return 1;
1840 }
1841
1842 /*
1843  * This is our [ini] type file parser.
1844  */
1845 static int __parse_jobs_ini(struct thread_data *td,
1846                 char *file, int is_buf, int stonewall_flag, int type,
1847                 int nested, char *name, char ***popts, int *aopts, int *nopts)
1848 {
1849         bool global = false;
1850         char *string;
1851         FILE *f;
1852         char *p;
1853         int ret = 0, stonewall;
1854         int first_sect = 1;
1855         int skip_fgets = 0;
1856         int inside_skip = 0;
1857         char **opts;
1858         int i, alloc_opts, num_opts;
1859
1860         dprint(FD_PARSE, "Parsing ini file %s\n", file);
1861         assert(td || !nested);
1862
1863         if (is_buf)
1864                 f = NULL;
1865         else {
1866                 if (!strcmp(file, "-"))
1867                         f = stdin;
1868                 else
1869                         f = fopen(file, "r");
1870
1871                 if (!f) {
1872                         int __err = errno;
1873
1874                         log_err("fio: unable to open '%s' job file\n", file);
1875                         if (td)
1876                                 td_verror(td, __err, "job file open");
1877                         return 1;
1878                 }
1879         }
1880
1881         string = malloc(4096);
1882
1883         /*
1884          * it's really 256 + small bit, 280 should suffice
1885          */
1886         if (!nested) {
1887                 name = malloc(280);
1888                 memset(name, 0, 280);
1889         }
1890
1891         opts = NULL;
1892         if (nested && popts) {
1893                 opts = *popts;
1894                 alloc_opts = *aopts;
1895                 num_opts = *nopts;
1896         }
1897
1898         if (!opts) {
1899                 alloc_opts = 8;
1900                 opts = malloc(sizeof(char *) * alloc_opts);
1901                 num_opts = 0;
1902         }
1903
1904         stonewall = stonewall_flag;
1905         do {
1906                 /*
1907                  * if skip_fgets is set, we already have loaded a line we
1908                  * haven't handled.
1909                  */
1910                 if (!skip_fgets) {
1911                         if (is_buf)
1912                                 p = strsep(&file, "\n");
1913                         else
1914                                 p = fgets(string, 4096, f);
1915                         if (!p)
1916                                 break;
1917                 }
1918
1919                 skip_fgets = 0;
1920                 strip_blank_front(&p);
1921                 strip_blank_end(p);
1922
1923                 dprint(FD_PARSE, "%s\n", p);
1924                 if (is_empty_or_comment(p))
1925                         continue;
1926
1927                 if (!nested) {
1928                         if (sscanf(p, "[%255[^\n]]", name) != 1) {
1929                                 if (inside_skip)
1930                                         continue;
1931
1932                                 log_err("fio: option <%s> outside of "
1933                                         "[] job section\n", p);
1934                                 ret = 1;
1935                                 break;
1936                         }
1937
1938                         name[strlen(name) - 1] = '\0';
1939
1940                         if (skip_this_section(name)) {
1941                                 inside_skip = 1;
1942                                 continue;
1943                         } else
1944                                 inside_skip = 0;
1945
1946                         dprint(FD_PARSE, "Parsing section [%s]\n", name);
1947
1948                         global = !strncmp(name, "global", 6);
1949
1950                         if (dump_cmdline) {
1951                                 if (first_sect)
1952                                         log_info("fio ");
1953                                 if (!global)
1954                                         log_info("--name=%s ", name);
1955                                 first_sect = 0;
1956                         }
1957
1958                         td = get_new_job(global, &def_thread, false, name);
1959                         if (!td) {
1960                                 ret = 1;
1961                                 break;
1962                         }
1963
1964                         /*
1965                          * Separate multiple job files by a stonewall
1966                          */
1967                         if (!global && stonewall) {
1968                                 td->o.stonewall = stonewall;
1969                                 stonewall = 0;
1970                         }
1971
1972                         num_opts = 0;
1973                         memset(opts, 0, alloc_opts * sizeof(char *));
1974                 }
1975                 else
1976                         skip_fgets = 1;
1977
1978                 while (1) {
1979                         if (!skip_fgets) {
1980                                 if (is_buf)
1981                                         p = strsep(&file, "\n");
1982                                 else
1983                                         p = fgets(string, 4096, f);
1984                                 if (!p)
1985                                         break;
1986                                 dprint(FD_PARSE, "%s", p);
1987                         }
1988                         else
1989                                 skip_fgets = 0;
1990
1991                         if (is_empty_or_comment(p))
1992                                 continue;
1993
1994                         strip_blank_front(&p);
1995
1996                         /*
1997                          * new section, break out and make sure we don't
1998                          * fgets() a new line at the top.
1999                          */
2000                         if (p[0] == '[') {
2001                                 if (nested) {
2002                                         log_err("No new sections in included files\n");
2003                                         ret = 1;
2004                                         goto out;
2005                                 }
2006
2007                                 skip_fgets = 1;
2008                                 break;
2009                         }
2010
2011                         strip_blank_end(p);
2012
2013                         if (!strncmp(p, "include", strlen("include"))) {
2014                                 char *filename = p + strlen("include") + 1,
2015                                         *ts, *full_fn = NULL;
2016
2017                                 /*
2018                                  * Allow for the include filename
2019                                  * specification to be relative.
2020                                  */
2021                                 if (access(filename, F_OK) &&
2022                                     (ts = strrchr(file, '/'))) {
2023                                         int len = ts - file +
2024                                                 strlen(filename) + 2;
2025
2026                                         if (!(full_fn = calloc(1, len))) {
2027                                                 ret = ENOMEM;
2028                                                 break;
2029                                         }
2030
2031                                         strncpy(full_fn,
2032                                                 file, (ts - file) + 1);
2033                                         strncpy(full_fn + (ts - file) + 1,
2034                                                 filename, strlen(filename));
2035                                         full_fn[len - 1] = 0;
2036                                         filename = full_fn;
2037                                 }
2038
2039                                 ret = __parse_jobs_ini(td, filename, is_buf,
2040                                                        stonewall_flag, type, 1,
2041                                                        name, &opts,
2042                                                        &alloc_opts, &num_opts);
2043
2044                                 if (ret) {
2045                                         log_err("Error %d while parsing "
2046                                                 "include file %s\n",
2047                                                 ret, filename);
2048                                 }
2049
2050                                 if (full_fn)
2051                                         free(full_fn);
2052
2053                                 if (ret)
2054                                         break;
2055
2056                                 continue;
2057                         }
2058
2059                         if (num_opts == alloc_opts) {
2060                                 alloc_opts <<= 1;
2061                                 opts = realloc(opts,
2062                                                 alloc_opts * sizeof(char *));
2063                         }
2064
2065                         opts[num_opts] = strdup(p);
2066                         num_opts++;
2067                 }
2068
2069                 if (nested) {
2070                         *popts = opts;
2071                         *aopts = alloc_opts;
2072                         *nopts = num_opts;
2073                         goto out;
2074                 }
2075
2076                 ret = fio_options_parse(td, opts, num_opts);
2077                 if (!ret) {
2078                         if (dump_cmdline)
2079                                 dump_opt_list(td);
2080
2081                         ret = add_job(td, name, 0, 0, type);
2082                 } else {
2083                         log_err("fio: job %s dropped\n", name);
2084                         put_job(td);
2085                 }
2086
2087                 for (i = 0; i < num_opts; i++)
2088                         free(opts[i]);
2089                 num_opts = 0;
2090         } while (!ret);
2091
2092         if (dump_cmdline)
2093                 log_info("\n");
2094
2095         i = 0;
2096         while (i < nr_job_sections) {
2097                 free(job_sections[i]);
2098                 i++;
2099         }
2100
2101         free(opts);
2102 out:
2103         free(string);
2104         if (!nested)
2105                 free(name);
2106         if (!is_buf && f != stdin)
2107                 fclose(f);
2108         return ret;
2109 }
2110
2111 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2112 {
2113         return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2114                         0, NULL, NULL, NULL, NULL);
2115 }
2116
2117 static int fill_def_thread(void)
2118 {
2119         memset(&def_thread, 0, sizeof(def_thread));
2120         INIT_FLIST_HEAD(&def_thread.opt_list);
2121
2122         fio_getaffinity(getpid(), &def_thread.o.cpumask);
2123         def_thread.o.error_dump = 1;
2124
2125         /*
2126          * fill default options
2127          */
2128         fio_fill_default_options(&def_thread);
2129         return 0;
2130 }
2131
2132 static void show_debug_categories(void)
2133 {
2134 #ifdef FIO_INC_DEBUG
2135         const struct debug_level *dl = &debug_levels[0];
2136         int curlen, first = 1;
2137
2138         curlen = 0;
2139         while (dl->name) {
2140                 int has_next = (dl + 1)->name != NULL;
2141
2142                 if (first || curlen + strlen(dl->name) >= 80) {
2143                         if (!first) {
2144                                 printf("\n");
2145                                 curlen = 0;
2146                         }
2147                         curlen += printf("\t\t\t%s", dl->name);
2148                         curlen += 3 * (8 - 1);
2149                         if (has_next)
2150                                 curlen += printf(",");
2151                 } else {
2152                         curlen += printf("%s", dl->name);
2153                         if (has_next)
2154                                 curlen += printf(",");
2155                 }
2156                 dl++;
2157                 first = 0;
2158         }
2159         printf("\n");
2160 #endif
2161 }
2162
2163 /*
2164  * Following options aren't printed by usage().
2165  * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2166  * --latency-log - Deprecated option.
2167  */
2168 static void usage(const char *name)
2169 {
2170         printf("%s\n", fio_version_string);
2171         printf("%s [options] [job options] <job file(s)>\n", name);
2172         printf("  --debug=options\tEnable debug logging. May be one/more of:\n");
2173         show_debug_categories();
2174         printf("  --parse-only\t\tParse options only, don't start any IO\n");
2175         printf("  --output\t\tWrite output to file\n");
2176         printf("  --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2177         printf("  --minimal\t\tMinimal (terse) output\n");
2178         printf("  --output-format=type\tOutput format (terse,json,json+,normal)\n");
2179         printf("  --terse-version=type\tSet terse version output format"
2180                 " (default 3, or 2 or 4)\n");
2181         printf("  --version\t\tPrint version info and exit\n");
2182         printf("  --help\t\tPrint this page\n");
2183         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
2184         printf("  --crctest=[type]\tTest speed of checksum functions\n");
2185         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2186                 " them\n");
2187         printf("  --enghelp=engine\tPrint ioengine help, or list"
2188                 " available ioengines\n");
2189         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
2190                 " cmd\n");
2191         printf("  --showcmd\t\tTurn a job file into command line options\n");
2192         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
2193         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
2194         printf("  --eta-newline=t\tForce a new line for every 't'");
2195         printf(" period passed\n");
2196         printf("  --status-interval=t\tForce full status dump every");
2197         printf(" 't' period passed\n");
2198         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
2199                 " writes\n");
2200         printf("  --section=name\tOnly run specified section in job file,"
2201                 " multiple sections can be specified\n");
2202         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
2203                 " (def 16384)\n");
2204         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
2205         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2206         printf("  --server=args\t\tStart a backend fio server\n");
2207         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
2208         printf("  --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2209         printf("  --remote-config=file\tTell fio server to load this local job file\n");
2210         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2211                 "\t\t\t(option=system,percpu) or run unit work\n"
2212                 "\t\t\tcalibration only (option=calibrate)\n");
2213 #ifdef CONFIG_ZLIB
2214         printf("  --inflate-log=log\tInflate and output compressed log\n");
2215 #endif
2216         printf("  --trigger-file=file\tExecute trigger cmd when file exists\n");
2217         printf("  --trigger-timeout=t\tExecute trigger at this time\n");
2218         printf("  --trigger=cmd\t\tSet this command as local trigger\n");
2219         printf("  --trigger-remote=cmd\tSet this command as remote trigger\n");
2220         printf("  --aux-path=path\tUse this path for fio state generated files\n");
2221         printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2222 }
2223
2224 #ifdef FIO_INC_DEBUG
2225 const struct debug_level debug_levels[] = {
2226         { .name = "process",
2227           .help = "Process creation/exit logging",
2228           .shift = FD_PROCESS,
2229         },
2230         { .name = "file",
2231           .help = "File related action logging",
2232           .shift = FD_FILE,
2233         },
2234         { .name = "io",
2235           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2236           .shift = FD_IO,
2237         },
2238         { .name = "mem",
2239           .help = "Memory allocation/freeing logging",
2240           .shift = FD_MEM,
2241         },
2242         { .name = "blktrace",
2243           .help = "blktrace action logging",
2244           .shift = FD_BLKTRACE,
2245         },
2246         { .name = "verify",
2247           .help = "IO verification action logging",
2248           .shift = FD_VERIFY,
2249         },
2250         { .name = "random",
2251           .help = "Random generation logging",
2252           .shift = FD_RANDOM,
2253         },
2254         { .name = "parse",
2255           .help = "Parser logging",
2256           .shift = FD_PARSE,
2257         },
2258         { .name = "diskutil",
2259           .help = "Disk utility logging actions",
2260           .shift = FD_DISKUTIL,
2261         },
2262         { .name = "job",
2263           .help = "Logging related to creating/destroying jobs",
2264           .shift = FD_JOB,
2265         },
2266         { .name = "mutex",
2267           .help = "Mutex logging",
2268           .shift = FD_MUTEX
2269         },
2270         { .name = "profile",
2271           .help = "Logging related to profiles",
2272           .shift = FD_PROFILE,
2273         },
2274         { .name = "time",
2275           .help = "Logging related to time keeping functions",
2276           .shift = FD_TIME,
2277         },
2278         { .name = "net",
2279           .help = "Network logging",
2280           .shift = FD_NET,
2281         },
2282         { .name = "rate",
2283           .help = "Rate logging",
2284           .shift = FD_RATE,
2285         },
2286         { .name = "compress",
2287           .help = "Log compression logging",
2288           .shift = FD_COMPRESS,
2289         },
2290         { .name = "steadystate",
2291           .help = "Steady state detection logging",
2292           .shift = FD_STEADYSTATE,
2293         },
2294         { .name = "helperthread",
2295           .help = "Helper thread logging",
2296           .shift = FD_HELPERTHREAD,
2297         },
2298         { .name = "zbd",
2299           .help = "Zoned Block Device logging",
2300           .shift = FD_ZBD,
2301         },
2302         { .name = NULL, },
2303 };
2304
2305 static int set_debug(const char *string)
2306 {
2307         const struct debug_level *dl;
2308         char *p = (char *) string;
2309         char *opt;
2310         int i;
2311
2312         if (!string)
2313                 return 0;
2314
2315         if (!strcmp(string, "?") || !strcmp(string, "help")) {
2316                 log_info("fio: dumping debug options:");
2317                 for (i = 0; debug_levels[i].name; i++) {
2318                         dl = &debug_levels[i];
2319                         log_info("%s,", dl->name);
2320                 }
2321                 log_info("all\n");
2322                 return 1;
2323         }
2324
2325         while ((opt = strsep(&p, ",")) != NULL) {
2326                 int found = 0;
2327
2328                 if (!strncmp(opt, "all", 3)) {
2329                         log_info("fio: set all debug options\n");
2330                         fio_debug = ~0UL;
2331                         continue;
2332                 }
2333
2334                 for (i = 0; debug_levels[i].name; i++) {
2335                         dl = &debug_levels[i];
2336                         found = !strncmp(opt, dl->name, strlen(dl->name));
2337                         if (!found)
2338                                 continue;
2339
2340                         if (dl->shift == FD_JOB) {
2341                                 opt = strchr(opt, ':');
2342                                 if (!opt) {
2343                                         log_err("fio: missing job number\n");
2344                                         break;
2345                                 }
2346                                 opt++;
2347                                 fio_debug_jobno = atoi(opt);
2348                                 log_info("fio: set debug jobno %d\n",
2349                                                         fio_debug_jobno);
2350                         } else {
2351                                 log_info("fio: set debug option %s\n", opt);
2352                                 fio_debug |= (1UL << dl->shift);
2353                         }
2354                         break;
2355                 }
2356
2357                 if (!found)
2358                         log_err("fio: debug mask %s not found\n", opt);
2359         }
2360         return 0;
2361 }
2362 #else
2363 static int set_debug(const char *string)
2364 {
2365         log_err("fio: debug tracing not included in build\n");
2366         return 1;
2367 }
2368 #endif
2369
2370 static void fio_options_fill_optstring(void)
2371 {
2372         char *ostr = cmd_optstr;
2373         int i, c;
2374
2375         c = i = 0;
2376         while (l_opts[i].name) {
2377                 ostr[c++] = l_opts[i].val;
2378                 if (l_opts[i].has_arg == required_argument)
2379                         ostr[c++] = ':';
2380                 else if (l_opts[i].has_arg == optional_argument) {
2381                         ostr[c++] = ':';
2382                         ostr[c++] = ':';
2383                 }
2384                 i++;
2385         }
2386         ostr[c] = '\0';
2387 }
2388
2389 static int client_flag_set(char c)
2390 {
2391         int i;
2392
2393         i = 0;
2394         while (l_opts[i].name) {
2395                 int val = l_opts[i].val;
2396
2397                 if (c == (val & 0xff))
2398                         return (val & FIO_CLIENT_FLAG);
2399
2400                 i++;
2401         }
2402
2403         return 0;
2404 }
2405
2406 static void parse_cmd_client(void *client, char *opt)
2407 {
2408         fio_client_add_cmd_option(client, opt);
2409 }
2410
2411 static void show_closest_option(const char *name)
2412 {
2413         int best_option, best_distance;
2414         int i, distance;
2415
2416         while (*name == '-')
2417                 name++;
2418
2419         best_option = -1;
2420         best_distance = INT_MAX;
2421         i = 0;
2422         while (l_opts[i].name) {
2423                 distance = string_distance(name, l_opts[i].name);
2424                 if (distance < best_distance) {
2425                         best_distance = distance;
2426                         best_option = i;
2427                 }
2428                 i++;
2429         }
2430
2431         if (best_option != -1 && string_distance_ok(name, best_distance))
2432                 log_err("Did you mean %s?\n", l_opts[best_option].name);
2433 }
2434
2435 static int parse_output_format(const char *optarg)
2436 {
2437         char *p, *orig, *opt;
2438         int ret = 0;
2439
2440         p = orig = strdup(optarg);
2441
2442         output_format = 0;
2443
2444         while ((opt = strsep(&p, ",")) != NULL) {
2445                 if (!strcmp(opt, "minimal") ||
2446                     !strcmp(opt, "terse") ||
2447                     !strcmp(opt, "csv"))
2448                         output_format |= FIO_OUTPUT_TERSE;
2449                 else if (!strcmp(opt, "json"))
2450                         output_format |= FIO_OUTPUT_JSON;
2451                 else if (!strcmp(opt, "json+"))
2452                         output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2453                 else if (!strcmp(opt, "normal"))
2454                         output_format |= FIO_OUTPUT_NORMAL;
2455                 else {
2456                         log_err("fio: invalid output format %s\n", opt);
2457                         ret = 1;
2458                         break;
2459                 }
2460         }
2461
2462         free(orig);
2463         return ret;
2464 }
2465
2466 int parse_cmd_line(int argc, char *argv[], int client_type)
2467 {
2468         struct thread_data *td = NULL;
2469         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2470         char *ostr = cmd_optstr;
2471         char *pid_file = NULL;
2472         void *cur_client = NULL;
2473         int backend = 0;
2474
2475         /*
2476          * Reset optind handling, since we may call this multiple times
2477          * for the backend.
2478          */
2479         optind = 1;
2480
2481         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2482                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2483                         parse_cmd_client(cur_client, argv[optind - 1]);
2484                         c &= ~FIO_CLIENT_FLAG;
2485                 }
2486
2487                 switch (c) {
2488                 case 'a':
2489                         smalloc_pool_size = atoi(optarg);
2490                         smalloc_pool_size <<= 10;
2491                         sinit();
2492                         break;
2493                 case 'l':
2494                         log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2495                         do_exit++;
2496                         exit_val = 1;
2497                         break;
2498                 case 'b':
2499                         write_bw_log = 1;
2500                         break;
2501                 case 'o': {
2502                         FILE *tmp;
2503
2504                         if (f_out && f_out != stdout)
2505                                 fclose(f_out);
2506
2507                         tmp = fopen(optarg, "w+");
2508                         if (!tmp) {
2509                                 log_err("fio: output file open error: %s\n", strerror(errno));
2510                                 exit_val = 1;
2511                                 do_exit++;
2512                                 break;
2513                         }
2514                         f_err = f_out = tmp;
2515                         break;
2516                         }
2517                 case 'm':
2518                         output_format = FIO_OUTPUT_TERSE;
2519                         break;
2520                 case 'F':
2521                         if (parse_output_format(optarg)) {
2522                                 log_err("fio: failed parsing output-format\n");
2523                                 exit_val = 1;
2524                                 do_exit++;
2525                                 break;
2526                         }
2527                         break;
2528                 case 'f':
2529                         output_format |= FIO_OUTPUT_TERSE;
2530                         break;
2531                 case 'h':
2532                         did_arg = true;
2533                         if (!cur_client) {
2534                                 usage(argv[0]);
2535                                 do_exit++;
2536                         }
2537                         break;
2538                 case 'c':
2539                         did_arg = true;
2540                         if (!cur_client) {
2541                                 fio_show_option_help(optarg);
2542                                 do_exit++;
2543                         }
2544                         break;
2545                 case 'i':
2546                         did_arg = true;
2547                         if (!cur_client) {
2548                                 fio_show_ioengine_help(optarg);
2549                                 do_exit++;
2550                         }
2551                         break;
2552                 case 's':
2553                         did_arg = true;
2554                         dump_cmdline = 1;
2555                         break;
2556                 case 'r':
2557                         read_only = 1;
2558                         break;
2559                 case 'v':
2560                         did_arg = true;
2561                         if (!cur_client) {
2562                                 log_info("%s\n", fio_version_string);
2563                                 do_exit++;
2564                         }
2565                         break;
2566                 case 'V':
2567                         terse_version = atoi(optarg);
2568                         if (!(terse_version >= 2 && terse_version <= 5)) {
2569                                 log_err("fio: bad terse version format\n");
2570                                 exit_val = 1;
2571                                 do_exit++;
2572                         }
2573                         break;
2574                 case 'e':
2575                         if (!strcmp("always", optarg))
2576                                 eta_print = FIO_ETA_ALWAYS;
2577                         else if (!strcmp("never", optarg))
2578                                 eta_print = FIO_ETA_NEVER;
2579                         break;
2580                 case 'E': {
2581                         long long t = 0;
2582
2583                         if (check_str_time(optarg, &t, 1)) {
2584                                 log_err("fio: failed parsing eta time %s\n", optarg);
2585                                 exit_val = 1;
2586                                 do_exit++;
2587                                 break;
2588                         }
2589                         eta_new_line = t / 1000;
2590                         if (!eta_new_line) {
2591                                 log_err("fio: eta new line time too short\n");
2592                                 exit_val = 1;
2593                                 do_exit++;
2594                         }
2595                         break;
2596                         }
2597                 case 'O': {
2598                         long long t = 0;
2599
2600                         if (check_str_time(optarg, &t, 1)) {
2601                                 log_err("fio: failed parsing eta interval %s\n", optarg);
2602                                 exit_val = 1;
2603                                 do_exit++;
2604                                 break;
2605                         }
2606                         eta_interval_msec = t / 1000;
2607                         if (eta_interval_msec < DISK_UTIL_MSEC) {
2608                                 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2609                                 exit_val = 1;
2610                                 do_exit++;
2611                         }
2612                         break;
2613                         }
2614                 case 'd':
2615                         if (set_debug(optarg))
2616                                 do_exit++;
2617                         break;
2618                 case 'P':
2619                         did_arg = true;
2620                         parse_only = 1;
2621                         break;
2622                 case 'x': {
2623                         size_t new_size;
2624
2625                         if (!strcmp(optarg, "global")) {
2626                                 log_err("fio: can't use global as only "
2627                                         "section\n");
2628                                 do_exit++;
2629                                 exit_val = 1;
2630                                 break;
2631                         }
2632                         new_size = (nr_job_sections + 1) * sizeof(char *);
2633                         job_sections = realloc(job_sections, new_size);
2634                         job_sections[nr_job_sections] = strdup(optarg);
2635                         nr_job_sections++;
2636                         break;
2637                         }
2638 #ifdef CONFIG_ZLIB
2639                 case 'X':
2640                         exit_val = iolog_file_inflate(optarg);
2641                         did_arg = true;
2642                         do_exit++;
2643                         break;
2644 #endif
2645                 case 'p':
2646                         did_arg = true;
2647                         if (exec_profile)
2648                                 free(exec_profile);
2649                         exec_profile = strdup(optarg);
2650                         break;
2651                 case FIO_GETOPT_JOB: {
2652                         const char *opt = l_opts[lidx].name;
2653                         char *val = optarg;
2654
2655                         if (!strncmp(opt, "name", 4) && td) {
2656                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2657                                 if (ret)
2658                                         goto out_free;
2659                                 td = NULL;
2660                                 did_arg = true;
2661                         }
2662                         if (!td) {
2663                                 int is_section = !strncmp(opt, "name", 4);
2664                                 int global = 0;
2665
2666                                 if (!is_section || !strncmp(val, "global", 6))
2667                                         global = 1;
2668
2669                                 if (is_section && skip_this_section(val))
2670                                         continue;
2671
2672                                 td = get_new_job(global, &def_thread, true, NULL);
2673                                 if (!td || ioengine_load(td)) {
2674                                         if (td) {
2675                                                 put_job(td);
2676                                                 td = NULL;
2677                                         }
2678                                         do_exit++;
2679                                         exit_val = 1;
2680                                         break;
2681                                 }
2682                                 fio_options_set_ioengine_opts(l_opts, td);
2683                         }
2684
2685                         if ((!val || !strlen(val)) &&
2686                             l_opts[lidx].has_arg == required_argument) {
2687                                 log_err("fio: option %s requires an argument\n", opt);
2688                                 ret = 1;
2689                         } else
2690                                 ret = fio_cmd_option_parse(td, opt, val);
2691
2692                         if (ret) {
2693                                 if (td) {
2694                                         put_job(td);
2695                                         td = NULL;
2696                                 }
2697                                 do_exit++;
2698                                 exit_val = 1;
2699                         }
2700
2701                         if (!ret && !strcmp(opt, "ioengine")) {
2702                                 if (ioengine_load(td)) {
2703                                         put_job(td);
2704                                         td = NULL;
2705                                         do_exit++;
2706                                         exit_val = 1;
2707                                         break;
2708                                 }
2709                                 fio_options_set_ioengine_opts(l_opts, td);
2710                         }
2711                         break;
2712                 }
2713                 case FIO_GETOPT_IOENGINE: {
2714                         const char *opt = l_opts[lidx].name;
2715                         char *val = optarg;
2716
2717                         if (!td)
2718                                 break;
2719
2720                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
2721                         break;
2722                 }
2723                 case 'w':
2724                         warnings_fatal = 1;
2725                         break;
2726                 case 'j':
2727                         max_jobs = atoi(optarg);
2728                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2729                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
2730                                 do_exit++;
2731                                 exit_val = 1;
2732                         }
2733                         break;
2734                 case 'S':
2735                         did_arg = true;
2736 #ifndef CONFIG_NO_SHM
2737                         if (nr_clients) {
2738                                 log_err("fio: can't be both client and server\n");
2739                                 do_exit++;
2740                                 exit_val = 1;
2741                                 break;
2742                         }
2743                         if (optarg)
2744                                 fio_server_set_arg(optarg);
2745                         is_backend = 1;
2746                         backend = 1;
2747 #else
2748                         log_err("fio: client/server requires SHM support\n");
2749                         do_exit++;
2750                         exit_val = 1;
2751 #endif
2752                         break;
2753                 case 'D':
2754                         if (pid_file)
2755                                 free(pid_file);
2756                         pid_file = strdup(optarg);
2757                         break;
2758                 case 'I':
2759                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
2760                                 /* exit on error and calibration only */
2761                                 did_arg = true;
2762                                 do_exit++;
2763                                 if (ret == -1)
2764                                         exit_val = 1;
2765                         }
2766                         break;
2767                 case 'C':
2768                         did_arg = true;
2769                         if (is_backend) {
2770                                 log_err("fio: can't be both client and server\n");
2771                                 do_exit++;
2772                                 exit_val = 1;
2773                                 break;
2774                         }
2775                         /* if --client parameter contains a pathname */
2776                         if (0 == access(optarg, R_OK)) {
2777                                 /* file contains a list of host addrs or names */
2778                                 char hostaddr[PATH_MAX] = {0};
2779                                 char formatstr[8];
2780                                 FILE * hostf = fopen(optarg, "r");
2781                                 if (!hostf) {
2782                                         log_err("fio: could not open client list file %s for read\n", optarg);
2783                                         do_exit++;
2784                                         exit_val = 1;
2785                                         break;
2786                                 }
2787                                 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2788                                 /*
2789                                  * read at most PATH_MAX-1 chars from each
2790                                  * record in this file
2791                                  */
2792                                 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2793                                         /* expect EVERY host in file to be valid */
2794                                         if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2795                                                 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2796                                                 do_exit++;
2797                                                 exit_val = 1;
2798                                                 break;
2799                                         }
2800                                 }
2801                                 fclose(hostf);
2802                                 break; /* no possibility of job file for "this client only" */
2803                         }
2804                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2805                                 log_err("fio: failed adding client %s\n", optarg);
2806                                 do_exit++;
2807                                 exit_val = 1;
2808                                 break;
2809                         }
2810                         /*
2811                          * If the next argument exists and isn't an option,
2812                          * assume it's a job file for this client only.
2813                          */
2814                         while (optind < argc) {
2815                                 if (!strncmp(argv[optind], "--", 2) ||
2816                                     !strncmp(argv[optind], "-", 1))
2817                                         break;
2818
2819                                 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2820                                         break;
2821                                 optind++;
2822                         }
2823                         break;
2824                 case 'R':
2825                         did_arg = true;
2826                         if (fio_client_add_ini_file(cur_client, optarg, true)) {
2827                                 do_exit++;
2828                                 exit_val = 1;
2829                         }
2830                         break;
2831                 case 'T':
2832                         did_arg = true;
2833                         do_exit++;
2834                         exit_val = fio_monotonic_clocktest(1);
2835                         break;
2836                 case 'G':
2837                         did_arg = true;
2838                         do_exit++;
2839                         exit_val = fio_crctest(optarg);
2840                         break;
2841                 case 'M':
2842                         did_arg = true;
2843                         do_exit++;
2844                         exit_val = fio_memcpy_test(optarg);
2845                         break;
2846                 case 'L': {
2847                         long long val;
2848
2849                         if (check_str_time(optarg, &val, 1)) {
2850                                 log_err("fio: failed parsing time %s\n", optarg);
2851                                 do_exit++;
2852                                 exit_val = 1;
2853                                 break;
2854                         }
2855                         if (val < 1000) {
2856                                 log_err("fio: status interval too small\n");
2857                                 do_exit++;
2858                                 exit_val = 1;
2859                         }
2860                         status_interval = val / 1000;
2861                         break;
2862                         }
2863                 case 'W':
2864                         if (trigger_file)
2865                                 free(trigger_file);
2866                         trigger_file = strdup(optarg);
2867                         break;
2868                 case 'H':
2869                         if (trigger_cmd)
2870                                 free(trigger_cmd);
2871                         trigger_cmd = strdup(optarg);
2872                         break;
2873                 case 'J':
2874                         if (trigger_remote_cmd)
2875                                 free(trigger_remote_cmd);
2876                         trigger_remote_cmd = strdup(optarg);
2877                         break;
2878                 case 'K':
2879                         if (aux_path)
2880                                 free(aux_path);
2881                         aux_path = strdup(optarg);
2882                         break;
2883                 case 'B':
2884                         if (check_str_time(optarg, &trigger_timeout, 1)) {
2885                                 log_err("fio: failed parsing time %s\n", optarg);
2886                                 do_exit++;
2887                                 exit_val = 1;
2888                         }
2889                         trigger_timeout /= 1000000;
2890                         break;
2891                 case '?':
2892                         log_err("%s: unrecognized option '%s'\n", argv[0],
2893                                                         argv[optind - 1]);
2894                         show_closest_option(argv[optind - 1]);
2895                 default:
2896                         do_exit++;
2897                         exit_val = 1;
2898                         break;
2899                 }
2900                 if (do_exit)
2901                         break;
2902         }
2903
2904         if (do_exit && !(is_backend || nr_clients))
2905                 exit(exit_val);
2906
2907         if (nr_clients && fio_clients_connect())
2908                 exit(1);
2909
2910         if (is_backend && backend)
2911                 return fio_start_server(pid_file);
2912         else if (pid_file)
2913                 free(pid_file);
2914
2915         if (td) {
2916                 if (!ret) {
2917                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2918                         if (ret)
2919                                 exit(1);
2920                 }
2921         }
2922
2923         while (!ret && optind < argc) {
2924                 ini_idx++;
2925                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2926                 ini_file[ini_idx - 1] = strdup(argv[optind]);
2927                 optind++;
2928         }
2929
2930 out_free:
2931         return ini_idx;
2932 }
2933
2934 int fio_init_options(void)
2935 {
2936         f_out = stdout;
2937         f_err = stderr;
2938
2939         fio_options_fill_optstring();
2940         fio_options_dup_and_init(l_opts);
2941
2942         atexit(free_shm);
2943
2944         if (fill_def_thread())
2945                 return 1;
2946
2947         return 0;
2948 }
2949
2950 extern int fio_check_options(struct thread_options *);
2951
2952 int parse_options(int argc, char *argv[])
2953 {
2954         const int type = FIO_CLIENT_TYPE_CLI;
2955         int job_files, i;
2956
2957         if (fio_init_options())
2958                 return 1;
2959         if (fio_test_cconv(&def_thread.o))
2960                 log_err("fio: failed internal cconv test\n");
2961
2962         job_files = parse_cmd_line(argc, argv, type);
2963
2964         if (job_files > 0) {
2965                 for (i = 0; i < job_files; i++) {
2966                         if (i && fill_def_thread())
2967                                 return 1;
2968                         if (nr_clients) {
2969                                 if (fio_clients_send_ini(ini_file[i]))
2970                                         return 1;
2971                                 free(ini_file[i]);
2972                         } else if (!is_backend) {
2973                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
2974                                         return 1;
2975                                 free(ini_file[i]);
2976                         }
2977                 }
2978         } else if (nr_clients) {
2979                 if (fill_def_thread())
2980                         return 1;
2981                 if (fio_clients_send_ini(NULL))
2982                         return 1;
2983         }
2984
2985         free(ini_file);
2986         fio_options_free(&def_thread);
2987         filesetup_mem_free();
2988
2989         if (!thread_number) {
2990                 if (parse_dryrun())
2991                         return 0;
2992                 if (exec_profile)
2993                         return 0;
2994                 if (is_backend || nr_clients)
2995                         return 0;
2996                 if (did_arg)
2997                         return 0;
2998
2999                 log_err("No job(s) defined\n\n");
3000                 usage(argv[0]);
3001                 return 1;
3002         }
3003
3004         if (output_format & FIO_OUTPUT_NORMAL)
3005                 log_info("%s\n", fio_version_string);
3006
3007         return 0;
3008 }
3009
3010 void options_default_fill(struct thread_options *o)
3011 {
3012         memcpy(o, &def_thread.o, sizeof(*o));
3013 }
3014
3015 struct thread_data *get_global_options(void)
3016 {
3017         return &def_thread;
3018 }