options.c

   1 #include <stdio.h>
   2 #include <stdlib.h>
   3 #include <unistd.h>
   4 #include <ctype.h>
   5 #include <string.h>
   6 #include <getopt.h>
   7 #include <assert.h>
   8 #include <libgen.h>
   9 #include <fcntl.h>
  10 #include <sys/types.h>
  11 #include <sys/stat.h>
  12
  13 #include "fio.h"
  14 #include "verify.h"
  15 #include "parse.h"
  16 #include "lib/fls.h"
  17
  18 #define td_var_offset(var)      ((size_t) &((struct thread_options *)0)->var)
  19
  20 /*
  21  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
  22  */
  23 static char *get_opt_postfix(const char *str)
  24 {
  25         char *p = strstr(str, ":");
  26
  27         if (!p)
  28                 return NULL;
  29
  30         p++;
  31         strip_blank_front(&p);
  32         strip_blank_end(p);
  33         return strdup(p);
  34 }
  35
  36 static int converthexchartoint(char a)
  37 {
  38         int base;
  39
  40         switch(a) {
  41         case '0'...'9':
  42                 base = '0';
  43                 break;
  44         case 'A'...'F':
  45                 base = 'A' - 10;
  46                 break;
  47         case 'a'...'f':
  48                 base = 'a' - 10;
  49                 break;
  50         default:
  51                 base = 0;
  52         }
  53         return (a - base);
  54 }
  55
  56 static int bs_cmp(const void *p1, const void *p2)
  57 {
  58         const struct bssplit *bsp1 = p1;
  59         const struct bssplit *bsp2 = p2;
  60
  61         return bsp1->perc < bsp2->perc;
  62 }
  63
  64 static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
  65 {
  66         struct bssplit *bssplit;
  67         unsigned int i, perc, perc_missing;
  68         unsigned int max_bs, min_bs;
  69         long long val;
  70         char *fname;
  71
  72         td->o.bssplit_nr[ddir] = 4;
  73         bssplit = malloc(4 * sizeof(struct bssplit));
  74
  75         i = 0;
  76         max_bs = 0;
  77         min_bs = -1;
  78         while ((fname = strsep(&str, ":")) != NULL) {
  79                 char *perc_str;
  80
  81                 if (!strlen(fname))
  82                         break;
  83
  84                 /*
  85                  * grow struct buffer, if needed
  86                  */
  87                 if (i == td->o.bssplit_nr[ddir]) {
  88                         td->o.bssplit_nr[ddir] <<= 1;
  89                         bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
  90                                                   * sizeof(struct bssplit));
  91                 }
  92
  93                 perc_str = strstr(fname, "/");
  94                 if (perc_str) {
  95                         *perc_str = '\0';
  96                         perc_str++;
  97                         perc = atoi(perc_str);
  98                         if (perc > 100)
  99                                 perc = 100;
 100                         else if (!perc)
 101                                 perc = -1;
 102                 } else
 103                         perc = -1;
 104
 105                 if (str_to_decimal(fname, &val, 1, td)) {
 106                         log_err("fio: bssplit conversion failed\n");
 107                         free(td->o.bssplit);
 108                         return 1;
 109                 }
 110
 111                 if (val > max_bs)
 112                         max_bs = val;
 113                 if (val < min_bs)
 114                         min_bs = val;
 115
 116                 bssplit[i].bs = val;
 117                 bssplit[i].perc = perc;
 118                 i++;
 119         }
 120
 121         td->o.bssplit_nr[ddir] = i;
 122
 123         /*
 124          * Now check if the percentages add up, and how much is missing
 125          */
 126         perc = perc_missing = 0;
 127         for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
 128                 struct bssplit *bsp = &bssplit[i];
 129
 130                 if (bsp->perc == (unsigned char) -1)
 131                         perc_missing++;
 132                 else
 133                         perc += bsp->perc;
 134         }
 135
 136         if (perc > 100) {
 137                 log_err("fio: bssplit percentages add to more than 100%%\n");
 138                 free(bssplit);
 139                 return 1;
 140         }
 141         /*
 142          * If values didn't have a percentage set, divide the remains between
 143          * them.
 144          */
 145         if (perc_missing) {
 146                 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
 147                         struct bssplit *bsp = &bssplit[i];
 148
 149                         if (bsp->perc == (unsigned char) -1)
 150                                 bsp->perc = (100 - perc) / perc_missing;
 151                 }
 152         }
 153
 154         td->o.min_bs[ddir] = min_bs;
 155         td->o.max_bs[ddir] = max_bs;
 156
 157         /*
 158          * now sort based on percentages, for ease of lookup
 159          */
 160         qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
 161         td->o.bssplit[ddir] = bssplit;
 162         return 0;
 163
 164 }
 165
 166 static int str_bssplit_cb(void *data, const char *input)
 167 {
 168         struct thread_data *td = data;
 169         char *str, *p, *odir;
 170         int ret = 0;
 171
 172         p = str = strdup(input);
 173
 174         strip_blank_front(&str);
 175         strip_blank_end(str);
 176
 177         odir = strchr(str, ',');
 178         if (odir) {
 179                 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
 180                 if (!ret) {
 181                         *odir = '\0';
 182                         ret = bssplit_ddir(td, DDIR_READ, str);
 183                 }
 184         } else {
 185                 char *op;
 186
 187                 op = strdup(str);
 188
 189                 ret = bssplit_ddir(td, DDIR_READ, str);
 190                 if (!ret)
 191                         ret = bssplit_ddir(td, DDIR_WRITE, op);
 192
 193                 free(op);
 194         }
 195
 196         free(p);
 197         return ret;
 198 }
 199
 200 static int str_rw_cb(void *data, const char *str)
 201 {
 202         struct thread_data *td = data;
 203         char *nr = get_opt_postfix(str);
 204
 205         td->o.ddir_nr = 1;
 206         if (nr) {
 207                 td->o.ddir_nr = atoi(nr);
 208                 free(nr);
 209         }
 210
 211         return 0;
 212 }
 213
 214 static int str_mem_cb(void *data, const char *mem)
 215 {
 216         struct thread_data *td = data;
 217
 218         if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
 219                 td->mmapfile = get_opt_postfix(mem);
 220                 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
 221                         log_err("fio: mmaphuge:/path/to/file\n");
 222                         return 1;
 223                 }
 224         }
 225
 226         return 0;
 227 }
 228
 229 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
 230 {
 231         mlock_size = *val;
 232         return 0;
 233 }
 234
 235 static int str_rwmix_read_cb(void *data, unsigned int *val)
 236 {
 237         struct thread_data *td = data;
 238
 239         td->o.rwmix[DDIR_READ] = *val;
 240         td->o.rwmix[DDIR_WRITE] = 100 - *val;
 241         return 0;
 242 }
 243
 244 static int str_rwmix_write_cb(void *data, unsigned int *val)
 245 {
 246         struct thread_data *td = data;
 247
 248         td->o.rwmix[DDIR_WRITE] = *val;
 249         td->o.rwmix[DDIR_READ] = 100 - *val;
 250         return 0;
 251 }
 252
 253 #ifdef FIO_HAVE_IOPRIO
 254 static int str_prioclass_cb(void *data, unsigned int *val)
 255 {
 256         struct thread_data *td = data;
 257         unsigned short mask;
 258
 259         /*
 260          * mask off old class bits, str_prio_cb() may have set a default class
 261          */
 262         mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
 263         td->ioprio &= mask;
 264
 265         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
 266         td->ioprio_set = 1;
 267         return 0;
 268 }
 269
 270 static int str_prio_cb(void *data, unsigned int *val)
 271 {
 272         struct thread_data *td = data;
 273
 274         td->ioprio |= *val;
 275
 276         /*
 277          * If no class is set, assume BE
 278          */
 279         if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
 280                 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
 281
 282         td->ioprio_set = 1;
 283         return 0;
 284 }
 285 #endif
 286
 287 static int str_exitall_cb(void)
 288 {
 289         exitall_on_terminate = 1;
 290         return 0;
 291 }
 292
 293 #ifdef FIO_HAVE_CPU_AFFINITY
 294 static int str_cpumask_cb(void *data, unsigned int *val)
 295 {
 296         struct thread_data *td = data;
 297         unsigned int i;
 298         long max_cpu;
 299         int ret;
 300
 301         ret = fio_cpuset_init(&td->o.cpumask);
 302         if (ret < 0) {
 303                 log_err("fio: cpuset_init failed\n");
 304                 td_verror(td, ret, "fio_cpuset_init");
 305                 return 1;
 306         }
 307
 308         max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
 309
 310         for (i = 0; i < sizeof(int) * 8; i++) {
 311                 if ((1 << i) & *val) {
 312                         if (i > max_cpu) {
 313                                 log_err("fio: CPU %d too large (max=%ld)\n", i,
 314                                                                 max_cpu);
 315                                 return 1;
 316                         }
 317                         dprint(FD_PARSE, "set cpu allowed %d\n", i);
 318                         fio_cpu_set(&td->o.cpumask, i);
 319                 }
 320         }
 321
 322         td->o.cpumask_set = 1;
 323         return 0;
 324 }
 325
 326 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
 327                             const char *input)
 328 {
 329         char *cpu, *str, *p;
 330         long max_cpu;
 331         int ret = 0;
 332
 333         ret = fio_cpuset_init(mask);
 334         if (ret < 0) {
 335                 log_err("fio: cpuset_init failed\n");
 336                 td_verror(td, ret, "fio_cpuset_init");
 337                 return 1;
 338         }
 339
 340         p = str = strdup(input);
 341
 342         strip_blank_front(&str);
 343         strip_blank_end(str);
 344
 345         max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
 346
 347         while ((cpu = strsep(&str, ",")) != NULL) {
 348                 char *str2, *cpu2;
 349                 int icpu, icpu2;
 350
 351                 if (!strlen(cpu))
 352                         break;
 353
 354                 str2 = cpu;
 355                 icpu2 = -1;
 356                 while ((cpu2 = strsep(&str2, "-")) != NULL) {
 357                         if (!strlen(cpu2))
 358                                 break;
 359
 360                         icpu2 = atoi(cpu2);
 361                 }
 362
 363                 icpu = atoi(cpu);
 364                 if (icpu2 == -1)
 365                         icpu2 = icpu;
 366                 while (icpu <= icpu2) {
 367                         if (icpu >= FIO_MAX_CPUS) {
 368                                 log_err("fio: your OS only supports up to"
 369                                         " %d CPUs\n", (int) FIO_MAX_CPUS);
 370                                 ret = 1;
 371                                 break;
 372                         }
 373                         if (icpu > max_cpu) {
 374                                 log_err("fio: CPU %d too large (max=%ld)\n",
 375                                                         icpu, max_cpu);
 376                                 ret = 1;
 377                                 break;
 378                         }
 379
 380                         dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
 381                         fio_cpu_set(mask, icpu);
 382                         icpu++;
 383                 }
 384                 if (ret)
 385                         break;
 386         }
 387
 388         free(p);
 389         if (!ret)
 390                 td->o.cpumask_set = 1;
 391         return ret;
 392 }
 393
 394 static int str_cpus_allowed_cb(void *data, const char *input)
 395 {
 396         struct thread_data *td = data;
 397         int ret;
 398
 399         ret = set_cpus_allowed(td, &td->o.cpumask, input);
 400         if (!ret)
 401                 td->o.cpumask_set = 1;
 402
 403         return ret;
 404 }
 405
 406 static int str_verify_cpus_allowed_cb(void *data, const char *input)
 407 {
 408         struct thread_data *td = data;
 409         int ret;
 410
 411         ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
 412         if (!ret)
 413                 td->o.verify_cpumask_set = 1;
 414
 415         return ret;
 416 }
 417 #endif
 418
 419 static int str_fst_cb(void *data, const char *str)
 420 {
 421         struct thread_data *td = data;
 422         char *nr = get_opt_postfix(str);
 423
 424         td->file_service_nr = 1;
 425         if (nr) {
 426                 td->file_service_nr = atoi(nr);
 427                 free(nr);
 428         }
 429
 430         return 0;
 431 }
 432
 433 static int check_dir(struct thread_data *td, char *fname)
 434 {
 435         char file[PATH_MAX], *dir;
 436         int elen = 0;
 437
 438         if (td->o.directory) {
 439                 strcpy(file, td->o.directory);
 440                 strcat(file, "/");
 441                 elen = strlen(file);
 442         }
 443
 444         sprintf(file + elen, "%s", fname);
 445         dir = dirname(file);
 446
 447 #if 0
 448         {
 449         struct stat sb;
 450         /*
 451          * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
 452          * yet, so we can't do this check right here...
 453          */
 454         if (lstat(dir, &sb) < 0) {
 455                 int ret = errno;
 456
 457                 log_err("fio: %s is not a directory\n", dir);
 458                 td_verror(td, ret, "lstat");
 459                 return 1;
 460         }
 461
 462         if (!S_ISDIR(sb.st_mode)) {
 463                 log_err("fio: %s is not a directory\n", dir);
 464                 return 1;
 465         }
 466         }
 467 #endif
 468
 469         return 0;
 470 }
 471
 472 /*
 473  * Return next file in the string. Files are separated with ':'. If the ':'
 474  * is escaped with a '\', then that ':' is part of the filename and does not
 475  * indicate a new file.
 476  */
 477 static char *get_next_file_name(char **ptr)
 478 {
 479         char *str = *ptr;
 480         char *p, *start;
 481
 482         if (!str || !strlen(str))
 483                 return NULL;
 484
 485         start = str;
 486         do {
 487                 /*
 488                  * No colon, we are done
 489                  */
 490                 p = strchr(str, ':');
 491                 if (!p) {
 492                         *ptr = NULL;
 493                         break;
 494                 }
 495
 496                 /*
 497                  * We got a colon, but it's the first character. Skip and
 498                  * continue
 499                  */
 500                 if (p == start) {
 501                         str = ++start;
 502                         continue;
 503                 }
 504
 505                 if (*(p - 1) != '\\') {
 506                         *p = '\0';
 507                         *ptr = p + 1;
 508                         break;
 509                 }
 510
 511                 memmove(p - 1, p, strlen(p) + 1);
 512                 str = p;
 513         } while (1);
 514
 515         return start;
 516 }
 517
 518 static int str_filename_cb(void *data, const char *input)
 519 {
 520         struct thread_data *td = data;
 521         char *fname, *str, *p;
 522
 523         p = str = strdup(input);
 524
 525         strip_blank_front(&str);
 526         strip_blank_end(str);
 527
 528         if (!td->files_index)
 529                 td->o.nr_files = 0;
 530
 531         while ((fname = get_next_file_name(&str)) != NULL) {
 532                 if (!strlen(fname))
 533                         break;
 534                 if (check_dir(td, fname)) {
 535                         free(p);
 536                         return 1;
 537                 }
 538                 add_file(td, fname);
 539                 td->o.nr_files++;
 540         }
 541
 542         free(p);
 543         return 0;
 544 }
 545
 546 static int str_directory_cb(void *data, const char fio_unused *str)
 547 {
 548         struct thread_data *td = data;
 549         struct stat sb;
 550
 551         if (lstat(td->o.directory, &sb) < 0) {
 552                 int ret = errno;
 553
 554                 log_err("fio: %s is not a directory\n", td->o.directory);
 555                 td_verror(td, ret, "lstat");
 556                 return 1;
 557         }
 558         if (!S_ISDIR(sb.st_mode)) {
 559                 log_err("fio: %s is not a directory\n", td->o.directory);
 560                 return 1;
 561         }
 562
 563         return 0;
 564 }
 565
 566 static int str_opendir_cb(void *data, const char fio_unused *str)
 567 {
 568         struct thread_data *td = data;
 569
 570         if (!td->files_index)
 571                 td->o.nr_files = 0;
 572
 573         return add_dir_files(td, td->o.opendir);
 574 }
 575
 576 static int str_verify_offset_cb(void *data, unsigned int *off)
 577 {
 578         struct thread_data *td = data;
 579
 580         if (*off && *off < sizeof(struct verify_header)) {
 581                 log_err("fio: verify_offset too small\n");
 582                 return 1;
 583         }
 584
 585         td->o.verify_offset = *off;
 586         return 0;
 587 }
 588
 589 static int str_verify_pattern_cb(void *data, const char *input)
 590 {
 591         struct thread_data *td = data;
 592         long off;
 593         int i = 0, j = 0, len, k, base = 10;
 594         char* loc1, * loc2;
 595
 596         loc1 = strstr(input, "0x");
 597         loc2 = strstr(input, "0X");
 598         if (loc1 || loc2)
 599                 base = 16;
 600         off = strtol(input, NULL, base);
 601         if (off != LONG_MAX || errno != ERANGE) {
 602                 while (off) {
 603                         td->o.verify_pattern[i] = off & 0xff;
 604                         off >>= 8;
 605                         i++;
 606                 }
 607         } else {
 608                 len = strlen(input);
 609                 k = len - 1;
 610                 if (base == 16) {
 611                         if (loc1)
 612                                 j = loc1 - input + 2;
 613                         else
 614                                 j = loc2 - input + 2;
 615                 } else
 616                         return 1;
 617                 if (len - j < MAX_PATTERN_SIZE * 2) {
 618                         while (k >= j) {
 619                                 off = converthexchartoint(input[k--]);
 620                                 if (k >= j)
 621                                         off += (converthexchartoint(input[k--])
 622                                                 * 16);
 623                                 td->o.verify_pattern[i++] = (char) off;
 624                         }
 625                 }
 626         }
 627         td->o.verify_pattern_bytes = i;
 628         return 0;
 629 }
 630
 631 static int str_lockfile_cb(void *data, const char *str)
 632 {
 633         struct thread_data *td = data;
 634         char *nr = get_opt_postfix(str);
 635
 636         td->o.lockfile_batch = 1;
 637         if (nr) {
 638                 td->o.lockfile_batch = atoi(nr);
 639                 free(nr);
 640         }
 641
 642         return 0;
 643 }
 644
 645 static int str_write_bw_log_cb(void *data, const char *str)
 646 {
 647         struct thread_data *td = data;
 648
 649         if (str)
 650                 td->o.bw_log_file = strdup(str);
 651
 652         td->o.write_bw_log = 1;
 653         return 0;
 654 }
 655
 656 static int str_write_lat_log_cb(void *data, const char *str)
 657 {
 658         struct thread_data *td = data;
 659
 660         if (str)
 661                 td->o.lat_log_file = strdup(str);
 662
 663         td->o.write_lat_log = 1;
 664         return 0;
 665 }
 666
 667 static int str_gtod_reduce_cb(void *data, int *il)
 668 {
 669         struct thread_data *td = data;
 670         int val = *il;
 671
 672         td->o.disable_clat = !!val;
 673         td->o.disable_slat = !!val;
 674         td->o.disable_bw = !!val;
 675         if (val)
 676                 td->tv_cache_mask = 63;
 677
 678         return 0;
 679 }
 680
 681 static int str_gtod_cpu_cb(void *data, int *il)
 682 {
 683         struct thread_data *td = data;
 684         int val = *il;
 685
 686         td->o.gtod_cpu = val;
 687         td->o.gtod_offload = 1;
 688         return 0;
 689 }
 690
 691 static int rw_verify(struct fio_option *o, void *data)
 692 {
 693         struct thread_data *td = data;
 694
 695         if (read_only && td_write(td)) {
 696                 log_err("fio: job <%s> has write bit set, but fio is in"
 697                         " read-only mode\n", td->o.name);
 698                 return 1;
 699         }
 700
 701         return 0;
 702 }
 703
 704 static int gtod_cpu_verify(struct fio_option *o, void *data)
 705 {
 706 #ifndef FIO_HAVE_CPU_AFFINITY
 707         struct thread_data *td = data;
 708
 709         if (td->o.gtod_cpu) {
 710                 log_err("fio: platform must support CPU affinity for"
 711                         "gettimeofday() offloading\n");
 712                 return 1;
 713         }
 714 #endif
 715
 716         return 0;
 717 }
 718
 719 static int kb_base_verify(struct fio_option *o, void *data)
 720 {
 721         struct thread_data *td = data;
 722
 723         if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
 724                 log_err("fio: kb_base set to nonsensical value: %u\n",
 725                                 td->o.kb_base);
 726                 return 1;
 727         }
 728
 729         return 0;
 730 }
 731
 732 #define __stringify_1(x)        #x
 733 #define __stringify(x)          __stringify_1(x)
 734
 735 /*
 736  * Map of job/command line options
 737  */
 738 static struct fio_option options[] = {
 739         {
 740                 .name   = "description",
 741                 .type   = FIO_OPT_STR_STORE,
 742                 .off1   = td_var_offset(description),
 743                 .help   = "Text job description",
 744         },
 745         {
 746                 .name   = "name",
 747                 .type   = FIO_OPT_STR_STORE,
 748                 .off1   = td_var_offset(name),
 749                 .help   = "Name of this job",
 750         },
 751         {
 752                 .name   = "directory",
 753                 .type   = FIO_OPT_STR_STORE,
 754                 .off1   = td_var_offset(directory),
 755                 .cb     = str_directory_cb,
 756                 .help   = "Directory to store files in",
 757         },
 758         {
 759                 .name   = "filename",
 760                 .type   = FIO_OPT_STR_STORE,
 761                 .off1   = td_var_offset(filename),
 762                 .cb     = str_filename_cb,
 763                 .prio   = -1, /* must come after "directory" */
 764                 .help   = "File(s) to use for the workload",
 765         },
 766         {
 767                 .name   = "kb_base",
 768                 .type   = FIO_OPT_INT,
 769                 .off1   = td_var_offset(kb_base),
 770                 .verify = kb_base_verify,
 771                 .prio   = 1,
 772                 .def    = "1024",
 773                 .help   = "How many bytes per KB for reporting (1000 or 1024)",
 774         },
 775         {
 776                 .name   = "lockfile",
 777                 .type   = FIO_OPT_STR,
 778                 .cb     = str_lockfile_cb,
 779                 .off1   = td_var_offset(file_lock_mode),
 780                 .help   = "Lock file when doing IO to it",
 781                 .parent = "filename",
 782                 .def    = "none",
 783                 .posval = {
 784                           { .ival = "none",
 785                             .oval = FILE_LOCK_NONE,
 786                             .help = "No file locking",
 787                           },
 788                           { .ival = "exclusive",
 789                             .oval = FILE_LOCK_EXCLUSIVE,
 790                             .help = "Exclusive file lock",
 791                           },
 792                           {
 793                             .ival = "readwrite",
 794                             .oval = FILE_LOCK_READWRITE,
 795                             .help = "Read vs write lock",
 796                           },
 797                 },
 798         },
 799         {
 800                 .name   = "opendir",
 801                 .type   = FIO_OPT_STR_STORE,
 802                 .off1   = td_var_offset(opendir),
 803                 .cb     = str_opendir_cb,
 804                 .help   = "Recursively add files from this directory and down",
 805         },
 806         {
 807                 .name   = "rw",
 808                 .alias  = "readwrite",
 809                 .type   = FIO_OPT_STR,
 810                 .cb     = str_rw_cb,
 811                 .off1   = td_var_offset(td_ddir),
 812                 .help   = "IO direction",
 813                 .def    = "read",
 814                 .verify = rw_verify,
 815                 .posval = {
 816                           { .ival = "read",
 817                             .oval = TD_DDIR_READ,
 818                             .help = "Sequential read",
 819                           },
 820                           { .ival = "write",
 821                             .oval = TD_DDIR_WRITE,
 822                             .help = "Sequential write",
 823                           },
 824                           { .ival = "randread",
 825                             .oval = TD_DDIR_RANDREAD,
 826                             .help = "Random read",
 827                           },
 828                           { .ival = "randwrite",
 829                             .oval = TD_DDIR_RANDWRITE,
 830                             .help = "Random write",
 831                           },
 832                           { .ival = "rw",
 833                             .oval = TD_DDIR_RW,
 834                             .help = "Sequential read and write mix",
 835                           },
 836                           { .ival = "randrw",
 837                             .oval = TD_DDIR_RANDRW,
 838                             .help = "Random read and write mix"
 839                           },
 840                 },
 841         },
 842         {
 843                 .name   = "ioengine",
 844                 .type   = FIO_OPT_STR_STORE,
 845                 .off1   = td_var_offset(ioengine),
 846                 .help   = "IO engine to use",
 847                 .def    = "sync",
 848                 .posval = {
 849                           { .ival = "sync",
 850                             .help = "Use read/write",
 851                           },
 852                           { .ival = "psync",
 853                             .help = "Use pread/pwrite",
 854                           },
 855                           { .ival = "vsync",
 856                              .help = "Use readv/writev",
 857                           },
 858 #ifdef FIO_HAVE_LIBAIO
 859                           { .ival = "libaio",
 860                             .help = "Linux native asynchronous IO",
 861                           },
 862 #endif
 863 #ifdef FIO_HAVE_POSIXAIO
 864                           { .ival = "posixaio",
 865                             .help = "POSIX asynchronous IO",
 866                           },
 867 #endif
 868 #ifdef FIO_HAVE_SOLARISAIO
 869                           { .ival = "solarisaio",
 870                             .help = "Solaris native asynchronous IO",
 871                           },
 872 #endif
 873                           { .ival = "mmap",
 874                             .help = "Memory mapped IO",
 875                           },
 876 #ifdef FIO_HAVE_SPLICE
 877                           { .ival = "splice",
 878                             .help = "splice/vmsplice based IO",
 879                           },
 880                           { .ival = "netsplice",
 881                             .help = "splice/vmsplice to/from the network",
 882                           },
 883 #endif
 884 #ifdef FIO_HAVE_SGIO
 885                           { .ival = "sg",
 886                             .help = "SCSI generic v3 IO",
 887                           },
 888 #endif
 889                           { .ival = "null",
 890                             .help = "Testing engine (no data transfer)",
 891                           },
 892                           { .ival = "net",
 893                             .help = "Network IO",
 894                           },
 895 #ifdef FIO_HAVE_SYSLET
 896                           { .ival = "syslet-rw",
 897                             .help = "syslet enabled async pread/pwrite IO",
 898                           },
 899 #endif
 900                           { .ival = "cpuio",
 901                             .help = "CPU cycler burner engine",
 902                           },
 903 #ifdef FIO_HAVE_GUASI
 904                           { .ival = "guasi",
 905                             .help = "GUASI IO engine",
 906                           },
 907 #endif
 908                           { .ival = "external",
 909                             .help = "Load external engine (append name)",
 910                           },
 911                 },
 912         },
 913         {
 914                 .name   = "iodepth",
 915                 .type   = FIO_OPT_INT,
 916                 .off1   = td_var_offset(iodepth),
 917                 .help   = "Amount of IO buffers to keep in flight",
 918                 .minval = 1,
 919                 .def    = "1",
 920         },
 921         {
 922                 .name   = "iodepth_batch",
 923                 .alias  = "iodepth_batch_submit",
 924                 .type   = FIO_OPT_INT,
 925                 .off1   = td_var_offset(iodepth_batch),
 926                 .help   = "Number of IO buffers to submit in one go",
 927                 .parent = "iodepth",
 928                 .minval = 1,
 929                 .def    = "1",
 930         },
 931         {
 932                 .name   = "iodepth_batch_complete",
 933                 .type   = FIO_OPT_INT,
 934                 .off1   = td_var_offset(iodepth_batch_complete),
 935                 .help   = "Number of IO buffers to retrieve in one go",
 936                 .parent = "iodepth",
 937                 .minval = 0,
 938                 .def    = "1",
 939         },
 940         {
 941                 .name   = "iodepth_low",
 942                 .type   = FIO_OPT_INT,
 943                 .off1   = td_var_offset(iodepth_low),
 944                 .help   = "Low water mark for queuing depth",
 945                 .parent = "iodepth",
 946         },
 947         {
 948                 .name   = "size",
 949                 .type   = FIO_OPT_STR_VAL,
 950                 .off1   = td_var_offset(size),
 951                 .minval = 1,
 952                 .help   = "Total size of device or files",
 953         },
 954         {
 955                 .name   = "fill_device",
 956                 .type   = FIO_OPT_BOOL,
 957                 .off1   = td_var_offset(fill_device),
 958                 .help   = "Write until an ENOSPC error occurs",
 959                 .def    = "0",
 960         },
 961         {
 962                 .name   = "filesize",
 963                 .type   = FIO_OPT_STR_VAL,
 964                 .off1   = td_var_offset(file_size_low),
 965                 .off2   = td_var_offset(file_size_high),
 966                 .minval = 1,
 967                 .help   = "Size of individual files",
 968         },
 969         {
 970                 .name   = "offset",
 971                 .alias  = "fileoffset",
 972                 .type   = FIO_OPT_STR_VAL,
 973                 .off1   = td_var_offset(start_offset),
 974                 .help   = "Start IO from this offset",
 975                 .def    = "0",
 976         },
 977         {
 978                 .name   = "bs",
 979                 .alias  = "blocksize",
 980                 .type   = FIO_OPT_INT,
 981                 .off1   = td_var_offset(bs[DDIR_READ]),
 982                 .off2   = td_var_offset(bs[DDIR_WRITE]),
 983                 .minval = 1,
 984                 .help   = "Block size unit",
 985                 .def    = "4k",
 986                 .parent = "rw",
 987         },
 988         {
 989                 .name   = "ba",
 990                 .alias  = "blockalign",
 991                 .type   = FIO_OPT_INT,
 992                 .off1   = td_var_offset(ba[DDIR_READ]),
 993                 .off2   = td_var_offset(ba[DDIR_WRITE]),
 994                 .minval = 1,
 995                 .help   = "IO block offset alignment",
 996                 .parent = "rw",
 997         },
 998         {
 999                 .name   = "bsrange",
1000                 .alias  = "blocksize_range",
1001                 .type   = FIO_OPT_RANGE,
1002                 .off1   = td_var_offset(min_bs[DDIR_READ]),
1003                 .off2   = td_var_offset(max_bs[DDIR_READ]),
1004                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
1005                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
1006                 .minval = 1,
1007                 .help   = "Set block size range (in more detail than bs)",
1008                 .parent = "rw",
1009         },
1010         {
1011                 .name   = "bssplit",
1012                 .type   = FIO_OPT_STR,
1013                 .cb     = str_bssplit_cb,
1014                 .help   = "Set a specific mix of block sizes",
1015                 .parent = "rw",
1016         },
1017         {
1018                 .name   = "bs_unaligned",
1019                 .alias  = "blocksize_unaligned",
1020                 .type   = FIO_OPT_STR_SET,
1021                 .off1   = td_var_offset(bs_unaligned),
1022                 .help   = "Don't sector align IO buffer sizes",
1023                 .parent = "rw",
1024         },
1025         {
1026                 .name   = "randrepeat",
1027                 .type   = FIO_OPT_BOOL,
1028                 .off1   = td_var_offset(rand_repeatable),
1029                 .help   = "Use repeatable random IO pattern",
1030                 .def    = "1",
1031                 .parent = "rw",
1032         },
1033         {
1034                 .name   = "norandommap",
1035                 .type   = FIO_OPT_STR_SET,
1036                 .off1   = td_var_offset(norandommap),
1037                 .help   = "Accept potential duplicate random blocks",
1038                 .parent = "rw",
1039         },
1040         {
1041                 .name   = "softrandommap",
1042                 .type   = FIO_OPT_BOOL,
1043                 .off1   = td_var_offset(softrandommap),
1044                 .help   = "Set norandommap if randommap allocation fails",
1045                 .parent = "norandommap",
1046                 .def    = "0",
1047         },
1048         {
1049                 .name   = "nrfiles",
1050                 .type   = FIO_OPT_INT,
1051                 .off1   = td_var_offset(nr_files),
1052                 .help   = "Split job workload between this number of files",
1053                 .def    = "1",
1054         },
1055         {
1056                 .name   = "openfiles",
1057                 .type   = FIO_OPT_INT,
1058                 .off1   = td_var_offset(open_files),
1059                 .help   = "Number of files to keep open at the same time",
1060         },
1061         {
1062                 .name   = "file_service_type",
1063                 .type   = FIO_OPT_STR,
1064                 .cb     = str_fst_cb,
1065                 .off1   = td_var_offset(file_service_type),
1066                 .help   = "How to select which file to service next",
1067                 .def    = "roundrobin",
1068                 .posval = {
1069                           { .ival = "random",
1070                             .oval = FIO_FSERVICE_RANDOM,
1071                             .help = "Choose a file at random",
1072                           },
1073                           { .ival = "roundrobin",
1074                             .oval = FIO_FSERVICE_RR,
1075                             .help = "Round robin select files",
1076                           },
1077                           { .ival = "sequential",
1078                             .oval = FIO_FSERVICE_SEQ,
1079                             .help = "Finish one file before moving to the next",
1080                           },
1081                 },
1082                 .parent = "nrfiles",
1083         },
1084 #ifdef FIO_HAVE_FALLOCATE
1085         {
1086                 .name   = "fallocate",
1087                 .type   = FIO_OPT_BOOL,
1088                 .off1   = td_var_offset(fallocate),
1089                 .help   = "Use fallocate() when laying out files",
1090                 .def    = "1",
1091         },
1092 #endif
1093         {
1094                 .name   = "fadvise_hint",
1095                 .type   = FIO_OPT_BOOL,
1096                 .off1   = td_var_offset(fadvise_hint),
1097                 .help   = "Use fadvise() to advise the kernel on IO pattern",
1098                 .def    = "1",
1099         },
1100         {
1101                 .name   = "fsync",
1102                 .type   = FIO_OPT_INT,
1103                 .off1   = td_var_offset(fsync_blocks),
1104                 .help   = "Issue fsync for writes every given number of blocks",
1105                 .def    = "0",
1106         },
1107         {
1108                 .name   = "fdatasync",
1109                 .type   = FIO_OPT_INT,
1110                 .off1   = td_var_offset(fdatasync_blocks),
1111                 .help   = "Issue fdatasync for writes every given number of blocks",
1112                 .def    = "0",
1113         },
1114         {
1115                 .name   = "direct",
1116                 .type   = FIO_OPT_BOOL,
1117                 .off1   = td_var_offset(odirect),
1118                 .help   = "Use O_DIRECT IO (negates buffered)",
1119                 .def    = "0",
1120         },
1121         {
1122                 .name   = "buffered",
1123                 .type   = FIO_OPT_BOOL,
1124                 .off1   = td_var_offset(odirect),
1125                 .neg    = 1,
1126                 .help   = "Use buffered IO (negates direct)",
1127                 .def    = "1",
1128         },
1129         {
1130                 .name   = "overwrite",
1131                 .type   = FIO_OPT_BOOL,
1132                 .off1   = td_var_offset(overwrite),
1133                 .help   = "When writing, set whether to overwrite current data",
1134                 .def    = "0",
1135         },
1136         {
1137                 .name   = "loops",
1138                 .type   = FIO_OPT_INT,
1139                 .off1   = td_var_offset(loops),
1140                 .help   = "Number of times to run the job",
1141                 .def    = "1",
1142         },
1143         {
1144                 .name   = "numjobs",
1145                 .type   = FIO_OPT_INT,
1146                 .off1   = td_var_offset(numjobs),
1147                 .help   = "Duplicate this job this many times",
1148                 .def    = "1",
1149         },
1150         {
1151                 .name   = "startdelay",
1152                 .type   = FIO_OPT_INT,
1153                 .off1   = td_var_offset(start_delay),
1154                 .help   = "Only start job when this period has passed",
1155                 .def    = "0",
1156         },
1157         {
1158                 .name   = "runtime",
1159                 .alias  = "timeout",
1160                 .type   = FIO_OPT_STR_VAL_TIME,
1161                 .off1   = td_var_offset(timeout),
1162                 .help   = "Stop workload when this amount of time has passed",
1163                 .def    = "0",
1164         },
1165         {
1166                 .name   = "time_based",
1167                 .type   = FIO_OPT_STR_SET,
1168                 .off1   = td_var_offset(time_based),
1169                 .help   = "Keep running until runtime/timeout is met",
1170         },
1171         {
1172                 .name   = "ramp_time",
1173                 .type   = FIO_OPT_STR_VAL_TIME,
1174                 .off1   = td_var_offset(ramp_time),
1175                 .help   = "Ramp up time before measuring performance",
1176         },
1177         {
1178                 .name   = "mem",
1179                 .alias  = "iomem",
1180                 .type   = FIO_OPT_STR,
1181                 .cb     = str_mem_cb,
1182                 .off1   = td_var_offset(mem_type),
1183                 .help   = "Backing type for IO buffers",
1184                 .def    = "malloc",
1185                 .posval = {
1186                           { .ival = "malloc",
1187                             .oval = MEM_MALLOC,
1188                             .help = "Use malloc(3) for IO buffers",
1189                           },
1190                           { .ival = "shm",
1191                             .oval = MEM_SHM,
1192                             .help = "Use shared memory segments for IO buffers",
1193                           },
1194 #ifdef FIO_HAVE_HUGETLB
1195                           { .ival = "shmhuge",
1196                             .oval = MEM_SHMHUGE,
1197                             .help = "Like shm, but use huge pages",
1198                           },
1199 #endif
1200                           { .ival = "mmap",
1201                             .oval = MEM_MMAP,
1202                             .help = "Use mmap(2) (file or anon) for IO buffers",
1203                           },
1204 #ifdef FIO_HAVE_HUGETLB
1205                           { .ival = "mmaphuge",
1206                             .oval = MEM_MMAPHUGE,
1207                             .help = "Like mmap, but use huge pages",
1208                           },
1209 #endif
1210                   },
1211         },
1212         {
1213                 .name   = "iomem_align",
1214                 .alias  = "mem_align",
1215                 .type   = FIO_OPT_INT,
1216                 .off1   = td_var_offset(mem_align),
1217                 .minval = 0,
1218                 .help   = "IO memory buffer offset alignment",
1219                 .def    = "0",
1220                 .parent = "iomem",
1221         },
1222         {
1223                 .name   = "verify",
1224                 .type   = FIO_OPT_STR,
1225                 .off1   = td_var_offset(verify),
1226                 .help   = "Verify data written",
1227                 .def    = "0",
1228                 .posval = {
1229                           { .ival = "0",
1230                             .oval = VERIFY_NONE,
1231                             .help = "Don't do IO verification",
1232                           },
1233                           { .ival = "md5",
1234                             .oval = VERIFY_MD5,
1235                             .help = "Use md5 checksums for verification",
1236                           },
1237                           { .ival = "crc64",
1238                             .oval = VERIFY_CRC64,
1239                             .help = "Use crc64 checksums for verification",
1240                           },
1241                           { .ival = "crc32",
1242                             .oval = VERIFY_CRC32,
1243                             .help = "Use crc32 checksums for verification",
1244                           },
1245                           { .ival = "crc32c-intel",
1246                             .oval = VERIFY_CRC32C_INTEL,
1247                             .help = "Use hw crc32c checksums for verification",
1248                           },
1249                           { .ival = "crc32c",
1250                             .oval = VERIFY_CRC32C,
1251                             .help = "Use crc32c checksums for verification",
1252                           },
1253                           { .ival = "crc16",
1254                             .oval = VERIFY_CRC16,
1255                             .help = "Use crc16 checksums for verification",
1256                           },
1257                           { .ival = "crc7",
1258                             .oval = VERIFY_CRC7,
1259                             .help = "Use crc7 checksums for verification",
1260                           },
1261                           { .ival = "sha1",
1262                             .oval = VERIFY_SHA1,
1263                             .help = "Use sha1 checksums for verification",
1264                           },
1265                           { .ival = "sha256",
1266                             .oval = VERIFY_SHA256,
1267                             .help = "Use sha256 checksums for verification",
1268                           },
1269                           { .ival = "sha512",
1270                             .oval = VERIFY_SHA512,
1271                             .help = "Use sha512 checksums for verification",
1272                           },
1273                           { .ival = "meta",
1274                             .oval = VERIFY_META,
1275                             .help = "Use io information",
1276                           },
1277                           {
1278                             .ival = "null",
1279                             .oval = VERIFY_NULL,
1280                             .help = "Pretend to verify",
1281                           },
1282                 },
1283         },
1284         {
1285                 .name   = "do_verify",
1286                 .type   = FIO_OPT_BOOL,
1287                 .off1   = td_var_offset(do_verify),
1288                 .help   = "Run verification stage after write",
1289                 .def    = "1",
1290                 .parent = "verify",
1291         },
1292         {
1293                 .name   = "verifysort",
1294                 .type   = FIO_OPT_BOOL,
1295                 .off1   = td_var_offset(verifysort),
1296                 .help   = "Sort written verify blocks for read back",
1297                 .def    = "1",
1298                 .parent = "verify",
1299         },
1300         {
1301                 .name   = "verify_interval",
1302                 .type   = FIO_OPT_INT,
1303                 .off1   = td_var_offset(verify_interval),
1304                 .minval = 2 * sizeof(struct verify_header),
1305                 .help   = "Store verify buffer header every N bytes",
1306                 .parent = "verify",
1307         },
1308         {
1309                 .name   = "verify_offset",
1310                 .type   = FIO_OPT_INT,
1311                 .help   = "Offset verify header location by N bytes",
1312                 .def    = "0",
1313                 .cb     = str_verify_offset_cb,
1314                 .parent = "verify",
1315         },
1316         {
1317                 .name   = "verify_pattern",
1318                 .type   = FIO_OPT_STR,
1319                 .cb     = str_verify_pattern_cb,
1320                 .help   = "Fill pattern for IO buffers",
1321                 .parent = "verify",
1322         },
1323         {
1324                 .name   = "verify_fatal",
1325                 .type   = FIO_OPT_BOOL,
1326                 .off1   = td_var_offset(verify_fatal),
1327                 .def    = "0",
1328                 .help   = "Exit on a single verify failure, don't continue",
1329                 .parent = "verify",
1330         },
1331         {
1332                 .name   = "verify_async",
1333                 .type   = FIO_OPT_INT,
1334                 .off1   = td_var_offset(verify_async),
1335                 .def    = "0",
1336                 .help   = "Number of async verifier threads to use",
1337                 .parent = "verify",
1338         },
1339 #ifdef FIO_HAVE_CPU_AFFINITY
1340         {
1341                 .name   = "verify_async_cpus",
1342                 .type   = FIO_OPT_STR,
1343                 .cb     = str_verify_cpus_allowed_cb,
1344                 .help   = "Set CPUs allowed for async verify threads",
1345                 .parent = "verify_async",
1346         },
1347 #endif
1348         {
1349                 .name   = "write_iolog",
1350                 .type   = FIO_OPT_STR_STORE,
1351                 .off1   = td_var_offset(write_iolog_file),
1352                 .help   = "Store IO pattern to file",
1353         },
1354         {
1355                 .name   = "read_iolog",
1356                 .type   = FIO_OPT_STR_STORE,
1357                 .off1   = td_var_offset(read_iolog_file),
1358                 .help   = "Playback IO pattern from file",
1359         },
1360         {
1361                 .name   = "exec_prerun",
1362                 .type   = FIO_OPT_STR_STORE,
1363                 .off1   = td_var_offset(exec_prerun),
1364                 .help   = "Execute this file prior to running job",
1365         },
1366         {
1367                 .name   = "exec_postrun",
1368                 .type   = FIO_OPT_STR_STORE,
1369                 .off1   = td_var_offset(exec_postrun),
1370                 .help   = "Execute this file after running job",
1371         },
1372 #ifdef FIO_HAVE_IOSCHED_SWITCH
1373         {
1374                 .name   = "ioscheduler",
1375                 .type   = FIO_OPT_STR_STORE,
1376                 .off1   = td_var_offset(ioscheduler),
1377                 .help   = "Use this IO scheduler on the backing device",
1378         },
1379 #endif
1380         {
1381                 .name   = "zonesize",
1382                 .type   = FIO_OPT_STR_VAL,
1383                 .off1   = td_var_offset(zone_size),
1384                 .help   = "Give size of an IO zone",
1385                 .def    = "0",
1386         },
1387         {
1388                 .name   = "zoneskip",
1389                 .type   = FIO_OPT_STR_VAL,
1390                 .off1   = td_var_offset(zone_skip),
1391                 .help   = "Space between IO zones",
1392                 .def    = "0",
1393         },
1394         {
1395                 .name   = "lockmem",
1396                 .type   = FIO_OPT_STR_VAL,
1397                 .cb     = str_lockmem_cb,
1398                 .help   = "Lock down this amount of memory",
1399                 .def    = "0",
1400         },
1401         {
1402                 .name   = "rwmixread",
1403                 .type   = FIO_OPT_INT,
1404                 .cb     = str_rwmix_read_cb,
1405                 .maxval = 100,
1406                 .help   = "Percentage of mixed workload that is reads",
1407                 .def    = "50",
1408         },
1409         {
1410                 .name   = "rwmixwrite",
1411                 .type   = FIO_OPT_INT,
1412                 .cb     = str_rwmix_write_cb,
1413                 .maxval = 100,
1414                 .help   = "Percentage of mixed workload that is writes",
1415                 .def    = "50",
1416         },
1417         {
1418                 .name   = "rwmixcycle",
1419                 .type   = FIO_OPT_DEPRECATED,
1420         },
1421         {
1422                 .name   = "nice",
1423                 .type   = FIO_OPT_INT,
1424                 .off1   = td_var_offset(nice),
1425                 .help   = "Set job CPU nice value",
1426                 .minval = -19,
1427                 .maxval = 20,
1428                 .def    = "0",
1429         },
1430 #ifdef FIO_HAVE_IOPRIO
1431         {
1432                 .name   = "prio",
1433                 .type   = FIO_OPT_INT,
1434                 .cb     = str_prio_cb,
1435                 .help   = "Set job IO priority value",
1436                 .minval = 0,
1437                 .maxval = 7,
1438         },
1439         {
1440                 .name   = "prioclass",
1441                 .type   = FIO_OPT_INT,
1442                 .cb     = str_prioclass_cb,
1443                 .help   = "Set job IO priority class",
1444                 .minval = 0,
1445                 .maxval = 3,
1446         },
1447 #endif
1448         {
1449                 .name   = "thinktime",
1450                 .type   = FIO_OPT_INT,
1451                 .off1   = td_var_offset(thinktime),
1452                 .help   = "Idle time between IO buffers (usec)",
1453                 .def    = "0",
1454         },
1455         {
1456                 .name   = "thinktime_spin",
1457                 .type   = FIO_OPT_INT,
1458                 .off1   = td_var_offset(thinktime_spin),
1459                 .help   = "Start think time by spinning this amount (usec)",
1460                 .def    = "0",
1461                 .parent = "thinktime",
1462         },
1463         {
1464                 .name   = "thinktime_blocks",
1465                 .type   = FIO_OPT_INT,
1466                 .off1   = td_var_offset(thinktime_blocks),
1467                 .help   = "IO buffer period between 'thinktime'",
1468                 .def    = "1",
1469                 .parent = "thinktime",
1470         },
1471         {
1472                 .name   = "rate",
1473                 .type   = FIO_OPT_INT,
1474                 .off1   = td_var_offset(rate[0]),
1475                 .off2   = td_var_offset(rate[1]),
1476                 .help   = "Set bandwidth rate",
1477         },
1478         {
1479                 .name   = "ratemin",
1480                 .type   = FIO_OPT_INT,
1481                 .off1   = td_var_offset(ratemin[0]),
1482                 .off2   = td_var_offset(ratemin[1]),
1483                 .help   = "Job must meet this rate or it will be shutdown",
1484                 .parent = "rate",
1485         },
1486         {
1487                 .name   = "rate_iops",
1488                 .type   = FIO_OPT_INT,
1489                 .off1   = td_var_offset(rate_iops[0]),
1490                 .off2   = td_var_offset(rate_iops[1]),
1491                 .help   = "Limit IO used to this number of IO operations/sec",
1492         },
1493         {
1494                 .name   = "rate_iops_min",
1495                 .type   = FIO_OPT_INT,
1496                 .off1   = td_var_offset(rate_iops_min[0]),
1497                 .off2   = td_var_offset(rate_iops_min[1]),
1498                 .help   = "Job must meet this rate or it will be shutdown",
1499                 .parent = "rate_iops",
1500         },
1501         {
1502                 .name   = "ratecycle",
1503                 .type   = FIO_OPT_INT,
1504                 .off1   = td_var_offset(ratecycle),
1505                 .help   = "Window average for rate limits (msec)",
1506                 .def    = "1000",
1507                 .parent = "rate",
1508         },
1509         {
1510                 .name   = "invalidate",
1511                 .type   = FIO_OPT_BOOL,
1512                 .off1   = td_var_offset(invalidate_cache),
1513                 .help   = "Invalidate buffer/page cache prior to running job",
1514                 .def    = "1",
1515         },
1516         {
1517                 .name   = "sync",
1518                 .type   = FIO_OPT_BOOL,
1519                 .off1   = td_var_offset(sync_io),
1520                 .help   = "Use O_SYNC for buffered writes",
1521                 .def    = "0",
1522                 .parent = "buffered",
1523         },
1524         {
1525                 .name   = "bwavgtime",
1526                 .type   = FIO_OPT_INT,
1527                 .off1   = td_var_offset(bw_avg_time),
1528                 .help   = "Time window over which to calculate bandwidth"
1529                           " (msec)",
1530                 .def    = "500",
1531         },
1532         {
1533                 .name   = "create_serialize",
1534                 .type   = FIO_OPT_BOOL,
1535                 .off1   = td_var_offset(create_serialize),
1536                 .help   = "Serialize creating of job files",
1537                 .def    = "1",
1538         },
1539         {
1540                 .name   = "create_fsync",
1541                 .type   = FIO_OPT_BOOL,
1542                 .off1   = td_var_offset(create_fsync),
1543                 .help   = "Fsync file after creation",
1544                 .def    = "1",
1545         },
1546         {
1547                 .name   = "create_on_open",
1548                 .type   = FIO_OPT_BOOL,
1549                 .off1   = td_var_offset(create_on_open),
1550                 .help   = "Create files when they are opened for IO",
1551                 .def    = "0",
1552         },
1553         {
1554                 .name   = "pre_read",
1555                 .type   = FIO_OPT_BOOL,
1556                 .off1   = td_var_offset(pre_read),
1557                 .help   = "Preread files before starting official testing",
1558                 .def    = "0",
1559         },
1560         {
1561                 .name   = "cpuload",
1562                 .type   = FIO_OPT_INT,
1563                 .off1   = td_var_offset(cpuload),
1564                 .help   = "Use this percentage of CPU",
1565         },
1566         {
1567                 .name   = "cpuchunks",
1568                 .type   = FIO_OPT_INT,
1569                 .off1   = td_var_offset(cpucycle),
1570                 .help   = "Length of the CPU burn cycles (usecs)",
1571                 .def    = "50000",
1572                 .parent = "cpuload",
1573         },
1574 #ifdef FIO_HAVE_CPU_AFFINITY
1575         {
1576                 .name   = "cpumask",
1577                 .type   = FIO_OPT_INT,
1578                 .cb     = str_cpumask_cb,
1579                 .help   = "CPU affinity mask",
1580         },
1581         {
1582                 .name   = "cpus_allowed",
1583                 .type   = FIO_OPT_STR,
1584                 .cb     = str_cpus_allowed_cb,
1585                 .help   = "Set CPUs allowed",
1586         },
1587 #endif
1588         {
1589                 .name   = "end_fsync",
1590                 .type   = FIO_OPT_BOOL,
1591                 .off1   = td_var_offset(end_fsync),
1592                 .help   = "Include fsync at the end of job",
1593                 .def    = "0",
1594         },
1595         {
1596                 .name   = "fsync_on_close",
1597                 .type   = FIO_OPT_BOOL,
1598                 .off1   = td_var_offset(fsync_on_close),
1599                 .help   = "fsync files on close",
1600                 .def    = "0",
1601         },
1602         {
1603                 .name   = "unlink",
1604                 .type   = FIO_OPT_BOOL,
1605                 .off1   = td_var_offset(unlink),
1606                 .help   = "Unlink created files after job has completed",
1607                 .def    = "0",
1608         },
1609         {
1610                 .name   = "exitall",
1611                 .type   = FIO_OPT_STR_SET,
1612                 .cb     = str_exitall_cb,
1613                 .help   = "Terminate all jobs when one exits",
1614         },
1615         {
1616                 .name   = "stonewall",
1617                 .type   = FIO_OPT_STR_SET,
1618                 .off1   = td_var_offset(stonewall),
1619                 .help   = "Insert a hard barrier between this job and previous",
1620         },
1621         {
1622                 .name   = "new_group",
1623                 .type   = FIO_OPT_STR_SET,
1624                 .off1   = td_var_offset(new_group),
1625                 .help   = "Mark the start of a new group (for reporting)",
1626         },
1627         {
1628                 .name   = "thread",
1629                 .type   = FIO_OPT_STR_SET,
1630                 .off1   = td_var_offset(use_thread),
1631                 .help   = "Use threads instead of forks",
1632         },
1633         {
1634                 .name   = "write_bw_log",
1635                 .type   = FIO_OPT_STR,
1636                 .off1   = td_var_offset(write_bw_log),
1637                 .cb     = str_write_bw_log_cb,
1638                 .help   = "Write log of bandwidth during run",
1639         },
1640         {
1641                 .name   = "write_lat_log",
1642                 .type   = FIO_OPT_STR,
1643                 .off1   = td_var_offset(write_lat_log),
1644                 .cb     = str_write_lat_log_cb,
1645                 .help   = "Write log of latency during run",
1646         },
1647         {
1648                 .name   = "hugepage-size",
1649                 .type   = FIO_OPT_INT,
1650                 .off1   = td_var_offset(hugepage_size),
1651                 .help   = "When using hugepages, specify size of each page",
1652                 .def    = __stringify(FIO_HUGE_PAGE),
1653         },
1654         {
1655                 .name   = "group_reporting",
1656                 .type   = FIO_OPT_STR_SET,
1657                 .off1   = td_var_offset(group_reporting),
1658                 .help   = "Do reporting on a per-group basis",
1659         },
1660         {
1661                 .name   = "zero_buffers",
1662                 .type   = FIO_OPT_STR_SET,
1663                 .off1   = td_var_offset(zero_buffers),
1664                 .help   = "Init IO buffers to all zeroes",
1665         },
1666         {
1667                 .name   = "refill_buffers",
1668                 .type   = FIO_OPT_STR_SET,
1669                 .off1   = td_var_offset(refill_buffers),
1670                 .help   = "Refill IO buffers on every IO submit",
1671         },
1672 #ifdef FIO_HAVE_DISK_UTIL
1673         {
1674                 .name   = "disk_util",
1675                 .type   = FIO_OPT_BOOL,
1676                 .off1   = td_var_offset(do_disk_util),
1677                 .help   = "Log disk utilization statistics",
1678                 .def    = "1",
1679         },
1680 #endif
1681         {
1682                 .name   = "gtod_reduce",
1683                 .type   = FIO_OPT_BOOL,
1684                 .help   = "Greatly reduce number of gettimeofday() calls",
1685                 .cb     = str_gtod_reduce_cb,
1686                 .def    = "0",
1687         },
1688         {
1689                 .name   = "disable_clat",
1690                 .type   = FIO_OPT_BOOL,
1691                 .off1   = td_var_offset(disable_clat),
1692                 .help   = "Disable completion latency numbers",
1693                 .parent = "gtod_reduce",
1694                 .def    = "0",
1695         },
1696         {
1697                 .name   = "disable_slat",
1698                 .type   = FIO_OPT_BOOL,
1699                 .off1   = td_var_offset(disable_slat),
1700                 .help   = "Disable submissionn latency numbers",
1701                 .parent = "gtod_reduce",
1702                 .def    = "0",
1703         },
1704         {
1705                 .name   = "disable_bw_measurement",
1706                 .type   = FIO_OPT_BOOL,
1707                 .off1   = td_var_offset(disable_bw),
1708                 .help   = "Disable bandwidth logging",
1709                 .parent = "gtod_reduce",
1710                 .def    = "0",
1711         },
1712         {
1713                 .name   = "gtod_cpu",
1714                 .type   = FIO_OPT_INT,
1715                 .cb     = str_gtod_cpu_cb,
1716                 .help   = "Setup dedicated gettimeofday() thread on this CPU",
1717                 .verify = gtod_cpu_verify,
1718         },
1719         {
1720                 .name   = "continue_on_error",
1721                 .type   = FIO_OPT_BOOL,
1722                 .off1   = td_var_offset(continue_on_error),
1723                 .help   = "Continue on non-fatal errors during I/O",
1724                 .def    = "0",
1725         },
1726         {
1727                 .name   = "profile",
1728                 .type   = FIO_OPT_STR,
1729                 .off1   = td_var_offset(profile),
1730                 .posval = {
1731                           { .ival = "tiobench",
1732                             .oval = PROFILE_TIOBENCH,
1733                             .help = "Perform tiobench like test",
1734                           },
1735                 },
1736                 .help   = "Select a specific builtin performance test",
1737         },
1738         {
1739                 .name   = "cgroup",
1740                 .type   = FIO_OPT_STR_STORE,
1741                 .off1   = td_var_offset(cgroup),
1742                 .help   = "Add job to cgroup of this name",
1743         },
1744         {
1745                 .name   = "cgroup_weight",
1746                 .type   = FIO_OPT_INT,
1747                 .off1   = td_var_offset(cgroup_weight),
1748                 .help   = "Use given weight for cgroup",
1749                 .minval = 100,
1750                 .maxval = 1000,
1751         },
1752         {
1753                 .name   = "uid",
1754                 .type   = FIO_OPT_INT,
1755                 .off1   = td_var_offset(uid),
1756                 .help   = "Run job with this user ID",
1757         },
1758         {
1759                 .name   = "gid",
1760                 .type   = FIO_OPT_INT,
1761                 .off1   = td_var_offset(gid),
1762                 .help   = "Run job with this group ID",
1763         },
1764         {
1765                 .name = NULL,
1766         },
1767 };
1768
1769 void fio_options_dup_and_init(struct option *long_options)
1770 {
1771         struct fio_option *o;
1772         unsigned int i;
1773
1774         options_init(options);
1775
1776         i = 0;
1777         while (long_options[i].name)
1778                 i++;
1779
1780         o = &options[0];
1781         while (o->name) {
1782                 long_options[i].name = (char *) o->name;
1783                 long_options[i].val = FIO_GETOPT_JOB;
1784                 if (o->type == FIO_OPT_STR_SET)
1785                         long_options[i].has_arg = no_argument;
1786                 else
1787                         long_options[i].has_arg = required_argument;
1788
1789                 i++;
1790                 o++;
1791                 assert(i < FIO_NR_OPTIONS);
1792         }
1793 }
1794
1795 struct fio_keyword {
1796         const char *word;
1797         const char *desc;
1798         char *replace;
1799 };
1800
1801 static struct fio_keyword fio_keywords[] = {
1802         {
1803                 .word   = "$pagesize",
1804                 .desc   = "Page size in the system",
1805         },
1806         {
1807                 .word   = "$mb_memory",
1808                 .desc   = "Megabytes of memory online",
1809         },
1810         {
1811                 .word   = "$ncpus",
1812                 .desc   = "Number of CPUs online in the system",
1813         },
1814         {
1815                 .word   = NULL,
1816         },
1817 };
1818
1819 void fio_keywords_init(void)
1820 {
1821         unsigned long long mb_memory;
1822         char buf[128];
1823         long l;
1824
1825         sprintf(buf, "%lu", page_size);
1826         fio_keywords[0].replace = strdup(buf);
1827
1828         mb_memory = os_phys_mem() / page_size;
1829         sprintf(buf, "%llu", mb_memory);
1830         fio_keywords[1].replace = strdup(buf);
1831
1832         l = sysconf(_SC_NPROCESSORS_ONLN);
1833         sprintf(buf, "%lu", l);
1834         fio_keywords[2].replace = strdup(buf);
1835 }
1836
1837 #define BC_APP          "bc"
1838
1839 static char *bc_calc(char *str)
1840 {
1841         char *buf, *tmp, opt[80];
1842         FILE *f;
1843         int ret;
1844
1845         /*
1846          * No math, just return string
1847          */
1848         if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
1849             !strchr(str, '/'))
1850                 return str;
1851
1852         /*
1853          * Split option from value, we only need to calculate the value
1854          */
1855         tmp = strchr(str, '=');
1856         if (!tmp)
1857                 return str;
1858
1859         tmp++;
1860         memset(opt, 0, sizeof(opt));
1861         strncpy(opt, str, tmp - str);
1862
1863         buf = malloc(128);
1864
1865         sprintf(buf, "which %s > /dev/null", BC_APP);
1866         if (system(buf)) {
1867                 log_err("fio: bc is needed for performing math\n");
1868                 free(buf);
1869                 return NULL;
1870         }
1871
1872         sprintf(buf, "echo %s | %s", tmp, BC_APP);
1873         f = popen(buf, "r");
1874         if (!f) {
1875                 free(buf);
1876                 return NULL;
1877         }
1878
1879         ret = fread(buf, 1, 128, f);
1880         if (ret <= 0) {
1881                 free(buf);
1882                 return NULL;
1883         }
1884
1885         buf[ret - 1] = '\0';
1886         strcat(opt, buf);
1887         strcpy(buf, opt);
1888         pclose(f);
1889         free(str);
1890         return buf;
1891 }
1892
1893 /*
1894  * Look for reserved variable names and replace them with real values
1895  */
1896 static char *fio_keyword_replace(char *opt)
1897 {
1898         char *s;
1899         int i;
1900
1901         for (i = 0; fio_keywords[i].word != NULL; i++) {
1902                 struct fio_keyword *kw = &fio_keywords[i];
1903
1904                 while ((s = strstr(opt, kw->word)) != NULL) {
1905                         char *new = malloc(strlen(opt) + 1);
1906                         char *o_org = opt;
1907                         int olen = s - opt;
1908                         int len;
1909
1910                         /*
1911                          * Copy part of the string before the keyword and
1912                          * sprintf() the replacement after it.
1913                          */
1914                         memcpy(new, opt, olen);
1915                         len = sprintf(new + olen, "%s", kw->replace);
1916
1917                         /*
1918                          * If there's more in the original string, copy that
1919                          * in too
1920                          */
1921                         opt += strlen(kw->word) + olen;
1922                         if (strlen(opt))
1923                                 memcpy(new + olen + len, opt, opt - o_org - 1);
1924
1925                         /*
1926                          * replace opt and free the old opt
1927                          */
1928                         opt = new;
1929                         //free(o_org);
1930
1931                         /*
1932                          * Check for potential math and invoke bc, if possible
1933                          */
1934                         opt = bc_calc(opt);
1935                 }
1936         }
1937
1938         return opt;
1939 }
1940
1941 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
1942 {
1943         int i, ret;
1944
1945         sort_options(opts, options, num_opts);
1946
1947         for (ret = 0, i = 0; i < num_opts; i++) {
1948                 opts[i] = fio_keyword_replace(opts[i]);
1949                 ret |= parse_option(opts[i], options, td);
1950         }
1951
1952         return ret;
1953 }
1954
1955 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1956 {
1957         return parse_cmd_option(opt, val, options, td);
1958 }
1959
1960 void fio_fill_default_options(struct thread_data *td)
1961 {
1962         fill_default_options(td, options);
1963 }
1964
1965 int fio_show_option_help(const char *opt)
1966 {
1967         return show_cmd_help(options, opt);
1968 }
1969
1970 static void __options_mem(struct thread_data *td, int alloc)
1971 {
1972         struct thread_options *o = &td->o;
1973         struct fio_option *opt;
1974         char **ptr;
1975         int i;
1976
1977         for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1978                 if (opt->type != FIO_OPT_STR_STORE)
1979                         continue;
1980
1981                 ptr = (void *) o + opt->off1;
1982                 if (*ptr) {
1983                         if (alloc)
1984                                 *ptr = strdup(*ptr);
1985                         else {
1986                                 free(*ptr);
1987                                 *ptr = NULL;
1988                         }
1989                 }
1990         }
1991 }
1992
1993 /*
1994  * dupe FIO_OPT_STR_STORE options
1995  */
1996 void options_mem_dupe(struct thread_data *td)
1997 {
1998         __options_mem(td, 1);
1999 }
2000
2001 void options_mem_free(struct thread_data fio_unused *td)
2002 {
2003 #if 0
2004         __options_mem(td, 0);
2005 #endif
2006 }
2007
2008 unsigned int fio_get_kb_base(void *data)
2009 {
2010         struct thread_data *td = data;
2011         unsigned int kb_base = 0;
2012
2013         if (td)
2014                 kb_base = td->o.kb_base;
2015         if (!kb_base)
2016                 kb_base = 1024;
2017
2018         return kb_base;
2019 }