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