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 #ifndef FIO_NO_HAVE_SHM_H
  13 #include <sys/shm.h>
  14 #endif
  15 #include <sys/types.h>
  16 #include <sys/stat.h>
  17
  18 #include "fio.h"
  19 #include "parse.h"
  20 #include "smalloc.h"
  21 #include "filehash.h"
  22 #include "verify.h"
  23 #include "profile.h"
  24 #include "server.h"
  25
  26 #include "lib/getopt.h"
  27
  28 const char fio_version_string[] = FIO_VERSION;
  29
  30 #define FIO_RANDSEED            (0xb1899bedUL)
  31
  32 static char **ini_file;
  33 static int max_jobs = FIO_MAX_JOBS;
  34 static int dump_cmdline;
  35 static int def_timeout;
  36
  37 static struct thread_data def_thread;
  38 struct thread_data *threads = NULL;
  39
  40 int exitall_on_terminate = 0;
  41 int output_format = FIO_OUTPUT_NORMAL;
  42 int eta_print;
  43 unsigned long long mlock_size = 0;
  44 FILE *f_out = NULL;
  45 FILE *f_err = NULL;
  46 char **job_sections = NULL;
  47 int nr_job_sections = 0;
  48 char *exec_profile = NULL;
  49 int warnings_fatal = 0;
  50 int terse_version = 3;
  51 int is_backend = 0;
  52 int nr_clients = 0;
  53 int log_syslog = 0;
  54
  55 int write_bw_log = 0;
  56 int read_only = 0;
  57
  58 static int write_lat_log;
  59
  60 static int prev_group_jobs;
  61
  62 unsigned long fio_debug = 0;
  63 unsigned int fio_debug_jobno = -1;
  64 unsigned int *fio_debug_jobp = NULL;
  65
  66 static char cmd_optstr[256];
  67 static int did_arg;
  68
  69 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
  70         { .u.f  =  1.00 },
  71         { .u.f  =  5.00 },
  72         { .u.f  = 10.00 },
  73         { .u.f  = 20.00 },
  74         { .u.f  = 30.00 },
  75         { .u.f  = 40.00 },
  76         { .u.f  = 50.00 },
  77         { .u.f  = 60.00 },
  78         { .u.f  = 70.00 },
  79         { .u.f  = 80.00 },
  80         { .u.f  = 90.00 },
  81         { .u.f  = 95.00 },
  82         { .u.f  = 99.00 },
  83         { .u.f  = 99.50 },
  84         { .u.f  = 99.90 },
  85         { .u.f  = 99.95 },
  86         { .u.f  = 99.99 },
  87 };
  88
  89 #define FIO_CLIENT_FLAG         (1 << 16)
  90
  91 /*
  92  * Command line options. These will contain the above, plus a few
  93  * extra that only pertain to fio itself and not jobs.
  94  */
  95 static struct option l_opts[FIO_NR_OPTIONS] = {
  96         {
  97                 .name           = (char *) "output",
  98                 .has_arg        = required_argument,
  99                 .val            = 'o' | FIO_CLIENT_FLAG,
 100         },
 101         {
 102                 .name           = (char *) "timeout",
 103                 .has_arg        = required_argument,
 104                 .val            = 't' | FIO_CLIENT_FLAG,
 105         },
 106         {
 107                 .name           = (char *) "latency-log",
 108                 .has_arg        = required_argument,
 109                 .val            = 'l' | FIO_CLIENT_FLAG,
 110         },
 111         {
 112                 .name           = (char *) "bandwidth-log",
 113                 .has_arg        = required_argument,
 114                 .val            = 'b' | FIO_CLIENT_FLAG,
 115         },
 116         {
 117                 .name           = (char *) "minimal",
 118                 .has_arg        = optional_argument,
 119                 .val            = 'm' | FIO_CLIENT_FLAG,
 120         },
 121         {
 122                 .name           = (char *) "output-format",
 123                 .has_arg        = optional_argument,
 124                 .val            = 'F' | FIO_CLIENT_FLAG,
 125         },
 126         {
 127                 .name           = (char *) "version",
 128                 .has_arg        = no_argument,
 129                 .val            = 'v' | FIO_CLIENT_FLAG,
 130         },
 131         {
 132                 .name           = (char *) "help",
 133                 .has_arg        = no_argument,
 134                 .val            = 'h' | FIO_CLIENT_FLAG,
 135         },
 136         {
 137                 .name           = (char *) "cmdhelp",
 138                 .has_arg        = optional_argument,
 139                 .val            = 'c' | FIO_CLIENT_FLAG,
 140         },
 141         {
 142                 .name              = (char *) "enghelp",
 143                 .has_arg        = optional_argument,
 144                 .val                = 'i' | FIO_CLIENT_FLAG,
 145         },
 146         {
 147                 .name           = (char *) "showcmd",
 148                 .has_arg        = no_argument,
 149                 .val            = 's' | FIO_CLIENT_FLAG,
 150         },
 151         {
 152                 .name           = (char *) "readonly",
 153                 .has_arg        = no_argument,
 154                 .val            = 'r' | FIO_CLIENT_FLAG,
 155         },
 156         {
 157                 .name           = (char *) "eta",
 158                 .has_arg        = required_argument,
 159                 .val            = 'e' | FIO_CLIENT_FLAG,
 160         },
 161         {
 162                 .name           = (char *) "debug",
 163                 .has_arg        = required_argument,
 164                 .val            = 'd' | FIO_CLIENT_FLAG,
 165         },
 166         {
 167                 .name           = (char *) "section",
 168                 .has_arg        = required_argument,
 169                 .val            = 'x' | FIO_CLIENT_FLAG,
 170         },
 171         {
 172                 .name           = (char *) "alloc-size",
 173                 .has_arg        = required_argument,
 174                 .val            = 'a' | FIO_CLIENT_FLAG,
 175         },
 176         {
 177                 .name           = (char *) "profile",
 178                 .has_arg        = required_argument,
 179                 .val            = 'p' | FIO_CLIENT_FLAG,
 180         },
 181         {
 182                 .name           = (char *) "warnings-fatal",
 183                 .has_arg        = no_argument,
 184                 .val            = 'w' | FIO_CLIENT_FLAG,
 185         },
 186         {
 187                 .name           = (char *) "max-jobs",
 188                 .has_arg        = required_argument,
 189                 .val            = 'j' | FIO_CLIENT_FLAG,
 190         },
 191         {
 192                 .name           = (char *) "terse-version",
 193                 .has_arg        = required_argument,
 194                 .val            = 'V' | FIO_CLIENT_FLAG,
 195         },
 196         {
 197                 .name           = (char *) "server",
 198                 .has_arg        = optional_argument,
 199                 .val            = 'S',
 200         },
 201         {       .name           = (char *) "daemonize",
 202                 .has_arg        = required_argument,
 203                 .val            = 'D',
 204         },
 205         {
 206                 .name           = (char *) "client",
 207                 .has_arg        = required_argument,
 208                 .val            = 'C',
 209         },
 210         {
 211                 .name           = NULL,
 212         },
 213 };
 214
 215 static void free_shm(void)
 216 {
 217         struct shmid_ds sbuf;
 218
 219         if (threads) {
 220                 void *tp = threads;
 221
 222                 threads = NULL;
 223                 file_hash_exit();
 224                 flow_exit();
 225                 fio_debug_jobp = NULL;
 226                 shmdt(tp);
 227                 shmctl(shm_id, IPC_RMID, &sbuf);
 228         }
 229
 230         scleanup();
 231 }
 232
 233 /*
 234  * The thread area is shared between the main process and the job
 235  * threads/processes. So setup a shared memory segment that will hold
 236  * all the job info. We use the end of the region for keeping track of
 237  * open files across jobs, for file sharing.
 238  */
 239 static int setup_thread_area(void)
 240 {
 241         void *hash;
 242
 243         if (threads)
 244                 return 0;
 245
 246         /*
 247          * 1024 is too much on some machines, scale max_jobs if
 248          * we get a failure that looks like too large a shm segment
 249          */
 250         do {
 251                 size_t size = max_jobs * sizeof(struct thread_data);
 252
 253                 size += file_hash_size;
 254                 size += sizeof(unsigned int);
 255
 256                 shm_id = shmget(0, size, IPC_CREAT | 0600);
 257                 if (shm_id != -1)
 258                         break;
 259                 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
 260                         perror("shmget");
 261                         break;
 262                 }
 263
 264                 max_jobs >>= 1;
 265         } while (max_jobs);
 266
 267         if (shm_id == -1)
 268                 return 1;
 269
 270         threads = shmat(shm_id, NULL, 0);
 271         if (threads == (void *) -1) {
 272                 perror("shmat");
 273                 return 1;
 274         }
 275
 276         memset(threads, 0, max_jobs * sizeof(struct thread_data));
 277         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
 278         fio_debug_jobp = (void *) hash + file_hash_size;
 279         *fio_debug_jobp = -1;
 280         file_hash_init(hash);
 281
 282         flow_init();
 283
 284         return 0;
 285 }
 286
 287 /*
 288  * Return a free job structure.
 289  */
 290 static struct thread_data *get_new_job(int global, struct thread_data *parent,
 291                                        int preserve_eo)
 292 {
 293         struct thread_data *td;
 294
 295         if (global)
 296                 return &def_thread;
 297         if (setup_thread_area()) {
 298                 log_err("error: failed to setup shm segment\n");
 299                 return NULL;
 300         }
 301         if (thread_number >= max_jobs) {
 302                 log_err("error: maximum number of jobs (%d) reached.\n",
 303                                 max_jobs);
 304                 return NULL;
 305         }
 306
 307         td = &threads[thread_number++];
 308         *td = *parent;
 309
 310         td->io_ops = NULL;
 311         if (!preserve_eo)
 312                 td->eo = NULL;
 313
 314         td->o.uid = td->o.gid = -1U;
 315
 316         dup_files(td, parent);
 317         fio_options_mem_dupe(td);
 318
 319         profile_add_hooks(td);
 320
 321         td->thread_number = thread_number;
 322
 323         if (!parent || !parent->o.group_reporting)
 324                 stat_number++;
 325
 326         return td;
 327 }
 328
 329 static void put_job(struct thread_data *td)
 330 {
 331         if (td == &def_thread)
 332                 return;
 333
 334         profile_td_exit(td);
 335         flow_exit_job(td);
 336
 337         if (td->error)
 338                 log_info("fio: %s\n", td->verror);
 339
 340         fio_options_free(td);
 341         if (td->io_ops)
 342                 free_ioengine(td);
 343
 344         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
 345         thread_number--;
 346 }
 347
 348 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 349 {
 350         unsigned int bs = td->o.min_bs[ddir];
 351
 352         assert(ddir_rw(ddir));
 353
 354         if (td->o.rate[ddir])
 355                 td->rate_bps[ddir] = td->o.rate[ddir];
 356         else
 357                 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
 358
 359         if (!td->rate_bps[ddir]) {
 360                 log_err("rate lower than supported\n");
 361                 return -1;
 362         }
 363
 364         td->rate_pending_usleep[ddir] = 0;
 365         return 0;
 366 }
 367
 368 static int setup_rate(struct thread_data *td)
 369 {
 370         int ret = 0;
 371
 372         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
 373                 ret = __setup_rate(td, DDIR_READ);
 374         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
 375                 ret |= __setup_rate(td, DDIR_WRITE);
 376         if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
 377                 ret |= __setup_rate(td, DDIR_TRIM);
 378
 379         return ret;
 380 }
 381
 382 static int fixed_block_size(struct thread_options *o)
 383 {
 384         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
 385                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
 386                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
 387                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
 388                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
 389 }
 390
 391 /*
 392  * Lazy way of fixing up options that depend on each other. We could also
 393  * define option callback handlers, but this is easier.
 394  */
 395 static int fixup_options(struct thread_data *td)
 396 {
 397         struct thread_options *o = &td->o;
 398         int ret = 0;
 399
 400 #ifndef FIO_HAVE_PSHARED_MUTEX
 401         if (!o->use_thread) {
 402                 log_info("fio: this platform does not support process shared"
 403                          " mutexes, forcing use of threads. Use the 'thread'"
 404                          " option to get rid of this warning.\n");
 405                 o->use_thread = 1;
 406                 ret = warnings_fatal;
 407         }
 408 #endif
 409
 410         if (o->write_iolog_file && o->read_iolog_file) {
 411                 log_err("fio: read iolog overrides write_iolog\n");
 412                 free(o->write_iolog_file);
 413                 o->write_iolog_file = NULL;
 414                 ret = warnings_fatal;
 415         }
 416
 417         /*
 418          * only really works with 1 file
 419          */
 420         if (o->zone_size && o->open_files == 1)
 421                 o->zone_size = 0;
 422
 423         /*
 424          * If zone_range isn't specified, backward compatibility dictates it
 425          * should be made equal to zone_size.
 426          */
 427         if (o->zone_size && !o->zone_range)
 428                 o->zone_range = o->zone_size;
 429
 430         /*
 431          * Reads can do overwrites, we always need to pre-create the file
 432          */
 433         if (td_read(td) || td_rw(td))
 434                 o->overwrite = 1;
 435
 436         if (!o->min_bs[DDIR_READ])
 437                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
 438         if (!o->max_bs[DDIR_READ])
 439                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
 440         if (!o->min_bs[DDIR_WRITE])
 441                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 442         if (!o->max_bs[DDIR_WRITE])
 443                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 444         if (!o->min_bs[DDIR_TRIM])
 445                 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 446         if (!o->max_bs[DDIR_TRIM])
 447                 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 448
 449
 450         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
 451         o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
 452
 453         /*
 454          * For random IO, allow blockalign offset other than min_bs.
 455          */
 456         if (!o->ba[DDIR_READ] || !td_random(td))
 457                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
 458         if (!o->ba[DDIR_WRITE] || !td_random(td))
 459                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
 460         if (!o->ba[DDIR_TRIM] || !td_random(td))
 461                 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
 462
 463         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
 464             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
 465             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
 466             !o->norandommap) {
 467                 log_err("fio: Any use of blockalign= turns off randommap\n");
 468                 o->norandommap = 1;
 469                 ret = warnings_fatal;
 470         }
 471
 472         if (!o->file_size_high)
 473                 o->file_size_high = o->file_size_low;
 474
 475         if (o->norandommap && o->verify != VERIFY_NONE
 476             && !fixed_block_size(o))  {
 477                 log_err("fio: norandommap given for variable block sizes, "
 478                         "verify disabled\n");
 479                 o->verify = VERIFY_NONE;
 480                 ret = warnings_fatal;
 481         }
 482         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
 483                 log_err("fio: bs_unaligned may not work with raw io\n");
 484
 485         /*
 486          * thinktime_spin must be less than thinktime
 487          */
 488         if (o->thinktime_spin > o->thinktime)
 489                 o->thinktime_spin = o->thinktime;
 490
 491         /*
 492          * The low water mark cannot be bigger than the iodepth
 493          */
 494         if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
 495                 /*
 496                  * syslet work around - if the workload is sequential,
 497                  * we want to let the queue drain all the way down to
 498                  * avoid seeking between async threads
 499                  */
 500                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
 501                         o->iodepth_low = 1;
 502                 else
 503                         o->iodepth_low = o->iodepth;
 504         }
 505
 506         /*
 507          * If batch number isn't set, default to the same as iodepth
 508          */
 509         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 510                 o->iodepth_batch = o->iodepth;
 511
 512         if (o->nr_files > td->files_index)
 513                 o->nr_files = td->files_index;
 514
 515         if (o->open_files > o->nr_files || !o->open_files)
 516                 o->open_files = o->nr_files;
 517
 518         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
 519             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
 520             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
 521             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
 522                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 523                 ret = 1;
 524         }
 525         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
 526             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
 527             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
 528             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
 529             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
 530             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
 531                 log_err("fio: minimum rate exceeds rate\n");
 532                 ret = 1;
 533         }
 534
 535         if (!o->timeout && o->time_based) {
 536                 log_err("fio: time_based requires a runtime/timeout setting\n");
 537                 o->time_based = 0;
 538                 ret = warnings_fatal;
 539         }
 540
 541         if (o->fill_device && !o->size)
 542                 o->size = -1ULL;
 543
 544         if (o->verify != VERIFY_NONE) {
 545                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
 546                         log_info("Multiple writers may overwrite blocks that "
 547                                 "belong to other jobs. This can cause "
 548                                 "verification failures.\n");
 549                         ret = warnings_fatal;
 550                 }
 551
 552                 o->refill_buffers = 1;
 553                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
 554                     !o->verify_interval)
 555                         o->verify_interval = o->min_bs[DDIR_WRITE];
 556         }
 557
 558         if (o->pre_read) {
 559                 o->invalidate_cache = 0;
 560                 if (td->io_ops->flags & FIO_PIPEIO) {
 561                         log_info("fio: cannot pre-read files with an IO engine"
 562                                  " that isn't seekable. Pre-read disabled.\n");
 563                         ret = warnings_fatal;
 564                 }
 565         }
 566
 567 #ifndef FIO_HAVE_FDATASYNC
 568         if (o->fdatasync_blocks) {
 569                 log_info("fio: this platform does not support fdatasync()"
 570                          " falling back to using fsync().  Use the 'fsync'"
 571                          " option instead of 'fdatasync' to get rid of"
 572                          " this warning\n");
 573                 o->fsync_blocks = o->fdatasync_blocks;
 574                 o->fdatasync_blocks = 0;
 575                 ret = warnings_fatal;
 576         }
 577 #endif
 578
 579 #ifdef WIN32
 580         /*
 581          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
 582          * so fail if we're passed those flags
 583          */
 584         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
 585                 log_err("fio: Windows does not support direct or non-buffered io with"
 586                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
 587                                 " with 'direct=1' and 'iodepth=1' instead.\n");
 588                 ret = 1;
 589         }
 590 #endif
 591
 592         /*
 593          * For fully compressible data, just zero them at init time.
 594          * It's faster than repeatedly filling it.
 595          */
 596         if (td->o.compress_percentage == 100) {
 597                 td->o.zero_buffers = 1;
 598                 td->o.compress_percentage = 0;
 599         }
 600
 601         /*
 602          * Using a non-uniform random distribution excludes usage of
 603          * a random map
 604          */
 605         if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
 606                 td->o.norandommap = 1;
 607
 608         return ret;
 609 }
 610
 611 /*
 612  * This function leaks the buffer
 613  */
 614 static char *to_kmg(unsigned int val)
 615 {
 616         char *buf = malloc(32);
 617         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 618         char *p = post;
 619
 620         do {
 621                 if (val & 1023)
 622                         break;
 623
 624                 val >>= 10;
 625                 p++;
 626         } while (*p);
 627
 628         snprintf(buf, 31, "%u%c", val, *p);
 629         return buf;
 630 }
 631
 632 /* External engines are specified by "external:name.o") */
 633 static const char *get_engine_name(const char *str)
 634 {
 635         char *p = strstr(str, ":");
 636
 637         if (!p)
 638                 return str;
 639
 640         p++;
 641         strip_blank_front(&p);
 642         strip_blank_end(p);
 643         return p;
 644 }
 645
 646 static int exists_and_not_file(const char *filename)
 647 {
 648         struct stat sb;
 649
 650         if (lstat(filename, &sb) == -1)
 651                 return 0;
 652
 653         /* \\.\ is the device namespace in Windows, where every file
 654          * is a device node */
 655         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
 656                 return 0;
 657
 658         return 1;
 659 }
 660
 661 static void td_fill_rand_seeds_os(struct thread_data *td)
 662 {
 663         os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
 664         os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
 665         os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
 666
 667         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 668                 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
 669
 670         os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
 671         os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
 672
 673         if (!td_random(td))
 674                 return;
 675
 676         if (td->o.rand_repeatable)
 677                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 678
 679         os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
 680 }
 681
 682 static void td_fill_rand_seeds_internal(struct thread_data *td)
 683 {
 684         init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
 685         init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
 686         init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
 687
 688         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 689                 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
 690
 691         init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
 692         init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
 693
 694         if (!td_random(td))
 695                 return;
 696
 697         if (td->o.rand_repeatable)
 698                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 699
 700         init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
 701 }
 702
 703 void td_fill_rand_seeds(struct thread_data *td)
 704 {
 705         if (td->o.use_os_rand)
 706                 td_fill_rand_seeds_os(td);
 707         else
 708                 td_fill_rand_seeds_internal(td);
 709
 710         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
 711 }
 712
 713
 714 /*
 715  * Initializes the ioengine configured for a job, if it has not been done so
 716  * already.
 717  */
 718 int ioengine_load(struct thread_data *td)
 719 {
 720         const char *engine;
 721
 722         /*
 723          * Engine has already been loaded.
 724          */
 725         if (td->io_ops)
 726                 return 0;
 727
 728         engine = get_engine_name(td->o.ioengine);
 729         td->io_ops = load_ioengine(td, engine);
 730         if (!td->io_ops) {
 731                 log_err("fio: failed to load engine %s\n", engine);
 732                 return 1;
 733         }
 734
 735         if (td->io_ops->option_struct_size && td->io_ops->options) {
 736                 /*
 737                  * In cases where td->eo is set, clone it for a child thread.
 738                  * This requires that the parent thread has the same ioengine,
 739                  * but that requirement must be enforced by the code which
 740                  * cloned the thread.
 741                  */
 742                 void *origeo = td->eo;
 743                 /*
 744                  * Otherwise use the default thread options.
 745                  */
 746                 if (!origeo && td != &def_thread && def_thread.eo &&
 747                     def_thread.io_ops->options == td->io_ops->options)
 748                         origeo = def_thread.eo;
 749
 750                 options_init(td->io_ops->options);
 751                 td->eo = malloc(td->io_ops->option_struct_size);
 752                 /*
 753                  * Use the default thread as an option template if this uses the
 754                  * same options structure and there are non-default options
 755                  * used.
 756                  */
 757                 if (origeo) {
 758                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 759                         options_mem_dupe(td->eo, td->io_ops->options);
 760                 } else {
 761                         memset(td->eo, 0, td->io_ops->option_struct_size);
 762                         fill_default_options(td->eo, td->io_ops->options);
 763                 }
 764                 *(struct thread_data **)td->eo = td;
 765         }
 766
 767         return 0;
 768 }
 769
 770 static void init_flags(struct thread_data *td)
 771 {
 772         struct thread_options *o = &td->o;
 773
 774         if (o->verify_backlog)
 775                 td->flags |= TD_F_VER_BACKLOG;
 776         if (o->trim_backlog)
 777                 td->flags |= TD_F_TRIM_BACKLOG;
 778         if (o->read_iolog_file)
 779                 td->flags |= TD_F_READ_IOLOG;
 780         if (o->refill_buffers)
 781                 td->flags |= TD_F_REFILL_BUFFERS;
 782         if (o->scramble_buffers)
 783                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 784         if (o->verify != VERIFY_NONE)
 785                 td->flags |= TD_F_VER_NONE;
 786 }
 787
 788 /*
 789  * Adds a job to the list of things todo. Sanitizes the various options
 790  * to make sure we don't have conflicts, and initializes various
 791  * members of td.
 792  */
 793 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 794 {
 795         const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
 796                                    "randread", "randwrite", "randrw",
 797                                    "trim", NULL, NULL, NULL, "randtrim" };
 798         unsigned int i;
 799         char fname[PATH_MAX];
 800         int numjobs, file_alloced;
 801
 802         /*
 803          * the def_thread is just for options, it's not a real job
 804          */
 805         if (td == &def_thread)
 806                 return 0;
 807
 808         init_flags(td);
 809
 810         /*
 811          * if we are just dumping the output command line, don't add the job
 812          */
 813         if (dump_cmdline) {
 814                 put_job(td);
 815                 return 0;
 816         }
 817
 818         if (profile_td_init(td))
 819                 goto err;
 820
 821         if (ioengine_load(td))
 822                 goto err;
 823
 824         if (td->o.use_thread)
 825                 nr_thread++;
 826         else
 827                 nr_process++;
 828
 829         if (td->o.odirect)
 830                 td->io_ops->flags |= FIO_RAWIO;
 831
 832         file_alloced = 0;
 833         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
 834                 file_alloced = 1;
 835
 836                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
 837                         add_file(td, jobname);
 838                 else {
 839                         for (i = 0; i < td->o.nr_files; i++) {
 840                                 sprintf(fname, "%s.%d.%d", jobname,
 841                                                         td->thread_number, i);
 842                                 add_file(td, fname);
 843                         }
 844                 }
 845         }
 846
 847         if (fixup_options(td))
 848                 goto err;
 849
 850         flow_init_job(td);
 851
 852         /*
 853          * IO engines only need this for option callbacks, and the address may
 854          * change in subprocesses.
 855          */
 856         if (td->eo)
 857                 *(struct thread_data **)td->eo = NULL;
 858
 859         if (td->io_ops->flags & FIO_DISKLESSIO) {
 860                 struct fio_file *f;
 861
 862                 for_each_file(td, f, i)
 863                         f->real_file_size = -1ULL;
 864         }
 865
 866         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
 867
 868         td->ts.clat_percentiles = td->o.clat_percentiles;
 869         if (td->o.overwrite_plist)
 870                 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
 871         else
 872                 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
 873
 874         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 875                 td->ts.clat_stat[i].min_val = ULONG_MAX;
 876                 td->ts.slat_stat[i].min_val = ULONG_MAX;
 877                 td->ts.lat_stat[i].min_val = ULONG_MAX;
 878                 td->ts.bw_stat[i].min_val = ULONG_MAX;
 879         }
 880         td->ddir_seq_nr = td->o.ddir_seq_nr;
 881
 882         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
 883                 prev_group_jobs = 0;
 884                 groupid++;
 885         }
 886
 887         td->groupid = groupid;
 888         prev_group_jobs++;
 889
 890         if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
 891                 td_verror(td, errno, "init_random_state");
 892                 goto err;
 893         }
 894
 895         if (setup_rate(td))
 896                 goto err;
 897
 898         if (td->o.write_lat_log) {
 899                 setup_log(&td->lat_log, td->o.log_avg_msec);
 900                 setup_log(&td->slat_log, td->o.log_avg_msec);
 901                 setup_log(&td->clat_log, td->o.log_avg_msec);
 902         }
 903         if (td->o.write_bw_log)
 904                 setup_log(&td->bw_log, td->o.log_avg_msec);
 905         if (td->o.write_iops_log)
 906                 setup_log(&td->iops_log, td->o.log_avg_msec);
 907
 908         if (!td->o.name)
 909                 td->o.name = strdup(jobname);
 910
 911         if (output_format == FIO_OUTPUT_NORMAL) {
 912                 if (!job_add_num) {
 913                         if (!strcmp(td->io_ops->name, "cpuio")) {
 914                                 log_info("%s: ioengine=cpu, cpuload=%u,"
 915                                          " cpucycle=%u\n", td->o.name,
 916                                                         td->o.cpuload,
 917                                                         td->o.cpucycle);
 918                         } else {
 919                                 char *c1, *c2, *c3, *c4, *c5, *c6;
 920
 921                                 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
 922                                 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
 923                                 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
 924                                 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
 925                                 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
 926                                 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
 927
 928                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
 929                                          " ioengine=%s, iodepth=%u\n",
 930                                                 td->o.name, td->groupid,
 931                                                 ddir_str[td->o.td_ddir],
 932                                                 c1, c2, c3, c4, c5, c6,
 933                                                 td->io_ops->name,
 934                                                 td->o.iodepth);
 935
 936                                 free(c1);
 937                                 free(c2);
 938                                 free(c3);
 939                                 free(c4);
 940                                 free(c5);
 941                                 free(c6);
 942                         }
 943                 } else if (job_add_num == 1)
 944                         log_info("...\n");
 945         }
 946
 947         /*
 948          * recurse add identical jobs, clear numjobs and stonewall options
 949          * as they don't apply to sub-jobs
 950          */
 951         numjobs = td->o.numjobs;
 952         while (--numjobs) {
 953                 struct thread_data *td_new = get_new_job(0, td, 1);
 954
 955                 if (!td_new)
 956                         goto err;
 957
 958                 td_new->o.numjobs = 1;
 959                 td_new->o.stonewall = 0;
 960                 td_new->o.new_group = 0;
 961
 962                 if (file_alloced) {
 963                         td_new->o.filename = NULL;
 964                         td_new->files_index = 0;
 965                         td_new->files_size = 0;
 966                         td_new->files = NULL;
 967                 }
 968
 969                 job_add_num = numjobs - 1;
 970
 971                 if (add_job(td_new, jobname, job_add_num))
 972                         goto err;
 973         }
 974
 975         return 0;
 976 err:
 977         put_job(td);
 978         return -1;
 979 }
 980
 981 /*
 982  * Parse as if 'o' was a command line
 983  */
 984 void add_job_opts(const char **o)
 985 {
 986         struct thread_data *td, *td_parent;
 987         int i, in_global = 1;
 988         char jobname[32];
 989
 990         i = 0;
 991         td_parent = td = NULL;
 992         while (o[i]) {
 993                 if (!strncmp(o[i], "name", 4)) {
 994                         in_global = 0;
 995                         if (td)
 996                                 add_job(td, jobname, 0);
 997                         td = NULL;
 998                         sprintf(jobname, "%s", o[i] + 5);
 999                 }
1000                 if (in_global && !td_parent)
1001                         td_parent = get_new_job(1, &def_thread, 0);
1002                 else if (!in_global && !td) {
1003                         if (!td_parent)
1004                                 td_parent = &def_thread;
1005                         td = get_new_job(0, td_parent, 0);
1006                 }
1007                 if (in_global)
1008                         fio_options_parse(td_parent, (char **) &o[i], 1);
1009                 else
1010                         fio_options_parse(td, (char **) &o[i], 1);
1011                 i++;
1012         }
1013
1014         if (td)
1015                 add_job(td, jobname, 0);
1016 }
1017
1018 static int skip_this_section(const char *name)
1019 {
1020         int i;
1021
1022         if (!nr_job_sections)
1023                 return 0;
1024         if (!strncmp(name, "global", 6))
1025                 return 0;
1026
1027         for (i = 0; i < nr_job_sections; i++)
1028                 if (!strcmp(job_sections[i], name))
1029                         return 0;
1030
1031         return 1;
1032 }
1033
1034 static int is_empty_or_comment(char *line)
1035 {
1036         unsigned int i;
1037
1038         for (i = 0; i < strlen(line); i++) {
1039                 if (line[i] == ';')
1040                         return 1;
1041                 if (line[i] == '#')
1042                         return 1;
1043                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1044                         return 0;
1045         }
1046
1047         return 1;
1048 }
1049
1050 /*
1051  * This is our [ini] type file parser.
1052  */
1053 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1054 {
1055         unsigned int global;
1056         struct thread_data *td;
1057         char *string, *name;
1058         FILE *f;
1059         char *p;
1060         int ret = 0, stonewall;
1061         int first_sect = 1;
1062         int skip_fgets = 0;
1063         int inside_skip = 0;
1064         char **opts;
1065         int i, alloc_opts, num_opts;
1066
1067         if (is_buf)
1068                 f = NULL;
1069         else {
1070                 if (!strcmp(file, "-"))
1071                         f = stdin;
1072                 else
1073                         f = fopen(file, "r");
1074
1075                 if (!f) {
1076                         perror("fopen job file");
1077                         return 1;
1078                 }
1079         }
1080
1081         string = malloc(4096);
1082
1083         /*
1084          * it's really 256 + small bit, 280 should suffice
1085          */
1086         name = malloc(280);
1087         memset(name, 0, 280);
1088
1089         alloc_opts = 8;
1090         opts = malloc(sizeof(char *) * alloc_opts);
1091         num_opts = 0;
1092
1093         stonewall = stonewall_flag;
1094         do {
1095                 /*
1096                  * if skip_fgets is set, we already have loaded a line we
1097                  * haven't handled.
1098                  */
1099                 if (!skip_fgets) {
1100                         if (is_buf)
1101                                 p = strsep(&file, "\n");
1102                         else
1103                                 p = fgets(string, 4096, f);
1104                         if (!p)
1105                                 break;
1106                 }
1107
1108                 skip_fgets = 0;
1109                 strip_blank_front(&p);
1110                 strip_blank_end(p);
1111
1112                 if (is_empty_or_comment(p))
1113                         continue;
1114                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1115                         if (inside_skip)
1116                                 continue;
1117                         log_err("fio: option <%s> outside of [] job section\n",
1118                                                                         p);
1119                         break;
1120                 }
1121
1122                 name[strlen(name) - 1] = '\0';
1123
1124                 if (skip_this_section(name)) {
1125                         inside_skip = 1;
1126                         continue;
1127                 } else
1128                         inside_skip = 0;
1129
1130                 global = !strncmp(name, "global", 6);
1131
1132                 if (dump_cmdline) {
1133                         if (first_sect)
1134                                 log_info("fio ");
1135                         if (!global)
1136                                 log_info("--name=%s ", name);
1137                         first_sect = 0;
1138                 }
1139
1140                 td = get_new_job(global, &def_thread, 0);
1141                 if (!td) {
1142                         ret = 1;
1143                         break;
1144                 }
1145
1146                 /*
1147                  * Seperate multiple job files by a stonewall
1148                  */
1149                 if (!global && stonewall) {
1150                         td->o.stonewall = stonewall;
1151                         stonewall = 0;
1152                 }
1153
1154                 num_opts = 0;
1155                 memset(opts, 0, alloc_opts * sizeof(char *));
1156
1157                 while (1) {
1158                         if (is_buf)
1159                                 p = strsep(&file, "\n");
1160                         else
1161                                 p = fgets(string, 4096, f);
1162                         if (!p)
1163                                 break;
1164
1165                         if (is_empty_or_comment(p))
1166                                 continue;
1167
1168                         strip_blank_front(&p);
1169
1170                         /*
1171                          * new section, break out and make sure we don't
1172                          * fgets() a new line at the top.
1173                          */
1174                         if (p[0] == '[') {
1175                                 skip_fgets = 1;
1176                                 break;
1177                         }
1178
1179                         strip_blank_end(p);
1180
1181                         if (num_opts == alloc_opts) {
1182                                 alloc_opts <<= 1;
1183                                 opts = realloc(opts,
1184                                                 alloc_opts * sizeof(char *));
1185                         }
1186
1187                         opts[num_opts] = strdup(p);
1188                         num_opts++;
1189                 }
1190
1191                 ret = fio_options_parse(td, opts, num_opts);
1192                 if (!ret) {
1193                         if (dump_cmdline)
1194                                 for (i = 0; i < num_opts; i++)
1195                                         log_info("--%s ", opts[i]);
1196
1197                         ret = add_job(td, name, 0);
1198                 } else {
1199                         log_err("fio: job %s dropped\n", name);
1200                         put_job(td);
1201                 }
1202
1203                 for (i = 0; i < num_opts; i++)
1204                         free(opts[i]);
1205                 num_opts = 0;
1206         } while (!ret);
1207
1208         if (dump_cmdline)
1209                 log_info("\n");
1210
1211         i = 0;
1212         while (i < nr_job_sections) {
1213                 free(job_sections[i]);
1214                 i++;
1215         }
1216
1217         for (i = 0; i < num_opts; i++)
1218                 free(opts[i]);
1219
1220         free(string);
1221         free(name);
1222         free(opts);
1223         if (!is_buf && f != stdin)
1224                 fclose(f);
1225         return ret;
1226 }
1227
1228 static int fill_def_thread(void)
1229 {
1230         memset(&def_thread, 0, sizeof(def_thread));
1231
1232         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1233         def_thread.o.timeout = def_timeout;
1234         def_thread.o.error_dump = 1;
1235         /*
1236          * fill default options
1237          */
1238         fio_fill_default_options(&def_thread);
1239         return 0;
1240 }
1241
1242 static void usage(const char *name)
1243 {
1244         printf("%s\n", fio_version_string);
1245         printf("%s [options] [job options] <job file(s)>\n", name);
1246         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1247                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1248                 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1249         printf("  --output\t\tWrite output to file\n");
1250         printf("  --runtime\t\tRuntime in seconds\n");
1251         printf("  --latency-log\t\tGenerate per-job latency logs\n");
1252         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1253         printf("  --minimal\t\tMinimal (terse) output\n");
1254         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1255         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1256         printf("  --version\t\tPrint version info and exit\n");
1257         printf("  --help\t\tPrint this page\n");
1258         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1259                 " them\n");
1260         printf("  --enghelp=engine\tPrint ioengine help, or list"
1261                 " available ioengines\n");
1262         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1263                 " cmd\n");
1264         printf("  --showcmd\t\tTurn a job file into command line options\n");
1265         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1266         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1267         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1268                 " writes\n");
1269         printf("  --section=name\tOnly run specified section in job file\n");
1270         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1271                 " (def 1024)\n");
1272         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1273         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1274         printf("  --server=args\t\tStart a backend fio server\n");
1275         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1276         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1277         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1278         printf("\n                 Jens Axboe <jaxboe@fusionio.com>\n");
1279 }
1280
1281 #ifdef FIO_INC_DEBUG
1282 struct debug_level debug_levels[] = {
1283         { .name = "process",    .shift = FD_PROCESS, },
1284         { .name = "file",       .shift = FD_FILE, },
1285         { .name = "io",         .shift = FD_IO, },
1286         { .name = "mem",        .shift = FD_MEM, },
1287         { .name = "blktrace",   .shift = FD_BLKTRACE },
1288         { .name = "verify",     .shift = FD_VERIFY },
1289         { .name = "random",     .shift = FD_RANDOM },
1290         { .name = "parse",      .shift = FD_PARSE },
1291         { .name = "diskutil",   .shift = FD_DISKUTIL },
1292         { .name = "job",        .shift = FD_JOB },
1293         { .name = "mutex",      .shift = FD_MUTEX },
1294         { .name = "profile",    .shift = FD_PROFILE },
1295         { .name = "time",       .shift = FD_TIME },
1296         { .name = "net",        .shift = FD_NET },
1297         { .name = NULL, },
1298 };
1299
1300 static int set_debug(const char *string)
1301 {
1302         struct debug_level *dl;
1303         char *p = (char *) string;
1304         char *opt;
1305         int i;
1306
1307         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1308                 log_info("fio: dumping debug options:");
1309                 for (i = 0; debug_levels[i].name; i++) {
1310                         dl = &debug_levels[i];
1311                         log_info("%s,", dl->name);
1312                 }
1313                 log_info("all\n");
1314                 return 1;
1315         }
1316
1317         while ((opt = strsep(&p, ",")) != NULL) {
1318                 int found = 0;
1319
1320                 if (!strncmp(opt, "all", 3)) {
1321                         log_info("fio: set all debug options\n");
1322                         fio_debug = ~0UL;
1323                         continue;
1324                 }
1325
1326                 for (i = 0; debug_levels[i].name; i++) {
1327                         dl = &debug_levels[i];
1328                         found = !strncmp(opt, dl->name, strlen(dl->name));
1329                         if (!found)
1330                                 continue;
1331
1332                         if (dl->shift == FD_JOB) {
1333                                 opt = strchr(opt, ':');
1334                                 if (!opt) {
1335                                         log_err("fio: missing job number\n");
1336                                         break;
1337                                 }
1338                                 opt++;
1339                                 fio_debug_jobno = atoi(opt);
1340                                 log_info("fio: set debug jobno %d\n",
1341                                                         fio_debug_jobno);
1342                         } else {
1343                                 log_info("fio: set debug option %s\n", opt);
1344                                 fio_debug |= (1UL << dl->shift);
1345                         }
1346                         break;
1347                 }
1348
1349                 if (!found)
1350                         log_err("fio: debug mask %s not found\n", opt);
1351         }
1352         return 0;
1353 }
1354 #else
1355 static int set_debug(const char *string)
1356 {
1357         log_err("fio: debug tracing not included in build\n");
1358         return 1;
1359 }
1360 #endif
1361
1362 static void fio_options_fill_optstring(void)
1363 {
1364         char *ostr = cmd_optstr;
1365         int i, c;
1366
1367         c = i = 0;
1368         while (l_opts[i].name) {
1369                 ostr[c++] = l_opts[i].val;
1370                 if (l_opts[i].has_arg == required_argument)
1371                         ostr[c++] = ':';
1372                 else if (l_opts[i].has_arg == optional_argument) {
1373                         ostr[c++] = ':';
1374                         ostr[c++] = ':';
1375                 }
1376                 i++;
1377         }
1378         ostr[c] = '\0';
1379 }
1380
1381 static int client_flag_set(char c)
1382 {
1383         int i;
1384
1385         i = 0;
1386         while (l_opts[i].name) {
1387                 int val = l_opts[i].val;
1388
1389                 if (c == (val & 0xff))
1390                         return (val & FIO_CLIENT_FLAG);
1391
1392                 i++;
1393         }
1394
1395         return 0;
1396 }
1397
1398 void parse_cmd_client(void *client, char *opt)
1399 {
1400         fio_client_add_cmd_option(client, opt);
1401 }
1402
1403 int parse_cmd_line(int argc, char *argv[])
1404 {
1405         struct thread_data *td = NULL;
1406         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1407         char *ostr = cmd_optstr;
1408         void *pid_file = NULL;
1409         void *cur_client = NULL;
1410         int backend = 0;
1411
1412         /*
1413          * Reset optind handling, since we may call this multiple times
1414          * for the backend.
1415          */
1416         optind = 1;
1417
1418         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1419                 did_arg = 1;
1420
1421                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1422                         parse_cmd_client(cur_client, argv[optind - 1]);
1423                         c &= ~FIO_CLIENT_FLAG;
1424                 }
1425
1426                 switch (c) {
1427                 case 'a':
1428                         smalloc_pool_size = atoi(optarg);
1429                         break;
1430                 case 't':
1431                         def_timeout = atoi(optarg);
1432                         break;
1433                 case 'l':
1434                         write_lat_log = 1;
1435                         break;
1436                 case 'b':
1437                         write_bw_log = 1;
1438                         break;
1439                 case 'o':
1440                         f_out = fopen(optarg, "w+");
1441                         if (!f_out) {
1442                                 perror("fopen output");
1443                                 exit(1);
1444                         }
1445                         f_err = f_out;
1446                         break;
1447                 case 'm':
1448                         output_format = FIO_OUTPUT_TERSE;
1449                         break;
1450                 case 'F':
1451                         if (!strcmp(optarg, "minimal") ||
1452                             !strcmp(optarg, "terse") ||
1453                             !strcmp(optarg, "csv"))
1454                                 output_format = FIO_OUTPUT_TERSE;
1455                         else if (!strcmp(optarg, "json"))
1456                                 output_format = FIO_OUTPUT_JSON;
1457                         else
1458                                 output_format = FIO_OUTPUT_NORMAL;
1459                         break;
1460                 case 'h':
1461                         if (!cur_client) {
1462                                 usage(argv[0]);
1463                                 do_exit++;
1464                         }
1465                         break;
1466                 case 'c':
1467                         if (!cur_client) {
1468                                 fio_show_option_help(optarg);
1469                                 do_exit++;
1470                         }
1471                         break;
1472                 case 'i':
1473                         if (!cur_client) {
1474                                 fio_show_ioengine_help(optarg);
1475                                 do_exit++;
1476                         }
1477                         break;
1478                 case 's':
1479                         dump_cmdline = 1;
1480                         break;
1481                 case 'r':
1482                         read_only = 1;
1483                         break;
1484                 case 'v':
1485                         if (!cur_client) {
1486                                 log_info("%s\n", fio_version_string);
1487                                 do_exit++;
1488                         }
1489                         break;
1490                 case 'V':
1491                         terse_version = atoi(optarg);
1492                         if (!(terse_version == 2 || terse_version == 3 ||
1493                              terse_version == 4)) {
1494                                 log_err("fio: bad terse version format\n");
1495                                 exit_val = 1;
1496                                 do_exit++;
1497                         }
1498                         break;
1499                 case 'e':
1500                         if (!strcmp("always", optarg))
1501                                 eta_print = FIO_ETA_ALWAYS;
1502                         else if (!strcmp("never", optarg))
1503                                 eta_print = FIO_ETA_NEVER;
1504                         break;
1505                 case 'd':
1506                         if (set_debug(optarg))
1507                                 do_exit++;
1508                         break;
1509                 case 'x': {
1510                         size_t new_size;
1511
1512                         if (!strcmp(optarg, "global")) {
1513                                 log_err("fio: can't use global as only "
1514                                         "section\n");
1515                                 do_exit++;
1516                                 exit_val = 1;
1517                                 break;
1518                         }
1519                         new_size = (nr_job_sections + 1) * sizeof(char *);
1520                         job_sections = realloc(job_sections, new_size);
1521                         job_sections[nr_job_sections] = strdup(optarg);
1522                         nr_job_sections++;
1523                         break;
1524                         }
1525                 case 'p':
1526                         exec_profile = strdup(optarg);
1527                         break;
1528                 case FIO_GETOPT_JOB: {
1529                         const char *opt = l_opts[lidx].name;
1530                         char *val = optarg;
1531
1532                         if (!strncmp(opt, "name", 4) && td) {
1533                                 ret = add_job(td, td->o.name ?: "fio", 0);
1534                                 if (ret)
1535                                         return 0;
1536                                 td = NULL;
1537                         }
1538                         if (!td) {
1539                                 int is_section = !strncmp(opt, "name", 4);
1540                                 int global = 0;
1541
1542                                 if (!is_section || !strncmp(val, "global", 6))
1543                                         global = 1;
1544
1545                                 if (is_section && skip_this_section(val))
1546                                         continue;
1547
1548                                 td = get_new_job(global, &def_thread, 1);
1549                                 if (!td || ioengine_load(td))
1550                                         return 0;
1551                                 fio_options_set_ioengine_opts(l_opts, td);
1552                         }
1553
1554                         ret = fio_cmd_option_parse(td, opt, val);
1555
1556                         if (!ret && !strcmp(opt, "ioengine")) {
1557                                 free_ioengine(td);
1558                                 if (ioengine_load(td))
1559                                         return 0;
1560                                 fio_options_set_ioengine_opts(l_opts, td);
1561                         }
1562                         break;
1563                 }
1564                 case FIO_GETOPT_IOENGINE: {
1565                         const char *opt = l_opts[lidx].name;
1566                         char *val = optarg;
1567                         opt = l_opts[lidx].name;
1568                         val = optarg;
1569                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1570                         break;
1571                 }
1572                 case 'w':
1573                         warnings_fatal = 1;
1574                         break;
1575                 case 'j':
1576                         max_jobs = atoi(optarg);
1577                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1578                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1579                                 do_exit++;
1580                                 exit_val = 1;
1581                         }
1582                         break;
1583                 case 'S':
1584                         if (nr_clients) {
1585                                 log_err("fio: can't be both client and server\n");
1586                                 do_exit++;
1587                                 exit_val = 1;
1588                                 break;
1589                         }
1590                         if (optarg)
1591                                 fio_server_set_arg(optarg);
1592                         is_backend = 1;
1593                         backend = 1;
1594                         break;
1595                 case 'D':
1596                         pid_file = strdup(optarg);
1597                         break;
1598                 case 'C':
1599                         if (is_backend) {
1600                                 log_err("fio: can't be both client and server\n");
1601                                 do_exit++;
1602                                 exit_val = 1;
1603                                 break;
1604                         }
1605                         if (fio_client_add(optarg, &cur_client)) {
1606                                 log_err("fio: failed adding client %s\n", optarg);
1607                                 do_exit++;
1608                                 exit_val = 1;
1609                                 break;
1610                         }
1611                         /*
1612                          * If the next argument exists and isn't an option,
1613                          * assume it's a job file for this client only.
1614                          */
1615                         while (optind < argc) {
1616                                 if (!strncmp(argv[optind], "--", 2) ||
1617                                     !strncmp(argv[optind], "-", 1))
1618                                         break;
1619
1620                                 fio_client_add_ini_file(cur_client, argv[optind]);
1621                                 optind++;
1622                         }
1623                         break;
1624                 default:
1625                         do_exit++;
1626                         exit_val = 1;
1627                         break;
1628                 }
1629                 if (do_exit)
1630                         break;
1631         }
1632
1633         if (do_exit) {
1634                 if (exit_val && !(is_backend || nr_clients))
1635                         exit(exit_val);
1636         }
1637
1638         if (nr_clients && fio_clients_connect()) {
1639                 do_exit++;
1640                 exit_val = 1;
1641                 return -1;
1642         }
1643
1644         if (is_backend && backend)
1645                 return fio_start_server(pid_file);
1646
1647         if (td) {
1648                 if (!ret)
1649                         ret = add_job(td, td->o.name ?: "fio", 0);
1650         }
1651
1652         while (!ret && optind < argc) {
1653                 ini_idx++;
1654                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1655                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1656                 optind++;
1657         }
1658
1659         return ini_idx;
1660 }
1661
1662 int parse_options(int argc, char *argv[])
1663 {
1664         int job_files, i;
1665
1666         f_out = stdout;
1667         f_err = stderr;
1668
1669         fio_options_fill_optstring();
1670         fio_options_dup_and_init(l_opts);
1671
1672         atexit(free_shm);
1673
1674         if (fill_def_thread())
1675                 return 1;
1676
1677         job_files = parse_cmd_line(argc, argv);
1678
1679         if (job_files > 0) {
1680                 for (i = 0; i < job_files; i++) {
1681                         if (fill_def_thread())
1682                                 return 1;
1683                         if (nr_clients) {
1684                                 if (fio_clients_send_ini(ini_file[i]))
1685                                         return 1;
1686                                 free(ini_file[i]);
1687                         } else if (!is_backend) {
1688                                 if (parse_jobs_ini(ini_file[i], 0, i))
1689                                         return 1;
1690                                 free(ini_file[i]);
1691                         }
1692                 }
1693         } else if (nr_clients) {
1694                 if (fill_def_thread())
1695                         return 1;
1696                 if (fio_clients_send_ini(NULL))
1697                         return 1;
1698         }
1699
1700         free(ini_file);
1701         fio_options_free(&def_thread);
1702
1703         if (!thread_number) {
1704                 if (dump_cmdline)
1705                         return 0;
1706                 if (exec_profile)
1707                         return 0;
1708                 if (is_backend || nr_clients)
1709                         return 0;
1710                 if (did_arg)
1711                         return 0;
1712
1713                 log_err("No jobs(s) defined\n\n");
1714
1715                 if (!did_arg) {
1716                         usage(argv[0]);
1717                         return 1;
1718                 }
1719
1720                 return 0;
1721         }
1722
1723         if (def_thread.o.gtod_offload) {
1724                 fio_gtod_init();
1725                 fio_gtod_offload = 1;
1726                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1727         }
1728
1729         if (output_format == FIO_OUTPUT_NORMAL)
1730                 log_info("%s\n", fio_version_string);
1731
1732         return 0;
1733 }