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