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