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