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 <assert.h>
  13 #include <sys/ipc.h>
  14 #include <sys/shm.h>
  15 #include <sys/types.h>
  16 #include <sys/stat.h>
  17
  18 #include "fio.h"
  19 #include "parse.h"
  20
  21 #define FIO_RANDSEED            (0xb1899bedUL)
  22
  23 #define td_var_offset(var)      ((size_t) &((struct thread_data *)0)->var)
  24
  25 static int str_ioengine_cb(void *, const char *);
  26 static int str_mem_cb(void *, const char *);
  27 static int str_lockmem_cb(void *, unsigned long *);
  28 #ifdef FIO_HAVE_IOPRIO
  29 static int str_prio_cb(void *, unsigned int *);
  30 static int str_prioclass_cb(void *, unsigned int *);
  31 #endif
  32 static int str_exitall_cb(void);
  33 static int str_cpumask_cb(void *, unsigned int *);
  34
  35 #define __stringify_1(x)        #x
  36 #define __stringify(x)          __stringify_1(x)
  37
  38 /*
  39  * Map of job/command line options
  40  */
  41 static struct fio_option options[] = {
  42         {
  43                 .name   = "description",
  44                 .type   = FIO_OPT_STR_STORE,
  45                 .off1   = td_var_offset(description),
  46                 .help   = "Text job description",
  47         },
  48         {
  49                 .name   = "name",
  50                 .type   = FIO_OPT_STR_STORE,
  51                 .off1   = td_var_offset(name),
  52                 .help   = "Name of this job",
  53         },
  54         {
  55                 .name   = "directory",
  56                 .type   = FIO_OPT_STR_STORE,
  57                 .off1   = td_var_offset(directory),
  58                 .help   = "Directory to store files in",
  59         },
  60         {
  61                 .name   = "filename",
  62                 .type   = FIO_OPT_STR_STORE,
  63                 .off1   = td_var_offset(filename),
  64                 .help   = "Force the use of a specific file",
  65         },
  66         {
  67                 .name   = "rw",
  68                 .type   = FIO_OPT_STR,
  69                 .off1   = td_var_offset(td_ddir),
  70                 .help   = "IO direction",
  71                 .def    = "read",
  72                 .posval = {
  73                           { .ival = "read", .oval = TD_DDIR_READ },
  74                           { .ival = "write", .oval = TD_DDIR_WRITE },
  75                           { .ival = "randread", .oval = TD_DDIR_RANDREAD },
  76                           { .ival = "randwrite", .oval = TD_DDIR_RANDWRITE },
  77                           { .ival = "rw", .oval = TD_DDIR_RW },
  78                           { .ival = "randrw", .oval = TD_DDIR_RANDRW },
  79                           },
  80         },
  81         {
  82                 .name   = "ioengine",
  83                 .type   = FIO_OPT_STR,
  84                 .cb     = str_ioengine_cb,
  85                 .help   = "IO engine to use",
  86                 .def    = "sync",
  87                 .posval = {
  88                           { .ival = "sync", },
  89 #ifdef FIO_HAVE_LIBAIO
  90                           { .ival = "libaio", },
  91 #endif
  92 #ifdef FIO_HAVE_POSIXAIO
  93                           { .ival = "posixaio", },
  94 #endif
  95                           { .ival = "mmap", },
  96 #ifdef FIO_HAVE_SPLICE
  97                           { .ival = "splice", },
  98 #endif
  99 #ifdef FIO_HAVE_SGIO
 100                           { .ival = "sg", },
 101 #endif
 102                           { .ival = "null", }, { .ival = "net", },
 103 #ifdef FIO_HAVE_SYSLET
 104                           { .ival = "syslet-rw", },
 105 #endif
 106                           { .ival = "external", },
 107                           },
 108         },
 109         {
 110                 .name   = "iodepth",
 111                 .type   = FIO_OPT_INT,
 112                 .off1   = td_var_offset(iodepth),
 113                 .help   = "Amount of IO buffers to keep in flight",
 114                 .def    = "1",
 115         },
 116         {
 117                 .name   = "iodepth_batch",
 118                 .type   = FIO_OPT_INT,
 119                 .off1   = td_var_offset(iodepth_batch),
 120                 .help   = "Number of IO to submit in one go",
 121         },
 122         {
 123                 .name   = "iodepth_low",
 124                 .type   = FIO_OPT_INT,
 125                 .off1   = td_var_offset(iodepth_low),
 126                 .help   = "Low water mark for queuing depth",
 127         },
 128         {
 129                 .name   = "size",
 130                 .type   = FIO_OPT_STR_VAL,
 131                 .off1   = td_var_offset(total_file_size),
 132                 .help   = "Size of device or file",
 133         },
 134         {
 135                 .name   = "bs",
 136                 .type   = FIO_OPT_STR_VAL_INT,
 137                 .off1   = td_var_offset(bs[DDIR_READ]),
 138                 .off2   = td_var_offset(bs[DDIR_WRITE]),
 139                 .help   = "Block size unit",
 140                 .def    = "4k",
 141         },
 142         {
 143                 .name   = "bsrange",
 144                 .type   = FIO_OPT_RANGE,
 145                 .off1   = td_var_offset(min_bs[DDIR_READ]),
 146                 .off2   = td_var_offset(max_bs[DDIR_READ]),
 147                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
 148                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
 149                 .help   = "Set block size range (in more detail than bs)",
 150         },
 151         {
 152                 .name   = "bs_unaligned",
 153                 .type   = FIO_OPT_STR_SET,
 154                 .off1   = td_var_offset(bs_unaligned),
 155                 .help   = "Don't sector align IO buffer sizes",
 156         },
 157         {
 158                 .name   = "offset",
 159                 .type   = FIO_OPT_STR_VAL,
 160                 .off1   = td_var_offset(start_offset),
 161                 .help   = "Start IO from this offset",
 162                 .def    = "0",
 163         },
 164         {
 165                 .name   = "randrepeat",
 166                 .type   = FIO_OPT_BOOL,
 167                 .off1   = td_var_offset(rand_repeatable),
 168                 .help   = "Use repeatable random IO pattern",
 169                 .def    = "1",
 170         },
 171         {
 172                 .name   = "norandommap",
 173                 .type   = FIO_OPT_STR_SET,
 174                 .off1   = td_var_offset(norandommap),
 175                 .help   = "Accept potential duplicate random blocks",
 176         },
 177         {
 178                 .name   = "nrfiles",
 179                 .type   = FIO_OPT_INT,
 180                 .off1   = td_var_offset(nr_files),
 181                 .help   = "Split job workload between this number of files",
 182                 .def    = "1",
 183         },
 184         {
 185                 .name   = "file_service_type",
 186                 .type   = FIO_OPT_STR,
 187                 .off1   = td_var_offset(file_service_type),
 188                 .help   = "How to select which file to service next",
 189                 .def    = "roundrobin",
 190                 .posval = {
 191                           { .ival = "random", .oval = FIO_FSERVICE_RANDOM },
 192                           { .ival = "roundrobin", .oval = FIO_FSERVICE_RR },
 193                           },
 194         },
 195         {
 196                 .name   = "fsync",
 197                 .type   = FIO_OPT_INT,
 198                 .off1   = td_var_offset(fsync_blocks),
 199                 .help   = "Issue fsync for writes every given number of blocks",
 200                 .def    = "0",
 201         },
 202         {
 203                 .name   = "direct",
 204                 .type   = FIO_OPT_BOOL,
 205                 .off1   = td_var_offset(odirect),
 206                 .help   = "Use O_DIRECT IO (negates buffered)",
 207                 .def    = "0",
 208         },
 209         {
 210                 .name   = "buffered",
 211                 .type   = FIO_OPT_BOOL,
 212                 .off1   = td_var_offset(odirect),
 213                 .neg    = 1,
 214                 .help   = "Use buffered IO (negates direct)",
 215                 .def    = "1",
 216         },
 217         {
 218                 .name   = "overwrite",
 219                 .type   = FIO_OPT_BOOL,
 220                 .off1   = td_var_offset(overwrite),
 221                 .help   = "When writing, set whether to overwrite current data",
 222                 .def    = "0",
 223         },
 224         {
 225                 .name   = "loops",
 226                 .type   = FIO_OPT_INT,
 227                 .off1   = td_var_offset(loops),
 228                 .help   = "Number of times to run the job",
 229                 .def    = "1",
 230         },
 231         {
 232                 .name   = "numjobs",
 233                 .type   = FIO_OPT_INT,
 234                 .off1   = td_var_offset(numjobs),
 235                 .help   = "Duplicate this job this many times",
 236                 .def    = "1",
 237         },
 238         {
 239                 .name   = "startdelay",
 240                 .type   = FIO_OPT_INT,
 241                 .off1   = td_var_offset(start_delay),
 242                 .help   = "Only start job when this period has passed",
 243                 .def    = "0",
 244         },
 245         {
 246                 .name   = "runtime",
 247                 .alias  = "timeout",
 248                 .type   = FIO_OPT_STR_VAL_TIME,
 249                 .off1   = td_var_offset(timeout),
 250                 .help   = "Stop workload when this amount of time has passed",
 251                 .def    = "0",
 252         },
 253         {
 254                 .name   = "mem",
 255                 .type   = FIO_OPT_STR,
 256                 .cb     = str_mem_cb,
 257                 .off1   = td_var_offset(mem_type),
 258                 .help   = "Backing type for IO buffers",
 259                 .def    = "malloc",
 260                 .posval = {
 261                           { .ival = "malloc", .oval = MEM_MALLOC },
 262                           { .ival = "shm", .oval = MEM_SHM },
 263 #ifdef FIO_HAVE_HUGETLB
 264                           { .ival = "shmhuge", .oval = MEM_SHMHUGE },
 265 #endif
 266                           { .ival = "mmap", .oval = MEM_MMAP },
 267 #ifdef FIO_HAVE_HUGETLB
 268                           { .ival = "mmaphuge", .oval = MEM_MMAPHUGE },
 269 #endif
 270                           },
 271         },
 272         {
 273                 .name   = "verify",
 274                 .type   = FIO_OPT_STR,
 275                 .off1   = td_var_offset(verify),
 276                 .help   = "Verify sum function",
 277                 .def    = "0",
 278                 .posval = {
 279                           { .ival = "0", .oval = VERIFY_NONE },
 280                           { .ival = "crc32", .oval = VERIFY_CRC32 },
 281                           { .ival = "md5", .oval = VERIFY_MD5 },
 282                           },
 283         },
 284         {
 285                 .name   = "write_iolog",
 286                 .type   = FIO_OPT_STR_STORE,
 287                 .off1   = td_var_offset(write_iolog_file),
 288                 .help   = "Store IO pattern to file",
 289         },
 290         {
 291                 .name   = "read_iolog",
 292                 .type   = FIO_OPT_STR_STORE,
 293                 .off1   = td_var_offset(read_iolog_file),
 294                 .help   = "Playback IO pattern from file",
 295         },
 296         {
 297                 .name   = "exec_prerun",
 298                 .type   = FIO_OPT_STR_STORE,
 299                 .off1   = td_var_offset(exec_prerun),
 300                 .help   = "Execute this file prior to running job",
 301         },
 302         {
 303                 .name   = "exec_postrun",
 304                 .type   = FIO_OPT_STR_STORE,
 305                 .off1   = td_var_offset(exec_postrun),
 306                 .help   = "Execute this file after running job",
 307         },
 308 #ifdef FIO_HAVE_IOSCHED_SWITCH
 309         {
 310                 .name   = "ioscheduler",
 311                 .type   = FIO_OPT_STR_STORE,
 312                 .off1   = td_var_offset(ioscheduler),
 313                 .help   = "Use this IO scheduler on the backing device",
 314         },
 315 #endif
 316         {
 317                 .name   = "zonesize",
 318                 .type   = FIO_OPT_STR_VAL,
 319                 .off1   = td_var_offset(zone_size),
 320                 .help   = "Give size of an IO zone",
 321                 .def    = "0",
 322         },
 323         {
 324                 .name   = "zoneskip",
 325                 .type   = FIO_OPT_STR_VAL,
 326                 .off1   = td_var_offset(zone_skip),
 327                 .help   = "Space between IO zones",
 328                 .def    = "0",
 329         },
 330         {
 331                 .name   = "lockmem",
 332                 .type   = FIO_OPT_STR_VAL,
 333                 .cb     = str_lockmem_cb,
 334                 .help   = "Lock down this amount of memory",
 335                 .def    = "0",
 336         },
 337         {
 338                 .name   = "rwmixcycle",
 339                 .type   = FIO_OPT_INT,
 340                 .off1   = td_var_offset(rwmixcycle),
 341                 .help   = "Cycle period for mixed read/write workloads (msec)",
 342                 .def    = "500",
 343         },
 344         {
 345                 .name   = "rwmixread",
 346                 .type   = FIO_OPT_INT,
 347                 .off1   = td_var_offset(rwmixread),
 348                 .maxval = 100,
 349                 .help   = "Percentage of mixed workload that is reads",
 350                 .def    = "50",
 351         },
 352         {
 353                 .name   = "rwmixwrite",
 354                 .type   = FIO_OPT_INT,
 355                 .off1   = td_var_offset(rwmixwrite),
 356                 .maxval = 100,
 357                 .help   = "Percentage of mixed workload that is writes",
 358                 .def    = "50",
 359         },
 360         {
 361                 .name   = "nice",
 362                 .type   = FIO_OPT_INT,
 363                 .off1   = td_var_offset(nice),
 364                 .help   = "Set job CPU nice value",
 365                 .minval = -19,
 366                 .maxval = 20,
 367                 .def    = "0",
 368         },
 369 #ifdef FIO_HAVE_IOPRIO
 370         {
 371                 .name   = "prio",
 372                 .type   = FIO_OPT_INT,
 373                 .cb     = str_prio_cb,
 374                 .help   = "Set job IO priority value",
 375                 .minval = 0,
 376                 .maxval = 7,
 377         },
 378         {
 379                 .name   = "prioclass",
 380                 .type   = FIO_OPT_INT,
 381                 .cb     = str_prioclass_cb,
 382                 .help   = "Set job IO priority class",
 383                 .minval = 0,
 384                 .maxval = 3,
 385         },
 386 #endif
 387         {
 388                 .name   = "thinktime",
 389                 .type   = FIO_OPT_INT,
 390                 .off1   = td_var_offset(thinktime),
 391                 .help   = "Idle time between IO buffers (usec)",
 392                 .def    = "0",
 393         },
 394         {
 395                 .name   = "thinktime_spin",
 396                 .type   = FIO_OPT_INT,
 397                 .off1   = td_var_offset(thinktime_spin),
 398                 .help   = "Start think time by spinning this amount (usec)",
 399                 .def    = "0",
 400         },
 401         {
 402                 .name   = "thinktime_blocks",
 403                 .type   = FIO_OPT_INT,
 404                 .off1   = td_var_offset(thinktime_blocks),
 405                 .help   = "IO buffer period between 'thinktime'",
 406                 .def    = "1",
 407         },
 408         {
 409                 .name   = "rate",
 410                 .type   = FIO_OPT_INT,
 411                 .off1   = td_var_offset(rate),
 412                 .help   = "Set bandwidth rate",
 413         },
 414         {
 415                 .name   = "ratemin",
 416                 .type   = FIO_OPT_INT,
 417                 .off1   = td_var_offset(ratemin),
 418                 .help   = "The bottom limit accepted",
 419         },
 420         {
 421                 .name   = "ratecycle",
 422                 .type   = FIO_OPT_INT,
 423                 .off1   = td_var_offset(ratecycle),
 424                 .help   = "Window average for rate limits (msec)",
 425                 .def    = "1000",
 426         },
 427         {
 428                 .name   = "invalidate",
 429                 .type   = FIO_OPT_BOOL,
 430                 .off1   = td_var_offset(invalidate_cache),
 431                 .help   = "Invalidate buffer/page cache prior to running job",
 432                 .def    = "1",
 433         },
 434         {
 435                 .name   = "sync",
 436                 .type   = FIO_OPT_BOOL,
 437                 .off1   = td_var_offset(sync_io),
 438                 .help   = "Use O_SYNC for buffered writes",
 439                 .def    = "0",
 440         },
 441         {
 442                 .name   = "bwavgtime",
 443                 .type   = FIO_OPT_INT,
 444                 .off1   = td_var_offset(bw_avg_time),
 445                 .help   = "Time window over which to calculate bandwidth (msec)",
 446                 .def    = "500",
 447         },
 448         {
 449                 .name   = "create_serialize",
 450                 .type   = FIO_OPT_BOOL,
 451                 .off1   = td_var_offset(create_serialize),
 452                 .help   = "Serialize creating of job files",
 453                 .def    = "1",
 454         },
 455         {
 456                 .name   = "create_fsync",
 457                 .type   = FIO_OPT_BOOL,
 458                 .off1   = td_var_offset(create_fsync),
 459                 .help   = "Fsync file after creation",
 460                 .def    = "1",
 461         },
 462         {
 463                 .name   = "cpuload",
 464                 .type   = FIO_OPT_INT,
 465                 .off1   = td_var_offset(cpuload),
 466                 .help   = "Use this percentage of CPU",
 467         },
 468         {
 469                 .name   = "cpuchunks",
 470                 .type   = FIO_OPT_INT,
 471                 .off1   = td_var_offset(cpucycle),
 472                 .help   = "Length of the CPU burn cycles",
 473         },
 474 #ifdef FIO_HAVE_CPU_AFFINITY
 475         {
 476                 .name   = "cpumask",
 477                 .type   = FIO_OPT_INT,
 478                 .cb     = str_cpumask_cb,
 479                 .help   = "CPU affinity mask",
 480         },
 481 #endif
 482         {
 483                 .name   = "end_fsync",
 484                 .type   = FIO_OPT_BOOL,
 485                 .off1   = td_var_offset(end_fsync),
 486                 .help   = "Include fsync at the end of job",
 487                 .def    = "0",
 488         },
 489         {
 490                 .name   = "unlink",
 491                 .type   = FIO_OPT_BOOL,
 492                 .off1   = td_var_offset(unlink),
 493                 .help   = "Unlink created files after job has completed",
 494                 .def    = "0",
 495         },
 496         {
 497                 .name   = "exitall",
 498                 .type   = FIO_OPT_STR_SET,
 499                 .cb     = str_exitall_cb,
 500                 .help   = "Terminate all jobs when one exits",
 501         },
 502         {
 503                 .name   = "stonewall",
 504                 .type   = FIO_OPT_STR_SET,
 505                 .off1   = td_var_offset(stonewall),
 506                 .help   = "Insert a hard barrier between this job and previous",
 507         },
 508         {
 509                 .name   = "thread",
 510                 .type   = FIO_OPT_STR_SET,
 511                 .off1   = td_var_offset(use_thread),
 512                 .help   = "Use threads instead of forks",
 513         },
 514         {
 515                 .name   = "write_bw_log",
 516                 .type   = FIO_OPT_STR_SET,
 517                 .off1   = td_var_offset(write_bw_log),
 518                 .help   = "Write log of bandwidth during run",
 519         },
 520         {
 521                 .name   = "write_lat_log",
 522                 .type   = FIO_OPT_STR_SET,
 523                 .off1   = td_var_offset(write_lat_log),
 524                 .help   = "Write log of latency during run",
 525         },
 526         {
 527                 .name   = "hugepage-size",
 528                 .type   = FIO_OPT_STR_VAL,
 529                 .off1   = td_var_offset(hugepage_size),
 530                 .help   = "When using hugepages, specify size of each page",
 531                 .def    = __stringify(FIO_HUGE_PAGE),
 532         },
 533         {
 534                 .name   = "group_reporting",
 535                 .type   = FIO_OPT_STR_SET,
 536                 .off1   = td_var_offset(group_reporting),
 537                 .help   = "Do reporting on a per-group basis",
 538         },
 539         {
 540                 .name = NULL,
 541         },
 542 };
 543
 544 #define FIO_JOB_OPTS    (sizeof(options) / sizeof(struct fio_option))
 545 #define FIO_CMD_OPTS    (16)
 546 #define FIO_GETOPT_JOB  (0x89988998)
 547
 548 /*
 549  * Command line options. These will contain the above, plus a few
 550  * extra that only pertain to fio itself and not jobs.
 551  */
 552 static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
 553         {
 554                 .name           = "output",
 555                 .has_arg        = required_argument,
 556                 .val            = 'o',
 557         },
 558         {
 559                 .name           = "timeout",
 560                 .has_arg        = required_argument,
 561                 .val            = 't',
 562         },
 563         {
 564                 .name           = "latency-log",
 565                 .has_arg        = required_argument,
 566                 .val            = 'l',
 567         },
 568         {
 569                 .name           = "bandwidth-log",
 570                 .has_arg        = required_argument,
 571                 .val            = 'b',
 572         },
 573         {
 574                 .name           = "minimal",
 575                 .has_arg        = optional_argument,
 576                 .val            = 'm',
 577         },
 578         {
 579                 .name           = "version",
 580                 .has_arg        = no_argument,
 581                 .val            = 'v',
 582         },
 583         {
 584                 .name           = "help",
 585                 .has_arg        = no_argument,
 586                 .val            = 'h',
 587         },
 588         {
 589                 .name           = "cmdhelp",
 590                 .has_arg        = optional_argument,
 591                 .val            = 'c',
 592         },
 593         {
 594                 .name           = NULL,
 595         },
 596 };
 597
 598 static int def_timeout = 0;
 599
 600 static char fio_version_string[] = "fio 1.13";
 601
 602 static char **ini_file;
 603 static int max_jobs = MAX_JOBS;
 604
 605 struct thread_data def_thread;
 606 struct thread_data *threads = NULL;
 607
 608 int exitall_on_terminate = 0;
 609 int terse_output = 0;
 610 unsigned long long mlock_size = 0;
 611 FILE *f_out = NULL;
 612 FILE *f_err = NULL;
 613
 614 static int write_lat_log = 0;
 615 int write_bw_log = 0;
 616
 617 FILE *get_f_out()
 618 {
 619         return f_out;
 620 }
 621
 622 FILE *get_f_err()
 623 {
 624         return f_err;
 625 }
 626
 627 /*
 628  * Return a free job structure.
 629  */
 630 static struct thread_data *get_new_job(int global, struct thread_data *parent)
 631 {
 632         struct thread_data *td;
 633
 634         if (global)
 635                 return &def_thread;
 636         if (thread_number >= max_jobs)
 637                 return NULL;
 638
 639         td = &threads[thread_number++];
 640         *td = *parent;
 641
 642         td->thread_number = thread_number;
 643         return td;
 644 }
 645
 646 static void put_job(struct thread_data *td)
 647 {
 648         if (td == &def_thread)
 649                 return;
 650
 651         if (td->error)
 652                 fprintf(f_out, "fio: %s\n", td->verror);
 653
 654         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
 655         thread_number--;
 656 }
 657
 658 /*
 659  * Lazy way of fixing up options that depend on each other. We could also
 660  * define option callback handlers, but this is easier.
 661  */
 662 static void fixup_options(struct thread_data *td)
 663 {
 664         if (!td->rwmixread && td->rwmixwrite)
 665                 td->rwmixread = 100 - td->rwmixwrite;
 666
 667         if (td->write_iolog_file && td->read_iolog_file) {
 668                 log_err("fio: read iolog overrides write_iolog\n");
 669                 free(td->write_iolog_file);
 670                 td->write_iolog_file = NULL;
 671         }
 672
 673         if (td->io_ops->flags & FIO_SYNCIO)
 674                 td->iodepth = 1;
 675         else {
 676                 if (!td->iodepth)
 677                         td->iodepth = td->nr_files;
 678         }
 679
 680         /*
 681          * only really works for sequential io for now, and with 1 file
 682          */
 683         if (td->zone_size && td_random(td) && td->nr_files == 1)
 684                 td->zone_size = 0;
 685
 686         /*
 687          * Reads can do overwrites, we always need to pre-create the file
 688          */
 689         if (td_read(td) || td_rw(td))
 690                 td->overwrite = 1;
 691
 692         if (!td->min_bs[DDIR_READ])
 693                 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
 694         if (!td->max_bs[DDIR_READ])
 695                 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
 696         if (!td->min_bs[DDIR_WRITE])
 697                 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
 698         if (!td->max_bs[DDIR_WRITE])
 699                 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
 700
 701         td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
 702
 703         if (td_read(td) && !td_rw(td))
 704                 td->verify = 0;
 705
 706         if (td->norandommap && td->verify != VERIFY_NONE) {
 707                 log_err("fio: norandommap given, verify disabled\n");
 708                 td->verify = VERIFY_NONE;
 709         }
 710         if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
 711                 log_err("fio: bs_unaligned may not work with raw io\n");
 712
 713         /*
 714          * O_DIRECT and char doesn't mix, clear that flag if necessary.
 715          */
 716         if (td->filetype == FIO_TYPE_CHAR && td->odirect)
 717                 td->odirect = 0;
 718
 719         /*
 720          * thinktime_spin must be less than thinktime
 721          */
 722         if (td->thinktime_spin > td->thinktime)
 723                 td->thinktime_spin = td->thinktime;
 724
 725         /*
 726          * The low water mark cannot be bigger than the iodepth
 727          */
 728         if (td->iodepth_low > td->iodepth || !td->iodepth_low) {
 729                 /*
 730                  * syslet work around - if the workload is sequential,
 731                  * we want to let the queue drain all the way down to
 732                  * avoid seeking between async threads
 733                  */
 734                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
 735                         td->iodepth_low = 1;
 736                 else
 737                         td->iodepth_low = td->iodepth;
 738         }
 739
 740         /*
 741          * If batch number isn't set, default to the same as iodepth
 742          */
 743         if (td->iodepth_batch > td->iodepth || !td->iodepth_batch)
 744                 td->iodepth_batch = td->iodepth;
 745 }
 746
 747 /*
 748  * This function leaks the buffer
 749  */
 750 static char *to_kmg(unsigned int val)
 751 {
 752         char *buf = malloc(32);
 753         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
 754         char *p = post;
 755
 756         do {
 757                 if (val & 1023)
 758                         break;
 759
 760                 val >>= 10;
 761                 p++;
 762         } while (*p);
 763
 764         snprintf(buf, 31, "%u%c", val, *p);
 765         return buf;
 766 }
 767
 768 /*
 769  * Adds a job to the list of things todo. Sanitizes the various options
 770  * to make sure we don't have conflicts, and initializes various
 771  * members of td.
 772  */
 773 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 774 {
 775         const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
 776                                    "randread", "randwrite", "randrw" };
 777         struct stat sb;
 778         int numjobs, i;
 779         struct fio_file *f;
 780
 781         /*
 782          * the def_thread is just for options, it's not a real job
 783          */
 784         if (td == &def_thread)
 785                 return 0;
 786
 787         assert(td->io_ops);
 788
 789         if (td->odirect)
 790                 td->io_ops->flags |= FIO_RAWIO;
 791
 792         td->filetype = FIO_TYPE_FILE;
 793         if (td->filename && !lstat(td->filename, &sb)) {
 794                 if (S_ISBLK(sb.st_mode))
 795                         td->filetype = FIO_TYPE_BD;
 796                 else if (S_ISCHR(sb.st_mode))
 797                         td->filetype = FIO_TYPE_CHAR;
 798         }
 799
 800         fixup_options(td);
 801
 802         if (td->filename)
 803                 td->nr_uniq_files = 1;
 804         else
 805                 td->nr_uniq_files = td->nr_files;
 806
 807         if (td->filetype == FIO_TYPE_FILE || td->filename) {
 808                 char tmp[PATH_MAX];
 809                 int len = 0;
 810
 811                 if (td->directory && td->directory[0] != '\0') {
 812                         if (lstat(td->directory, &sb) < 0) {
 813                                 log_err("fio: %s is not a directory\n", td->directory);
 814                                 td_verror(td, errno, "lstat");
 815                                 return 1;
 816                         }
 817                         if (!S_ISDIR(sb.st_mode)) {
 818                                 log_err("fio: %s is not a directory\n", td->directory);
 819                                 return 1;
 820                         }
 821                         len = sprintf(tmp, "%s/", td->directory);
 822                 }
 823
 824                 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
 825
 826                 for_each_file(td, f, i) {
 827                         memset(f, 0, sizeof(*f));
 828                         f->fd = -1;
 829
 830                         if (td->filename)
 831                                 sprintf(tmp + len, "%s", td->filename);
 832                         else
 833                                 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
 834                         f->file_name = strdup(tmp);
 835                 }
 836         } else {
 837                 td->nr_files = 1;
 838                 td->files = malloc(sizeof(struct fio_file));
 839                 f = &td->files[0];
 840
 841                 memset(f, 0, sizeof(*f));
 842                 f->fd = -1;
 843                 f->file_name = strdup(jobname);
 844         }
 845
 846         for_each_file(td, f, i) {
 847                 f->file_size = td->total_file_size / td->nr_files;
 848                 f->file_offset = td->start_offset;
 849         }
 850
 851         fio_sem_init(&td->mutex, 0);
 852
 853         td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
 854         td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
 855         td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
 856
 857         if (td->stonewall && td->thread_number > 1)
 858                 groupid++;
 859
 860         td->groupid = groupid;
 861
 862         if (setup_rate(td))
 863                 goto err;
 864
 865         if (td->write_lat_log) {
 866                 setup_log(&td->ts.slat_log);
 867                 setup_log(&td->ts.clat_log);
 868         }
 869         if (td->write_bw_log)
 870                 setup_log(&td->ts.bw_log);
 871
 872         if (!td->name)
 873                 td->name = strdup(jobname);
 874
 875         if (!terse_output) {
 876                 if (!job_add_num) {
 877                         if (td->io_ops->flags & FIO_CPUIO)
 878                                 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
 879                         else {
 880                                 char *c1, *c2, *c3, *c4;
 881
 882                                 c1 = to_kmg(td->min_bs[DDIR_READ]);
 883                                 c2 = to_kmg(td->max_bs[DDIR_READ]);
 884                                 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
 885                                 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
 886
 887                                 fprintf(f_out, "%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[td->td_ddir], c1, c2, c3, c4, td->io_ops->name, td->iodepth);
 888
 889                                 free(c1);
 890                                 free(c2);
 891                                 free(c3);
 892                                 free(c4);
 893                         }
 894                 } else if (job_add_num == 1)
 895                         fprintf(f_out, "...\n");
 896         }
 897
 898         /*
 899          * recurse add identical jobs, clear numjobs and stonewall options
 900          * as they don't apply to sub-jobs
 901          */
 902         numjobs = td->numjobs;
 903         while (--numjobs) {
 904                 struct thread_data *td_new = get_new_job(0, td);
 905
 906                 if (!td_new)
 907                         goto err;
 908
 909                 td_new->numjobs = 1;
 910                 td_new->stonewall = 0;
 911                 job_add_num = numjobs - 1;
 912
 913                 if (add_job(td_new, jobname, job_add_num))
 914                         goto err;
 915         }
 916         return 0;
 917 err:
 918         put_job(td);
 919         return -1;
 920 }
 921
 922 /*
 923  * Initialize the various random states we need (random io, block size ranges,
 924  * read/write mix, etc).
 925  */
 926 int init_random_state(struct thread_data *td)
 927 {
 928         unsigned long seeds[5];
 929         int fd, num_maps, blocks, i;
 930         struct fio_file *f;
 931
 932         if (td->io_ops->flags & FIO_CPUIO)
 933                 return 0;
 934
 935         fd = open("/dev/urandom", O_RDONLY);
 936         if (fd == -1) {
 937                 td_verror(td, errno, "open");
 938                 return 1;
 939         }
 940
 941         if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
 942                 td_verror(td, EIO, "read");
 943                 close(fd);
 944                 return 1;
 945         }
 946
 947         close(fd);
 948
 949         os_random_seed(seeds[0], &td->bsrange_state);
 950         os_random_seed(seeds[1], &td->verify_state);
 951         os_random_seed(seeds[2], &td->rwmix_state);
 952
 953         if (td->file_service_type == FIO_FSERVICE_RANDOM)
 954                 os_random_seed(seeds[3], &td->next_file_state);
 955
 956         if (!td_random(td))
 957                 return 0;
 958
 959         if (td->rand_repeatable)
 960                 seeds[4] = FIO_RANDSEED * td->thread_number;
 961
 962         if (!td->norandommap) {
 963                 for_each_file(td, f, i) {
 964                         blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
 965                         num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
 966                         f->file_map = malloc(num_maps * sizeof(long));
 967                         f->num_maps = num_maps;
 968                         memset(f->file_map, 0, num_maps * sizeof(long));
 969                 }
 970         }
 971
 972         os_random_seed(seeds[4], &td->random_state);
 973         return 0;
 974 }
 975
 976 static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
 977 {
 978 #ifdef FIO_HAVE_CPU_AFFINITY
 979         unsigned int i;
 980
 981         CPU_ZERO(&cpumask);
 982
 983         for (i = 0; i < sizeof(int) * 8; i++) {
 984                 if ((1 << i) & cpu)
 985                         CPU_SET(i, &cpumask);
 986         }
 987 #endif
 988 }
 989
 990 static int is_empty_or_comment(char *line)
 991 {
 992         unsigned int i;
 993
 994         for (i = 0; i < strlen(line); i++) {
 995                 if (line[i] == ';')
 996                         return 1;
 997                 if (line[i] == '#')
 998                         return 1;
 999                 if (!isspace(line[i]) && !iscntrl(line[i]))
1000                         return 0;
1001         }
1002
1003         return 1;
1004 }
1005
1006 /*
1007  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
1008  */
1009 static char *get_mmap_file(const char *str)
1010 {
1011         char *p = strstr(str, ":");
1012
1013         if (!p)
1014                 return NULL;
1015
1016         p++;
1017         strip_blank_front(&p);
1018         strip_blank_end(p);
1019         return strdup(p);
1020 }
1021
1022 static int str_mem_cb(void *data, const char *mem)
1023 {
1024         struct thread_data *td = data;
1025
1026         if (td->mem_type == MEM_MMAPHUGE || td->mem_type == MEM_MMAP) {
1027                 td->mmapfile = get_mmap_file(mem);
1028                 if (td->mem_type == MEM_MMAPHUGE && !td->mmapfile) {
1029                         log_err("fio: mmaphuge:/path/to/file\n");
1030                         return 1;
1031                 }
1032         }
1033
1034         return 0;
1035 }
1036
1037 /* External engines are specified by "external:name.o") */
1038 static const char *get_engine_name(const char *str)
1039 {
1040         char *p = strstr(str, ":");
1041
1042         if (!p)
1043                 return str;
1044
1045         p++;
1046         strip_blank_front(&p);
1047         strip_blank_end(p);
1048         return p;
1049 }
1050
1051 static int str_ioengine_cb(void *data, const char *str)
1052 {
1053         struct thread_data *td = data;
1054         const char *name = get_engine_name(str);
1055
1056         td->io_ops = load_ioengine(td, name);
1057         if (td->io_ops)
1058                 return 0;
1059
1060         return 1;
1061 }
1062
1063 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1064 {
1065         mlock_size = *val;
1066         return 0;
1067 }
1068
1069 #ifdef FIO_HAVE_IOPRIO
1070 static int str_prioclass_cb(void *data, unsigned int *val)
1071 {
1072         struct thread_data *td = data;
1073
1074         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1075         return 0;
1076 }
1077
1078 static int str_prio_cb(void *data, unsigned int *val)
1079 {
1080         struct thread_data *td = data;
1081
1082         td->ioprio |= *val;
1083         return 0;
1084 }
1085 #endif
1086
1087 static int str_exitall_cb(void)
1088 {
1089         exitall_on_terminate = 1;
1090         return 0;
1091 }
1092
1093 static int str_cpumask_cb(void *data, unsigned int *val)
1094 {
1095         struct thread_data *td = data;
1096
1097         fill_cpu_mask(td->cpumask, *val);
1098         return 0;
1099 }
1100
1101 /*
1102  * This is our [ini] type file parser.
1103  */
1104 static int parse_jobs_ini(char *file, int stonewall_flag)
1105 {
1106         unsigned int global;
1107         struct thread_data *td;
1108         char *string, *name;
1109         fpos_t off;
1110         FILE *f;
1111         char *p;
1112         int ret = 0, stonewall;
1113
1114         f = fopen(file, "r");
1115         if (!f) {
1116                 perror("fopen job file");
1117                 return 1;
1118         }
1119
1120         string = malloc(4096);
1121         name = malloc(256);
1122         memset(name, 0, 256);
1123
1124         stonewall = stonewall_flag;
1125         do {
1126                 p = fgets(string, 4095, f);
1127                 if (!p)
1128                         break;
1129                 if (is_empty_or_comment(p))
1130                         continue;
1131                 if (sscanf(p, "[%255s]", name) != 1)
1132                         continue;
1133
1134                 global = !strncmp(name, "global", 6);
1135
1136                 name[strlen(name) - 1] = '\0';
1137
1138                 td = get_new_job(global, &def_thread);
1139                 if (!td) {
1140                         ret = 1;
1141                         break;
1142                 }
1143
1144                 /*
1145                  * Seperate multiple job files by a stonewall
1146                  */
1147                 if (!global && stonewall) {
1148                         td->stonewall = stonewall;
1149                         stonewall = 0;
1150                 }
1151
1152                 fgetpos(f, &off);
1153                 while ((p = fgets(string, 4096, f)) != NULL) {
1154                         if (is_empty_or_comment(p))
1155                                 continue;
1156
1157                         strip_blank_front(&p);
1158
1159                         if (p[0] == '[')
1160                                 break;
1161
1162                         strip_blank_end(p);
1163
1164                         fgetpos(f, &off);
1165
1166                         /*
1167                          * Don't break here, continue parsing options so we
1168                          * dump all the bad ones. Makes trial/error fixups
1169                          * easier on the user.
1170                          */
1171                         ret |= parse_option(p, options, td);
1172                 }
1173
1174                 if (!ret) {
1175                         fsetpos(f, &off);
1176                         ret = add_job(td, name, 0);
1177                 } else {
1178                         log_err("fio: job %s dropped\n", name);
1179                         put_job(td);
1180                 }
1181         } while (!ret);
1182
1183         free(string);
1184         free(name);
1185         fclose(f);
1186         return ret;
1187 }
1188
1189 static int fill_def_thread(void)
1190 {
1191         memset(&def_thread, 0, sizeof(def_thread));
1192
1193         if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1194                 perror("sched_getaffinity");
1195                 return 1;
1196         }
1197
1198         /*
1199          * fill default options
1200          */
1201         fill_default_options(&def_thread, options);
1202
1203         def_thread.timeout = def_timeout;
1204         def_thread.write_bw_log = write_bw_log;
1205         def_thread.write_lat_log = write_lat_log;
1206
1207 #ifdef FIO_HAVE_DISK_UTIL
1208         def_thread.do_disk_util = 1;
1209 #endif
1210
1211         return 0;
1212 }
1213
1214 static void usage(void)
1215 {
1216         printf("%s\n", fio_version_string);
1217         printf("\t--output\tWrite output to file\n");
1218         printf("\t--timeout\tRuntime in seconds\n");
1219         printf("\t--latency-log\tGenerate per-job latency logs\n");
1220         printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1221         printf("\t--minimal\tMinimal (terse) output\n");
1222         printf("\t--version\tPrint version info and exit\n");
1223         printf("\t--help\t\tPrint this page\n");
1224         printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
1225 }
1226
1227 static int parse_cmd_line(int argc, char *argv[])
1228 {
1229         struct thread_data *td = NULL;
1230         int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
1231
1232         while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
1233                 switch (c) {
1234                 case 't':
1235                         def_timeout = atoi(optarg);
1236                         break;
1237                 case 'l':
1238                         write_lat_log = 1;
1239                         break;
1240                 case 'w':
1241                         write_bw_log = 1;
1242                         break;
1243                 case 'o':
1244                         f_out = fopen(optarg, "w+");
1245                         if (!f_out) {
1246                                 perror("fopen output");
1247                                 exit(1);
1248                         }
1249                         f_err = f_out;
1250                         break;
1251                 case 'm':
1252                         terse_output = 1;
1253                         break;
1254                 case 'h':
1255                         usage();
1256                         exit(0);
1257                 case 'c':
1258                         ret = show_cmd_help(options, optarg);
1259                         exit(ret);
1260                 case 'v':
1261                         printf("%s\n", fio_version_string);
1262                         exit(0);
1263                 case FIO_GETOPT_JOB: {
1264                         const char *opt = long_options[lidx].name;
1265                         char *val = optarg;
1266
1267                         if (!strncmp(opt, "name", 4) && td) {
1268                                 ret = add_job(td, td->name ?: "fio", 0);
1269                                 if (ret) {
1270                                         put_job(td);
1271                                         return 0;
1272                                 }
1273                                 td = NULL;
1274                         }
1275                         if (!td) {
1276                                 int global = !strncmp(val, "global", 6);
1277
1278                                 td = get_new_job(global, &def_thread);
1279                                 if (!td)
1280                                         return 0;
1281                         }
1282
1283                         ret = parse_cmd_option(opt, val, options, td);
1284                         if (ret)
1285                                 dont_add_job = 1;
1286                         break;
1287                 }
1288                 default:
1289                         break;
1290                 }
1291         }
1292
1293         if (td) {
1294                 if (dont_add_job)
1295                         put_job(td);
1296                 else {
1297                         ret = add_job(td, td->name ?: "fio", 0);
1298                         if (ret)
1299                                 put_job(td);
1300                 }
1301         }
1302
1303         while (optind < argc) {
1304                 ini_idx++;
1305                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1306                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1307                 optind++;
1308         }
1309
1310         return ini_idx;
1311 }
1312
1313 static void free_shm(void)
1314 {
1315         struct shmid_ds sbuf;
1316
1317         if (threads) {
1318                 shmdt((void *) threads);
1319                 threads = NULL;
1320                 shmctl(shm_id, IPC_RMID, &sbuf);
1321         }
1322 }
1323
1324 /*
1325  * The thread area is shared between the main process and the job
1326  * threads/processes. So setup a shared memory segment that will hold
1327  * all the job info.
1328  */
1329 static int setup_thread_area(void)
1330 {
1331         /*
1332          * 1024 is too much on some machines, scale max_jobs if
1333          * we get a failure that looks like too large a shm segment
1334          */
1335         do {
1336                 size_t size = max_jobs * sizeof(struct thread_data);
1337
1338                 shm_id = shmget(0, size, IPC_CREAT | 0600);
1339                 if (shm_id != -1)
1340                         break;
1341                 if (errno != EINVAL) {
1342                         perror("shmget");
1343                         break;
1344                 }
1345
1346                 max_jobs >>= 1;
1347         } while (max_jobs);
1348
1349         if (shm_id == -1)
1350                 return 1;
1351
1352         threads = shmat(shm_id, NULL, 0);
1353         if (threads == (void *) -1) {
1354                 perror("shmat");
1355                 return 1;
1356         }
1357
1358         atexit(free_shm);
1359         return 0;
1360 }
1361
1362 /*
1363  * Copy the fio options into the long options map, so we mirror
1364  * job and cmd line options.
1365  */
1366 static void dupe_job_options(void)
1367 {
1368         struct fio_option *o;
1369         unsigned int i;
1370
1371         i = 0;
1372         while (long_options[i].name)
1373                 i++;
1374
1375         o = &options[0];
1376         while (o->name) {
1377                 long_options[i].name = o->name;
1378                 long_options[i].val = FIO_GETOPT_JOB;
1379                 if (o->type == FIO_OPT_STR_SET)
1380                         long_options[i].has_arg = no_argument;
1381                 else
1382                         long_options[i].has_arg = required_argument;
1383
1384                 i++;
1385                 o++;
1386                 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1387         }
1388 }
1389
1390 int parse_options(int argc, char *argv[])
1391 {
1392         int job_files, i;
1393
1394         f_out = stdout;
1395         f_err = stderr;
1396
1397         options_init(options);
1398
1399         dupe_job_options();
1400
1401         if (setup_thread_area())
1402                 return 1;
1403         if (fill_def_thread())
1404                 return 1;
1405
1406         job_files = parse_cmd_line(argc, argv);
1407
1408         for (i = 0; i < job_files; i++) {
1409                 if (fill_def_thread())
1410                         return 1;
1411                 if (parse_jobs_ini(ini_file[i], i))
1412                         return 1;
1413                 free(ini_file[i]);
1414         }
1415
1416         free(ini_file);
1417
1418         if (!thread_number) {
1419                 log_err("No jobs defined(s)\n");
1420                 return 1;
1421         }
1422
1423         return 0;
1424 }