options.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <unistd.h>
   4 #include <ctype.h>
   5 #include <string.h>
   6 #include <getopt.h>
   7 #include <assert.h>
   8
   9 #include "fio.h"
  10 #include "parse.h"
  11
  12 #define td_var_offset(var)      ((size_t) &((struct thread_options *)0)->var)
  13
  14 /*
  15  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
  16  */
  17 static char *get_opt_postfix(const char *str)
  18 {
  19         char *p = strstr(str, ":");
  20
  21         if (!p)
  22                 return NULL;
  23
  24         p++;
  25         strip_blank_front(&p);
  26         strip_blank_end(p);
  27         return strdup(p);
  28 }
  29
  30 static int str_rw_cb(void *data, const char *str)
  31 {
  32         struct thread_data *td = data;
  33         char *nr = get_opt_postfix(str);
  34
  35         td->o.ddir_nr = 1;
  36         if (nr)
  37                 td->o.ddir_nr = atoi(nr);
  38
  39         return 0;
  40 }
  41
  42 static int str_mem_cb(void *data, const char *mem)
  43 {
  44         struct thread_data *td = data;
  45
  46         if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
  47                 td->mmapfile = get_opt_postfix(mem);
  48                 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
  49                         log_err("fio: mmaphuge:/path/to/file\n");
  50                         return 1;
  51                 }
  52         }
  53
  54         return 0;
  55 }
  56
  57 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
  58 {
  59         mlock_size = *val;
  60         return 0;
  61 }
  62
  63 #ifdef FIO_HAVE_IOPRIO
  64 static int str_prioclass_cb(void *data, unsigned int *val)
  65 {
  66         struct thread_data *td = data;
  67         unsigned short mask;
  68
  69         /*
  70          * mask off old class bits, str_prio_cb() may have set a default class
  71          */
  72         mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
  73         td->ioprio &= mask;
  74
  75         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
  76         return 0;
  77 }
  78
  79 static int str_prio_cb(void *data, unsigned int *val)
  80 {
  81         struct thread_data *td = data;
  82
  83         td->ioprio |= *val;
  84
  85         /*
  86          * If no class is set, assume BE
  87          */
  88         if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
  89                 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
  90
  91         return 0;
  92 }
  93 #endif
  94
  95 static int str_exitall_cb(void)
  96 {
  97         exitall_on_terminate = 1;
  98         return 0;
  99 }
 100
 101 #ifdef FIO_HAVE_CPU_AFFINITY
 102 static int str_cpumask_cb(void *data, unsigned int *val)
 103 {
 104         struct thread_data *td = data;
 105         unsigned int i;
 106
 107         CPU_ZERO(&td->o.cpumask);
 108
 109         for (i = 0; i < sizeof(int) * 8; i++)
 110                 if ((1 << i) & *val)
 111                         CPU_SET(*val, &td->o.cpumask);
 112
 113         td->o.cpumask_set = 1;
 114         return 0;
 115 }
 116
 117 static int str_cpus_allowed_cb(void *data, const char *input)
 118 {
 119         struct thread_data *td = data;
 120         char *cpu, *str, *p;
 121
 122         CPU_ZERO(&td->o.cpumask);
 123
 124         p = str = strdup(input);
 125
 126         strip_blank_front(&str);
 127         strip_blank_end(str);
 128
 129         while ((cpu = strsep(&str, ",")) != NULL) {
 130                 if (!strlen(cpu))
 131                         break;
 132                 CPU_SET(atoi(cpu), &td->o.cpumask);
 133         }
 134
 135         free(p);
 136         td->o.cpumask_set = 1;
 137         exit(0);
 138         return 0;
 139 }
 140 #endif
 141
 142 static int str_fst_cb(void *data, const char *str)
 143 {
 144         struct thread_data *td = data;
 145         char *nr = get_opt_postfix(str);
 146
 147         td->file_service_nr = 1;
 148         if (nr)
 149                 td->file_service_nr = atoi(nr);
 150
 151         return 0;
 152 }
 153
 154 static int str_filename_cb(void *data, const char *input)
 155 {
 156         struct thread_data *td = data;
 157         char *fname, *str, *p;
 158
 159         p = str = strdup(input);
 160
 161         strip_blank_front(&str);
 162         strip_blank_end(str);
 163
 164         if (!td->files_index)
 165                 td->o.nr_files = 0;
 166
 167         while ((fname = strsep(&str, ":")) != NULL) {
 168                 if (!strlen(fname))
 169                         break;
 170                 add_file(td, fname);
 171                 td->o.nr_files++;
 172         }
 173
 174         free(p);
 175         return 0;
 176 }
 177
 178 static int str_directory_cb(void *data, const char fio_unused *str)
 179 {
 180         struct thread_data *td = data;
 181         struct stat sb;
 182
 183         if (lstat(td->o.directory, &sb) < 0) {
 184                 log_err("fio: %s is not a directory\n", td->o.directory);
 185                 td_verror(td, errno, "lstat");
 186                 return 1;
 187         }
 188         if (!S_ISDIR(sb.st_mode)) {
 189                 log_err("fio: %s is not a directory\n", td->o.directory);
 190                 return 1;
 191         }
 192
 193         return 0;
 194 }
 195
 196 static int str_opendir_cb(void *data, const char fio_unused *str)
 197 {
 198         struct thread_data *td = data;
 199
 200         if (!td->files_index)
 201                 td->o.nr_files = 0;
 202
 203         return add_dir_files(td, td->o.opendir);
 204 }
 205
 206
 207 #define __stringify_1(x)        #x
 208 #define __stringify(x)          __stringify_1(x)
 209
 210 /*
 211  * Map of job/command line options
 212  */
 213 static struct fio_option options[] = {
 214         {
 215                 .name   = "description",
 216                 .type   = FIO_OPT_STR_STORE,
 217                 .off1   = td_var_offset(description),
 218                 .help   = "Text job description",
 219         },
 220         {
 221                 .name   = "name",
 222                 .type   = FIO_OPT_STR_STORE,
 223                 .off1   = td_var_offset(name),
 224                 .help   = "Name of this job",
 225         },
 226         {
 227                 .name   = "directory",
 228                 .type   = FIO_OPT_STR_STORE,
 229                 .off1   = td_var_offset(directory),
 230                 .cb     = str_directory_cb,
 231                 .help   = "Directory to store files in",
 232         },
 233         {
 234                 .name   = "filename",
 235                 .type   = FIO_OPT_STR_STORE,
 236                 .off1   = td_var_offset(filename),
 237                 .cb     = str_filename_cb,
 238                 .help   = "File(s) to use for the workload",
 239         },
 240         {
 241                 .name   = "opendir",
 242                 .type   = FIO_OPT_STR_STORE,
 243                 .off1   = td_var_offset(opendir),
 244                 .cb     = str_opendir_cb,
 245                 .help   = "Recursively add files from this directory and down",
 246         },
 247         {
 248                 .name   = "rw",
 249                 .alias  = "readwrite",
 250                 .type   = FIO_OPT_STR,
 251                 .cb     = str_rw_cb,
 252                 .off1   = td_var_offset(td_ddir),
 253                 .help   = "IO direction",
 254                 .def    = "read",
 255                 .posval = {
 256                           { .ival = "read",
 257                             .oval = TD_DDIR_READ,
 258                             .help = "Sequential read",
 259                           },
 260                           { .ival = "write",
 261                             .oval = TD_DDIR_WRITE,
 262                             .help = "Sequential write",
 263                           },
 264                           { .ival = "randread",
 265                             .oval = TD_DDIR_RANDREAD,
 266                             .help = "Random read",
 267                           },
 268                           { .ival = "randwrite",
 269                             .oval = TD_DDIR_RANDWRITE,
 270                             .help = "Random write",
 271                           },
 272                           { .ival = "rw",
 273                             .oval = TD_DDIR_RW,
 274                             .help = "Sequential read and write mix",
 275                           },
 276                           { .ival = "randrw",
 277                             .oval = TD_DDIR_RANDRW,
 278                             .help = "Random read and write mix"
 279                           },
 280                 },
 281         },
 282         {
 283                 .name   = "fadvise_hint",
 284                 .type   = FIO_OPT_BOOL,
 285                 .off1   = td_var_offset(fadvise_hint),
 286                 .help   = "Use fadvise() to advise the kernel on IO pattern",
 287                 .def    = "1",
 288         },
 289         {
 290                 .name   = "ioengine",
 291                 .type   = FIO_OPT_STR_STORE,
 292                 .off1   = td_var_offset(ioengine),
 293                 .help   = "IO engine to use",
 294                 .def    = "sync",
 295                 .posval = {
 296                           { .ival = "sync",
 297                             .help = "Use read/write",
 298                           },
 299 #ifdef FIO_HAVE_LIBAIO
 300                           { .ival = "libaio",
 301                             .help = "Linux native asynchronous IO",
 302                           },
 303 #endif
 304 #ifdef FIO_HAVE_POSIXAIO
 305                           { .ival = "posixaio",
 306                             .help = "POSIX asynchronous IO",
 307                           },
 308 #endif
 309                           { .ival = "mmap",
 310                             .help = "Memory mapped IO",
 311                           },
 312 #ifdef FIO_HAVE_SPLICE
 313                           { .ival = "splice",
 314                             .help = "splice/vmsplice based IO",
 315                           },
 316                           { .ival = "netsplice",
 317                             .help = "splice/vmsplice to/from the network",
 318                           },
 319 #endif
 320 #ifdef FIO_HAVE_SGIO
 321                           { .ival = "sg",
 322                             .help = "SCSI generic v3 IO",
 323                           },
 324 #endif
 325                           { .ival = "null",
 326                             .help = "Testing engine (no data transfer)",
 327                           },
 328                           { .ival = "net",
 329                             .help = "Network IO",
 330                           },
 331 #ifdef FIO_HAVE_SYSLET
 332                           { .ival = "syslet-rw",
 333                             .help = "syslet enabled async pread/pwrite IO",
 334                           },
 335 #endif
 336                           { .ival = "cpuio",
 337                             .help = "CPU cycler burner engine",
 338                           },
 339 #ifdef FIO_HAVE_GUASI
 340                           { .ival = "guasi",
 341                             .help = "GUASI IO engine",
 342                           },
 343 #endif
 344                           { .ival = "external",
 345                             .help = "Load external engine (append name)",
 346                           },
 347                 },
 348         },
 349         {
 350                 .name   = "iodepth",
 351                 .type   = FIO_OPT_INT,
 352                 .off1   = td_var_offset(iodepth),
 353                 .help   = "Amount of IO buffers to keep in flight",
 354                 .def    = "1",
 355         },
 356         {
 357                 .name   = "iodepth_batch",
 358                 .type   = FIO_OPT_INT,
 359                 .off1   = td_var_offset(iodepth_batch),
 360                 .help   = "Number of IO to submit in one go",
 361         },
 362         {
 363                 .name   = "iodepth_low",
 364                 .type   = FIO_OPT_INT,
 365                 .off1   = td_var_offset(iodepth_low),
 366                 .help   = "Low water mark for queuing depth",
 367         },
 368         {
 369                 .name   = "size",
 370                 .type   = FIO_OPT_STR_VAL,
 371                 .off1   = td_var_offset(size),
 372                 .minval = 1,
 373                 .help   = "Total size of device or files",
 374         },
 375         {
 376                 .name   = "filesize",
 377                 .type   = FIO_OPT_STR_VAL,
 378                 .off1   = td_var_offset(file_size_low),
 379                 .off2   = td_var_offset(file_size_high),
 380                 .minval = 1,
 381                 .help   = "Size of individual files",
 382         },
 383         {
 384                 .name   = "bs",
 385                 .alias  = "blocksize",
 386                 .type   = FIO_OPT_STR_VAL_INT,
 387                 .off1   = td_var_offset(bs[DDIR_READ]),
 388                 .off2   = td_var_offset(bs[DDIR_WRITE]),
 389                 .minval = 1,
 390                 .help   = "Block size unit",
 391                 .def    = "4k",
 392         },
 393         {
 394                 .name   = "bsrange",
 395                 .alias  = "blocksize_range",
 396                 .type   = FIO_OPT_RANGE,
 397                 .off1   = td_var_offset(min_bs[DDIR_READ]),
 398                 .off2   = td_var_offset(max_bs[DDIR_READ]),
 399                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
 400                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
 401                 .minval = 1,
 402                 .help   = "Set block size range (in more detail than bs)",
 403         },
 404         {
 405                 .name   = "bs_unaligned",
 406                 .alias  = "blocksize_unaligned",
 407                 .type   = FIO_OPT_STR_SET,
 408                 .off1   = td_var_offset(bs_unaligned),
 409                 .help   = "Don't sector align IO buffer sizes",
 410         },
 411         {
 412                 .name   = "offset",
 413                 .type   = FIO_OPT_STR_VAL,
 414                 .off1   = td_var_offset(start_offset),
 415                 .help   = "Start IO from this offset",
 416                 .def    = "0",
 417         },
 418         {
 419                 .name   = "randrepeat",
 420                 .type   = FIO_OPT_BOOL,
 421                 .off1   = td_var_offset(rand_repeatable),
 422                 .help   = "Use repeatable random IO pattern",
 423                 .def    = "1",
 424         },
 425         {
 426                 .name   = "norandommap",
 427                 .type   = FIO_OPT_STR_SET,
 428                 .off1   = td_var_offset(norandommap),
 429                 .help   = "Accept potential duplicate random blocks",
 430         },
 431         {
 432                 .name   = "nrfiles",
 433                 .type   = FIO_OPT_INT,
 434                 .off1   = td_var_offset(nr_files),
 435                 .help   = "Split job workload between this number of files",
 436                 .def    = "1",
 437         },
 438         {
 439                 .name   = "openfiles",
 440                 .type   = FIO_OPT_INT,
 441                 .off1   = td_var_offset(open_files),
 442                 .help   = "Number of files to keep open at the same time",
 443         },
 444         {
 445                 .name   = "file_service_type",
 446                 .type   = FIO_OPT_STR,
 447                 .cb     = str_fst_cb,
 448                 .off1   = td_var_offset(file_service_type),
 449                 .help   = "How to select which file to service next",
 450                 .def    = "roundrobin",
 451                 .posval = {
 452                           { .ival = "random",
 453                             .oval = FIO_FSERVICE_RANDOM,
 454                             .help = "Choose a file at random",
 455                           },
 456                           { .ival = "roundrobin",
 457                             .oval = FIO_FSERVICE_RR,
 458                             .help = "Round robin select files",
 459                           },
 460                 },
 461         },
 462         {
 463                 .name   = "fsync",
 464                 .type   = FIO_OPT_INT,
 465                 .off1   = td_var_offset(fsync_blocks),
 466                 .help   = "Issue fsync for writes every given number of blocks",
 467                 .def    = "0",
 468         },
 469         {
 470                 .name   = "direct",
 471                 .type   = FIO_OPT_BOOL,
 472                 .off1   = td_var_offset(odirect),
 473                 .help   = "Use O_DIRECT IO (negates buffered)",
 474                 .def    = "0",
 475         },
 476         {
 477                 .name   = "buffered",
 478                 .type   = FIO_OPT_BOOL,
 479                 .off1   = td_var_offset(odirect),
 480                 .neg    = 1,
 481                 .help   = "Use buffered IO (negates direct)",
 482                 .def    = "1",
 483         },
 484         {
 485                 .name   = "overwrite",
 486                 .type   = FIO_OPT_BOOL,
 487                 .off1   = td_var_offset(overwrite),
 488                 .help   = "When writing, set whether to overwrite current data",
 489                 .def    = "0",
 490         },
 491         {
 492                 .name   = "loops",
 493                 .type   = FIO_OPT_INT,
 494                 .off1   = td_var_offset(loops),
 495                 .help   = "Number of times to run the job",
 496                 .def    = "1",
 497         },
 498         {
 499                 .name   = "numjobs",
 500                 .type   = FIO_OPT_INT,
 501                 .off1   = td_var_offset(numjobs),
 502                 .help   = "Duplicate this job this many times",
 503                 .def    = "1",
 504         },
 505         {
 506                 .name   = "startdelay",
 507                 .type   = FIO_OPT_INT,
 508                 .off1   = td_var_offset(start_delay),
 509                 .help   = "Only start job when this period has passed",
 510                 .def    = "0",
 511         },
 512         {
 513                 .name   = "runtime",
 514                 .alias  = "timeout",
 515                 .type   = FIO_OPT_STR_VAL_TIME,
 516                 .off1   = td_var_offset(timeout),
 517                 .help   = "Stop workload when this amount of time has passed",
 518                 .def    = "0",
 519         },
 520         {
 521                 .name   = "time_based",
 522                 .type   = FIO_OPT_STR_SET,
 523                 .off1   = td_var_offset(time_based),
 524                 .help   = "Keep running until runtime/timeout is met",
 525         },
 526         {
 527                 .name   = "mem",
 528                 .alias  = "iomem",
 529                 .type   = FIO_OPT_STR,
 530                 .cb     = str_mem_cb,
 531                 .off1   = td_var_offset(mem_type),
 532                 .help   = "Backing type for IO buffers",
 533                 .def    = "malloc",
 534                 .posval = {
 535                           { .ival = "malloc",
 536                             .oval = MEM_MALLOC,
 537                             .help = "Use malloc(3) for IO buffers",
 538                           },
 539                           { .ival = "shm",
 540                             .oval = MEM_SHM,
 541                             .help = "Use shared memory segments for IO buffers",
 542                           },
 543 #ifdef FIO_HAVE_HUGETLB
 544                           { .ival = "shmhuge",
 545                             .oval = MEM_SHMHUGE,
 546                             .help = "Like shm, but use huge pages",
 547                           },
 548 #endif
 549                           { .ival = "mmap",
 550                             .oval = MEM_MMAP,
 551                             .help = "Use mmap(2) (file or anon) for IO buffers",
 552                           },
 553 #ifdef FIO_HAVE_HUGETLB
 554                           { .ival = "mmaphuge",
 555                             .oval = MEM_MMAPHUGE,
 556                             .help = "Like mmap, but use huge pages",
 557                           },
 558 #endif
 559                   },
 560         },
 561         {
 562                 .name   = "verify",
 563                 .type   = FIO_OPT_STR,
 564                 .off1   = td_var_offset(verify),
 565                 .help   = "Verify data written",
 566                 .def    = "0",
 567                 .posval = {
 568                           { .ival = "0",
 569                             .oval = VERIFY_NONE,
 570                             .help = "Don't do IO verification",
 571                           },
 572                           { .ival = "crc32",
 573                             .oval = VERIFY_CRC32,
 574                             .help = "Use crc32 checksums for verification",
 575                           },
 576                           { .ival = "crc16",
 577                             .oval = VERIFY_CRC16,
 578                             .help = "Use crc16 checksums for verification",
 579                           },
 580                           { .ival = "crc7",
 581                             .oval = VERIFY_CRC7,
 582                             .help = "Use crc7 checksums for verification",
 583                           },
 584                           { .ival = "md5",
 585                             .oval = VERIFY_MD5,
 586                             .help = "Use md5 checksums for verification",
 587                           },
 588                           {
 589                             .ival = "null",
 590                             .oval = VERIFY_NULL,
 591                             .help = "Pretend to verify",
 592                           },
 593                 },
 594         },
 595         {
 596                 .name   = "verifysort",
 597                 .type   = FIO_OPT_BOOL,
 598                 .off1   = td_var_offset(verifysort),
 599                 .help   = "Sort written verify blocks for read back",
 600                 .def    = "1",
 601         },
 602         {
 603                 .name   = "write_iolog",
 604                 .type   = FIO_OPT_STR_STORE,
 605                 .off1   = td_var_offset(write_iolog_file),
 606                 .help   = "Store IO pattern to file",
 607         },
 608         {
 609                 .name   = "read_iolog",
 610                 .type   = FIO_OPT_STR_STORE,
 611                 .off1   = td_var_offset(read_iolog_file),
 612                 .help   = "Playback IO pattern from file",
 613         },
 614         {
 615                 .name   = "exec_prerun",
 616                 .type   = FIO_OPT_STR_STORE,
 617                 .off1   = td_var_offset(exec_prerun),
 618                 .help   = "Execute this file prior to running job",
 619         },
 620         {
 621                 .name   = "exec_postrun",
 622                 .type   = FIO_OPT_STR_STORE,
 623                 .off1   = td_var_offset(exec_postrun),
 624                 .help   = "Execute this file after running job",
 625         },
 626 #ifdef FIO_HAVE_IOSCHED_SWITCH
 627         {
 628                 .name   = "ioscheduler",
 629                 .type   = FIO_OPT_STR_STORE,
 630                 .off1   = td_var_offset(ioscheduler),
 631                 .help   = "Use this IO scheduler on the backing device",
 632         },
 633 #endif
 634         {
 635                 .name   = "zonesize",
 636                 .type   = FIO_OPT_STR_VAL,
 637                 .off1   = td_var_offset(zone_size),
 638                 .help   = "Give size of an IO zone",
 639                 .def    = "0",
 640         },
 641         {
 642                 .name   = "zoneskip",
 643                 .type   = FIO_OPT_STR_VAL,
 644                 .off1   = td_var_offset(zone_skip),
 645                 .help   = "Space between IO zones",
 646                 .def    = "0",
 647         },
 648         {
 649                 .name   = "lockmem",
 650                 .type   = FIO_OPT_STR_VAL,
 651                 .cb     = str_lockmem_cb,
 652                 .help   = "Lock down this amount of memory",
 653                 .def    = "0",
 654         },
 655         {
 656                 .name   = "rwmixcycle",
 657                 .type   = FIO_OPT_INT,
 658                 .off1   = td_var_offset(rwmixcycle),
 659                 .help   = "Cycle period for mixed read/write workloads (msec)",
 660                 .def    = "500",
 661         },
 662         {
 663                 .name   = "rwmixread",
 664                 .type   = FIO_OPT_INT,
 665                 .off1   = td_var_offset(rwmix[DDIR_READ]),
 666                 .maxval = 100,
 667                 .help   = "Percentage of mixed workload that is reads",
 668                 .def    = "50",
 669         },
 670         {
 671                 .name   = "rwmixwrite",
 672                 .type   = FIO_OPT_INT,
 673                 .off1   = td_var_offset(rwmix[DDIR_WRITE]),
 674                 .maxval = 100,
 675                 .help   = "Percentage of mixed workload that is writes",
 676                 .def    = "50",
 677         },
 678         {
 679                 .name   = "nice",
 680                 .type   = FIO_OPT_INT,
 681                 .off1   = td_var_offset(nice),
 682                 .help   = "Set job CPU nice value",
 683                 .minval = -19,
 684                 .maxval = 20,
 685                 .def    = "0",
 686         },
 687 #ifdef FIO_HAVE_IOPRIO
 688         {
 689                 .name   = "prio",
 690                 .type   = FIO_OPT_INT,
 691                 .cb     = str_prio_cb,
 692                 .help   = "Set job IO priority value",
 693                 .minval = 0,
 694                 .maxval = 7,
 695         },
 696         {
 697                 .name   = "prioclass",
 698                 .type   = FIO_OPT_INT,
 699                 .cb     = str_prioclass_cb,
 700                 .help   = "Set job IO priority class",
 701                 .minval = 0,
 702                 .maxval = 3,
 703         },
 704 #endif
 705         {
 706                 .name   = "thinktime",
 707                 .type   = FIO_OPT_INT,
 708                 .off1   = td_var_offset(thinktime),
 709                 .help   = "Idle time between IO buffers (usec)",
 710                 .def    = "0",
 711         },
 712         {
 713                 .name   = "thinktime_spin",
 714                 .type   = FIO_OPT_INT,
 715                 .off1   = td_var_offset(thinktime_spin),
 716                 .help   = "Start think time by spinning this amount (usec)",
 717                 .def    = "0",
 718         },
 719         {
 720                 .name   = "thinktime_blocks",
 721                 .type   = FIO_OPT_INT,
 722                 .off1   = td_var_offset(thinktime_blocks),
 723                 .help   = "IO buffer period between 'thinktime'",
 724                 .def    = "1",
 725         },
 726         {
 727                 .name   = "rate",
 728                 .type   = FIO_OPT_INT,
 729                 .off1   = td_var_offset(rate),
 730                 .help   = "Set bandwidth rate",
 731         },
 732         {
 733                 .name   = "ratemin",
 734                 .type   = FIO_OPT_INT,
 735                 .off1   = td_var_offset(ratemin),
 736                 .help   = "Job must meet this rate or it will be shutdown",
 737         },
 738         {
 739                 .name   = "rate_iops",
 740                 .type   = FIO_OPT_INT,
 741                 .off1   = td_var_offset(rate_iops),
 742                 .help   = "Limit IO used to this number of IO operations/sec",
 743         },
 744         {
 745                 .name   = "rate_iops_min",
 746                 .type   = FIO_OPT_INT,
 747                 .off1   = td_var_offset(rate_iops_min),
 748                 .help   = "Job must meet this rate or it will be shutdown",
 749         },
 750         {
 751                 .name   = "ratecycle",
 752                 .type   = FIO_OPT_INT,
 753                 .off1   = td_var_offset(ratecycle),
 754                 .help   = "Window average for rate limits (msec)",
 755                 .def    = "1000",
 756         },
 757         {
 758                 .name   = "invalidate",
 759                 .type   = FIO_OPT_BOOL,
 760                 .off1   = td_var_offset(invalidate_cache),
 761                 .help   = "Invalidate buffer/page cache prior to running job",
 762                 .def    = "1",
 763         },
 764         {
 765                 .name   = "sync",
 766                 .type   = FIO_OPT_BOOL,
 767                 .off1   = td_var_offset(sync_io),
 768                 .help   = "Use O_SYNC for buffered writes",
 769                 .def    = "0",
 770         },
 771         {
 772                 .name   = "bwavgtime",
 773                 .type   = FIO_OPT_INT,
 774                 .off1   = td_var_offset(bw_avg_time),
 775                 .help   = "Time window over which to calculate bandwidth (msec)",
 776                 .def    = "500",
 777         },
 778         {
 779                 .name   = "create_serialize",
 780                 .type   = FIO_OPT_BOOL,
 781                 .off1   = td_var_offset(create_serialize),
 782                 .help   = "Serialize creating of job files",
 783                 .def    = "1",
 784         },
 785         {
 786                 .name   = "create_fsync",
 787                 .type   = FIO_OPT_BOOL,
 788                 .off1   = td_var_offset(create_fsync),
 789                 .help   = "Fsync file after creation",
 790                 .def    = "1",
 791         },
 792         {
 793                 .name   = "cpuload",
 794                 .type   = FIO_OPT_INT,
 795                 .off1   = td_var_offset(cpuload),
 796                 .help   = "Use this percentage of CPU",
 797         },
 798         {
 799                 .name   = "cpuchunks",
 800                 .type   = FIO_OPT_INT,
 801                 .off1   = td_var_offset(cpucycle),
 802                 .help   = "Length of the CPU burn cycles (usecs)",
 803                 .def    = "50000",
 804         },
 805 #ifdef FIO_HAVE_CPU_AFFINITY
 806         {
 807                 .name   = "cpumask",
 808                 .type   = FIO_OPT_INT,
 809                 .cb     = str_cpumask_cb,
 810                 .help   = "CPU affinity mask",
 811         },
 812         {
 813                 .name   = "cpus_allowed",
 814                 .type   = FIO_OPT_STR,
 815                 .cb     = str_cpus_allowed_cb,
 816                 .help   = "Set CPUs allowed",
 817         },
 818 #endif
 819         {
 820                 .name   = "end_fsync",
 821                 .type   = FIO_OPT_BOOL,
 822                 .off1   = td_var_offset(end_fsync),
 823                 .help   = "Include fsync at the end of job",
 824                 .def    = "0",
 825         },
 826         {
 827                 .name   = "fsync_on_close",
 828                 .type   = FIO_OPT_BOOL,
 829                 .off1   = td_var_offset(fsync_on_close),
 830                 .help   = "fsync files on close",
 831                 .def    = "0",
 832         },
 833         {
 834                 .name   = "unlink",
 835                 .type   = FIO_OPT_BOOL,
 836                 .off1   = td_var_offset(unlink),
 837                 .help   = "Unlink created files after job has completed",
 838                 .def    = "0",
 839         },
 840         {
 841                 .name   = "exitall",
 842                 .type   = FIO_OPT_STR_SET,
 843                 .cb     = str_exitall_cb,
 844                 .help   = "Terminate all jobs when one exits",
 845         },
 846         {
 847                 .name   = "stonewall",
 848                 .type   = FIO_OPT_STR_SET,
 849                 .off1   = td_var_offset(stonewall),
 850                 .help   = "Insert a hard barrier between this job and previous",
 851         },
 852         {
 853                 .name   = "new_group",
 854                 .type   = FIO_OPT_STR_SET,
 855                 .off1   = td_var_offset(new_group),
 856                 .help   = "Mark the start of a new group (for reporting)",
 857         },
 858         {
 859                 .name   = "thread",
 860                 .type   = FIO_OPT_STR_SET,
 861                 .off1   = td_var_offset(use_thread),
 862                 .help   = "Use threads instead of forks",
 863         },
 864         {
 865                 .name   = "write_bw_log",
 866                 .type   = FIO_OPT_STR_SET,
 867                 .off1   = td_var_offset(write_bw_log),
 868                 .help   = "Write log of bandwidth during run",
 869         },
 870         {
 871                 .name   = "write_lat_log",
 872                 .type   = FIO_OPT_STR_SET,
 873                 .off1   = td_var_offset(write_lat_log),
 874                 .help   = "Write log of latency during run",
 875         },
 876         {
 877                 .name   = "hugepage-size",
 878                 .type   = FIO_OPT_STR_VAL,
 879                 .off1   = td_var_offset(hugepage_size),
 880                 .help   = "When using hugepages, specify size of each page",
 881                 .def    = __stringify(FIO_HUGE_PAGE),
 882         },
 883         {
 884                 .name   = "group_reporting",
 885                 .type   = FIO_OPT_STR_SET,
 886                 .off1   = td_var_offset(group_reporting),
 887                 .help   = "Do reporting on a per-group basis",
 888         },
 889         {
 890                 .name   = "zero_buffers",
 891                 .type   = FIO_OPT_STR_SET,
 892                 .off1   = td_var_offset(zero_buffers),
 893                 .help   = "Init IO buffers to all zeroes",
 894         },
 895 #ifdef FIO_HAVE_DISK_UTIL
 896         {
 897                 .name   = "disk_util",
 898                 .type   = FIO_OPT_BOOL,
 899                 .off1   = td_var_offset(do_disk_util),
 900                 .help   = "Log disk utilization stats",
 901                 .def    = "1",
 902         },
 903 #endif
 904         {
 905                 .name = NULL,
 906         },
 907 };
 908
 909 void fio_options_dup_and_init(struct option *long_options)
 910 {
 911         struct fio_option *o;
 912         unsigned int i;
 913
 914         options_init(options);
 915
 916         i = 0;
 917         while (long_options[i].name)
 918                 i++;
 919
 920         o = &options[0];
 921         while (o->name) {
 922                 long_options[i].name = o->name;
 923                 long_options[i].val = FIO_GETOPT_JOB;
 924                 if (o->type == FIO_OPT_STR_SET)
 925                         long_options[i].has_arg = no_argument;
 926                 else
 927                         long_options[i].has_arg = required_argument;
 928
 929                 i++;
 930                 o++;
 931                 assert(i < FIO_NR_OPTIONS);
 932         }
 933 }
 934
 935 int fio_option_parse(struct thread_data *td, const char *opt)
 936 {
 937         return parse_option(opt, options, td);
 938 }
 939
 940 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
 941 {
 942         return parse_cmd_option(opt, val, options, td);
 943 }
 944
 945 void fio_fill_default_options(struct thread_data *td)
 946 {
 947         fill_default_options(td, options);
 948 }
 949
 950 int fio_show_option_help(const char *opt)
 951 {
 952         return show_cmd_help(options, opt);
 953 }
 954
 955 static void __options_mem(struct thread_data *td, int alloc)
 956 {
 957         struct thread_options *o = &td->o;
 958         struct fio_option *opt;
 959         char **ptr;
 960         int i;
 961
 962         for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
 963                 if (opt->type != FIO_OPT_STR_STORE)
 964                         continue;
 965
 966                 ptr = (void *) o + opt->off1;
 967                 if (*ptr) {
 968                         if (alloc)
 969                                 *ptr = strdup(*ptr);
 970                         else {
 971                                 free(*ptr);
 972                                 *ptr = NULL;
 973                         }
 974                 }
 975         }
 976 }
 977
 978 /*
 979  * dupe FIO_OPT_STR_STORE options
 980  */
 981 void options_mem_dupe(struct thread_data *td)
 982 {
 983         __options_mem(td, 1);
 984 }
 985
 986 void options_mem_free(struct thread_data fio_unused *td)
 987 {
 988 #if 0
 989         __options_mem(td, 0);
 990 #endif
 991 }