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