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