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