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