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