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