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