init.c

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