options.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <unistd.h>
   4 #include <ctype.h>
   5 #include <string.h>
   6 #include <assert.h>
   7 #include <libgen.h>
   8 #include <fcntl.h>
   9 #include <sys/types.h>
  10 #include <sys/stat.h>
  11
  12 #include "fio.h"
  13 #include "verify.h"
  14 #include "parse.h"
  15 #include "lib/fls.h"
  16 #include "options.h"
  17
  18 #include "crc/crc32c.h"
  19
  20 /*
  21  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
  22  */
  23 static char *get_opt_postfix(const char *str)
  24 {
  25         char *p = strstr(str, ":");
  26
  27         if (!p)
  28                 return NULL;
  29
  30         p++;
  31         strip_blank_front(&p);
  32         strip_blank_end(p);
  33         return strdup(p);
  34 }
  35
  36 static int converthexchartoint(char a)
  37 {
  38         int base;
  39
  40         switch (a) {
  41         case '0'...'9':
  42                 base = '0';
  43                 break;
  44         case 'A'...'F':
  45                 base = 'A' - 10;
  46                 break;
  47         case 'a'...'f':
  48                 base = 'a' - 10;
  49                 break;
  50         default:
  51                 base = 0;
  52         }
  53         return a - base;
  54 }
  55
  56 static int bs_cmp(const void *p1, const void *p2)
  57 {
  58         const struct bssplit *bsp1 = p1;
  59         const struct bssplit *bsp2 = p2;
  60
  61         return bsp1->perc < bsp2->perc;
  62 }
  63
  64 static int bssplit_ddir(struct thread_options *o, int ddir, char *str)
  65 {
  66         struct bssplit *bssplit;
  67         unsigned int i, perc, perc_missing;
  68         unsigned int max_bs, min_bs;
  69         long long val;
  70         char *fname;
  71
  72         o->bssplit_nr[ddir] = 4;
  73         bssplit = malloc(4 * sizeof(struct bssplit));
  74
  75         i = 0;
  76         max_bs = 0;
  77         min_bs = -1;
  78         while ((fname = strsep(&str, ":")) != NULL) {
  79                 char *perc_str;
  80
  81                 if (!strlen(fname))
  82                         break;
  83
  84                 /*
  85                  * grow struct buffer, if needed
  86                  */
  87                 if (i == o->bssplit_nr[ddir]) {
  88                         o->bssplit_nr[ddir] <<= 1;
  89                         bssplit = realloc(bssplit, o->bssplit_nr[ddir]
  90                                                   * sizeof(struct bssplit));
  91                 }
  92
  93                 perc_str = strstr(fname, "/");
  94                 if (perc_str) {
  95                         *perc_str = '\0';
  96                         perc_str++;
  97                         perc = atoi(perc_str);
  98                         if (perc > 100)
  99                                 perc = 100;
 100                         else if (!perc)
 101                                 perc = -1;
 102                 } else
 103                         perc = -1;
 104
 105                 if (str_to_decimal(fname, &val, 1, o)) {
 106                         log_err("fio: bssplit conversion failed\n");
 107                         free(o->bssplit);
 108                         return 1;
 109                 }
 110
 111                 if (val > max_bs)
 112                         max_bs = val;
 113                 if (val < min_bs)
 114                         min_bs = val;
 115
 116                 bssplit[i].bs = val;
 117                 bssplit[i].perc = perc;
 118                 i++;
 119         }
 120
 121         o->bssplit_nr[ddir] = i;
 122
 123         /*
 124          * Now check if the percentages add up, and how much is missing
 125          */
 126         perc = perc_missing = 0;
 127         for (i = 0; i < o->bssplit_nr[ddir]; i++) {
 128                 struct bssplit *bsp = &bssplit[i];
 129
 130                 if (bsp->perc == (unsigned char) -1)
 131                         perc_missing++;
 132                 else
 133                         perc += bsp->perc;
 134         }
 135
 136         if (perc > 100) {
 137                 log_err("fio: bssplit percentages add to more than 100%%\n");
 138                 free(bssplit);
 139                 return 1;
 140         }
 141         /*
 142          * If values didn't have a percentage set, divide the remains between
 143          * them.
 144          */
 145         if (perc_missing) {
 146                 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
 147                         struct bssplit *bsp = &bssplit[i];
 148
 149                         if (bsp->perc == (unsigned char) -1)
 150                                 bsp->perc = (100 - perc) / perc_missing;
 151                 }
 152         }
 153
 154         o->min_bs[ddir] = min_bs;
 155         o->max_bs[ddir] = max_bs;
 156
 157         /*
 158          * now sort based on percentages, for ease of lookup
 159          */
 160         qsort(bssplit, o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
 161         o->bssplit[ddir] = bssplit;
 162         return 0;
 163 }
 164
 165 static int str_bssplit_cb(void *data, const char *input)
 166 {
 167         struct thread_data *td = data;
 168         char *str, *p, *odir;
 169         int ret = 0;
 170
 171         p = str = strdup(input);
 172
 173         strip_blank_front(&str);
 174         strip_blank_end(str);
 175
 176         odir = strchr(str, ',');
 177         if (odir) {
 178                 ret = bssplit_ddir(&td->o, DDIR_WRITE, odir + 1);
 179                 if (!ret) {
 180                         *odir = '\0';
 181                         ret = bssplit_ddir(&td->o, DDIR_READ, str);
 182                 }
 183         } else {
 184                 char *op;
 185
 186                 op = strdup(str);
 187
 188                 ret = bssplit_ddir(&td->o, DDIR_READ, str);
 189                 if (!ret)
 190                         ret = bssplit_ddir(&td->o, DDIR_WRITE, op);
 191
 192                 free(op);
 193         }
 194
 195         free(p);
 196         return ret;
 197 }
 198
 199 static int str_rw_cb(void *data, const char *str)
 200 {
 201         struct thread_data *td = data;
 202         struct thread_options *o = &td->o;
 203         char *nr = get_opt_postfix(str);
 204
 205         o->ddir_seq_nr = 1;
 206         o->ddir_seq_add = 0;
 207
 208         if (!nr)
 209                 return 0;
 210
 211         if (td_random(td))
 212                 o->ddir_seq_nr = atoi(nr);
 213         else {
 214                 long long val;
 215
 216                 if (str_to_decimal(nr, &val, 1, o)) {
 217                         log_err("fio: rw postfix parsing failed\n");
 218                         free(nr);
 219                         return 1;
 220                 }
 221
 222                 o->ddir_seq_add = val;
 223         }
 224
 225         free(nr);
 226         return 0;
 227 }
 228
 229 static int str_mem_cb(void *data, const char *mem)
 230 {
 231         struct thread_data *td = data;
 232         struct thread_options *o = &td->o;
 233
 234         if (o->mem_type == MEM_MMAPHUGE || o->mem_type == MEM_MMAP) {
 235                 o->mmapfile = get_opt_postfix(mem);
 236                 if (o->mem_type == MEM_MMAPHUGE && !o->mmapfile) {
 237                         log_err("fio: mmaphuge:/path/to/file\n");
 238                         return 1;
 239                 }
 240         }
 241
 242         return 0;
 243 }
 244
 245 static int fio_clock_source_cb(void *data, const char *str)
 246 {
 247         struct thread_data *td = data;
 248
 249         fio_clock_source = td->o.clocksource;
 250         fio_time_init();
 251         return 0;
 252 }
 253
 254 static int str_rwmix_read_cb(void *data, unsigned long long *val)
 255 {
 256         struct thread_data *td = data;
 257
 258         td->o.rwmix[DDIR_READ] = *val;
 259         td->o.rwmix[DDIR_WRITE] = 100 - *val;
 260         return 0;
 261 }
 262
 263 static int str_rwmix_write_cb(void *data, unsigned long long *val)
 264 {
 265         struct thread_data *td = data;
 266
 267         td->o.rwmix[DDIR_WRITE] = *val;
 268         td->o.rwmix[DDIR_READ] = 100 - *val;
 269         return 0;
 270 }
 271
 272 #ifdef FIO_HAVE_IOPRIO
 273 static int str_prioclass_cb(void *data, unsigned long long *val)
 274 {
 275         struct thread_data *td = data;
 276         unsigned short mask;
 277
 278         /*
 279          * mask off old class bits, str_prio_cb() may have set a default class
 280          */
 281         mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
 282         td->ioprio &= mask;
 283
 284         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
 285         td->ioprio_set = 1;
 286         return 0;
 287 }
 288
 289 static int str_prio_cb(void *data, unsigned long long *val)
 290 {
 291         struct thread_data *td = data;
 292
 293         td->ioprio |= *val;
 294
 295         /*
 296          * If no class is set, assume BE
 297          */
 298         if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
 299                 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
 300
 301         td->ioprio_set = 1;
 302         return 0;
 303 }
 304 #endif
 305
 306 static int str_exitall_cb(void)
 307 {
 308         exitall_on_terminate = 1;
 309         return 0;
 310 }
 311
 312 #ifdef FIO_HAVE_CPU_AFFINITY
 313 static int str_cpumask_cb(void *data, unsigned long long *val)
 314 {
 315         struct thread_data *td = data;
 316         unsigned int i;
 317         long max_cpu;
 318         int ret;
 319
 320         ret = fio_cpuset_init(&td->o.cpumask);
 321         if (ret < 0) {
 322                 log_err("fio: cpuset_init failed\n");
 323                 td_verror(td, ret, "fio_cpuset_init");
 324                 return 1;
 325         }
 326
 327         max_cpu = cpus_online();
 328
 329         for (i = 0; i < sizeof(int) * 8; i++) {
 330                 if ((1 << i) & *val) {
 331                         if (i > max_cpu) {
 332                                 log_err("fio: CPU %d too large (max=%ld)\n", i,
 333                                                                 max_cpu);
 334                                 return 1;
 335                         }
 336                         dprint(FD_PARSE, "set cpu allowed %d\n", i);
 337                         fio_cpu_set(&td->o.cpumask, i);
 338                 }
 339         }
 340
 341         td->o.cpumask_set = 1;
 342         return 0;
 343 }
 344
 345 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
 346                             const char *input)
 347 {
 348         char *cpu, *str, *p;
 349         long max_cpu;
 350         int ret = 0;
 351
 352         ret = fio_cpuset_init(mask);
 353         if (ret < 0) {
 354                 log_err("fio: cpuset_init failed\n");
 355                 td_verror(td, ret, "fio_cpuset_init");
 356                 return 1;
 357         }
 358
 359         p = str = strdup(input);
 360
 361         strip_blank_front(&str);
 362         strip_blank_end(str);
 363
 364         max_cpu = cpus_online();
 365
 366         while ((cpu = strsep(&str, ",")) != NULL) {
 367                 char *str2, *cpu2;
 368                 int icpu, icpu2;
 369
 370                 if (!strlen(cpu))
 371                         break;
 372
 373                 str2 = cpu;
 374                 icpu2 = -1;
 375                 while ((cpu2 = strsep(&str2, "-")) != NULL) {
 376                         if (!strlen(cpu2))
 377                                 break;
 378
 379                         icpu2 = atoi(cpu2);
 380                 }
 381
 382                 icpu = atoi(cpu);
 383                 if (icpu2 == -1)
 384                         icpu2 = icpu;
 385                 while (icpu <= icpu2) {
 386                         if (icpu >= FIO_MAX_CPUS) {
 387                                 log_err("fio: your OS only supports up to"
 388                                         " %d CPUs\n", (int) FIO_MAX_CPUS);
 389                                 ret = 1;
 390                                 break;
 391                         }
 392                         if (icpu > max_cpu) {
 393                                 log_err("fio: CPU %d too large (max=%ld)\n",
 394                                                         icpu, max_cpu);
 395                                 ret = 1;
 396                                 break;
 397                         }
 398
 399                         dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
 400                         fio_cpu_set(mask, icpu);
 401                         icpu++;
 402                 }
 403                 if (ret)
 404                         break;
 405         }
 406
 407         free(p);
 408         if (!ret)
 409                 td->o.cpumask_set = 1;
 410         return ret;
 411 }
 412
 413 static int str_cpus_allowed_cb(void *data, const char *input)
 414 {
 415         struct thread_data *td = data;
 416         int ret;
 417
 418         ret = set_cpus_allowed(td, &td->o.cpumask, input);
 419         if (!ret)
 420                 td->o.cpumask_set = 1;
 421
 422         return ret;
 423 }
 424
 425 static int str_verify_cpus_allowed_cb(void *data, const char *input)
 426 {
 427         struct thread_data *td = data;
 428         int ret;
 429
 430         ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
 431         if (!ret)
 432                 td->o.verify_cpumask_set = 1;
 433
 434         return ret;
 435 }
 436 #endif
 437
 438 #ifdef FIO_HAVE_TRIM
 439 static int str_verify_trim_cb(void *data, unsigned long long *val)
 440 {
 441         struct thread_data *td = data;
 442
 443         td->o.trim_percentage = *val;
 444         return 0;
 445 }
 446 #endif
 447
 448 static int str_fst_cb(void *data, const char *str)
 449 {
 450         struct thread_data *td = data;
 451         char *nr = get_opt_postfix(str);
 452
 453         td->file_service_nr = 1;
 454         if (nr) {
 455                 td->file_service_nr = atoi(nr);
 456                 free(nr);
 457         }
 458
 459         return 0;
 460 }
 461
 462 #ifdef FIO_HAVE_SYNC_FILE_RANGE
 463 static int str_sfr_cb(void *data, const char *str)
 464 {
 465         struct thread_data *td = data;
 466         char *nr = get_opt_postfix(str);
 467
 468         td->sync_file_range_nr = 1;
 469         if (nr) {
 470                 td->sync_file_range_nr = atoi(nr);
 471                 free(nr);
 472         }
 473
 474         return 0;
 475 }
 476 #endif
 477
 478 static int check_dir(struct thread_data *td, char *fname)
 479 {
 480 #if 0
 481         char file[PATH_MAX], *dir;
 482         int elen = 0;
 483
 484         if (td->o.directory) {
 485                 strcpy(file, td->o.directory);
 486                 strcat(file, "/");
 487                 elen = strlen(file);
 488         }
 489
 490         sprintf(file + elen, "%s", fname);
 491         dir = dirname(file);
 492
 493         {
 494         struct stat sb;
 495         /*
 496          * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
 497          * yet, so we can't do this check right here...
 498          */
 499         if (lstat(dir, &sb) < 0) {
 500                 int ret = errno;
 501
 502                 log_err("fio: %s is not a directory\n", dir);
 503                 td_verror(td, ret, "lstat");
 504                 return 1;
 505         }
 506
 507         if (!S_ISDIR(sb.st_mode)) {
 508                 log_err("fio: %s is not a directory\n", dir);
 509                 return 1;
 510         }
 511         }
 512 #endif
 513
 514         return 0;
 515 }
 516
 517 /*
 518  * Return next file in the string. Files are separated with ':'. If the ':'
 519  * is escaped with a '\', then that ':' is part of the filename and does not
 520  * indicate a new file.
 521  */
 522 static char *get_next_file_name(char **ptr)
 523 {
 524         char *str = *ptr;
 525         char *p, *start;
 526
 527         if (!str || !strlen(str))
 528                 return NULL;
 529
 530         start = str;
 531         do {
 532                 /*
 533                  * No colon, we are done
 534                  */
 535                 p = strchr(str, ':');
 536                 if (!p) {
 537                         *ptr = NULL;
 538                         break;
 539                 }
 540
 541                 /*
 542                  * We got a colon, but it's the first character. Skip and
 543                  * continue
 544                  */
 545                 if (p == start) {
 546                         str = ++start;
 547                         continue;
 548                 }
 549
 550                 if (*(p - 1) != '\\') {
 551                         *p = '\0';
 552                         *ptr = p + 1;
 553                         break;
 554                 }
 555
 556                 memmove(p - 1, p, strlen(p) + 1);
 557                 str = p;
 558         } while (1);
 559
 560         return start;
 561 }
 562
 563 static int str_filename_cb(void *data, const char *input)
 564 {
 565         struct thread_data *td = data;
 566         char *fname, *str, *p;
 567
 568         p = str = strdup(input);
 569
 570         strip_blank_front(&str);
 571         strip_blank_end(str);
 572
 573         if (!td->files_index)
 574                 td->o.nr_files = 0;
 575
 576         while ((fname = get_next_file_name(&str)) != NULL) {
 577                 if (!strlen(fname))
 578                         break;
 579                 if (check_dir(td, fname)) {
 580                         free(p);
 581                         return 1;
 582                 }
 583                 add_file(td, fname);
 584                 td->o.nr_files++;
 585         }
 586
 587         free(p);
 588         return 0;
 589 }
 590
 591 static int str_directory_cb(void *data, const char fio_unused *str)
 592 {
 593         struct thread_data *td = data;
 594         struct stat sb;
 595
 596         if (lstat(td->o.directory, &sb) < 0) {
 597                 int ret = errno;
 598
 599                 log_err("fio: %s is not a directory\n", td->o.directory);
 600                 td_verror(td, ret, "lstat");
 601                 return 1;
 602         }
 603         if (!S_ISDIR(sb.st_mode)) {
 604                 log_err("fio: %s is not a directory\n", td->o.directory);
 605                 return 1;
 606         }
 607
 608         return 0;
 609 }
 610
 611 static int str_opendir_cb(void *data, const char fio_unused *str)
 612 {
 613         struct thread_data *td = data;
 614
 615         if (!td->files_index)
 616                 td->o.nr_files = 0;
 617
 618         return add_dir_files(td, td->o.opendir);
 619 }
 620
 621 static int str_verify_offset_cb(void *data, unsigned long long *off)
 622 {
 623         struct thread_data *td = data;
 624
 625         if (*off && *off < sizeof(struct verify_header)) {
 626                 log_err("fio: verify_offset too small\n");
 627                 return 1;
 628         }
 629
 630         td->o.verify_offset = *off;
 631         return 0;
 632 }
 633
 634 static int str_verify_pattern_cb(void *data, const char *input)
 635 {
 636         struct thread_data *td = data;
 637         long off;
 638         int i = 0, j = 0, len, k, base = 10;
 639         char *loc1, *loc2;
 640
 641         loc1 = strstr(input, "0x");
 642         loc2 = strstr(input, "0X");
 643         if (loc1 || loc2)
 644                 base = 16;
 645         off = strtol(input, NULL, base);
 646         if (off != LONG_MAX || errno != ERANGE) {
 647                 while (off) {
 648                         td->o.verify_pattern[i] = off & 0xff;
 649                         off >>= 8;
 650                         i++;
 651                 }
 652         } else {
 653                 len = strlen(input);
 654                 k = len - 1;
 655                 if (base == 16) {
 656                         if (loc1)
 657                                 j = loc1 - input + 2;
 658                         else
 659                                 j = loc2 - input + 2;
 660                 } else
 661                         return 1;
 662                 if (len - j < MAX_PATTERN_SIZE * 2) {
 663                         while (k >= j) {
 664                                 off = converthexchartoint(input[k--]);
 665                                 if (k >= j)
 666                                         off += (converthexchartoint(input[k--])
 667                                                 * 16);
 668                                 td->o.verify_pattern[i++] = (char) off;
 669                         }
 670                 }
 671         }
 672
 673         /*
 674          * Fill the pattern all the way to the end. This greatly reduces
 675          * the number of memcpy's we have to do when verifying the IO.
 676          */
 677         while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
 678                 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
 679                 i *= 2;
 680         }
 681         if (i == 1) {
 682                 /*
 683                  * The code in verify_io_u_pattern assumes a single byte pattern
 684                  * fills the whole verify pattern buffer.
 685                  */
 686                 memset(td->o.verify_pattern, td->o.verify_pattern[0],
 687                        MAX_PATTERN_SIZE);
 688         }
 689
 690         td->o.verify_pattern_bytes = i;
 691
 692         /*
 693          * VERIFY_META could already be set
 694          */
 695         if (td->o.verify == VERIFY_NONE)
 696                 td->o.verify = VERIFY_PATTERN;
 697
 698         return 0;
 699 }
 700
 701 static int str_lockfile_cb(void *data, const char *str)
 702 {
 703         struct thread_data *td = data;
 704         char *nr = get_opt_postfix(str);
 705
 706         td->o.lockfile_batch = 1;
 707         if (nr) {
 708                 td->o.lockfile_batch = atoi(nr);
 709                 free(nr);
 710         }
 711
 712         return 0;
 713 }
 714
 715 static int str_write_bw_log_cb(void *data, const char *str)
 716 {
 717         struct thread_data *td = data;
 718
 719         if (str)
 720                 td->o.bw_log_file = strdup(str);
 721
 722         td->o.write_bw_log = 1;
 723         return 0;
 724 }
 725
 726 static int str_write_lat_log_cb(void *data, const char *str)
 727 {
 728         struct thread_data *td = data;
 729
 730         if (str)
 731                 td->o.lat_log_file = strdup(str);
 732
 733         td->o.write_lat_log = 1;
 734         return 0;
 735 }
 736
 737 static int str_write_iops_log_cb(void *data, const char *str)
 738 {
 739         struct thread_data *td = data;
 740
 741         if (str)
 742                 td->o.iops_log_file = strdup(str);
 743
 744         td->o.write_iops_log = 1;
 745         return 0;
 746 }
 747
 748 static int str_gtod_reduce_cb(void *data, int *il)
 749 {
 750         struct thread_data *td = data;
 751         int val = *il;
 752
 753         td->o.disable_lat = !!val;
 754         td->o.disable_clat = !!val;
 755         td->o.disable_slat = !!val;
 756         td->o.disable_bw = !!val;
 757         td->o.clat_percentiles = !val;
 758         if (val)
 759                 td->tv_cache_mask = 63;
 760
 761         return 0;
 762 }
 763
 764 static int str_gtod_cpu_cb(void *data, long long *il)
 765 {
 766         struct thread_data *td = data;
 767         int val = *il;
 768
 769         td->o.gtod_cpu = val;
 770         td->o.gtod_offload = 1;
 771         return 0;
 772 }
 773
 774 static int str_size_cb(void *data, unsigned long long *__val)
 775 {
 776         struct thread_data *td = data;
 777         unsigned long long v = *__val;
 778
 779         if (parse_is_percent(v)) {
 780                 td->o.size = 0;
 781                 td->o.size_percent = -1ULL - v;
 782         } else
 783                 td->o.size = v;
 784
 785         return 0;
 786 }
 787
 788 static int rw_verify(struct fio_option *o, void *data)
 789 {
 790         struct thread_data *td = data;
 791
 792         if (read_only && td_write(td)) {
 793                 log_err("fio: job <%s> has write bit set, but fio is in"
 794                         " read-only mode\n", td->o.name);
 795                 return 1;
 796         }
 797
 798         return 0;
 799 }
 800
 801 static int gtod_cpu_verify(struct fio_option *o, void *data)
 802 {
 803 #ifndef FIO_HAVE_CPU_AFFINITY
 804         struct thread_data *td = data;
 805
 806         if (td->o.gtod_cpu) {
 807                 log_err("fio: platform must support CPU affinity for"
 808                         "gettimeofday() offloading\n");
 809                 return 1;
 810         }
 811 #endif
 812
 813         return 0;
 814 }
 815
 816 static int kb_base_verify(struct fio_option *o, void *data)
 817 {
 818         struct thread_data *td = data;
 819
 820         if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
 821                 log_err("fio: kb_base set to nonsensical value: %u\n",
 822                                 td->o.kb_base);
 823                 return 1;
 824         }
 825
 826         return 0;
 827 }
 828
 829 /*
 830  * Option grouping
 831  */
 832 static struct opt_group fio_opt_groups[] = {
 833         {
 834                 .name   = "General",
 835                 .mask   = FIO_OPT_C_GENERAL,
 836         },
 837         {
 838                 .name   = "I/O",
 839                 .mask   = FIO_OPT_C_IO,
 840         },
 841         {
 842                 .name   = "File",
 843                 .mask   = FIO_OPT_C_FILE,
 844         },
 845         {
 846                 .name   = "Statistics",
 847                 .mask   = FIO_OPT_C_STAT,
 848         },
 849         {
 850                 .name   = "Logging",
 851                 .mask   = FIO_OPT_C_LOG,
 852         },
 853         {
 854                 .name   = NULL,
 855         },
 856 };
 857
 858 static struct opt_group *__opt_group_from_mask(struct opt_group *ogs, unsigned int *mask,
 859                                                unsigned int inv_mask)
 860 {
 861         struct opt_group *og;
 862         int i;
 863
 864         if (*mask == inv_mask || !*mask)
 865                 return NULL;
 866
 867         for (i = 0; ogs[i].name; i++) {
 868                 og = &ogs[i];
 869
 870                 if (*mask & og->mask) {
 871                         *mask &= ~(og->mask);
 872                         return og;
 873                 }
 874         }
 875
 876         return NULL;
 877 }
 878
 879 struct opt_group *opt_group_from_mask(unsigned int *mask)
 880 {
 881         return __opt_group_from_mask(fio_opt_groups, mask, FIO_OPT_C_INVALID);
 882 }
 883
 884 static struct opt_group fio_opt_cat_groups[] = {
 885         {
 886                 .name   = "Rate",
 887                 .mask   = FIO_OPT_G_RATE,
 888         },
 889         {
 890                 .name   = "Zone",
 891                 .mask   = FIO_OPT_G_ZONE,
 892         },
 893         {
 894                 .name   = "Read/write mix",
 895                 .mask   = FIO_OPT_G_RWMIX,
 896         },
 897         {
 898                 .name   = "Verify",
 899                 .mask   = FIO_OPT_G_VERIFY,
 900         },
 901         {
 902                 .name   = "Trim",
 903                 .mask   = FIO_OPT_G_TRIM,
 904         },
 905         {
 906                 .name   = "I/O Logging",
 907                 .mask   = FIO_OPT_G_IOLOG,
 908         },
 909         {
 910                 .name   = "I/O Depth",
 911                 .mask   = FIO_OPT_G_IO_DEPTH,
 912         },
 913         {
 914                 .name   = "I/O Flow",
 915                 .mask   = FIO_OPT_G_IO_FLOW,
 916         },
 917         {
 918                 .name   = "Description",
 919                 .mask   = FIO_OPT_G_DESC,
 920         },
 921         {
 922                 .name   = "Filename",
 923                 .mask   = FIO_OPT_G_FILENAME,
 924         },
 925         {
 926                 .name   = "General I/O",
 927                 .mask   = FIO_OPT_G_IO_BASIC,
 928         },
 929         {
 930                 .name   = "Cgroups",
 931                 .mask   = FIO_OPT_G_CGROUP,
 932         },
 933         {
 934                 .name   = "Runtime",
 935                 .mask   = FIO_OPT_G_RUNTIME,
 936         },
 937         {
 938                 .name   = "Process",
 939                 .mask   = FIO_OPT_G_PROCESS,
 940         },
 941         {
 942                 .name   = "Job credentials / priority",
 943                 .mask   = FIO_OPT_G_CRED,
 944         },
 945         {
 946                 .name   = "Clock settings",
 947                 .mask   = FIO_OPT_G_CLOCK,
 948         },
 949         {
 950                 .name   = "I/O Type",
 951                 .mask   = FIO_OPT_G_IO_TYPE,
 952         },
 953         {
 954                 .name   = "I/O Thinktime",
 955                 .mask   = FIO_OPT_G_THINKTIME,
 956         },
 957         {
 958                 .name   = "Randomizations",
 959                 .mask   = FIO_OPT_G_RANDOM,
 960         },
 961         {
 962                 .name   = "I/O buffers",
 963                 .mask   = FIO_OPT_G_IO_BUF,
 964         },
 965         {
 966                 .name   = NULL,
 967         }
 968 };
 969
 970 struct opt_group *opt_group_cat_from_mask(unsigned int *mask)
 971 {
 972         return __opt_group_from_mask(fio_opt_cat_groups, mask, FIO_OPT_G_INVALID);
 973 }
 974
 975 /*
 976  * Map of job/command line options
 977  */
 978 struct fio_option fio_options[FIO_MAX_OPTS] = {
 979         {
 980                 .name   = "description",
 981                 .lname  = "Description of job",
 982                 .type   = FIO_OPT_STR_STORE,
 983                 .off1   = td_var_offset(description),
 984                 .help   = "Text job description",
 985                 .category = FIO_OPT_C_GENERAL,
 986                 .group  = FIO_OPT_G_DESC,
 987         },
 988         {
 989                 .name   = "name",
 990                 .lname  = "Job name",
 991                 .type   = FIO_OPT_STR_STORE,
 992                 .off1   = td_var_offset(name),
 993                 .help   = "Name of this job",
 994                 .category = FIO_OPT_C_GENERAL,
 995                 .group  = FIO_OPT_G_DESC,
 996         },
 997         {
 998                 .name   = "filename",
 999                 .lname  = "Filename(s)",
1000                 .type   = FIO_OPT_STR_STORE,
1001                 .off1   = td_var_offset(filename),
1002                 .cb     = str_filename_cb,
1003                 .prio   = -1, /* must come after "directory" */
1004                 .help   = "File(s) to use for the workload",
1005                 .category = FIO_OPT_C_FILE,
1006                 .group  = FIO_OPT_G_FILENAME,
1007         },
1008         {
1009                 .name   = "directory",
1010                 .lname  = "Directory",
1011                 .type   = FIO_OPT_STR_STORE,
1012                 .off1   = td_var_offset(directory),
1013                 .cb     = str_directory_cb,
1014                 .help   = "Directory to store files in",
1015                 .category = FIO_OPT_C_FILE,
1016                 .group  = FIO_OPT_G_FILENAME,
1017         },
1018         {
1019                 .name   = "lockfile",
1020                 .lname  = "Lockfile",
1021                 .type   = FIO_OPT_STR,
1022                 .cb     = str_lockfile_cb,
1023                 .off1   = td_var_offset(file_lock_mode),
1024                 .help   = "Lock file when doing IO to it",
1025                 .parent = "filename",
1026                 .hide   = 0,
1027                 .def    = "none",
1028                 .category = FIO_OPT_C_FILE,
1029                 .group  = FIO_OPT_G_FILENAME,
1030                 .posval = {
1031                           { .ival = "none",
1032                             .oval = FILE_LOCK_NONE,
1033                             .help = "No file locking",
1034                           },
1035                           { .ival = "exclusive",
1036                             .oval = FILE_LOCK_EXCLUSIVE,
1037                             .help = "Exclusive file lock",
1038                           },
1039                           {
1040                             .ival = "readwrite",
1041                             .oval = FILE_LOCK_READWRITE,
1042                             .help = "Read vs write lock",
1043                           },
1044                 },
1045         },
1046         {
1047                 .name   = "opendir",
1048                 .lname  = "Open directory",
1049                 .type   = FIO_OPT_STR_STORE,
1050                 .off1   = td_var_offset(opendir),
1051                 .cb     = str_opendir_cb,
1052                 .help   = "Recursively add files from this directory and down",
1053                 .category = FIO_OPT_C_FILE,
1054                 .group  = FIO_OPT_G_FILENAME,
1055         },
1056         {
1057                 .name   = "rw",
1058                 .lname  = "Read/write",
1059                 .alias  = "readwrite",
1060                 .type   = FIO_OPT_STR,
1061                 .cb     = str_rw_cb,
1062                 .off1   = td_var_offset(td_ddir),
1063                 .help   = "IO direction",
1064                 .def    = "read",
1065                 .verify = rw_verify,
1066                 .category = FIO_OPT_C_IO,
1067                 .group  = FIO_OPT_G_IO_BASIC,
1068                 .posval = {
1069                           { .ival = "read",
1070                             .oval = TD_DDIR_READ,
1071                             .help = "Sequential read",
1072                           },
1073                           { .ival = "write",
1074                             .oval = TD_DDIR_WRITE,
1075                             .help = "Sequential write",
1076                           },
1077                           { .ival = "randread",
1078                             .oval = TD_DDIR_RANDREAD,
1079                             .help = "Random read",
1080                           },
1081                           { .ival = "randwrite",
1082                             .oval = TD_DDIR_RANDWRITE,
1083                             .help = "Random write",
1084                           },
1085                           { .ival = "rw",
1086                             .oval = TD_DDIR_RW,
1087                             .help = "Sequential read and write mix",
1088                           },
1089                           { .ival = "randrw",
1090                             .oval = TD_DDIR_RANDRW,
1091                             .help = "Random read and write mix"
1092                           },
1093                 },
1094         },
1095         {
1096                 .name   = "rw_sequencer",
1097                 .lname  = "RW Sequencer",
1098                 .type   = FIO_OPT_STR,
1099                 .off1   = td_var_offset(rw_seq),
1100                 .help   = "IO offset generator modifier",
1101                 .def    = "sequential",
1102                 .category = FIO_OPT_C_IO,
1103                 .group  = FIO_OPT_G_IO_BASIC,
1104                 .posval = {
1105                           { .ival = "sequential",
1106                             .oval = RW_SEQ_SEQ,
1107                             .help = "Generate sequential offsets",
1108                           },
1109                           { .ival = "identical",
1110                             .oval = RW_SEQ_IDENT,
1111                             .help = "Generate identical offsets",
1112                           },
1113                 },
1114         },
1115
1116         {
1117                 .name   = "ioengine",
1118                 .lname  = "IO Engine",
1119                 .type   = FIO_OPT_STR_STORE,
1120                 .off1   = td_var_offset(ioengine),
1121                 .help   = "IO engine to use",
1122                 .def    = FIO_PREFERRED_ENGINE,
1123                 .category = FIO_OPT_C_IO,
1124                 .group  = FIO_OPT_G_IO_BASIC,
1125                 .posval = {
1126                           { .ival = "sync",
1127                             .help = "Use read/write",
1128                           },
1129                           { .ival = "psync",
1130                             .help = "Use pread/pwrite",
1131                           },
1132                           { .ival = "vsync",
1133                             .help = "Use readv/writev",
1134                           },
1135 #ifdef FIO_HAVE_LIBAIO
1136                           { .ival = "libaio",
1137                             .help = "Linux native asynchronous IO",
1138                           },
1139 #endif
1140 #ifdef FIO_HAVE_POSIXAIO
1141                           { .ival = "posixaio",
1142                             .help = "POSIX asynchronous IO",
1143                           },
1144 #endif
1145 #ifdef FIO_HAVE_SOLARISAIO
1146                           { .ival = "solarisaio",
1147                             .help = "Solaris native asynchronous IO",
1148                           },
1149 #endif
1150 #ifdef FIO_HAVE_WINDOWSAIO
1151                           { .ival = "windowsaio",
1152                             .help = "Windows native asynchronous IO"
1153                           },
1154 #endif
1155                           { .ival = "mmap",
1156                             .help = "Memory mapped IO"
1157                           },
1158 #ifdef FIO_HAVE_SPLICE
1159                           { .ival = "splice",
1160                             .help = "splice/vmsplice based IO",
1161                           },
1162                           { .ival = "netsplice",
1163                             .help = "splice/vmsplice to/from the network",
1164                           },
1165 #endif
1166 #ifdef FIO_HAVE_SGIO
1167                           { .ival = "sg",
1168                             .help = "SCSI generic v3 IO",
1169                           },
1170 #endif
1171                           { .ival = "null",
1172                             .help = "Testing engine (no data transfer)",
1173                           },
1174                           { .ival = "net",
1175                             .help = "Network IO",
1176                           },
1177 #ifdef FIO_HAVE_SYSLET
1178                           { .ival = "syslet-rw",
1179                             .help = "syslet enabled async pread/pwrite IO",
1180                           },
1181 #endif
1182                           { .ival = "cpuio",
1183                             .help = "CPU cycle burner engine",
1184                           },
1185 #ifdef FIO_HAVE_GUASI
1186                           { .ival = "guasi",
1187                             .help = "GUASI IO engine",
1188                           },
1189 #endif
1190 #ifdef FIO_HAVE_BINJECT
1191                           { .ival = "binject",
1192                             .help = "binject direct inject block engine",
1193                           },
1194 #endif
1195 #ifdef FIO_HAVE_RDMA
1196                           { .ival = "rdma",
1197                             .help = "RDMA IO engine",
1198                           },
1199 #endif
1200                           { .ival = "external",
1201                             .help = "Load external engine (append name)",
1202                           },
1203                 },
1204         },
1205         {
1206                 .name   = "iodepth",
1207                 .lname  = "IO Depth",
1208                 .type   = FIO_OPT_INT,
1209                 .off1   = td_var_offset(iodepth),
1210                 .help   = "Number of IO buffers to keep in flight",
1211                 .minval = 1,
1212                 .interval = 1,
1213                 .def    = "1",
1214                 .category = FIO_OPT_C_IO,
1215                 .group  = FIO_OPT_G_IO_BASIC,
1216         },
1217         {
1218                 .name   = "iodepth_batch",
1219                 .lname  = "IO Depth batch",
1220                 .alias  = "iodepth_batch_submit",
1221                 .type   = FIO_OPT_INT,
1222                 .off1   = td_var_offset(iodepth_batch),
1223                 .help   = "Number of IO buffers to submit in one go",
1224                 .parent = "iodepth",
1225                 .hide   = 1,
1226                 .minval = 1,
1227                 .interval = 1,
1228                 .def    = "1",
1229                 .category = FIO_OPT_C_IO,
1230                 .group  = FIO_OPT_G_IO_BASIC,
1231         },
1232         {
1233                 .name   = "iodepth_batch_complete",
1234                 .lname  = "IO Depth batch complete",
1235                 .type   = FIO_OPT_INT,
1236                 .off1   = td_var_offset(iodepth_batch_complete),
1237                 .help   = "Number of IO buffers to retrieve in one go",
1238                 .parent = "iodepth",
1239                 .hide   = 1,
1240                 .minval = 0,
1241                 .interval = 1,
1242                 .def    = "1",
1243                 .category = FIO_OPT_C_IO,
1244                 .group  = FIO_OPT_G_IO_BASIC,
1245         },
1246         {
1247                 .name   = "iodepth_low",
1248                 .lname  = "IO Depth batch low",
1249                 .type   = FIO_OPT_INT,
1250                 .off1   = td_var_offset(iodepth_low),
1251                 .help   = "Low water mark for queuing depth",
1252                 .parent = "iodepth",
1253                 .hide   = 1,
1254                 .interval = 1,
1255                 .category = FIO_OPT_C_IO,
1256                 .group  = FIO_OPT_G_IO_BASIC,
1257         },
1258         {
1259                 .name   = "size",
1260                 .lname  = "Size",
1261                 .type   = FIO_OPT_STR_VAL,
1262                 .cb     = str_size_cb,
1263                 .help   = "Total size of device or files",
1264                 .interval = 1024 * 1024,
1265                 .category = FIO_OPT_C_IO,
1266                 .group  = FIO_OPT_G_INVALID,
1267         },
1268         {
1269                 .name   = "fill_device",
1270                 .lname  = "Fill device",
1271                 .alias  = "fill_fs",
1272                 .type   = FIO_OPT_BOOL,
1273                 .off1   = td_var_offset(fill_device),
1274                 .help   = "Write until an ENOSPC error occurs",
1275                 .def    = "0",
1276                 .category = FIO_OPT_C_FILE,
1277                 .group  = FIO_OPT_G_INVALID,
1278         },
1279         {
1280                 .name   = "filesize",
1281                 .lname  = "File size",
1282                 .type   = FIO_OPT_STR_VAL,
1283                 .off1   = td_var_offset(file_size_low),
1284                 .off2   = td_var_offset(file_size_high),
1285                 .minval = 1,
1286                 .help   = "Size of individual files",
1287                 .interval = 1024 * 1024,
1288                 .category = FIO_OPT_C_FILE,
1289                 .group  = FIO_OPT_G_INVALID,
1290         },
1291         {
1292                 .name   = "offset",
1293                 .lname  = "IO offset",
1294                 .alias  = "fileoffset",
1295                 .type   = FIO_OPT_STR_VAL,
1296                 .off1   = td_var_offset(start_offset),
1297                 .help   = "Start IO from this offset",
1298                 .def    = "0",
1299                 .interval = 1024 * 1024,
1300                 .category = FIO_OPT_C_IO,
1301                 .group  = FIO_OPT_G_INVALID,
1302         },
1303         {
1304                 .name   = "offset_increment",
1305                 .lname  = "IO offset increment",
1306                 .type   = FIO_OPT_STR_VAL,
1307                 .off1   = td_var_offset(offset_increment),
1308                 .help   = "What is the increment from one offset to the next",
1309                 .parent = "offset",
1310                 .hide   = 1,
1311                 .def    = "0",
1312                 .interval = 1024 * 1024,
1313                 .category = FIO_OPT_C_IO,
1314                 .group  = FIO_OPT_G_INVALID,
1315         },
1316         {
1317                 .name   = "bs",
1318                 .lname  = "Block size",
1319                 .alias  = "blocksize",
1320                 .type   = FIO_OPT_INT,
1321                 .off1   = td_var_offset(bs[DDIR_READ]),
1322                 .off2   = td_var_offset(bs[DDIR_WRITE]),
1323                 .minval = 1,
1324                 .help   = "Block size unit",
1325                 .def    = "4k",
1326                 .parent = "rw",
1327                 .hide   = 1,
1328                 .interval = 512,
1329                 .category = FIO_OPT_C_IO,
1330                 .group  = FIO_OPT_G_INVALID,
1331         },
1332         {
1333                 .name   = "ba",
1334                 .lname  = "Block size align",
1335                 .alias  = "blockalign",
1336                 .type   = FIO_OPT_INT,
1337                 .off1   = td_var_offset(ba[DDIR_READ]),
1338                 .off2   = td_var_offset(ba[DDIR_WRITE]),
1339                 .minval = 1,
1340                 .help   = "IO block offset alignment",
1341                 .parent = "rw",
1342                 .hide   = 1,
1343                 .interval = 512,
1344                 .category = FIO_OPT_C_IO,
1345                 .group  = FIO_OPT_G_INVALID,
1346         },
1347         {
1348                 .name   = "bsrange",
1349                 .lname  = "Block size range",
1350                 .alias  = "blocksize_range",
1351                 .type   = FIO_OPT_RANGE,
1352                 .off1   = td_var_offset(min_bs[DDIR_READ]),
1353                 .off2   = td_var_offset(max_bs[DDIR_READ]),
1354                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
1355                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
1356                 .minval = 1,
1357                 .help   = "Set block size range (in more detail than bs)",
1358                 .parent = "rw",
1359                 .hide   = 1,
1360                 .interval = 4096,
1361                 .category = FIO_OPT_C_IO,
1362                 .group  = FIO_OPT_G_INVALID,
1363         },
1364         {
1365                 .name   = "bssplit",
1366                 .lname  = "Block size split",
1367                 .type   = FIO_OPT_STR,
1368                 .cb     = str_bssplit_cb,
1369                 .help   = "Set a specific mix of block sizes",
1370                 .parent = "rw",
1371                 .hide   = 1,
1372                 .category = FIO_OPT_C_IO,
1373                 .group  = FIO_OPT_G_INVALID,
1374         },
1375         {
1376                 .name   = "bs_unaligned",
1377                 .lname  = "Block size unaligned",
1378                 .alias  = "blocksize_unaligned",
1379                 .type   = FIO_OPT_STR_SET,
1380                 .off1   = td_var_offset(bs_unaligned),
1381                 .help   = "Don't sector align IO buffer sizes",
1382                 .parent = "rw",
1383                 .hide   = 1,
1384                 .category = FIO_OPT_C_IO,
1385                 .group  = FIO_OPT_G_INVALID,
1386         },
1387         {
1388                 .name   = "randrepeat",
1389                 .lname  = "Random repeatable",
1390                 .type   = FIO_OPT_BOOL,
1391                 .off1   = td_var_offset(rand_repeatable),
1392                 .help   = "Use repeatable random IO pattern",
1393                 .def    = "1",
1394                 .parent = "rw",
1395                 .hide   = 1,
1396                 .category = FIO_OPT_C_IO,
1397                 .group  = FIO_OPT_G_RANDOM,
1398         },
1399         {
1400                 .name   = "use_os_rand",
1401                 .lname  = "Use OS random",
1402                 .type   = FIO_OPT_BOOL,
1403                 .off1   = td_var_offset(use_os_rand),
1404                 .help   = "Set to use OS random generator",
1405                 .def    = "0",
1406                 .parent = "rw",
1407                 .hide   = 1,
1408                 .category = FIO_OPT_C_IO,
1409                 .group  = FIO_OPT_G_RANDOM,
1410         },
1411         {
1412                 .name   = "norandommap",
1413                 .lname  = "No randommap",
1414                 .type   = FIO_OPT_STR_SET,
1415                 .off1   = td_var_offset(norandommap),
1416                 .help   = "Accept potential duplicate random blocks",
1417                 .parent = "rw",
1418                 .hide   = 1,
1419                 .hide_on_set = 1,
1420                 .category = FIO_OPT_C_IO,
1421                 .group  = FIO_OPT_G_RANDOM,
1422         },
1423         {
1424                 .name   = "softrandommap",
1425                 .lname  = "Soft randommap",
1426                 .type   = FIO_OPT_BOOL,
1427                 .off1   = td_var_offset(softrandommap),
1428                 .help   = "Set norandommap if randommap allocation fails",
1429                 .parent = "norandommap",
1430                 .hide   = 1,
1431                 .def    = "0",
1432                 .category = FIO_OPT_C_IO,
1433                 .group  = FIO_OPT_G_RANDOM,
1434         },
1435         {
1436                 .name   = "nrfiles",
1437                 .lname  = "Number of files",
1438                 .alias  = "nr_files",
1439                 .type   = FIO_OPT_INT,
1440                 .off1   = td_var_offset(nr_files),
1441                 .help   = "Split job workload between this number of files",
1442                 .def    = "1",
1443                 .interval = 1,
1444                 .category = FIO_OPT_C_FILE,
1445                 .group  = FIO_OPT_G_INVALID,
1446         },
1447         {
1448                 .name   = "openfiles",
1449                 .lname  = "Number of open files",
1450                 .type   = FIO_OPT_INT,
1451                 .off1   = td_var_offset(open_files),
1452                 .help   = "Number of files to keep open at the same time",
1453                 .category = FIO_OPT_C_FILE,
1454                 .group  = FIO_OPT_G_INVALID,
1455         },
1456         {
1457                 .name   = "file_service_type",
1458                 .lname  = "File service type",
1459                 .type   = FIO_OPT_STR,
1460                 .cb     = str_fst_cb,
1461                 .off1   = td_var_offset(file_service_type),
1462                 .help   = "How to select which file to service next",
1463                 .def    = "roundrobin",
1464                 .category = FIO_OPT_C_FILE,
1465                 .group  = FIO_OPT_G_INVALID,
1466                 .posval = {
1467                           { .ival = "random",
1468                             .oval = FIO_FSERVICE_RANDOM,
1469                             .help = "Choose a file at random",
1470                           },
1471                           { .ival = "roundrobin",
1472                             .oval = FIO_FSERVICE_RR,
1473                             .help = "Round robin select files",
1474                           },
1475                           { .ival = "sequential",
1476                             .oval = FIO_FSERVICE_SEQ,
1477                             .help = "Finish one file before moving to the next",
1478                           },
1479                 },
1480                 .parent = "nrfiles",
1481                 .hide   = 1,
1482         },
1483 #ifdef FIO_HAVE_FALLOCATE
1484         {
1485                 .name   = "fallocate",
1486                 .lname  = "Fallocate",
1487                 .type   = FIO_OPT_STR,
1488                 .off1   = td_var_offset(fallocate_mode),
1489                 .help   = "Whether pre-allocation is performed when laying out files",
1490                 .def    = "posix",
1491                 .category = FIO_OPT_C_FILE,
1492                 .group  = FIO_OPT_G_INVALID,
1493                 .posval = {
1494                           { .ival = "none",
1495                             .oval = FIO_FALLOCATE_NONE,
1496                             .help = "Do not pre-allocate space",
1497                           },
1498                           { .ival = "posix",
1499                             .oval = FIO_FALLOCATE_POSIX,
1500                             .help = "Use posix_fallocate()",
1501                           },
1502 #ifdef FIO_HAVE_LINUX_FALLOCATE
1503                           { .ival = "keep",
1504                             .oval = FIO_FALLOCATE_KEEP_SIZE,
1505                             .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1506                           },
1507 #endif
1508                           /* Compatibility with former boolean values */
1509                           { .ival = "0",
1510                             .oval = FIO_FALLOCATE_NONE,
1511                             .help = "Alias for 'none'",
1512                           },
1513                           { .ival = "1",
1514                             .oval = FIO_FALLOCATE_POSIX,
1515                             .help = "Alias for 'posix'",
1516                           },
1517                 },
1518         },
1519 #endif  /* FIO_HAVE_FALLOCATE */
1520         {
1521                 .name   = "fadvise_hint",
1522                 .lname  = "Fadvise hint",
1523                 .type   = FIO_OPT_BOOL,
1524                 .off1   = td_var_offset(fadvise_hint),
1525                 .help   = "Use fadvise() to advise the kernel on IO pattern",
1526                 .def    = "1",
1527                 .category = FIO_OPT_C_FILE,
1528                 .group  = FIO_OPT_G_INVALID,
1529         },
1530         {
1531                 .name   = "fsync",
1532                 .lname  = "Fsync",
1533                 .type   = FIO_OPT_INT,
1534                 .off1   = td_var_offset(fsync_blocks),
1535                 .help   = "Issue fsync for writes every given number of blocks",
1536                 .def    = "0",
1537                 .interval = 1,
1538                 .category = FIO_OPT_C_FILE,
1539                 .group  = FIO_OPT_G_INVALID,
1540         },
1541         {
1542                 .name   = "fdatasync",
1543                 .lname  = "Fdatasync",
1544                 .type   = FIO_OPT_INT,
1545                 .off1   = td_var_offset(fdatasync_blocks),
1546                 .help   = "Issue fdatasync for writes every given number of blocks",
1547                 .def    = "0",
1548                 .interval = 1,
1549                 .category = FIO_OPT_C_FILE,
1550                 .group  = FIO_OPT_G_INVALID,
1551         },
1552         {
1553                 .name   = "write_barrier",
1554                 .lname  = "Write barrier",
1555                 .type   = FIO_OPT_INT,
1556                 .off1   = td_var_offset(barrier_blocks),
1557                 .help   = "Make every Nth write a barrier write",
1558                 .def    = "0",
1559                 .interval = 1,
1560                 .category = FIO_OPT_C_IO,
1561                 .group  = FIO_OPT_G_INVALID,
1562         },
1563 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1564         {
1565                 .name   = "sync_file_range",
1566                 .lname  = "Sync file range",
1567                 .posval = {
1568                           { .ival = "wait_before",
1569                             .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1570                             .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1571                             .or   = 1,
1572                           },
1573                           { .ival = "write",
1574                             .oval = SYNC_FILE_RANGE_WRITE,
1575                             .help = "SYNC_FILE_RANGE_WRITE",
1576                             .or   = 1,
1577                           },
1578                           {
1579                             .ival = "wait_after",
1580                             .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1581                             .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1582                             .or   = 1,
1583                           },
1584                 },
1585                 .type   = FIO_OPT_STR_MULTI,
1586                 .cb     = str_sfr_cb,
1587                 .off1   = td_var_offset(sync_file_range),
1588                 .help   = "Use sync_file_range()",
1589                 .category = FIO_OPT_C_FILE,
1590                 .group  = FIO_OPT_G_INVALID,
1591         },
1592 #endif
1593         {
1594                 .name   = "direct",
1595                 .lname  = "Direct I/O",
1596                 .type   = FIO_OPT_BOOL,
1597                 .off1   = td_var_offset(odirect),
1598                 .help   = "Use O_DIRECT IO (negates buffered)",
1599                 .def    = "0",
1600                 .inverse = "buffered",
1601                 .category = FIO_OPT_C_IO,
1602                 .group  = FIO_OPT_G_IO_TYPE,
1603         },
1604         {
1605                 .name   = "buffered",
1606                 .lname  = "Buffered I/O",
1607                 .type   = FIO_OPT_BOOL,
1608                 .off1   = td_var_offset(odirect),
1609                 .neg    = 1,
1610                 .help   = "Use buffered IO (negates direct)",
1611                 .def    = "1",
1612                 .inverse = "direct",
1613                 .category = FIO_OPT_C_IO,
1614                 .group  = FIO_OPT_G_IO_TYPE,
1615         },
1616         {
1617                 .name   = "overwrite",
1618                 .lname  = "Overwrite",
1619                 .type   = FIO_OPT_BOOL,
1620                 .off1   = td_var_offset(overwrite),
1621                 .help   = "When writing, set whether to overwrite current data",
1622                 .def    = "0",
1623                 .category = FIO_OPT_C_FILE,
1624                 .group  = FIO_OPT_G_INVALID,
1625         },
1626         {
1627                 .name   = "loops",
1628                 .lname  = "Loops",
1629                 .type   = FIO_OPT_INT,
1630                 .off1   = td_var_offset(loops),
1631                 .help   = "Number of times to run the job",
1632                 .def    = "1",
1633                 .interval = 1,
1634                 .category = FIO_OPT_C_GENERAL,
1635                 .group  = FIO_OPT_G_RUNTIME,
1636         },
1637         {
1638                 .name   = "numjobs",
1639                 .lname  = "Number of jobs",
1640                 .type   = FIO_OPT_INT,
1641                 .off1   = td_var_offset(numjobs),
1642                 .help   = "Duplicate this job this many times",
1643                 .def    = "1",
1644                 .interval = 1,
1645                 .category = FIO_OPT_C_GENERAL,
1646                 .group  = FIO_OPT_G_RUNTIME,
1647         },
1648         {
1649                 .name   = "startdelay",
1650                 .lname  = "Start delay",
1651                 .type   = FIO_OPT_STR_VAL_TIME,
1652                 .off1   = td_var_offset(start_delay),
1653                 .help   = "Only start job when this period has passed",
1654                 .def    = "0",
1655                 .category = FIO_OPT_C_GENERAL,
1656                 .group  = FIO_OPT_G_RUNTIME,
1657         },
1658         {
1659                 .name   = "runtime",
1660                 .lname  = "Runtime",
1661                 .alias  = "timeout",
1662                 .type   = FIO_OPT_STR_VAL_TIME,
1663                 .off1   = td_var_offset(timeout),
1664                 .help   = "Stop workload when this amount of time has passed",
1665                 .def    = "0",
1666                 .category = FIO_OPT_C_GENERAL,
1667                 .group  = FIO_OPT_G_RUNTIME,
1668         },
1669         {
1670                 .name   = "time_based",
1671                 .lname  = "Time based",
1672                 .type   = FIO_OPT_STR_SET,
1673                 .off1   = td_var_offset(time_based),
1674                 .help   = "Keep running until runtime/timeout is met",
1675                 .category = FIO_OPT_C_GENERAL,
1676                 .group  = FIO_OPT_G_RUNTIME,
1677         },
1678         {
1679                 .name   = "ramp_time",
1680                 .lname  = "Ramp time",
1681                 .type   = FIO_OPT_STR_VAL_TIME,
1682                 .off1   = td_var_offset(ramp_time),
1683                 .help   = "Ramp up time before measuring performance",
1684                 .category = FIO_OPT_C_GENERAL,
1685                 .group  = FIO_OPT_G_RUNTIME,
1686         },
1687         {
1688                 .name   = "clocksource",
1689                 .lname  = "Clock source",
1690                 .type   = FIO_OPT_STR,
1691                 .cb     = fio_clock_source_cb,
1692                 .off1   = td_var_offset(clocksource),
1693                 .help   = "What type of timing source to use",
1694                 .category = FIO_OPT_C_GENERAL,
1695                 .group  = FIO_OPT_G_CLOCK,
1696                 .posval = {
1697                           { .ival = "gettimeofday",
1698                             .oval = CS_GTOD,
1699                             .help = "Use gettimeofday(2) for timing",
1700                           },
1701                           { .ival = "clock_gettime",
1702                             .oval = CS_CGETTIME,
1703                             .help = "Use clock_gettime(2) for timing",
1704                           },
1705 #ifdef ARCH_HAVE_CPU_CLOCK
1706                           { .ival = "cpu",
1707                             .oval = CS_CPUCLOCK,
1708                             .help = "Use CPU private clock",
1709                           },
1710 #endif
1711                 },
1712         },
1713         {
1714                 .name   = "mem",
1715                 .alias  = "iomem",
1716                 .lname  = "I/O Memory",
1717                 .type   = FIO_OPT_STR,
1718                 .cb     = str_mem_cb,
1719                 .off1   = td_var_offset(mem_type),
1720                 .help   = "Backing type for IO buffers",
1721                 .def    = "malloc",
1722                 .category = FIO_OPT_C_IO,
1723                 .group  = FIO_OPT_G_INVALID,
1724                 .posval = {
1725                           { .ival = "malloc",
1726                             .oval = MEM_MALLOC,
1727                             .help = "Use malloc(3) for IO buffers",
1728                           },
1729                           { .ival = "shm",
1730                             .oval = MEM_SHM,
1731                             .help = "Use shared memory segments for IO buffers",
1732                           },
1733 #ifdef FIO_HAVE_HUGETLB
1734                           { .ival = "shmhuge",
1735                             .oval = MEM_SHMHUGE,
1736                             .help = "Like shm, but use huge pages",
1737                           },
1738 #endif
1739                           { .ival = "mmap",
1740                             .oval = MEM_MMAP,
1741                             .help = "Use mmap(2) (file or anon) for IO buffers",
1742                           },
1743 #ifdef FIO_HAVE_HUGETLB
1744                           { .ival = "mmaphuge",
1745                             .oval = MEM_MMAPHUGE,
1746                             .help = "Like mmap, but use huge pages",
1747                           },
1748 #endif
1749                   },
1750         },
1751         {
1752                 .name   = "iomem_align",
1753                 .alias  = "mem_align",
1754                 .lname  = "I/O memory alignment",
1755                 .type   = FIO_OPT_INT,
1756                 .off1   = td_var_offset(mem_align),
1757                 .minval = 0,
1758                 .help   = "IO memory buffer offset alignment",
1759                 .def    = "0",
1760                 .parent = "iomem",
1761                 .hide   = 1,
1762                 .category = FIO_OPT_C_IO,
1763                 .group  = FIO_OPT_G_INVALID,
1764         },
1765         {
1766                 .name   = "verify",
1767                 .lname  = "Verify",
1768                 .type   = FIO_OPT_STR,
1769                 .off1   = td_var_offset(verify),
1770                 .help   = "Verify data written",
1771                 .def    = "0",
1772                 .category = FIO_OPT_C_IO,
1773                 .group  = FIO_OPT_G_VERIFY,
1774                 .posval = {
1775                           { .ival = "0",
1776                             .oval = VERIFY_NONE,
1777                             .help = "Don't do IO verification",
1778                           },
1779                           { .ival = "md5",
1780                             .oval = VERIFY_MD5,
1781                             .help = "Use md5 checksums for verification",
1782                           },
1783                           { .ival = "crc64",
1784                             .oval = VERIFY_CRC64,
1785                             .help = "Use crc64 checksums for verification",
1786                           },
1787                           { .ival = "crc32",
1788                             .oval = VERIFY_CRC32,
1789                             .help = "Use crc32 checksums for verification",
1790                           },
1791                           { .ival = "crc32c-intel",
1792                             .oval = VERIFY_CRC32C,
1793                             .help = "Use crc32c checksums for verification (hw assisted, if available)",
1794                           },
1795                           { .ival = "crc32c",
1796                             .oval = VERIFY_CRC32C,
1797                             .help = "Use crc32c checksums for verification (hw assisted, if available)",
1798                           },
1799                           { .ival = "crc16",
1800                             .oval = VERIFY_CRC16,
1801                             .help = "Use crc16 checksums for verification",
1802                           },
1803                           { .ival = "crc7",
1804                             .oval = VERIFY_CRC7,
1805                             .help = "Use crc7 checksums for verification",
1806                           },
1807                           { .ival = "sha1",
1808                             .oval = VERIFY_SHA1,
1809                             .help = "Use sha1 checksums for verification",
1810                           },
1811                           { .ival = "sha256",
1812                             .oval = VERIFY_SHA256,
1813                             .help = "Use sha256 checksums for verification",
1814                           },
1815                           { .ival = "sha512",
1816                             .oval = VERIFY_SHA512,
1817                             .help = "Use sha512 checksums for verification",
1818                           },
1819                           { .ival = "meta",
1820                             .oval = VERIFY_META,
1821                             .help = "Use io information",
1822                           },
1823                           {
1824                             .ival = "null",
1825                             .oval = VERIFY_NULL,
1826                             .help = "Pretend to verify",
1827                           },
1828                 },
1829         },
1830         {
1831                 .name   = "do_verify",
1832                 .lname  = "Perform verify step",
1833                 .type   = FIO_OPT_BOOL,
1834                 .off1   = td_var_offset(do_verify),
1835                 .help   = "Run verification stage after write",
1836                 .def    = "1",
1837                 .parent = "verify",
1838                 .hide   = 1,
1839                 .category = FIO_OPT_C_IO,
1840                 .group  = FIO_OPT_G_VERIFY,
1841         },
1842         {
1843                 .name   = "verifysort",
1844                 .lname  = "Verify sort",
1845                 .type   = FIO_OPT_BOOL,
1846                 .off1   = td_var_offset(verifysort),
1847                 .help   = "Sort written verify blocks for read back",
1848                 .def    = "1",
1849                 .parent = "verify",
1850                 .hide   = 1,
1851                 .category = FIO_OPT_C_IO,
1852                 .group  = FIO_OPT_G_VERIFY,
1853         },
1854         {
1855                 .name   = "verify_interval",
1856                 .lname  = "Verify interval",
1857                 .type   = FIO_OPT_INT,
1858                 .off1   = td_var_offset(verify_interval),
1859                 .minval = 2 * sizeof(struct verify_header),
1860                 .help   = "Store verify buffer header every N bytes",
1861                 .parent = "verify",
1862                 .hide   = 1,
1863                 .interval = 2 * sizeof(struct verify_header),
1864                 .category = FIO_OPT_C_IO,
1865                 .group  = FIO_OPT_G_VERIFY,
1866         },
1867         {
1868                 .name   = "verify_offset",
1869                 .lname  = "Verify offset",
1870                 .type   = FIO_OPT_INT,
1871                 .help   = "Offset verify header location by N bytes",
1872                 .def    = "0",
1873                 .cb     = str_verify_offset_cb,
1874                 .parent = "verify",
1875                 .hide   = 1,
1876                 .category = FIO_OPT_C_IO,
1877                 .group  = FIO_OPT_G_VERIFY,
1878         },
1879         {
1880                 .name   = "verify_pattern",
1881                 .lname  = "Verify pattern",
1882                 .type   = FIO_OPT_STR,
1883                 .cb     = str_verify_pattern_cb,
1884                 .help   = "Fill pattern for IO buffers",
1885                 .parent = "verify",
1886                 .hide   = 1,
1887                 .category = FIO_OPT_C_IO,
1888                 .group  = FIO_OPT_G_VERIFY,
1889         },
1890         {
1891                 .name   = "verify_fatal",
1892                 .lname  = "Verify fatal",
1893                 .type   = FIO_OPT_BOOL,
1894                 .off1   = td_var_offset(verify_fatal),
1895                 .def    = "0",
1896                 .help   = "Exit on a single verify failure, don't continue",
1897                 .parent = "verify",
1898                 .hide   = 1,
1899                 .category = FIO_OPT_C_IO,
1900                 .group  = FIO_OPT_G_VERIFY,
1901         },
1902         {
1903                 .name   = "verify_dump",
1904                 .lname  = "Verify dump",
1905                 .type   = FIO_OPT_BOOL,
1906                 .off1   = td_var_offset(verify_dump),
1907                 .def    = "0",
1908                 .help   = "Dump contents of good and bad blocks on failure",
1909                 .parent = "verify",
1910                 .hide   = 1,
1911                 .category = FIO_OPT_C_IO,
1912                 .group  = FIO_OPT_G_VERIFY,
1913         },
1914         {
1915                 .name   = "verify_async",
1916                 .lname  = "Verify asynchronously",
1917                 .type   = FIO_OPT_INT,
1918                 .off1   = td_var_offset(verify_async),
1919                 .def    = "0",
1920                 .help   = "Number of async verifier threads to use",
1921                 .parent = "verify",
1922                 .hide   = 1,
1923                 .category = FIO_OPT_C_IO,
1924                 .group  = FIO_OPT_G_VERIFY,
1925         },
1926         {
1927                 .name   = "verify_backlog",
1928                 .lname  = "Verify backlog",
1929                 .type   = FIO_OPT_STR_VAL,
1930                 .off1   = td_var_offset(verify_backlog),
1931                 .help   = "Verify after this number of blocks are written",
1932                 .parent = "verify",
1933                 .hide   = 1,
1934                 .category = FIO_OPT_C_IO,
1935                 .group  = FIO_OPT_G_VERIFY,
1936         },
1937         {
1938                 .name   = "verify_backlog_batch",
1939                 .lname  = "Verify backlog batch",
1940                 .type   = FIO_OPT_INT,
1941                 .off1   = td_var_offset(verify_batch),
1942                 .help   = "Verify this number of IO blocks",
1943                 .parent = "verify",
1944                 .hide   = 1,
1945                 .category = FIO_OPT_C_IO,
1946                 .group  = FIO_OPT_G_VERIFY,
1947         },
1948 #ifdef FIO_HAVE_CPU_AFFINITY
1949         {
1950                 .name   = "verify_async_cpus",
1951                 .lname  = "Async verify CPUs",
1952                 .type   = FIO_OPT_STR,
1953                 .cb     = str_verify_cpus_allowed_cb,
1954                 .help   = "Set CPUs allowed for async verify threads",
1955                 .parent = "verify_async",
1956                 .hide   = 1,
1957                 .category = FIO_OPT_C_IO,
1958                 .group  = FIO_OPT_G_VERIFY,
1959         },
1960 #endif
1961 #ifdef FIO_HAVE_TRIM
1962         {
1963                 .name   = "trim_percentage",
1964                 .lname  = "Trim percentage",
1965                 .type   = FIO_OPT_INT,
1966                 .cb     = str_verify_trim_cb,
1967                 .minval = 0,
1968                 .maxval = 100,
1969                 .help   = "Number of verify blocks to discard/trim",
1970                 .parent = "verify",
1971                 .def    = "0",
1972                 .interval = 1,
1973                 .hide   = 1,
1974                 .category = FIO_OPT_C_IO,
1975                 .group  = FIO_OPT_G_TRIM,
1976         },
1977         {
1978                 .name   = "trim_verify_zero",
1979                 .lname  = "Verify trim zero",
1980                 .type   = FIO_OPT_BOOL,
1981                 .help   = "Verify that trim/discarded blocks are returned as zeroes",
1982                 .off1   = td_var_offset(trim_zero),
1983                 .parent = "trim_percentage",
1984                 .hide   = 1,
1985                 .def    = "1",
1986                 .category = FIO_OPT_C_IO,
1987                 .group  = FIO_OPT_G_TRIM,
1988         },
1989         {
1990                 .name   = "trim_backlog",
1991                 .lname  = "Trim backlog",
1992                 .type   = FIO_OPT_STR_VAL,
1993                 .off1   = td_var_offset(trim_backlog),
1994                 .help   = "Trim after this number of blocks are written",
1995                 .parent = "trim_percentage",
1996                 .hide   = 1,
1997                 .interval = 1,
1998                 .category = FIO_OPT_C_IO,
1999                 .group  = FIO_OPT_G_TRIM,
2000         },
2001         {
2002                 .name   = "trim_backlog_batch",
2003                 .lname  = "Trim backlog batch",
2004                 .type   = FIO_OPT_INT,
2005                 .off1   = td_var_offset(trim_batch),
2006                 .help   = "Trim this number of IO blocks",
2007                 .parent = "trim_percentage",
2008                 .hide   = 1,
2009                 .interval = 1,
2010                 .category = FIO_OPT_C_IO,
2011                 .group  = FIO_OPT_G_TRIM,
2012         },
2013 #endif
2014         {
2015                 .name   = "write_iolog",
2016                 .lname  = "Write I/O log",
2017                 .type   = FIO_OPT_STR_STORE,
2018                 .off1   = td_var_offset(write_iolog_file),
2019                 .help   = "Store IO pattern to file",
2020                 .category = FIO_OPT_C_IO,
2021                 .group  = FIO_OPT_G_IOLOG,
2022         },
2023         {
2024                 .name   = "read_iolog",
2025                 .lname  = "Read I/O log",
2026                 .type   = FIO_OPT_STR_STORE,
2027                 .off1   = td_var_offset(read_iolog_file),
2028                 .help   = "Playback IO pattern from file",
2029                 .category = FIO_OPT_C_IO,
2030                 .group  = FIO_OPT_G_IOLOG,
2031         },
2032         {
2033                 .name   = "replay_no_stall",
2034                 .lname  = "Don't stall on replay",
2035                 .type   = FIO_OPT_BOOL,
2036                 .off1   = td_var_offset(no_stall),
2037                 .def    = "0",
2038                 .parent = "read_iolog",
2039                 .hide   = 1,
2040                 .help   = "Playback IO pattern file as fast as possible without stalls",
2041                 .category = FIO_OPT_C_IO,
2042                 .group  = FIO_OPT_G_IOLOG,
2043         },
2044         {
2045                 .name   = "replay_redirect",
2046                 .lname  = "Redirect device for replay",
2047                 .type   = FIO_OPT_STR_STORE,
2048                 .off1   = td_var_offset(replay_redirect),
2049                 .parent = "read_iolog",
2050                 .hide   = 1,
2051                 .help   = "Replay all I/O onto this device, regardless of trace device",
2052                 .category = FIO_OPT_C_IO,
2053                 .group  = FIO_OPT_G_IOLOG,
2054         },
2055         {
2056                 .name   = "exec_prerun",
2057                 .lname  = "Pre-execute runnable",
2058                 .type   = FIO_OPT_STR_STORE,
2059                 .off1   = td_var_offset(exec_prerun),
2060                 .help   = "Execute this file prior to running job",
2061                 .category = FIO_OPT_C_GENERAL,
2062                 .group  = FIO_OPT_G_INVALID,
2063         },
2064         {
2065                 .name   = "exec_postrun",
2066                 .lname  = "Post-execute runnable",
2067                 .type   = FIO_OPT_STR_STORE,
2068                 .off1   = td_var_offset(exec_postrun),
2069                 .help   = "Execute this file after running job",
2070                 .category = FIO_OPT_C_GENERAL,
2071                 .group  = FIO_OPT_G_INVALID,
2072         },
2073 #ifdef FIO_HAVE_IOSCHED_SWITCH
2074         {
2075                 .name   = "ioscheduler",
2076                 .lname  = "I/O scheduler",
2077                 .type   = FIO_OPT_STR_STORE,
2078                 .off1   = td_var_offset(ioscheduler),
2079                 .help   = "Use this IO scheduler on the backing device",
2080                 .category = FIO_OPT_C_FILE,
2081                 .group  = FIO_OPT_G_INVALID,
2082         },
2083 #endif
2084         {
2085                 .name   = "zonesize",
2086                 .lname  = "Zone size",
2087                 .type   = FIO_OPT_STR_VAL,
2088                 .off1   = td_var_offset(zone_size),
2089                 .help   = "Amount of data to read per zone",
2090                 .def    = "0",
2091                 .interval = 1024 * 1024,
2092                 .category = FIO_OPT_C_IO,
2093                 .group  = FIO_OPT_G_ZONE,
2094         },
2095         {
2096                 .name   = "zonerange",
2097                 .lname  = "Zone range",
2098                 .type   = FIO_OPT_STR_VAL,
2099                 .off1   = td_var_offset(zone_range),
2100                 .help   = "Give size of an IO zone",
2101                 .def    = "0",
2102                 .interval = 1024 * 1024,
2103                 .category = FIO_OPT_C_IO,
2104                 .group  = FIO_OPT_G_ZONE,
2105         },
2106         {
2107                 .name   = "zoneskip",
2108                 .lname  = "Zone skip",
2109                 .type   = FIO_OPT_STR_VAL,
2110                 .off1   = td_var_offset(zone_skip),
2111                 .help   = "Space between IO zones",
2112                 .def    = "0",
2113                 .interval = 1024 * 1024,
2114                 .category = FIO_OPT_C_IO,
2115                 .group  = FIO_OPT_G_ZONE,
2116         },
2117         {
2118                 .name   = "lockmem",
2119                 .lname  = "Lock memory",
2120                 .type   = FIO_OPT_STR_VAL,
2121                 .off1   = td_var_offset(lockmem),
2122                 .help   = "Lock down this amount of memory",
2123                 .def    = "0",
2124                 .interval = 1024 * 1024,
2125                 .category = FIO_OPT_C_GENERAL,
2126                 .group  = FIO_OPT_G_INVALID,
2127         },
2128         {
2129                 .name   = "rwmixread",
2130                 .lname  = "Read/write mix read",
2131                 .type   = FIO_OPT_INT,
2132                 .cb     = str_rwmix_read_cb,
2133                 .maxval = 100,
2134                 .help   = "Percentage of mixed workload that is reads",
2135                 .def    = "50",
2136                 .interval = 5,
2137                 .inverse = "rwmixwrite",
2138                 .category = FIO_OPT_C_IO,
2139                 .group  = FIO_OPT_G_RWMIX,
2140         },
2141         {
2142                 .name   = "rwmixwrite",
2143                 .lname  = "Read/write mix write",
2144                 .type   = FIO_OPT_INT,
2145                 .cb     = str_rwmix_write_cb,
2146                 .maxval = 100,
2147                 .help   = "Percentage of mixed workload that is writes",
2148                 .def    = "50",
2149                 .interval = 5,
2150                 .inverse = "rwmixread",
2151                 .category = FIO_OPT_C_IO,
2152                 .group  = FIO_OPT_G_RWMIX,
2153         },
2154         {
2155                 .name   = "rwmixcycle",
2156                 .lname  = "Read/write mix cycle",
2157                 .type   = FIO_OPT_DEPRECATED,
2158                 .category = FIO_OPT_C_IO,
2159                 .group  = FIO_OPT_G_RWMIX,
2160         },
2161         {
2162                 .name   = "nice",
2163                 .lname  = "Nice",
2164                 .type   = FIO_OPT_INT,
2165                 .off1   = td_var_offset(nice),
2166                 .help   = "Set job CPU nice value",
2167                 .minval = -19,
2168                 .maxval = 20,
2169                 .def    = "0",
2170                 .interval = 1,
2171                 .category = FIO_OPT_C_GENERAL,
2172                 .group  = FIO_OPT_G_CRED,
2173         },
2174 #ifdef FIO_HAVE_IOPRIO
2175         {
2176                 .name   = "prio",
2177                 .lname  = "I/O nice priority",
2178                 .type   = FIO_OPT_INT,
2179                 .cb     = str_prio_cb,
2180                 .help   = "Set job IO priority value",
2181                 .minval = 0,
2182                 .maxval = 7,
2183                 .interval = 1,
2184                 .category = FIO_OPT_C_GENERAL,
2185                 .group  = FIO_OPT_G_CRED,
2186         },
2187         {
2188                 .name   = "prioclass",
2189                 .lname  = "I/O nice priority class",
2190                 .type   = FIO_OPT_INT,
2191                 .cb     = str_prioclass_cb,
2192                 .help   = "Set job IO priority class",
2193                 .minval = 0,
2194                 .maxval = 3,
2195                 .interval = 1,
2196                 .category = FIO_OPT_C_GENERAL,
2197                 .group  = FIO_OPT_G_CRED,
2198         },
2199 #endif
2200         {
2201                 .name   = "thinktime",
2202                 .lname  = "Thinktime",
2203                 .type   = FIO_OPT_INT,
2204                 .off1   = td_var_offset(thinktime),
2205                 .help   = "Idle time between IO buffers (usec)",
2206                 .def    = "0",
2207                 .category = FIO_OPT_C_IO,
2208                 .group  = FIO_OPT_G_THINKTIME,
2209         },
2210         {
2211                 .name   = "thinktime_spin",
2212                 .lname  = "Thinktime spin",
2213                 .type   = FIO_OPT_INT,
2214                 .off1   = td_var_offset(thinktime_spin),
2215                 .help   = "Start think time by spinning this amount (usec)",
2216                 .def    = "0",
2217                 .parent = "thinktime",
2218                 .hide   = 1,
2219                 .category = FIO_OPT_C_IO,
2220                 .group  = FIO_OPT_G_THINKTIME,
2221         },
2222         {
2223                 .name   = "thinktime_blocks",
2224                 .lname  = "Thinktime blocks",
2225                 .type   = FIO_OPT_INT,
2226                 .off1   = td_var_offset(thinktime_blocks),
2227                 .help   = "IO buffer period between 'thinktime'",
2228                 .def    = "1",
2229                 .parent = "thinktime",
2230                 .hide   = 1,
2231                 .category = FIO_OPT_C_IO,
2232                 .group  = FIO_OPT_G_THINKTIME,
2233         },
2234         {
2235                 .name   = "rate",
2236                 .lname  = "I/O rate",
2237                 .type   = FIO_OPT_INT,
2238                 .off1   = td_var_offset(rate[0]),
2239                 .off2   = td_var_offset(rate[1]),
2240                 .help   = "Set bandwidth rate",
2241                 .category = FIO_OPT_C_IO,
2242                 .group  = FIO_OPT_G_RATE,
2243         },
2244         {
2245                 .name   = "ratemin",
2246                 .lname  = "I/O min rate",
2247                 .type   = FIO_OPT_INT,
2248                 .off1   = td_var_offset(ratemin[0]),
2249                 .off2   = td_var_offset(ratemin[1]),
2250                 .help   = "Job must meet this rate or it will be shutdown",
2251                 .parent = "rate",
2252                 .hide   = 1,
2253                 .category = FIO_OPT_C_IO,
2254                 .group  = FIO_OPT_G_RATE,
2255         },
2256         {
2257                 .name   = "rate_iops",
2258                 .lname  = "I/O rate IOPS",
2259                 .type   = FIO_OPT_INT,
2260                 .off1   = td_var_offset(rate_iops[0]),
2261                 .off2   = td_var_offset(rate_iops[1]),
2262                 .help   = "Limit IO used to this number of IO operations/sec",
2263                 .hide   = 1,
2264                 .category = FIO_OPT_C_IO,
2265                 .group  = FIO_OPT_G_RATE,
2266         },
2267         {
2268                 .name   = "rate_iops_min",
2269                 .lname  = "I/O min rate IOPS",
2270                 .type   = FIO_OPT_INT,
2271                 .off1   = td_var_offset(rate_iops_min[0]),
2272                 .off2   = td_var_offset(rate_iops_min[1]),
2273                 .help   = "Job must meet this rate or it will be shut down",
2274                 .parent = "rate_iops",
2275                 .hide   = 1,
2276                 .category = FIO_OPT_C_IO,
2277                 .group  = FIO_OPT_G_RATE,
2278         },
2279         {
2280                 .name   = "ratecycle",
2281                 .lname  = "I/O rate cycle",
2282                 .type   = FIO_OPT_INT,
2283                 .off1   = td_var_offset(ratecycle),
2284                 .help   = "Window average for rate limits (msec)",
2285                 .def    = "1000",
2286                 .parent = "rate",
2287                 .hide   = 1,
2288                 .category = FIO_OPT_C_IO,
2289                 .group  = FIO_OPT_G_RATE,
2290         },
2291         {
2292                 .name   = "invalidate",
2293                 .lname  = "Cache invalidate",
2294                 .type   = FIO_OPT_BOOL,
2295                 .off1   = td_var_offset(invalidate_cache),
2296                 .help   = "Invalidate buffer/page cache prior to running job",
2297                 .def    = "1",
2298                 .category = FIO_OPT_C_IO,
2299                 .group  = FIO_OPT_G_IO_TYPE,
2300         },
2301         {
2302                 .name   = "sync",
2303                 .lname  = "Synchronous I/O",
2304                 .type   = FIO_OPT_BOOL,
2305                 .off1   = td_var_offset(sync_io),
2306                 .help   = "Use O_SYNC for buffered writes",
2307                 .def    = "0",
2308                 .parent = "buffered",
2309                 .hide   = 1,
2310                 .category = FIO_OPT_C_IO,
2311                 .group  = FIO_OPT_G_IO_TYPE,
2312         },
2313         {
2314                 .name   = "create_serialize",
2315                 .lname  = "Create serialize",
2316                 .type   = FIO_OPT_BOOL,
2317                 .off1   = td_var_offset(create_serialize),
2318                 .help   = "Serialize creating of job files",
2319                 .def    = "1",
2320                 .category = FIO_OPT_C_FILE,
2321                 .group  = FIO_OPT_G_INVALID,
2322         },
2323         {
2324                 .name   = "create_fsync",
2325                 .lname  = "Create fsync",
2326                 .type   = FIO_OPT_BOOL,
2327                 .off1   = td_var_offset(create_fsync),
2328                 .help   = "fsync file after creation",
2329                 .def    = "1",
2330                 .category = FIO_OPT_C_FILE,
2331                 .group  = FIO_OPT_G_INVALID,
2332         },
2333         {
2334                 .name   = "create_on_open",
2335                 .lname  = "Create on open",
2336                 .type   = FIO_OPT_BOOL,
2337                 .off1   = td_var_offset(create_on_open),
2338                 .help   = "Create files when they are opened for IO",
2339                 .def    = "0",
2340                 .category = FIO_OPT_C_FILE,
2341                 .group  = FIO_OPT_G_INVALID,
2342         },
2343         {
2344                 .name   = "pre_read",
2345                 .lname  = "Pre-read files",
2346                 .type   = FIO_OPT_BOOL,
2347                 .off1   = td_var_offset(pre_read),
2348                 .help   = "Pre-read files before starting official testing",
2349                 .def    = "0",
2350                 .category = FIO_OPT_C_FILE,
2351                 .group  = FIO_OPT_G_INVALID,
2352         },
2353 #ifdef FIO_HAVE_CPU_AFFINITY
2354         {
2355                 .name   = "cpumask",
2356                 .lname  = "CPU mask",
2357                 .type   = FIO_OPT_INT,
2358                 .cb     = str_cpumask_cb,
2359                 .help   = "CPU affinity mask",
2360                 .category = FIO_OPT_C_GENERAL,
2361                 .group  = FIO_OPT_G_CRED,
2362         },
2363         {
2364                 .name   = "cpus_allowed",
2365                 .lname  = "CPUs allowed",
2366                 .type   = FIO_OPT_STR,
2367                 .cb     = str_cpus_allowed_cb,
2368                 .help   = "Set CPUs allowed",
2369                 .category = FIO_OPT_C_GENERAL,
2370                 .group  = FIO_OPT_G_CRED,
2371         },
2372 #endif
2373         {
2374                 .name   = "end_fsync",
2375                 .lname  = "End fsync",
2376                 .type   = FIO_OPT_BOOL,
2377                 .off1   = td_var_offset(end_fsync),
2378                 .help   = "Include fsync at the end of job",
2379                 .def    = "0",
2380                 .category = FIO_OPT_C_FILE,
2381                 .group  = FIO_OPT_G_INVALID,
2382         },
2383         {
2384                 .name   = "fsync_on_close",
2385                 .lname  = "Fsync on close",
2386                 .type   = FIO_OPT_BOOL,
2387                 .off1   = td_var_offset(fsync_on_close),
2388                 .help   = "fsync files on close",
2389                 .def    = "0",
2390                 .category = FIO_OPT_C_FILE,
2391                 .group  = FIO_OPT_G_INVALID,
2392         },
2393         {
2394                 .name   = "unlink",
2395                 .lname  = "Unlink file",
2396                 .type   = FIO_OPT_BOOL,
2397                 .off1   = td_var_offset(unlink),
2398                 .help   = "Unlink created files after job has completed",
2399                 .def    = "0",
2400                 .category = FIO_OPT_C_FILE,
2401                 .group  = FIO_OPT_G_INVALID,
2402         },
2403         {
2404                 .name   = "exitall",
2405                 .lname  = "Exit-all on terminate",
2406                 .type   = FIO_OPT_STR_SET,
2407                 .cb     = str_exitall_cb,
2408                 .help   = "Terminate all jobs when one exits",
2409                 .category = FIO_OPT_C_GENERAL,
2410                 .group  = FIO_OPT_G_PROCESS,
2411         },
2412         {
2413                 .name   = "stonewall",
2414                 .lname  = "Wait for previous",
2415                 .alias  = "wait_for_previous",
2416                 .type   = FIO_OPT_STR_SET,
2417                 .off1   = td_var_offset(stonewall),
2418                 .help   = "Insert a hard barrier between this job and previous",
2419                 .category = FIO_OPT_C_GENERAL,
2420                 .group  = FIO_OPT_G_PROCESS,
2421         },
2422         {
2423                 .name   = "new_group",
2424                 .lname  = "New group",
2425                 .type   = FIO_OPT_STR_SET,
2426                 .off1   = td_var_offset(new_group),
2427                 .help   = "Mark the start of a new group (for reporting)",
2428                 .category = FIO_OPT_C_GENERAL,
2429                 .group  = FIO_OPT_G_PROCESS,
2430         },
2431         {
2432                 .name   = "thread",
2433                 .lname  = "Thread",
2434                 .type   = FIO_OPT_STR_SET,
2435                 .off1   = td_var_offset(use_thread),
2436                 .help   = "Use threads instead of processes",
2437                 .category = FIO_OPT_C_GENERAL,
2438                 .group  = FIO_OPT_G_PROCESS,
2439         },
2440         {
2441                 .name   = "write_bw_log",
2442                 .lname  = "Write bandwidth log",
2443                 .type   = FIO_OPT_STR,
2444                 .off1   = td_var_offset(write_bw_log),
2445                 .cb     = str_write_bw_log_cb,
2446                 .help   = "Write log of bandwidth during run",
2447                 .category = FIO_OPT_C_LOG,
2448                 .group  = FIO_OPT_G_INVALID,
2449         },
2450         {
2451                 .name   = "write_lat_log",
2452                 .lname  = "Write latency log",
2453                 .type   = FIO_OPT_STR,
2454                 .off1   = td_var_offset(write_lat_log),
2455                 .cb     = str_write_lat_log_cb,
2456                 .help   = "Write log of latency during run",
2457                 .category = FIO_OPT_C_LOG,
2458                 .group  = FIO_OPT_G_INVALID,
2459         },
2460         {
2461                 .name   = "write_iops_log",
2462                 .lname  = "Write IOPS log",
2463                 .type   = FIO_OPT_STR,
2464                 .off1   = td_var_offset(write_iops_log),
2465                 .cb     = str_write_iops_log_cb,
2466                 .help   = "Write log of IOPS during run",
2467                 .category = FIO_OPT_C_LOG,
2468                 .group  = FIO_OPT_G_INVALID,
2469         },
2470         {
2471                 .name   = "log_avg_msec",
2472                 .lname  = "Log averaging (msec)",
2473                 .type   = FIO_OPT_INT,
2474                 .off1   = td_var_offset(log_avg_msec),
2475                 .help   = "Average bw/iops/lat logs over this period of time",
2476                 .def    = "0",
2477                 .category = FIO_OPT_C_LOG,
2478                 .group  = FIO_OPT_G_INVALID,
2479         },
2480         {
2481                 .name   = "bwavgtime",
2482                 .lname  = "Bandwidth average time",
2483                 .type   = FIO_OPT_INT,
2484                 .off1   = td_var_offset(bw_avg_time),
2485                 .help   = "Time window over which to calculate bandwidth"
2486                           " (msec)",
2487                 .def    = "500",
2488                 .parent = "write_bw_log",
2489                 .hide   = 1,
2490                 .interval = 100,
2491                 .category = FIO_OPT_C_LOG,
2492                 .group  = FIO_OPT_G_INVALID,
2493         },
2494         {
2495                 .name   = "iopsavgtime",
2496                 .lname  = "IOPS average time",
2497                 .type   = FIO_OPT_INT,
2498                 .off1   = td_var_offset(iops_avg_time),
2499                 .help   = "Time window over which to calculate IOPS (msec)",
2500                 .def    = "500",
2501                 .parent = "write_iops_log",
2502                 .hide   = 1,
2503                 .interval = 100,
2504                 .category = FIO_OPT_C_LOG,
2505                 .group  = FIO_OPT_G_INVALID,
2506         },
2507         {
2508                 .name   = "group_reporting",
2509                 .lname  = "Group reporting",
2510                 .type   = FIO_OPT_BOOL,
2511                 .off1   = td_var_offset(group_reporting),
2512                 .help   = "Do reporting on a per-group basis",
2513                 .def    = "1",
2514                 .category = FIO_OPT_C_STAT,
2515                 .group  = FIO_OPT_G_INVALID,
2516         },
2517         {
2518                 .name   = "zero_buffers",
2519                 .lname  = "Zero I/O buffers",
2520                 .type   = FIO_OPT_STR_SET,
2521                 .off1   = td_var_offset(zero_buffers),
2522                 .help   = "Init IO buffers to all zeroes",
2523                 .category = FIO_OPT_C_IO,
2524                 .group  = FIO_OPT_G_IO_BUF,
2525         },
2526         {
2527                 .name   = "refill_buffers",
2528                 .lname  = "Refill I/O buffers",
2529                 .type   = FIO_OPT_STR_SET,
2530                 .off1   = td_var_offset(refill_buffers),
2531                 .help   = "Refill IO buffers on every IO submit",
2532                 .category = FIO_OPT_C_IO,
2533                 .group  = FIO_OPT_G_IO_BUF,
2534         },
2535         {
2536                 .name   = "scramble_buffers",
2537                 .lname  = "Scramble I/O buffers",
2538                 .type   = FIO_OPT_BOOL,
2539                 .off1   = td_var_offset(scramble_buffers),
2540                 .help   = "Slightly scramble buffers on every IO submit",
2541                 .def    = "1",
2542                 .category = FIO_OPT_C_IO,
2543                 .group  = FIO_OPT_G_IO_BUF,
2544         },
2545         {
2546                 .name   = "buffer_compress_percentage",
2547                 .lname  = "Buffer compression percentage",
2548                 .type   = FIO_OPT_INT,
2549                 .off1   = td_var_offset(compress_percentage),
2550                 .maxval = 100,
2551                 .minval = 1,
2552                 .help   = "How compressible the buffer is (approximately)",
2553                 .interval = 5,
2554                 .category = FIO_OPT_C_IO,
2555                 .group  = FIO_OPT_G_IO_BUF,
2556         },
2557         {
2558                 .name   = "buffer_compress_chunk",
2559                 .lname  = "Buffer compression chunk size",
2560                 .type   = FIO_OPT_INT,
2561                 .off1   = td_var_offset(compress_chunk),
2562                 .parent = "buffer_compress_percentage",
2563                 .hide   = 1,
2564                 .help   = "Size of compressible region in buffer",
2565                 .interval = 256,
2566                 .category = FIO_OPT_C_IO,
2567                 .group  = FIO_OPT_G_IO_BUF,
2568         },
2569         {
2570                 .name   = "clat_percentiles",
2571                 .lname  = "Completion latency percentiles",
2572                 .type   = FIO_OPT_BOOL,
2573                 .off1   = td_var_offset(clat_percentiles),
2574                 .help   = "Enable the reporting of completion latency percentiles",
2575                 .def    = "1",
2576                 .category = FIO_OPT_C_STAT,
2577                 .group  = FIO_OPT_G_INVALID,
2578         },
2579         {
2580                 .name   = "percentile_list",
2581                 .lname  = "Completion latency percentile list",
2582                 .type   = FIO_OPT_FLOAT_LIST,
2583                 .off1   = td_var_offset(percentile_list),
2584                 .off2   = td_var_offset(overwrite_plist),
2585                 .help   = "Specify a custom list of percentiles to report",
2586                 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2587                 .minfp  = 0.0,
2588                 .maxfp  = 100.0,
2589                 .category = FIO_OPT_C_STAT,
2590                 .group  = FIO_OPT_G_INVALID,
2591         },
2592
2593 #ifdef FIO_HAVE_DISK_UTIL
2594         {
2595                 .name   = "disk_util",
2596                 .lname  = "Disk utilization",
2597                 .type   = FIO_OPT_BOOL,
2598                 .off1   = td_var_offset(do_disk_util),
2599                 .help   = "Log disk utilization statistics",
2600                 .def    = "1",
2601                 .category = FIO_OPT_C_STAT,
2602                 .group  = FIO_OPT_G_INVALID,
2603         },
2604 #endif
2605         {
2606                 .name   = "gtod_reduce",
2607                 .lname  = "Reduce gettimeofday() calls",
2608                 .type   = FIO_OPT_BOOL,
2609                 .help   = "Greatly reduce number of gettimeofday() calls",
2610                 .cb     = str_gtod_reduce_cb,
2611                 .def    = "0",
2612                 .hide_on_set = 1,
2613                 .category = FIO_OPT_C_STAT,
2614                 .group  = FIO_OPT_G_INVALID,
2615         },
2616         {
2617                 .name   = "disable_lat",
2618                 .lname  = "Disable all latency stats",
2619                 .type   = FIO_OPT_BOOL,
2620                 .off1   = td_var_offset(disable_lat),
2621                 .help   = "Disable latency numbers",
2622                 .parent = "gtod_reduce",
2623                 .hide   = 1,
2624                 .def    = "0",
2625                 .category = FIO_OPT_C_STAT,
2626                 .group  = FIO_OPT_G_INVALID,
2627         },
2628         {
2629                 .name   = "disable_clat",
2630                 .lname  = "Disable completion latency stats",
2631                 .type   = FIO_OPT_BOOL,
2632                 .off1   = td_var_offset(disable_clat),
2633                 .help   = "Disable completion latency numbers",
2634                 .parent = "gtod_reduce",
2635                 .hide   = 1,
2636                 .def    = "0",
2637                 .category = FIO_OPT_C_STAT,
2638                 .group  = FIO_OPT_G_INVALID,
2639         },
2640         {
2641                 .name   = "disable_slat",
2642                 .lname  = "Disable submission latency stats",
2643                 .type   = FIO_OPT_BOOL,
2644                 .off1   = td_var_offset(disable_slat),
2645                 .help   = "Disable submission latency numbers",
2646                 .parent = "gtod_reduce",
2647                 .hide   = 1,
2648                 .def    = "0",
2649                 .category = FIO_OPT_C_STAT,
2650                 .group  = FIO_OPT_G_INVALID,
2651         },
2652         {
2653                 .name   = "disable_bw_measurement",
2654                 .lname  = "Disable bandwidth stats",
2655                 .type   = FIO_OPT_BOOL,
2656                 .off1   = td_var_offset(disable_bw),
2657                 .help   = "Disable bandwidth logging",
2658                 .parent = "gtod_reduce",
2659                 .hide   = 1,
2660                 .def    = "0",
2661                 .category = FIO_OPT_C_STAT,
2662                 .group  = FIO_OPT_G_INVALID,
2663         },
2664         {
2665                 .name   = "gtod_cpu",
2666                 .lname  = "Dedicated gettimeofday() CPU",
2667                 .type   = FIO_OPT_INT,
2668                 .cb     = str_gtod_cpu_cb,
2669                 .help   = "Set up dedicated gettimeofday() thread on this CPU",
2670                 .verify = gtod_cpu_verify,
2671                 .category = FIO_OPT_C_GENERAL,
2672                 .group  = FIO_OPT_G_CLOCK,
2673         },
2674         {
2675                 .name   = "continue_on_error",
2676                 .lname  = "Continue on error",
2677                 .type   = FIO_OPT_STR,
2678                 .off1   = td_var_offset(continue_on_error),
2679                 .help   = "Continue on non-fatal errors during IO",
2680                 .def    = "none",
2681                 .category = FIO_OPT_C_GENERAL,
2682                 .group  = FIO_OPT_G_INVALID,
2683                 .posval = {
2684                           { .ival = "none",
2685                             .oval = ERROR_TYPE_NONE,
2686                             .help = "Exit when an error is encountered",
2687                           },
2688                           { .ival = "read",
2689                             .oval = ERROR_TYPE_READ,
2690                             .help = "Continue on read errors only",
2691                           },
2692                           { .ival = "write",
2693                             .oval = ERROR_TYPE_WRITE,
2694                             .help = "Continue on write errors only",
2695                           },
2696                           { .ival = "io",
2697                             .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2698                             .help = "Continue on any IO errors",
2699                           },
2700                           { .ival = "verify",
2701                             .oval = ERROR_TYPE_VERIFY,
2702                             .help = "Continue on verify errors only",
2703                           },
2704                           { .ival = "all",
2705                             .oval = ERROR_TYPE_ANY,
2706                             .help = "Continue on all io and verify errors",
2707                           },
2708                           { .ival = "0",
2709                             .oval = ERROR_TYPE_NONE,
2710                             .help = "Alias for 'none'",
2711                           },
2712                           { .ival = "1",
2713                             .oval = ERROR_TYPE_ANY,
2714                             .help = "Alias for 'all'",
2715                           },
2716                 },
2717         },
2718         {
2719                 .name   = "profile",
2720                 .lname  = "Profile",
2721                 .type   = FIO_OPT_STR_STORE,
2722                 .off1   = td_var_offset(profile),
2723                 .help   = "Select a specific builtin performance test",
2724                 .category = FIO_OPT_C_GENERAL,
2725                 .group  = FIO_OPT_G_INVALID,
2726         },
2727         {
2728                 .name   = "cgroup",
2729                 .lname  = "Cgroup",
2730                 .type   = FIO_OPT_STR_STORE,
2731                 .off1   = td_var_offset(cgroup),
2732                 .help   = "Add job to cgroup of this name",
2733                 .category = FIO_OPT_C_GENERAL,
2734                 .group  = FIO_OPT_G_CGROUP,
2735         },
2736         {
2737                 .name   = "cgroup_nodelete",
2738                 .lname  = "Cgroup no-delete",
2739                 .type   = FIO_OPT_BOOL,
2740                 .off1   = td_var_offset(cgroup_nodelete),
2741                 .help   = "Do not delete cgroups after job completion",
2742                 .def    = "0",
2743                 .parent = "cgroup",
2744                 .category = FIO_OPT_C_GENERAL,
2745                 .group  = FIO_OPT_G_CGROUP,
2746         },
2747         {
2748                 .name   = "cgroup_weight",
2749                 .lname  = "Cgroup weight",
2750                 .type   = FIO_OPT_INT,
2751                 .off1   = td_var_offset(cgroup_weight),
2752                 .help   = "Use given weight for cgroup",
2753                 .minval = 100,
2754                 .maxval = 1000,
2755                 .parent = "cgroup",
2756                 .category = FIO_OPT_C_GENERAL,
2757                 .group  = FIO_OPT_G_CGROUP,
2758         },
2759         {
2760                 .name   = "uid",
2761                 .lname  = "User ID",
2762                 .type   = FIO_OPT_INT,
2763                 .off1   = td_var_offset(uid),
2764                 .help   = "Run job with this user ID",
2765                 .category = FIO_OPT_C_GENERAL,
2766                 .group  = FIO_OPT_G_CRED,
2767         },
2768         {
2769                 .name   = "gid",
2770                 .lname  = "Group ID",
2771                 .type   = FIO_OPT_INT,
2772                 .off1   = td_var_offset(gid),
2773                 .help   = "Run job with this group ID",
2774                 .category = FIO_OPT_C_GENERAL,
2775                 .group  = FIO_OPT_G_CRED,
2776         },
2777         {
2778                 .name   = "kb_base",
2779                 .lname  = "KB Base",
2780                 .type   = FIO_OPT_INT,
2781                 .off1   = td_var_offset(kb_base),
2782                 .verify = kb_base_verify,
2783                 .prio   = 1,
2784                 .def    = "1024",
2785                 .help   = "How many bytes per KB for reporting (1000 or 1024)",
2786                 .category = FIO_OPT_C_GENERAL,
2787                 .group  = FIO_OPT_G_INVALID,
2788         },
2789         {
2790                 .name   = "hugepage-size",
2791                 .lname  = "Hugepage size",
2792                 .type   = FIO_OPT_INT,
2793                 .off1   = td_var_offset(hugepage_size),
2794                 .help   = "When using hugepages, specify size of each page",
2795                 .def    = __fio_stringify(FIO_HUGE_PAGE),
2796                 .interval = 1024 * 1024,
2797                 .category = FIO_OPT_C_GENERAL,
2798                 .group  = FIO_OPT_G_INVALID,
2799         },
2800         {
2801                 .name   = "flow_id",
2802                 .lname  = "I/O flow ID",
2803                 .type   = FIO_OPT_INT,
2804                 .off1   = td_var_offset(flow_id),
2805                 .help   = "The flow index ID to use",
2806                 .def    = "0",
2807                 .category = FIO_OPT_C_IO,
2808                 .group  = FIO_OPT_G_IO_FLOW,
2809         },
2810         {
2811                 .name   = "flow",
2812                 .lname  = "I/O flow weight",
2813                 .type   = FIO_OPT_INT,
2814                 .off1   = td_var_offset(flow),
2815                 .help   = "Weight for flow control of this job",
2816                 .parent = "flow_id",
2817                 .hide   = 1,
2818                 .def    = "0",
2819                 .category = FIO_OPT_C_IO,
2820                 .group  = FIO_OPT_G_IO_FLOW,
2821         },
2822         {
2823                 .name   = "flow_watermark",
2824                 .lname  = "I/O flow watermark",
2825                 .type   = FIO_OPT_INT,
2826                 .off1   = td_var_offset(flow_watermark),
2827                 .help   = "High watermark for flow control. This option"
2828                         " should be set to the same value for all threads"
2829                         " with non-zero flow.",
2830                 .parent = "flow_id",
2831                 .hide   = 1,
2832                 .def    = "1024",
2833                 .category = FIO_OPT_C_IO,
2834                 .group  = FIO_OPT_G_IO_FLOW,
2835         },
2836         {
2837                 .name   = "flow_sleep",
2838                 .lname  = "I/O flow sleep",
2839                 .type   = FIO_OPT_INT,
2840                 .off1   = td_var_offset(flow_sleep),
2841                 .help   = "How many microseconds to sleep after being held"
2842                         " back by the flow control mechanism",
2843                 .parent = "flow_id",
2844                 .hide   = 1,
2845                 .def    = "0",
2846                 .category = FIO_OPT_C_IO,
2847                 .group  = FIO_OPT_G_IO_FLOW,
2848         },
2849         {
2850                 .name = NULL,
2851         },
2852 };
2853
2854 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2855                         const char *name, int val)
2856 {
2857         lopt->name = (char *) name;
2858         lopt->val = val;
2859         if (o->type == FIO_OPT_STR_SET)
2860                 lopt->has_arg = no_argument;
2861         else
2862                 lopt->has_arg = required_argument;
2863 }
2864
2865 static void options_to_lopts(struct fio_option *opts,
2866                               struct option *long_options,
2867                               int i, int option_type)
2868 {
2869         struct fio_option *o = &opts[0];
2870         while (o->name) {
2871                 add_to_lopt(&long_options[i], o, o->name, option_type);
2872                 if (o->alias) {
2873                         i++;
2874                         add_to_lopt(&long_options[i], o, o->alias, option_type);
2875                 }
2876
2877                 i++;
2878                 o++;
2879                 assert(i < FIO_NR_OPTIONS);
2880         }
2881 }
2882
2883 void fio_options_set_ioengine_opts(struct option *long_options,
2884                                    struct thread_data *td)
2885 {
2886         unsigned int i;
2887
2888         i = 0;
2889         while (long_options[i].name) {
2890                 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2891                         memset(&long_options[i], 0, sizeof(*long_options));
2892                         break;
2893                 }
2894                 i++;
2895         }
2896
2897         /*
2898          * Just clear out the prior ioengine options.
2899          */
2900         if (!td || !td->eo)
2901                 return;
2902
2903         options_to_lopts(td->io_ops->options, long_options, i,
2904                          FIO_GETOPT_IOENGINE);
2905 }
2906
2907 void fio_options_dup_and_init(struct option *long_options)
2908 {
2909         unsigned int i;
2910
2911         options_init(fio_options);
2912
2913         i = 0;
2914         while (long_options[i].name)
2915                 i++;
2916
2917         options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
2918 }
2919
2920 struct fio_keyword {
2921         const char *word;
2922         const char *desc;
2923         char *replace;
2924 };
2925
2926 static struct fio_keyword fio_keywords[] = {
2927         {
2928                 .word   = "$pagesize",
2929                 .desc   = "Page size in the system",
2930         },
2931         {
2932                 .word   = "$mb_memory",
2933                 .desc   = "Megabytes of memory online",
2934         },
2935         {
2936                 .word   = "$ncpus",
2937                 .desc   = "Number of CPUs online in the system",
2938         },
2939         {
2940                 .word   = NULL,
2941         },
2942 };
2943
2944 void fio_keywords_init(void)
2945 {
2946         unsigned long long mb_memory;
2947         char buf[128];
2948         long l;
2949
2950         sprintf(buf, "%lu", page_size);
2951         fio_keywords[0].replace = strdup(buf);
2952
2953         mb_memory = os_phys_mem() / (1024 * 1024);
2954         sprintf(buf, "%llu", mb_memory);
2955         fio_keywords[1].replace = strdup(buf);
2956
2957         l = cpus_online();
2958         sprintf(buf, "%lu", l);
2959         fio_keywords[2].replace = strdup(buf);
2960 }
2961
2962 #define BC_APP          "bc"
2963
2964 static char *bc_calc(char *str)
2965 {
2966         char buf[128], *tmp;
2967         FILE *f;
2968         int ret;
2969
2970         /*
2971          * No math, just return string
2972          */
2973         if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2974              !strchr(str, '/')) || strchr(str, '\''))
2975                 return str;
2976
2977         /*
2978          * Split option from value, we only need to calculate the value
2979          */
2980         tmp = strchr(str, '=');
2981         if (!tmp)
2982                 return str;
2983
2984         tmp++;
2985
2986         /*
2987          * Prevent buffer overflows; such a case isn't reasonable anyway
2988          */
2989         if (strlen(str) >= 128 || strlen(tmp) > 100)
2990                 return str;
2991
2992         sprintf(buf, "which %s > /dev/null", BC_APP);
2993         if (system(buf)) {
2994                 log_err("fio: bc is needed for performing math\n");
2995                 return NULL;
2996         }
2997
2998         sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2999         f = popen(buf, "r");
3000         if (!f)
3001                 return NULL;
3002
3003         ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
3004         if (ret <= 0)
3005                 return NULL;
3006
3007         pclose(f);
3008         buf[(tmp - str) + ret - 1] = '\0';
3009         memcpy(buf, str, tmp - str);
3010         free(str);
3011         return strdup(buf);
3012 }
3013
3014 /*
3015  * Return a copy of the input string with substrings of the form ${VARNAME}
3016  * substituted with the value of the environment variable VARNAME.  The
3017  * substitution always occurs, even if VARNAME is empty or the corresponding
3018  * environment variable undefined.
3019  */
3020 static char *option_dup_subs(const char *opt)
3021 {
3022         char out[OPT_LEN_MAX+1];
3023         char in[OPT_LEN_MAX+1];
3024         char *outptr = out;
3025         char *inptr = in;
3026         char *ch1, *ch2, *env;
3027         ssize_t nchr = OPT_LEN_MAX;
3028         size_t envlen;
3029
3030         if (strlen(opt) + 1 > OPT_LEN_MAX) {
3031                 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
3032                 return NULL;
3033         }
3034
3035         in[OPT_LEN_MAX] = '\0';
3036         strncpy(in, opt, OPT_LEN_MAX);
3037
3038         while (*inptr && nchr > 0) {
3039                 if (inptr[0] == '$' && inptr[1] == '{') {
3040                         ch2 = strchr(inptr, '}');
3041                         if (ch2 && inptr+1 < ch2) {
3042                                 ch1 = inptr+2;
3043                                 inptr = ch2+1;
3044                                 *ch2 = '\0';
3045
3046                                 env = getenv(ch1);
3047                                 if (env) {
3048                                         envlen = strlen(env);
3049                                         if (envlen <= nchr) {
3050                                                 memcpy(outptr, env, envlen);
3051                                                 outptr += envlen;
3052                                                 nchr -= envlen;
3053                                         }
3054                                 }
3055
3056                                 continue;
3057                         }
3058                 }
3059
3060                 *outptr++ = *inptr++;
3061                 --nchr;
3062         }
3063
3064         *outptr = '\0';
3065         return strdup(out);
3066 }
3067
3068 /*
3069  * Look for reserved variable names and replace them with real values
3070  */
3071 static char *fio_keyword_replace(char *opt)
3072 {
3073         char *s;
3074         int i;
3075         int docalc = 0;
3076
3077         for (i = 0; fio_keywords[i].word != NULL; i++) {
3078                 struct fio_keyword *kw = &fio_keywords[i];
3079
3080                 while ((s = strstr(opt, kw->word)) != NULL) {
3081                         char *new = malloc(strlen(opt) + 1);
3082                         char *o_org = opt;
3083                         int olen = s - opt;
3084                         int len;
3085
3086                         /*
3087                          * Copy part of the string before the keyword and
3088                          * sprintf() the replacement after it.
3089                          */
3090                         memcpy(new, opt, olen);
3091                         len = sprintf(new + olen, "%s", kw->replace);
3092
3093                         /*
3094                          * If there's more in the original string, copy that
3095                          * in too
3096                          */
3097                         opt += strlen(kw->word) + olen;
3098                         if (strlen(opt))
3099                                 memcpy(new + olen + len, opt, opt - o_org - 1);
3100
3101                         /*
3102                          * replace opt and free the old opt
3103                          */
3104                         opt = new;
3105                         free(o_org);
3106
3107                         docalc = 1;
3108                 }
3109         }
3110
3111         /*
3112          * Check for potential math and invoke bc, if possible
3113          */
3114         if (docalc)
3115                 opt = bc_calc(opt);
3116
3117         return opt;
3118 }
3119
3120 static char **dup_and_sub_options(char **opts, int num_opts)
3121 {
3122         int i;
3123         char **opts_copy = malloc(num_opts * sizeof(*opts));
3124         for (i = 0; i < num_opts; i++) {
3125                 opts_copy[i] = option_dup_subs(opts[i]);
3126                 if (!opts_copy[i])
3127                         continue;
3128                 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
3129         }
3130         return opts_copy;
3131 }
3132
3133 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
3134 {
3135         int i, ret, unknown;
3136         char **opts_copy;
3137
3138         sort_options(opts, fio_options, num_opts);
3139         opts_copy = dup_and_sub_options(opts, num_opts);
3140
3141         for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
3142                 struct fio_option *o;
3143                 int newret = parse_option(opts_copy[i], opts[i], fio_options,
3144                                                 &o, td);
3145
3146                 if (opts_copy[i]) {
3147                         if (newret && !o) {
3148                                 unknown++;
3149                                 continue;
3150                         }
3151                         free(opts_copy[i]);
3152                         opts_copy[i] = NULL;
3153                 }
3154
3155                 ret |= newret;
3156         }
3157
3158         if (unknown) {
3159                 ret |= ioengine_load(td);
3160                 if (td->eo) {
3161                         sort_options(opts_copy, td->io_ops->options, num_opts);
3162                         opts = opts_copy;
3163                 }
3164                 for (i = 0; i < num_opts; i++) {
3165                         struct fio_option *o = NULL;
3166                         int newret = 1;
3167                         if (!opts_copy[i])
3168                                 continue;
3169
3170                         if (td->eo)
3171                                 newret = parse_option(opts_copy[i], opts[i],
3172                                                       td->io_ops->options, &o,
3173                                                       td->eo);
3174
3175                         ret |= newret;
3176                         if (!o)
3177                                 log_err("Bad option <%s>\n", opts[i]);
3178
3179                         free(opts_copy[i]);
3180                         opts_copy[i] = NULL;
3181                 }
3182         }
3183
3184         free(opts_copy);
3185         return ret;
3186 }
3187
3188 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
3189 {
3190         return parse_cmd_option(opt, val, fio_options, td);
3191 }
3192
3193 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
3194                                 char *val)
3195 {
3196         return parse_cmd_option(opt, val, td->io_ops->options, td);
3197 }
3198
3199 void fio_fill_default_options(struct thread_data *td)
3200 {
3201         fill_default_options(td, fio_options);
3202 }
3203
3204 int fio_show_option_help(const char *opt)
3205 {
3206         return show_cmd_help(fio_options, opt);
3207 }
3208
3209 void options_mem_dupe(void *data, struct fio_option *options)
3210 {
3211         struct fio_option *o;
3212         char **ptr;
3213
3214         for (o = &options[0]; o->name; o++) {
3215                 if (o->type != FIO_OPT_STR_STORE)
3216                         continue;
3217
3218                 ptr = td_var(data, o->off1);
3219                 if (*ptr)
3220                         *ptr = strdup(*ptr);
3221         }
3222 }
3223
3224 /*
3225  * dupe FIO_OPT_STR_STORE options
3226  */
3227 void fio_options_mem_dupe(struct thread_data *td)
3228 {
3229         options_mem_dupe(&td->o, fio_options);
3230
3231         if (td->eo && td->io_ops) {
3232                 void *oldeo = td->eo;
3233
3234                 td->eo = malloc(td->io_ops->option_struct_size);
3235                 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3236                 options_mem_dupe(td->eo, td->io_ops->options);
3237         }
3238 }
3239
3240 unsigned int fio_get_kb_base(void *data)
3241 {
3242         struct thread_options *o = data;
3243         unsigned int kb_base = 0;
3244
3245         if (o)
3246                 kb_base = o->kb_base;
3247         if (!kb_base)
3248                 kb_base = 1024;
3249
3250         return kb_base;
3251 }
3252
3253 int add_option(struct fio_option *o)
3254 {
3255         struct fio_option *__o;
3256         int opt_index = 0;
3257
3258         __o = fio_options;
3259         while (__o->name) {
3260                 opt_index++;
3261                 __o++;
3262         }
3263
3264         memcpy(&fio_options[opt_index], o, sizeof(*o));
3265         return 0;
3266 }
3267
3268 void invalidate_profile_options(const char *prof_name)
3269 {
3270         struct fio_option *o;
3271
3272         o = fio_options;
3273         while (o->name) {
3274                 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3275                         o->type = FIO_OPT_INVALID;
3276                         o->prof_name = NULL;
3277                 }
3278                 o++;
3279         }
3280 }
3281
3282 void add_opt_posval(const char *optname, const char *ival, const char *help)
3283 {
3284         struct fio_option *o;
3285         unsigned int i;
3286
3287         o = find_option(fio_options, optname);
3288         if (!o)
3289                 return;
3290
3291         for (i = 0; i < PARSE_MAX_VP; i++) {
3292                 if (o->posval[i].ival)
3293                         continue;
3294
3295                 o->posval[i].ival = ival;
3296                 o->posval[i].help = help;
3297                 break;
3298         }
3299 }
3300
3301 void del_opt_posval(const char *optname, const char *ival)
3302 {
3303         struct fio_option *o;
3304         unsigned int i;
3305
3306         o = find_option(fio_options, optname);
3307         if (!o)
3308                 return;
3309
3310         for (i = 0; i < PARSE_MAX_VP; i++) {
3311                 if (!o->posval[i].ival)
3312                         continue;
3313                 if (strcmp(o->posval[i].ival, ival))
3314                         continue;
3315
3316                 o->posval[i].ival = NULL;
3317                 o->posval[i].help = NULL;
3318         }
3319 }
3320
3321 void fio_options_free(struct thread_data *td)
3322 {
3323         options_free(fio_options, td);
3324         if (td->eo && td->io_ops && td->io_ops->options) {
3325                 options_free(td->io_ops->options, td->eo);
3326                 free(td->eo);
3327                 td->eo = NULL;
3328         }
3329 }
3330
3331 struct fio_option *fio_option_find(const char *name)
3332 {
3333         return find_option(fio_options, name);
3334 }
3335