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 <getopt.h>
  12 #include <sys/ipc.h>
  13 #include <sys/shm.h>
  14 #include <sys/types.h>
  15 #include <sys/stat.h>
  16
  17 #include "fio.h"
  18 #include "parse.h"
  19 #include "smalloc.h"
  20 #include "filehash.h"
  21 #include "verify.h"
  22 #include "profile.h"
  23
  24 static char fio_version_string[] = "fio 1.37";
  25
  26 #define FIO_RANDSEED            (0xb1899bedUL)
  27
  28 static char **ini_file;
  29 static int max_jobs = MAX_JOBS;
  30 static int dump_cmdline;
  31
  32 static struct thread_data def_thread;
  33 struct thread_data *threads = NULL;
  34
  35 int exitall_on_terminate = 0;
  36 int terse_output = 0;
  37 int eta_print;
  38 unsigned long long mlock_size = 0;
  39 FILE *f_out = NULL;
  40 FILE *f_err = NULL;
  41 char *job_section = NULL;
  42 char *exec_profile = NULL;
  43
  44 int write_bw_log = 0;
  45 int read_only = 0;
  46
  47 static int def_timeout;
  48 static int write_lat_log;
  49
  50 static int prev_group_jobs;
  51
  52 unsigned long fio_debug = 0;
  53 unsigned int fio_debug_jobno = -1;
  54 unsigned int *fio_debug_jobp = NULL;
  55
  56 /*
  57  * Command line options. These will contain the above, plus a few
  58  * extra that only pertain to fio itself and not jobs.
  59  */
  60 static struct option l_opts[FIO_NR_OPTIONS] = {
  61         {
  62                 .name           = "output",
  63                 .has_arg        = required_argument,
  64                 .val            = 'o',
  65         },
  66         {
  67                 .name           = "timeout",
  68                 .has_arg        = required_argument,
  69                 .val            = 't',
  70         },
  71         {
  72                 .name           = "latency-log",
  73                 .has_arg        = required_argument,
  74                 .val            = 'l',
  75         },
  76         {
  77                 .name           = "bandwidth-log",
  78                 .has_arg        = required_argument,
  79                 .val            = 'b',
  80         },
  81         {
  82                 .name           = "minimal",
  83                 .has_arg        = optional_argument,
  84                 .val            = 'm',
  85         },
  86         {
  87                 .name           = "version",
  88                 .has_arg        = no_argument,
  89                 .val            = 'v',
  90         },
  91         {
  92                 .name           = "help",
  93                 .has_arg        = no_argument,
  94                 .val            = 'h',
  95         },
  96         {
  97                 .name           = "cmdhelp",
  98                 .has_arg        = optional_argument,
  99                 .val            = 'c',
 100         },
 101         {
 102                 .name           = "showcmd",
 103                 .has_arg        = no_argument,
 104                 .val            = 's',
 105         },
 106         {
 107                 .name           = "readonly",
 108                 .has_arg        = no_argument,
 109                 .val            = 'r',
 110         },
 111         {
 112                 .name           = "eta",
 113                 .has_arg        = required_argument,
 114                 .val            = 'e',
 115         },
 116         {
 117                 .name           = "debug",
 118                 .has_arg        = required_argument,
 119                 .val            = 'd',
 120         },
 121         {
 122                 .name           = "section",
 123                 .has_arg        = required_argument,
 124                 .val            = 'x',
 125         },
 126         {
 127                 .name           = "alloc-size",
 128                 .has_arg        = required_argument,
 129                 .val            = 'a',
 130         },
 131         {
 132                 .name           = "profile",
 133                 .has_arg        = required_argument,
 134                 .val            = 'p',
 135         },
 136         {
 137                 .name           = NULL,
 138         },
 139 };
 140
 141 FILE *get_f_out()
 142 {
 143         return f_out;
 144 }
 145
 146 FILE *get_f_err()
 147 {
 148         return f_err;
 149 }
 150
 151 /*
 152  * Return a free job structure.
 153  */
 154 static struct thread_data *get_new_job(int global, struct thread_data *parent)
 155 {
 156         struct thread_data *td;
 157
 158         if (global)
 159                 return &def_thread;
 160         if (thread_number >= max_jobs)
 161                 return NULL;
 162
 163         td = &threads[thread_number++];
 164         *td = *parent;
 165
 166         td->o.uid = td->o.gid = -1U;
 167
 168         dup_files(td, parent);
 169         options_mem_dupe(td);
 170
 171         td->thread_number = thread_number;
 172         return td;
 173 }
 174
 175 static void put_job(struct thread_data *td)
 176 {
 177         if (td == &def_thread)
 178                 return;
 179
 180         if (td->error)
 181                 log_info("fio: %s\n", td->verror);
 182
 183         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
 184         thread_number--;
 185 }
 186
 187 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 188 {
 189         unsigned int bs = td->o.min_bs[ddir];
 190         unsigned long long bytes_per_sec;
 191
 192         if (td->o.rate[ddir])
 193                 bytes_per_sec = td->o.rate[ddir];
 194         else
 195                 bytes_per_sec = td->o.rate_iops[ddir] * bs;
 196
 197         if (!bytes_per_sec) {
 198                 log_err("rate lower than supported\n");
 199                 return -1;
 200         }
 201
 202         td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
 203         td->rate_pending_usleep[ddir] = 0;
 204         return 0;
 205 }
 206
 207 static int setup_rate(struct thread_data *td)
 208 {
 209         int ret = 0;
 210
 211         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
 212                 ret = __setup_rate(td, DDIR_READ);
 213         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
 214                 ret |= __setup_rate(td, DDIR_WRITE);
 215
 216         return ret;
 217 }
 218
 219 static int fixed_block_size(struct thread_options *o)
 220 {
 221         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
 222                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
 223                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
 224 }
 225
 226 /*
 227  * Lazy way of fixing up options that depend on each other. We could also
 228  * define option callback handlers, but this is easier.
 229  */
 230 static int fixup_options(struct thread_data *td)
 231 {
 232         struct thread_options *o = &td->o;
 233
 234 #ifndef FIO_HAVE_PSHARED_MUTEX
 235         if (!td->o.use_thread) {
 236                 log_info("fio: this platform does not support process shared"
 237                          " mutexes, forcing use of threads. Use the 'thread'"
 238                          " option to get rid of this warning.\n");
 239                 td->o.use_thread = 1;
 240         }
 241 #endif
 242
 243         if (o->write_iolog_file && o->read_iolog_file) {
 244                 log_err("fio: read iolog overrides write_iolog\n");
 245                 free(o->write_iolog_file);
 246                 o->write_iolog_file = NULL;
 247         }
 248
 249         /*
 250          * only really works for sequential io for now, and with 1 file
 251          */
 252         if (o->zone_size && td_random(td) && o->open_files == 1)
 253                 o->zone_size = 0;
 254
 255         /*
 256          * Reads can do overwrites, we always need to pre-create the file
 257          */
 258         if (td_read(td) || td_rw(td))
 259                 o->overwrite = 1;
 260
 261         if (!o->min_bs[DDIR_READ])
 262                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
 263         if (!o->max_bs[DDIR_READ])
 264                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
 265         if (!o->min_bs[DDIR_WRITE])
 266                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 267         if (!o->max_bs[DDIR_WRITE])
 268                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 269
 270         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
 271
 272         /*
 273          * For random IO, allow blockalign offset other than min_bs.
 274          */
 275         if (!o->ba[DDIR_READ] || !td_random(td))
 276                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
 277         if (!o->ba[DDIR_WRITE] || !td_random(td))
 278                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
 279
 280         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
 281             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
 282             !td->o.norandommap) {
 283                 log_err("fio: Any use of blockalign= turns off randommap\n");
 284                 td->o.norandommap = 1;
 285         }
 286
 287         if (!o->file_size_high)
 288                 o->file_size_high = o->file_size_low;
 289
 290         if (o->norandommap && o->verify != VERIFY_NONE
 291             && !fixed_block_size(o))  {
 292                 log_err("fio: norandommap given for variable block sizes, "
 293                         "verify disabled\n");
 294                 o->verify = VERIFY_NONE;
 295         }
 296         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
 297                 log_err("fio: bs_unaligned may not work with raw io\n");
 298
 299         /*
 300          * thinktime_spin must be less than thinktime
 301          */
 302         if (o->thinktime_spin > o->thinktime)
 303                 o->thinktime_spin = o->thinktime;
 304
 305         /*
 306          * The low water mark cannot be bigger than the iodepth
 307          */
 308         if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
 309                 /*
 310                  * syslet work around - if the workload is sequential,
 311                  * we want to let the queue drain all the way down to
 312                  * avoid seeking between async threads
 313                  */
 314                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
 315                         o->iodepth_low = 1;
 316                 else
 317                         o->iodepth_low = o->iodepth;
 318         }
 319
 320         /*
 321          * If batch number isn't set, default to the same as iodepth
 322          */
 323         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
 324                 o->iodepth_batch = o->iodepth;
 325
 326         if (o->nr_files > td->files_index)
 327                 o->nr_files = td->files_index;
 328
 329         if (o->open_files > o->nr_files || !o->open_files)
 330                 o->open_files = o->nr_files;
 331
 332         if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
 333             ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
 334                 o->rate_iops_min[1]))) {
 335                 log_err("fio: rate and rate_iops are mutually exclusive\n");
 336                 return 1;
 337         }
 338         if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
 339             (o->rate_iops[0] < o->rate_iops_min[0]) ||
 340             (o->rate_iops[1] < o->rate_iops_min[1])) {
 341                 log_err("fio: minimum rate exceeds rate\n");
 342                 return 1;
 343         }
 344
 345         if (!o->timeout && o->time_based) {
 346                 log_err("fio: time_based requires a runtime/timeout setting\n");
 347                 o->time_based = 0;
 348         }
 349
 350         if (o->fill_device && !o->size)
 351                 o->size = -1ULL;
 352
 353         if (td_rw(td) && td->o.verify != VERIFY_NONE)
 354                 log_info("fio: mixed read/write workload with verify. May not "
 355                  "work as expected, unless you pre-populated the file\n");
 356
 357         if (td->o.verify != VERIFY_NONE)
 358                 td->o.refill_buffers = 1;
 359
 360         if (td->o.pre_read) {
 361                 td->o.invalidate_cache = 0;
 362                 if (td->io_ops->flags & FIO_PIPEIO)
 363                         log_info("fio: cannot pre-read files with an IO engine"
 364                                  " that isn't seekable. Pre-read disabled.\n");
 365         }
 366
 367 #ifndef FIO_HAVE_FDATASYNC
 368         if (td->o.fdatasync_blocks) {
 369                 log_info("fio: this platform does not support fdatasync()"
 370                          " falling back to using fsync().  Use the 'fsync'"
 371                          " option instead of 'fdatasync' to get rid of"
 372                          " this warning\n");
 373                 td->o.fsync_blocks = td->o.fdatasync_blocks;
 374                 td->o.fdatasync_blocks = 0;
 375         }
 376 #endif
 377
 378         return 0;
 379 }
 380
 381 /*
 382  * This function leaks the buffer
 383  */
 384 static char *to_kmg(unsigned int val)
 385 {
 386         char *buf = malloc(32);
 387         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 388         char *p = post;
 389
 390         do {
 391                 if (val & 1023)
 392                         break;
 393
 394                 val >>= 10;
 395                 p++;
 396         } while (*p);
 397
 398         snprintf(buf, 31, "%u%c", val, *p);
 399         return buf;
 400 }
 401
 402 /* External engines are specified by "external:name.o") */
 403 static const char *get_engine_name(const char *str)
 404 {
 405         char *p = strstr(str, ":");
 406
 407         if (!p)
 408                 return str;
 409
 410         p++;
 411         strip_blank_front(&p);
 412         strip_blank_end(p);
 413         return p;
 414 }
 415
 416 static int exists_and_not_file(const char *filename)
 417 {
 418         struct stat sb;
 419
 420         if (lstat(filename, &sb) == -1)
 421                 return 0;
 422
 423         if (S_ISREG(sb.st_mode))
 424                 return 0;
 425
 426         return 1;
 427 }
 428
 429 void td_fill_rand_seeds(struct thread_data *td)
 430 {
 431         os_random_seed(td->rand_seeds[0], &td->bsrange_state);
 432         os_random_seed(td->rand_seeds[1], &td->verify_state);
 433         os_random_seed(td->rand_seeds[2], &td->rwmix_state);
 434
 435         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
 436                 os_random_seed(td->rand_seeds[3], &td->next_file_state);
 437
 438         os_random_seed(td->rand_seeds[5], &td->file_size_state);
 439
 440         if (!td_random(td))
 441                 return;
 442
 443         if (td->o.rand_repeatable)
 444                 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
 445
 446         os_random_seed(td->rand_seeds[4], &td->random_state);
 447 }
 448
 449 /*
 450  * Initialize the various random states we need (random io, block size ranges,
 451  * read/write mix, etc).
 452  */
 453 static int init_random_state(struct thread_data *td)
 454 {
 455         int fd;
 456
 457         fd = open("/dev/urandom", O_RDONLY);
 458         if (fd == -1) {
 459                 td_verror(td, errno, "open");
 460                 return 1;
 461         }
 462
 463         if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
 464             (int) sizeof(td->rand_seeds)) {
 465                 td_verror(td, EIO, "read");
 466                 close(fd);
 467                 return 1;
 468         }
 469
 470         close(fd);
 471         td_fill_rand_seeds(td);
 472         return 0;
 473 }
 474
 475 /*
 476  * Adds a job to the list of things todo. Sanitizes the various options
 477  * to make sure we don't have conflicts, and initializes various
 478  * members of td.
 479  */
 480 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 481 {
 482         const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
 483                                    "randread", "randwrite", "randrw" };
 484         unsigned int i;
 485         const char *engine;
 486         char fname[PATH_MAX];
 487         int numjobs, file_alloced;
 488
 489         /*
 490          * the def_thread is just for options, it's not a real job
 491          */
 492         if (td == &def_thread)
 493                 return 0;
 494
 495         /*
 496          * if we are just dumping the output command line, don't add the job
 497          */
 498         if (dump_cmdline) {
 499                 put_job(td);
 500                 return 0;
 501         }
 502
 503         engine = get_engine_name(td->o.ioengine);
 504         td->io_ops = load_ioengine(td, engine);
 505         if (!td->io_ops) {
 506                 log_err("fio: failed to load engine %s\n", engine);
 507                 goto err;
 508         }
 509
 510         if (td->o.use_thread)
 511                 nr_thread++;
 512         else
 513                 nr_process++;
 514
 515         if (td->o.odirect)
 516                 td->io_ops->flags |= FIO_RAWIO;
 517
 518         file_alloced = 0;
 519         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
 520                 file_alloced = 1;
 521
 522                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
 523                         add_file(td, jobname);
 524                 else {
 525                         for (i = 0; i < td->o.nr_files; i++) {
 526                                 sprintf(fname, "%s.%d.%d", jobname,
 527                                                         td->thread_number, i);
 528                                 add_file(td, fname);
 529                         }
 530                 }
 531         }
 532
 533         if (fixup_options(td))
 534                 goto err;
 535
 536         if (td->io_ops->flags & FIO_DISKLESSIO) {
 537                 struct fio_file *f;
 538
 539                 for_each_file(td, f, i)
 540                         f->real_file_size = -1ULL;
 541         }
 542
 543         td->mutex = fio_mutex_init(0);
 544
 545         td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
 546         td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
 547         td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
 548         td->ddir_nr = td->o.ddir_nr;
 549
 550         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
 551                 prev_group_jobs = 0;
 552                 groupid++;
 553         }
 554
 555         td->groupid = groupid;
 556         prev_group_jobs++;
 557
 558         if (init_random_state(td))
 559                 goto err;
 560
 561         if (setup_rate(td))
 562                 goto err;
 563
 564         if (td->o.write_lat_log) {
 565                 setup_log(&td->ts.slat_log);
 566                 setup_log(&td->ts.clat_log);
 567         }
 568         if (td->o.write_bw_log)
 569                 setup_log(&td->ts.bw_log);
 570
 571         if (!td->o.name)
 572                 td->o.name = strdup(jobname);
 573
 574         if (!terse_output) {
 575                 if (!job_add_num) {
 576                         if (!strcmp(td->io_ops->name, "cpuio")) {
 577                                 log_info("%s: ioengine=cpu, cpuload=%u,"
 578                                          " cpucycle=%u\n", td->o.name,
 579                                                         td->o.cpuload,
 580                                                         td->o.cpucycle);
 581                         } else {
 582                                 char *c1, *c2, *c3, *c4;
 583
 584                                 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
 585                                 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
 586                                 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
 587                                 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
 588
 589                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
 590                                          " ioengine=%s, iodepth=%u\n",
 591                                                 td->o.name, td->groupid,
 592                                                 ddir_str[td->o.td_ddir],
 593                                                 c1, c2, c3, c4,
 594                                                 td->io_ops->name,
 595                                                 td->o.iodepth);
 596
 597                                 free(c1);
 598                                 free(c2);
 599                                 free(c3);
 600                                 free(c4);
 601                         }
 602                 } else if (job_add_num == 1)
 603                         log_info("...\n");
 604         }
 605
 606         /*
 607          * recurse add identical jobs, clear numjobs and stonewall options
 608          * as they don't apply to sub-jobs
 609          */
 610         numjobs = td->o.numjobs;
 611         while (--numjobs) {
 612                 struct thread_data *td_new = get_new_job(0, td);
 613
 614                 if (!td_new)
 615                         goto err;
 616
 617                 td_new->o.numjobs = 1;
 618                 td_new->o.stonewall = 0;
 619                 td_new->o.new_group = 0;
 620
 621                 if (file_alloced) {
 622                         td_new->o.filename = NULL;
 623                         td_new->files_index = 0;
 624                         td_new->files_size = 0;
 625                         td_new->files = NULL;
 626                 }
 627
 628                 job_add_num = numjobs - 1;
 629
 630                 if (add_job(td_new, jobname, job_add_num))
 631                         goto err;
 632         }
 633
 634         return 0;
 635 err:
 636         put_job(td);
 637         return -1;
 638 }
 639
 640 /*
 641  * Parse as if 'o' was a command line
 642  */
 643 void add_job_opts(const char **o)
 644 {
 645         struct thread_data *td, *td_parent;
 646         int i, in_global = 1;
 647         char jobname[32];
 648
 649         i = 0;
 650         td_parent = td = NULL;
 651         while (o[i]) {
 652                 if (!strncmp(o[i], "name", 4)) {
 653                         in_global = 0;
 654                         if (td)
 655                                 add_job(td, jobname, 0);
 656                         td = NULL;
 657                         sprintf(jobname, "%s", o[i] + 5);
 658                 }
 659                 if (in_global && !td_parent)
 660                         td_parent = get_new_job(1, &def_thread);
 661                 else if (!in_global && !td) {
 662                         if (!td_parent)
 663                                 td_parent = &def_thread;
 664                         td = get_new_job(0, td_parent);
 665                 }
 666                 if (in_global)
 667                         fio_options_parse(td_parent, (char **) &o[i], 1);
 668                 else
 669                         fio_options_parse(td, (char **) &o[i], 1);
 670                 i++;
 671         }
 672
 673         if (td)
 674                 add_job(td, jobname, 0);
 675 }
 676
 677 static int skip_this_section(const char *name)
 678 {
 679         if (!job_section)
 680                 return 0;
 681         if (!strncmp(name, "global", 6))
 682                 return 0;
 683
 684         return strcmp(job_section, name);
 685 }
 686
 687 static int is_empty_or_comment(char *line)
 688 {
 689         unsigned int i;
 690
 691         for (i = 0; i < strlen(line); i++) {
 692                 if (line[i] == ';')
 693                         return 1;
 694                 if (line[i] == '#')
 695                         return 1;
 696                 if (!isspace(line[i]) && !iscntrl(line[i]))
 697                         return 0;
 698         }
 699
 700         return 1;
 701 }
 702
 703 /*
 704  * This is our [ini] type file parser.
 705  */
 706 static int parse_jobs_ini(char *file, int stonewall_flag)
 707 {
 708         unsigned int global;
 709         struct thread_data *td;
 710         char *string, *name;
 711         FILE *f;
 712         char *p;
 713         int ret = 0, stonewall;
 714         int first_sect = 1;
 715         int skip_fgets = 0;
 716         int inside_skip = 0;
 717         char **opts;
 718         int i, alloc_opts, num_opts;
 719
 720         if (!strcmp(file, "-"))
 721                 f = stdin;
 722         else
 723                 f = fopen(file, "r");
 724
 725         if (!f) {
 726                 perror("fopen job file");
 727                 return 1;
 728         }
 729
 730         string = malloc(4096);
 731
 732         /*
 733          * it's really 256 + small bit, 280 should suffice
 734          */
 735         name = malloc(280);
 736         memset(name, 0, 280);
 737
 738         alloc_opts = 8;
 739         opts = malloc(sizeof(char *) * alloc_opts);
 740         num_opts = 0;
 741
 742         stonewall = stonewall_flag;
 743         do {
 744                 /*
 745                  * if skip_fgets is set, we already have loaded a line we
 746                  * haven't handled.
 747                  */
 748                 if (!skip_fgets) {
 749                         p = fgets(string, 4095, f);
 750                         if (!p)
 751                                 break;
 752                 }
 753
 754                 skip_fgets = 0;
 755                 strip_blank_front(&p);
 756                 strip_blank_end(p);
 757
 758                 if (is_empty_or_comment(p))
 759                         continue;
 760                 if (sscanf(p, "[%255s]", name) != 1) {
 761                         if (inside_skip)
 762                                 continue;
 763                         log_err("fio: option <%s> outside of [] job section\n",
 764                                                                         p);
 765                         break;
 766                 }
 767
 768                 if (skip_this_section(name)) {
 769                         inside_skip = 1;
 770                         continue;
 771                 } else
 772                         inside_skip = 0;
 773
 774                 global = !strncmp(name, "global", 6);
 775
 776                 name[strlen(name) - 1] = '\0';
 777
 778                 if (dump_cmdline) {
 779                         if (first_sect)
 780                                 log_info("fio ");
 781                         if (!global)
 782                                 log_info("--name=%s ", name);
 783                         first_sect = 0;
 784                 }
 785
 786                 td = get_new_job(global, &def_thread);
 787                 if (!td) {
 788                         ret = 1;
 789                         break;
 790                 }
 791
 792                 /*
 793                  * Seperate multiple job files by a stonewall
 794                  */
 795                 if (!global && stonewall) {
 796                         td->o.stonewall = stonewall;
 797                         stonewall = 0;
 798                 }
 799
 800                 num_opts = 0;
 801                 memset(opts, 0, alloc_opts * sizeof(char *));
 802
 803                 while ((p = fgets(string, 4096, f)) != NULL) {
 804                         if (is_empty_or_comment(p))
 805                                 continue;
 806
 807                         strip_blank_front(&p);
 808
 809                         /*
 810                          * new section, break out and make sure we don't
 811                          * fgets() a new line at the top.
 812                          */
 813                         if (p[0] == '[') {
 814                                 skip_fgets = 1;
 815                                 break;
 816                         }
 817
 818                         strip_blank_end(p);
 819
 820                         if (num_opts == alloc_opts) {
 821                                 alloc_opts <<= 1;
 822                                 opts = realloc(opts,
 823                                                 alloc_opts * sizeof(char *));
 824                         }
 825
 826                         opts[num_opts] = strdup(p);
 827                         num_opts++;
 828                 }
 829
 830                 ret = fio_options_parse(td, opts, num_opts);
 831                 if (!ret) {
 832                         if (dump_cmdline)
 833                                 for (i = 0; i < num_opts; i++)
 834                                         log_info("--%s ", opts[i]);
 835
 836                         ret = add_job(td, name, 0);
 837                 } else {
 838                         log_err("fio: job %s dropped\n", name);
 839                         put_job(td);
 840                 }
 841
 842                 for (i = 0; i < num_opts; i++)
 843                         free(opts[i]);
 844                 num_opts = 0;
 845         } while (!ret);
 846
 847         if (dump_cmdline)
 848                 log_info("\n");
 849
 850         for (i = 0; i < num_opts; i++)
 851                 free(opts[i]);
 852
 853         free(string);
 854         free(name);
 855         free(opts);
 856         if (f != stdin)
 857                 fclose(f);
 858         return ret;
 859 }
 860
 861 static int fill_def_thread(void)
 862 {
 863         memset(&def_thread, 0, sizeof(def_thread));
 864
 865         fio_getaffinity(getpid(), &def_thread.o.cpumask);
 866
 867         /*
 868          * fill default options
 869          */
 870         fio_fill_default_options(&def_thread);
 871
 872         def_thread.o.timeout = def_timeout;
 873         def_thread.o.write_bw_log = write_bw_log;
 874         def_thread.o.write_lat_log = write_lat_log;
 875
 876         return 0;
 877 }
 878
 879 static void free_shm(void)
 880 {
 881         struct shmid_ds sbuf;
 882
 883         if (threads) {
 884                 void *tp = threads;
 885
 886                 threads = NULL;
 887                 file_hash_exit();
 888                 fio_debug_jobp = NULL;
 889                 shmdt(tp);
 890                 shmctl(shm_id, IPC_RMID, &sbuf);
 891         }
 892
 893         scleanup();
 894 }
 895
 896 /*
 897  * The thread area is shared between the main process and the job
 898  * threads/processes. So setup a shared memory segment that will hold
 899  * all the job info. We use the end of the region for keeping track of
 900  * open files across jobs, for file sharing.
 901  */
 902 static int setup_thread_area(void)
 903 {
 904         void *hash;
 905
 906         /*
 907          * 1024 is too much on some machines, scale max_jobs if
 908          * we get a failure that looks like too large a shm segment
 909          */
 910         do {
 911                 size_t size = max_jobs * sizeof(struct thread_data);
 912
 913                 size += file_hash_size;
 914                 size += sizeof(unsigned int);
 915
 916                 shm_id = shmget(0, size, IPC_CREAT | 0600);
 917                 if (shm_id != -1)
 918                         break;
 919                 if (errno != EINVAL) {
 920                         perror("shmget");
 921                         break;
 922                 }
 923
 924                 max_jobs >>= 1;
 925         } while (max_jobs);
 926
 927         if (shm_id == -1)
 928                 return 1;
 929
 930         threads = shmat(shm_id, NULL, 0);
 931         if (threads == (void *) -1) {
 932                 perror("shmat");
 933                 return 1;
 934         }
 935
 936         memset(threads, 0, max_jobs * sizeof(struct thread_data));
 937         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
 938         fio_debug_jobp = (void *) hash + file_hash_size;
 939         *fio_debug_jobp = -1;
 940         file_hash_init(hash);
 941         atexit(free_shm);
 942         return 0;
 943 }
 944
 945 static void usage(const char *name)
 946 {
 947         printf("%s\n", fio_version_string);
 948         printf("%s [options] [job options] <job file(s)>\n", name);
 949         printf("\t--debug=options\tEnable debug logging\n");
 950         printf("\t--output\tWrite output to file\n");
 951         printf("\t--timeout\tRuntime in seconds\n");
 952         printf("\t--latency-log\tGenerate per-job latency logs\n");
 953         printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
 954         printf("\t--minimal\tMinimal (terse) output\n");
 955         printf("\t--version\tPrint version info and exit\n");
 956         printf("\t--help\t\tPrint this page\n");
 957         printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
 958                 " them\n");
 959         printf("\t--showcmd\tTurn a job file into command line options\n");
 960         printf("\t--eta=when\tWhen ETA estimate should be printed\n");
 961         printf("\t          \tMay be \"always\", \"never\" or \"auto\"\n");
 962         printf("\t--readonly\tTurn on safety read-only checks, preventing"
 963                 " writes\n");
 964         printf("\t--section=name\tOnly run specified section in job file\n");
 965         printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
 966                 " (def 1024)\n");
 967         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>\n");
 968 }
 969
 970 #ifdef FIO_INC_DEBUG
 971 struct debug_level debug_levels[] = {
 972         { .name = "process",    .shift = FD_PROCESS, },
 973         { .name = "file",       .shift = FD_FILE, },
 974         { .name = "io",         .shift = FD_IO, },
 975         { .name = "mem",        .shift = FD_MEM, },
 976         { .name = "blktrace",   .shift = FD_BLKTRACE },
 977         { .name = "verify",     .shift = FD_VERIFY },
 978         { .name = "random",     .shift = FD_RANDOM },
 979         { .name = "parse",      .shift = FD_PARSE },
 980         { .name = "diskutil",   .shift = FD_DISKUTIL },
 981         { .name = "job",        .shift = FD_JOB },
 982         { .name = "mutex",      .shift = FD_MUTEX },
 983         { .name = "profile",    .shift = FD_PROFILE },
 984         { .name = NULL, },
 985 };
 986
 987 static int set_debug(const char *string)
 988 {
 989         struct debug_level *dl;
 990         char *p = (char *) string;
 991         char *opt;
 992         int i;
 993
 994         if (!strcmp(string, "?") || !strcmp(string, "help")) {
 995                 int i;
 996
 997                 log_info("fio: dumping debug options:");
 998                 for (i = 0; debug_levels[i].name; i++) {
 999                         dl = &debug_levels[i];
1000                         log_info("%s,", dl->name);
1001                 }
1002                 log_info("all\n");
1003                 return 1;
1004         }
1005
1006         while ((opt = strsep(&p, ",")) != NULL) {
1007                 int found = 0;
1008
1009                 if (!strncmp(opt, "all", 3)) {
1010                         log_info("fio: set all debug options\n");
1011                         fio_debug = ~0UL;
1012                         continue;
1013                 }
1014
1015                 for (i = 0; debug_levels[i].name; i++) {
1016                         dl = &debug_levels[i];
1017                         found = !strncmp(opt, dl->name, strlen(dl->name));
1018                         if (!found)
1019                                 continue;
1020
1021                         if (dl->shift == FD_JOB) {
1022                                 opt = strchr(opt, ':');
1023                                 if (!opt) {
1024                                         log_err("fio: missing job number\n");
1025                                         break;
1026                                 }
1027                                 opt++;
1028                                 fio_debug_jobno = atoi(opt);
1029                                 log_info("fio: set debug jobno %d\n",
1030                                                         fio_debug_jobno);
1031                         } else {
1032                                 log_info("fio: set debug option %s\n", opt);
1033                                 fio_debug |= (1UL << dl->shift);
1034                         }
1035                         break;
1036                 }
1037
1038                 if (!found)
1039                         log_err("fio: debug mask %s not found\n", opt);
1040         }
1041         return 0;
1042 }
1043 #else
1044 static int set_debug(const char *string)
1045 {
1046         log_err("fio: debug tracing not included in build\n");
1047         return 1;
1048 }
1049 #endif
1050
1051 static int parse_cmd_line(int argc, char *argv[])
1052 {
1053         struct thread_data *td = NULL;
1054         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1055
1056         while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
1057                 switch (c) {
1058                 case 'a':
1059                         smalloc_pool_size = atoi(optarg);
1060                         break;
1061                 case 't':
1062                         def_timeout = atoi(optarg);
1063                         break;
1064                 case 'l':
1065                         write_lat_log = 1;
1066                         break;
1067                 case 'w':
1068                         write_bw_log = 1;
1069                         break;
1070                 case 'o':
1071                         f_out = fopen(optarg, "w+");
1072                         if (!f_out) {
1073                                 perror("fopen output");
1074                                 exit(1);
1075                         }
1076                         f_err = f_out;
1077                         break;
1078                 case 'm':
1079                         terse_output = 1;
1080                         break;
1081                 case 'h':
1082                         usage(argv[0]);
1083                         exit(0);
1084                 case 'c':
1085                         exit(fio_show_option_help(optarg));
1086                 case 's':
1087                         dump_cmdline = 1;
1088                         break;
1089                 case 'r':
1090                         read_only = 1;
1091                         break;
1092                 case 'v':
1093                         printf("%s\n", fio_version_string);
1094                         exit(0);
1095                 case 'e':
1096                         if (!strcmp("always", optarg))
1097                                 eta_print = FIO_ETA_ALWAYS;
1098                         else if (!strcmp("never", optarg))
1099                                 eta_print = FIO_ETA_NEVER;
1100                         break;
1101                 case 'd':
1102                         if (set_debug(optarg))
1103                                 do_exit++;
1104                         break;
1105                 case 'x':
1106                         if (!strcmp(optarg, "global")) {
1107                                 log_err("fio: can't use global as only "
1108                                         "section\n");
1109                                 do_exit++;
1110                                 exit_val = 1;
1111                                 break;
1112                         }
1113                         if (job_section)
1114                                 free(job_section);
1115                         job_section = strdup(optarg);
1116                         break;
1117                 case 'p':
1118                         exec_profile = strdup(optarg);
1119                         break;
1120                 case FIO_GETOPT_JOB: {
1121                         const char *opt = l_opts[lidx].name;
1122                         char *val = optarg;
1123
1124                         if (!strncmp(opt, "name", 4) && td) {
1125                                 ret = add_job(td, td->o.name ?: "fio", 0);
1126                                 if (ret) {
1127                                         put_job(td);
1128                                         return 0;
1129                                 }
1130                                 td = NULL;
1131                         }
1132                         if (!td) {
1133                                 int is_section = !strncmp(opt, "name", 4);
1134                                 int global = 0;
1135
1136                                 if (!is_section || !strncmp(val, "global", 6))
1137                                         global = 1;
1138
1139                                 if (is_section && skip_this_section(val))
1140                                         continue;
1141
1142                                 td = get_new_job(global, &def_thread);
1143                                 if (!td)
1144                                         return 0;
1145                         }
1146
1147                         ret = fio_cmd_option_parse(td, opt, val);
1148                         break;
1149                 }
1150                 default:
1151                         do_exit++;
1152                         exit_val = 1;
1153                         break;
1154                 }
1155         }
1156
1157         if (do_exit)
1158                 exit(exit_val);
1159
1160         if (td) {
1161                 if (!ret)
1162                         ret = add_job(td, td->o.name ?: "fio", 0);
1163                 if (ret)
1164                         put_job(td);
1165         }
1166
1167         while (optind < argc) {
1168                 ini_idx++;
1169                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1170                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1171                 optind++;
1172         }
1173
1174         return ini_idx;
1175 }
1176
1177 int parse_options(int argc, char *argv[])
1178 {
1179         int job_files, i;
1180
1181         f_out = stdout;
1182         f_err = stderr;
1183
1184         fio_options_dup_and_init(l_opts);
1185
1186         if (setup_thread_area())
1187                 return 1;
1188         if (fill_def_thread())
1189                 return 1;
1190
1191         job_files = parse_cmd_line(argc, argv);
1192
1193         for (i = 0; i < job_files; i++) {
1194                 if (fill_def_thread())
1195                         return 1;
1196                 if (parse_jobs_ini(ini_file[i], i))
1197                         return 1;
1198                 free(ini_file[i]);
1199         }
1200
1201         free(ini_file);
1202         options_mem_free(&def_thread);
1203
1204         if (!thread_number) {
1205                 if (dump_cmdline)
1206                         return 0;
1207                 if (exec_profile)
1208                         return 0;
1209
1210                 log_err("No jobs defined(s)\n\n");
1211                 usage(argv[0]);
1212                 return 1;
1213         }
1214
1215         if (def_thread.o.gtod_offload) {
1216                 fio_gtod_init();
1217                 fio_gtod_offload = 1;
1218                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1219         }
1220
1221         return 0;
1222 }