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