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.allrand_repeatable) {
 755                 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
 756                         td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
 757                                 + i;
 758         }
 759
 760         if (td->o.use_os_rand)
 761                 td_fill_rand_seeds_os(td);
 762         else
 763                 td_fill_rand_seeds_internal(td);
 764
 765         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
 766 }
 767
 768 /*
 769  * Initializes the ioengine configured for a job, if it has not been done so
 770  * already.
 771  */
 772 int ioengine_load(struct thread_data *td)
 773 {
 774         const char *engine;
 775
 776         /*
 777          * Engine has already been loaded.
 778          */
 779         if (td->io_ops)
 780                 return 0;
 781         if (!td->o.ioengine) {
 782                 log_err("fio: internal fault, no IO engine specified\n");
 783                 return 1;
 784         }
 785
 786         engine = get_engine_name(td->o.ioengine);
 787         td->io_ops = load_ioengine(td, engine);
 788         if (!td->io_ops) {
 789                 log_err("fio: failed to load engine %s\n", engine);
 790                 return 1;
 791         }
 792
 793         if (td->io_ops->option_struct_size && td->io_ops->options) {
 794                 /*
 795                  * In cases where td->eo is set, clone it for a child thread.
 796                  * This requires that the parent thread has the same ioengine,
 797                  * but that requirement must be enforced by the code which
 798                  * cloned the thread.
 799                  */
 800                 void *origeo = td->eo;
 801                 /*
 802                  * Otherwise use the default thread options.
 803                  */
 804                 if (!origeo && td != &def_thread && def_thread.eo &&
 805                     def_thread.io_ops->options == td->io_ops->options)
 806                         origeo = def_thread.eo;
 807
 808                 options_init(td->io_ops->options);
 809                 td->eo = malloc(td->io_ops->option_struct_size);
 810                 /*
 811                  * Use the default thread as an option template if this uses the
 812                  * same options structure and there are non-default options
 813                  * used.
 814                  */
 815                 if (origeo) {
 816                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 817                         options_mem_dupe(td->eo, td->io_ops->options);
 818                 } else {
 819                         memset(td->eo, 0, td->io_ops->option_struct_size);
 820                         fill_default_options(td->eo, td->io_ops->options);
 821                 }
 822                 *(struct thread_data **)td->eo = td;
 823         }
 824
 825         return 0;
 826 }
 827
 828 static void init_flags(struct thread_data *td)
 829 {
 830         struct thread_options *o = &td->o;
 831
 832         if (o->verify_backlog)
 833                 td->flags |= TD_F_VER_BACKLOG;
 834         if (o->trim_backlog)
 835                 td->flags |= TD_F_TRIM_BACKLOG;
 836         if (o->read_iolog_file)
 837                 td->flags |= TD_F_READ_IOLOG;
 838         if (o->refill_buffers)
 839                 td->flags |= TD_F_REFILL_BUFFERS;
 840         if (o->scramble_buffers)
 841                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 842         if (o->verify != VERIFY_NONE)
 843                 td->flags |= TD_F_VER_NONE;
 844 }
 845
 846 static int setup_random_seeds(struct thread_data *td)
 847 {
 848         unsigned long seed;
 849         unsigned int i;
 850
 851         if (!td->o.rand_repeatable && !td->o.rand_seed)
 852                 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
 853
 854         if (!td->o.rand_seed)
 855                 seed = 0x89;
 856         else
 857                 seed = td->o.rand_seed;
 858
 859         for (i = 0; i < 4; i++)
 860                 seed *= 0x9e370001UL;
 861
 862         for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
 863                 td->rand_seeds[i] = seed;
 864                 seed *= 0x9e370001UL;
 865         }
 866
 867         td_fill_rand_seeds(td);
 868         return 0;
 869 }
 870
 871 enum {
 872         FPRE_NONE = 0,
 873         FPRE_JOBNAME,
 874         FPRE_JOBNUM,
 875         FPRE_FILENUM
 876 };
 877
 878 static struct fpre_keyword {
 879         const char *keyword;
 880         size_t strlen;
 881         int key;
 882 } fpre_keywords[] = {
 883         { .keyword = "$jobname",        .key = FPRE_JOBNAME, },
 884         { .keyword = "$jobnum",         .key = FPRE_JOBNUM, },
 885         { .keyword = "$filenum",        .key = FPRE_FILENUM, },
 886         { .keyword = NULL, },
 887         };
 888
 889 static char *make_filename(char *buf, struct thread_options *o,
 890                            const char *jobname, int jobnum, int filenum)
 891 {
 892         struct fpre_keyword *f;
 893         char copy[PATH_MAX];
 894
 895         if (!o->filename_format || !strlen(o->filename_format)) {
 896                 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
 897                 return NULL;
 898         }
 899
 900         for (f = &fpre_keywords[0]; f->keyword; f++)
 901                 f->strlen = strlen(f->keyword);
 902
 903         strcpy(buf, o->filename_format);
 904         memset(copy, 0, sizeof(copy));
 905         for (f = &fpre_keywords[0]; f->keyword; f++) {
 906                 do {
 907                         size_t pre_len, post_start = 0;
 908                         char *str, *dst = copy;
 909
 910                         str = strcasestr(buf, f->keyword);
 911                         if (!str)
 912                                 break;
 913
 914                         pre_len = str - buf;
 915                         if (strlen(str) != f->strlen)
 916                                 post_start = pre_len + f->strlen;
 917
 918                         if (pre_len) {
 919                                 strncpy(dst, buf, pre_len);
 920                                 dst += pre_len;
 921                         }
 922
 923                         switch (f->key) {
 924                         case FPRE_JOBNAME:
 925                                 dst += sprintf(dst, "%s", jobname);
 926                                 break;
 927                         case FPRE_JOBNUM:
 928                                 dst += sprintf(dst, "%d", jobnum);
 929                                 break;
 930                         case FPRE_FILENUM:
 931                                 dst += sprintf(dst, "%d", filenum);
 932                                 break;
 933                         default:
 934                                 assert(0);
 935                                 break;
 936                         }
 937
 938                         if (post_start)
 939                                 strcpy(dst, buf + post_start);
 940
 941                         strcpy(buf, copy);
 942                 } while (1);
 943         }
 944
 945         return buf;
 946 }
 947
 948 int parse_dryrun(void)
 949 {
 950         return dump_cmdline || parse_only;
 951 }
 952
 953 /*
 954  * Adds a job to the list of things todo. Sanitizes the various options
 955  * to make sure we don't have conflicts, and initializes various
 956  * members of td.
 957  */
 958 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
 959                    int recursed, int client_type)
 960 {
 961         unsigned int i;
 962         char fname[PATH_MAX];
 963         int numjobs, file_alloced;
 964         struct thread_options *o = &td->o;
 965
 966         /*
 967          * the def_thread is just for options, it's not a real job
 968          */
 969         if (td == &def_thread)
 970                 return 0;
 971
 972         init_flags(td);
 973
 974         /*
 975          * if we are just dumping the output command line, don't add the job
 976          */
 977         if (parse_dryrun()) {
 978                 put_job(td);
 979                 return 0;
 980         }
 981
 982         td->client_type = client_type;
 983
 984         if (profile_td_init(td))
 985                 goto err;
 986
 987         if (ioengine_load(td))
 988                 goto err;
 989
 990         if (o->odirect)
 991                 td->io_ops->flags |= FIO_RAWIO;
 992
 993         file_alloced = 0;
 994         if (!o->filename && !td->files_index && !o->read_iolog_file) {
 995                 file_alloced = 1;
 996
 997                 if (o->nr_files == 1 && exists_and_not_file(jobname))
 998                         add_file(td, jobname);
 999                 else {
1000                         for (i = 0; i < o->nr_files; i++)
1001                                 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
1002                 }
1003         }
1004
1005         if (fixup_options(td))
1006                 goto err;
1007
1008         flow_init_job(td);
1009
1010         /*
1011          * IO engines only need this for option callbacks, and the address may
1012          * change in subprocesses.
1013          */
1014         if (td->eo)
1015                 *(struct thread_data **)td->eo = NULL;
1016
1017         if (td->io_ops->flags & FIO_DISKLESSIO) {
1018                 struct fio_file *f;
1019
1020                 for_each_file(td, f, i)
1021                         f->real_file_size = -1ULL;
1022         }
1023
1024         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1025
1026         td->ts.clat_percentiles = o->clat_percentiles;
1027         td->ts.percentile_precision = o->percentile_precision;
1028         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1029
1030         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1031                 td->ts.clat_stat[i].min_val = ULONG_MAX;
1032                 td->ts.slat_stat[i].min_val = ULONG_MAX;
1033                 td->ts.lat_stat[i].min_val = ULONG_MAX;
1034                 td->ts.bw_stat[i].min_val = ULONG_MAX;
1035         }
1036         td->ddir_seq_nr = o->ddir_seq_nr;
1037
1038         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1039                 prev_group_jobs = 0;
1040                 groupid++;
1041         }
1042
1043         td->groupid = groupid;
1044         prev_group_jobs++;
1045
1046         if (setup_random_seeds(td)) {
1047                 td_verror(td, errno, "init_random_state");
1048                 goto err;
1049         }
1050
1051         if (setup_rate(td))
1052                 goto err;
1053
1054         if (o->lat_log_file) {
1055                 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1056                 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1057                 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1058         }
1059         if (o->bw_log_file)
1060                 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1061         if (o->iops_log_file)
1062                 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1063
1064         if (!o->name)
1065                 o->name = strdup(jobname);
1066
1067         if (output_format == FIO_OUTPUT_NORMAL) {
1068                 if (!job_add_num) {
1069                         if (is_backend && !recursed)
1070                                 fio_server_send_add_job(td);
1071
1072                         if (!(td->io_ops->flags & FIO_NOIO)) {
1073                                 char *c1, *c2, *c3, *c4;
1074                                 char *c5 = NULL, *c6 = NULL;
1075
1076                                 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1077                                 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1078                                 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1079                                 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1080
1081                                 if (!o->bs_is_seq_rand) {
1082                                         c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1083                                         c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1084                                 }
1085
1086                                 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1087                                                         td->groupid,
1088                                                         ddir_str(o->td_ddir));
1089
1090                                 if (o->bs_is_seq_rand)
1091                                         log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1092                                                         c1, c2, c3, c4);
1093                                 else
1094                                         log_info("bs=%s-%s/%s-%s/%s-%s, ",
1095                                                         c1, c2, c3, c4, c5, c6);
1096
1097                                 log_info("ioengine=%s, iodepth=%u\n",
1098                                                 td->io_ops->name, o->iodepth);
1099
1100                                 free(c1);
1101                                 free(c2);
1102                                 free(c3);
1103                                 free(c4);
1104                                 free(c5);
1105                                 free(c6);
1106                         }
1107                 } else if (job_add_num == 1)
1108                         log_info("...\n");
1109         }
1110
1111         /*
1112          * recurse add identical jobs, clear numjobs and stonewall options
1113          * as they don't apply to sub-jobs
1114          */
1115         numjobs = o->numjobs;
1116         while (--numjobs) {
1117                 struct thread_data *td_new = get_new_job(0, td, 1);
1118
1119                 if (!td_new)
1120                         goto err;
1121
1122                 td_new->o.numjobs = 1;
1123                 td_new->o.stonewall = 0;
1124                 td_new->o.new_group = 0;
1125
1126                 if (file_alloced) {
1127                         td_new->files_index = 0;
1128                         td_new->files_size = 0;
1129                         if (td_new->files) {
1130                                 struct fio_file *f;
1131                                 for_each_file(td_new, f, i) {
1132                                         if (f->file_name)
1133                                                 free(f->file_name);
1134                                         free(f);
1135                                 }
1136                                 td_new->files = NULL;
1137                         }
1138                         if (td_new->o.filename) {
1139                                 free(td_new->o.filename);
1140                                 td_new->o.filename = NULL;
1141                         }
1142                 }
1143
1144                 job_add_num = numjobs - 1;
1145
1146                 if (add_job(td_new, jobname, job_add_num, 1, client_type))
1147                         goto err;
1148         }
1149
1150         return 0;
1151 err:
1152         put_job(td);
1153         return -1;
1154 }
1155
1156 /*
1157  * Parse as if 'o' was a command line
1158  */
1159 void add_job_opts(const char **o, int client_type)
1160 {
1161         struct thread_data *td, *td_parent;
1162         int i, in_global = 1;
1163         char jobname[32];
1164
1165         i = 0;
1166         td_parent = td = NULL;
1167         while (o[i]) {
1168                 if (!strncmp(o[i], "name", 4)) {
1169                         in_global = 0;
1170                         if (td)
1171                                 add_job(td, jobname, 0, 0, client_type);
1172                         td = NULL;
1173                         sprintf(jobname, "%s", o[i] + 5);
1174                 }
1175                 if (in_global && !td_parent)
1176                         td_parent = get_new_job(1, &def_thread, 0);
1177                 else if (!in_global && !td) {
1178                         if (!td_parent)
1179                                 td_parent = &def_thread;
1180                         td = get_new_job(0, td_parent, 0);
1181                 }
1182                 if (in_global)
1183                         fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1184                 else
1185                         fio_options_parse(td, (char **) &o[i], 1, 0);
1186                 i++;
1187         }
1188
1189         if (td)
1190                 add_job(td, jobname, 0, 0, client_type);
1191 }
1192
1193 static int skip_this_section(const char *name)
1194 {
1195         int i;
1196
1197         if (!nr_job_sections)
1198                 return 0;
1199         if (!strncmp(name, "global", 6))
1200                 return 0;
1201
1202         for (i = 0; i < nr_job_sections; i++)
1203                 if (!strcmp(job_sections[i], name))
1204                         return 0;
1205
1206         return 1;
1207 }
1208
1209 static int is_empty_or_comment(char *line)
1210 {
1211         unsigned int i;
1212
1213         for (i = 0; i < strlen(line); i++) {
1214                 if (line[i] == ';')
1215                         return 1;
1216                 if (line[i] == '#')
1217                         return 1;
1218                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1219                         return 0;
1220         }
1221
1222         return 1;
1223 }
1224
1225 /*
1226  * This is our [ini] type file parser.
1227  */
1228 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1229 {
1230         unsigned int global;
1231         struct thread_data *td;
1232         char *string, *name;
1233         FILE *f;
1234         char *p;
1235         int ret = 0, stonewall;
1236         int first_sect = 1;
1237         int skip_fgets = 0;
1238         int inside_skip = 0;
1239         char **opts;
1240         int i, alloc_opts, num_opts;
1241
1242         if (is_buf)
1243                 f = NULL;
1244         else {
1245                 if (!strcmp(file, "-"))
1246                         f = stdin;
1247                 else
1248                         f = fopen(file, "r");
1249
1250                 if (!f) {
1251                         perror("fopen job file");
1252                         return 1;
1253                 }
1254         }
1255
1256         string = malloc(4096);
1257
1258         /*
1259          * it's really 256 + small bit, 280 should suffice
1260          */
1261         name = malloc(280);
1262         memset(name, 0, 280);
1263
1264         alloc_opts = 8;
1265         opts = malloc(sizeof(char *) * alloc_opts);
1266         num_opts = 0;
1267
1268         stonewall = stonewall_flag;
1269         do {
1270                 /*
1271                  * if skip_fgets is set, we already have loaded a line we
1272                  * haven't handled.
1273                  */
1274                 if (!skip_fgets) {
1275                         if (is_buf)
1276                                 p = strsep(&file, "\n");
1277                         else
1278                                 p = fgets(string, 4096, f);
1279                         if (!p)
1280                                 break;
1281                 }
1282
1283                 skip_fgets = 0;
1284                 strip_blank_front(&p);
1285                 strip_blank_end(p);
1286
1287                 if (is_empty_or_comment(p))
1288                         continue;
1289                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1290                         if (inside_skip)
1291                                 continue;
1292                         log_err("fio: option <%s> outside of [] job section\n",
1293                                                                         p);
1294                         break;
1295                 }
1296
1297                 name[strlen(name) - 1] = '\0';
1298
1299                 if (skip_this_section(name)) {
1300                         inside_skip = 1;
1301                         continue;
1302                 } else
1303                         inside_skip = 0;
1304
1305                 global = !strncmp(name, "global", 6);
1306
1307                 if (dump_cmdline) {
1308                         if (first_sect)
1309                                 log_info("fio ");
1310                         if (!global)
1311                                 log_info("--name=%s ", name);
1312                         first_sect = 0;
1313                 }
1314
1315                 td = get_new_job(global, &def_thread, 0);
1316                 if (!td) {
1317                         ret = 1;
1318                         break;
1319                 }
1320
1321                 /*
1322                  * Separate multiple job files by a stonewall
1323                  */
1324                 if (!global && stonewall) {
1325                         td->o.stonewall = stonewall;
1326                         stonewall = 0;
1327                 }
1328
1329                 num_opts = 0;
1330                 memset(opts, 0, alloc_opts * sizeof(char *));
1331
1332                 while (1) {
1333                         if (is_buf)
1334                                 p = strsep(&file, "\n");
1335                         else
1336                                 p = fgets(string, 4096, f);
1337                         if (!p)
1338                                 break;
1339
1340                         if (is_empty_or_comment(p))
1341                                 continue;
1342
1343                         strip_blank_front(&p);
1344
1345                         /*
1346                          * new section, break out and make sure we don't
1347                          * fgets() a new line at the top.
1348                          */
1349                         if (p[0] == '[') {
1350                                 skip_fgets = 1;
1351                                 break;
1352                         }
1353
1354                         strip_blank_end(p);
1355
1356                         if (num_opts == alloc_opts) {
1357                                 alloc_opts <<= 1;
1358                                 opts = realloc(opts,
1359                                                 alloc_opts * sizeof(char *));
1360                         }
1361
1362                         opts[num_opts] = strdup(p);
1363                         num_opts++;
1364                 }
1365
1366                 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1367                 if (!ret)
1368                         ret = add_job(td, name, 0, 0, type);
1369                 else {
1370                         log_err("fio: job %s dropped\n", name);
1371                         put_job(td);
1372                 }
1373
1374                 for (i = 0; i < num_opts; i++)
1375                         free(opts[i]);
1376                 num_opts = 0;
1377         } while (!ret);
1378
1379         if (dump_cmdline)
1380                 log_info("\n");
1381
1382         i = 0;
1383         while (i < nr_job_sections) {
1384                 free(job_sections[i]);
1385                 i++;
1386         }
1387
1388         for (i = 0; i < num_opts; i++)
1389                 free(opts[i]);
1390
1391         free(string);
1392         free(name);
1393         free(opts);
1394         if (!is_buf && f != stdin)
1395                 fclose(f);
1396         return ret;
1397 }
1398
1399 static int fill_def_thread(void)
1400 {
1401         memset(&def_thread, 0, sizeof(def_thread));
1402
1403         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1404         def_thread.o.timeout = def_timeout;
1405         def_thread.o.error_dump = 1;
1406         /*
1407          * fill default options
1408          */
1409         fio_fill_default_options(&def_thread);
1410         return 0;
1411 }
1412
1413 static void usage(const char *name)
1414 {
1415         printf("%s\n", fio_version_string);
1416         printf("%s [options] [job options] <job file(s)>\n", name);
1417         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1418                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1419                 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1420         printf("  --parse-only\t\tParse options only, don't start any IO\n");
1421         printf("  --output\t\tWrite output to file\n");
1422         printf("  --runtime\t\tRuntime in seconds\n");
1423         printf("  --latency-log\t\tGenerate per-job latency logs\n");
1424         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1425         printf("  --minimal\t\tMinimal (terse) output\n");
1426         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1427         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1428         printf("  --version\t\tPrint version info and exit\n");
1429         printf("  --help\t\tPrint this page\n");
1430         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
1431         printf("  --crctest\t\tTest speed of checksum functions\n");
1432         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1433                 " them\n");
1434         printf("  --enghelp=engine\tPrint ioengine help, or list"
1435                 " available ioengines\n");
1436         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1437                 " cmd\n");
1438         printf("  --showcmd\t\tTurn a job file into command line options\n");
1439         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1440         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1441         printf("  --eta-newline=time\tForce a new line for every 'time'");
1442         printf(" period passed\n");
1443         printf("  --status-interval=t\tForce full status dump every");
1444         printf(" 't' period passed\n");
1445         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1446                 " writes\n");
1447         printf("  --section=name\tOnly run specified section in job file\n");
1448         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1449                 " (def 1024)\n");
1450         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1451         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1452         printf("  --server=args\t\tStart a backend fio server\n");
1453         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1454         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1455         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1456                 "\t\t\t(option=system,percpu) or run unit work\n"
1457                 "\t\t\tcalibration only (option=calibrate)\n");
1458         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1459         printf("\n                   Jens Axboe <jaxboe@fusionio.com>");
1460         printf("\n                   Jens Axboe <axboe@fb.com>\n");
1461 }
1462
1463 #ifdef FIO_INC_DEBUG
1464 struct debug_level debug_levels[] = {
1465         { .name = "process",
1466           .help = "Process creation/exit logging",
1467           .shift = FD_PROCESS,
1468         },
1469         { .name = "file",
1470           .help = "File related action logging",
1471           .shift = FD_FILE,
1472         },
1473         { .name = "io",
1474           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1475           .shift = FD_IO,
1476         },
1477         { .name = "mem",
1478           .help = "Memory allocation/freeing logging",
1479           .shift = FD_MEM,
1480         },
1481         { .name = "blktrace",
1482           .help = "blktrace action logging",
1483           .shift = FD_BLKTRACE,
1484         },
1485         { .name = "verify",
1486           .help = "IO verification action logging",
1487           .shift = FD_VERIFY,
1488         },
1489         { .name = "random",
1490           .help = "Random generation logging",
1491           .shift = FD_RANDOM,
1492         },
1493         { .name = "parse",
1494           .help = "Parser logging",
1495           .shift = FD_PARSE,
1496         },
1497         { .name = "diskutil",
1498           .help = "Disk utility logging actions",
1499           .shift = FD_DISKUTIL,
1500         },
1501         { .name = "job",
1502           .help = "Logging related to creating/destroying jobs",
1503           .shift = FD_JOB,
1504         },
1505         { .name = "mutex",
1506           .help = "Mutex logging",
1507           .shift = FD_MUTEX
1508         },
1509         { .name = "profile",
1510           .help = "Logging related to profiles",
1511           .shift = FD_PROFILE,
1512         },
1513         { .name = "time",
1514           .help = "Logging related to time keeping functions",
1515           .shift = FD_TIME,
1516         },
1517         { .name = "net",
1518           .help = "Network logging",
1519           .shift = FD_NET,
1520         },
1521         { .name = "rate",
1522           .help = "Rate logging",
1523           .shift = FD_RATE,
1524         },
1525         { .name = NULL, },
1526 };
1527
1528 static int set_debug(const char *string)
1529 {
1530         struct debug_level *dl;
1531         char *p = (char *) string;
1532         char *opt;
1533         int i;
1534
1535         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1536                 log_info("fio: dumping debug options:");
1537                 for (i = 0; debug_levels[i].name; i++) {
1538                         dl = &debug_levels[i];
1539                         log_info("%s,", dl->name);
1540                 }
1541                 log_info("all\n");
1542                 return 1;
1543         }
1544
1545         while ((opt = strsep(&p, ",")) != NULL) {
1546                 int found = 0;
1547
1548                 if (!strncmp(opt, "all", 3)) {
1549                         log_info("fio: set all debug options\n");
1550                         fio_debug = ~0UL;
1551                         continue;
1552                 }
1553
1554                 for (i = 0; debug_levels[i].name; i++) {
1555                         dl = &debug_levels[i];
1556                         found = !strncmp(opt, dl->name, strlen(dl->name));
1557                         if (!found)
1558                                 continue;
1559
1560                         if (dl->shift == FD_JOB) {
1561                                 opt = strchr(opt, ':');
1562                                 if (!opt) {
1563                                         log_err("fio: missing job number\n");
1564                                         break;
1565                                 }
1566                                 opt++;
1567                                 fio_debug_jobno = atoi(opt);
1568                                 log_info("fio: set debug jobno %d\n",
1569                                                         fio_debug_jobno);
1570                         } else {
1571                                 log_info("fio: set debug option %s\n", opt);
1572                                 fio_debug |= (1UL << dl->shift);
1573                         }
1574                         break;
1575                 }
1576
1577                 if (!found)
1578                         log_err("fio: debug mask %s not found\n", opt);
1579         }
1580         return 0;
1581 }
1582 #else
1583 static int set_debug(const char *string)
1584 {
1585         log_err("fio: debug tracing not included in build\n");
1586         return 1;
1587 }
1588 #endif
1589
1590 static void fio_options_fill_optstring(void)
1591 {
1592         char *ostr = cmd_optstr;
1593         int i, c;
1594
1595         c = i = 0;
1596         while (l_opts[i].name) {
1597                 ostr[c++] = l_opts[i].val;
1598                 if (l_opts[i].has_arg == required_argument)
1599                         ostr[c++] = ':';
1600                 else if (l_opts[i].has_arg == optional_argument) {
1601                         ostr[c++] = ':';
1602                         ostr[c++] = ':';
1603                 }
1604                 i++;
1605         }
1606         ostr[c] = '\0';
1607 }
1608
1609 static int client_flag_set(char c)
1610 {
1611         int i;
1612
1613         i = 0;
1614         while (l_opts[i].name) {
1615                 int val = l_opts[i].val;
1616
1617                 if (c == (val & 0xff))
1618                         return (val & FIO_CLIENT_FLAG);
1619
1620                 i++;
1621         }
1622
1623         return 0;
1624 }
1625
1626 void parse_cmd_client(void *client, char *opt)
1627 {
1628         fio_client_add_cmd_option(client, opt);
1629 }
1630
1631 extern int fio_crctest(const char *);
1632
1633 int parse_cmd_line(int argc, char *argv[], int client_type)
1634 {
1635         struct thread_data *td = NULL;
1636         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1637         char *ostr = cmd_optstr;
1638         void *pid_file = NULL;
1639         void *cur_client = NULL;
1640         int backend = 0;
1641
1642         /*
1643          * Reset optind handling, since we may call this multiple times
1644          * for the backend.
1645          */
1646         optind = 1;
1647
1648         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1649                 did_arg = 1;
1650
1651                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1652                         parse_cmd_client(cur_client, argv[optind - 1]);
1653                         c &= ~FIO_CLIENT_FLAG;
1654                 }
1655
1656                 switch (c) {
1657                 case 'a':
1658                         smalloc_pool_size = atoi(optarg);
1659                         break;
1660                 case 't':
1661                         def_timeout = atoi(optarg);
1662                         break;
1663                 case 'l':
1664                         write_lat_log = 1;
1665                         break;
1666                 case 'b':
1667                         write_bw_log = 1;
1668                         break;
1669                 case 'o':
1670                         f_out = fopen(optarg, "w+");
1671                         if (!f_out) {
1672                                 perror("fopen output");
1673                                 exit(1);
1674                         }
1675                         f_err = f_out;
1676                         break;
1677                 case 'm':
1678                         output_format = FIO_OUTPUT_TERSE;
1679                         break;
1680                 case 'F':
1681                         if (!optarg) {
1682                                 log_err("fio: missing --output-format argument\n");
1683                                 exit_val = 1;
1684                                 do_exit++;
1685                                 break;
1686                         }
1687                         if (!strcmp(optarg, "minimal") ||
1688                             !strcmp(optarg, "terse") ||
1689                             !strcmp(optarg, "csv"))
1690                                 output_format = FIO_OUTPUT_TERSE;
1691                         else if (!strcmp(optarg, "json"))
1692                                 output_format = FIO_OUTPUT_JSON;
1693                         else
1694                                 output_format = FIO_OUTPUT_NORMAL;
1695                         break;
1696                 case 'h':
1697                         if (!cur_client) {
1698                                 usage(argv[0]);
1699                                 do_exit++;
1700                         }
1701                         break;
1702                 case 'c':
1703                         if (!cur_client) {
1704                                 fio_show_option_help(optarg);
1705                                 do_exit++;
1706                         }
1707                         break;
1708                 case 'i':
1709                         if (!cur_client) {
1710                                 fio_show_ioengine_help(optarg);
1711                                 do_exit++;
1712                         }
1713                         break;
1714                 case 's':
1715                         dump_cmdline = 1;
1716                         break;
1717                 case 'r':
1718                         read_only = 1;
1719                         break;
1720                 case 'v':
1721                         if (!cur_client) {
1722                                 log_info("%s\n", fio_version_string);
1723                                 do_exit++;
1724                         }
1725                         break;
1726                 case 'V':
1727                         terse_version = atoi(optarg);
1728                         if (!(terse_version == 2 || terse_version == 3 ||
1729                              terse_version == 4)) {
1730                                 log_err("fio: bad terse version format\n");
1731                                 exit_val = 1;
1732                                 do_exit++;
1733                         }
1734                         break;
1735                 case 'e':
1736                         if (!strcmp("always", optarg))
1737                                 eta_print = FIO_ETA_ALWAYS;
1738                         else if (!strcmp("never", optarg))
1739                                 eta_print = FIO_ETA_NEVER;
1740                         break;
1741                 case 'E': {
1742                         long long t = 0;
1743
1744                         if (str_to_decimal(optarg, &t, 0, NULL)) {
1745                                 log_err("fio: failed parsing eta time %s\n", optarg);
1746                                 exit_val = 1;
1747                                 do_exit++;
1748                         }
1749                         eta_new_line = t;
1750                         break;
1751                         }
1752                 case 'd':
1753                         if (set_debug(optarg))
1754                                 do_exit++;
1755                         break;
1756                 case 'P':
1757                         parse_only = 1;
1758                         break;
1759                 case 'x': {
1760                         size_t new_size;
1761
1762                         if (!strcmp(optarg, "global")) {
1763                                 log_err("fio: can't use global as only "
1764                                         "section\n");
1765                                 do_exit++;
1766                                 exit_val = 1;
1767                                 break;
1768                         }
1769                         new_size = (nr_job_sections + 1) * sizeof(char *);
1770                         job_sections = realloc(job_sections, new_size);
1771                         job_sections[nr_job_sections] = strdup(optarg);
1772                         nr_job_sections++;
1773                         break;
1774                         }
1775                 case 'p':
1776                         exec_profile = strdup(optarg);
1777                         break;
1778                 case FIO_GETOPT_JOB: {
1779                         const char *opt = l_opts[lidx].name;
1780                         char *val = optarg;
1781
1782                         if (!strncmp(opt, "name", 4) && td) {
1783                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1784                                 if (ret)
1785                                         return 0;
1786                                 td = NULL;
1787                         }
1788                         if (!td) {
1789                                 int is_section = !strncmp(opt, "name", 4);
1790                                 int global = 0;
1791
1792                                 if (!is_section || !strncmp(val, "global", 6))
1793                                         global = 1;
1794
1795                                 if (is_section && skip_this_section(val))
1796                                         continue;
1797
1798                                 td = get_new_job(global, &def_thread, 1);
1799                                 if (!td || ioengine_load(td))
1800                                         return 0;
1801                                 fio_options_set_ioengine_opts(l_opts, td);
1802                         }
1803
1804                         if ((!val || !strlen(val)) &&
1805                             l_opts[lidx].has_arg == required_argument) {
1806                                 log_err("fio: option %s requires an argument\n", opt);
1807                                 ret = 1;
1808                         } else
1809                                 ret = fio_cmd_option_parse(td, opt, val);
1810
1811                         if (ret) {
1812                                 if (td) {
1813                                         put_job(td);
1814                                         td = NULL;
1815                                 }
1816                                 do_exit++;
1817                         }
1818
1819                         if (!ret && !strcmp(opt, "ioengine")) {
1820                                 free_ioengine(td);
1821                                 if (ioengine_load(td))
1822                                         return 0;
1823                                 fio_options_set_ioengine_opts(l_opts, td);
1824                         }
1825                         break;
1826                 }
1827                 case FIO_GETOPT_IOENGINE: {
1828                         const char *opt = l_opts[lidx].name;
1829                         char *val = optarg;
1830                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1831                         break;
1832                 }
1833                 case 'w':
1834                         warnings_fatal = 1;
1835                         break;
1836                 case 'j':
1837                         max_jobs = atoi(optarg);
1838                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1839                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1840                                 do_exit++;
1841                                 exit_val = 1;
1842                         }
1843                         break;
1844                 case 'S':
1845                         if (nr_clients) {
1846                                 log_err("fio: can't be both client and server\n");
1847                                 do_exit++;
1848                                 exit_val = 1;
1849                                 break;
1850                         }
1851                         if (optarg)
1852                                 fio_server_set_arg(optarg);
1853                         is_backend = 1;
1854                         backend = 1;
1855                         break;
1856                 case 'D':
1857                         pid_file = strdup(optarg);
1858                         break;
1859                 case 'I':
1860                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
1861                                 /* exit on error and calibration only */
1862                                 do_exit++;
1863                                 if (ret == -1)
1864                                         exit_val = 1;
1865                         }
1866                         break;
1867                 case 'C':
1868                         if (is_backend) {
1869                                 log_err("fio: can't be both client and server\n");
1870                                 do_exit++;
1871                                 exit_val = 1;
1872                                 break;
1873                         }
1874                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1875                                 log_err("fio: failed adding client %s\n", optarg);
1876                                 do_exit++;
1877                                 exit_val = 1;
1878                                 break;
1879                         }
1880                         /*
1881                          * If the next argument exists and isn't an option,
1882                          * assume it's a job file for this client only.
1883                          */
1884                         while (optind < argc) {
1885                                 if (!strncmp(argv[optind], "--", 2) ||
1886                                     !strncmp(argv[optind], "-", 1))
1887                                         break;
1888
1889                                 fio_client_add_ini_file(cur_client, argv[optind]);
1890                                 optind++;
1891                         }
1892                         break;
1893                 case 'T':
1894                         do_exit++;
1895                         exit_val = fio_monotonic_clocktest();
1896                         break;
1897                 case 'G':
1898                         do_exit++;
1899                         exit_val = fio_crctest(optarg);
1900                         break;
1901                 case 'L': {
1902                         long long val;
1903
1904                         if (check_str_time(optarg, &val)) {
1905                                 log_err("fio: failed parsing time %s\n", optarg);
1906                                 do_exit++;
1907                                 exit_val = 1;
1908                                 break;
1909                         }
1910                         status_interval = val * 1000;
1911                         break;
1912                         }
1913                 case '?':
1914                         log_err("%s: unrecognized option '%s'\n", argv[0],
1915                                                         argv[optind - 1]);
1916                 default:
1917                         do_exit++;
1918                         exit_val = 1;
1919                         break;
1920                 }
1921                 if (do_exit)
1922                         break;
1923         }
1924
1925         if (do_exit && !(is_backend || nr_clients))
1926                 exit(exit_val);
1927
1928         if (nr_clients && fio_clients_connect()) {
1929                 do_exit++;
1930                 exit_val = 1;
1931                 return -1;
1932         }
1933
1934         if (is_backend && backend)
1935                 return fio_start_server(pid_file);
1936
1937         if (td) {
1938                 if (!ret)
1939                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1940         }
1941
1942         while (!ret && optind < argc) {
1943                 ini_idx++;
1944                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1945                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1946                 optind++;
1947         }
1948
1949         return ini_idx;
1950 }
1951
1952 int fio_init_options(void)
1953 {
1954         f_out = stdout;
1955         f_err = stderr;
1956
1957         fio_options_fill_optstring();
1958         fio_options_dup_and_init(l_opts);
1959
1960         atexit(free_shm);
1961
1962         if (fill_def_thread())
1963                 return 1;
1964
1965         return 0;
1966 }
1967
1968 extern int fio_check_options(struct thread_options *);
1969
1970 int parse_options(int argc, char *argv[])
1971 {
1972         const int type = FIO_CLIENT_TYPE_CLI;
1973         int job_files, i;
1974
1975         if (fio_init_options())
1976                 return 1;
1977         if (fio_test_cconv(&def_thread.o))
1978                 log_err("fio: failed internal cconv test\n");
1979
1980         job_files = parse_cmd_line(argc, argv, type);
1981
1982         if (job_files > 0) {
1983                 for (i = 0; i < job_files; i++) {
1984                         if (fill_def_thread())
1985                                 return 1;
1986                         if (nr_clients) {
1987                                 if (fio_clients_send_ini(ini_file[i]))
1988                                         return 1;
1989                                 free(ini_file[i]);
1990                         } else if (!is_backend) {
1991                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
1992                                         return 1;
1993                                 free(ini_file[i]);
1994                         }
1995                 }
1996         } else if (nr_clients) {
1997                 if (fill_def_thread())
1998                         return 1;
1999                 if (fio_clients_send_ini(NULL))
2000                         return 1;
2001         }
2002
2003         free(ini_file);
2004         fio_options_free(&def_thread);
2005
2006         if (!thread_number) {
2007                 if (parse_dryrun())
2008                         return 0;
2009                 if (exec_profile)
2010                         return 0;
2011                 if (is_backend || nr_clients)
2012                         return 0;
2013                 if (did_arg)
2014                         return 0;
2015
2016                 log_err("No jobs(s) defined\n\n");
2017
2018                 if (!did_arg) {
2019                         usage(argv[0]);
2020                         return 1;
2021                 }
2022
2023                 return 0;
2024         }
2025
2026         if (def_thread.o.gtod_offload) {
2027                 fio_gtod_init();
2028                 fio_gtod_offload = 1;
2029                 fio_gtod_cpu = def_thread.o.gtod_cpu;
2030         }
2031
2032         if (output_format == FIO_OUTPUT_NORMAL)
2033                 log_info("%s\n", fio_version_string);
2034
2035         return 0;
2036 }
2037
2038 void options_default_fill(struct thread_options *o)
2039 {
2040         memcpy(o, &def_thread.o, sizeof(*o));
2041 }