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