init.c

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