init.c

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