init.c

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