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