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