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/shm.h>
  13 #include <sys/types.h>
  14 #include <sys/stat.h>
  15
  16 #include "fio.h"
  17 #include "parse.h"
  18 #include "smalloc.h"
  19 #include "filehash.h"
  20 #include "verify.h"
  21 #include "profile.h"
  22 #include "server.h"
  23
  24 #include "lib/getopt.h"
  25
  26 const char fio_version_string[] = FIO_VERSION;
  27
  28 #define FIO_RANDSEED            (0xb1899bedUL)
  29
  30 static char **ini_file;
  31 static int max_jobs = FIO_MAX_JOBS;
  32 static int dump_cmdline;
  33 static int def_timeout;
  34
  35 static struct thread_data def_thread;
  36 struct thread_data *threads = NULL;
  37
  38 int exitall_on_terminate = 0;
  39 int output_format = FIO_OUTPUT_NORMAL;
  40 int eta_print;
  41 FILE *f_out = NULL;
  42 FILE *f_err = NULL;
  43 char **job_sections = NULL;
  44 int nr_job_sections = 0;
  45 char *exec_profile = NULL;
  46 int warnings_fatal = 0;
  47 int terse_version = 3;
  48 int is_backend = 0;
  49 int nr_clients = 0;
  50 int log_syslog = 0;
  51
  52 int write_bw_log = 0;
  53 int read_only = 0;
  54
  55 static int write_lat_log;
  56
  57 static int prev_group_jobs;
  58
  59 unsigned long fio_debug = 0;
  60 unsigned int fio_debug_jobno = -1;
  61 unsigned int *fio_debug_jobp = NULL;
  62
  63 static char cmd_optstr[256];
  64 static int did_arg;
  65
  66 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
  67         { .u.f  =  1.00 },
  68         { .u.f  =  5.00 },
  69         { .u.f  = 10.00 },
  70         { .u.f  = 20.00 },
  71         { .u.f  = 30.00 },
  72         { .u.f  = 40.00 },
  73         { .u.f  = 50.00 },
  74         { .u.f  = 60.00 },
  75         { .u.f  = 70.00 },
  76         { .u.f  = 80.00 },
  77         { .u.f  = 90.00 },
  78         { .u.f  = 95.00 },
  79         { .u.f  = 99.00 },
  80         { .u.f  = 99.50 },
  81         { .u.f  = 99.90 },
  82         { .u.f  = 99.95 },
  83         { .u.f  = 99.99 },
  84 };
  85
  86 #define FIO_CLIENT_FLAG         (1 << 16)
  87
  88 /*
  89  * Command line options. These will contain the above, plus a few
  90  * extra that only pertain to fio itself and not jobs.
  91  */
  92 static struct option l_opts[FIO_NR_OPTIONS] = {
  93         {
  94                 .name           = (char *) "output",
  95                 .has_arg        = required_argument,
  96                 .val            = 'o' | FIO_CLIENT_FLAG,
  97         },
  98         {
  99                 .name           = (char *) "timeout",
 100                 .has_arg        = required_argument,
 101                 .val            = 't' | FIO_CLIENT_FLAG,
 102         },
 103         {
 104                 .name           = (char *) "latency-log",
 105                 .has_arg        = required_argument,
 106                 .val            = 'l' | FIO_CLIENT_FLAG,
 107         },
 108         {
 109                 .name           = (char *) "bandwidth-log",
 110                 .has_arg        = required_argument,
 111                 .val            = 'b' | FIO_CLIENT_FLAG,
 112         },
 113         {
 114                 .name           = (char *) "minimal",
 115                 .has_arg        = optional_argument,
 116                 .val            = 'm' | FIO_CLIENT_FLAG,
 117         },
 118         {
 119                 .name           = (char *) "output-format",
 120                 .has_arg        = optional_argument,
 121                 .val            = 'F' | FIO_CLIENT_FLAG,
 122         },
 123         {
 124                 .name           = (char *) "version",
 125                 .has_arg        = no_argument,
 126                 .val            = 'v' | FIO_CLIENT_FLAG,
 127         },
 128         {
 129                 .name           = (char *) "help",
 130                 .has_arg        = no_argument,
 131                 .val            = 'h' | FIO_CLIENT_FLAG,
 132         },
 133         {
 134                 .name           = (char *) "cmdhelp",
 135                 .has_arg        = optional_argument,
 136                 .val            = 'c' | FIO_CLIENT_FLAG,
 137         },
 138         {
 139                 .name              = (char *) "enghelp",
 140                 .has_arg        = optional_argument,
 141                 .val                = 'i' | FIO_CLIENT_FLAG,
 142         },
 143         {
 144                 .name           = (char *) "showcmd",
 145                 .has_arg        = no_argument,
 146                 .val            = 's' | FIO_CLIENT_FLAG,
 147         },
 148         {
 149                 .name           = (char *) "readonly",
 150                 .has_arg        = no_argument,
 151                 .val            = 'r' | FIO_CLIENT_FLAG,
 152         },
 153         {
 154                 .name           = (char *) "eta",
 155                 .has_arg        = required_argument,
 156                 .val            = 'e' | FIO_CLIENT_FLAG,
 157         },
 158         {
 159                 .name           = (char *) "debug",
 160                 .has_arg        = required_argument,
 161                 .val            = 'd' | FIO_CLIENT_FLAG,
 162         },
 163         {
 164                 .name           = (char *) "section",
 165                 .has_arg        = required_argument,
 166                 .val            = 'x' | FIO_CLIENT_FLAG,
 167         },
 168         {
 169                 .name           = (char *) "alloc-size",
 170                 .has_arg        = required_argument,
 171                 .val            = 'a' | FIO_CLIENT_FLAG,
 172         },
 173         {
 174                 .name           = (char *) "profile",
 175                 .has_arg        = required_argument,
 176                 .val            = 'p' | FIO_CLIENT_FLAG,
 177         },
 178         {
 179                 .name           = (char *) "warnings-fatal",
 180                 .has_arg        = no_argument,
 181                 .val            = 'w' | FIO_CLIENT_FLAG,
 182         },
 183         {
 184                 .name           = (char *) "max-jobs",
 185                 .has_arg        = required_argument,
 186                 .val            = 'j' | FIO_CLIENT_FLAG,
 187         },
 188         {
 189                 .name           = (char *) "terse-version",
 190                 .has_arg        = required_argument,
 191                 .val            = 'V' | FIO_CLIENT_FLAG,
 192         },
 193         {
 194                 .name           = (char *) "server",
 195                 .has_arg        = optional_argument,
 196                 .val            = 'S',
 197         },
 198         {       .name           = (char *) "daemonize",
 199                 .has_arg        = required_argument,
 200                 .val            = 'D',
 201         },
 202         {
 203                 .name           = (char *) "client",
 204                 .has_arg        = required_argument,
 205                 .val            = 'C',
 206         },
 207         {
 208                 .name           = NULL,
 209         },
 210 };
 211
 212 void free_threads_shm(void)
 213 {
 214         struct shmid_ds sbuf;
 215
 216         if (threads) {
 217                 void *tp = threads;
 218
 219                 threads = NULL;
 220                 shmdt(tp);
 221                 shmctl(shm_id, IPC_RMID, &sbuf);
 222                 shm_id = -1;
 223         }
 224 }
 225
 226 void free_shm(void)
 227 {
 228         if (threads) {
 229                 file_hash_exit();
 230                 flow_exit();
 231                 fio_debug_jobp = NULL;
 232                 free_threads_shm();
 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         return ret;
 607 }
 608
 609 /*
 610  * This function leaks the buffer
 611  */
 612 char *fio_uint_to_kmg(unsigned int val)
 613 {
 614         char *buf = malloc(32);
 615         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 616         char *p = post;
 617
 618         do {
 619                 if (val & 1023)
 620                         break;
 621
 622                 val >>= 10;
 623                 p++;
 624         } while (*p);
 625
 626         snprintf(buf, 31, "%u%c", val, *p);
 627         return buf;
 628 }
 629
 630 /* External engines are specified by "external:name.o") */
 631 static const char *get_engine_name(const char *str)
 632 {
 633         char *p = strstr(str, ":");
 634
 635         if (!p)
 636                 return str;
 637
 638         p++;
 639         strip_blank_front(&p);
 640         strip_blank_end(p);
 641         return p;
 642 }
 643
 644 static int exists_and_not_file(const char *filename)
 645 {
 646         struct stat sb;
 647
 648         if (lstat(filename, &sb) == -1)
 649                 return 0;
 650
 651         /* \\.\ is the device namespace in Windows, where every file
 652          * is a device node */
 653         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
 654                 return 0;
 655
 656         return 1;
 657 }
 658
 659 static void td_fill_rand_seeds_os(struct thread_data *td)
 660 {
 661         os_random_seed(td->rand_seeds[0], &td->bsrange_state);
 662         os_random_seed(td->rand_seeds[1], &td->verify_state);
 663         os_random_seed(td->rand_seeds[2], &td->rwmix_state);
 664
 665         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 666                 os_random_seed(td->rand_seeds[3], &td->next_file_state);
 667
 668         os_random_seed(td->rand_seeds[5], &td->file_size_state);
 669         os_random_seed(td->rand_seeds[6], &td->trim_state);
 670
 671         if (!td_random(td))
 672                 return;
 673
 674         if (td->o.rand_repeatable)
 675                 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
 676
 677         os_random_seed(td->rand_seeds[4], &td->random_state);
 678 }
 679
 680 static void td_fill_rand_seeds_internal(struct thread_data *td)
 681 {
 682         init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
 683         init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
 684         init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
 685
 686         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 687                 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
 688
 689         init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
 690         init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
 691
 692         if (!td_random(td))
 693                 return;
 694
 695         if (td->o.rand_repeatable)
 696                 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
 697
 698         init_rand_seed(&td->__random_state, td->rand_seeds[4]);
 699 }
 700
 701 void td_fill_rand_seeds(struct thread_data *td)
 702 {
 703         if (td->o.use_os_rand)
 704                 td_fill_rand_seeds_os(td);
 705         else
 706                 td_fill_rand_seeds_internal(td);
 707
 708         init_rand_seed(&td->buf_state, td->rand_seeds[7]);
 709 }
 710
 711
 712 /*
 713  * Initializes the ioengine configured for a job, if it has not been done so
 714  * already.
 715  */
 716 int ioengine_load(struct thread_data *td)
 717 {
 718         const char *engine;
 719
 720         /*
 721          * Engine has already been loaded.
 722          */
 723         if (td->io_ops)
 724                 return 0;
 725
 726         engine = get_engine_name(td->o.ioengine);
 727         td->io_ops = load_ioengine(td, engine);
 728         if (!td->io_ops) {
 729                 log_err("fio: failed to load engine %s\n", engine);
 730                 return 1;
 731         }
 732
 733         if (td->io_ops->option_struct_size && td->io_ops->options) {
 734                 /*
 735                  * In cases where td->eo is set, clone it for a child thread.
 736                  * This requires that the parent thread has the same ioengine,
 737                  * but that requirement must be enforced by the code which
 738                  * cloned the thread.
 739                  */
 740                 void *origeo = td->eo;
 741                 /*
 742                  * Otherwise use the default thread options.
 743                  */
 744                 if (!origeo && td != &def_thread && def_thread.eo &&
 745                     def_thread.io_ops->options == td->io_ops->options)
 746                         origeo = def_thread.eo;
 747
 748                 options_init(td->io_ops->options);
 749                 td->eo = malloc(td->io_ops->option_struct_size);
 750                 /*
 751                  * Use the default thread as an option template if this uses the
 752                  * same options structure and there are non-default options
 753                  * used.
 754                  */
 755                 if (origeo) {
 756                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 757                         options_mem_dupe(td->eo, td->io_ops->options);
 758                 } else {
 759                         memset(td->eo, 0, td->io_ops->option_struct_size);
 760                         fill_default_options(td->eo, td->io_ops->options);
 761                 }
 762                 *(struct thread_data **)td->eo = td;
 763         }
 764
 765         return 0;
 766 }
 767
 768 /*
 769  * Adds a job to the list of things todo. Sanitizes the various options
 770  * to make sure we don't have conflicts, and initializes various
 771  * members of td.
 772  */
 773 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
 774                    int recursed, int client_type)
 775 {
 776         unsigned int i;
 777         char fname[PATH_MAX];
 778         int numjobs, file_alloced;
 779
 780         /*
 781          * the def_thread is just for options, it's not a real job
 782          */
 783         if (td == &def_thread)
 784                 return 0;
 785
 786         /*
 787          * if we are just dumping the output command line, don't add the job
 788          */
 789         if (dump_cmdline) {
 790                 put_job(td);
 791                 return 0;
 792         }
 793
 794         td->client_type = client_type;
 795
 796         if (profile_td_init(td))
 797                 goto err;
 798
 799         if (ioengine_load(td))
 800                 goto err;
 801
 802         if (td->o.odirect)
 803                 td->io_ops->flags |= FIO_RAWIO;
 804
 805         file_alloced = 0;
 806         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
 807                 file_alloced = 1;
 808
 809                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
 810                         add_file(td, jobname);
 811                 else {
 812                         for (i = 0; i < td->o.nr_files; i++) {
 813                                 sprintf(fname, "%s.%d.%d", jobname,
 814                                                         td->thread_number, i);
 815                                 add_file(td, fname);
 816                         }
 817                 }
 818         }
 819
 820         if (fixup_options(td))
 821                 goto err;
 822
 823         flow_init_job(td);
 824
 825         /*
 826          * IO engines only need this for option callbacks, and the address may
 827          * change in subprocesses.
 828          */
 829         if (td->eo)
 830                 *(struct thread_data **)td->eo = NULL;
 831
 832         if (td->io_ops->flags & FIO_DISKLESSIO) {
 833                 struct fio_file *f;
 834
 835                 for_each_file(td, f, i)
 836                         f->real_file_size = -1ULL;
 837         }
 838
 839         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
 840
 841         td->ts.clat_percentiles = td->o.clat_percentiles;
 842         if (td->o.overwrite_plist)
 843                 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
 844         else
 845                 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
 846
 847         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 848                 td->ts.clat_stat[i].min_val = ULONG_MAX;
 849                 td->ts.slat_stat[i].min_val = ULONG_MAX;
 850                 td->ts.lat_stat[i].min_val = ULONG_MAX;
 851                 td->ts.bw_stat[i].min_val = ULONG_MAX;
 852         }
 853         td->ddir_seq_nr = td->o.ddir_seq_nr;
 854
 855         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
 856                 prev_group_jobs = 0;
 857                 groupid++;
 858         }
 859
 860         td->groupid = groupid;
 861         prev_group_jobs++;
 862
 863         if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
 864                 td_verror(td, errno, "init_random_state");
 865                 goto err;
 866         }
 867
 868         if (setup_rate(td))
 869                 goto err;
 870
 871         if (td->o.lat_log_file) {
 872                 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
 873                 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
 874                 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
 875         }
 876         if (td->o.bw_log_file)
 877                 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
 878         if (td->o.iops_log_file)
 879                 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
 880
 881         if (!td->o.name)
 882                 td->o.name = strdup(jobname);
 883
 884         if (output_format == FIO_OUTPUT_NORMAL) {
 885                 if (!job_add_num) {
 886                         if (is_backend && !recursed)
 887                                 fio_server_send_add_job(td);
 888
 889                         if (!(td->io_ops->flags & FIO_NOIO)) {
 890                                 char *c1, *c2, *c3, *c4, *c5, *c6;
 891
 892                                 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
 893                                 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
 894                                 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
 895                                 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
 896                                 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
 897                                 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
 898
 899                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
 900                                          " ioengine=%s, iodepth=%u\n",
 901                                                 td->o.name, td->groupid,
 902                                                 ddir_str(td->o.td_ddir),
 903                                                 c1, c2, c3, c4, c5, c6,
 904                                                 td->io_ops->name,
 905                                                 td->o.iodepth);
 906
 907                                 free(c1);
 908                                 free(c2);
 909                                 free(c3);
 910                                 free(c4);
 911                                 free(c5);
 912                                 free(c6);
 913                         }
 914                 } else if (job_add_num == 1)
 915                         log_info("...\n");
 916         }
 917
 918         /*
 919          * recurse add identical jobs, clear numjobs and stonewall options
 920          * as they don't apply to sub-jobs
 921          */
 922         numjobs = td->o.numjobs;
 923         while (--numjobs) {
 924                 struct thread_data *td_new = get_new_job(0, td, 1);
 925
 926                 if (!td_new)
 927                         goto err;
 928
 929                 td_new->o.numjobs = 1;
 930                 td_new->o.stonewall = 0;
 931                 td_new->o.new_group = 0;
 932
 933                 if (file_alloced) {
 934                         td_new->o.filename = NULL;
 935                         td_new->files_index = 0;
 936                         td_new->files_size = 0;
 937                         td_new->files = NULL;
 938                 }
 939
 940                 job_add_num = numjobs - 1;
 941
 942                 if (add_job(td_new, jobname, job_add_num, 1, client_type))
 943                         goto err;
 944         }
 945
 946         return 0;
 947 err:
 948         put_job(td);
 949         return -1;
 950 }
 951
 952 /*
 953  * Parse as if 'o' was a command line
 954  */
 955 void add_job_opts(const char **o, int client_type)
 956 {
 957         struct thread_data *td, *td_parent;
 958         int i, in_global = 1;
 959         char jobname[32];
 960
 961         i = 0;
 962         td_parent = td = NULL;
 963         while (o[i]) {
 964                 if (!strncmp(o[i], "name", 4)) {
 965                         in_global = 0;
 966                         if (td)
 967                                 add_job(td, jobname, 0, 0, client_type);
 968                         td = NULL;
 969                         sprintf(jobname, "%s", o[i] + 5);
 970                 }
 971                 if (in_global && !td_parent)
 972                         td_parent = get_new_job(1, &def_thread, 0);
 973                 else if (!in_global && !td) {
 974                         if (!td_parent)
 975                                 td_parent = &def_thread;
 976                         td = get_new_job(0, td_parent, 0);
 977                 }
 978                 if (in_global)
 979                         fio_options_parse(td_parent, (char **) &o[i], 1);
 980                 else
 981                         fio_options_parse(td, (char **) &o[i], 1);
 982                 i++;
 983         }
 984
 985         if (td)
 986                 add_job(td, jobname, 0, 0, client_type);
 987 }
 988
 989 static int skip_this_section(const char *name)
 990 {
 991         int i;
 992
 993         if (!nr_job_sections)
 994                 return 0;
 995         if (!strncmp(name, "global", 6))
 996                 return 0;
 997
 998         for (i = 0; i < nr_job_sections; i++)
 999                 if (!strcmp(job_sections[i], name))
1000                         return 0;
1001
1002         return 1;
1003 }
1004
1005 static int is_empty_or_comment(char *line)
1006 {
1007         unsigned int i;
1008
1009         for (i = 0; i < strlen(line); i++) {
1010                 if (line[i] == ';')
1011                         return 1;
1012                 if (line[i] == '#')
1013                         return 1;
1014                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1015                         return 0;
1016         }
1017
1018         return 1;
1019 }
1020
1021 /*
1022  * This is our [ini] type file parser.
1023  */
1024 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1025 {
1026         unsigned int global;
1027         struct thread_data *td;
1028         char *string, *name;
1029         FILE *f;
1030         char *p;
1031         int ret = 0, stonewall;
1032         int first_sect = 1;
1033         int skip_fgets = 0;
1034         int inside_skip = 0;
1035         char **opts;
1036         int i, alloc_opts, num_opts;
1037
1038         if (is_buf)
1039                 f = NULL;
1040         else {
1041                 if (!strcmp(file, "-"))
1042                         f = stdin;
1043                 else
1044                         f = fopen(file, "r");
1045
1046                 if (!f) {
1047                         perror("fopen job file");
1048                         return 1;
1049                 }
1050         }
1051
1052         string = malloc(4096);
1053
1054         /*
1055          * it's really 256 + small bit, 280 should suffice
1056          */
1057         name = malloc(280);
1058         memset(name, 0, 280);
1059
1060         alloc_opts = 8;
1061         opts = malloc(sizeof(char *) * alloc_opts);
1062         num_opts = 0;
1063
1064         stonewall = stonewall_flag;
1065         do {
1066                 /*
1067                  * if skip_fgets is set, we already have loaded a line we
1068                  * haven't handled.
1069                  */
1070                 if (!skip_fgets) {
1071                         if (is_buf)
1072                                 p = strsep(&file, "\n");
1073                         else
1074                                 p = fgets(string, 4096, f);
1075                         if (!p)
1076                                 break;
1077                 }
1078
1079                 skip_fgets = 0;
1080                 strip_blank_front(&p);
1081                 strip_blank_end(p);
1082
1083                 if (is_empty_or_comment(p))
1084                         continue;
1085                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1086                         if (inside_skip)
1087                                 continue;
1088                         log_err("fio: option <%s> outside of [] job section\n",
1089                                                                         p);
1090                         break;
1091                 }
1092
1093                 name[strlen(name) - 1] = '\0';
1094
1095                 if (skip_this_section(name)) {
1096                         inside_skip = 1;
1097                         continue;
1098                 } else
1099                         inside_skip = 0;
1100
1101                 global = !strncmp(name, "global", 6);
1102
1103                 if (dump_cmdline) {
1104                         if (first_sect)
1105                                 log_info("fio ");
1106                         if (!global)
1107                                 log_info("--name=%s ", name);
1108                         first_sect = 0;
1109                 }
1110
1111                 td = get_new_job(global, &def_thread, 0);
1112                 if (!td) {
1113                         ret = 1;
1114                         break;
1115                 }
1116
1117                 /*
1118                  * Seperate multiple job files by a stonewall
1119                  */
1120                 if (!global && stonewall) {
1121                         td->o.stonewall = stonewall;
1122                         stonewall = 0;
1123                 }
1124
1125                 num_opts = 0;
1126                 memset(opts, 0, alloc_opts * sizeof(char *));
1127
1128                 while (1) {
1129                         if (is_buf)
1130                                 p = strsep(&file, "\n");
1131                         else
1132                                 p = fgets(string, 4096, f);
1133                         if (!p)
1134                                 break;
1135
1136                         if (is_empty_or_comment(p))
1137                                 continue;
1138
1139                         strip_blank_front(&p);
1140
1141                         /*
1142                          * new section, break out and make sure we don't
1143                          * fgets() a new line at the top.
1144                          */
1145                         if (p[0] == '[') {
1146                                 skip_fgets = 1;
1147                                 break;
1148                         }
1149
1150                         strip_blank_end(p);
1151
1152                         if (num_opts == alloc_opts) {
1153                                 alloc_opts <<= 1;
1154                                 opts = realloc(opts,
1155                                                 alloc_opts * sizeof(char *));
1156                         }
1157
1158                         opts[num_opts] = strdup(p);
1159                         num_opts++;
1160                 }
1161
1162                 ret = fio_options_parse(td, opts, num_opts);
1163                 if (!ret) {
1164                         if (dump_cmdline)
1165                                 for (i = 0; i < num_opts; i++)
1166                                         log_info("--%s ", opts[i]);
1167
1168                         ret = add_job(td, name, 0, 0, type);
1169                 } else {
1170                         log_err("fio: job %s dropped\n", name);
1171                         put_job(td);
1172                 }
1173
1174                 for (i = 0; i < num_opts; i++)
1175                         free(opts[i]);
1176                 num_opts = 0;
1177         } while (!ret);
1178
1179         if (dump_cmdline)
1180                 log_info("\n");
1181
1182         i = 0;
1183         while (i < nr_job_sections) {
1184                 free(job_sections[i]);
1185                 i++;
1186         }
1187
1188         for (i = 0; i < num_opts; i++)
1189                 free(opts[i]);
1190
1191         free(string);
1192         free(name);
1193         free(opts);
1194         if (!is_buf && f != stdin)
1195                 fclose(f);
1196         return ret;
1197 }
1198
1199 static int fill_def_thread(void)
1200 {
1201         memset(&def_thread, 0, sizeof(def_thread));
1202
1203         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1204         def_thread.o.timeout = def_timeout;
1205         def_thread.o.error_dump = 1;
1206         /*
1207          * fill default options
1208          */
1209         fio_fill_default_options(&def_thread);
1210         return 0;
1211 }
1212
1213 static void usage(const char *name)
1214 {
1215         printf("%s\n", fio_version_string);
1216         printf("%s [options] [job options] <job file(s)>\n", name);
1217         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1218                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1219                 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1220         printf("  --output\t\tWrite output to file\n");
1221         printf("  --runtime\t\tRuntime in seconds\n");
1222         printf("  --latency-log\t\tGenerate per-job latency logs\n");
1223         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1224         printf("  --minimal\t\tMinimal (terse) output\n");
1225         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1226         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1227         printf("  --version\t\tPrint version info and exit\n");
1228         printf("  --help\t\tPrint this page\n");
1229         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1230                 " them\n");
1231         printf("  --enghelp=engine\tPrint ioengine help, or list"
1232                 " available ioengines\n");
1233         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1234                 " cmd\n");
1235         printf("  --showcmd\t\tTurn a job file into command line options\n");
1236         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1237         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1238         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1239                 " writes\n");
1240         printf("  --section=name\tOnly run specified section in job file\n");
1241         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1242                 " (def 1024)\n");
1243         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1244         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1245         printf("  --server=args\t\tStart a backend fio server\n");
1246         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1247         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1248         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1249         printf("\n                 Jens Axboe <jaxboe@fusionio.com>\n");
1250 }
1251
1252 #ifdef FIO_INC_DEBUG
1253 struct debug_level debug_levels[] = {
1254         { .name = "process",
1255           .help = "Process creation/exit logging",
1256           .shift = FD_PROCESS,
1257         },
1258         { .name = "file",
1259           .help = "File related action logging",
1260           .shift = FD_FILE,
1261         },
1262         { .name = "io",
1263           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1264           .shift = FD_IO,
1265         },
1266         { .name = "mem",
1267           .help = "Memory allocation/freeing logging",
1268           .shift = FD_MEM,
1269         },
1270         { .name = "blktrace",
1271           .help = "blktrace action logging",
1272           .shift = FD_BLKTRACE,
1273         },
1274         { .name = "verify",
1275           .help = "IO verification action logging",
1276           .shift = FD_VERIFY,
1277         },
1278         { .name = "random",
1279           .help = "Random generation logging",
1280           .shift = FD_RANDOM,
1281         },
1282         { .name = "parse",
1283           .help = "Parser logging",
1284           .shift = FD_PARSE,
1285         },
1286         { .name = "diskutil",
1287           .help = "Disk utility logging actions",
1288           .shift = FD_DISKUTIL,
1289         },
1290         { .name = "job",
1291           .help = "Logging related to creating/destroying jobs",
1292           .shift = FD_JOB,
1293         },
1294         { .name = "mutex",
1295           .help = "Mutex logging",
1296           .shift = FD_MUTEX
1297         },
1298         { .name = "profile",
1299           .help = "Logging related to profiles",
1300           .shift = FD_PROFILE,
1301         },
1302         { .name = "time",
1303           .help = "Logging related to time keeping functions",
1304           .shift = FD_TIME,
1305         },
1306         { .name = "net",
1307           .help = "Network logging",
1308           .shift = FD_NET,
1309         },
1310         { .name = NULL, },
1311 };
1312
1313 static int set_debug(const char *string)
1314 {
1315         struct debug_level *dl;
1316         char *p = (char *) string;
1317         char *opt;
1318         int i;
1319
1320         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1321                 log_info("fio: dumping debug options:");
1322                 for (i = 0; debug_levels[i].name; i++) {
1323                         dl = &debug_levels[i];
1324                         log_info("%s,", dl->name);
1325                 }
1326                 log_info("all\n");
1327                 return 1;
1328         }
1329
1330         while ((opt = strsep(&p, ",")) != NULL) {
1331                 int found = 0;
1332
1333                 if (!strncmp(opt, "all", 3)) {
1334                         log_info("fio: set all debug options\n");
1335                         fio_debug = ~0UL;
1336                         continue;
1337                 }
1338
1339                 for (i = 0; debug_levels[i].name; i++) {
1340                         dl = &debug_levels[i];
1341                         found = !strncmp(opt, dl->name, strlen(dl->name));
1342                         if (!found)
1343                                 continue;
1344
1345                         if (dl->shift == FD_JOB) {
1346                                 opt = strchr(opt, ':');
1347                                 if (!opt) {
1348                                         log_err("fio: missing job number\n");
1349                                         break;
1350                                 }
1351                                 opt++;
1352                                 fio_debug_jobno = atoi(opt);
1353                                 log_info("fio: set debug jobno %d\n",
1354                                                         fio_debug_jobno);
1355                         } else {
1356                                 log_info("fio: set debug option %s\n", opt);
1357                                 fio_debug |= (1UL << dl->shift);
1358                         }
1359                         break;
1360                 }
1361
1362                 if (!found)
1363                         log_err("fio: debug mask %s not found\n", opt);
1364         }
1365         return 0;
1366 }
1367 #else
1368 static int set_debug(const char *string)
1369 {
1370         log_err("fio: debug tracing not included in build\n");
1371         return 1;
1372 }
1373 #endif
1374
1375 static void fio_options_fill_optstring(void)
1376 {
1377         char *ostr = cmd_optstr;
1378         int i, c;
1379
1380         c = i = 0;
1381         while (l_opts[i].name) {
1382                 ostr[c++] = l_opts[i].val;
1383                 if (l_opts[i].has_arg == required_argument)
1384                         ostr[c++] = ':';
1385                 else if (l_opts[i].has_arg == optional_argument) {
1386                         ostr[c++] = ':';
1387                         ostr[c++] = ':';
1388                 }
1389                 i++;
1390         }
1391         ostr[c] = '\0';
1392 }
1393
1394 static int client_flag_set(char c)
1395 {
1396         int i;
1397
1398         i = 0;
1399         while (l_opts[i].name) {
1400                 int val = l_opts[i].val;
1401
1402                 if (c == (val & 0xff))
1403                         return (val & FIO_CLIENT_FLAG);
1404
1405                 i++;
1406         }
1407
1408         return 0;
1409 }
1410
1411 void parse_cmd_client(void *client, char *opt)
1412 {
1413         fio_client_add_cmd_option(client, opt);
1414 }
1415
1416 int parse_cmd_line(int argc, char *argv[], int client_type)
1417 {
1418         struct thread_data *td = NULL;
1419         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1420         char *ostr = cmd_optstr;
1421         void *pid_file = NULL;
1422         void *cur_client = NULL;
1423         int backend = 0;
1424
1425         /*
1426          * Reset optind handling, since we may call this multiple times
1427          * for the backend.
1428          */
1429         optind = 1;
1430
1431         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1432                 did_arg = 1;
1433
1434                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1435                         parse_cmd_client(cur_client, argv[optind - 1]);
1436                         c &= ~FIO_CLIENT_FLAG;
1437                 }
1438
1439                 switch (c) {
1440                 case 'a':
1441                         smalloc_pool_size = atoi(optarg);
1442                         break;
1443                 case 't':
1444                         def_timeout = atoi(optarg);
1445                         break;
1446                 case 'l':
1447                         write_lat_log = 1;
1448                         break;
1449                 case 'b':
1450                         write_bw_log = 1;
1451                         break;
1452                 case 'o':
1453                         f_out = fopen(optarg, "w+");
1454                         if (!f_out) {
1455                                 perror("fopen output");
1456                                 exit(1);
1457                         }
1458                         f_err = f_out;
1459                         break;
1460                 case 'm':
1461                         output_format = FIO_OUTPUT_TERSE;
1462                         break;
1463                 case 'F':
1464                         if (!strcmp(optarg, "minimal") ||
1465                             !strcmp(optarg, "terse") ||
1466                             !strcmp(optarg, "csv"))
1467                                 output_format = FIO_OUTPUT_TERSE;
1468                         else if (!strcmp(optarg, "json"))
1469                                 output_format = FIO_OUTPUT_JSON;
1470                         else
1471                                 output_format = FIO_OUTPUT_NORMAL;
1472                         break;
1473                 case 'h':
1474                         if (!cur_client) {
1475                                 usage(argv[0]);
1476                                 do_exit++;
1477                         }
1478                         break;
1479                 case 'c':
1480                         if (!cur_client) {
1481                                 fio_show_option_help(optarg);
1482                                 do_exit++;
1483                         }
1484                         break;
1485                 case 'i':
1486                         if (!cur_client) {
1487                                 fio_show_ioengine_help(optarg);
1488                                 do_exit++;
1489                         }
1490                         break;
1491                 case 's':
1492                         dump_cmdline = 1;
1493                         break;
1494                 case 'r':
1495                         read_only = 1;
1496                         break;
1497                 case 'v':
1498                         if (!cur_client) {
1499                                 log_info("%s\n", fio_version_string);
1500                                 do_exit++;
1501                         }
1502                         break;
1503                 case 'V':
1504                         terse_version = atoi(optarg);
1505                         if (!(terse_version == 2 || terse_version == 3 ||
1506                              terse_version == 4)) {
1507                                 log_err("fio: bad terse version format\n");
1508                                 exit_val = 1;
1509                                 do_exit++;
1510                         }
1511                         break;
1512                 case 'e':
1513                         if (!strcmp("always", optarg))
1514                                 eta_print = FIO_ETA_ALWAYS;
1515                         else if (!strcmp("never", optarg))
1516                                 eta_print = FIO_ETA_NEVER;
1517                         break;
1518                 case 'd':
1519                         if (set_debug(optarg))
1520                                 do_exit++;
1521                         break;
1522                 case 'x': {
1523                         size_t new_size;
1524
1525                         if (!strcmp(optarg, "global")) {
1526                                 log_err("fio: can't use global as only "
1527                                         "section\n");
1528                                 do_exit++;
1529                                 exit_val = 1;
1530                                 break;
1531                         }
1532                         new_size = (nr_job_sections + 1) * sizeof(char *);
1533                         job_sections = realloc(job_sections, new_size);
1534                         job_sections[nr_job_sections] = strdup(optarg);
1535                         nr_job_sections++;
1536                         break;
1537                         }
1538                 case 'p':
1539                         exec_profile = strdup(optarg);
1540                         break;
1541                 case FIO_GETOPT_JOB: {
1542                         const char *opt = l_opts[lidx].name;
1543                         char *val = optarg;
1544
1545                         if (!strncmp(opt, "name", 4) && td) {
1546                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1547                                 if (ret)
1548                                         return 0;
1549                                 td = NULL;
1550                         }
1551                         if (!td) {
1552                                 int is_section = !strncmp(opt, "name", 4);
1553                                 int global = 0;
1554
1555                                 if (!is_section || !strncmp(val, "global", 6))
1556                                         global = 1;
1557
1558                                 if (is_section && skip_this_section(val))
1559                                         continue;
1560
1561                                 td = get_new_job(global, &def_thread, 1);
1562                                 if (!td || ioengine_load(td))
1563                                         return 0;
1564                                 fio_options_set_ioengine_opts(l_opts, td);
1565                         }
1566
1567                         ret = fio_cmd_option_parse(td, opt, val);
1568
1569                         if (!ret && !strcmp(opt, "ioengine")) {
1570                                 free_ioengine(td);
1571                                 if (ioengine_load(td))
1572                                         return 0;
1573                                 fio_options_set_ioengine_opts(l_opts, td);
1574                         }
1575                         break;
1576                 }
1577                 case FIO_GETOPT_IOENGINE: {
1578                         const char *opt = l_opts[lidx].name;
1579                         char *val = optarg;
1580                         opt = l_opts[lidx].name;
1581                         val = optarg;
1582                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1583                         break;
1584                 }
1585                 case 'w':
1586                         warnings_fatal = 1;
1587                         break;
1588                 case 'j':
1589                         max_jobs = atoi(optarg);
1590                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1591                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1592                                 do_exit++;
1593                                 exit_val = 1;
1594                         }
1595                         break;
1596                 case 'S':
1597                         if (nr_clients) {
1598                                 log_err("fio: can't be both client and server\n");
1599                                 do_exit++;
1600                                 exit_val = 1;
1601                                 break;
1602                         }
1603                         if (optarg)
1604                                 fio_server_set_arg(optarg);
1605                         is_backend = 1;
1606                         backend = 1;
1607                         break;
1608                 case 'D':
1609                         pid_file = strdup(optarg);
1610                         break;
1611                 case 'C':
1612                         if (is_backend) {
1613                                 log_err("fio: can't be both client and server\n");
1614                                 do_exit++;
1615                                 exit_val = 1;
1616                                 break;
1617                         }
1618                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1619                                 log_err("fio: failed adding client %s\n", optarg);
1620                                 do_exit++;
1621                                 exit_val = 1;
1622                                 break;
1623                         }
1624                         /*
1625                          * If the next argument exists and isn't an option,
1626                          * assume it's a job file for this client only.
1627                          */
1628                         while (optind < argc) {
1629                                 if (!strncmp(argv[optind], "--", 2) ||
1630                                     !strncmp(argv[optind], "-", 1))
1631                                         break;
1632
1633                                 fio_client_add_ini_file(cur_client, argv[optind]);
1634                                 optind++;
1635                         }
1636                         break;
1637                 default:
1638                         do_exit++;
1639                         exit_val = 1;
1640                         break;
1641                 }
1642                 if (do_exit)
1643                         break;
1644         }
1645
1646         if (do_exit) {
1647                 if (exit_val && !(is_backend || nr_clients))
1648                         exit(exit_val);
1649         }
1650
1651         if (nr_clients && fio_clients_connect()) {
1652                 do_exit++;
1653                 exit_val = 1;
1654                 return -1;
1655         }
1656
1657         if (is_backend && backend)
1658                 return fio_start_server(pid_file);
1659
1660         if (td) {
1661                 if (!ret)
1662                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1663         }
1664
1665         while (!ret && optind < argc) {
1666                 ini_idx++;
1667                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1668                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1669                 optind++;
1670         }
1671
1672         return ini_idx;
1673 }
1674
1675 int fio_init_options(void)
1676 {
1677         f_out = stdout;
1678         f_err = stderr;
1679
1680         fio_options_fill_optstring();
1681         fio_options_dup_and_init(l_opts);
1682
1683         atexit(free_shm);
1684
1685         if (fill_def_thread())
1686                 return 1;
1687
1688         return 0;
1689 }
1690
1691 extern int fio_check_options(struct thread_options *);
1692
1693 int parse_options(int argc, char *argv[])
1694 {
1695         const int type = FIO_CLIENT_TYPE_CLI;
1696         int job_files, i;
1697
1698         if (fio_init_options())
1699                 return 1;
1700         if (fio_test_cconv(&def_thread.o))
1701                 log_err("fio: failed internal cconv test\n");
1702
1703         job_files = parse_cmd_line(argc, argv, type);
1704
1705         if (job_files > 0) {
1706                 for (i = 0; i < job_files; i++) {
1707                         if (fill_def_thread())
1708                                 return 1;
1709                         if (nr_clients) {
1710                                 if (fio_clients_send_ini(ini_file[i]))
1711                                         return 1;
1712                                 free(ini_file[i]);
1713                         } else if (!is_backend) {
1714                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
1715                                         return 1;
1716                                 free(ini_file[i]);
1717                         }
1718                 }
1719         } else if (nr_clients) {
1720                 if (fill_def_thread())
1721                         return 1;
1722                 if (fio_clients_send_ini(NULL))
1723                         return 1;
1724         }
1725
1726         free(ini_file);
1727         fio_options_free(&def_thread);
1728
1729         if (!thread_number) {
1730                 if (dump_cmdline)
1731                         return 0;
1732                 if (exec_profile)
1733                         return 0;
1734                 if (is_backend || nr_clients)
1735                         return 0;
1736                 if (did_arg)
1737                         return 0;
1738
1739                 log_err("No jobs(s) defined\n\n");
1740
1741                 if (!did_arg) {
1742                         usage(argv[0]);
1743                         return 1;
1744                 }
1745
1746                 return 0;
1747         }
1748
1749         if (def_thread.o.gtod_offload) {
1750                 fio_gtod_init();
1751                 fio_gtod_offload = 1;
1752                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1753         }
1754
1755         if (output_format == FIO_OUTPUT_NORMAL)
1756                 log_info("%s\n", fio_version_string);
1757
1758         return 0;
1759 }
1760
1761 void options_default_fill(struct thread_options *o)
1762 {
1763         memcpy(o, &def_thread.o, sizeof(*o));
1764 }