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