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 FILE *f_out = NULL;
  44 FILE *f_err = NULL;
  45 char **job_sections = NULL;
  46 int nr_job_sections = 0;
  47 char *exec_profile = NULL;
  48 int warnings_fatal = 0;
  49 int terse_version = 3;
  50 int is_backend = 0;
  51 int nr_clients = 0;
  52 int log_syslog = 0;
  53
  54 int write_bw_log = 0;
  55 int read_only = 0;
  56
  57 static int write_lat_log;
  58
  59 static int prev_group_jobs;
  60
  61 unsigned long fio_debug = 0;
  62 unsigned int fio_debug_jobno = -1;
  63 unsigned int *fio_debug_jobp = NULL;
  64
  65 static char cmd_optstr[256];
  66 static int did_arg;
  67
  68 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
  69         { .u.f  =  1.00 },
  70         { .u.f  =  5.00 },
  71         { .u.f  = 10.00 },
  72         { .u.f  = 20.00 },
  73         { .u.f  = 30.00 },
  74         { .u.f  = 40.00 },
  75         { .u.f  = 50.00 },
  76         { .u.f  = 60.00 },
  77         { .u.f  = 70.00 },
  78         { .u.f  = 80.00 },
  79         { .u.f  = 90.00 },
  80         { .u.f  = 95.00 },
  81         { .u.f  = 99.00 },
  82         { .u.f  = 99.50 },
  83         { .u.f  = 99.90 },
  84         { .u.f  = 99.95 },
  85         { .u.f  = 99.99 },
  86 };
  87
  88 #define FIO_CLIENT_FLAG         (1 << 16)
  89
  90 /*
  91  * Command line options. These will contain the above, plus a few
  92  * extra that only pertain to fio itself and not jobs.
  93  */
  94 static struct option l_opts[FIO_NR_OPTIONS] = {
  95         {
  96                 .name           = (char *) "output",
  97                 .has_arg        = required_argument,
  98                 .val            = 'o' | FIO_CLIENT_FLAG,
  99         },
 100         {
 101                 .name           = (char *) "timeout",
 102                 .has_arg        = required_argument,
 103                 .val            = 't' | FIO_CLIENT_FLAG,
 104         },
 105         {
 106                 .name           = (char *) "latency-log",
 107                 .has_arg        = required_argument,
 108                 .val            = 'l' | FIO_CLIENT_FLAG,
 109         },
 110         {
 111                 .name           = (char *) "bandwidth-log",
 112                 .has_arg        = required_argument,
 113                 .val            = 'b' | FIO_CLIENT_FLAG,
 114         },
 115         {
 116                 .name           = (char *) "minimal",
 117                 .has_arg        = optional_argument,
 118                 .val            = 'm' | FIO_CLIENT_FLAG,
 119         },
 120         {
 121                 .name           = (char *) "output-format",
 122                 .has_arg        = optional_argument,
 123                 .val            = 'F' | FIO_CLIENT_FLAG,
 124         },
 125         {
 126                 .name           = (char *) "version",
 127                 .has_arg        = no_argument,
 128                 .val            = 'v' | FIO_CLIENT_FLAG,
 129         },
 130         {
 131                 .name           = (char *) "help",
 132                 .has_arg        = no_argument,
 133                 .val            = 'h' | FIO_CLIENT_FLAG,
 134         },
 135         {
 136                 .name           = (char *) "cmdhelp",
 137                 .has_arg        = optional_argument,
 138                 .val            = 'c' | FIO_CLIENT_FLAG,
 139         },
 140         {
 141                 .name              = (char *) "enghelp",
 142                 .has_arg        = optional_argument,
 143                 .val                = 'i' | FIO_CLIENT_FLAG,
 144         },
 145         {
 146                 .name           = (char *) "showcmd",
 147                 .has_arg        = no_argument,
 148                 .val            = 's' | FIO_CLIENT_FLAG,
 149         },
 150         {
 151                 .name           = (char *) "readonly",
 152                 .has_arg        = no_argument,
 153                 .val            = 'r' | FIO_CLIENT_FLAG,
 154         },
 155         {
 156                 .name           = (char *) "eta",
 157                 .has_arg        = required_argument,
 158                 .val            = 'e' | FIO_CLIENT_FLAG,
 159         },
 160         {
 161                 .name           = (char *) "debug",
 162                 .has_arg        = required_argument,
 163                 .val            = 'd' | FIO_CLIENT_FLAG,
 164         },
 165         {
 166                 .name           = (char *) "section",
 167                 .has_arg        = required_argument,
 168                 .val            = 'x' | FIO_CLIENT_FLAG,
 169         },
 170         {
 171                 .name           = (char *) "alloc-size",
 172                 .has_arg        = required_argument,
 173                 .val            = 'a' | FIO_CLIENT_FLAG,
 174         },
 175         {
 176                 .name           = (char *) "profile",
 177                 .has_arg        = required_argument,
 178                 .val            = 'p' | FIO_CLIENT_FLAG,
 179         },
 180         {
 181                 .name           = (char *) "warnings-fatal",
 182                 .has_arg        = no_argument,
 183                 .val            = 'w' | FIO_CLIENT_FLAG,
 184         },
 185         {
 186                 .name           = (char *) "max-jobs",
 187                 .has_arg        = required_argument,
 188                 .val            = 'j' | FIO_CLIENT_FLAG,
 189         },
 190         {
 191                 .name           = (char *) "terse-version",
 192                 .has_arg        = required_argument,
 193                 .val            = 'V' | FIO_CLIENT_FLAG,
 194         },
 195         {
 196                 .name           = (char *) "server",
 197                 .has_arg        = optional_argument,
 198                 .val            = 'S',
 199         },
 200         {       .name           = (char *) "daemonize",
 201                 .has_arg        = required_argument,
 202                 .val            = 'D',
 203         },
 204         {
 205                 .name           = (char *) "client",
 206                 .has_arg        = required_argument,
 207                 .val            = 'C',
 208         },
 209         {
 210                 .name           = (char *) "cpuclock-test",
 211                 .has_arg        = no_argument,
 212                 .val            = 'T',
 213         },
 214         {
 215                 .name           = NULL,
 216         },
 217 };
 218
 219 void free_threads_shm(void)
 220 {
 221         struct shmid_ds sbuf;
 222
 223         if (threads) {
 224                 void *tp = threads;
 225
 226                 threads = NULL;
 227                 shmdt(tp);
 228                 shmctl(shm_id, IPC_RMID, &sbuf);
 229                 shm_id = -1;
 230         }
 231 }
 232
 233 void free_shm(void)
 234 {
 235         if (threads) {
 236                 file_hash_exit();
 237                 flow_exit();
 238                 fio_debug_jobp = NULL;
 239                 free_threads_shm();
 240         }
 241
 242         scleanup();
 243 }
 244
 245 /*
 246  * The thread area is shared between the main process and the job
 247  * threads/processes. So setup a shared memory segment that will hold
 248  * all the job info. We use the end of the region for keeping track of
 249  * open files across jobs, for file sharing.
 250  */
 251 static int setup_thread_area(void)
 252 {
 253         void *hash;
 254
 255         if (threads)
 256                 return 0;
 257
 258         /*
 259          * 1024 is too much on some machines, scale max_jobs if
 260          * we get a failure that looks like too large a shm segment
 261          */
 262         do {
 263                 size_t size = max_jobs * sizeof(struct thread_data);
 264
 265                 size += file_hash_size;
 266                 size += sizeof(unsigned int);
 267
 268                 shm_id = shmget(0, size, IPC_CREAT | 0600);
 269                 if (shm_id != -1)
 270                         break;
 271                 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
 272                         perror("shmget");
 273                         break;
 274                 }
 275
 276                 max_jobs >>= 1;
 277         } while (max_jobs);
 278
 279         if (shm_id == -1)
 280                 return 1;
 281
 282         threads = shmat(shm_id, NULL, 0);
 283         if (threads == (void *) -1) {
 284                 perror("shmat");
 285                 return 1;
 286         }
 287
 288         memset(threads, 0, max_jobs * sizeof(struct thread_data));
 289         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
 290         fio_debug_jobp = (void *) hash + file_hash_size;
 291         *fio_debug_jobp = -1;
 292         file_hash_init(hash);
 293
 294         flow_init();
 295
 296         return 0;
 297 }
 298
 299 /*
 300  * Return a free job structure.
 301  */
 302 static struct thread_data *get_new_job(int global, struct thread_data *parent,
 303                                        int preserve_eo)
 304 {
 305         struct thread_data *td;
 306
 307         if (global)
 308                 return &def_thread;
 309         if (setup_thread_area()) {
 310                 log_err("error: failed to setup shm segment\n");
 311                 return NULL;
 312         }
 313         if (thread_number >= max_jobs) {
 314                 log_err("error: maximum number of jobs (%d) reached.\n",
 315                                 max_jobs);
 316                 return NULL;
 317         }
 318
 319         td = &threads[thread_number++];
 320         *td = *parent;
 321
 322         td->io_ops = NULL;
 323         if (!preserve_eo)
 324                 td->eo = NULL;
 325
 326         td->o.uid = td->o.gid = -1U;
 327
 328         dup_files(td, parent);
 329         fio_options_mem_dupe(td);
 330
 331         profile_add_hooks(td);
 332
 333         td->thread_number = thread_number;
 334
 335         if (!parent || !parent->o.group_reporting)
 336                 stat_number++;
 337
 338         return td;
 339 }
 340
 341 static void put_job(struct thread_data *td)
 342 {
 343         if (td == &def_thread)
 344                 return;
 345
 346         profile_td_exit(td);
 347         flow_exit_job(td);
 348
 349         if (td->error)
 350                 log_info("fio: %s\n", td->verror);
 351
 352         fio_options_free(td);
 353         if (td->io_ops)
 354                 free_ioengine(td);
 355
 356         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
 357         thread_number--;
 358 }
 359
 360 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 361 {
 362         unsigned int bs = td->o.min_bs[ddir];
 363
 364         assert(ddir_rw(ddir));
 365
 366         if (td->o.rate[ddir])
 367                 td->rate_bps[ddir] = td->o.rate[ddir];
 368         else
 369                 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
 370
 371         if (!td->rate_bps[ddir]) {
 372                 log_err("rate lower than supported\n");
 373                 return -1;
 374         }
 375
 376         td->rate_pending_usleep[ddir] = 0;
 377         return 0;
 378 }
 379
 380 static int setup_rate(struct thread_data *td)
 381 {
 382         int ret = 0;
 383
 384         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
 385                 ret = __setup_rate(td, DDIR_READ);
 386         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
 387                 ret |= __setup_rate(td, DDIR_WRITE);
 388         if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
 389                 ret |= __setup_rate(td, DDIR_TRIM);
 390
 391         return ret;
 392 }
 393
 394 static int fixed_block_size(struct thread_options *o)
 395 {
 396         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
 397                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
 398                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
 399                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
 400                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
 401 }
 402
 403 /*
 404  * Lazy way of fixing up options that depend on each other. We could also
 405  * define option callback handlers, but this is easier.
 406  */
 407 static int fixup_options(struct thread_data *td)
 408 {
 409         struct thread_options *o = &td->o;
 410         int ret = 0;
 411
 412 #ifndef FIO_HAVE_PSHARED_MUTEX
 413         if (!o->use_thread) {
 414                 log_info("fio: this platform does not support process shared"
 415                          " mutexes, forcing use of threads. Use the 'thread'"
 416                          " option to get rid of this warning.\n");
 417                 o->use_thread = 1;
 418                 ret = warnings_fatal;
 419         }
 420 #endif
 421
 422         if (o->write_iolog_file && o->read_iolog_file) {
 423                 log_err("fio: read iolog overrides write_iolog\n");
 424                 free(o->write_iolog_file);
 425                 o->write_iolog_file = NULL;
 426                 ret = warnings_fatal;
 427         }
 428
 429         /*
 430          * only really works with 1 file
 431          */
 432         if (o->zone_size && o->open_files == 1)
 433                 o->zone_size = 0;
 434
 435         /*
 436          * If zone_range isn't specified, backward compatibility dictates it
 437          * should be made equal to zone_size.
 438          */
 439         if (o->zone_size && !o->zone_range)
 440                 o->zone_range = o->zone_size;
 441
 442         /*
 443          * Reads can do overwrites, we always need to pre-create the file
 444          */
 445         if (td_read(td) || td_rw(td))
 446                 o->overwrite = 1;
 447
 448         if (!o->min_bs[DDIR_READ])
 449                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
 450         if (!o->max_bs[DDIR_READ])
 451                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
 452         if (!o->min_bs[DDIR_WRITE])
 453                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 454         if (!o->max_bs[DDIR_WRITE])
 455                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 456         if (!o->min_bs[DDIR_TRIM])
 457                 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 458         if (!o->max_bs[DDIR_TRIM])
 459                 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 460
 461
 462         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
 463         o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
 464
 465         /*
 466          * For random IO, allow blockalign offset other than min_bs.
 467          */
 468         if (!o->ba[DDIR_READ] || !td_random(td))
 469                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
 470         if (!o->ba[DDIR_WRITE] || !td_random(td))
 471                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
 472         if (!o->ba[DDIR_TRIM] || !td_random(td))
 473                 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
 474
 475         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
 476             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
 477             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
 478             !o->norandommap) {
 479                 log_err("fio: Any use of blockalign= turns off randommap\n");
 480                 o->norandommap = 1;
 481                 ret = warnings_fatal;
 482         }
 483
 484         if (!o->file_size_high)
 485                 o->file_size_high = o->file_size_low;
 486
 487         if (o->norandommap && o->verify != VERIFY_NONE
 488             && !fixed_block_size(o))  {
 489                 log_err("fio: norandommap given for variable block sizes, "
 490                         "verify disabled\n");
 491                 o->verify = VERIFY_NONE;
 492                 ret = warnings_fatal;
 493         }
 494         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
 495                 log_err("fio: bs_unaligned may not work with raw io\n");
 496
 497         /*
 498          * thinktime_spin must be less than thinktime
 499          */
 500         if (o->thinktime_spin > o->thinktime)
 501                 o->thinktime_spin = o->thinktime;
 502
 503         /*
 504          * The low water mark cannot be bigger than the iodepth
 505          */
 506         if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
 507                 /*
 508                  * syslet work around - if the workload is sequential,
 509                  * we want to let the queue drain all the way down to
 510                  * avoid seeking between async threads
 511                  */
 512                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
 513                         o->iodepth_low = 1;
 514                 else
 515                         o->iodepth_low = o->iodepth;
 516         }
 517
 518         /*
 519          * If batch number isn't set, default to the same as iodepth
 520          */
 521         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 522                 o->iodepth_batch = o->iodepth;
 523
 524         if (o->nr_files > td->files_index)
 525                 o->nr_files = td->files_index;
 526
 527         if (o->open_files > o->nr_files || !o->open_files)
 528                 o->open_files = o->nr_files;
 529
 530         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
 531             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
 532             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
 533             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
 534                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 535                 ret = 1;
 536         }
 537         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
 538             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
 539             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
 540             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
 541             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
 542             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
 543                 log_err("fio: minimum rate exceeds rate\n");
 544                 ret = 1;
 545         }
 546
 547         if (!o->timeout && o->time_based) {
 548                 log_err("fio: time_based requires a runtime/timeout setting\n");
 549                 o->time_based = 0;
 550                 ret = warnings_fatal;
 551         }
 552
 553         if (o->fill_device && !o->size)
 554                 o->size = -1ULL;
 555
 556         if (o->verify != VERIFY_NONE) {
 557                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
 558                         log_info("Multiple writers may overwrite blocks that "
 559                                 "belong to other jobs. This can cause "
 560                                 "verification failures.\n");
 561                         ret = warnings_fatal;
 562                 }
 563
 564                 o->refill_buffers = 1;
 565                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
 566                     !o->verify_interval)
 567                         o->verify_interval = o->min_bs[DDIR_WRITE];
 568         }
 569
 570         if (o->pre_read) {
 571                 o->invalidate_cache = 0;
 572                 if (td->io_ops->flags & FIO_PIPEIO) {
 573                         log_info("fio: cannot pre-read files with an IO engine"
 574                                  " that isn't seekable. Pre-read disabled.\n");
 575                         ret = warnings_fatal;
 576                 }
 577         }
 578
 579 #ifndef FIO_HAVE_FDATASYNC
 580         if (o->fdatasync_blocks) {
 581                 log_info("fio: this platform does not support fdatasync()"
 582                          " falling back to using fsync().  Use the 'fsync'"
 583                          " option instead of 'fdatasync' to get rid of"
 584                          " this warning\n");
 585                 o->fsync_blocks = o->fdatasync_blocks;
 586                 o->fdatasync_blocks = 0;
 587                 ret = warnings_fatal;
 588         }
 589 #endif
 590
 591 #ifdef WIN32
 592         /*
 593          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
 594          * so fail if we're passed those flags
 595          */
 596         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
 597                 log_err("fio: Windows does not support direct or non-buffered io with"
 598                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
 599                                 " with 'direct=1' and 'iodepth=1' instead.\n");
 600                 ret = 1;
 601         }
 602 #endif
 603
 604         /*
 605          * For fully compressible data, just zero them at init time.
 606          * It's faster than repeatedly filling it.
 607          */
 608         if (td->o.compress_percentage == 100) {
 609                 td->o.zero_buffers = 1;
 610                 td->o.compress_percentage = 0;
 611         }
 612
 613         /*
 614          * Using a non-uniform random distribution excludes usage of
 615          * a random map
 616          */
 617         if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
 618                 td->o.norandommap = 1;
 619
 620         return ret;
 621 }
 622
 623 /*
 624  * This function leaks the buffer
 625  */
 626 char *fio_uint_to_kmg(unsigned int val)
 627 {
 628         char *buf = malloc(32);
 629         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 630         char *p = post;
 631
 632         do {
 633                 if (val & 1023)
 634                         break;
 635
 636                 val >>= 10;
 637                 p++;
 638         } while (*p);
 639
 640         snprintf(buf, 31, "%u%c", val, *p);
 641         return buf;
 642 }
 643
 644 /* External engines are specified by "external:name.o") */
 645 static const char *get_engine_name(const char *str)
 646 {
 647         char *p = strstr(str, ":");
 648
 649         if (!p)
 650                 return str;
 651
 652         p++;
 653         strip_blank_front(&p);
 654         strip_blank_end(p);
 655         return p;
 656 }
 657
 658 static int exists_and_not_file(const char *filename)
 659 {
 660         struct stat sb;
 661
 662         if (lstat(filename, &sb) == -1)
 663                 return 0;
 664
 665         /* \\.\ is the device namespace in Windows, where every file
 666          * is a device node */
 667         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
 668                 return 0;
 669
 670         return 1;
 671 }
 672
 673 static void td_fill_rand_seeds_os(struct thread_data *td)
 674 {
 675         os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
 676         os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
 677         os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
 678
 679         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 680                 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
 681
 682         os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
 683         os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
 684
 685         if (!td_random(td))
 686                 return;
 687
 688         if (td->o.rand_repeatable)
 689                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 690
 691         os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
 692 }
 693
 694 static void td_fill_rand_seeds_internal(struct thread_data *td)
 695 {
 696         init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
 697         init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
 698         init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
 699
 700         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 701                 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
 702
 703         init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
 704         init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
 705
 706         if (!td_random(td))
 707                 return;
 708
 709         if (td->o.rand_repeatable)
 710                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 711
 712         init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
 713 }
 714
 715 void td_fill_rand_seeds(struct thread_data *td)
 716 {
 717         if (td->o.use_os_rand)
 718                 td_fill_rand_seeds_os(td);
 719         else
 720                 td_fill_rand_seeds_internal(td);
 721
 722         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
 723 }
 724
 725
 726 /*
 727  * Initializes the ioengine configured for a job, if it has not been done so
 728  * already.
 729  */
 730 int ioengine_load(struct thread_data *td)
 731 {
 732         const char *engine;
 733
 734         /*
 735          * Engine has already been loaded.
 736          */
 737         if (td->io_ops)
 738                 return 0;
 739
 740         engine = get_engine_name(td->o.ioengine);
 741         td->io_ops = load_ioengine(td, engine);
 742         if (!td->io_ops) {
 743                 log_err("fio: failed to load engine %s\n", engine);
 744                 return 1;
 745         }
 746
 747         if (td->io_ops->option_struct_size && td->io_ops->options) {
 748                 /*
 749                  * In cases where td->eo is set, clone it for a child thread.
 750                  * This requires that the parent thread has the same ioengine,
 751                  * but that requirement must be enforced by the code which
 752                  * cloned the thread.
 753                  */
 754                 void *origeo = td->eo;
 755                 /*
 756                  * Otherwise use the default thread options.
 757                  */
 758                 if (!origeo && td != &def_thread && def_thread.eo &&
 759                     def_thread.io_ops->options == td->io_ops->options)
 760                         origeo = def_thread.eo;
 761
 762                 options_init(td->io_ops->options);
 763                 td->eo = malloc(td->io_ops->option_struct_size);
 764                 /*
 765                  * Use the default thread as an option template if this uses the
 766                  * same options structure and there are non-default options
 767                  * used.
 768                  */
 769                 if (origeo) {
 770                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 771                         options_mem_dupe(td->eo, td->io_ops->options);
 772                 } else {
 773                         memset(td->eo, 0, td->io_ops->option_struct_size);
 774                         fill_default_options(td->eo, td->io_ops->options);
 775                 }
 776                 *(struct thread_data **)td->eo = td;
 777         }
 778
 779         return 0;
 780 }
 781
 782 static void init_flags(struct thread_data *td)
 783 {
 784         struct thread_options *o = &td->o;
 785
 786         if (o->verify_backlog)
 787                 td->flags |= TD_F_VER_BACKLOG;
 788         if (o->trim_backlog)
 789                 td->flags |= TD_F_TRIM_BACKLOG;
 790         if (o->read_iolog_file)
 791                 td->flags |= TD_F_READ_IOLOG;
 792         if (o->refill_buffers)
 793                 td->flags |= TD_F_REFILL_BUFFERS;
 794         if (o->scramble_buffers)
 795                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 796         if (o->verify != VERIFY_NONE)
 797                 td->flags |= TD_F_VER_NONE;
 798 }
 799
 800 /*
 801  * Adds a job to the list of things todo. Sanitizes the various options
 802  * to make sure we don't have conflicts, and initializes various
 803  * members of td.
 804  */
 805 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
 806                    int recursed, int client_type)
 807 {
 808         unsigned int i;
 809         char fname[PATH_MAX];
 810         int numjobs, file_alloced;
 811
 812         /*
 813          * the def_thread is just for options, it's not a real job
 814          */
 815         if (td == &def_thread)
 816                 return 0;
 817
 818         init_flags(td);
 819
 820         /*
 821          * if we are just dumping the output command line, don't add the job
 822          */
 823         if (dump_cmdline) {
 824                 put_job(td);
 825                 return 0;
 826         }
 827
 828         td->client_type = client_type;
 829
 830         if (profile_td_init(td))
 831                 goto err;
 832
 833         if (ioengine_load(td))
 834                 goto err;
 835
 836         if (td->o.odirect)
 837                 td->io_ops->flags |= FIO_RAWIO;
 838
 839         file_alloced = 0;
 840         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
 841                 file_alloced = 1;
 842
 843                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
 844                         add_file(td, jobname);
 845                 else {
 846                         for (i = 0; i < td->o.nr_files; i++) {
 847                                 sprintf(fname, "%s.%d.%d", jobname,
 848                                                         td->thread_number, i);
 849                                 add_file(td, fname);
 850                         }
 851                 }
 852         }
 853
 854         if (fixup_options(td))
 855                 goto err;
 856
 857         flow_init_job(td);
 858
 859         /*
 860          * IO engines only need this for option callbacks, and the address may
 861          * change in subprocesses.
 862          */
 863         if (td->eo)
 864                 *(struct thread_data **)td->eo = NULL;
 865
 866         if (td->io_ops->flags & FIO_DISKLESSIO) {
 867                 struct fio_file *f;
 868
 869                 for_each_file(td, f, i)
 870                         f->real_file_size = -1ULL;
 871         }
 872
 873         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
 874
 875         td->ts.clat_percentiles = td->o.clat_percentiles;
 876         if (td->o.overwrite_plist)
 877                 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
 878         else
 879                 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
 880
 881         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 882                 td->ts.clat_stat[i].min_val = ULONG_MAX;
 883                 td->ts.slat_stat[i].min_val = ULONG_MAX;
 884                 td->ts.lat_stat[i].min_val = ULONG_MAX;
 885                 td->ts.bw_stat[i].min_val = ULONG_MAX;
 886         }
 887         td->ddir_seq_nr = td->o.ddir_seq_nr;
 888
 889         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
 890                 prev_group_jobs = 0;
 891                 groupid++;
 892         }
 893
 894         td->groupid = groupid;
 895         prev_group_jobs++;
 896
 897         if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
 898                 td_verror(td, errno, "init_random_state");
 899                 goto err;
 900         }
 901
 902         if (setup_rate(td))
 903                 goto err;
 904
 905         if (td->o.lat_log_file) {
 906                 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
 907                 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
 908                 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
 909         }
 910         if (td->o.bw_log_file)
 911                 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
 912         if (td->o.iops_log_file)
 913                 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
 914
 915         if (!td->o.name)
 916                 td->o.name = strdup(jobname);
 917
 918         if (output_format == FIO_OUTPUT_NORMAL) {
 919                 if (!job_add_num) {
 920                         if (is_backend && !recursed)
 921                                 fio_server_send_add_job(td);
 922
 923                         if (!(td->io_ops->flags & FIO_NOIO)) {
 924                                 char *c1, *c2, *c3, *c4, *c5, *c6;
 925
 926                                 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
 927                                 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
 928                                 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
 929                                 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
 930                                 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
 931                                 c6 = fio_uint_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, 1, client_type))
 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, int client_type)
 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, 0, client_type);
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, 0, client_type);
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, int type)
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, 0, type);
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",
1290           .help = "Process creation/exit logging",
1291           .shift = FD_PROCESS,
1292         },
1293         { .name = "file",
1294           .help = "File related action logging",
1295           .shift = FD_FILE,
1296         },
1297         { .name = "io",
1298           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1299           .shift = FD_IO,
1300         },
1301         { .name = "mem",
1302           .help = "Memory allocation/freeing logging",
1303           .shift = FD_MEM,
1304         },
1305         { .name = "blktrace",
1306           .help = "blktrace action logging",
1307           .shift = FD_BLKTRACE,
1308         },
1309         { .name = "verify",
1310           .help = "IO verification action logging",
1311           .shift = FD_VERIFY,
1312         },
1313         { .name = "random",
1314           .help = "Random generation logging",
1315           .shift = FD_RANDOM,
1316         },
1317         { .name = "parse",
1318           .help = "Parser logging",
1319           .shift = FD_PARSE,
1320         },
1321         { .name = "diskutil",
1322           .help = "Disk utility logging actions",
1323           .shift = FD_DISKUTIL,
1324         },
1325         { .name = "job",
1326           .help = "Logging related to creating/destroying jobs",
1327           .shift = FD_JOB,
1328         },
1329         { .name = "mutex",
1330           .help = "Mutex logging",
1331           .shift = FD_MUTEX
1332         },
1333         { .name = "profile",
1334           .help = "Logging related to profiles",
1335           .shift = FD_PROFILE,
1336         },
1337         { .name = "time",
1338           .help = "Logging related to time keeping functions",
1339           .shift = FD_TIME,
1340         },
1341         { .name = "net",
1342           .help = "Network logging",
1343           .shift = FD_NET,
1344         },
1345         { .name = NULL, },
1346 };
1347
1348 static int set_debug(const char *string)
1349 {
1350         struct debug_level *dl;
1351         char *p = (char *) string;
1352         char *opt;
1353         int i;
1354
1355         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1356                 log_info("fio: dumping debug options:");
1357                 for (i = 0; debug_levels[i].name; i++) {
1358                         dl = &debug_levels[i];
1359                         log_info("%s,", dl->name);
1360                 }
1361                 log_info("all\n");
1362                 return 1;
1363         }
1364
1365         while ((opt = strsep(&p, ",")) != NULL) {
1366                 int found = 0;
1367
1368                 if (!strncmp(opt, "all", 3)) {
1369                         log_info("fio: set all debug options\n");
1370                         fio_debug = ~0UL;
1371                         continue;
1372                 }
1373
1374                 for (i = 0; debug_levels[i].name; i++) {
1375                         dl = &debug_levels[i];
1376                         found = !strncmp(opt, dl->name, strlen(dl->name));
1377                         if (!found)
1378                                 continue;
1379
1380                         if (dl->shift == FD_JOB) {
1381                                 opt = strchr(opt, ':');
1382                                 if (!opt) {
1383                                         log_err("fio: missing job number\n");
1384                                         break;
1385                                 }
1386                                 opt++;
1387                                 fio_debug_jobno = atoi(opt);
1388                                 log_info("fio: set debug jobno %d\n",
1389                                                         fio_debug_jobno);
1390                         } else {
1391                                 log_info("fio: set debug option %s\n", opt);
1392                                 fio_debug |= (1UL << dl->shift);
1393                         }
1394                         break;
1395                 }
1396
1397                 if (!found)
1398                         log_err("fio: debug mask %s not found\n", opt);
1399         }
1400         return 0;
1401 }
1402 #else
1403 static int set_debug(const char *string)
1404 {
1405         log_err("fio: debug tracing not included in build\n");
1406         return 1;
1407 }
1408 #endif
1409
1410 static void fio_options_fill_optstring(void)
1411 {
1412         char *ostr = cmd_optstr;
1413         int i, c;
1414
1415         c = i = 0;
1416         while (l_opts[i].name) {
1417                 ostr[c++] = l_opts[i].val;
1418                 if (l_opts[i].has_arg == required_argument)
1419                         ostr[c++] = ':';
1420                 else if (l_opts[i].has_arg == optional_argument) {
1421                         ostr[c++] = ':';
1422                         ostr[c++] = ':';
1423                 }
1424                 i++;
1425         }
1426         ostr[c] = '\0';
1427 }
1428
1429 static int client_flag_set(char c)
1430 {
1431         int i;
1432
1433         i = 0;
1434         while (l_opts[i].name) {
1435                 int val = l_opts[i].val;
1436
1437                 if (c == (val & 0xff))
1438                         return (val & FIO_CLIENT_FLAG);
1439
1440                 i++;
1441         }
1442
1443         return 0;
1444 }
1445
1446 void parse_cmd_client(void *client, char *opt)
1447 {
1448         fio_client_add_cmd_option(client, opt);
1449 }
1450
1451 int parse_cmd_line(int argc, char *argv[], int client_type)
1452 {
1453         struct thread_data *td = NULL;
1454         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1455         char *ostr = cmd_optstr;
1456         void *pid_file = NULL;
1457         void *cur_client = NULL;
1458         int backend = 0;
1459
1460         /*
1461          * Reset optind handling, since we may call this multiple times
1462          * for the backend.
1463          */
1464         optind = 1;
1465
1466         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1467                 did_arg = 1;
1468
1469                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1470                         parse_cmd_client(cur_client, argv[optind - 1]);
1471                         c &= ~FIO_CLIENT_FLAG;
1472                 }
1473
1474                 switch (c) {
1475                 case 'a':
1476                         smalloc_pool_size = atoi(optarg);
1477                         break;
1478                 case 't':
1479                         def_timeout = atoi(optarg);
1480                         break;
1481                 case 'l':
1482                         write_lat_log = 1;
1483                         break;
1484                 case 'b':
1485                         write_bw_log = 1;
1486                         break;
1487                 case 'o':
1488                         f_out = fopen(optarg, "w+");
1489                         if (!f_out) {
1490                                 perror("fopen output");
1491                                 exit(1);
1492                         }
1493                         f_err = f_out;
1494                         break;
1495                 case 'm':
1496                         output_format = FIO_OUTPUT_TERSE;
1497                         break;
1498                 case 'F':
1499                         if (!strcmp(optarg, "minimal") ||
1500                             !strcmp(optarg, "terse") ||
1501                             !strcmp(optarg, "csv"))
1502                                 output_format = FIO_OUTPUT_TERSE;
1503                         else if (!strcmp(optarg, "json"))
1504                                 output_format = FIO_OUTPUT_JSON;
1505                         else
1506                                 output_format = FIO_OUTPUT_NORMAL;
1507                         break;
1508                 case 'h':
1509                         if (!cur_client) {
1510                                 usage(argv[0]);
1511                                 do_exit++;
1512                         }
1513                         break;
1514                 case 'c':
1515                         if (!cur_client) {
1516                                 fio_show_option_help(optarg);
1517                                 do_exit++;
1518                         }
1519                         break;
1520                 case 'i':
1521                         if (!cur_client) {
1522                                 fio_show_ioengine_help(optarg);
1523                                 do_exit++;
1524                         }
1525                         break;
1526                 case 's':
1527                         dump_cmdline = 1;
1528                         break;
1529                 case 'r':
1530                         read_only = 1;
1531                         break;
1532                 case 'v':
1533                         if (!cur_client) {
1534                                 log_info("%s\n", fio_version_string);
1535                                 do_exit++;
1536                         }
1537                         break;
1538                 case 'V':
1539                         terse_version = atoi(optarg);
1540                         if (!(terse_version == 2 || terse_version == 3 ||
1541                              terse_version == 4)) {
1542                                 log_err("fio: bad terse version format\n");
1543                                 exit_val = 1;
1544                                 do_exit++;
1545                         }
1546                         break;
1547                 case 'e':
1548                         if (!strcmp("always", optarg))
1549                                 eta_print = FIO_ETA_ALWAYS;
1550                         else if (!strcmp("never", optarg))
1551                                 eta_print = FIO_ETA_NEVER;
1552                         break;
1553                 case 'd':
1554                         if (set_debug(optarg))
1555                                 do_exit++;
1556                         break;
1557                 case 'x': {
1558                         size_t new_size;
1559
1560                         if (!strcmp(optarg, "global")) {
1561                                 log_err("fio: can't use global as only "
1562                                         "section\n");
1563                                 do_exit++;
1564                                 exit_val = 1;
1565                                 break;
1566                         }
1567                         new_size = (nr_job_sections + 1) * sizeof(char *);
1568                         job_sections = realloc(job_sections, new_size);
1569                         job_sections[nr_job_sections] = strdup(optarg);
1570                         nr_job_sections++;
1571                         break;
1572                         }
1573                 case 'p':
1574                         exec_profile = strdup(optarg);
1575                         break;
1576                 case FIO_GETOPT_JOB: {
1577                         const char *opt = l_opts[lidx].name;
1578                         char *val = optarg;
1579
1580                         if (!strncmp(opt, "name", 4) && td) {
1581                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1582                                 if (ret)
1583                                         return 0;
1584                                 td = NULL;
1585                         }
1586                         if (!td) {
1587                                 int is_section = !strncmp(opt, "name", 4);
1588                                 int global = 0;
1589
1590                                 if (!is_section || !strncmp(val, "global", 6))
1591                                         global = 1;
1592
1593                                 if (is_section && skip_this_section(val))
1594                                         continue;
1595
1596                                 td = get_new_job(global, &def_thread, 1);
1597                                 if (!td || ioengine_load(td))
1598                                         return 0;
1599                                 fio_options_set_ioengine_opts(l_opts, td);
1600                         }
1601
1602                         ret = fio_cmd_option_parse(td, opt, val);
1603
1604                         if (!ret && !strcmp(opt, "ioengine")) {
1605                                 free_ioengine(td);
1606                                 if (ioengine_load(td))
1607                                         return 0;
1608                                 fio_options_set_ioengine_opts(l_opts, td);
1609                         }
1610                         break;
1611                 }
1612                 case FIO_GETOPT_IOENGINE: {
1613                         const char *opt = l_opts[lidx].name;
1614                         char *val = optarg;
1615                         opt = l_opts[lidx].name;
1616                         val = optarg;
1617                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1618                         break;
1619                 }
1620                 case 'w':
1621                         warnings_fatal = 1;
1622                         break;
1623                 case 'j':
1624                         max_jobs = atoi(optarg);
1625                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1626                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1627                                 do_exit++;
1628                                 exit_val = 1;
1629                         }
1630                         break;
1631                 case 'S':
1632                         if (nr_clients) {
1633                                 log_err("fio: can't be both client and server\n");
1634                                 do_exit++;
1635                                 exit_val = 1;
1636                                 break;
1637                         }
1638                         if (optarg)
1639                                 fio_server_set_arg(optarg);
1640                         is_backend = 1;
1641                         backend = 1;
1642                         break;
1643                 case 'D':
1644                         pid_file = strdup(optarg);
1645                         break;
1646                 case 'C':
1647                         if (is_backend) {
1648                                 log_err("fio: can't be both client and server\n");
1649                                 do_exit++;
1650                                 exit_val = 1;
1651                                 break;
1652                         }
1653                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1654                                 log_err("fio: failed adding client %s\n", optarg);
1655                                 do_exit++;
1656                                 exit_val = 1;
1657                                 break;
1658                         }
1659                         /*
1660                          * If the next argument exists and isn't an option,
1661                          * assume it's a job file for this client only.
1662                          */
1663                         while (optind < argc) {
1664                                 if (!strncmp(argv[optind], "--", 2) ||
1665                                     !strncmp(argv[optind], "-", 1))
1666                                         break;
1667
1668                                 fio_client_add_ini_file(cur_client, argv[optind]);
1669                                 optind++;
1670                         }
1671                         break;
1672                 case 'T':
1673                         do_exit++;
1674                         exit_val = fio_monotonic_clocktest();
1675                         break;
1676                 default:
1677                         do_exit++;
1678                         exit_val = 1;
1679                         break;
1680                 }
1681                 if (do_exit)
1682                         break;
1683         }
1684
1685         if (do_exit) {
1686                 if (exit_val && !(is_backend || nr_clients))
1687                         exit(exit_val);
1688         }
1689
1690         if (nr_clients && fio_clients_connect()) {
1691                 do_exit++;
1692                 exit_val = 1;
1693                 return -1;
1694         }
1695
1696         if (is_backend && backend)
1697                 return fio_start_server(pid_file);
1698
1699         if (td) {
1700                 if (!ret)
1701                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1702         }
1703
1704         while (!ret && optind < argc) {
1705                 ini_idx++;
1706                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1707                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1708                 optind++;
1709         }
1710
1711         return ini_idx;
1712 }
1713
1714 int fio_init_options(void)
1715 {
1716         f_out = stdout;
1717         f_err = stderr;
1718
1719         fio_options_fill_optstring();
1720         fio_options_dup_and_init(l_opts);
1721
1722         atexit(free_shm);
1723
1724         if (fill_def_thread())
1725                 return 1;
1726
1727         return 0;
1728 }
1729
1730 extern int fio_check_options(struct thread_options *);
1731
1732 int parse_options(int argc, char *argv[])
1733 {
1734         const int type = FIO_CLIENT_TYPE_CLI;
1735         int job_files, i;
1736
1737         if (fio_init_options())
1738                 return 1;
1739         if (fio_test_cconv(&def_thread.o))
1740                 log_err("fio: failed internal cconv test\n");
1741
1742         job_files = parse_cmd_line(argc, argv, type);
1743
1744         if (job_files > 0) {
1745                 for (i = 0; i < job_files; i++) {
1746                         if (fill_def_thread())
1747                                 return 1;
1748                         if (nr_clients) {
1749                                 if (fio_clients_send_ini(ini_file[i]))
1750                                         return 1;
1751                                 free(ini_file[i]);
1752                         } else if (!is_backend) {
1753                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
1754                                         return 1;
1755                                 free(ini_file[i]);
1756                         }
1757                 }
1758         } else if (nr_clients) {
1759                 if (fill_def_thread())
1760                         return 1;
1761                 if (fio_clients_send_ini(NULL))
1762                         return 1;
1763         }
1764
1765         free(ini_file);
1766         fio_options_free(&def_thread);
1767
1768         if (!thread_number) {
1769                 if (dump_cmdline)
1770                         return 0;
1771                 if (exec_profile)
1772                         return 0;
1773                 if (is_backend || nr_clients)
1774                         return 0;
1775                 if (did_arg)
1776                         return 0;
1777
1778                 log_err("No jobs(s) defined\n\n");
1779
1780                 if (!did_arg) {
1781                         usage(argv[0]);
1782                         return 1;
1783                 }
1784
1785                 return 0;
1786         }
1787
1788         if (def_thread.o.gtod_offload) {
1789                 fio_gtod_init();
1790                 fio_gtod_offload = 1;
1791                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1792         }
1793
1794         if (output_format == FIO_OUTPUT_NORMAL)
1795                 log_info("%s\n", fio_version_string);
1796
1797         return 0;
1798 }
1799
1800 void options_default_fill(struct thread_options *o)
1801 {
1802         memcpy(o, &def_thread.o, sizeof(*o));
1803 }