init.c

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