init.c

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