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