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