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