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