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