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