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