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