init.c

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