init.c

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