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