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