init.c

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