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                 o->iodepth_low = o->iodepth;
 508
 509         /*
 510          * If batch number isn't set, default to the same as iodepth
 511          */
 512         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 513                 o->iodepth_batch = o->iodepth;
 514
 515         if (o->nr_files > td->files_index)
 516                 o->nr_files = td->files_index;
 517
 518         if (o->open_files > o->nr_files || !o->open_files)
 519                 o->open_files = o->nr_files;
 520
 521         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
 522             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
 523             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
 524             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
 525                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 526                 ret = 1;
 527         }
 528         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
 529             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
 530             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
 531             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
 532             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
 533             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
 534                 log_err("fio: minimum rate exceeds rate\n");
 535                 ret = 1;
 536         }
 537
 538         if (!o->timeout && o->time_based) {
 539                 log_err("fio: time_based requires a runtime/timeout setting\n");
 540                 o->time_based = 0;
 541                 ret = warnings_fatal;
 542         }
 543
 544         if (o->fill_device && !o->size)
 545                 o->size = -1ULL;
 546
 547         if (o->verify != VERIFY_NONE) {
 548                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
 549                         log_info("Multiple writers may overwrite blocks that "
 550                                 "belong to other jobs. This can cause "
 551                                 "verification failures.\n");
 552                         ret = warnings_fatal;
 553                 }
 554
 555                 o->refill_buffers = 1;
 556                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
 557                     !o->verify_interval)
 558                         o->verify_interval = o->min_bs[DDIR_WRITE];
 559         }
 560
 561         if (o->pre_read) {
 562                 o->invalidate_cache = 0;
 563                 if (td->io_ops->flags & FIO_PIPEIO) {
 564                         log_info("fio: cannot pre-read files with an IO engine"
 565                                  " that isn't seekable. Pre-read disabled.\n");
 566                         ret = warnings_fatal;
 567                 }
 568         }
 569
 570 #ifndef CONFIG_FDATASYNC
 571         if (o->fdatasync_blocks) {
 572                 log_info("fio: this platform does not support fdatasync()"
 573                          " falling back to using fsync().  Use the 'fsync'"
 574                          " option instead of 'fdatasync' to get rid of"
 575                          " this warning\n");
 576                 o->fsync_blocks = o->fdatasync_blocks;
 577                 o->fdatasync_blocks = 0;
 578                 ret = warnings_fatal;
 579         }
 580 #endif
 581
 582 #ifdef WIN32
 583         /*
 584          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
 585          * so fail if we're passed those flags
 586          */
 587         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
 588                 log_err("fio: Windows does not support direct or non-buffered io with"
 589                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
 590                                 " with 'direct=1' and 'iodepth=1' instead.\n");
 591                 ret = 1;
 592         }
 593 #endif
 594
 595         /*
 596          * For fully compressible data, just zero them at init time.
 597          * It's faster than repeatedly filling it.
 598          */
 599         if (td->o.compress_percentage == 100) {
 600                 td->o.zero_buffers = 1;
 601                 td->o.compress_percentage = 0;
 602         }
 603
 604         /*
 605          * Using a non-uniform random distribution excludes usage of
 606          * a random map
 607          */
 608         if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
 609                 td->o.norandommap = 1;
 610
 611         return ret;
 612 }
 613
 614 /*
 615  * This function leaks the buffer
 616  */
 617 char *fio_uint_to_kmg(unsigned int val)
 618 {
 619         char *buf = malloc(32);
 620         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 621         char *p = post;
 622
 623         do {
 624                 if (val & 1023)
 625                         break;
 626
 627                 val >>= 10;
 628                 p++;
 629         } while (*p);
 630
 631         snprintf(buf, 31, "%u%c", val, *p);
 632         return buf;
 633 }
 634
 635 /* External engines are specified by "external:name.o") */
 636 static const char *get_engine_name(const char *str)
 637 {
 638         char *p = strstr(str, ":");
 639
 640         if (!p)
 641                 return str;
 642
 643         p++;
 644         strip_blank_front(&p);
 645         strip_blank_end(p);
 646         return p;
 647 }
 648
 649 static int exists_and_not_file(const char *filename)
 650 {
 651         struct stat sb;
 652
 653         if (lstat(filename, &sb) == -1)
 654                 return 0;
 655
 656         /* \\.\ is the device namespace in Windows, where every file
 657          * is a device node */
 658         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
 659                 return 0;
 660
 661         return 1;
 662 }
 663
 664 static void td_fill_rand_seeds_os(struct thread_data *td)
 665 {
 666         os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
 667         os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
 668         os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
 669
 670         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 671                 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
 672
 673         os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
 674         os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
 675
 676         if (!td_random(td))
 677                 return;
 678
 679         if (td->o.rand_repeatable)
 680                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 681
 682         os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
 683 }
 684
 685 static void td_fill_rand_seeds_internal(struct thread_data *td)
 686 {
 687         init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
 688         init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
 689         init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
 690
 691         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 692                 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
 693
 694         init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
 695         init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
 696
 697         if (!td_random(td))
 698                 return;
 699
 700         if (td->o.rand_repeatable)
 701                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 702
 703         init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
 704 }
 705
 706 void td_fill_rand_seeds(struct thread_data *td)
 707 {
 708         if (td->o.use_os_rand)
 709                 td_fill_rand_seeds_os(td);
 710         else
 711                 td_fill_rand_seeds_internal(td);
 712
 713         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
 714 }
 715
 716 /*
 717  * Initializes the ioengine configured for a job, if it has not been done so
 718  * already.
 719  */
 720 int ioengine_load(struct thread_data *td)
 721 {
 722         const char *engine;
 723
 724         /*
 725          * Engine has already been loaded.
 726          */
 727         if (td->io_ops)
 728                 return 0;
 729
 730         engine = get_engine_name(td->o.ioengine);
 731         td->io_ops = load_ioengine(td, engine);
 732         if (!td->io_ops) {
 733                 log_err("fio: failed to load engine %s\n", engine);
 734                 return 1;
 735         }
 736
 737         if (td->io_ops->option_struct_size && td->io_ops->options) {
 738                 /*
 739                  * In cases where td->eo is set, clone it for a child thread.
 740                  * This requires that the parent thread has the same ioengine,
 741                  * but that requirement must be enforced by the code which
 742                  * cloned the thread.
 743                  */
 744                 void *origeo = td->eo;
 745                 /*
 746                  * Otherwise use the default thread options.
 747                  */
 748                 if (!origeo && td != &def_thread && def_thread.eo &&
 749                     def_thread.io_ops->options == td->io_ops->options)
 750                         origeo = def_thread.eo;
 751
 752                 options_init(td->io_ops->options);
 753                 td->eo = malloc(td->io_ops->option_struct_size);
 754                 /*
 755                  * Use the default thread as an option template if this uses the
 756                  * same options structure and there are non-default options
 757                  * used.
 758                  */
 759                 if (origeo) {
 760                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 761                         options_mem_dupe(td->eo, td->io_ops->options);
 762                 } else {
 763                         memset(td->eo, 0, td->io_ops->option_struct_size);
 764                         fill_default_options(td->eo, td->io_ops->options);
 765                 }
 766                 *(struct thread_data **)td->eo = td;
 767         }
 768
 769         return 0;
 770 }
 771
 772 static void init_flags(struct thread_data *td)
 773 {
 774         struct thread_options *o = &td->o;
 775
 776         if (o->verify_backlog)
 777                 td->flags |= TD_F_VER_BACKLOG;
 778         if (o->trim_backlog)
 779                 td->flags |= TD_F_TRIM_BACKLOG;
 780         if (o->read_iolog_file)
 781                 td->flags |= TD_F_READ_IOLOG;
 782         if (o->refill_buffers)
 783                 td->flags |= TD_F_REFILL_BUFFERS;
 784         if (o->scramble_buffers)
 785                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 786         if (o->verify != VERIFY_NONE)
 787                 td->flags |= TD_F_VER_NONE;
 788 }
 789
 790 static int setup_random_seeds(struct thread_data *td)
 791 {
 792         unsigned long seed;
 793         unsigned int i;
 794
 795         if (!td->o.rand_repeatable)
 796                 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
 797
 798         for (seed = 0x89, i = 0; i < 4; i++)
 799                 seed *= 0x9e370001UL;
 800
 801         for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
 802                 td->rand_seeds[i] = seed;
 803                 seed *= 0x9e370001UL;
 804         }
 805
 806         td_fill_rand_seeds(td);
 807         return 0;
 808 }
 809
 810 /*
 811  * Adds a job to the list of things todo. Sanitizes the various options
 812  * to make sure we don't have conflicts, and initializes various
 813  * members of td.
 814  */
 815 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
 816                    int recursed, int client_type)
 817 {
 818         unsigned int i;
 819         char fname[PATH_MAX];
 820         int numjobs, file_alloced;
 821
 822         /*
 823          * the def_thread is just for options, it's not a real job
 824          */
 825         if (td == &def_thread)
 826                 return 0;
 827
 828         init_flags(td);
 829
 830         /*
 831          * if we are just dumping the output command line, don't add the job
 832          */
 833         if (dump_cmdline) {
 834                 put_job(td);
 835                 return 0;
 836         }
 837
 838         td->client_type = client_type;
 839
 840         if (profile_td_init(td))
 841                 goto err;
 842
 843         if (ioengine_load(td))
 844                 goto err;
 845
 846         if (td->o.odirect)
 847                 td->io_ops->flags |= FIO_RAWIO;
 848
 849         file_alloced = 0;
 850         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
 851                 file_alloced = 1;
 852
 853                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
 854                         add_file(td, jobname);
 855                 else {
 856                         for (i = 0; i < td->o.nr_files; i++) {
 857                                 sprintf(fname, "%s.%d.%d", jobname,
 858                                                         td->thread_number, i);
 859                                 add_file(td, fname);
 860                         }
 861                 }
 862         }
 863
 864         if (fixup_options(td))
 865                 goto err;
 866
 867         flow_init_job(td);
 868
 869         /*
 870          * IO engines only need this for option callbacks, and the address may
 871          * change in subprocesses.
 872          */
 873         if (td->eo)
 874                 *(struct thread_data **)td->eo = NULL;
 875
 876         if (td->io_ops->flags & FIO_DISKLESSIO) {
 877                 struct fio_file *f;
 878
 879                 for_each_file(td, f, i)
 880                         f->real_file_size = -1ULL;
 881         }
 882
 883         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
 884
 885         td->ts.clat_percentiles = td->o.clat_percentiles;
 886         if (td->o.overwrite_plist)
 887                 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
 888         else
 889                 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
 890
 891         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 892                 td->ts.clat_stat[i].min_val = ULONG_MAX;
 893                 td->ts.slat_stat[i].min_val = ULONG_MAX;
 894                 td->ts.lat_stat[i].min_val = ULONG_MAX;
 895                 td->ts.bw_stat[i].min_val = ULONG_MAX;
 896         }
 897         td->ddir_seq_nr = td->o.ddir_seq_nr;
 898
 899         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
 900                 prev_group_jobs = 0;
 901                 groupid++;
 902         }
 903
 904         td->groupid = groupid;
 905         prev_group_jobs++;
 906
 907         if (setup_random_seeds(td)) {
 908                 td_verror(td, errno, "init_random_state");
 909                 goto err;
 910         }
 911
 912         if (setup_rate(td))
 913                 goto err;
 914
 915         if (td->o.lat_log_file) {
 916                 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
 917                 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
 918                 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
 919         }
 920         if (td->o.bw_log_file)
 921                 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
 922         if (td->o.iops_log_file)
 923                 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
 924
 925         if (!td->o.name)
 926                 td->o.name = strdup(jobname);
 927
 928         if (output_format == FIO_OUTPUT_NORMAL) {
 929                 if (!job_add_num) {
 930                         if (is_backend && !recursed)
 931                                 fio_server_send_add_job(td);
 932
 933                         if (!(td->io_ops->flags & FIO_NOIO)) {
 934                                 char *c1, *c2, *c3, *c4, *c5, *c6;
 935
 936                                 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
 937                                 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
 938                                 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
 939                                 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
 940                                 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
 941                                 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
 942
 943                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
 944                                          " ioengine=%s, iodepth=%u\n",
 945                                                 td->o.name, td->groupid,
 946                                                 ddir_str(td->o.td_ddir),
 947                                                 c1, c2, c3, c4, c5, c6,
 948                                                 td->io_ops->name,
 949                                                 td->o.iodepth);
 950
 951                                 free(c1);
 952                                 free(c2);
 953                                 free(c3);
 954                                 free(c4);
 955                                 free(c5);
 956                                 free(c6);
 957                         }
 958                 } else if (job_add_num == 1)
 959                         log_info("...\n");
 960         }
 961
 962         /*
 963          * recurse add identical jobs, clear numjobs and stonewall options
 964          * as they don't apply to sub-jobs
 965          */
 966         numjobs = td->o.numjobs;
 967         while (--numjobs) {
 968                 struct thread_data *td_new = get_new_job(0, td, 1);
 969
 970                 if (!td_new)
 971                         goto err;
 972
 973                 td_new->o.numjobs = 1;
 974                 td_new->o.stonewall = 0;
 975                 td_new->o.new_group = 0;
 976
 977                 if (file_alloced) {
 978                         td_new->o.filename = NULL;
 979                         td_new->files_index = 0;
 980                         td_new->files_size = 0;
 981                         td_new->files = NULL;
 982                 }
 983
 984                 job_add_num = numjobs - 1;
 985
 986                 if (add_job(td_new, jobname, job_add_num, 1, client_type))
 987                         goto err;
 988         }
 989
 990         return 0;
 991 err:
 992         put_job(td);
 993         return -1;
 994 }
 995
 996 /*
 997  * Parse as if 'o' was a command line
 998  */
 999 void add_job_opts(const char **o, int client_type)
1000 {
1001         struct thread_data *td, *td_parent;
1002         int i, in_global = 1;
1003         char jobname[32];
1004
1005         i = 0;
1006         td_parent = td = NULL;
1007         while (o[i]) {
1008                 if (!strncmp(o[i], "name", 4)) {
1009                         in_global = 0;
1010                         if (td)
1011                                 add_job(td, jobname, 0, 0, client_type);
1012                         td = NULL;
1013                         sprintf(jobname, "%s", o[i] + 5);
1014                 }
1015                 if (in_global && !td_parent)
1016                         td_parent = get_new_job(1, &def_thread, 0);
1017                 else if (!in_global && !td) {
1018                         if (!td_parent)
1019                                 td_parent = &def_thread;
1020                         td = get_new_job(0, td_parent, 0);
1021                 }
1022                 if (in_global)
1023                         fio_options_parse(td_parent, (char **) &o[i], 1);
1024                 else
1025                         fio_options_parse(td, (char **) &o[i], 1);
1026                 i++;
1027         }
1028
1029         if (td)
1030                 add_job(td, jobname, 0, 0, client_type);
1031 }
1032
1033 static int skip_this_section(const char *name)
1034 {
1035         int i;
1036
1037         if (!nr_job_sections)
1038                 return 0;
1039         if (!strncmp(name, "global", 6))
1040                 return 0;
1041
1042         for (i = 0; i < nr_job_sections; i++)
1043                 if (!strcmp(job_sections[i], name))
1044                         return 0;
1045
1046         return 1;
1047 }
1048
1049 static int is_empty_or_comment(char *line)
1050 {
1051         unsigned int i;
1052
1053         for (i = 0; i < strlen(line); i++) {
1054                 if (line[i] == ';')
1055                         return 1;
1056                 if (line[i] == '#')
1057                         return 1;
1058                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1059                         return 0;
1060         }
1061
1062         return 1;
1063 }
1064
1065 /*
1066  * This is our [ini] type file parser.
1067  */
1068 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1069 {
1070         unsigned int global;
1071         struct thread_data *td;
1072         char *string, *name;
1073         FILE *f;
1074         char *p;
1075         int ret = 0, stonewall;
1076         int first_sect = 1;
1077         int skip_fgets = 0;
1078         int inside_skip = 0;
1079         char **opts;
1080         int i, alloc_opts, num_opts;
1081
1082         if (is_buf)
1083                 f = NULL;
1084         else {
1085                 if (!strcmp(file, "-"))
1086                         f = stdin;
1087                 else
1088                         f = fopen(file, "r");
1089
1090                 if (!f) {
1091                         perror("fopen job file");
1092                         return 1;
1093                 }
1094         }
1095
1096         string = malloc(4096);
1097
1098         /*
1099          * it's really 256 + small bit, 280 should suffice
1100          */
1101         name = malloc(280);
1102         memset(name, 0, 280);
1103
1104         alloc_opts = 8;
1105         opts = malloc(sizeof(char *) * alloc_opts);
1106         num_opts = 0;
1107
1108         stonewall = stonewall_flag;
1109         do {
1110                 /*
1111                  * if skip_fgets is set, we already have loaded a line we
1112                  * haven't handled.
1113                  */
1114                 if (!skip_fgets) {
1115                         if (is_buf)
1116                                 p = strsep(&file, "\n");
1117                         else
1118                                 p = fgets(string, 4096, f);
1119                         if (!p)
1120                                 break;
1121                 }
1122
1123                 skip_fgets = 0;
1124                 strip_blank_front(&p);
1125                 strip_blank_end(p);
1126
1127                 if (is_empty_or_comment(p))
1128                         continue;
1129                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1130                         if (inside_skip)
1131                                 continue;
1132                         log_err("fio: option <%s> outside of [] job section\n",
1133                                                                         p);
1134                         break;
1135                 }
1136
1137                 name[strlen(name) - 1] = '\0';
1138
1139                 if (skip_this_section(name)) {
1140                         inside_skip = 1;
1141                         continue;
1142                 } else
1143                         inside_skip = 0;
1144
1145                 global = !strncmp(name, "global", 6);
1146
1147                 if (dump_cmdline) {
1148                         if (first_sect)
1149                                 log_info("fio ");
1150                         if (!global)
1151                                 log_info("--name=%s ", name);
1152                         first_sect = 0;
1153                 }
1154
1155                 td = get_new_job(global, &def_thread, 0);
1156                 if (!td) {
1157                         ret = 1;
1158                         break;
1159                 }
1160
1161                 /*
1162                  * Seperate multiple job files by a stonewall
1163                  */
1164                 if (!global && stonewall) {
1165                         td->o.stonewall = stonewall;
1166                         stonewall = 0;
1167                 }
1168
1169                 num_opts = 0;
1170                 memset(opts, 0, alloc_opts * sizeof(char *));
1171
1172                 while (1) {
1173                         if (is_buf)
1174                                 p = strsep(&file, "\n");
1175                         else
1176                                 p = fgets(string, 4096, f);
1177                         if (!p)
1178                                 break;
1179
1180                         if (is_empty_or_comment(p))
1181                                 continue;
1182
1183                         strip_blank_front(&p);
1184
1185                         /*
1186                          * new section, break out and make sure we don't
1187                          * fgets() a new line at the top.
1188                          */
1189                         if (p[0] == '[') {
1190                                 skip_fgets = 1;
1191                                 break;
1192                         }
1193
1194                         strip_blank_end(p);
1195
1196                         if (num_opts == alloc_opts) {
1197                                 alloc_opts <<= 1;
1198                                 opts = realloc(opts,
1199                                                 alloc_opts * sizeof(char *));
1200                         }
1201
1202                         opts[num_opts] = strdup(p);
1203                         num_opts++;
1204                 }
1205
1206                 ret = fio_options_parse(td, opts, num_opts);
1207                 if (!ret) {
1208                         if (dump_cmdline)
1209                                 for (i = 0; i < num_opts; i++)
1210                                         log_info("--%s ", opts[i]);
1211
1212                         ret = add_job(td, name, 0, 0, type);
1213                 } else {
1214                         log_err("fio: job %s dropped\n", name);
1215                         put_job(td);
1216                 }
1217
1218                 for (i = 0; i < num_opts; i++)
1219                         free(opts[i]);
1220                 num_opts = 0;
1221         } while (!ret);
1222
1223         if (dump_cmdline)
1224                 log_info("\n");
1225
1226         i = 0;
1227         while (i < nr_job_sections) {
1228                 free(job_sections[i]);
1229                 i++;
1230         }
1231
1232         for (i = 0; i < num_opts; i++)
1233                 free(opts[i]);
1234
1235         free(string);
1236         free(name);
1237         free(opts);
1238         if (!is_buf && f != stdin)
1239                 fclose(f);
1240         return ret;
1241 }
1242
1243 static int fill_def_thread(void)
1244 {
1245         memset(&def_thread, 0, sizeof(def_thread));
1246
1247         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1248         def_thread.o.timeout = def_timeout;
1249         def_thread.o.error_dump = 1;
1250         /*
1251          * fill default options
1252          */
1253         fio_fill_default_options(&def_thread);
1254         return 0;
1255 }
1256
1257 static void usage(const char *name)
1258 {
1259         printf("%s\n", fio_version_string);
1260         printf("%s [options] [job options] <job file(s)>\n", name);
1261         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1262                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1263                 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1264         printf("  --output\t\tWrite output to file\n");
1265         printf("  --runtime\t\tRuntime in seconds\n");
1266         printf("  --latency-log\t\tGenerate per-job latency logs\n");
1267         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1268         printf("  --minimal\t\tMinimal (terse) output\n");
1269         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1270         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1271         printf("  --version\t\tPrint version info and exit\n");
1272         printf("  --help\t\tPrint this page\n");
1273         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
1274         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1275                 " them\n");
1276         printf("  --enghelp=engine\tPrint ioengine help, or list"
1277                 " available ioengines\n");
1278         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1279                 " cmd\n");
1280         printf("  --showcmd\t\tTurn a job file into command line options\n");
1281         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1282         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1283         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1284                 " writes\n");
1285         printf("  --section=name\tOnly run specified section in job file\n");
1286         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1287                 " (def 1024)\n");
1288         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1289         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1290         printf("  --server=args\t\tStart a backend fio server\n");
1291         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1292         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1293         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1294         printf("\n                   Jens Axboe <jaxboe@fusionio.com>\n");
1295 }
1296
1297 #ifdef FIO_INC_DEBUG
1298 struct debug_level debug_levels[] = {
1299         { .name = "process",
1300           .help = "Process creation/exit logging",
1301           .shift = FD_PROCESS,
1302         },
1303         { .name = "file",
1304           .help = "File related action logging",
1305           .shift = FD_FILE,
1306         },
1307         { .name = "io",
1308           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1309           .shift = FD_IO,
1310         },
1311         { .name = "mem",
1312           .help = "Memory allocation/freeing logging",
1313           .shift = FD_MEM,
1314         },
1315         { .name = "blktrace",
1316           .help = "blktrace action logging",
1317           .shift = FD_BLKTRACE,
1318         },
1319         { .name = "verify",
1320           .help = "IO verification action logging",
1321           .shift = FD_VERIFY,
1322         },
1323         { .name = "random",
1324           .help = "Random generation logging",
1325           .shift = FD_RANDOM,
1326         },
1327         { .name = "parse",
1328           .help = "Parser logging",
1329           .shift = FD_PARSE,
1330         },
1331         { .name = "diskutil",
1332           .help = "Disk utility logging actions",
1333           .shift = FD_DISKUTIL,
1334         },
1335         { .name = "job",
1336           .help = "Logging related to creating/destroying jobs",
1337           .shift = FD_JOB,
1338         },
1339         { .name = "mutex",
1340           .help = "Mutex logging",
1341           .shift = FD_MUTEX
1342         },
1343         { .name = "profile",
1344           .help = "Logging related to profiles",
1345           .shift = FD_PROFILE,
1346         },
1347         { .name = "time",
1348           .help = "Logging related to time keeping functions",
1349           .shift = FD_TIME,
1350         },
1351         { .name = "net",
1352           .help = "Network logging",
1353           .shift = FD_NET,
1354         },
1355         { .name = NULL, },
1356 };
1357
1358 static int set_debug(const char *string)
1359 {
1360         struct debug_level *dl;
1361         char *p = (char *) string;
1362         char *opt;
1363         int i;
1364
1365         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1366                 log_info("fio: dumping debug options:");
1367                 for (i = 0; debug_levels[i].name; i++) {
1368                         dl = &debug_levels[i];
1369                         log_info("%s,", dl->name);
1370                 }
1371                 log_info("all\n");
1372                 return 1;
1373         }
1374
1375         while ((opt = strsep(&p, ",")) != NULL) {
1376                 int found = 0;
1377
1378                 if (!strncmp(opt, "all", 3)) {
1379                         log_info("fio: set all debug options\n");
1380                         fio_debug = ~0UL;
1381                         continue;
1382                 }
1383
1384                 for (i = 0; debug_levels[i].name; i++) {
1385                         dl = &debug_levels[i];
1386                         found = !strncmp(opt, dl->name, strlen(dl->name));
1387                         if (!found)
1388                                 continue;
1389
1390                         if (dl->shift == FD_JOB) {
1391                                 opt = strchr(opt, ':');
1392                                 if (!opt) {
1393                                         log_err("fio: missing job number\n");
1394                                         break;
1395                                 }
1396                                 opt++;
1397                                 fio_debug_jobno = atoi(opt);
1398                                 log_info("fio: set debug jobno %d\n",
1399                                                         fio_debug_jobno);
1400                         } else {
1401                                 log_info("fio: set debug option %s\n", opt);
1402                                 fio_debug |= (1UL << dl->shift);
1403                         }
1404                         break;
1405                 }
1406
1407                 if (!found)
1408                         log_err("fio: debug mask %s not found\n", opt);
1409         }
1410         return 0;
1411 }
1412 #else
1413 static int set_debug(const char *string)
1414 {
1415         log_err("fio: debug tracing not included in build\n");
1416         return 1;
1417 }
1418 #endif
1419
1420 static void fio_options_fill_optstring(void)
1421 {
1422         char *ostr = cmd_optstr;
1423         int i, c;
1424
1425         c = i = 0;
1426         while (l_opts[i].name) {
1427                 ostr[c++] = l_opts[i].val;
1428                 if (l_opts[i].has_arg == required_argument)
1429                         ostr[c++] = ':';
1430                 else if (l_opts[i].has_arg == optional_argument) {
1431                         ostr[c++] = ':';
1432                         ostr[c++] = ':';
1433                 }
1434                 i++;
1435         }
1436         ostr[c] = '\0';
1437 }
1438
1439 static int client_flag_set(char c)
1440 {
1441         int i;
1442
1443         i = 0;
1444         while (l_opts[i].name) {
1445                 int val = l_opts[i].val;
1446
1447                 if (c == (val & 0xff))
1448                         return (val & FIO_CLIENT_FLAG);
1449
1450                 i++;
1451         }
1452
1453         return 0;
1454 }
1455
1456 void parse_cmd_client(void *client, char *opt)
1457 {
1458         fio_client_add_cmd_option(client, opt);
1459 }
1460
1461 int parse_cmd_line(int argc, char *argv[], int client_type)
1462 {
1463         struct thread_data *td = NULL;
1464         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1465         char *ostr = cmd_optstr;
1466         void *pid_file = NULL;
1467         void *cur_client = NULL;
1468         int backend = 0;
1469
1470         /*
1471          * Reset optind handling, since we may call this multiple times
1472          * for the backend.
1473          */
1474         optind = 1;
1475
1476         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1477                 did_arg = 1;
1478
1479                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1480                         parse_cmd_client(cur_client, argv[optind - 1]);
1481                         c &= ~FIO_CLIENT_FLAG;
1482                 }
1483
1484                 switch (c) {
1485                 case 'a':
1486                         smalloc_pool_size = atoi(optarg);
1487                         break;
1488                 case 't':
1489                         def_timeout = atoi(optarg);
1490                         break;
1491                 case 'l':
1492                         write_lat_log = 1;
1493                         break;
1494                 case 'b':
1495                         write_bw_log = 1;
1496                         break;
1497                 case 'o':
1498                         f_out = fopen(optarg, "w+");
1499                         if (!f_out) {
1500                                 perror("fopen output");
1501                                 exit(1);
1502                         }
1503                         f_err = f_out;
1504                         break;
1505                 case 'm':
1506                         output_format = FIO_OUTPUT_TERSE;
1507                         break;
1508                 case 'F':
1509                         if (!strcmp(optarg, "minimal") ||
1510                             !strcmp(optarg, "terse") ||
1511                             !strcmp(optarg, "csv"))
1512                                 output_format = FIO_OUTPUT_TERSE;
1513                         else if (!strcmp(optarg, "json"))
1514                                 output_format = FIO_OUTPUT_JSON;
1515                         else
1516                                 output_format = FIO_OUTPUT_NORMAL;
1517                         break;
1518                 case 'h':
1519                         if (!cur_client) {
1520                                 usage(argv[0]);
1521                                 do_exit++;
1522                         }
1523                         break;
1524                 case 'c':
1525                         if (!cur_client) {
1526                                 fio_show_option_help(optarg);
1527                                 do_exit++;
1528                         }
1529                         break;
1530                 case 'i':
1531                         if (!cur_client) {
1532                                 fio_show_ioengine_help(optarg);
1533                                 do_exit++;
1534                         }
1535                         break;
1536                 case 's':
1537                         dump_cmdline = 1;
1538                         break;
1539                 case 'r':
1540                         read_only = 1;
1541                         break;
1542                 case 'v':
1543                         if (!cur_client) {
1544                                 log_info("%s\n", fio_version_string);
1545                                 do_exit++;
1546                         }
1547                         break;
1548                 case 'V':
1549                         terse_version = atoi(optarg);
1550                         if (!(terse_version == 2 || terse_version == 3 ||
1551                              terse_version == 4)) {
1552                                 log_err("fio: bad terse version format\n");
1553                                 exit_val = 1;
1554                                 do_exit++;
1555                         }
1556                         break;
1557                 case 'e':
1558                         if (!strcmp("always", optarg))
1559                                 eta_print = FIO_ETA_ALWAYS;
1560                         else if (!strcmp("never", optarg))
1561                                 eta_print = FIO_ETA_NEVER;
1562                         break;
1563                 case 'd':
1564                         if (set_debug(optarg))
1565                                 do_exit++;
1566                         break;
1567                 case 'x': {
1568                         size_t new_size;
1569
1570                         if (!strcmp(optarg, "global")) {
1571                                 log_err("fio: can't use global as only "
1572                                         "section\n");
1573                                 do_exit++;
1574                                 exit_val = 1;
1575                                 break;
1576                         }
1577                         new_size = (nr_job_sections + 1) * sizeof(char *);
1578                         job_sections = realloc(job_sections, new_size);
1579                         job_sections[nr_job_sections] = strdup(optarg);
1580                         nr_job_sections++;
1581                         break;
1582                         }
1583                 case 'p':
1584                         exec_profile = strdup(optarg);
1585                         break;
1586                 case FIO_GETOPT_JOB: {
1587                         const char *opt = l_opts[lidx].name;
1588                         char *val = optarg;
1589
1590                         if (!strncmp(opt, "name", 4) && td) {
1591                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1592                                 if (ret)
1593                                         return 0;
1594                                 td = NULL;
1595                         }
1596                         if (!td) {
1597                                 int is_section = !strncmp(opt, "name", 4);
1598                                 int global = 0;
1599
1600                                 if (!is_section || !strncmp(val, "global", 6))
1601                                         global = 1;
1602
1603                                 if (is_section && skip_this_section(val))
1604                                         continue;
1605
1606                                 td = get_new_job(global, &def_thread, 1);
1607                                 if (!td || ioengine_load(td))
1608                                         return 0;
1609                                 fio_options_set_ioengine_opts(l_opts, td);
1610                         }
1611
1612                         ret = fio_cmd_option_parse(td, opt, val);
1613
1614                         if (!ret && !strcmp(opt, "ioengine")) {
1615                                 free_ioengine(td);
1616                                 if (ioengine_load(td))
1617                                         return 0;
1618                                 fio_options_set_ioengine_opts(l_opts, td);
1619                         }
1620                         break;
1621                 }
1622                 case FIO_GETOPT_IOENGINE: {
1623                         const char *opt = l_opts[lidx].name;
1624                         char *val = optarg;
1625                         opt = l_opts[lidx].name;
1626                         val = optarg;
1627                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1628                         break;
1629                 }
1630                 case 'w':
1631                         warnings_fatal = 1;
1632                         break;
1633                 case 'j':
1634                         max_jobs = atoi(optarg);
1635                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1636                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1637                                 do_exit++;
1638                                 exit_val = 1;
1639                         }
1640                         break;
1641                 case 'S':
1642                         if (nr_clients) {
1643                                 log_err("fio: can't be both client and server\n");
1644                                 do_exit++;
1645                                 exit_val = 1;
1646                                 break;
1647                         }
1648                         if (optarg)
1649                                 fio_server_set_arg(optarg);
1650                         is_backend = 1;
1651                         backend = 1;
1652                         break;
1653                 case 'D':
1654                         pid_file = strdup(optarg);
1655                         break;
1656                 case 'C':
1657                         if (is_backend) {
1658                                 log_err("fio: can't be both client and server\n");
1659                                 do_exit++;
1660                                 exit_val = 1;
1661                                 break;
1662                         }
1663                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1664                                 log_err("fio: failed adding client %s\n", optarg);
1665                                 do_exit++;
1666                                 exit_val = 1;
1667                                 break;
1668                         }
1669                         /*
1670                          * If the next argument exists and isn't an option,
1671                          * assume it's a job file for this client only.
1672                          */
1673                         while (optind < argc) {
1674                                 if (!strncmp(argv[optind], "--", 2) ||
1675                                     !strncmp(argv[optind], "-", 1))
1676                                         break;
1677
1678                                 fio_client_add_ini_file(cur_client, argv[optind]);
1679                                 optind++;
1680                         }
1681                         break;
1682                 case 'T':
1683                         do_exit++;
1684                         exit_val = fio_monotonic_clocktest();
1685                         break;
1686                 case '?':
1687                         log_err("%s: unrecognized option '%s'\n", argv[0],
1688                                                         argv[optind - 1]);
1689                 default:
1690                         do_exit++;
1691                         exit_val = 1;
1692                         break;
1693                 }
1694                 if (do_exit)
1695                         break;
1696         }
1697
1698         if (do_exit) {
1699                 if (exit_val && !(is_backend || nr_clients))
1700                         exit(exit_val);
1701         }
1702
1703         if (nr_clients && fio_clients_connect()) {
1704                 do_exit++;
1705                 exit_val = 1;
1706                 return -1;
1707         }
1708
1709         if (is_backend && backend)
1710                 return fio_start_server(pid_file);
1711
1712         if (td) {
1713                 if (!ret)
1714                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1715         }
1716
1717         while (!ret && optind < argc) {
1718                 ini_idx++;
1719                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1720                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1721                 optind++;
1722         }
1723
1724         return ini_idx;
1725 }
1726
1727 int fio_init_options(void)
1728 {
1729         f_out = stdout;
1730         f_err = stderr;
1731
1732         fio_options_fill_optstring();
1733         fio_options_dup_and_init(l_opts);
1734
1735         atexit(free_shm);
1736
1737         if (fill_def_thread())
1738                 return 1;
1739
1740         return 0;
1741 }
1742
1743 extern int fio_check_options(struct thread_options *);
1744
1745 int parse_options(int argc, char *argv[])
1746 {
1747         const int type = FIO_CLIENT_TYPE_CLI;
1748         int job_files, i;
1749
1750         if (fio_init_options())
1751                 return 1;
1752         if (fio_test_cconv(&def_thread.o))
1753                 log_err("fio: failed internal cconv test\n");
1754
1755         job_files = parse_cmd_line(argc, argv, type);
1756
1757         if (job_files > 0) {
1758                 for (i = 0; i < job_files; i++) {
1759                         if (fill_def_thread())
1760                                 return 1;
1761                         if (nr_clients) {
1762                                 if (fio_clients_send_ini(ini_file[i]))
1763                                         return 1;
1764                                 free(ini_file[i]);
1765                         } else if (!is_backend) {
1766                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
1767                                         return 1;
1768                                 free(ini_file[i]);
1769                         }
1770                 }
1771         } else if (nr_clients) {
1772                 if (fill_def_thread())
1773                         return 1;
1774                 if (fio_clients_send_ini(NULL))
1775                         return 1;
1776         }
1777
1778         free(ini_file);
1779         fio_options_free(&def_thread);
1780
1781         if (!thread_number) {
1782                 if (dump_cmdline)
1783                         return 0;
1784                 if (exec_profile)
1785                         return 0;
1786                 if (is_backend || nr_clients)
1787                         return 0;
1788                 if (did_arg)
1789                         return 0;
1790
1791                 log_err("No jobs(s) defined\n\n");
1792
1793                 if (!did_arg) {
1794                         usage(argv[0]);
1795                         return 1;
1796                 }
1797
1798                 return 0;
1799         }
1800
1801         if (def_thread.o.gtod_offload) {
1802                 fio_gtod_init();
1803                 fio_gtod_offload = 1;
1804                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1805         }
1806
1807         if (output_format == FIO_OUTPUT_NORMAL)
1808                 log_info("%s\n", fio_version_string);
1809
1810         return 0;
1811 }
1812
1813 void options_default_fill(struct thread_options *o)
1814 {
1815         memcpy(o, &def_thread.o, sizeof(*o));
1816 }