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