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 #include "filelock.h"
  28
  29 #include "lib/getopt.h"
  30 #include "lib/strcasestr.h"
  31
  32 #include "crc/test.h"
  33
  34 const char fio_version_string[] = FIO_VERSION;
  35
  36 #define FIO_RANDSEED            (0xb1899bedUL)
  37
  38 static char **ini_file;
  39 static int max_jobs = FIO_MAX_JOBS;
  40 static int dump_cmdline;
  41 static long long def_timeout;
  42 static int parse_only;
  43
  44 static struct thread_data def_thread;
  45 struct thread_data *threads = NULL;
  46 static char **job_sections;
  47 static int nr_job_sections;
  48
  49 int exitall_on_terminate = 0;
  50 int output_format = FIO_OUTPUT_NORMAL;
  51 int append_terse_output = 0;
  52 int eta_print = FIO_ETA_AUTO;
  53 int eta_new_line = 0;
  54 FILE *f_out = NULL;
  55 FILE *f_err = NULL;
  56 char *exec_profile = NULL;
  57 int warnings_fatal = 0;
  58 int terse_version = 3;
  59 int is_backend = 0;
  60 int nr_clients = 0;
  61 int log_syslog = 0;
  62
  63 int write_bw_log = 0;
  64 int read_only = 0;
  65 int status_interval = 0;
  66
  67 char *trigger_file = NULL;
  68 long long trigger_timeout = 0;
  69 char *trigger_cmd = NULL;
  70 char *trigger_remote_cmd = NULL;
  71
  72 static int prev_group_jobs;
  73
  74 unsigned long fio_debug = 0;
  75 unsigned int fio_debug_jobno = -1;
  76 unsigned int *fio_debug_jobp = NULL;
  77
  78 static char cmd_optstr[256];
  79 static int did_arg;
  80
  81 #define FIO_CLIENT_FLAG         (1 << 16)
  82
  83 /*
  84  * Command line options. These will contain the above, plus a few
  85  * extra that only pertain to fio itself and not jobs.
  86  */
  87 static struct option l_opts[FIO_NR_OPTIONS] = {
  88         {
  89                 .name           = (char *) "output",
  90                 .has_arg        = required_argument,
  91                 .val            = 'o' | FIO_CLIENT_FLAG,
  92         },
  93         {
  94                 .name           = (char *) "timeout",
  95                 .has_arg        = required_argument,
  96                 .val            = 't' | FIO_CLIENT_FLAG,
  97         },
  98         {
  99                 .name           = (char *) "latency-log",
 100                 .has_arg        = required_argument,
 101                 .val            = 'l' | FIO_CLIENT_FLAG,
 102         },
 103         {
 104                 .name           = (char *) "bandwidth-log",
 105                 .has_arg        = required_argument,
 106                 .val            = 'b' | FIO_CLIENT_FLAG,
 107         },
 108         {
 109                 .name           = (char *) "minimal",
 110                 .has_arg        = no_argument,
 111                 .val            = 'm' | FIO_CLIENT_FLAG,
 112         },
 113         {
 114                 .name           = (char *) "output-format",
 115                 .has_arg        = optional_argument,
 116                 .val            = 'F' | FIO_CLIENT_FLAG,
 117         },
 118         {
 119                 .name           = (char *) "append-terse",
 120                 .has_arg        = optional_argument,
 121                 .val            = 'f',
 122         },
 123         {
 124                 .name           = (char *) "version",
 125                 .has_arg        = no_argument,
 126                 .val            = 'v' | FIO_CLIENT_FLAG,
 127         },
 128         {
 129                 .name           = (char *) "help",
 130                 .has_arg        = no_argument,
 131                 .val            = 'h' | FIO_CLIENT_FLAG,
 132         },
 133         {
 134                 .name           = (char *) "cmdhelp",
 135                 .has_arg        = optional_argument,
 136                 .val            = 'c' | FIO_CLIENT_FLAG,
 137         },
 138         {
 139                 .name           = (char *) "enghelp",
 140                 .has_arg        = optional_argument,
 141                 .val            = 'i' | FIO_CLIENT_FLAG,
 142         },
 143         {
 144                 .name           = (char *) "showcmd",
 145                 .has_arg        = no_argument,
 146                 .val            = 's' | FIO_CLIENT_FLAG,
 147         },
 148         {
 149                 .name           = (char *) "readonly",
 150                 .has_arg        = no_argument,
 151                 .val            = 'r' | FIO_CLIENT_FLAG,
 152         },
 153         {
 154                 .name           = (char *) "eta",
 155                 .has_arg        = required_argument,
 156                 .val            = 'e' | FIO_CLIENT_FLAG,
 157         },
 158         {
 159                 .name           = (char *) "eta-newline",
 160                 .has_arg        = required_argument,
 161                 .val            = 'E' | FIO_CLIENT_FLAG,
 162         },
 163         {
 164                 .name           = (char *) "debug",
 165                 .has_arg        = required_argument,
 166                 .val            = 'd' | FIO_CLIENT_FLAG,
 167         },
 168         {
 169                 .name           = (char *) "parse-only",
 170                 .has_arg        = no_argument,
 171                 .val            = 'P' | FIO_CLIENT_FLAG,
 172         },
 173         {
 174                 .name           = (char *) "section",
 175                 .has_arg        = required_argument,
 176                 .val            = 'x' | FIO_CLIENT_FLAG,
 177         },
 178 #ifdef CONFIG_ZLIB
 179         {
 180                 .name           = (char *) "inflate-log",
 181                 .has_arg        = required_argument,
 182                 .val            = 'X' | FIO_CLIENT_FLAG,
 183         },
 184 #endif
 185         {
 186                 .name           = (char *) "alloc-size",
 187                 .has_arg        = required_argument,
 188                 .val            = 'a' | FIO_CLIENT_FLAG,
 189         },
 190         {
 191                 .name           = (char *) "profile",
 192                 .has_arg        = required_argument,
 193                 .val            = 'p' | FIO_CLIENT_FLAG,
 194         },
 195         {
 196                 .name           = (char *) "warnings-fatal",
 197                 .has_arg        = no_argument,
 198                 .val            = 'w' | FIO_CLIENT_FLAG,
 199         },
 200         {
 201                 .name           = (char *) "max-jobs",
 202                 .has_arg        = required_argument,
 203                 .val            = 'j' | FIO_CLIENT_FLAG,
 204         },
 205         {
 206                 .name           = (char *) "terse-version",
 207                 .has_arg        = required_argument,
 208                 .val            = 'V' | FIO_CLIENT_FLAG,
 209         },
 210         {
 211                 .name           = (char *) "server",
 212                 .has_arg        = optional_argument,
 213                 .val            = 'S',
 214         },
 215         {       .name           = (char *) "daemonize",
 216                 .has_arg        = required_argument,
 217                 .val            = 'D',
 218         },
 219         {
 220                 .name           = (char *) "client",
 221                 .has_arg        = required_argument,
 222                 .val            = 'C',
 223         },
 224         {
 225                 .name           = (char *) "remote-config",
 226                 .has_arg        = required_argument,
 227                 .val            = 'R',
 228         },
 229         {
 230                 .name           = (char *) "cpuclock-test",
 231                 .has_arg        = no_argument,
 232                 .val            = 'T',
 233         },
 234         {
 235                 .name           = (char *) "crctest",
 236                 .has_arg        = optional_argument,
 237                 .val            = 'G',
 238         },
 239         {
 240                 .name           = (char *) "idle-prof",
 241                 .has_arg        = required_argument,
 242                 .val            = 'I',
 243         },
 244         {
 245                 .name           = (char *) "status-interval",
 246                 .has_arg        = required_argument,
 247                 .val            = 'L',
 248         },
 249         {
 250                 .name           = (char *) "trigger-file",
 251                 .has_arg        = required_argument,
 252                 .val            = 'W',
 253         },
 254         {
 255                 .name           = (char *) "trigger-timeout",
 256                 .has_arg        = required_argument,
 257                 .val            = 'B',
 258         },
 259         {
 260                 .name           = (char *) "trigger",
 261                 .has_arg        = required_argument,
 262                 .val            = 'H',
 263         },
 264         {
 265                 .name           = (char *) "trigger-remote",
 266                 .has_arg        = required_argument,
 267                 .val            = 'J',
 268         },
 269         {
 270                 .name           = NULL,
 271         },
 272 };
 273
 274 void free_threads_shm(void)
 275 {
 276         if (threads) {
 277                 void *tp = threads;
 278 #ifndef CONFIG_NO_SHM
 279                 struct shmid_ds sbuf;
 280
 281                 threads = NULL;
 282                 shmdt(tp);
 283                 shmctl(shm_id, IPC_RMID, &sbuf);
 284                 shm_id = -1;
 285 #else
 286                 threads = NULL;
 287                 free(tp);
 288 #endif
 289         }
 290 }
 291
 292 static void free_shm(void)
 293 {
 294         if (threads) {
 295                 file_hash_exit();
 296                 flow_exit();
 297                 fio_debug_jobp = NULL;
 298                 free_threads_shm();
 299         }
 300
 301         free(trigger_file);
 302         free(trigger_cmd);
 303         free(trigger_remote_cmd);
 304         trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
 305
 306         options_free(fio_options, &def_thread);
 307         fio_filelock_exit();
 308         scleanup();
 309 }
 310
 311 /*
 312  * The thread area is shared between the main process and the job
 313  * threads/processes. So setup a shared memory segment that will hold
 314  * all the job info. We use the end of the region for keeping track of
 315  * open files across jobs, for file sharing.
 316  */
 317 static int setup_thread_area(void)
 318 {
 319         void *hash;
 320
 321         if (threads)
 322                 return 0;
 323
 324         /*
 325          * 1024 is too much on some machines, scale max_jobs if
 326          * we get a failure that looks like too large a shm segment
 327          */
 328         do {
 329                 size_t size = max_jobs * sizeof(struct thread_data);
 330
 331                 size += file_hash_size;
 332                 size += sizeof(unsigned int);
 333
 334 #ifndef CONFIG_NO_SHM
 335                 shm_id = shmget(0, size, IPC_CREAT | 0600);
 336                 if (shm_id != -1)
 337                         break;
 338                 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
 339                         perror("shmget");
 340                         break;
 341                 }
 342 #else
 343                 threads = malloc(size);
 344                 if (threads)
 345                         break;
 346 #endif
 347
 348                 max_jobs >>= 1;
 349         } while (max_jobs);
 350
 351 #ifndef CONFIG_NO_SHM
 352         if (shm_id == -1)
 353                 return 1;
 354
 355         threads = shmat(shm_id, NULL, 0);
 356         if (threads == (void *) -1) {
 357                 perror("shmat");
 358                 return 1;
 359         }
 360 #endif
 361
 362         memset(threads, 0, max_jobs * sizeof(struct thread_data));
 363         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
 364         fio_debug_jobp = (void *) hash + file_hash_size;
 365         *fio_debug_jobp = -1;
 366         file_hash_init(hash);
 367
 368         flow_init();
 369
 370         return 0;
 371 }
 372
 373 static void set_cmd_options(struct thread_data *td)
 374 {
 375         struct thread_options *o = &td->o;
 376
 377         if (!o->timeout)
 378                 o->timeout = def_timeout;
 379 }
 380
 381 /*
 382  * Return a free job structure.
 383  */
 384 static struct thread_data *get_new_job(int global, struct thread_data *parent,
 385                                        int preserve_eo, const char *jobname)
 386 {
 387         struct thread_data *td;
 388
 389         if (global) {
 390                 set_cmd_options(&def_thread);
 391                 return &def_thread;
 392         }
 393         if (setup_thread_area()) {
 394                 log_err("error: failed to setup shm segment\n");
 395                 return NULL;
 396         }
 397         if (thread_number >= max_jobs) {
 398                 log_err("error: maximum number of jobs (%d) reached.\n",
 399                                 max_jobs);
 400                 return NULL;
 401         }
 402
 403         td = &threads[thread_number++];
 404         *td = *parent;
 405
 406         td->io_ops = NULL;
 407         if (!preserve_eo)
 408                 td->eo = NULL;
 409
 410         td->o.uid = td->o.gid = -1U;
 411
 412         dup_files(td, parent);
 413         fio_options_mem_dupe(td);
 414
 415         profile_add_hooks(td);
 416
 417         td->thread_number = thread_number;
 418         td->subjob_number = 0;
 419
 420         if (jobname)
 421                 td->o.name = strdup(jobname);
 422
 423         if (!parent->o.group_reporting)
 424                 stat_number++;
 425
 426         set_cmd_options(td);
 427         return td;
 428 }
 429
 430 static void put_job(struct thread_data *td)
 431 {
 432         if (td == &def_thread)
 433                 return;
 434
 435         profile_td_exit(td);
 436         flow_exit_job(td);
 437
 438         if (td->error)
 439                 log_info("fio: %s\n", td->verror);
 440
 441         fio_options_free(td);
 442         if (td->io_ops)
 443                 free_ioengine(td);
 444
 445         if (td->o.name)
 446                 free(td->o.name);
 447
 448         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
 449         thread_number--;
 450 }
 451
 452 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 453 {
 454         unsigned int bs = td->o.min_bs[ddir];
 455
 456         assert(ddir_rw(ddir));
 457
 458         if (td->o.rate[ddir])
 459                 td->rate_bps[ddir] = td->o.rate[ddir];
 460         else
 461                 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
 462
 463         if (!td->rate_bps[ddir]) {
 464                 log_err("rate lower than supported\n");
 465                 return -1;
 466         }
 467
 468         td->rate_pending_usleep[ddir] = 0;
 469         return 0;
 470 }
 471
 472 static int setup_rate(struct thread_data *td)
 473 {
 474         int ret = 0;
 475
 476         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
 477                 ret = __setup_rate(td, DDIR_READ);
 478         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
 479                 ret |= __setup_rate(td, DDIR_WRITE);
 480         if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
 481                 ret |= __setup_rate(td, DDIR_TRIM);
 482
 483         return ret;
 484 }
 485
 486 static int fixed_block_size(struct thread_options *o)
 487 {
 488         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
 489                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
 490                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
 491                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
 492                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
 493 }
 494
 495
 496 static unsigned long long get_rand_start_delay(struct thread_data *td)
 497 {
 498         unsigned long long delayrange;
 499         unsigned long r;
 500
 501         delayrange = td->o.start_delay_high - td->o.start_delay;
 502
 503         r = __rand(&td->delay_state);
 504         delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
 505
 506         delayrange += td->o.start_delay;
 507         return delayrange;
 508 }
 509
 510 /*
 511  * Lazy way of fixing up options that depend on each other. We could also
 512  * define option callback handlers, but this is easier.
 513  */
 514 static int fixup_options(struct thread_data *td)
 515 {
 516         struct thread_options *o = &td->o;
 517         int ret = 0;
 518
 519 #ifndef FIO_HAVE_PSHARED_MUTEX
 520         if (!o->use_thread) {
 521                 log_info("fio: this platform does not support process shared"
 522                          " mutexes, forcing use of threads. Use the 'thread'"
 523                          " option to get rid of this warning.\n");
 524                 o->use_thread = 1;
 525                 ret = warnings_fatal;
 526         }
 527 #endif
 528
 529         if (o->write_iolog_file && o->read_iolog_file) {
 530                 log_err("fio: read iolog overrides write_iolog\n");
 531                 free(o->write_iolog_file);
 532                 o->write_iolog_file = NULL;
 533                 ret = warnings_fatal;
 534         }
 535
 536         /*
 537          * only really works with 1 file
 538          */
 539         if (o->zone_size && o->open_files > 1)
 540                 o->zone_size = 0;
 541
 542         /*
 543          * If zone_range isn't specified, backward compatibility dictates it
 544          * should be made equal to zone_size.
 545          */
 546         if (o->zone_size && !o->zone_range)
 547                 o->zone_range = o->zone_size;
 548
 549         /*
 550          * Reads can do overwrites, we always need to pre-create the file
 551          */
 552         if (td_read(td) || td_rw(td))
 553                 o->overwrite = 1;
 554
 555         if (!o->min_bs[DDIR_READ])
 556                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
 557         if (!o->max_bs[DDIR_READ])
 558                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
 559         if (!o->min_bs[DDIR_WRITE])
 560                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 561         if (!o->max_bs[DDIR_WRITE])
 562                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 563         if (!o->min_bs[DDIR_TRIM])
 564                 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 565         if (!o->max_bs[DDIR_TRIM])
 566                 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
 567
 568         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
 569         o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
 570
 571         /*
 572          * For random IO, allow blockalign offset other than min_bs.
 573          */
 574         if (!o->ba[DDIR_READ] || !td_random(td))
 575                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
 576         if (!o->ba[DDIR_WRITE] || !td_random(td))
 577                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
 578         if (!o->ba[DDIR_TRIM] || !td_random(td))
 579                 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
 580
 581         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
 582             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
 583             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
 584             !o->norandommap) {
 585                 log_err("fio: Any use of blockalign= turns off randommap\n");
 586                 o->norandommap = 1;
 587                 ret = warnings_fatal;
 588         }
 589
 590         if (!o->file_size_high)
 591                 o->file_size_high = o->file_size_low;
 592
 593         if (o->start_delay_high)
 594                 o->start_delay = get_rand_start_delay(td);
 595
 596         if (o->norandommap && o->verify != VERIFY_NONE
 597             && !fixed_block_size(o))  {
 598                 log_err("fio: norandommap given for variable block sizes, "
 599                         "verify limited\n");
 600                 ret = warnings_fatal;
 601         }
 602         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
 603                 log_err("fio: bs_unaligned may not work with raw io\n");
 604
 605         /*
 606          * thinktime_spin must be less than thinktime
 607          */
 608         if (o->thinktime_spin > o->thinktime)
 609                 o->thinktime_spin = o->thinktime;
 610
 611         /*
 612          * The low water mark cannot be bigger than the iodepth
 613          */
 614         if (o->iodepth_low > o->iodepth || !o->iodepth_low)
 615                 o->iodepth_low = o->iodepth;
 616
 617         /*
 618          * If batch number isn't set, default to the same as iodepth
 619          */
 620         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 621                 o->iodepth_batch = o->iodepth;
 622
 623         if (o->nr_files > td->files_index)
 624                 o->nr_files = td->files_index;
 625
 626         if (o->open_files > o->nr_files || !o->open_files)
 627                 o->open_files = o->nr_files;
 628
 629         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
 630             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
 631             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
 632             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
 633                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 634                 ret = 1;
 635         }
 636         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
 637             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
 638             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
 639             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
 640             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
 641             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
 642                 log_err("fio: minimum rate exceeds rate\n");
 643                 ret = 1;
 644         }
 645
 646         if (!o->timeout && o->time_based) {
 647                 log_err("fio: time_based requires a runtime/timeout setting\n");
 648                 o->time_based = 0;
 649                 ret = warnings_fatal;
 650         }
 651
 652         if (o->fill_device && !o->size)
 653                 o->size = -1ULL;
 654
 655         if (o->verify != VERIFY_NONE) {
 656                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
 657                         log_info("Multiple writers may overwrite blocks that "
 658                                 "belong to other jobs. This can cause "
 659                                 "verification failures.\n");
 660                         ret = warnings_fatal;
 661                 }
 662
 663                 o->refill_buffers = 1;
 664                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
 665                     !o->verify_interval)
 666                         o->verify_interval = o->min_bs[DDIR_WRITE];
 667
 668                 /*
 669                  * Verify interval must be smaller or equal to the
 670                  * write size.
 671                  */
 672                 if (o->verify_interval > o->min_bs[DDIR_WRITE])
 673                         o->verify_interval = o->min_bs[DDIR_WRITE];
 674                 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
 675                         o->verify_interval = o->min_bs[DDIR_READ];
 676         }
 677
 678         if (o->pre_read) {
 679                 o->invalidate_cache = 0;
 680                 if (td->io_ops->flags & FIO_PIPEIO) {
 681                         log_info("fio: cannot pre-read files with an IO engine"
 682                                  " that isn't seekable. Pre-read disabled.\n");
 683                         ret = warnings_fatal;
 684                 }
 685         }
 686
 687         if (!o->unit_base) {
 688                 if (td->io_ops->flags & FIO_BIT_BASED)
 689                         o->unit_base = 1;
 690                 else
 691                         o->unit_base = 8;
 692         }
 693
 694 #ifndef CONFIG_FDATASYNC
 695         if (o->fdatasync_blocks) {
 696                 log_info("fio: this platform does not support fdatasync()"
 697                          " falling back to using fsync().  Use the 'fsync'"
 698                          " option instead of 'fdatasync' to get rid of"
 699                          " this warning\n");
 700                 o->fsync_blocks = o->fdatasync_blocks;
 701                 o->fdatasync_blocks = 0;
 702                 ret = warnings_fatal;
 703         }
 704 #endif
 705
 706 #ifdef WIN32
 707         /*
 708          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
 709          * so fail if we're passed those flags
 710          */
 711         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
 712                 log_err("fio: Windows does not support direct or non-buffered io with"
 713                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
 714                                 " with 'direct=1' and 'iodepth=1' instead.\n");
 715                 ret = 1;
 716         }
 717 #endif
 718
 719         /*
 720          * For fully compressible data, just zero them at init time.
 721          * It's faster than repeatedly filling it.
 722          */
 723         if (td->o.compress_percentage == 100) {
 724                 td->o.zero_buffers = 1;
 725                 td->o.compress_percentage = 0;
 726         }
 727
 728         /*
 729          * Using a non-uniform random distribution excludes usage of
 730          * a random map
 731          */
 732         if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
 733                 td->o.norandommap = 1;
 734
 735         /*
 736          * If size is set but less than the min block size, complain
 737          */
 738         if (o->size && o->size < td_min_bs(td)) {
 739                 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
 740                 ret = 1;
 741         }
 742
 743         /*
 744          * O_ATOMIC implies O_DIRECT
 745          */
 746         if (td->o.oatomic)
 747                 td->o.odirect = 1;
 748
 749         /*
 750          * If randseed is set, that overrides randrepeat
 751          */
 752         if (fio_option_is_set(&td->o, rand_seed))
 753                 td->o.rand_repeatable = 0;
 754
 755         if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
 756                 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
 757                 ret = 1;
 758         }
 759
 760         if (fio_option_is_set(o, gtod_cpu)) {
 761                 fio_gtod_init();
 762                 fio_gtod_set_cpu(o->gtod_cpu);
 763                 fio_gtod_offload = 1;
 764         }
 765
 766         td->loops = o->loops;
 767         if (!td->loops)
 768                 td->loops = 1;
 769
 770         if (td->o.block_error_hist && td->o.nr_files != 1) {
 771                 log_err("fio: block error histogram only available with "
 772                         "with a single file per job, but %d files "
 773                         "provided\n", td->o.nr_files);
 774                 ret = 1;
 775         }
 776
 777         return ret;
 778 }
 779
 780 /*
 781  * This function leaks the buffer
 782  */
 783 char *fio_uint_to_kmg(unsigned int val)
 784 {
 785         char *buf = malloc(32);
 786         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 787         char *p = post;
 788
 789         do {
 790                 if (val & 1023)
 791                         break;
 792
 793                 val >>= 10;
 794                 p++;
 795         } while (*p);
 796
 797         snprintf(buf, 32, "%u%c", val, *p);
 798         return buf;
 799 }
 800
 801 /* External engines are specified by "external:name.o") */
 802 static const char *get_engine_name(const char *str)
 803 {
 804         char *p = strstr(str, ":");
 805
 806         if (!p)
 807                 return str;
 808
 809         p++;
 810         strip_blank_front(&p);
 811         strip_blank_end(p);
 812         return p;
 813 }
 814
 815 static int exists_and_not_file(const char *filename)
 816 {
 817         struct stat sb;
 818
 819         if (lstat(filename, &sb) == -1)
 820                 return 0;
 821
 822         /* \\.\ is the device namespace in Windows, where every file
 823          * is a device node */
 824         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
 825                 return 0;
 826
 827         return 1;
 828 }
 829
 830 static void td_fill_rand_seeds_internal(struct thread_data *td)
 831 {
 832         init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
 833         init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
 834         init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
 835
 836         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 837                 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
 838
 839         init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
 840         init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
 841         init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
 842
 843         if (!td_random(td))
 844                 return;
 845
 846         if (td->o.rand_repeatable)
 847                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
 848
 849         init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
 850         init_rand_seed(&td->seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
 851         init_rand_seed(&td->seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
 852         init_rand_seed(&td->seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
 853 }
 854
 855 void td_fill_rand_seeds(struct thread_data *td)
 856 {
 857         if (td->o.allrand_repeatable) {
 858                 unsigned int i;
 859
 860                 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
 861                         td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
 862                                 + i;
 863         }
 864
 865         td_fill_rand_seeds_internal(td);
 866
 867         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
 868         frand_copy(&td->buf_state_prev, &td->buf_state);
 869
 870         init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF]);
 871 }
 872
 873 /*
 874  * Initializes the ioengine configured for a job, if it has not been done so
 875  * already.
 876  */
 877 int ioengine_load(struct thread_data *td)
 878 {
 879         const char *engine;
 880
 881         /*
 882          * Engine has already been loaded.
 883          */
 884         if (td->io_ops)
 885                 return 0;
 886         if (!td->o.ioengine) {
 887                 log_err("fio: internal fault, no IO engine specified\n");
 888                 return 1;
 889         }
 890
 891         engine = get_engine_name(td->o.ioengine);
 892         td->io_ops = load_ioengine(td, engine);
 893         if (!td->io_ops) {
 894                 log_err("fio: failed to load engine %s\n", engine);
 895                 return 1;
 896         }
 897
 898         if (td->io_ops->option_struct_size && td->io_ops->options) {
 899                 /*
 900                  * In cases where td->eo is set, clone it for a child thread.
 901                  * This requires that the parent thread has the same ioengine,
 902                  * but that requirement must be enforced by the code which
 903                  * cloned the thread.
 904                  */
 905                 void *origeo = td->eo;
 906                 /*
 907                  * Otherwise use the default thread options.
 908                  */
 909                 if (!origeo && td != &def_thread && def_thread.eo &&
 910                     def_thread.io_ops->options == td->io_ops->options)
 911                         origeo = def_thread.eo;
 912
 913                 options_init(td->io_ops->options);
 914                 td->eo = malloc(td->io_ops->option_struct_size);
 915                 /*
 916                  * Use the default thread as an option template if this uses the
 917                  * same options structure and there are non-default options
 918                  * used.
 919                  */
 920                 if (origeo) {
 921                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
 922                         options_mem_dupe(td->eo, td->io_ops->options);
 923                 } else {
 924                         memset(td->eo, 0, td->io_ops->option_struct_size);
 925                         fill_default_options(td->eo, td->io_ops->options);
 926                 }
 927                 *(struct thread_data **)td->eo = td;
 928         }
 929
 930         return 0;
 931 }
 932
 933 static void init_flags(struct thread_data *td)
 934 {
 935         struct thread_options *o = &td->o;
 936
 937         if (o->verify_backlog)
 938                 td->flags |= TD_F_VER_BACKLOG;
 939         if (o->trim_backlog)
 940                 td->flags |= TD_F_TRIM_BACKLOG;
 941         if (o->read_iolog_file)
 942                 td->flags |= TD_F_READ_IOLOG;
 943         if (o->refill_buffers)
 944                 td->flags |= TD_F_REFILL_BUFFERS;
 945         /*
 946          * Always scramble buffers if asked to
 947          */
 948         if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
 949                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 950         /*
 951          * But also scramble buffers, unless we were explicitly asked
 952          * to zero them.
 953          */
 954         if (o->scramble_buffers && !(o->zero_buffers &&
 955             fio_option_is_set(o, zero_buffers)))
 956                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
 957         if (o->verify != VERIFY_NONE)
 958                 td->flags |= TD_F_VER_NONE;
 959
 960         if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
 961                 td->flags |= TD_F_NEED_LOCK;
 962 }
 963
 964 static int setup_random_seeds(struct thread_data *td)
 965 {
 966         unsigned long seed;
 967         unsigned int i;
 968
 969         if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
 970                 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
 971
 972         seed = td->o.rand_seed;
 973         for (i = 0; i < 4; i++)
 974                 seed *= 0x9e370001UL;
 975
 976         for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
 977                 td->rand_seeds[i] = seed;
 978                 seed *= 0x9e370001UL;
 979         }
 980
 981         td_fill_rand_seeds(td);
 982         return 0;
 983 }
 984
 985 enum {
 986         FPRE_NONE = 0,
 987         FPRE_JOBNAME,
 988         FPRE_JOBNUM,
 989         FPRE_FILENUM
 990 };
 991
 992 static struct fpre_keyword {
 993         const char *keyword;
 994         size_t strlen;
 995         int key;
 996 } fpre_keywords[] = {
 997         { .keyword = "$jobname",        .key = FPRE_JOBNAME, },
 998         { .keyword = "$jobnum",         .key = FPRE_JOBNUM, },
 999         { .keyword = "$filenum",        .key = FPRE_FILENUM, },
1000         { .keyword = NULL, },
1001         };
1002
1003 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1004                            const char *jobname, int jobnum, int filenum)
1005 {
1006         struct fpre_keyword *f;
1007         char copy[PATH_MAX];
1008         size_t dst_left = PATH_MAX - 1;
1009
1010         if (!o->filename_format || !strlen(o->filename_format)) {
1011                 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1012                 return NULL;
1013         }
1014
1015         for (f = &fpre_keywords[0]; f->keyword; f++)
1016                 f->strlen = strlen(f->keyword);
1017
1018         buf[buf_size - 1] = '\0';
1019         strncpy(buf, o->filename_format, buf_size - 1);
1020
1021         memset(copy, 0, sizeof(copy));
1022         for (f = &fpre_keywords[0]; f->keyword; f++) {
1023                 do {
1024                         size_t pre_len, post_start = 0;
1025                         char *str, *dst = copy;
1026
1027                         str = strcasestr(buf, f->keyword);
1028                         if (!str)
1029                                 break;
1030
1031                         pre_len = str - buf;
1032                         if (strlen(str) != f->strlen)
1033                                 post_start = pre_len + f->strlen;
1034
1035                         if (pre_len) {
1036                                 strncpy(dst, buf, pre_len);
1037                                 dst += pre_len;
1038                                 dst_left -= pre_len;
1039                         }
1040
1041                         switch (f->key) {
1042                         case FPRE_JOBNAME: {
1043                                 int ret;
1044
1045                                 ret = snprintf(dst, dst_left, "%s", jobname);
1046                                 if (ret < 0)
1047                                         break;
1048                                 else if (ret > dst_left) {
1049                                         log_err("fio: truncated filename\n");
1050                                         dst += dst_left;
1051                                         dst_left = 0;
1052                                 } else {
1053                                         dst += ret;
1054                                         dst_left -= ret;
1055                                 }
1056                                 break;
1057                                 }
1058                         case FPRE_JOBNUM: {
1059                                 int ret;
1060
1061                                 ret = snprintf(dst, dst_left, "%d", jobnum);
1062                                 if (ret < 0)
1063                                         break;
1064                                 else if (ret > dst_left) {
1065                                         log_err("fio: truncated filename\n");
1066                                         dst += dst_left;
1067                                         dst_left = 0;
1068                                 } else {
1069                                         dst += ret;
1070                                         dst_left -= ret;
1071                                 }
1072                                 break;
1073                                 }
1074                         case FPRE_FILENUM: {
1075                                 int ret;
1076
1077                                 ret = snprintf(dst, dst_left, "%d", filenum);
1078                                 if (ret < 0)
1079                                         break;
1080                                 else if (ret > dst_left) {
1081                                         log_err("fio: truncated filename\n");
1082                                         dst += dst_left;
1083                                         dst_left = 0;
1084                                 } else {
1085                                         dst += ret;
1086                                         dst_left -= ret;
1087                                 }
1088                                 break;
1089                                 }
1090                         default:
1091                                 assert(0);
1092                                 break;
1093                         }
1094
1095                         if (post_start)
1096                                 strncpy(dst, buf + post_start, dst_left);
1097
1098                         strncpy(buf, copy, buf_size - 1);
1099                 } while (1);
1100         }
1101
1102         return buf;
1103 }
1104
1105 int parse_dryrun(void)
1106 {
1107         return dump_cmdline || parse_only;
1108 }
1109
1110 static void gen_log_name(char *name, size_t size, const char *logtype,
1111                          const char *logname, unsigned int num,
1112                          const char *suf, int per_job)
1113 {
1114         if (per_job)
1115                 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1116         else
1117                 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1118 }
1119
1120 /*
1121  * Adds a job to the list of things todo. Sanitizes the various options
1122  * to make sure we don't have conflicts, and initializes various
1123  * members of td.
1124  */
1125 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1126                    int recursed, int client_type)
1127 {
1128         unsigned int i;
1129         char fname[PATH_MAX];
1130         int numjobs, file_alloced;
1131         struct thread_options *o = &td->o;
1132         char logname[PATH_MAX + 32];
1133
1134         /*
1135          * the def_thread is just for options, it's not a real job
1136          */
1137         if (td == &def_thread)
1138                 return 0;
1139
1140         init_flags(td);
1141
1142         /*
1143          * if we are just dumping the output command line, don't add the job
1144          */
1145         if (parse_dryrun()) {
1146                 put_job(td);
1147                 return 0;
1148         }
1149
1150         td->client_type = client_type;
1151
1152         if (profile_td_init(td))
1153                 goto err;
1154
1155         if (ioengine_load(td))
1156                 goto err;
1157
1158         if (o->odirect)
1159                 td->io_ops->flags |= FIO_RAWIO;
1160
1161         file_alloced = 0;
1162         if (!o->filename && !td->files_index && !o->read_iolog_file) {
1163                 file_alloced = 1;
1164
1165                 if (o->nr_files == 1 && exists_and_not_file(jobname))
1166                         add_file(td, jobname, job_add_num, 0);
1167                 else {
1168                         for (i = 0; i < o->nr_files; i++)
1169                                 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1170                 }
1171         }
1172
1173         if (fixup_options(td))
1174                 goto err;
1175
1176         flow_init_job(td);
1177
1178         /*
1179          * IO engines only need this for option callbacks, and the address may
1180          * change in subprocesses.
1181          */
1182         if (td->eo)
1183                 *(struct thread_data **)td->eo = NULL;
1184
1185         if (td->io_ops->flags & FIO_DISKLESSIO) {
1186                 struct fio_file *f;
1187
1188                 for_each_file(td, f, i)
1189                         f->real_file_size = -1ULL;
1190         }
1191
1192         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1193
1194         td->ts.clat_percentiles = o->clat_percentiles;
1195         td->ts.percentile_precision = o->percentile_precision;
1196         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1197
1198         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1199                 td->ts.clat_stat[i].min_val = ULONG_MAX;
1200                 td->ts.slat_stat[i].min_val = ULONG_MAX;
1201                 td->ts.lat_stat[i].min_val = ULONG_MAX;
1202                 td->ts.bw_stat[i].min_val = ULONG_MAX;
1203         }
1204         td->ddir_seq_nr = o->ddir_seq_nr;
1205
1206         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1207                 prev_group_jobs = 0;
1208                 groupid++;
1209         }
1210
1211         td->groupid = groupid;
1212         prev_group_jobs++;
1213
1214         if (setup_random_seeds(td)) {
1215                 td_verror(td, errno, "init_random_state");
1216                 goto err;
1217         }
1218
1219         if (setup_rate(td))
1220                 goto err;
1221
1222         if (o->lat_log_file) {
1223                 struct log_params p = {
1224                         .td = td,
1225                         .avg_msec = o->log_avg_msec,
1226                         .log_type = IO_LOG_TYPE_LAT,
1227                         .log_offset = o->log_offset,
1228                         .log_gz = o->log_gz,
1229                         .log_gz_store = o->log_gz_store,
1230                 };
1231                 const char *suf;
1232
1233                 if (p.log_gz_store)
1234                         suf = "log.fz";
1235                 else
1236                         suf = "log";
1237
1238                 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1239                                 td->thread_number, suf, o->per_job_logs);
1240                 setup_log(&td->lat_log, &p, logname);
1241
1242                 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1243                                 td->thread_number, suf, o->per_job_logs);
1244                 setup_log(&td->slat_log, &p, logname);
1245
1246                 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1247                                 td->thread_number, suf, o->per_job_logs);
1248                 setup_log(&td->clat_log, &p, logname);
1249         }
1250         if (o->bw_log_file) {
1251                 struct log_params p = {
1252                         .td = td,
1253                         .avg_msec = o->log_avg_msec,
1254                         .log_type = IO_LOG_TYPE_BW,
1255                         .log_offset = o->log_offset,
1256                         .log_gz = o->log_gz,
1257                         .log_gz_store = o->log_gz_store,
1258                 };
1259                 const char *suf;
1260
1261                 if (p.log_gz_store)
1262                         suf = "log.fz";
1263                 else
1264                         suf = "log";
1265
1266                 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1267                                 td->thread_number, suf, o->per_job_logs);
1268                 setup_log(&td->bw_log, &p, logname);
1269         }
1270         if (o->iops_log_file) {
1271                 struct log_params p = {
1272                         .td = td,
1273                         .avg_msec = o->log_avg_msec,
1274                         .log_type = IO_LOG_TYPE_IOPS,
1275                         .log_offset = o->log_offset,
1276                         .log_gz = o->log_gz,
1277                         .log_gz_store = o->log_gz_store,
1278                 };
1279                 const char *suf;
1280
1281                 if (p.log_gz_store)
1282                         suf = "log.fz";
1283                 else
1284                         suf = "log";
1285
1286                 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1287                                 td->thread_number, suf, o->per_job_logs);
1288                 setup_log(&td->iops_log, &p, logname);
1289         }
1290
1291         if (!o->name)
1292                 o->name = strdup(jobname);
1293
1294         if (output_format == FIO_OUTPUT_NORMAL) {
1295                 if (!job_add_num) {
1296                         if (is_backend && !recursed)
1297                                 fio_server_send_add_job(td);
1298
1299                         if (!(td->io_ops->flags & FIO_NOIO)) {
1300                                 char *c1, *c2, *c3, *c4;
1301                                 char *c5 = NULL, *c6 = NULL;
1302
1303                                 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1304                                 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1305                                 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1306                                 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1307
1308                                 if (!o->bs_is_seq_rand) {
1309                                         c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1310                                         c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1311                                 }
1312
1313                                 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1314                                                         td->groupid,
1315                                                         ddir_str(o->td_ddir));
1316
1317                                 if (o->bs_is_seq_rand)
1318                                         log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1319                                                         c1, c2, c3, c4);
1320                                 else
1321                                         log_info("bs=%s-%s/%s-%s/%s-%s, ",
1322                                                         c1, c2, c3, c4, c5, c6);
1323
1324                                 log_info("ioengine=%s, iodepth=%u\n",
1325                                                 td->io_ops->name, o->iodepth);
1326
1327                                 free(c1);
1328                                 free(c2);
1329                                 free(c3);
1330                                 free(c4);
1331                                 free(c5);
1332                                 free(c6);
1333                         }
1334                 } else if (job_add_num == 1)
1335                         log_info("...\n");
1336         }
1337
1338         /*
1339          * recurse add identical jobs, clear numjobs and stonewall options
1340          * as they don't apply to sub-jobs
1341          */
1342         numjobs = o->numjobs;
1343         while (--numjobs) {
1344                 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1345
1346                 if (!td_new)
1347                         goto err;
1348
1349                 td_new->o.numjobs = 1;
1350                 td_new->o.stonewall = 0;
1351                 td_new->o.new_group = 0;
1352                 td_new->subjob_number = numjobs;
1353
1354                 if (file_alloced) {
1355                         if (td_new->files) {
1356                                 struct fio_file *f;
1357                                 for_each_file(td_new, f, i) {
1358                                         if (f->file_name)
1359                                                 sfree(f->file_name);
1360                                         sfree(f);
1361                                 }
1362                                 free(td_new->files);
1363                                 td_new->files = NULL;
1364                         }
1365                         td_new->files_index = 0;
1366                         td_new->files_size = 0;
1367                         if (td_new->o.filename) {
1368                                 free(td_new->o.filename);
1369                                 td_new->o.filename = NULL;
1370                         }
1371                 }
1372
1373                 if (add_job(td_new, jobname, numjobs, 1, client_type))
1374                         goto err;
1375         }
1376
1377         return 0;
1378 err:
1379         put_job(td);
1380         return -1;
1381 }
1382
1383 /*
1384  * Parse as if 'o' was a command line
1385  */
1386 void add_job_opts(const char **o, int client_type)
1387 {
1388         struct thread_data *td, *td_parent;
1389         int i, in_global = 1;
1390         char jobname[32];
1391
1392         i = 0;
1393         td_parent = td = NULL;
1394         while (o[i]) {
1395                 if (!strncmp(o[i], "name", 4)) {
1396                         in_global = 0;
1397                         if (td)
1398                                 add_job(td, jobname, 0, 0, client_type);
1399                         td = NULL;
1400                         sprintf(jobname, "%s", o[i] + 5);
1401                 }
1402                 if (in_global && !td_parent)
1403                         td_parent = get_new_job(1, &def_thread, 0, jobname);
1404                 else if (!in_global && !td) {
1405                         if (!td_parent)
1406                                 td_parent = &def_thread;
1407                         td = get_new_job(0, td_parent, 0, jobname);
1408                 }
1409                 if (in_global)
1410                         fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1411                 else
1412                         fio_options_parse(td, (char **) &o[i], 1, 0);
1413                 i++;
1414         }
1415
1416         if (td)
1417                 add_job(td, jobname, 0, 0, client_type);
1418 }
1419
1420 static int skip_this_section(const char *name)
1421 {
1422         int i;
1423
1424         if (!nr_job_sections)
1425                 return 0;
1426         if (!strncmp(name, "global", 6))
1427                 return 0;
1428
1429         for (i = 0; i < nr_job_sections; i++)
1430                 if (!strcmp(job_sections[i], name))
1431                         return 0;
1432
1433         return 1;
1434 }
1435
1436 static int is_empty_or_comment(char *line)
1437 {
1438         unsigned int i;
1439
1440         for (i = 0; i < strlen(line); i++) {
1441                 if (line[i] == ';')
1442                         return 1;
1443                 if (line[i] == '#')
1444                         return 1;
1445                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1446                         return 0;
1447         }
1448
1449         return 1;
1450 }
1451
1452 /*
1453  * This is our [ini] type file parser.
1454  */
1455 int __parse_jobs_ini(struct thread_data *td,
1456                 char *file, int is_buf, int stonewall_flag, int type,
1457                 int nested, char *name, char ***popts, int *aopts, int *nopts)
1458 {
1459         unsigned int global = 0;
1460         char *string;
1461         FILE *f;
1462         char *p;
1463         int ret = 0, stonewall;
1464         int first_sect = 1;
1465         int skip_fgets = 0;
1466         int inside_skip = 0;
1467         char **opts;
1468         int i, alloc_opts, num_opts;
1469
1470         dprint(FD_PARSE, "Parsing ini file %s\n", file);
1471         assert(td || !nested);
1472
1473         if (is_buf)
1474                 f = NULL;
1475         else {
1476                 if (!strcmp(file, "-"))
1477                         f = stdin;
1478                 else
1479                         f = fopen(file, "r");
1480
1481                 if (!f) {
1482                         int __err = errno;
1483
1484                         log_err("fio: unable to open '%s' job file\n", file);
1485                         if (td)
1486                                 td_verror(td, __err, "job file open");
1487                         return 1;
1488                 }
1489         }
1490
1491         string = malloc(4096);
1492
1493         /*
1494          * it's really 256 + small bit, 280 should suffice
1495          */
1496         if (!nested) {
1497                 name = malloc(280);
1498                 memset(name, 0, 280);
1499         }
1500
1501         opts = NULL;
1502         if (nested && popts) {
1503                 opts = *popts;
1504                 alloc_opts = *aopts;
1505                 num_opts = *nopts;
1506         }
1507
1508         if (!opts) {
1509                 alloc_opts = 8;
1510                 opts = malloc(sizeof(char *) * alloc_opts);
1511                 num_opts = 0;
1512         }
1513
1514         stonewall = stonewall_flag;
1515         do {
1516                 /*
1517                  * if skip_fgets is set, we already have loaded a line we
1518                  * haven't handled.
1519                  */
1520                 if (!skip_fgets) {
1521                         if (is_buf)
1522                                 p = strsep(&file, "\n");
1523                         else
1524                                 p = fgets(string, 4096, f);
1525                         if (!p)
1526                                 break;
1527                 }
1528
1529                 skip_fgets = 0;
1530                 strip_blank_front(&p);
1531                 strip_blank_end(p);
1532
1533                 dprint(FD_PARSE, "%s\n", p);
1534                 if (is_empty_or_comment(p))
1535                         continue;
1536
1537                 if (!nested) {
1538                         if (sscanf(p, "[%255[^\n]]", name) != 1) {
1539                                 if (inside_skip)
1540                                         continue;
1541
1542                                 log_err("fio: option <%s> outside of "
1543                                         "[] job section\n", p);
1544                                 ret = 1;
1545                                 break;
1546                         }
1547
1548                         name[strlen(name) - 1] = '\0';
1549
1550                         if (skip_this_section(name)) {
1551                                 inside_skip = 1;
1552                                 continue;
1553                         } else
1554                                 inside_skip = 0;
1555
1556                         dprint(FD_PARSE, "Parsing section [%s]\n", name);
1557
1558                         global = !strncmp(name, "global", 6);
1559
1560                         if (dump_cmdline) {
1561                                 if (first_sect)
1562                                         log_info("fio ");
1563                                 if (!global)
1564                                         log_info("--name=%s ", name);
1565                                 first_sect = 0;
1566                         }
1567
1568                         td = get_new_job(global, &def_thread, 0, name);
1569                         if (!td) {
1570                                 ret = 1;
1571                                 break;
1572                         }
1573
1574                         /*
1575                          * Separate multiple job files by a stonewall
1576                          */
1577                         if (!global && stonewall) {
1578                                 td->o.stonewall = stonewall;
1579                                 stonewall = 0;
1580                         }
1581
1582                         num_opts = 0;
1583                         memset(opts, 0, alloc_opts * sizeof(char *));
1584                 }
1585                 else
1586                         skip_fgets = 1;
1587
1588                 while (1) {
1589                         if (!skip_fgets) {
1590                                 if (is_buf)
1591                                         p = strsep(&file, "\n");
1592                                 else
1593                                         p = fgets(string, 4096, f);
1594                                 if (!p)
1595                                         break;
1596                                 dprint(FD_PARSE, "%s", p);
1597                         }
1598                         else
1599                                 skip_fgets = 0;
1600
1601                         if (is_empty_or_comment(p))
1602                                 continue;
1603
1604                         strip_blank_front(&p);
1605
1606                         /*
1607                          * new section, break out and make sure we don't
1608                          * fgets() a new line at the top.
1609                          */
1610                         if (p[0] == '[') {
1611                                 if (nested) {
1612                                         log_err("No new sections in included files\n");
1613                                         return 1;
1614                                 }
1615
1616                                 skip_fgets = 1;
1617                                 break;
1618                         }
1619
1620                         strip_blank_end(p);
1621
1622                         if (!strncmp(p, "include", strlen("include"))) {
1623                                 char *filename = p + strlen("include") + 1;
1624
1625                                 if ((ret = __parse_jobs_ini(td, filename,
1626                                                 is_buf, stonewall_flag, type, 1,
1627                                                 name, &opts, &alloc_opts, &num_opts))) {
1628                                         log_err("Error %d while parsing include file %s\n",
1629                                                 ret, filename);
1630                                         break;
1631                                 }
1632                                 continue;
1633                         }
1634
1635                         if (num_opts == alloc_opts) {
1636                                 alloc_opts <<= 1;
1637                                 opts = realloc(opts,
1638                                                 alloc_opts * sizeof(char *));
1639                         }
1640
1641                         opts[num_opts] = strdup(p);
1642                         num_opts++;
1643                 }
1644
1645                 if (nested) {
1646                         *popts = opts;
1647                         *aopts = alloc_opts;
1648                         *nopts = num_opts;
1649                         goto out;
1650                 }
1651
1652                 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1653                 if (!ret)
1654                         ret = add_job(td, name, 0, 0, type);
1655                 else {
1656                         log_err("fio: job %s dropped\n", name);
1657                         put_job(td);
1658                 }
1659
1660                 for (i = 0; i < num_opts; i++)
1661                         free(opts[i]);
1662                 num_opts = 0;
1663         } while (!ret);
1664
1665         if (dump_cmdline)
1666                 log_info("\n");
1667
1668         i = 0;
1669         while (i < nr_job_sections) {
1670                 free(job_sections[i]);
1671                 i++;
1672         }
1673
1674         free(opts);
1675 out:
1676         free(string);
1677         if (!nested)
1678                 free(name);
1679         if (!is_buf && f != stdin)
1680                 fclose(f);
1681         return ret;
1682 }
1683
1684 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1685 {
1686         return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1687                         0, NULL, NULL, NULL, NULL);
1688 }
1689
1690 static int fill_def_thread(void)
1691 {
1692         memset(&def_thread, 0, sizeof(def_thread));
1693
1694         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1695         def_thread.o.error_dump = 1;
1696
1697         /*
1698          * fill default options
1699          */
1700         fio_fill_default_options(&def_thread);
1701         return 0;
1702 }
1703
1704 static void usage(const char *name)
1705 {
1706         printf("%s\n", fio_version_string);
1707         printf("%s [options] [job options] <job file(s)>\n", name);
1708         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1709                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1710                 "\t\t\tdiskutil,job,mutex,profile,time,net,rate,compress\n");
1711         printf("  --parse-only\t\tParse options only, don't start any IO\n");
1712         printf("  --output\t\tWrite output to file\n");
1713         printf("  --runtime\t\tRuntime in seconds\n");
1714         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1715         printf("  --minimal\t\tMinimal (terse) output\n");
1716         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1717         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1718         printf("  --version\t\tPrint version info and exit\n");
1719         printf("  --help\t\tPrint this page\n");
1720         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
1721         printf("  --crctest\t\tTest speed of checksum functions\n");
1722         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1723                 " them\n");
1724         printf("  --enghelp=engine\tPrint ioengine help, or list"
1725                 " available ioengines\n");
1726         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1727                 " cmd\n");
1728         printf("  --showcmd\t\tTurn a job file into command line options\n");
1729         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1730         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1731         printf("  --eta-newline=time\tForce a new line for every 'time'");
1732         printf(" period passed\n");
1733         printf("  --status-interval=t\tForce full status dump every");
1734         printf(" 't' period passed\n");
1735         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1736                 " writes\n");
1737         printf("  --section=name\tOnly run specified section in job file\n");
1738         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1739                 " (def 1024)\n");
1740         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1741         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1742         printf("  --server=args\t\tStart a backend fio server\n");
1743         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1744         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1745         printf("  --remote-config=file\tTell fio server to load this local job file\n");
1746         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1747                 "\t\t\t(option=system,percpu) or run unit work\n"
1748                 "\t\t\tcalibration only (option=calibrate)\n");
1749 #ifdef CONFIG_ZLIB
1750         printf("  --inflate-log=log\tInflate and output compressed log\n");
1751 #endif
1752         printf("  --trigger-file=file\tExecute trigger cmd when file exists\n");
1753         printf("  --trigger-timeout=t\tExecute trigger af this time\n");
1754         printf("  --trigger=cmd\t\tSet this command as local trigger\n");
1755         printf("  --trigger-remote=cmd\tSet this command as remote trigger\n");
1756         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1757         printf("\n                   Jens Axboe <jaxboe@fusionio.com>");
1758         printf("\n                   Jens Axboe <axboe@fb.com>\n");
1759 }
1760
1761 #ifdef FIO_INC_DEBUG
1762 struct debug_level debug_levels[] = {
1763         { .name = "process",
1764           .help = "Process creation/exit logging",
1765           .shift = FD_PROCESS,
1766         },
1767         { .name = "file",
1768           .help = "File related action logging",
1769           .shift = FD_FILE,
1770         },
1771         { .name = "io",
1772           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1773           .shift = FD_IO,
1774         },
1775         { .name = "mem",
1776           .help = "Memory allocation/freeing logging",
1777           .shift = FD_MEM,
1778         },
1779         { .name = "blktrace",
1780           .help = "blktrace action logging",
1781           .shift = FD_BLKTRACE,
1782         },
1783         { .name = "verify",
1784           .help = "IO verification action logging",
1785           .shift = FD_VERIFY,
1786         },
1787         { .name = "random",
1788           .help = "Random generation logging",
1789           .shift = FD_RANDOM,
1790         },
1791         { .name = "parse",
1792           .help = "Parser logging",
1793           .shift = FD_PARSE,
1794         },
1795         { .name = "diskutil",
1796           .help = "Disk utility logging actions",
1797           .shift = FD_DISKUTIL,
1798         },
1799         { .name = "job",
1800           .help = "Logging related to creating/destroying jobs",
1801           .shift = FD_JOB,
1802         },
1803         { .name = "mutex",
1804           .help = "Mutex logging",
1805           .shift = FD_MUTEX
1806         },
1807         { .name = "profile",
1808           .help = "Logging related to profiles",
1809           .shift = FD_PROFILE,
1810         },
1811         { .name = "time",
1812           .help = "Logging related to time keeping functions",
1813           .shift = FD_TIME,
1814         },
1815         { .name = "net",
1816           .help = "Network logging",
1817           .shift = FD_NET,
1818         },
1819         { .name = "rate",
1820           .help = "Rate logging",
1821           .shift = FD_RATE,
1822         },
1823         { .name = "compress",
1824           .help = "Log compression logging",
1825           .shift = FD_COMPRESS,
1826         },
1827         { .name = NULL, },
1828 };
1829
1830 static int set_debug(const char *string)
1831 {
1832         struct debug_level *dl;
1833         char *p = (char *) string;
1834         char *opt;
1835         int i;
1836
1837         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1838                 log_info("fio: dumping debug options:");
1839                 for (i = 0; debug_levels[i].name; i++) {
1840                         dl = &debug_levels[i];
1841                         log_info("%s,", dl->name);
1842                 }
1843                 log_info("all\n");
1844                 return 1;
1845         }
1846
1847         while ((opt = strsep(&p, ",")) != NULL) {
1848                 int found = 0;
1849
1850                 if (!strncmp(opt, "all", 3)) {
1851                         log_info("fio: set all debug options\n");
1852                         fio_debug = ~0UL;
1853                         continue;
1854                 }
1855
1856                 for (i = 0; debug_levels[i].name; i++) {
1857                         dl = &debug_levels[i];
1858                         found = !strncmp(opt, dl->name, strlen(dl->name));
1859                         if (!found)
1860                                 continue;
1861
1862                         if (dl->shift == FD_JOB) {
1863                                 opt = strchr(opt, ':');
1864                                 if (!opt) {
1865                                         log_err("fio: missing job number\n");
1866                                         break;
1867                                 }
1868                                 opt++;
1869                                 fio_debug_jobno = atoi(opt);
1870                                 log_info("fio: set debug jobno %d\n",
1871                                                         fio_debug_jobno);
1872                         } else {
1873                                 log_info("fio: set debug option %s\n", opt);
1874                                 fio_debug |= (1UL << dl->shift);
1875                         }
1876                         break;
1877                 }
1878
1879                 if (!found)
1880                         log_err("fio: debug mask %s not found\n", opt);
1881         }
1882         return 0;
1883 }
1884 #else
1885 static int set_debug(const char *string)
1886 {
1887         log_err("fio: debug tracing not included in build\n");
1888         return 1;
1889 }
1890 #endif
1891
1892 static void fio_options_fill_optstring(void)
1893 {
1894         char *ostr = cmd_optstr;
1895         int i, c;
1896
1897         c = i = 0;
1898         while (l_opts[i].name) {
1899                 ostr[c++] = l_opts[i].val;
1900                 if (l_opts[i].has_arg == required_argument)
1901                         ostr[c++] = ':';
1902                 else if (l_opts[i].has_arg == optional_argument) {
1903                         ostr[c++] = ':';
1904                         ostr[c++] = ':';
1905                 }
1906                 i++;
1907         }
1908         ostr[c] = '\0';
1909 }
1910
1911 static int client_flag_set(char c)
1912 {
1913         int i;
1914
1915         i = 0;
1916         while (l_opts[i].name) {
1917                 int val = l_opts[i].val;
1918
1919                 if (c == (val & 0xff))
1920                         return (val & FIO_CLIENT_FLAG);
1921
1922                 i++;
1923         }
1924
1925         return 0;
1926 }
1927
1928 static void parse_cmd_client(void *client, char *opt)
1929 {
1930         fio_client_add_cmd_option(client, opt);
1931 }
1932
1933 static void show_closest_option(const char *name)
1934 {
1935         int best_option, best_distance;
1936         int i, distance;
1937
1938         while (*name == '-')
1939                 name++;
1940
1941         best_option = -1;
1942         best_distance = INT_MAX;
1943         i = 0;
1944         while (l_opts[i].name) {
1945                 distance = string_distance(name, l_opts[i].name);
1946                 if (distance < best_distance) {
1947                         best_distance = distance;
1948                         best_option = i;
1949                 }
1950                 i++;
1951         }
1952
1953         if (best_option != -1)
1954                 log_err("Did you mean %s?\n", l_opts[best_option].name);
1955 }
1956
1957 int parse_cmd_line(int argc, char *argv[], int client_type)
1958 {
1959         struct thread_data *td = NULL;
1960         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1961         char *ostr = cmd_optstr;
1962         void *pid_file = NULL;
1963         void *cur_client = NULL;
1964         int backend = 0;
1965
1966         /*
1967          * Reset optind handling, since we may call this multiple times
1968          * for the backend.
1969          */
1970         optind = 1;
1971
1972         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1973                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1974                         parse_cmd_client(cur_client, argv[optind - 1]);
1975                         c &= ~FIO_CLIENT_FLAG;
1976                 }
1977
1978                 switch (c) {
1979                 case 'a':
1980                         smalloc_pool_size = atoi(optarg);
1981                         break;
1982                 case 't':
1983                         if (check_str_time(optarg, &def_timeout, 1)) {
1984                                 log_err("fio: failed parsing time %s\n", optarg);
1985                                 do_exit++;
1986                                 exit_val = 1;
1987                         }
1988                         break;
1989                 case 'l':
1990                         log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
1991                         do_exit++;
1992                         exit_val = 1;
1993                         break;
1994                 case 'b':
1995                         write_bw_log = 1;
1996                         break;
1997                 case 'o':
1998                         if (f_out && f_out != stdout)
1999                                 fclose(f_out);
2000
2001                         f_out = fopen(optarg, "w+");
2002                         if (!f_out) {
2003                                 perror("fopen output");
2004                                 exit(1);
2005                         }
2006                         f_err = f_out;
2007                         break;
2008                 case 'm':
2009                         output_format = FIO_OUTPUT_TERSE;
2010                         break;
2011                 case 'F':
2012                         if (!optarg) {
2013                                 log_err("fio: missing --output-format argument\n");
2014                                 exit_val = 1;
2015                                 do_exit++;
2016                                 break;
2017                         }
2018                         if (!strcmp(optarg, "minimal") ||
2019                             !strcmp(optarg, "terse") ||
2020                             !strcmp(optarg, "csv"))
2021                                 output_format = FIO_OUTPUT_TERSE;
2022                         else if (!strcmp(optarg, "json"))
2023                                 output_format = FIO_OUTPUT_JSON;
2024                         else
2025                                 output_format = FIO_OUTPUT_NORMAL;
2026                         break;
2027                 case 'f':
2028                         append_terse_output = 1;
2029                         break;
2030                 case 'h':
2031                         did_arg = 1;
2032                         if (!cur_client) {
2033                                 usage(argv[0]);
2034                                 do_exit++;
2035                         }
2036                         break;
2037                 case 'c':
2038                         did_arg = 1;
2039                         if (!cur_client) {
2040                                 fio_show_option_help(optarg);
2041                                 do_exit++;
2042                         }
2043                         break;
2044                 case 'i':
2045                         did_arg = 1;
2046                         if (!cur_client) {
2047                                 fio_show_ioengine_help(optarg);
2048                                 do_exit++;
2049                         }
2050                         break;
2051                 case 's':
2052                         did_arg = 1;
2053                         dump_cmdline = 1;
2054                         break;
2055                 case 'r':
2056                         read_only = 1;
2057                         break;
2058                 case 'v':
2059                         did_arg = 1;
2060                         if (!cur_client) {
2061                                 log_info("%s\n", fio_version_string);
2062                                 do_exit++;
2063                         }
2064                         break;
2065                 case 'V':
2066                         terse_version = atoi(optarg);
2067                         if (!(terse_version == 2 || terse_version == 3 ||
2068                              terse_version == 4)) {
2069                                 log_err("fio: bad terse version format\n");
2070                                 exit_val = 1;
2071                                 do_exit++;
2072                         }
2073                         break;
2074                 case 'e':
2075                         if (!strcmp("always", optarg))
2076                                 eta_print = FIO_ETA_ALWAYS;
2077                         else if (!strcmp("never", optarg))
2078                                 eta_print = FIO_ETA_NEVER;
2079                         break;
2080                 case 'E': {
2081                         long long t = 0;
2082
2083                         if (check_str_time(optarg, &t, 1)) {
2084                                 log_err("fio: failed parsing eta time %s\n", optarg);
2085                                 exit_val = 1;
2086                                 do_exit++;
2087                         }
2088                         eta_new_line = t / 1000;
2089                         break;
2090                         }
2091                 case 'd':
2092                         if (set_debug(optarg))
2093                                 do_exit++;
2094                         break;
2095                 case 'P':
2096                         did_arg = 1;
2097                         parse_only = 1;
2098                         break;
2099                 case 'x': {
2100                         size_t new_size;
2101
2102                         if (!strcmp(optarg, "global")) {
2103                                 log_err("fio: can't use global as only "
2104                                         "section\n");
2105                                 do_exit++;
2106                                 exit_val = 1;
2107                                 break;
2108                         }
2109                         new_size = (nr_job_sections + 1) * sizeof(char *);
2110                         job_sections = realloc(job_sections, new_size);
2111                         job_sections[nr_job_sections] = strdup(optarg);
2112                         nr_job_sections++;
2113                         break;
2114                         }
2115 #ifdef CONFIG_ZLIB
2116                 case 'X':
2117                         exit_val = iolog_file_inflate(optarg);
2118                         did_arg++;
2119                         do_exit++;
2120                         break;
2121 #endif
2122                 case 'p':
2123                         did_arg = 1;
2124                         if (exec_profile)
2125                                 free(exec_profile);
2126                         exec_profile = strdup(optarg);
2127                         break;
2128                 case FIO_GETOPT_JOB: {
2129                         const char *opt = l_opts[lidx].name;
2130                         char *val = optarg;
2131
2132                         if (!strncmp(opt, "name", 4) && td) {
2133                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2134                                 if (ret)
2135                                         goto out_free;
2136                                 td = NULL;
2137                                 did_arg = 1;
2138                         }
2139                         if (!td) {
2140                                 int is_section = !strncmp(opt, "name", 4);
2141                                 int global = 0;
2142
2143                                 if (!is_section || !strncmp(val, "global", 6))
2144                                         global = 1;
2145
2146                                 if (is_section && skip_this_section(val))
2147                                         continue;
2148
2149                                 td = get_new_job(global, &def_thread, 1, NULL);
2150                                 if (!td || ioengine_load(td)) {
2151                                         if (td) {
2152                                                 put_job(td);
2153                                                 td = NULL;
2154                                         }
2155                                         do_exit++;
2156                                         exit_val = 1;
2157                                         break;
2158                                 }
2159                                 fio_options_set_ioengine_opts(l_opts, td);
2160                         }
2161
2162                         if ((!val || !strlen(val)) &&
2163                             l_opts[lidx].has_arg == required_argument) {
2164                                 log_err("fio: option %s requires an argument\n", opt);
2165                                 ret = 1;
2166                         } else
2167                                 ret = fio_cmd_option_parse(td, opt, val);
2168
2169                         if (ret) {
2170                                 if (td) {
2171                                         put_job(td);
2172                                         td = NULL;
2173                                 }
2174                                 do_exit++;
2175                                 exit_val = 1;
2176                         }
2177
2178                         if (!ret && !strcmp(opt, "ioengine")) {
2179                                 free_ioengine(td);
2180                                 if (ioengine_load(td)) {
2181                                         put_job(td);
2182                                         td = NULL;
2183                                         do_exit++;
2184                                         exit_val = 1;
2185                                         break;
2186                                 }
2187                                 fio_options_set_ioengine_opts(l_opts, td);
2188                         }
2189                         break;
2190                 }
2191                 case FIO_GETOPT_IOENGINE: {
2192                         const char *opt = l_opts[lidx].name;
2193                         char *val = optarg;
2194
2195                         if (!td)
2196                                 break;
2197
2198                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
2199                         break;
2200                 }
2201                 case 'w':
2202                         warnings_fatal = 1;
2203                         break;
2204                 case 'j':
2205                         max_jobs = atoi(optarg);
2206                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2207                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
2208                                 do_exit++;
2209                                 exit_val = 1;
2210                         }
2211                         break;
2212                 case 'S':
2213                         did_arg = 1;
2214 #ifndef CONFIG_NO_SHM
2215                         if (nr_clients) {
2216                                 log_err("fio: can't be both client and server\n");
2217                                 do_exit++;
2218                                 exit_val = 1;
2219                                 break;
2220                         }
2221                         if (optarg)
2222                                 fio_server_set_arg(optarg);
2223                         is_backend = 1;
2224                         backend = 1;
2225 #else
2226                         log_err("fio: client/server requires SHM support\n");
2227                         do_exit++;
2228                         exit_val = 1;
2229 #endif
2230                         break;
2231                 case 'D':
2232                         if (pid_file)
2233                                 free(pid_file);
2234                         pid_file = strdup(optarg);
2235                         break;
2236                 case 'I':
2237                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
2238                                 /* exit on error and calibration only */
2239                                 did_arg = 1;
2240                                 do_exit++;
2241                                 if (ret == -1)
2242                                         exit_val = 1;
2243                         }
2244                         break;
2245                 case 'C':
2246                         did_arg = 1;
2247                         if (is_backend) {
2248                                 log_err("fio: can't be both client and server\n");
2249                                 do_exit++;
2250                                 exit_val = 1;
2251                                 break;
2252                         }
2253                         /* if --client parameter contains a pathname */
2254                         if (0 == access(optarg, R_OK)) {
2255                                 /* file contains a list of host addrs or names */
2256                                 char hostaddr[PATH_MAX] = {0};
2257                                 char formatstr[8];
2258                                 FILE * hostf = fopen(optarg, "r");
2259                                 if (!hostf) {
2260                                         log_err("fio: could not open client list file %s for read\n", optarg);
2261                                         do_exit++;
2262                                         exit_val = 1;
2263                                         break;
2264                                 }
2265                                 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2266                                 /*
2267                                  * read at most PATH_MAX-1 chars from each
2268                                  * record in this file
2269                                  */
2270                                 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2271                                         /* expect EVERY host in file to be valid */
2272                                         if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2273                                                 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2274                                                 do_exit++;
2275                                                 exit_val = 1;
2276                                                 break;
2277                                         }
2278                                 }
2279                                 fclose(hostf);
2280                                 break; /* no possibility of job file for "this client only" */
2281                         }
2282                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2283                                 log_err("fio: failed adding client %s\n", optarg);
2284                                 do_exit++;
2285                                 exit_val = 1;
2286                                 break;
2287                         }
2288                         /*
2289                          * If the next argument exists and isn't an option,
2290                          * assume it's a job file for this client only.
2291                          */
2292                         while (optind < argc) {
2293                                 if (!strncmp(argv[optind], "--", 2) ||
2294                                     !strncmp(argv[optind], "-", 1))
2295                                         break;
2296
2297                                 if (fio_client_add_ini_file(cur_client, argv[optind], 0))
2298                                         break;
2299                                 optind++;
2300                         }
2301                         break;
2302                 case 'R':
2303                         did_arg = 1;
2304                         if (fio_client_add_ini_file(cur_client, optarg, 1)) {
2305                                 do_exit++;
2306                                 exit_val = 1;
2307                         }
2308                         break;
2309                 case 'T':
2310                         did_arg = 1;
2311                         do_exit++;
2312                         exit_val = fio_monotonic_clocktest(1);
2313                         break;
2314                 case 'G':
2315                         did_arg = 1;
2316                         do_exit++;
2317                         exit_val = fio_crctest(optarg);
2318                         break;
2319                 case 'L': {
2320                         long long val;
2321
2322                         if (check_str_time(optarg, &val, 1)) {
2323                                 log_err("fio: failed parsing time %s\n", optarg);
2324                                 do_exit++;
2325                                 exit_val = 1;
2326                                 break;
2327                         }
2328                         status_interval = val / 1000;
2329                         break;
2330                         }
2331                 case 'W':
2332                         if (trigger_file)
2333                                 free(trigger_file);
2334                         trigger_file = strdup(optarg);
2335                         break;
2336                 case 'H':
2337                         if (trigger_cmd)
2338                                 free(trigger_cmd);
2339                         trigger_cmd = strdup(optarg);
2340                         break;
2341                 case 'J':
2342                         if (trigger_remote_cmd)
2343                                 free(trigger_remote_cmd);
2344                         trigger_remote_cmd = strdup(optarg);
2345                         break;
2346                 case 'B':
2347                         if (check_str_time(optarg, &trigger_timeout, 1)) {
2348                                 log_err("fio: failed parsing time %s\n", optarg);
2349                                 do_exit++;
2350                                 exit_val = 1;
2351                         }
2352                         trigger_timeout /= 1000000;
2353                         break;
2354                 case '?':
2355                         log_err("%s: unrecognized option '%s'\n", argv[0],
2356                                                         argv[optind - 1]);
2357                         show_closest_option(argv[optind - 1]);
2358                 default:
2359                         do_exit++;
2360                         exit_val = 1;
2361                         break;
2362                 }
2363                 if (do_exit)
2364                         break;
2365         }
2366
2367         if (do_exit && !(is_backend || nr_clients))
2368                 exit(exit_val);
2369
2370         if (nr_clients && fio_clients_connect())
2371                 exit(1);
2372
2373         if (is_backend && backend)
2374                 return fio_start_server(pid_file);
2375         else if (pid_file)
2376                 free(pid_file);
2377
2378         if (td) {
2379                 if (!ret) {
2380                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2381                         if (ret)
2382                                 did_arg = 1;
2383                 }
2384         }
2385
2386         while (!ret && optind < argc) {
2387                 ini_idx++;
2388                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2389                 ini_file[ini_idx - 1] = strdup(argv[optind]);
2390                 optind++;
2391         }
2392
2393 out_free:
2394         if (pid_file)
2395                 free(pid_file);
2396
2397         return ini_idx;
2398 }
2399
2400 int fio_init_options(void)
2401 {
2402         f_out = stdout;
2403         f_err = stderr;
2404
2405         fio_options_fill_optstring();
2406         fio_options_dup_and_init(l_opts);
2407
2408         atexit(free_shm);
2409
2410         if (fill_def_thread())
2411                 return 1;
2412
2413         return 0;
2414 }
2415
2416 extern int fio_check_options(struct thread_options *);
2417
2418 int parse_options(int argc, char *argv[])
2419 {
2420         const int type = FIO_CLIENT_TYPE_CLI;
2421         int job_files, i;
2422
2423         if (fio_init_options())
2424                 return 1;
2425         if (fio_test_cconv(&def_thread.o))
2426                 log_err("fio: failed internal cconv test\n");
2427
2428         job_files = parse_cmd_line(argc, argv, type);
2429
2430         if (job_files > 0) {
2431                 for (i = 0; i < job_files; i++) {
2432                         if (i && fill_def_thread())
2433                                 return 1;
2434                         if (nr_clients) {
2435                                 if (fio_clients_send_ini(ini_file[i]))
2436                                         return 1;
2437                                 free(ini_file[i]);
2438                         } else if (!is_backend) {
2439                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
2440                                         return 1;
2441                                 free(ini_file[i]);
2442                         }
2443                 }
2444         } else if (nr_clients) {
2445                 if (fill_def_thread())
2446                         return 1;
2447                 if (fio_clients_send_ini(NULL))
2448                         return 1;
2449         }
2450
2451         free(ini_file);
2452         fio_options_free(&def_thread);
2453         filesetup_mem_free();
2454
2455         if (!thread_number) {
2456                 if (parse_dryrun())
2457                         return 0;
2458                 if (exec_profile)
2459                         return 0;
2460                 if (is_backend || nr_clients)
2461                         return 0;
2462                 if (did_arg)
2463                         return 0;
2464
2465                 log_err("No jobs(s) defined\n\n");
2466
2467                 if (!did_arg) {
2468                         usage(argv[0]);
2469                         return 1;
2470                 }
2471
2472                 return 0;
2473         }
2474
2475         if (output_format == FIO_OUTPUT_NORMAL)
2476                 log_info("%s\n", fio_version_string);
2477
2478         return 0;
2479 }
2480
2481 void options_default_fill(struct thread_options *o)
2482 {
2483         memcpy(o, &def_thread.o, sizeof(*o));
2484 }