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_data *td, 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         td->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 == td->o.bssplit_nr[ddir]) {
  88                         td->o.bssplit_nr[ddir] <<= 1;
  89                         bssplit = realloc(bssplit, td->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, td)) {
 106                         log_err("fio: bssplit conversion failed\n");
 107                         free(td->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         td->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 < td->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 < td->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         td->o.min_bs[ddir] = min_bs;
 155         td->o.max_bs[ddir] = max_bs;
 156
 157         /*
 158          * now sort based on percentages, for ease of lookup
 159          */
 160         qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
 161         td->o.bssplit[ddir] = bssplit;
 162         return 0;
 163
 164 }
 165
 166 static int str_bssplit_cb(void *data, const char *input)
 167 {
 168         struct thread_data *td = data;
 169         char *str, *p, *odir;
 170         int ret = 0;
 171
 172         p = str = strdup(input);
 173
 174         strip_blank_front(&str);
 175         strip_blank_end(str);
 176
 177         odir = strchr(str, ',');
 178         if (odir) {
 179                 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
 180                 if (!ret) {
 181                         *odir = '\0';
 182                         ret = bssplit_ddir(td, DDIR_READ, str);
 183                 }
 184         } else {
 185                 char *op;
 186
 187                 op = strdup(str);
 188
 189                 ret = bssplit_ddir(td, DDIR_READ, str);
 190                 if (!ret)
 191                         ret = bssplit_ddir(td, DDIR_WRITE, op);
 192
 193                 free(op);
 194         }
 195
 196         free(p);
 197         return ret;
 198 }
 199
 200 static int str_rw_cb(void *data, const char *str)
 201 {
 202         struct thread_data *td = data;
 203         char *nr = get_opt_postfix(str);
 204
 205         td->o.ddir_seq_nr = 1;
 206         td->o.ddir_seq_add = 0;
 207
 208         if (!nr)
 209                 return 0;
 210
 211         if (td_random(td))
 212                 td->o.ddir_seq_nr = atoi(nr);
 213         else {
 214                 long long val;
 215
 216                 if (str_to_decimal(nr, &val, 1, td)) {
 217                         log_err("fio: rw postfix parsing failed\n");
 218                         free(nr);
 219                         return 1;
 220                 }
 221
 222                 td->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
 233         if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
 234                 td->mmapfile = get_opt_postfix(mem);
 235                 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
 236                         log_err("fio: mmaphuge:/path/to/file\n");
 237                         return 1;
 238                 }
 239         }
 240
 241         return 0;
 242 }
 243
 244 static int str_verify_cb(void *data, const char *mem)
 245 {
 246         struct thread_data *td = data;
 247
 248         if (td->o.verify != VERIFY_CRC32C_INTEL)
 249                 return 0;
 250
 251         if (!crc32c_intel_works()) {
 252                 log_info("fio: System does not support hw accelerated crc32c. Falling back to sw crc32c.\n");
 253                 td->o.verify = VERIFY_CRC32C;
 254         }
 255
 256         return 0;
 257 }
 258
 259 static int fio_clock_source_cb(void *data, const char *str)
 260 {
 261         struct thread_data *td = data;
 262
 263         fio_clock_source = td->o.clocksource;
 264         fio_time_init();
 265         return 0;
 266 }
 267
 268 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
 269 {
 270         mlock_size = *val;
 271         return 0;
 272 }
 273
 274 static int str_rwmix_read_cb(void *data, unsigned long long *val)
 275 {
 276         struct thread_data *td = data;
 277
 278         td->o.rwmix[DDIR_READ] = *val;
 279         td->o.rwmix[DDIR_WRITE] = 100 - *val;
 280         return 0;
 281 }
 282
 283 static int str_rwmix_write_cb(void *data, unsigned long long *val)
 284 {
 285         struct thread_data *td = data;
 286
 287         td->o.rwmix[DDIR_WRITE] = *val;
 288         td->o.rwmix[DDIR_READ] = 100 - *val;
 289         return 0;
 290 }
 291
 292 #ifdef FIO_HAVE_IOPRIO
 293 static int str_prioclass_cb(void *data, unsigned long long *val)
 294 {
 295         struct thread_data *td = data;
 296         unsigned short mask;
 297
 298         /*
 299          * mask off old class bits, str_prio_cb() may have set a default class
 300          */
 301         mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
 302         td->ioprio &= mask;
 303
 304         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
 305         td->ioprio_set = 1;
 306         return 0;
 307 }
 308
 309 static int str_prio_cb(void *data, unsigned long long *val)
 310 {
 311         struct thread_data *td = data;
 312
 313         td->ioprio |= *val;
 314
 315         /*
 316          * If no class is set, assume BE
 317          */
 318         if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
 319                 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
 320
 321         td->ioprio_set = 1;
 322         return 0;
 323 }
 324 #endif
 325
 326 static int str_exitall_cb(void)
 327 {
 328         exitall_on_terminate = 1;
 329         return 0;
 330 }
 331
 332 #ifdef FIO_HAVE_CPU_AFFINITY
 333 static int str_cpumask_cb(void *data, unsigned long long *val)
 334 {
 335         struct thread_data *td = data;
 336         unsigned int i;
 337         long max_cpu;
 338         int ret;
 339
 340         ret = fio_cpuset_init(&td->o.cpumask);
 341         if (ret < 0) {
 342                 log_err("fio: cpuset_init failed\n");
 343                 td_verror(td, ret, "fio_cpuset_init");
 344                 return 1;
 345         }
 346
 347         max_cpu = cpus_online();
 348
 349         for (i = 0; i < sizeof(int) * 8; i++) {
 350                 if ((1 << i) & *val) {
 351                         if (i > max_cpu) {
 352                                 log_err("fio: CPU %d too large (max=%ld)\n", i,
 353                                                                 max_cpu);
 354                                 return 1;
 355                         }
 356                         dprint(FD_PARSE, "set cpu allowed %d\n", i);
 357                         fio_cpu_set(&td->o.cpumask, i);
 358                 }
 359         }
 360
 361         td->o.cpumask_set = 1;
 362         return 0;
 363 }
 364
 365 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
 366                             const char *input)
 367 {
 368         char *cpu, *str, *p;
 369         long max_cpu;
 370         int ret = 0;
 371
 372         ret = fio_cpuset_init(mask);
 373         if (ret < 0) {
 374                 log_err("fio: cpuset_init failed\n");
 375                 td_verror(td, ret, "fio_cpuset_init");
 376                 return 1;
 377         }
 378
 379         p = str = strdup(input);
 380
 381         strip_blank_front(&str);
 382         strip_blank_end(str);
 383
 384         max_cpu = cpus_online();
 385
 386         while ((cpu = strsep(&str, ",")) != NULL) {
 387                 char *str2, *cpu2;
 388                 int icpu, icpu2;
 389
 390                 if (!strlen(cpu))
 391                         break;
 392
 393                 str2 = cpu;
 394                 icpu2 = -1;
 395                 while ((cpu2 = strsep(&str2, "-")) != NULL) {
 396                         if (!strlen(cpu2))
 397                                 break;
 398
 399                         icpu2 = atoi(cpu2);
 400                 }
 401
 402                 icpu = atoi(cpu);
 403                 if (icpu2 == -1)
 404                         icpu2 = icpu;
 405                 while (icpu <= icpu2) {
 406                         if (icpu >= FIO_MAX_CPUS) {
 407                                 log_err("fio: your OS only supports up to"
 408                                         " %d CPUs\n", (int) FIO_MAX_CPUS);
 409                                 ret = 1;
 410                                 break;
 411                         }
 412                         if (icpu > max_cpu) {
 413                                 log_err("fio: CPU %d too large (max=%ld)\n",
 414                                                         icpu, max_cpu);
 415                                 ret = 1;
 416                                 break;
 417                         }
 418
 419                         dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
 420                         fio_cpu_set(mask, icpu);
 421                         icpu++;
 422                 }
 423                 if (ret)
 424                         break;
 425         }
 426
 427         free(p);
 428         if (!ret)
 429                 td->o.cpumask_set = 1;
 430         return ret;
 431 }
 432
 433 static int str_cpus_allowed_cb(void *data, const char *input)
 434 {
 435         struct thread_data *td = data;
 436         int ret;
 437
 438         ret = set_cpus_allowed(td, &td->o.cpumask, input);
 439         if (!ret)
 440                 td->o.cpumask_set = 1;
 441
 442         return ret;
 443 }
 444
 445 static int str_verify_cpus_allowed_cb(void *data, const char *input)
 446 {
 447         struct thread_data *td = data;
 448         int ret;
 449
 450         ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
 451         if (!ret)
 452                 td->o.verify_cpumask_set = 1;
 453
 454         return ret;
 455 }
 456 #endif
 457
 458 #ifdef FIO_HAVE_TRIM
 459 static int str_verify_trim_cb(void *data, unsigned long long *val)
 460 {
 461         struct thread_data *td = data;
 462
 463         td->o.trim_percentage = *val;
 464         return 0;
 465 }
 466 #endif
 467
 468 static int str_fst_cb(void *data, const char *str)
 469 {
 470         struct thread_data *td = data;
 471         char *nr = get_opt_postfix(str);
 472
 473         td->file_service_nr = 1;
 474         if (nr) {
 475                 td->file_service_nr = atoi(nr);
 476                 free(nr);
 477         }
 478
 479         return 0;
 480 }
 481
 482 #ifdef FIO_HAVE_SYNC_FILE_RANGE
 483 static int str_sfr_cb(void *data, const char *str)
 484 {
 485         struct thread_data *td = data;
 486         char *nr = get_opt_postfix(str);
 487
 488         td->sync_file_range_nr = 1;
 489         if (nr) {
 490                 td->sync_file_range_nr = atoi(nr);
 491                 free(nr);
 492         }
 493
 494         return 0;
 495 }
 496 #endif
 497
 498 static int check_dir(struct thread_data *td, char *fname)
 499 {
 500 #if 0
 501         char file[PATH_MAX], *dir;
 502         int elen = 0;
 503
 504         if (td->o.directory) {
 505                 strcpy(file, td->o.directory);
 506                 strcat(file, "/");
 507                 elen = strlen(file);
 508         }
 509
 510         sprintf(file + elen, "%s", fname);
 511         dir = dirname(file);
 512
 513         {
 514         struct stat sb;
 515         /*
 516          * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
 517          * yet, so we can't do this check right here...
 518          */
 519         if (lstat(dir, &sb) < 0) {
 520                 int ret = errno;
 521
 522                 log_err("fio: %s is not a directory\n", dir);
 523                 td_verror(td, ret, "lstat");
 524                 return 1;
 525         }
 526
 527         if (!S_ISDIR(sb.st_mode)) {
 528                 log_err("fio: %s is not a directory\n", dir);
 529                 return 1;
 530         }
 531         }
 532 #endif
 533
 534         return 0;
 535 }
 536
 537 /*
 538  * Return next file in the string. Files are separated with ':'. If the ':'
 539  * is escaped with a '\', then that ':' is part of the filename and does not
 540  * indicate a new file.
 541  */
 542 static char *get_next_file_name(char **ptr)
 543 {
 544         char *str = *ptr;
 545         char *p, *start;
 546
 547         if (!str || !strlen(str))
 548                 return NULL;
 549
 550         start = str;
 551         do {
 552                 /*
 553                  * No colon, we are done
 554                  */
 555                 p = strchr(str, ':');
 556                 if (!p) {
 557                         *ptr = NULL;
 558                         break;
 559                 }
 560
 561                 /*
 562                  * We got a colon, but it's the first character. Skip and
 563                  * continue
 564                  */
 565                 if (p == start) {
 566                         str = ++start;
 567                         continue;
 568                 }
 569
 570                 if (*(p - 1) != '\\') {
 571                         *p = '\0';
 572                         *ptr = p + 1;
 573                         break;
 574                 }
 575
 576                 memmove(p - 1, p, strlen(p) + 1);
 577                 str = p;
 578         } while (1);
 579
 580         return start;
 581 }
 582
 583 static int str_filename_cb(void *data, const char *input)
 584 {
 585         struct thread_data *td = data;
 586         char *fname, *str, *p;
 587
 588         p = str = strdup(input);
 589
 590         strip_blank_front(&str);
 591         strip_blank_end(str);
 592
 593         if (!td->files_index)
 594                 td->o.nr_files = 0;
 595
 596         while ((fname = get_next_file_name(&str)) != NULL) {
 597                 if (!strlen(fname))
 598                         break;
 599                 if (check_dir(td, fname)) {
 600                         free(p);
 601                         return 1;
 602                 }
 603                 add_file(td, fname);
 604                 td->o.nr_files++;
 605         }
 606
 607         free(p);
 608         return 0;
 609 }
 610
 611 static int str_directory_cb(void *data, const char fio_unused *str)
 612 {
 613         struct thread_data *td = data;
 614         struct stat sb;
 615
 616         if (lstat(td->o.directory, &sb) < 0) {
 617                 int ret = errno;
 618
 619                 log_err("fio: %s is not a directory\n", td->o.directory);
 620                 td_verror(td, ret, "lstat");
 621                 return 1;
 622         }
 623         if (!S_ISDIR(sb.st_mode)) {
 624                 log_err("fio: %s is not a directory\n", td->o.directory);
 625                 return 1;
 626         }
 627
 628         return 0;
 629 }
 630
 631 static int str_opendir_cb(void *data, const char fio_unused *str)
 632 {
 633         struct thread_data *td = data;
 634
 635         if (!td->files_index)
 636                 td->o.nr_files = 0;
 637
 638         return add_dir_files(td, td->o.opendir);
 639 }
 640
 641 static int str_verify_offset_cb(void *data, unsigned long long *off)
 642 {
 643         struct thread_data *td = data;
 644
 645         if (*off && *off < sizeof(struct verify_header)) {
 646                 log_err("fio: verify_offset too small\n");
 647                 return 1;
 648         }
 649
 650         td->o.verify_offset = *off;
 651         return 0;
 652 }
 653
 654 static int str_verify_pattern_cb(void *data, const char *input)
 655 {
 656         struct thread_data *td = data;
 657         long off;
 658         int i = 0, j = 0, len, k, base = 10;
 659         char* loc1, * loc2;
 660
 661         loc1 = strstr(input, "0x");
 662         loc2 = strstr(input, "0X");
 663         if (loc1 || loc2)
 664                 base = 16;
 665         off = strtol(input, NULL, base);
 666         if (off != LONG_MAX || errno != ERANGE) {
 667                 while (off) {
 668                         td->o.verify_pattern[i] = off & 0xff;
 669                         off >>= 8;
 670                         i++;
 671                 }
 672         } else {
 673                 len = strlen(input);
 674                 k = len - 1;
 675                 if (base == 16) {
 676                         if (loc1)
 677                                 j = loc1 - input + 2;
 678                         else
 679                                 j = loc2 - input + 2;
 680                 } else
 681                         return 1;
 682                 if (len - j < MAX_PATTERN_SIZE * 2) {
 683                         while (k >= j) {
 684                                 off = converthexchartoint(input[k--]);
 685                                 if (k >= j)
 686                                         off += (converthexchartoint(input[k--])
 687                                                 * 16);
 688                                 td->o.verify_pattern[i++] = (char) off;
 689                         }
 690                 }
 691         }
 692         td->o.verify_pattern_bytes = i;
 693         /*
 694          * VERIFY_META could already be set
 695          */
 696         if (td->o.verify == VERIFY_NONE)
 697                 td->o.verify = VERIFY_PATTERN;
 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  * Map of job/command line options
 831  */
 832 static struct fio_option options[FIO_MAX_OPTS] = {
 833         {
 834                 .name   = "description",
 835                 .type   = FIO_OPT_STR_STORE,
 836                 .off1   = td_var_offset(description),
 837                 .help   = "Text job description",
 838         },
 839         {
 840                 .name   = "name",
 841                 .type   = FIO_OPT_STR_STORE,
 842                 .off1   = td_var_offset(name),
 843                 .help   = "Name of this job",
 844         },
 845         {
 846                 .name   = "directory",
 847                 .type   = FIO_OPT_STR_STORE,
 848                 .off1   = td_var_offset(directory),
 849                 .cb     = str_directory_cb,
 850                 .help   = "Directory to store files in",
 851         },
 852         {
 853                 .name   = "filename",
 854                 .type   = FIO_OPT_STR_STORE,
 855                 .off1   = td_var_offset(filename),
 856                 .cb     = str_filename_cb,
 857                 .prio   = -1, /* must come after "directory" */
 858                 .help   = "File(s) to use for the workload",
 859         },
 860         {
 861                 .name   = "kb_base",
 862                 .type   = FIO_OPT_INT,
 863                 .off1   = td_var_offset(kb_base),
 864                 .verify = kb_base_verify,
 865                 .prio   = 1,
 866                 .def    = "1024",
 867                 .help   = "How many bytes per KB for reporting (1000 or 1024)",
 868         },
 869         {
 870                 .name   = "lockfile",
 871                 .type   = FIO_OPT_STR,
 872                 .cb     = str_lockfile_cb,
 873                 .off1   = td_var_offset(file_lock_mode),
 874                 .help   = "Lock file when doing IO to it",
 875                 .parent = "filename",
 876                 .def    = "none",
 877                 .posval = {
 878                           { .ival = "none",
 879                             .oval = FILE_LOCK_NONE,
 880                             .help = "No file locking",
 881                           },
 882                           { .ival = "exclusive",
 883                             .oval = FILE_LOCK_EXCLUSIVE,
 884                             .help = "Exclusive file lock",
 885                           },
 886                           {
 887                             .ival = "readwrite",
 888                             .oval = FILE_LOCK_READWRITE,
 889                             .help = "Read vs write lock",
 890                           },
 891                 },
 892         },
 893         {
 894                 .name   = "opendir",
 895                 .type   = FIO_OPT_STR_STORE,
 896                 .off1   = td_var_offset(opendir),
 897                 .cb     = str_opendir_cb,
 898                 .help   = "Recursively add files from this directory and down",
 899         },
 900         {
 901                 .name   = "rw",
 902                 .alias  = "readwrite",
 903                 .type   = FIO_OPT_STR,
 904                 .cb     = str_rw_cb,
 905                 .off1   = td_var_offset(td_ddir),
 906                 .help   = "IO direction",
 907                 .def    = "read",
 908                 .verify = rw_verify,
 909                 .posval = {
 910                           { .ival = "read",
 911                             .oval = TD_DDIR_READ,
 912                             .help = "Sequential read",
 913                           },
 914                           { .ival = "write",
 915                             .oval = TD_DDIR_WRITE,
 916                             .help = "Sequential write",
 917                           },
 918                           { .ival = "randread",
 919                             .oval = TD_DDIR_RANDREAD,
 920                             .help = "Random read",
 921                           },
 922                           { .ival = "randwrite",
 923                             .oval = TD_DDIR_RANDWRITE,
 924                             .help = "Random write",
 925                           },
 926                           { .ival = "rw",
 927                             .oval = TD_DDIR_RW,
 928                             .help = "Sequential read and write mix",
 929                           },
 930                           { .ival = "randrw",
 931                             .oval = TD_DDIR_RANDRW,
 932                             .help = "Random read and write mix"
 933                           },
 934                 },
 935         },
 936         {
 937                 .name   = "rw_sequencer",
 938                 .type   = FIO_OPT_STR,
 939                 .off1   = td_var_offset(rw_seq),
 940                 .help   = "IO offset generator modifier",
 941                 .def    = "sequential",
 942                 .posval = {
 943                           { .ival = "sequential",
 944                             .oval = RW_SEQ_SEQ,
 945                             .help = "Generate sequential offsets",
 946                           },
 947                           { .ival = "identical",
 948                             .oval = RW_SEQ_IDENT,
 949                             .help = "Generate identical offsets",
 950                           },
 951                 },
 952         },
 953
 954         {
 955                 .name   = "ioengine",
 956                 .type   = FIO_OPT_STR_STORE,
 957                 .off1   = td_var_offset(ioengine),
 958                 .help   = "IO engine to use",
 959                 .def    = FIO_PREFERRED_ENGINE,
 960                 .posval = {
 961                           { .ival = "sync",
 962                             .help = "Use read/write",
 963                           },
 964                           { .ival = "psync",
 965                             .help = "Use pread/pwrite",
 966                           },
 967                           { .ival = "vsync",
 968                             .help = "Use readv/writev",
 969                           },
 970 #ifdef FIO_HAVE_LIBAIO
 971                           { .ival = "libaio",
 972                             .help = "Linux native asynchronous IO",
 973                           },
 974 #endif
 975 #ifdef FIO_HAVE_POSIXAIO
 976                           { .ival = "posixaio",
 977                             .help = "POSIX asynchronous IO",
 978                           },
 979 #endif
 980 #ifdef FIO_HAVE_SOLARISAIO
 981                           { .ival = "solarisaio",
 982                             .help = "Solaris native asynchronous IO",
 983                           },
 984 #endif
 985 #ifdef FIO_HAVE_WINDOWSAIO
 986                           { .ival = "windowsaio",
 987                             .help = "Windows native asynchronous IO"
 988                           },
 989 #endif
 990                           { .ival = "mmap",
 991                             .help = "Memory mapped IO"
 992                           },
 993 #ifdef FIO_HAVE_SPLICE
 994                           { .ival = "splice",
 995                             .help = "splice/vmsplice based IO",
 996                           },
 997                           { .ival = "netsplice",
 998                             .help = "splice/vmsplice to/from the network",
 999                           },
1000 #endif
1001 #ifdef FIO_HAVE_SGIO
1002                           { .ival = "sg",
1003                             .help = "SCSI generic v3 IO",
1004                           },
1005 #endif
1006                           { .ival = "null",
1007                             .help = "Testing engine (no data transfer)",
1008                           },
1009                           { .ival = "net",
1010                             .help = "Network IO",
1011                           },
1012 #ifdef FIO_HAVE_SYSLET
1013                           { .ival = "syslet-rw",
1014                             .help = "syslet enabled async pread/pwrite IO",
1015                           },
1016 #endif
1017                           { .ival = "cpuio",
1018                             .help = "CPU cycle burner engine",
1019                           },
1020 #ifdef FIO_HAVE_GUASI
1021                           { .ival = "guasi",
1022                             .help = "GUASI IO engine",
1023                           },
1024 #endif
1025 #ifdef FIO_HAVE_BINJECT
1026                           { .ival = "binject",
1027                             .help = "binject direct inject block engine",
1028                           },
1029 #endif
1030 #ifdef FIO_HAVE_RDMA
1031                           { .ival = "rdma",
1032                             .help = "RDMA IO engine",
1033                           },
1034 #endif
1035                           { .ival = "external",
1036                             .help = "Load external engine (append name)",
1037                           },
1038                 },
1039         },
1040         {
1041                 .name   = "iodepth",
1042                 .type   = FIO_OPT_INT,
1043                 .off1   = td_var_offset(iodepth),
1044                 .help   = "Number of IO buffers to keep in flight",
1045                 .minval = 1,
1046                 .def    = "1",
1047         },
1048         {
1049                 .name   = "iodepth_batch",
1050                 .alias  = "iodepth_batch_submit",
1051                 .type   = FIO_OPT_INT,
1052                 .off1   = td_var_offset(iodepth_batch),
1053                 .help   = "Number of IO buffers to submit in one go",
1054                 .parent = "iodepth",
1055                 .minval = 1,
1056                 .def    = "1",
1057         },
1058         {
1059                 .name   = "iodepth_batch_complete",
1060                 .type   = FIO_OPT_INT,
1061                 .off1   = td_var_offset(iodepth_batch_complete),
1062                 .help   = "Number of IO buffers to retrieve in one go",
1063                 .parent = "iodepth",
1064                 .minval = 0,
1065                 .def    = "1",
1066         },
1067         {
1068                 .name   = "iodepth_low",
1069                 .type   = FIO_OPT_INT,
1070                 .off1   = td_var_offset(iodepth_low),
1071                 .help   = "Low water mark for queuing depth",
1072                 .parent = "iodepth",
1073         },
1074         {
1075                 .name   = "size",
1076                 .type   = FIO_OPT_STR_VAL,
1077                 .cb     = str_size_cb,
1078                 .help   = "Total size of device or files",
1079         },
1080         {
1081                 .name   = "fill_device",
1082                 .alias  = "fill_fs",
1083                 .type   = FIO_OPT_BOOL,
1084                 .off1   = td_var_offset(fill_device),
1085                 .help   = "Write until an ENOSPC error occurs",
1086                 .def    = "0",
1087         },
1088         {
1089                 .name   = "filesize",
1090                 .type   = FIO_OPT_STR_VAL,
1091                 .off1   = td_var_offset(file_size_low),
1092                 .off2   = td_var_offset(file_size_high),
1093                 .minval = 1,
1094                 .help   = "Size of individual files",
1095         },
1096         {
1097                 .name   = "offset",
1098                 .alias  = "fileoffset",
1099                 .type   = FIO_OPT_STR_VAL,
1100                 .off1   = td_var_offset(start_offset),
1101                 .help   = "Start IO from this offset",
1102                 .def    = "0",
1103         },
1104         {
1105                 .name   = "bs",
1106                 .alias  = "blocksize",
1107                 .type   = FIO_OPT_INT,
1108                 .off1   = td_var_offset(bs[DDIR_READ]),
1109                 .off2   = td_var_offset(bs[DDIR_WRITE]),
1110                 .minval = 1,
1111                 .help   = "Block size unit",
1112                 .def    = "4k",
1113                 .parent = "rw",
1114         },
1115         {
1116                 .name   = "ba",
1117                 .alias  = "blockalign",
1118                 .type   = FIO_OPT_INT,
1119                 .off1   = td_var_offset(ba[DDIR_READ]),
1120                 .off2   = td_var_offset(ba[DDIR_WRITE]),
1121                 .minval = 1,
1122                 .help   = "IO block offset alignment",
1123                 .parent = "rw",
1124         },
1125         {
1126                 .name   = "bsrange",
1127                 .alias  = "blocksize_range",
1128                 .type   = FIO_OPT_RANGE,
1129                 .off1   = td_var_offset(min_bs[DDIR_READ]),
1130                 .off2   = td_var_offset(max_bs[DDIR_READ]),
1131                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
1132                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
1133                 .minval = 1,
1134                 .help   = "Set block size range (in more detail than bs)",
1135                 .parent = "rw",
1136         },
1137         {
1138                 .name   = "bssplit",
1139                 .type   = FIO_OPT_STR,
1140                 .cb     = str_bssplit_cb,
1141                 .help   = "Set a specific mix of block sizes",
1142                 .parent = "rw",
1143         },
1144         {
1145                 .name   = "bs_unaligned",
1146                 .alias  = "blocksize_unaligned",
1147                 .type   = FIO_OPT_STR_SET,
1148                 .off1   = td_var_offset(bs_unaligned),
1149                 .help   = "Don't sector align IO buffer sizes",
1150                 .parent = "rw",
1151         },
1152         {
1153                 .name   = "randrepeat",
1154                 .type   = FIO_OPT_BOOL,
1155                 .off1   = td_var_offset(rand_repeatable),
1156                 .help   = "Use repeatable random IO pattern",
1157                 .def    = "1",
1158                 .parent = "rw",
1159         },
1160         {
1161                 .name   = "use_os_rand",
1162                 .type   = FIO_OPT_BOOL,
1163                 .off1   = td_var_offset(use_os_rand),
1164                 .help   = "Set to use OS random generator",
1165                 .def    = "0",
1166                 .parent = "rw",
1167         },
1168         {
1169                 .name   = "norandommap",
1170                 .type   = FIO_OPT_STR_SET,
1171                 .off1   = td_var_offset(norandommap),
1172                 .help   = "Accept potential duplicate random blocks",
1173                 .parent = "rw",
1174         },
1175         {
1176                 .name   = "softrandommap",
1177                 .type   = FIO_OPT_BOOL,
1178                 .off1   = td_var_offset(softrandommap),
1179                 .help   = "Set norandommap if randommap allocation fails",
1180                 .parent = "norandommap",
1181                 .def    = "0",
1182         },
1183         {
1184                 .name   = "nrfiles",
1185                 .alias  = "nr_files",
1186                 .type   = FIO_OPT_INT,
1187                 .off1   = td_var_offset(nr_files),
1188                 .help   = "Split job workload between this number of files",
1189                 .def    = "1",
1190         },
1191         {
1192                 .name   = "openfiles",
1193                 .type   = FIO_OPT_INT,
1194                 .off1   = td_var_offset(open_files),
1195                 .help   = "Number of files to keep open at the same time",
1196         },
1197         {
1198                 .name   = "file_service_type",
1199                 .type   = FIO_OPT_STR,
1200                 .cb     = str_fst_cb,
1201                 .off1   = td_var_offset(file_service_type),
1202                 .help   = "How to select which file to service next",
1203                 .def    = "roundrobin",
1204                 .posval = {
1205                           { .ival = "random",
1206                             .oval = FIO_FSERVICE_RANDOM,
1207                             .help = "Choose a file at random",
1208                           },
1209                           { .ival = "roundrobin",
1210                             .oval = FIO_FSERVICE_RR,
1211                             .help = "Round robin select files",
1212                           },
1213                           { .ival = "sequential",
1214                             .oval = FIO_FSERVICE_SEQ,
1215                             .help = "Finish one file before moving to the next",
1216                           },
1217                 },
1218                 .parent = "nrfiles",
1219         },
1220 #ifdef FIO_HAVE_FALLOCATE
1221         {
1222                 .name   = "fallocate",
1223                 .type   = FIO_OPT_STR,
1224                 .off1   = td_var_offset(fallocate_mode),
1225                 .help   = "Whether pre-allocation is performed when laying out files",
1226                 .def    = "posix",
1227                 .posval = {
1228                           { .ival = "none",
1229                             .oval = FIO_FALLOCATE_NONE,
1230                             .help = "Do not pre-allocate space",
1231                           },
1232                           { .ival = "posix",
1233                             .oval = FIO_FALLOCATE_POSIX,
1234                             .help = "Use posix_fallocate()",
1235                           },
1236 #ifdef FIO_HAVE_LINUX_FALLOCATE
1237                           { .ival = "keep",
1238                             .oval = FIO_FALLOCATE_KEEP_SIZE,
1239                             .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1240                           },
1241 #endif
1242                           /* Compatibility with former boolean values */
1243                           { .ival = "0",
1244                             .oval = FIO_FALLOCATE_NONE,
1245                             .help = "Alias for 'none'",
1246                           },
1247                           { .ival = "1",
1248                             .oval = FIO_FALLOCATE_POSIX,
1249                             .help = "Alias for 'posix'",
1250                           },
1251                 },
1252         },
1253 #endif  /* FIO_HAVE_FALLOCATE */
1254         {
1255                 .name   = "fadvise_hint",
1256                 .type   = FIO_OPT_BOOL,
1257                 .off1   = td_var_offset(fadvise_hint),
1258                 .help   = "Use fadvise() to advise the kernel on IO pattern",
1259                 .def    = "1",
1260         },
1261         {
1262                 .name   = "fsync",
1263                 .type   = FIO_OPT_INT,
1264                 .off1   = td_var_offset(fsync_blocks),
1265                 .help   = "Issue fsync for writes every given number of blocks",
1266                 .def    = "0",
1267         },
1268         {
1269                 .name   = "fdatasync",
1270                 .type   = FIO_OPT_INT,
1271                 .off1   = td_var_offset(fdatasync_blocks),
1272                 .help   = "Issue fdatasync for writes every given number of blocks",
1273                 .def    = "0",
1274         },
1275         {
1276                 .name   = "write_barrier",
1277                 .type   = FIO_OPT_INT,
1278                 .off1   = td_var_offset(barrier_blocks),
1279                 .help   = "Make every Nth write a barrier write",
1280                 .def    = "0",
1281         },
1282 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1283         {
1284                 .name   = "sync_file_range",
1285                 .posval = {
1286                           { .ival = "wait_before",
1287                             .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1288                             .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1289                             .or   = 1,
1290                           },
1291                           { .ival = "write",
1292                             .oval = SYNC_FILE_RANGE_WRITE,
1293                             .help = "SYNC_FILE_RANGE_WRITE",
1294                             .or   = 1,
1295                           },
1296                           {
1297                             .ival = "wait_after",
1298                             .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1299                             .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1300                             .or   = 1,
1301                           },
1302                 },
1303                 .type   = FIO_OPT_STR_MULTI,
1304                 .cb     = str_sfr_cb,
1305                 .off1   = td_var_offset(sync_file_range),
1306                 .help   = "Use sync_file_range()",
1307         },
1308 #endif
1309         {
1310                 .name   = "direct",
1311                 .type   = FIO_OPT_BOOL,
1312                 .off1   = td_var_offset(odirect),
1313                 .help   = "Use O_DIRECT IO (negates buffered)",
1314                 .def    = "0",
1315         },
1316         {
1317                 .name   = "buffered",
1318                 .type   = FIO_OPT_BOOL,
1319                 .off1   = td_var_offset(odirect),
1320                 .neg    = 1,
1321                 .help   = "Use buffered IO (negates direct)",
1322                 .def    = "1",
1323         },
1324         {
1325                 .name   = "overwrite",
1326                 .type   = FIO_OPT_BOOL,
1327                 .off1   = td_var_offset(overwrite),
1328                 .help   = "When writing, set whether to overwrite current data",
1329                 .def    = "0",
1330         },
1331         {
1332                 .name   = "loops",
1333                 .type   = FIO_OPT_INT,
1334                 .off1   = td_var_offset(loops),
1335                 .help   = "Number of times to run the job",
1336                 .def    = "1",
1337         },
1338         {
1339                 .name   = "numjobs",
1340                 .type   = FIO_OPT_INT,
1341                 .off1   = td_var_offset(numjobs),
1342                 .help   = "Duplicate this job this many times",
1343                 .def    = "1",
1344         },
1345         {
1346                 .name   = "startdelay",
1347                 .type   = FIO_OPT_STR_VAL_TIME,
1348                 .off1   = td_var_offset(start_delay),
1349                 .help   = "Only start job when this period has passed",
1350                 .def    = "0",
1351         },
1352         {
1353                 .name   = "runtime",
1354                 .alias  = "timeout",
1355                 .type   = FIO_OPT_STR_VAL_TIME,
1356                 .off1   = td_var_offset(timeout),
1357                 .help   = "Stop workload when this amount of time has passed",
1358                 .def    = "0",
1359         },
1360         {
1361                 .name   = "time_based",
1362                 .type   = FIO_OPT_STR_SET,
1363                 .off1   = td_var_offset(time_based),
1364                 .help   = "Keep running until runtime/timeout is met",
1365         },
1366         {
1367                 .name   = "ramp_time",
1368                 .type   = FIO_OPT_STR_VAL_TIME,
1369                 .off1   = td_var_offset(ramp_time),
1370                 .help   = "Ramp up time before measuring performance",
1371         },
1372         {
1373                 .name   = "clocksource",
1374                 .type   = FIO_OPT_STR,
1375                 .cb     = fio_clock_source_cb,
1376                 .off1   = td_var_offset(clocksource),
1377                 .help   = "What type of timing source to use",
1378                 .posval = {
1379                           { .ival = "gettimeofday",
1380                             .oval = CS_GTOD,
1381                             .help = "Use gettimeofday(2) for timing",
1382                           },
1383                           { .ival = "clock_gettime",
1384                             .oval = CS_CGETTIME,
1385                             .help = "Use clock_gettime(2) for timing",
1386                           },
1387 #ifdef ARCH_HAVE_CPU_CLOCK
1388                           { .ival = "cpu",
1389                             .oval = CS_CPUCLOCK,
1390                             .help = "Use CPU private clock",
1391                           },
1392 #endif
1393                 },
1394         },
1395         {
1396                 .name   = "mem",
1397                 .alias  = "iomem",
1398                 .type   = FIO_OPT_STR,
1399                 .cb     = str_mem_cb,
1400                 .off1   = td_var_offset(mem_type),
1401                 .help   = "Backing type for IO buffers",
1402                 .def    = "malloc",
1403                 .posval = {
1404                           { .ival = "malloc",
1405                             .oval = MEM_MALLOC,
1406                             .help = "Use malloc(3) for IO buffers",
1407                           },
1408                           { .ival = "shm",
1409                             .oval = MEM_SHM,
1410                             .help = "Use shared memory segments for IO buffers",
1411                           },
1412 #ifdef FIO_HAVE_HUGETLB
1413                           { .ival = "shmhuge",
1414                             .oval = MEM_SHMHUGE,
1415                             .help = "Like shm, but use huge pages",
1416                           },
1417 #endif
1418                           { .ival = "mmap",
1419                             .oval = MEM_MMAP,
1420                             .help = "Use mmap(2) (file or anon) for IO buffers",
1421                           },
1422 #ifdef FIO_HAVE_HUGETLB
1423                           { .ival = "mmaphuge",
1424                             .oval = MEM_MMAPHUGE,
1425                             .help = "Like mmap, but use huge pages",
1426                           },
1427 #endif
1428                   },
1429         },
1430         {
1431                 .name   = "iomem_align",
1432                 .alias  = "mem_align",
1433                 .type   = FIO_OPT_INT,
1434                 .off1   = td_var_offset(mem_align),
1435                 .minval = 0,
1436                 .help   = "IO memory buffer offset alignment",
1437                 .def    = "0",
1438                 .parent = "iomem",
1439         },
1440         {
1441                 .name   = "verify",
1442                 .type   = FIO_OPT_STR,
1443                 .off1   = td_var_offset(verify),
1444                 .help   = "Verify data written",
1445                 .cb     = str_verify_cb,
1446                 .def    = "0",
1447                 .posval = {
1448                           { .ival = "0",
1449                             .oval = VERIFY_NONE,
1450                             .help = "Don't do IO verification",
1451                           },
1452                           { .ival = "md5",
1453                             .oval = VERIFY_MD5,
1454                             .help = "Use md5 checksums for verification",
1455                           },
1456                           { .ival = "crc64",
1457                             .oval = VERIFY_CRC64,
1458                             .help = "Use crc64 checksums for verification",
1459                           },
1460                           { .ival = "crc32",
1461                             .oval = VERIFY_CRC32,
1462                             .help = "Use crc32 checksums for verification",
1463                           },
1464                           { .ival = "crc32c-intel",
1465                             .oval = VERIFY_CRC32C_INTEL,
1466                             .help = "Use hw crc32c checksums for verification",
1467                           },
1468                           { .ival = "crc32c",
1469                             .oval = VERIFY_CRC32C,
1470                             .help = "Use crc32c checksums for verification",
1471                           },
1472                           { .ival = "crc16",
1473                             .oval = VERIFY_CRC16,
1474                             .help = "Use crc16 checksums for verification",
1475                           },
1476                           { .ival = "crc7",
1477                             .oval = VERIFY_CRC7,
1478                             .help = "Use crc7 checksums for verification",
1479                           },
1480                           { .ival = "sha1",
1481                             .oval = VERIFY_SHA1,
1482                             .help = "Use sha1 checksums for verification",
1483                           },
1484                           { .ival = "sha256",
1485                             .oval = VERIFY_SHA256,
1486                             .help = "Use sha256 checksums for verification",
1487                           },
1488                           { .ival = "sha512",
1489                             .oval = VERIFY_SHA512,
1490                             .help = "Use sha512 checksums for verification",
1491                           },
1492                           { .ival = "meta",
1493                             .oval = VERIFY_META,
1494                             .help = "Use io information",
1495                           },
1496                           {
1497                             .ival = "null",
1498                             .oval = VERIFY_NULL,
1499                             .help = "Pretend to verify",
1500                           },
1501                 },
1502         },
1503         {
1504                 .name   = "do_verify",
1505                 .type   = FIO_OPT_BOOL,
1506                 .off1   = td_var_offset(do_verify),
1507                 .help   = "Run verification stage after write",
1508                 .def    = "1",
1509                 .parent = "verify",
1510         },
1511         {
1512                 .name   = "verifysort",
1513                 .type   = FIO_OPT_BOOL,
1514                 .off1   = td_var_offset(verifysort),
1515                 .help   = "Sort written verify blocks for read back",
1516                 .def    = "1",
1517                 .parent = "verify",
1518         },
1519         {
1520                 .name   = "verify_interval",
1521                 .type   = FIO_OPT_INT,
1522                 .off1   = td_var_offset(verify_interval),
1523                 .minval = 2 * sizeof(struct verify_header),
1524                 .help   = "Store verify buffer header every N bytes",
1525                 .parent = "verify",
1526         },
1527         {
1528                 .name   = "verify_offset",
1529                 .type   = FIO_OPT_INT,
1530                 .help   = "Offset verify header location by N bytes",
1531                 .def    = "0",
1532                 .cb     = str_verify_offset_cb,
1533                 .parent = "verify",
1534         },
1535         {
1536                 .name   = "verify_pattern",
1537                 .type   = FIO_OPT_STR,
1538                 .cb     = str_verify_pattern_cb,
1539                 .help   = "Fill pattern for IO buffers",
1540                 .parent = "verify",
1541         },
1542         {
1543                 .name   = "verify_fatal",
1544                 .type   = FIO_OPT_BOOL,
1545                 .off1   = td_var_offset(verify_fatal),
1546                 .def    = "0",
1547                 .help   = "Exit on a single verify failure, don't continue",
1548                 .parent = "verify",
1549         },
1550         {
1551                 .name   = "verify_dump",
1552                 .type   = FIO_OPT_BOOL,
1553                 .off1   = td_var_offset(verify_dump),
1554                 .def    = "0",
1555                 .help   = "Dump contents of good and bad blocks on failure",
1556                 .parent = "verify",
1557         },
1558         {
1559                 .name   = "verify_async",
1560                 .type   = FIO_OPT_INT,
1561                 .off1   = td_var_offset(verify_async),
1562                 .def    = "0",
1563                 .help   = "Number of async verifier threads to use",
1564                 .parent = "verify",
1565         },
1566         {
1567                 .name   = "verify_backlog",
1568                 .type   = FIO_OPT_STR_VAL,
1569                 .off1   = td_var_offset(verify_backlog),
1570                 .help   = "Verify after this number of blocks are written",
1571                 .parent = "verify",
1572         },
1573         {
1574                 .name   = "verify_backlog_batch",
1575                 .type   = FIO_OPT_INT,
1576                 .off1   = td_var_offset(verify_batch),
1577                 .help   = "Verify this number of IO blocks",
1578                 .parent = "verify",
1579         },
1580 #ifdef FIO_HAVE_CPU_AFFINITY
1581         {
1582                 .name   = "verify_async_cpus",
1583                 .type   = FIO_OPT_STR,
1584                 .cb     = str_verify_cpus_allowed_cb,
1585                 .help   = "Set CPUs allowed for async verify threads",
1586                 .parent = "verify_async",
1587         },
1588 #endif
1589 #ifdef FIO_HAVE_TRIM
1590         {
1591                 .name   = "trim_percentage",
1592                 .type   = FIO_OPT_INT,
1593                 .cb     = str_verify_trim_cb,
1594                 .maxval = 100,
1595                 .help   = "Number of verify blocks to discard/trim",
1596                 .parent = "verify",
1597                 .def    = "0",
1598         },
1599         {
1600                 .name   = "trim_verify_zero",
1601                 .type   = FIO_OPT_INT,
1602                 .help   = "Verify that trim/discarded blocks are returned as zeroes",
1603                 .off1   = td_var_offset(trim_zero),
1604                 .parent = "trim_percentage",
1605                 .def    = "1",
1606         },
1607         {
1608                 .name   = "trim_backlog",
1609                 .type   = FIO_OPT_STR_VAL,
1610                 .off1   = td_var_offset(trim_backlog),
1611                 .help   = "Trim after this number of blocks are written",
1612                 .parent = "trim_percentage",
1613         },
1614         {
1615                 .name   = "trim_backlog_batch",
1616                 .type   = FIO_OPT_INT,
1617                 .off1   = td_var_offset(trim_batch),
1618                 .help   = "Trim this number of IO blocks",
1619                 .parent = "trim_percentage",
1620         },
1621 #endif
1622         {
1623                 .name   = "write_iolog",
1624                 .type   = FIO_OPT_STR_STORE,
1625                 .off1   = td_var_offset(write_iolog_file),
1626                 .help   = "Store IO pattern to file",
1627         },
1628         {
1629                 .name   = "read_iolog",
1630                 .type   = FIO_OPT_STR_STORE,
1631                 .off1   = td_var_offset(read_iolog_file),
1632                 .help   = "Playback IO pattern from file",
1633         },
1634         {
1635                 .name   = "replay_no_stall",
1636                 .type   = FIO_OPT_INT,
1637                 .off1   = td_var_offset(no_stall),
1638                 .def    = "0",
1639                 .parent = "read_iolog",
1640                 .help   = "Playback IO pattern file as fast as possible without stalls",
1641         },
1642         {
1643                 .name   = "replay_redirect",
1644                 .type   = FIO_OPT_STR_STORE,
1645                 .off1   = td_var_offset(replay_redirect),
1646                 .parent = "read_iolog",
1647                 .help   = "Replay all I/O onto this device, regardless of trace device",
1648         },
1649         {
1650                 .name   = "exec_prerun",
1651                 .type   = FIO_OPT_STR_STORE,
1652                 .off1   = td_var_offset(exec_prerun),
1653                 .help   = "Execute this file prior to running job",
1654         },
1655         {
1656                 .name   = "exec_postrun",
1657                 .type   = FIO_OPT_STR_STORE,
1658                 .off1   = td_var_offset(exec_postrun),
1659                 .help   = "Execute this file after running job",
1660         },
1661 #ifdef FIO_HAVE_IOSCHED_SWITCH
1662         {
1663                 .name   = "ioscheduler",
1664                 .type   = FIO_OPT_STR_STORE,
1665                 .off1   = td_var_offset(ioscheduler),
1666                 .help   = "Use this IO scheduler on the backing device",
1667         },
1668 #endif
1669         {
1670                 .name   = "zonesize",
1671                 .type   = FIO_OPT_STR_VAL,
1672                 .off1   = td_var_offset(zone_size),
1673                 .help   = "Give size of an IO zone",
1674                 .def    = "0",
1675         },
1676         {
1677                 .name   = "zoneskip",
1678                 .type   = FIO_OPT_STR_VAL,
1679                 .off1   = td_var_offset(zone_skip),
1680                 .help   = "Space between IO zones",
1681                 .def    = "0",
1682         },
1683         {
1684                 .name   = "lockmem",
1685                 .type   = FIO_OPT_STR_VAL,
1686                 .cb     = str_lockmem_cb,
1687                 .help   = "Lock down this amount of memory",
1688                 .def    = "0",
1689         },
1690         {
1691                 .name   = "rwmixread",
1692                 .type   = FIO_OPT_INT,
1693                 .cb     = str_rwmix_read_cb,
1694                 .maxval = 100,
1695                 .help   = "Percentage of mixed workload that is reads",
1696                 .def    = "50",
1697         },
1698         {
1699                 .name   = "rwmixwrite",
1700                 .type   = FIO_OPT_INT,
1701                 .cb     = str_rwmix_write_cb,
1702                 .maxval = 100,
1703                 .help   = "Percentage of mixed workload that is writes",
1704                 .def    = "50",
1705         },
1706         {
1707                 .name   = "rwmixcycle",
1708                 .type   = FIO_OPT_DEPRECATED,
1709         },
1710         {
1711                 .name   = "nice",
1712                 .type   = FIO_OPT_INT,
1713                 .off1   = td_var_offset(nice),
1714                 .help   = "Set job CPU nice value",
1715                 .minval = -19,
1716                 .maxval = 20,
1717                 .def    = "0",
1718         },
1719 #ifdef FIO_HAVE_IOPRIO
1720         {
1721                 .name   = "prio",
1722                 .type   = FIO_OPT_INT,
1723                 .cb     = str_prio_cb,
1724                 .help   = "Set job IO priority value",
1725                 .minval = 0,
1726                 .maxval = 7,
1727         },
1728         {
1729                 .name   = "prioclass",
1730                 .type   = FIO_OPT_INT,
1731                 .cb     = str_prioclass_cb,
1732                 .help   = "Set job IO priority class",
1733                 .minval = 0,
1734                 .maxval = 3,
1735         },
1736 #endif
1737         {
1738                 .name   = "thinktime",
1739                 .type   = FIO_OPT_INT,
1740                 .off1   = td_var_offset(thinktime),
1741                 .help   = "Idle time between IO buffers (usec)",
1742                 .def    = "0",
1743         },
1744         {
1745                 .name   = "thinktime_spin",
1746                 .type   = FIO_OPT_INT,
1747                 .off1   = td_var_offset(thinktime_spin),
1748                 .help   = "Start think time by spinning this amount (usec)",
1749                 .def    = "0",
1750                 .parent = "thinktime",
1751         },
1752         {
1753                 .name   = "thinktime_blocks",
1754                 .type   = FIO_OPT_INT,
1755                 .off1   = td_var_offset(thinktime_blocks),
1756                 .help   = "IO buffer period between 'thinktime'",
1757                 .def    = "1",
1758                 .parent = "thinktime",
1759         },
1760         {
1761                 .name   = "rate",
1762                 .type   = FIO_OPT_INT,
1763                 .off1   = td_var_offset(rate[0]),
1764                 .off2   = td_var_offset(rate[1]),
1765                 .help   = "Set bandwidth rate",
1766         },
1767         {
1768                 .name   = "ratemin",
1769                 .type   = FIO_OPT_INT,
1770                 .off1   = td_var_offset(ratemin[0]),
1771                 .off2   = td_var_offset(ratemin[1]),
1772                 .help   = "Job must meet this rate or it will be shutdown",
1773                 .parent = "rate",
1774         },
1775         {
1776                 .name   = "rate_iops",
1777                 .type   = FIO_OPT_INT,
1778                 .off1   = td_var_offset(rate_iops[0]),
1779                 .off2   = td_var_offset(rate_iops[1]),
1780                 .help   = "Limit IO used to this number of IO operations/sec",
1781         },
1782         {
1783                 .name   = "rate_iops_min",
1784                 .type   = FIO_OPT_INT,
1785                 .off1   = td_var_offset(rate_iops_min[0]),
1786                 .off2   = td_var_offset(rate_iops_min[1]),
1787                 .help   = "Job must meet this rate or it will be shut down",
1788                 .parent = "rate_iops",
1789         },
1790         {
1791                 .name   = "ratecycle",
1792                 .type   = FIO_OPT_INT,
1793                 .off1   = td_var_offset(ratecycle),
1794                 .help   = "Window average for rate limits (msec)",
1795                 .def    = "1000",
1796                 .parent = "rate",
1797         },
1798         {
1799                 .name   = "invalidate",
1800                 .type   = FIO_OPT_BOOL,
1801                 .off1   = td_var_offset(invalidate_cache),
1802                 .help   = "Invalidate buffer/page cache prior to running job",
1803                 .def    = "1",
1804         },
1805         {
1806                 .name   = "sync",
1807                 .type   = FIO_OPT_BOOL,
1808                 .off1   = td_var_offset(sync_io),
1809                 .help   = "Use O_SYNC for buffered writes",
1810                 .def    = "0",
1811                 .parent = "buffered",
1812         },
1813         {
1814                 .name   = "bwavgtime",
1815                 .type   = FIO_OPT_INT,
1816                 .off1   = td_var_offset(bw_avg_time),
1817                 .help   = "Time window over which to calculate bandwidth"
1818                           " (msec)",
1819                 .def    = "500",
1820                 .parent = "write_bw_log",
1821         },
1822         {
1823                 .name   = "iopsavgtime",
1824                 .type   = FIO_OPT_INT,
1825                 .off1   = td_var_offset(iops_avg_time),
1826                 .help   = "Time window over which to calculate IOPS (msec)",
1827                 .def    = "500",
1828                 .parent = "write_iops_log",
1829         },
1830         {
1831                 .name   = "create_serialize",
1832                 .type   = FIO_OPT_BOOL,
1833                 .off1   = td_var_offset(create_serialize),
1834                 .help   = "Serialize creating of job files",
1835                 .def    = "1",
1836         },
1837         {
1838                 .name   = "create_fsync",
1839                 .type   = FIO_OPT_BOOL,
1840                 .off1   = td_var_offset(create_fsync),
1841                 .help   = "fsync file after creation",
1842                 .def    = "1",
1843         },
1844         {
1845                 .name   = "create_on_open",
1846                 .type   = FIO_OPT_BOOL,
1847                 .off1   = td_var_offset(create_on_open),
1848                 .help   = "Create files when they are opened for IO",
1849                 .def    = "0",
1850         },
1851         {
1852                 .name   = "pre_read",
1853                 .type   = FIO_OPT_BOOL,
1854                 .off1   = td_var_offset(pre_read),
1855                 .help   = "Pre-read files before starting official testing",
1856                 .def    = "0",
1857         },
1858         {
1859                 .name   = "cpuload",
1860                 .type   = FIO_OPT_INT,
1861                 .off1   = td_var_offset(cpuload),
1862                 .help   = "Use this percentage of CPU",
1863         },
1864         {
1865                 .name   = "cpuchunks",
1866                 .type   = FIO_OPT_INT,
1867                 .off1   = td_var_offset(cpucycle),
1868                 .help   = "Length of the CPU burn cycles (usecs)",
1869                 .def    = "50000",
1870                 .parent = "cpuload",
1871         },
1872 #ifdef FIO_HAVE_CPU_AFFINITY
1873         {
1874                 .name   = "cpumask",
1875                 .type   = FIO_OPT_INT,
1876                 .cb     = str_cpumask_cb,
1877                 .help   = "CPU affinity mask",
1878         },
1879         {
1880                 .name   = "cpus_allowed",
1881                 .type   = FIO_OPT_STR,
1882                 .cb     = str_cpus_allowed_cb,
1883                 .help   = "Set CPUs allowed",
1884         },
1885 #endif
1886         {
1887                 .name   = "end_fsync",
1888                 .type   = FIO_OPT_BOOL,
1889                 .off1   = td_var_offset(end_fsync),
1890                 .help   = "Include fsync at the end of job",
1891                 .def    = "0",
1892         },
1893         {
1894                 .name   = "fsync_on_close",
1895                 .type   = FIO_OPT_BOOL,
1896                 .off1   = td_var_offset(fsync_on_close),
1897                 .help   = "fsync files on close",
1898                 .def    = "0",
1899         },
1900         {
1901                 .name   = "unlink",
1902                 .type   = FIO_OPT_BOOL,
1903                 .off1   = td_var_offset(unlink),
1904                 .help   = "Unlink created files after job has completed",
1905                 .def    = "0",
1906         },
1907         {
1908                 .name   = "exitall",
1909                 .type   = FIO_OPT_STR_SET,
1910                 .cb     = str_exitall_cb,
1911                 .help   = "Terminate all jobs when one exits",
1912         },
1913         {
1914                 .name   = "stonewall",
1915                 .alias  = "wait_for_previous",
1916                 .type   = FIO_OPT_STR_SET,
1917                 .off1   = td_var_offset(stonewall),
1918                 .help   = "Insert a hard barrier between this job and previous",
1919         },
1920         {
1921                 .name   = "new_group",
1922                 .type   = FIO_OPT_STR_SET,
1923                 .off1   = td_var_offset(new_group),
1924                 .help   = "Mark the start of a new group (for reporting)",
1925         },
1926         {
1927                 .name   = "thread",
1928                 .type   = FIO_OPT_STR_SET,
1929                 .off1   = td_var_offset(use_thread),
1930                 .help   = "Use threads instead of forks",
1931         },
1932         {
1933                 .name   = "write_bw_log",
1934                 .type   = FIO_OPT_STR,
1935                 .off1   = td_var_offset(write_bw_log),
1936                 .cb     = str_write_bw_log_cb,
1937                 .help   = "Write log of bandwidth during run",
1938         },
1939         {
1940                 .name   = "write_lat_log",
1941                 .type   = FIO_OPT_STR,
1942                 .off1   = td_var_offset(write_lat_log),
1943                 .cb     = str_write_lat_log_cb,
1944                 .help   = "Write log of latency during run",
1945         },
1946         {
1947                 .name   = "write_iops_log",
1948                 .type   = FIO_OPT_STR,
1949                 .off1   = td_var_offset(write_iops_log),
1950                 .cb     = str_write_iops_log_cb,
1951                 .help   = "Write log of IOPS during run",
1952         },
1953         {
1954                 .name   = "hugepage-size",
1955                 .type   = FIO_OPT_INT,
1956                 .off1   = td_var_offset(hugepage_size),
1957                 .help   = "When using hugepages, specify size of each page",
1958                 .def    = __fio_stringify(FIO_HUGE_PAGE),
1959         },
1960         {
1961                 .name   = "group_reporting",
1962                 .type   = FIO_OPT_STR_SET,
1963                 .off1   = td_var_offset(group_reporting),
1964                 .help   = "Do reporting on a per-group basis",
1965         },
1966         {
1967                 .name   = "zero_buffers",
1968                 .type   = FIO_OPT_STR_SET,
1969                 .off1   = td_var_offset(zero_buffers),
1970                 .help   = "Init IO buffers to all zeroes",
1971         },
1972         {
1973                 .name   = "refill_buffers",
1974                 .type   = FIO_OPT_STR_SET,
1975                 .off1   = td_var_offset(refill_buffers),
1976                 .help   = "Refill IO buffers on every IO submit",
1977         },
1978         {
1979                 .name   = "scramble_buffers",
1980                 .type   = FIO_OPT_BOOL,
1981                 .off1   = td_var_offset(scramble_buffers),
1982                 .help   = "Slightly scramble buffers on every IO submit",
1983                 .def    = "1",
1984         },
1985         {
1986                 .name   = "clat_percentiles",
1987                 .type   = FIO_OPT_BOOL,
1988                 .off1   = td_var_offset(clat_percentiles),
1989                 .help   = "Enable the reporting of completion latency percentiles",
1990                 .def    = "1",
1991         },
1992         {
1993                 .name   = "percentile_list",
1994                 .type   = FIO_OPT_FLOAT_LIST,
1995                 .off1   = td_var_offset(percentile_list),
1996                 .off2   = td_var_offset(overwrite_plist),
1997                 .help   = "Specify a custom list of percentiles to report",
1998                 .maxlen = FIO_IO_U_LIST_MAX_LEN,
1999                 .minfp  = 0.0,
2000                 .maxfp  = 100.0,
2001         },
2002
2003 #ifdef FIO_HAVE_DISK_UTIL
2004         {
2005                 .name   = "disk_util",
2006                 .type   = FIO_OPT_BOOL,
2007                 .off1   = td_var_offset(do_disk_util),
2008                 .help   = "Log disk utilization statistics",
2009                 .def    = "1",
2010         },
2011 #endif
2012         {
2013                 .name   = "gtod_reduce",
2014                 .type   = FIO_OPT_BOOL,
2015                 .help   = "Greatly reduce number of gettimeofday() calls",
2016                 .cb     = str_gtod_reduce_cb,
2017                 .def    = "0",
2018         },
2019         {
2020                 .name   = "disable_lat",
2021                 .type   = FIO_OPT_BOOL,
2022                 .off1   = td_var_offset(disable_lat),
2023                 .help   = "Disable latency numbers",
2024                 .parent = "gtod_reduce",
2025                 .def    = "0",
2026         },
2027         {
2028                 .name   = "disable_clat",
2029                 .type   = FIO_OPT_BOOL,
2030                 .off1   = td_var_offset(disable_clat),
2031                 .help   = "Disable completion latency numbers",
2032                 .parent = "gtod_reduce",
2033                 .def    = "0",
2034         },
2035         {
2036                 .name   = "disable_slat",
2037                 .type   = FIO_OPT_BOOL,
2038                 .off1   = td_var_offset(disable_slat),
2039                 .help   = "Disable submission latency numbers",
2040                 .parent = "gtod_reduce",
2041                 .def    = "0",
2042         },
2043         {
2044                 .name   = "disable_bw_measurement",
2045                 .type   = FIO_OPT_BOOL,
2046                 .off1   = td_var_offset(disable_bw),
2047                 .help   = "Disable bandwidth logging",
2048                 .parent = "gtod_reduce",
2049                 .def    = "0",
2050         },
2051         {
2052                 .name   = "gtod_cpu",
2053                 .type   = FIO_OPT_INT,
2054                 .cb     = str_gtod_cpu_cb,
2055                 .help   = "Set up dedicated gettimeofday() thread on this CPU",
2056                 .verify = gtod_cpu_verify,
2057         },
2058         {
2059                 .name   = "continue_on_error",
2060                 .type   = FIO_OPT_BOOL,
2061                 .off1   = td_var_offset(continue_on_error),
2062                 .help   = "Continue on non-fatal errors during IO",
2063                 .def    = "0",
2064         },
2065         {
2066                 .name   = "profile",
2067                 .type   = FIO_OPT_STR_STORE,
2068                 .off1   = td_var_offset(profile),
2069                 .help   = "Select a specific builtin performance test",
2070         },
2071         {
2072                 .name   = "cgroup",
2073                 .type   = FIO_OPT_STR_STORE,
2074                 .off1   = td_var_offset(cgroup),
2075                 .help   = "Add job to cgroup of this name",
2076         },
2077         {
2078                 .name   = "cgroup_weight",
2079                 .type   = FIO_OPT_INT,
2080                 .off1   = td_var_offset(cgroup_weight),
2081                 .help   = "Use given weight for cgroup",
2082                 .minval = 100,
2083                 .maxval = 1000,
2084         },
2085         {
2086                 .name   = "cgroup_nodelete",
2087                 .type   = FIO_OPT_BOOL,
2088                 .off1   = td_var_offset(cgroup_nodelete),
2089                 .help   = "Do not delete cgroups after job completion",
2090                 .def    = "0",
2091         },
2092         {
2093                 .name   = "uid",
2094                 .type   = FIO_OPT_INT,
2095                 .off1   = td_var_offset(uid),
2096                 .help   = "Run job with this user ID",
2097         },
2098         {
2099                 .name   = "gid",
2100                 .type   = FIO_OPT_INT,
2101                 .off1   = td_var_offset(gid),
2102                 .help   = "Run job with this group ID",
2103         },
2104         {
2105                 .name = NULL,
2106         },
2107 };
2108
2109 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2110                         const char *name, int val)
2111 {
2112         lopt->name = (char *) name;
2113         lopt->val = val;
2114         if (o->type == FIO_OPT_STR_SET)
2115                 lopt->has_arg = no_argument;
2116         else
2117                 lopt->has_arg = required_argument;
2118 }
2119
2120 static void options_to_lopts(struct fio_option *opts,
2121                               struct option *long_options,
2122                               int i, int option_type)
2123 {
2124         struct fio_option *o = &opts[0];
2125         while (o->name) {
2126                 add_to_lopt(&long_options[i], o, o->name, option_type);
2127                 if (o->alias) {
2128                         i++;
2129                         add_to_lopt(&long_options[i], o, o->alias, option_type);
2130                 }
2131
2132                 i++;
2133                 o++;
2134                 assert(i < FIO_NR_OPTIONS);
2135         }
2136 }
2137
2138 void fio_options_set_ioengine_opts(struct option *long_options,
2139                                    struct thread_data *td)
2140 {
2141         unsigned int i;
2142
2143         i = 0;
2144         while (long_options[i].name) {
2145                 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2146                         memset(&long_options[i], 0, sizeof(*long_options));
2147                         break;
2148                 }
2149                 i++;
2150         }
2151
2152         /*
2153          * Just clear out the prior ioengine options.
2154          */
2155         if (!td || !td->eo)
2156                 return;
2157
2158         options_to_lopts(td->io_ops->options, long_options, i,
2159                          FIO_GETOPT_IOENGINE);
2160 }
2161
2162 void fio_options_dup_and_init(struct option *long_options)
2163 {
2164         unsigned int i;
2165
2166         options_init(options);
2167
2168         i = 0;
2169         while (long_options[i].name)
2170                 i++;
2171
2172         options_to_lopts(options, long_options, i, FIO_GETOPT_JOB);
2173 }
2174
2175 struct fio_keyword {
2176         const char *word;
2177         const char *desc;
2178         char *replace;
2179 };
2180
2181 static struct fio_keyword fio_keywords[] = {
2182         {
2183                 .word   = "$pagesize",
2184                 .desc   = "Page size in the system",
2185         },
2186         {
2187                 .word   = "$mb_memory",
2188                 .desc   = "Megabytes of memory online",
2189         },
2190         {
2191                 .word   = "$ncpus",
2192                 .desc   = "Number of CPUs online in the system",
2193         },
2194         {
2195                 .word   = NULL,
2196         },
2197 };
2198
2199 void fio_keywords_init(void)
2200 {
2201         unsigned long long mb_memory;
2202         char buf[128];
2203         long l;
2204
2205         sprintf(buf, "%lu", page_size);
2206         fio_keywords[0].replace = strdup(buf);
2207
2208         mb_memory = os_phys_mem() / (1024 * 1024);
2209         sprintf(buf, "%llu", mb_memory);
2210         fio_keywords[1].replace = strdup(buf);
2211
2212         l = cpus_online();
2213         sprintf(buf, "%lu", l);
2214         fio_keywords[2].replace = strdup(buf);
2215 }
2216
2217 #define BC_APP          "bc"
2218
2219 static char *bc_calc(char *str)
2220 {
2221         char buf[128], *tmp;
2222         FILE *f;
2223         int ret;
2224
2225         /*
2226          * No math, just return string
2227          */
2228         if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2229              !strchr(str, '/')) || strchr(str, '\''))
2230                 return str;
2231
2232         /*
2233          * Split option from value, we only need to calculate the value
2234          */
2235         tmp = strchr(str, '=');
2236         if (!tmp)
2237                 return str;
2238
2239         tmp++;
2240
2241         /*
2242          * Prevent buffer overflows; such a case isn't reasonable anyway
2243          */
2244         if (strlen(str) >= 128 || strlen(tmp) > 100)
2245                 return str;
2246
2247         sprintf(buf, "which %s > /dev/null", BC_APP);
2248         if (system(buf)) {
2249                 log_err("fio: bc is needed for performing math\n");
2250                 return NULL;
2251         }
2252
2253         sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2254         f = popen(buf, "r");
2255         if (!f) {
2256                 return NULL;
2257         }
2258
2259         ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2260         if (ret <= 0) {
2261                 return NULL;
2262         }
2263
2264         pclose(f);
2265         buf[(tmp - str) + ret - 1] = '\0';
2266         memcpy(buf, str, tmp - str);
2267         free(str);
2268         return strdup(buf);
2269 }
2270
2271 /*
2272  * Return a copy of the input string with substrings of the form ${VARNAME}
2273  * substituted with the value of the environment variable VARNAME.  The
2274  * substitution always occurs, even if VARNAME is empty or the corresponding
2275  * environment variable undefined.
2276  */
2277 static char *option_dup_subs(const char *opt)
2278 {
2279         char out[OPT_LEN_MAX+1];
2280         char in[OPT_LEN_MAX+1];
2281         char *outptr = out;
2282         char *inptr = in;
2283         char *ch1, *ch2, *env;
2284         ssize_t nchr = OPT_LEN_MAX;
2285         size_t envlen;
2286
2287         if (strlen(opt) + 1 > OPT_LEN_MAX) {
2288                 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2289                 return NULL;
2290         }
2291
2292         in[OPT_LEN_MAX] = '\0';
2293         strncpy(in, opt, OPT_LEN_MAX);
2294
2295         while (*inptr && nchr > 0) {
2296                 if (inptr[0] == '$' && inptr[1] == '{') {
2297                         ch2 = strchr(inptr, '}');
2298                         if (ch2 && inptr+1 < ch2) {
2299                                 ch1 = inptr+2;
2300                                 inptr = ch2+1;
2301                                 *ch2 = '\0';
2302
2303                                 env = getenv(ch1);
2304                                 if (env) {
2305                                         envlen = strlen(env);
2306                                         if (envlen <= nchr) {
2307                                                 memcpy(outptr, env, envlen);
2308                                                 outptr += envlen;
2309                                                 nchr -= envlen;
2310                                         }
2311                                 }
2312
2313                                 continue;
2314                         }
2315                 }
2316
2317                 *outptr++ = *inptr++;
2318                 --nchr;
2319         }
2320
2321         *outptr = '\0';
2322         return strdup(out);
2323 }
2324
2325 /*
2326  * Look for reserved variable names and replace them with real values
2327  */
2328 static char *fio_keyword_replace(char *opt)
2329 {
2330         char *s;
2331         int i;
2332         int docalc = 0;
2333
2334         for (i = 0; fio_keywords[i].word != NULL; i++) {
2335                 struct fio_keyword *kw = &fio_keywords[i];
2336
2337                 while ((s = strstr(opt, kw->word)) != NULL) {
2338                         char *new = malloc(strlen(opt) + 1);
2339                         char *o_org = opt;
2340                         int olen = s - opt;
2341                         int len;
2342
2343                         /*
2344                          * Copy part of the string before the keyword and
2345                          * sprintf() the replacement after it.
2346                          */
2347                         memcpy(new, opt, olen);
2348                         len = sprintf(new + olen, "%s", kw->replace);
2349
2350                         /*
2351                          * If there's more in the original string, copy that
2352                          * in too
2353                          */
2354                         opt += strlen(kw->word) + olen;
2355                         if (strlen(opt))
2356                                 memcpy(new + olen + len, opt, opt - o_org - 1);
2357
2358                         /*
2359                          * replace opt and free the old opt
2360                          */
2361                         opt = new;
2362                         free(o_org);
2363
2364                         docalc = 1;
2365                 }
2366         }
2367
2368         /*
2369          * Check for potential math and invoke bc, if possible
2370          */
2371         if (docalc)
2372                 opt = bc_calc(opt);
2373
2374         return opt;
2375 }
2376
2377 static char **dup_and_sub_options(char **opts, int num_opts)
2378 {
2379         int i;
2380         char **opts_copy = malloc(num_opts * sizeof(*opts));
2381         for (i = 0; i < num_opts; i++) {
2382                 opts_copy[i] = option_dup_subs(opts[i]);
2383                 if (!opts_copy[i])
2384                         continue;
2385                 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2386         }
2387         return opts_copy;
2388 }
2389
2390 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2391 {
2392         int i, ret, unknown;
2393         char **opts_copy;
2394
2395         sort_options(opts, options, num_opts);
2396         opts_copy = dup_and_sub_options(opts, num_opts);
2397
2398         for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2399                 struct fio_option *o;
2400                 int newret = parse_option(opts_copy[i], opts[i], options, &o,
2401                                           td);
2402
2403                 if (opts_copy[i]) {
2404                         if (newret && !o) {
2405                                 unknown++;
2406                                 continue;
2407                         }
2408                         free(opts_copy[i]);
2409                         opts_copy[i] = NULL;
2410                 }
2411
2412                 ret |= newret;
2413         }
2414
2415         if (unknown) {
2416                 ret |= ioengine_load(td);
2417                 if (td->eo) {
2418                         sort_options(opts_copy, td->io_ops->options, num_opts);
2419                         opts = opts_copy;
2420                 }
2421                 for (i = 0; i < num_opts; i++) {
2422                         struct fio_option *o = NULL;
2423                         int newret = 1;
2424                         if (!opts_copy[i])
2425                                 continue;
2426
2427                         if (td->eo)
2428                                 newret = parse_option(opts_copy[i], opts[i],
2429                                                       td->io_ops->options, &o,
2430                                                       td->eo);
2431
2432                         ret |= newret;
2433                         if (!o)
2434                                 log_err("Bad option <%s>\n", opts[i]);
2435
2436                         free(opts_copy[i]);
2437                         opts_copy[i] = NULL;
2438                 }
2439         }
2440
2441         free(opts_copy);
2442         return ret;
2443 }
2444
2445 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2446 {
2447         return parse_cmd_option(opt, val, options, td);
2448 }
2449
2450 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2451                                 char *val)
2452 {
2453         return parse_cmd_option(opt, val, td->io_ops->options, td);
2454 }
2455
2456 void fio_fill_default_options(struct thread_data *td)
2457 {
2458         fill_default_options(td, options);
2459 }
2460
2461 int fio_show_option_help(const char *opt)
2462 {
2463         return show_cmd_help(options, opt);
2464 }
2465
2466 void options_mem_dupe(void *data, struct fio_option *options)
2467 {
2468         struct fio_option *o;
2469         char **ptr;
2470
2471         for (o = &options[0]; o->name; o++) {
2472                 if (o->type != FIO_OPT_STR_STORE)
2473                         continue;
2474
2475                 ptr = td_var(data, o->off1);
2476                 if (*ptr)
2477                         *ptr = strdup(*ptr);
2478         }
2479 }
2480
2481 /*
2482  * dupe FIO_OPT_STR_STORE options
2483  */
2484 void fio_options_mem_dupe(struct thread_data *td)
2485 {
2486         options_mem_dupe(&td->o, options);
2487         if (td->eo) {
2488                 void *oldeo = td->eo;
2489                 td->eo = malloc(td->io_ops->option_struct_size);
2490                 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2491                 options_mem_dupe(td->eo, td->io_ops->options);
2492         }
2493 }
2494
2495 unsigned int fio_get_kb_base(void *data)
2496 {
2497         struct thread_data *td = data;
2498         unsigned int kb_base = 0;
2499
2500         if (td)
2501                 kb_base = td->o.kb_base;
2502         if (!kb_base)
2503                 kb_base = 1024;
2504
2505         return kb_base;
2506 }
2507
2508 int add_option(struct fio_option *o)
2509 {
2510         struct fio_option *__o;
2511         int opt_index = 0;
2512
2513         __o = options;
2514         while (__o->name) {
2515                 opt_index++;
2516                 __o++;
2517         }
2518
2519         memcpy(&options[opt_index], o, sizeof(*o));
2520         return 0;
2521 }
2522
2523 void invalidate_profile_options(const char *prof_name)
2524 {
2525         struct fio_option *o;
2526
2527         o = options;
2528         while (o->name) {
2529                 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2530                         o->type = FIO_OPT_INVALID;
2531                         o->prof_name = NULL;
2532                 }
2533                 o++;
2534         }
2535 }
2536
2537 void add_opt_posval(const char *optname, const char *ival, const char *help)
2538 {
2539         struct fio_option *o;
2540         unsigned int i;
2541
2542         o = find_option(options, optname);
2543         if (!o)
2544                 return;
2545
2546         for (i = 0; i < PARSE_MAX_VP; i++) {
2547                 if (o->posval[i].ival)
2548                         continue;
2549
2550                 o->posval[i].ival = ival;
2551                 o->posval[i].help = help;
2552                 break;
2553         }
2554 }
2555
2556 void del_opt_posval(const char *optname, const char *ival)
2557 {
2558         struct fio_option *o;
2559         unsigned int i;
2560
2561         o = find_option(options, optname);
2562         if (!o)
2563                 return;
2564
2565         for (i = 0; i < PARSE_MAX_VP; i++) {
2566                 if (!o->posval[i].ival)
2567                         continue;
2568                 if (strcmp(o->posval[i].ival, ival))
2569                         continue;
2570
2571                 o->posval[i].ival = NULL;
2572                 o->posval[i].help = NULL;
2573         }
2574 }
2575
2576 void fio_options_free(struct thread_data *td)
2577 {
2578         options_free(options, td);
2579         if (td->eo && td->io_ops && td->io_ops->options) {
2580                 options_free(td->io_ops->options, td->eo);
2581                 free(td->eo);
2582                 td->eo = NULL;
2583         }
2584 }