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