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