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