init.c

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