init.c

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