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