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