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