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