projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Add Hygon SoC support to enable tsc_reliable feature
[fio.git] / options.c
... / ...
CommitLineData
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 <sys/stat.h>
8#include <netinet/in.h>
9
10#include "fio.h"
11#include "verify.h"
12#include "parse.h"
13#include "lib/pattern.h"
14#include "options.h"
15#include "optgroup.h"
16
17char client_sockaddr_str[INET6_ADDRSTRLEN] = { 0 };
18
19#define cb_data_to_td(data) container_of(data, struct thread_data, o)
20
21static struct pattern_fmt_desc fmt_desc[] = {
22 {
23 .fmt = "%o",
24 .len = FIELD_SIZE(struct io_u *, offset),
25 .paste = paste_blockoff
26 }
27};
28
29/*
30 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
31 */
32static char *get_opt_postfix(const char *str)
33{
34 char *p = strstr(str, ":");
35
36 if (!p)
37 return NULL;
38
39 p++;
40 strip_blank_front(&p);
41 strip_blank_end(p);
42 return strdup(p);
43}
44
45static int bs_cmp(const void *p1, const void *p2)
46{
47 const struct bssplit *bsp1 = p1;
48 const struct bssplit *bsp2 = p2;
49
50 return (int) bsp1->perc - (int) bsp2->perc;
51}
52
53struct split {
54 unsigned int nr;
55 unsigned long long val1[ZONESPLIT_MAX];
56 unsigned long long val2[ZONESPLIT_MAX];
57};
58
59static int split_parse_ddir(struct thread_options *o, struct split *split,
60 char *str, bool absolute, unsigned int max_splits)
61{
62 unsigned long long perc;
63 unsigned int i;
64 long long val;
65 char *fname;
66
67 split->nr = 0;
68
69 i = 0;
70 while ((fname = strsep(&str, ":")) != NULL) {
71 char *perc_str;
72
73 if (!strlen(fname))
74 break;
75
76 perc_str = strstr(fname, "/");
77 if (perc_str) {
78 *perc_str = '\0';
79 perc_str++;
80 if (absolute) {
81 if (str_to_decimal(perc_str, &val, 1, o, 0, 0)) {
82 log_err("fio: split conversion failed\n");
83 return 1;
84 }
85 perc = val;
86 } else {
87 perc = atoi(perc_str);
88 if (perc > 100)
89 perc = 100;
90 else if (!perc)
91 perc = -1U;
92 }
93 } else {
94 if (absolute)
95 perc = 0;
96 else
97 perc = -1U;
98 }
99
100 if (str_to_decimal(fname, &val, 1, o, 0, 0)) {
101 log_err("fio: split conversion failed\n");
102 return 1;
103 }
104
105 split->val1[i] = val;
106 split->val2[i] = perc;
107 i++;
108 if (i == max_splits) {
109 log_err("fio: hit max of %d split entries\n", i);
110 break;
111 }
112 }
113
114 split->nr = i;
115 return 0;
116}
117
118static int bssplit_ddir(struct thread_options *o, enum fio_ddir ddir, char *str,
119 bool data)
120{
121 unsigned int i, perc, perc_missing;
122 unsigned long long max_bs, min_bs;
123 struct split split;
124
125 memset(&split, 0, sizeof(split));
126
127 if (split_parse_ddir(o, &split, str, data, BSSPLIT_MAX))
128 return 1;
129 if (!split.nr)
130 return 0;
131
132 max_bs = 0;
133 min_bs = -1;
134 o->bssplit[ddir] = malloc(split.nr * sizeof(struct bssplit));
135 o->bssplit_nr[ddir] = split.nr;
136 for (i = 0; i < split.nr; i++) {
137 if (split.val1[i] > max_bs)
138 max_bs = split.val1[i];
139 if (split.val1[i] < min_bs)
140 min_bs = split.val1[i];
141
142 o->bssplit[ddir][i].bs = split.val1[i];
143 o->bssplit[ddir][i].perc =split.val2[i];
144 }
145
146 /*
147 * Now check if the percentages add up, and how much is missing
148 */
149 perc = perc_missing = 0;
150 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
151 struct bssplit *bsp = &o->bssplit[ddir][i];
152
153 if (bsp->perc == -1U)
154 perc_missing++;
155 else
156 perc += bsp->perc;
157 }
158
159 if (perc > 100 && perc_missing > 1) {
160 log_err("fio: bssplit percentages add to more than 100%%\n");
161 free(o->bssplit[ddir]);
162 o->bssplit[ddir] = NULL;
163 return 1;
164 }
165
166 /*
167 * If values didn't have a percentage set, divide the remains between
168 * them.
169 */
170 if (perc_missing) {
171 if (perc_missing == 1 && o->bssplit_nr[ddir] == 1)
172 perc = 100;
173 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
174 struct bssplit *bsp = &o->bssplit[ddir][i];
175
176 if (bsp->perc == -1U)
177 bsp->perc = (100 - perc) / perc_missing;
178 }
179 }
180
181 o->min_bs[ddir] = min_bs;
182 o->max_bs[ddir] = max_bs;
183
184 /*
185 * now sort based on percentages, for ease of lookup
186 */
187 qsort(o->bssplit[ddir], o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
188 return 0;
189}
190
191typedef int (split_parse_fn)(struct thread_options *, enum fio_ddir, char *, bool);
192
193static int str_split_parse(struct thread_data *td, char *str,
194 split_parse_fn *fn, bool data)
195{
196 char *odir, *ddir;
197 int ret = 0;
198
199 odir = strchr(str, ',');
200 if (odir) {
201 ddir = strchr(odir + 1, ',');
202 if (ddir) {
203 ret = fn(&td->o, DDIR_TRIM, ddir + 1, data);
204 if (!ret)
205 *ddir = '\0';
206 } else {
207 char *op;
208
209 op = strdup(odir + 1);
210 ret = fn(&td->o, DDIR_TRIM, op, data);
211
212 free(op);
213 }
214 if (!ret)
215 ret = fn(&td->o, DDIR_WRITE, odir + 1, data);
216 if (!ret) {
217 *odir = '\0';
218 ret = fn(&td->o, DDIR_READ, str, data);
219 }
220 } else {
221 char *op;
222
223 op = strdup(str);
224 ret = fn(&td->o, DDIR_WRITE, op, data);
225 free(op);
226
227 if (!ret) {
228 op = strdup(str);
229 ret = fn(&td->o, DDIR_TRIM, op, data);
230 free(op);
231 }
232 if (!ret)
233 ret = fn(&td->o, DDIR_READ, str, data);
234 }
235
236 return ret;
237}
238
239static int str_bssplit_cb(void *data, const char *input)
240{
241 struct thread_data *td = cb_data_to_td(data);
242 char *str, *p;
243 int ret = 0;
244
245 p = str = strdup(input);
246
247 strip_blank_front(&str);
248 strip_blank_end(str);
249
250 ret = str_split_parse(td, str, bssplit_ddir, false);
251
252 if (parse_dryrun()) {
253 int i;
254
255 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
256 free(td->o.bssplit[i]);
257 td->o.bssplit[i] = NULL;
258 td->o.bssplit_nr[i] = 0;
259 }
260 }
261
262 free(p);
263 return ret;
264}
265
266static int str2error(char *str)
267{
268 const char *err[] = { "EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
269 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
270 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
271 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
272 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
273 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
274 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
275 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE" };
276 int i = 0, num = sizeof(err) / sizeof(char *);
277
278 while (i < num) {
279 if (!strcmp(err[i], str))
280 return i + 1;
281 i++;
282 }
283 return 0;
284}
285
286static int ignore_error_type(struct thread_data *td, enum error_type_bit etype,
287 char *str)
288{
289 unsigned int i;
290 int *error;
291 char *fname;
292
293 if (etype >= ERROR_TYPE_CNT) {
294 log_err("Illegal error type\n");
295 return 1;
296 }
297
298 td->o.ignore_error_nr[etype] = 4;
299 error = calloc(4, sizeof(int));
300
301 i = 0;
302 while ((fname = strsep(&str, ":")) != NULL) {
303
304 if (!strlen(fname))
305 break;
306
307 /*
308 * grow struct buffer, if needed
309 */
310 if (i == td->o.ignore_error_nr[etype]) {
311 td->o.ignore_error_nr[etype] <<= 1;
312 error = realloc(error, td->o.ignore_error_nr[etype]
313 * sizeof(int));
314 }
315 if (fname[0] == 'E') {
316 error[i] = str2error(fname);
317 } else {
318 error[i] = atoi(fname);
319 if (error[i] < 0)
320 error[i] = -error[i];
321 }
322 if (!error[i]) {
323 log_err("Unknown error %s, please use number value\n",
324 fname);
325 td->o.ignore_error_nr[etype] = 0;
326 free(error);
327 return 1;
328 }
329 i++;
330 }
331 if (i) {
332 td->o.continue_on_error |= 1 << etype;
333 td->o.ignore_error_nr[etype] = i;
334 td->o.ignore_error[etype] = error;
335 } else {
336 td->o.ignore_error_nr[etype] = 0;
337 free(error);
338 }
339
340 return 0;
341
342}
343
344static int str_replay_skip_cb(void *data, const char *input)
345{
346 struct thread_data *td = cb_data_to_td(data);
347 char *str, *p, *n;
348 int ret = 0;
349
350 if (parse_dryrun())
351 return 0;
352
353 p = str = strdup(input);
354
355 strip_blank_front(&str);
356 strip_blank_end(str);
357
358 while (p) {
359 n = strchr(p, ',');
360 if (n)
361 *n++ = '\0';
362 if (!strcmp(p, "read"))
363 td->o.replay_skip |= 1u << DDIR_READ;
364 else if (!strcmp(p, "write"))
365 td->o.replay_skip |= 1u << DDIR_WRITE;
366 else if (!strcmp(p, "trim"))
367 td->o.replay_skip |= 1u << DDIR_TRIM;
368 else if (!strcmp(p, "sync"))
369 td->o.replay_skip |= 1u << DDIR_SYNC;
370 else {
371 log_err("Unknown skip type: %s\n", p);
372 ret = 1;
373 break;
374 }
375 p = n;
376 }
377 free(str);
378 return ret;
379}
380
381static int str_ignore_error_cb(void *data, const char *input)
382{
383 struct thread_data *td = cb_data_to_td(data);
384 char *str, *p, *n;
385 int ret = 1;
386 enum error_type_bit type = 0;
387
388 if (parse_dryrun())
389 return 0;
390
391 p = str = strdup(input);
392
393 strip_blank_front(&str);
394 strip_blank_end(str);
395
396 while (p) {
397 n = strchr(p, ',');
398 if (n)
399 *n++ = '\0';
400 ret = ignore_error_type(td, type, p);
401 if (ret)
402 break;
403 p = n;
404 type++;
405 }
406 free(str);
407 return ret;
408}
409
410static int str_rw_cb(void *data, const char *str)
411{
412 struct thread_data *td = cb_data_to_td(data);
413 struct thread_options *o = &td->o;
414 char *nr;
415
416 if (parse_dryrun())
417 return 0;
418
419 o->ddir_seq_nr = 1;
420 o->ddir_seq_add = 0;
421
422 nr = get_opt_postfix(str);
423 if (!nr)
424 return 0;
425
426 if (td_random(td))
427 o->ddir_seq_nr = atoi(nr);
428 else {
429 long long val;
430
431 if (str_to_decimal(nr, &val, 1, o, 0, 0)) {
432 log_err("fio: rw postfix parsing failed\n");
433 free(nr);
434 return 1;
435 }
436
437 o->ddir_seq_add = val;
438 }
439
440 free(nr);
441 return 0;
442}
443
444static int str_mem_cb(void *data, const char *mem)
445{
446 struct thread_data *td = cb_data_to_td(data);
447
448 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP ||
449 td->o.mem_type == MEM_MMAPSHARED)
450 td->o.mmapfile = get_opt_postfix(mem);
451
452 return 0;
453}
454
455static int fio_clock_source_cb(void *data, const char *str)
456{
457 struct thread_data *td = cb_data_to_td(data);
458
459 fio_clock_source = td->o.clocksource;
460 fio_clock_source_set = 1;
461 fio_clock_init();
462 return 0;
463}
464
465static int str_rwmix_read_cb(void *data, unsigned long long *val)
466{
467 struct thread_data *td = cb_data_to_td(data);
468
469 td->o.rwmix[DDIR_READ] = *val;
470 td->o.rwmix[DDIR_WRITE] = 100 - *val;
471 return 0;
472}
473
474static int str_rwmix_write_cb(void *data, unsigned long long *val)
475{
476 struct thread_data *td = cb_data_to_td(data);
477
478 td->o.rwmix[DDIR_WRITE] = *val;
479 td->o.rwmix[DDIR_READ] = 100 - *val;
480 return 0;
481}
482
483static int str_exitall_cb(void)
484{
485 exitall_on_terminate = true;
486 return 0;
487}
488
489#ifdef FIO_HAVE_CPU_AFFINITY
490int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
491{
492 unsigned int i, index, cpus_in_mask;
493 const long max_cpu = cpus_online();
494
495 cpus_in_mask = fio_cpu_count(mask);
496 cpu_index = cpu_index % cpus_in_mask;
497
498 index = 0;
499 for (i = 0; i < max_cpu; i++) {
500 if (!fio_cpu_isset(mask, i))
501 continue;
502
503 if (cpu_index != index)
504 fio_cpu_clear(mask, i);
505
506 index++;
507 }
508
509 return fio_cpu_count(mask);
510}
511
512static int str_cpumask_cb(void *data, unsigned long long *val)
513{
514 struct thread_data *td = cb_data_to_td(data);
515 unsigned int i;
516 long max_cpu;
517 int ret;
518
519 if (parse_dryrun())
520 return 0;
521
522 ret = fio_cpuset_init(&td->o.cpumask);
523 if (ret < 0) {
524 log_err("fio: cpuset_init failed\n");
525 td_verror(td, ret, "fio_cpuset_init");
526 return 1;
527 }
528
529 max_cpu = cpus_online();
530
531 for (i = 0; i < sizeof(int) * 8; i++) {
532 if ((1 << i) & *val) {
533 if (i >= max_cpu) {
534 log_err("fio: CPU %d too large (max=%ld)\n", i,
535 max_cpu - 1);
536 return 1;
537 }
538 dprint(FD_PARSE, "set cpu allowed %d\n", i);
539 fio_cpu_set(&td->o.cpumask, i);
540 }
541 }
542
543 return 0;
544}
545
546static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
547 const char *input)
548{
549 char *cpu, *str, *p;
550 long max_cpu;
551 int ret = 0;
552
553 ret = fio_cpuset_init(mask);
554 if (ret < 0) {
555 log_err("fio: cpuset_init failed\n");
556 td_verror(td, ret, "fio_cpuset_init");
557 return 1;
558 }
559
560 p = str = strdup(input);
561
562 strip_blank_front(&str);
563 strip_blank_end(str);
564
565 max_cpu = cpus_online();
566
567 while ((cpu = strsep(&str, ",")) != NULL) {
568 char *str2, *cpu2;
569 int icpu, icpu2;
570
571 if (!strlen(cpu))
572 break;
573
574 str2 = cpu;
575 icpu2 = -1;
576 while ((cpu2 = strsep(&str2, "-")) != NULL) {
577 if (!strlen(cpu2))
578 break;
579
580 icpu2 = atoi(cpu2);
581 }
582
583 icpu = atoi(cpu);
584 if (icpu2 == -1)
585 icpu2 = icpu;
586 while (icpu <= icpu2) {
587 if (icpu >= FIO_MAX_CPUS) {
588 log_err("fio: your OS only supports up to"
589 " %d CPUs\n", (int) FIO_MAX_CPUS);
590 ret = 1;
591 break;
592 }
593 if (icpu >= max_cpu) {
594 log_err("fio: CPU %d too large (max=%ld)\n",
595 icpu, max_cpu - 1);
596 ret = 1;
597 break;
598 }
599
600 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
601 fio_cpu_set(mask, icpu);
602 icpu++;
603 }
604 if (ret)
605 break;
606 }
607
608 free(p);
609 return ret;
610}
611
612static int str_cpus_allowed_cb(void *data, const char *input)
613{
614 struct thread_data *td = cb_data_to_td(data);
615
616 if (parse_dryrun())
617 return 0;
618
619 return set_cpus_allowed(td, &td->o.cpumask, input);
620}
621
622static int str_verify_cpus_allowed_cb(void *data, const char *input)
623{
624 struct thread_data *td = cb_data_to_td(data);
625
626 if (parse_dryrun())
627 return 0;
628
629 return set_cpus_allowed(td, &td->o.verify_cpumask, input);
630}
631
632#ifdef CONFIG_ZLIB
633static int str_log_cpus_allowed_cb(void *data, const char *input)
634{
635 struct thread_data *td = cb_data_to_td(data);
636
637 if (parse_dryrun())
638 return 0;
639
640 return set_cpus_allowed(td, &td->o.log_gz_cpumask, input);
641}
642#endif /* CONFIG_ZLIB */
643
644#endif /* FIO_HAVE_CPU_AFFINITY */
645
646#ifdef CONFIG_LIBNUMA
647static int str_numa_cpunodes_cb(void *data, char *input)
648{
649 struct thread_data *td = cb_data_to_td(data);
650 struct bitmask *verify_bitmask;
651
652 if (parse_dryrun())
653 return 0;
654
655 /* numa_parse_nodestring() parses a character string list
656 * of nodes into a bit mask. The bit mask is allocated by
657 * numa_allocate_nodemask(), so it should be freed by
658 * numa_free_nodemask().
659 */
660 verify_bitmask = numa_parse_nodestring(input);
661 if (verify_bitmask == NULL) {
662 log_err("fio: numa_parse_nodestring failed\n");
663 td_verror(td, 1, "str_numa_cpunodes_cb");
664 return 1;
665 }
666 numa_free_nodemask(verify_bitmask);
667
668 td->o.numa_cpunodes = strdup(input);
669 return 0;
670}
671
672static int str_numa_mpol_cb(void *data, char *input)
673{
674 struct thread_data *td = cb_data_to_td(data);
675 const char * const policy_types[] =
676 { "default", "prefer", "bind", "interleave", "local", NULL };
677 int i;
678 char *nodelist;
679 struct bitmask *verify_bitmask;
680
681 if (parse_dryrun())
682 return 0;
683
684 nodelist = strchr(input, ':');
685 if (nodelist) {
686 /* NUL-terminate mode */
687 *nodelist++ = '\0';
688 }
689
690 for (i = 0; i <= MPOL_LOCAL; i++) {
691 if (!strcmp(input, policy_types[i])) {
692 td->o.numa_mem_mode = i;
693 break;
694 }
695 }
696 if (i > MPOL_LOCAL) {
697 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
698 goto out;
699 }
700
701 switch (td->o.numa_mem_mode) {
702 case MPOL_PREFERRED:
703 /*
704 * Insist on a nodelist of one node only
705 */
706 if (nodelist) {
707 char *rest = nodelist;
708 while (isdigit(*rest))
709 rest++;
710 if (*rest) {
711 log_err("fio: one node only for \'prefer\'\n");
712 goto out;
713 }
714 } else {
715 log_err("fio: one node is needed for \'prefer\'\n");
716 goto out;
717 }
718 break;
719 case MPOL_INTERLEAVE:
720 /*
721 * Default to online nodes with memory if no nodelist
722 */
723 if (!nodelist)
724 nodelist = strdup("all");
725 break;
726 case MPOL_LOCAL:
727 case MPOL_DEFAULT:
728 /*
729 * Don't allow a nodelist
730 */
731 if (nodelist) {
732 log_err("fio: NO nodelist for \'local\'\n");
733 goto out;
734 }
735 break;
736 case MPOL_BIND:
737 /*
738 * Insist on a nodelist
739 */
740 if (!nodelist) {
741 log_err("fio: a nodelist is needed for \'bind\'\n");
742 goto out;
743 }
744 break;
745 }
746
747
748 /* numa_parse_nodestring() parses a character string list
749 * of nodes into a bit mask. The bit mask is allocated by
750 * numa_allocate_nodemask(), so it should be freed by
751 * numa_free_nodemask().
752 */
753 switch (td->o.numa_mem_mode) {
754 case MPOL_PREFERRED:
755 td->o.numa_mem_prefer_node = atoi(nodelist);
756 break;
757 case MPOL_INTERLEAVE:
758 case MPOL_BIND:
759 verify_bitmask = numa_parse_nodestring(nodelist);
760 if (verify_bitmask == NULL) {
761 log_err("fio: numa_parse_nodestring failed\n");
762 td_verror(td, 1, "str_numa_memnodes_cb");
763 return 1;
764 }
765 td->o.numa_memnodes = strdup(nodelist);
766 numa_free_nodemask(verify_bitmask);
767
768 break;
769 case MPOL_LOCAL:
770 case MPOL_DEFAULT:
771 default:
772 break;
773 }
774
775 return 0;
776out:
777 return 1;
778}
779#endif
780
781static int str_fst_cb(void *data, const char *str)
782{
783 struct thread_data *td = cb_data_to_td(data);
784 double val;
785 bool done = false;
786 char *nr;
787
788 td->file_service_nr = 1;
789
790 switch (td->o.file_service_type) {
791 case FIO_FSERVICE_RANDOM:
792 case FIO_FSERVICE_RR:
793 case FIO_FSERVICE_SEQ:
794 nr = get_opt_postfix(str);
795 if (nr) {
796 td->file_service_nr = atoi(nr);
797 free(nr);
798 }
799 done = true;
800 break;
801 case FIO_FSERVICE_ZIPF:
802 val = FIO_DEF_ZIPF;
803 break;
804 case FIO_FSERVICE_PARETO:
805 val = FIO_DEF_PARETO;
806 break;
807 case FIO_FSERVICE_GAUSS:
808 val = 0.0;
809 break;
810 default:
811 log_err("fio: bad file service type: %d\n", td->o.file_service_type);
812 return 1;
813 }
814
815 if (done)
816 return 0;
817
818 nr = get_opt_postfix(str);
819 if (nr && !str_to_float(nr, &val, 0)) {
820 log_err("fio: file service type random postfix parsing failed\n");
821 free(nr);
822 return 1;
823 }
824
825 free(nr);
826
827 switch (td->o.file_service_type) {
828 case FIO_FSERVICE_ZIPF:
829 if (val == 1.00) {
830 log_err("fio: zipf theta must be different than 1.0\n");
831 return 1;
832 }
833 if (parse_dryrun())
834 return 0;
835 td->zipf_theta = val;
836 break;
837 case FIO_FSERVICE_PARETO:
838 if (val <= 0.00 || val >= 1.00) {
839 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
840 return 1;
841 }
842 if (parse_dryrun())
843 return 0;
844 td->pareto_h = val;
845 break;
846 case FIO_FSERVICE_GAUSS:
847 if (val < 0.00 || val >= 100.00) {
848 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
849 return 1;
850 }
851 if (parse_dryrun())
852 return 0;
853 td->gauss_dev = val;
854 break;
855 }
856
857 return 0;
858}
859
860#ifdef CONFIG_SYNC_FILE_RANGE
861static int str_sfr_cb(void *data, const char *str)
862{
863 struct thread_data *td = cb_data_to_td(data);
864 char *nr = get_opt_postfix(str);
865
866 td->sync_file_range_nr = 1;
867 if (nr) {
868 td->sync_file_range_nr = atoi(nr);
869 free(nr);
870 }
871
872 return 0;
873}
874#endif
875
876static int zone_split_ddir(struct thread_options *o, enum fio_ddir ddir,
877 char *str, bool absolute)
878{
879 unsigned int i, perc, perc_missing, sperc, sperc_missing;
880 struct split split;
881
882 memset(&split, 0, sizeof(split));
883
884 if (split_parse_ddir(o, &split, str, absolute, ZONESPLIT_MAX))
885 return 1;
886 if (!split.nr)
887 return 0;
888
889 o->zone_split[ddir] = malloc(split.nr * sizeof(struct zone_split));
890 o->zone_split_nr[ddir] = split.nr;
891 for (i = 0; i < split.nr; i++) {
892 o->zone_split[ddir][i].access_perc = split.val1[i];
893 if (absolute)
894 o->zone_split[ddir][i].size = split.val2[i];
895 else
896 o->zone_split[ddir][i].size_perc = split.val2[i];
897 }
898
899 /*
900 * Now check if the percentages add up, and how much is missing
901 */
902 perc = perc_missing = 0;
903 sperc = sperc_missing = 0;
904 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
905 struct zone_split *zsp = &o->zone_split[ddir][i];
906
907 if (zsp->access_perc == (uint8_t) -1U)
908 perc_missing++;
909 else
910 perc += zsp->access_perc;
911
912 if (!absolute) {
913 if (zsp->size_perc == (uint8_t) -1U)
914 sperc_missing++;
915 else
916 sperc += zsp->size_perc;
917 }
918 }
919
920 if (perc > 100 || sperc > 100) {
921 log_err("fio: zone_split percentages add to more than 100%%\n");
922 free(o->zone_split[ddir]);
923 o->zone_split[ddir] = NULL;
924 return 1;
925 }
926 if (perc < 100) {
927 log_err("fio: access percentage don't add up to 100 for zoned "
928 "random distribution (got=%u)\n", perc);
929 free(o->zone_split[ddir]);
930 o->zone_split[ddir] = NULL;
931 return 1;
932 }
933
934 /*
935 * If values didn't have a percentage set, divide the remains between
936 * them.
937 */
938 if (perc_missing) {
939 if (perc_missing == 1 && o->zone_split_nr[ddir] == 1)
940 perc = 100;
941 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
942 struct zone_split *zsp = &o->zone_split[ddir][i];
943
944 if (zsp->access_perc == (uint8_t) -1U)
945 zsp->access_perc = (100 - perc) / perc_missing;
946 }
947 }
948 if (sperc_missing) {
949 if (sperc_missing == 1 && o->zone_split_nr[ddir] == 1)
950 sperc = 100;
951 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
952 struct zone_split *zsp = &o->zone_split[ddir][i];
953
954 if (zsp->size_perc == (uint8_t) -1U)
955 zsp->size_perc = (100 - sperc) / sperc_missing;
956 }
957 }
958
959 return 0;
960}
961
962static int parse_zoned_distribution(struct thread_data *td, const char *input,
963 bool absolute)
964{
965 const char *pre = absolute ? "zoned_abs:" : "zoned:";
966 char *str, *p;
967 int i, ret = 0;
968
969 p = str = strdup(input);
970
971 strip_blank_front(&str);
972 strip_blank_end(str);
973
974 /* We expect it to start like that, bail if not */
975 if (strncmp(str, pre, strlen(pre))) {
976 log_err("fio: mismatch in zoned input <%s>\n", str);
977 free(p);
978 return 1;
979 }
980 str += strlen(pre);
981
982 ret = str_split_parse(td, str, zone_split_ddir, absolute);
983
984 free(p);
985
986 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
987 int j;
988
989 dprint(FD_PARSE, "zone ddir %d (nr=%u): \n", i, td->o.zone_split_nr[i]);
990
991 for (j = 0; j < td->o.zone_split_nr[i]; j++) {
992 struct zone_split *zsp = &td->o.zone_split[i][j];
993
994 if (absolute) {
995 dprint(FD_PARSE, "\t%d: %u/%llu\n", j,
996 zsp->access_perc,
997 (unsigned long long) zsp->size);
998 } else {
999 dprint(FD_PARSE, "\t%d: %u/%u\n", j,
1000 zsp->access_perc,
1001 zsp->size_perc);
1002 }
1003 }
1004 }
1005
1006 if (parse_dryrun()) {
1007 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1008 free(td->o.zone_split[i]);
1009 td->o.zone_split[i] = NULL;
1010 td->o.zone_split_nr[i] = 0;
1011 }
1012
1013 return ret;
1014 }
1015
1016 if (ret) {
1017 for (i = 0; i < DDIR_RWDIR_CNT; i++)
1018 td->o.zone_split_nr[i] = 0;
1019 }
1020
1021 return ret;
1022}
1023
1024static int str_random_distribution_cb(void *data, const char *str)
1025{
1026 struct thread_data *td = cb_data_to_td(data);
1027 double val;
1028 char *nr;
1029
1030 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
1031 val = FIO_DEF_ZIPF;
1032 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
1033 val = FIO_DEF_PARETO;
1034 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
1035 val = 0.0;
1036 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED)
1037 return parse_zoned_distribution(td, str, false);
1038 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED_ABS)
1039 return parse_zoned_distribution(td, str, true);
1040 else
1041 return 0;
1042
1043 nr = get_opt_postfix(str);
1044 if (nr && !str_to_float(nr, &val, 0)) {
1045 log_err("fio: random postfix parsing failed\n");
1046 free(nr);
1047 return 1;
1048 }
1049
1050 free(nr);
1051
1052 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
1053 if (val == 1.00) {
1054 log_err("fio: zipf theta must different than 1.0\n");
1055 return 1;
1056 }
1057 if (parse_dryrun())
1058 return 0;
1059 td->o.zipf_theta.u.f = val;
1060 } else if (td->o.random_distribution == FIO_RAND_DIST_PARETO) {
1061 if (val <= 0.00 || val >= 1.00) {
1062 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
1063 return 1;
1064 }
1065 if (parse_dryrun())
1066 return 0;
1067 td->o.pareto_h.u.f = val;
1068 } else {
1069 if (val < 0.00 || val >= 100.0) {
1070 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
1071 return 1;
1072 }
1073 if (parse_dryrun())
1074 return 0;
1075 td->o.gauss_dev.u.f = val;
1076 }
1077
1078 return 0;
1079}
1080
1081static int str_steadystate_cb(void *data, const char *str)
1082{
1083 struct thread_data *td = cb_data_to_td(data);
1084 double val;
1085 char *nr;
1086 char *pct;
1087 long long ll;
1088
1089 if (td->o.ss_state != FIO_SS_IOPS && td->o.ss_state != FIO_SS_IOPS_SLOPE &&
1090 td->o.ss_state != FIO_SS_BW && td->o.ss_state != FIO_SS_BW_SLOPE) {
1091 /* should be impossible to get here */
1092 log_err("fio: unknown steady state criterion\n");
1093 return 1;
1094 }
1095
1096 nr = get_opt_postfix(str);
1097 if (!nr) {
1098 log_err("fio: steadystate threshold must be specified in addition to criterion\n");
1099 free(nr);
1100 return 1;
1101 }
1102
1103 /* ENHANCEMENT Allow fio to understand size=10.2% and use here */
1104 pct = strstr(nr, "%");
1105 if (pct) {
1106 *pct = '\0';
1107 strip_blank_end(nr);
1108 if (!str_to_float(nr, &val, 0)) {
1109 log_err("fio: could not parse steadystate threshold percentage\n");
1110 free(nr);
1111 return 1;
1112 }
1113
1114 dprint(FD_PARSE, "set steady state threshold to %f%%\n", val);
1115 free(nr);
1116 if (parse_dryrun())
1117 return 0;
1118
1119 td->o.ss_state |= FIO_SS_PCT;
1120 td->o.ss_limit.u.f = val;
1121 } else if (td->o.ss_state & FIO_SS_IOPS) {
1122 if (!str_to_float(nr, &val, 0)) {
1123 log_err("fio: steadystate IOPS threshold postfix parsing failed\n");
1124 free(nr);
1125 return 1;
1126 }
1127
1128 dprint(FD_PARSE, "set steady state IOPS threshold to %f\n", val);
1129 free(nr);
1130 if (parse_dryrun())
1131 return 0;
1132
1133 td->o.ss_limit.u.f = val;
1134 } else { /* bandwidth criterion */
1135 if (str_to_decimal(nr, &ll, 1, td, 0, 0)) {
1136 log_err("fio: steadystate BW threshold postfix parsing failed\n");
1137 free(nr);
1138 return 1;
1139 }
1140
1141 dprint(FD_PARSE, "set steady state BW threshold to %lld\n", ll);
1142 free(nr);
1143 if (parse_dryrun())
1144 return 0;
1145
1146 td->o.ss_limit.u.f = (double) ll;
1147 }
1148
1149 td->ss.state = td->o.ss_state;
1150 return 0;
1151}
1152
1153/*
1154 * Return next name in the string. Files are separated with ':'. If the ':'
1155 * is escaped with a '\', then that ':' is part of the filename and does not
1156 * indicate a new file.
1157 */
1158char *get_next_str(char **ptr)
1159{
1160 char *str = *ptr;
1161 char *p, *start;
1162
1163 if (!str || !strlen(str))
1164 return NULL;
1165
1166 start = str;
1167 do {
1168 /*
1169 * No colon, we are done
1170 */
1171 p = strchr(str, ':');
1172 if (!p) {
1173 *ptr = NULL;
1174 break;
1175 }
1176
1177 /*
1178 * We got a colon, but it's the first character. Skip and
1179 * continue
1180 */
1181 if (p == start) {
1182 str = ++start;
1183 continue;
1184 }
1185
1186 if (*(p - 1) != '\\') {
1187 *p = '\0';
1188 *ptr = p + 1;
1189 break;
1190 }
1191
1192 memmove(p - 1, p, strlen(p) + 1);
1193 str = p;
1194 } while (1);
1195
1196 return start;
1197}
1198
1199
1200int get_max_str_idx(char *input)
1201{
1202 unsigned int cur_idx;
1203 char *str, *p;
1204
1205 p = str = strdup(input);
1206 for (cur_idx = 0; ; cur_idx++)
1207 if (get_next_str(&str) == NULL)
1208 break;
1209
1210 free(p);
1211 return cur_idx;
1212}
1213
1214/*
1215 * Returns the directory at the index, indexes > entires will be
1216 * assigned via modulo division of the index
1217 */
1218int set_name_idx(char *target, size_t tlen, char *input, int index,
1219 bool unique_filename)
1220{
1221 unsigned int cur_idx;
1222 int len;
1223 char *fname, *str, *p;
1224
1225 p = str = strdup(input);
1226
1227 index %= get_max_str_idx(input);
1228 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1229 fname = get_next_str(&str);
1230
1231 if (client_sockaddr_str[0] && unique_filename) {
1232 len = snprintf(target, tlen, "%s/%s.", fname,
1233 client_sockaddr_str);
1234 } else
1235 len = snprintf(target, tlen, "%s/", fname);
1236
1237 target[tlen - 1] = '\0';
1238 free(p);
1239
1240 return len;
1241}
1242
1243char* get_name_by_idx(char *input, int index)
1244{
1245 unsigned int cur_idx;
1246 char *fname, *str, *p;
1247
1248 p = str = strdup(input);
1249
1250 index %= get_max_str_idx(input);
1251 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1252 fname = get_next_str(&str);
1253
1254 fname = strdup(fname);
1255 free(p);
1256
1257 return fname;
1258}
1259
1260static int str_filename_cb(void *data, const char *input)
1261{
1262 struct thread_data *td = cb_data_to_td(data);
1263 char *fname, *str, *p;
1264
1265 p = str = strdup(input);
1266
1267 strip_blank_front(&str);
1268 strip_blank_end(str);
1269
1270 /*
1271 * Ignore what we may already have from nrfiles option.
1272 */
1273 if (!td->files_index)
1274 td->o.nr_files = 0;
1275
1276 while ((fname = get_next_str(&str)) != NULL) {
1277 if (!strlen(fname))
1278 break;
1279 add_file(td, fname, 0, 1);
1280 }
1281
1282 free(p);
1283 return 0;
1284}
1285
1286static int str_directory_cb(void *data, const char fio_unused *unused)
1287{
1288 struct thread_data *td = cb_data_to_td(data);
1289 struct stat sb;
1290 char *dirname, *str, *p;
1291 int ret = 0;
1292
1293 if (parse_dryrun())
1294 return 0;
1295
1296 p = str = strdup(td->o.directory);
1297 while ((dirname = get_next_str(&str)) != NULL) {
1298 if (lstat(dirname, &sb) < 0) {
1299 ret = errno;
1300
1301 log_err("fio: %s is not a directory\n", dirname);
1302 td_verror(td, ret, "lstat");
1303 goto out;
1304 }
1305 if (!S_ISDIR(sb.st_mode)) {
1306 log_err("fio: %s is not a directory\n", dirname);
1307 ret = 1;
1308 goto out;
1309 }
1310 }
1311
1312out:
1313 free(p);
1314 return ret;
1315}
1316
1317static int str_opendir_cb(void *data, const char fio_unused *str)
1318{
1319 struct thread_data *td = cb_data_to_td(data);
1320
1321 if (parse_dryrun())
1322 return 0;
1323
1324 if (!td->files_index)
1325 td->o.nr_files = 0;
1326
1327 return add_dir_files(td, td->o.opendir);
1328}
1329
1330static int str_buffer_pattern_cb(void *data, const char *input)
1331{
1332 struct thread_data *td = cb_data_to_td(data);
1333 int ret;
1334
1335 /* FIXME: for now buffer pattern does not support formats */
1336 ret = parse_and_fill_pattern(input, strlen(input), td->o.buffer_pattern,
1337 MAX_PATTERN_SIZE, NULL, 0, NULL, NULL);
1338 if (ret < 0)
1339 return 1;
1340
1341 assert(ret != 0);
1342 td->o.buffer_pattern_bytes = ret;
1343
1344 /*
1345 * If this job is doing any reading or has compression set,
1346 * ensure that we refill buffers for writes or we could be
1347 * invalidating the pattern through reads.
1348 */
1349 if (!td->o.compress_percentage && !td_read(td))
1350 td->o.refill_buffers = 0;
1351 else
1352 td->o.refill_buffers = 1;
1353
1354 td->o.scramble_buffers = 0;
1355 td->o.zero_buffers = 0;
1356
1357 return 0;
1358}
1359
1360static int str_buffer_compress_cb(void *data, unsigned long long *il)
1361{
1362 struct thread_data *td = cb_data_to_td(data);
1363
1364 td->flags |= TD_F_COMPRESS;
1365 td->o.compress_percentage = *il;
1366 return 0;
1367}
1368
1369static int str_dedupe_cb(void *data, unsigned long long *il)
1370{
1371 struct thread_data *td = cb_data_to_td(data);
1372
1373 td->flags |= TD_F_COMPRESS;
1374 td->o.dedupe_percentage = *il;
1375 td->o.refill_buffers = 1;
1376 return 0;
1377}
1378
1379static int str_verify_pattern_cb(void *data, const char *input)
1380{
1381 struct thread_data *td = cb_data_to_td(data);
1382 int ret;
1383
1384 td->o.verify_fmt_sz = ARRAY_SIZE(td->o.verify_fmt);
1385 ret = parse_and_fill_pattern(input, strlen(input), td->o.verify_pattern,
1386 MAX_PATTERN_SIZE, fmt_desc, sizeof(fmt_desc),
1387 td->o.verify_fmt, &td->o.verify_fmt_sz);
1388 if (ret < 0)
1389 return 1;
1390
1391 assert(ret != 0);
1392 td->o.verify_pattern_bytes = ret;
1393 /*
1394 * VERIFY_* could already be set
1395 */
1396 if (!fio_option_is_set(&td->o, verify))
1397 td->o.verify = VERIFY_PATTERN;
1398
1399 return 0;
1400}
1401
1402static int str_gtod_reduce_cb(void *data, int *il)
1403{
1404 struct thread_data *td = cb_data_to_td(data);
1405 int val = *il;
1406
1407 td->o.disable_lat = !!val;
1408 td->o.disable_clat = !!val;
1409 td->o.disable_slat = !!val;
1410 td->o.disable_bw = !!val;
1411 td->o.clat_percentiles = !val;
1412 if (val)
1413 td->ts_cache_mask = 63;
1414
1415 return 0;
1416}
1417
1418static int str_offset_cb(void *data, unsigned long long *__val)
1419{
1420 struct thread_data *td = cb_data_to_td(data);
1421 unsigned long long v = *__val;
1422
1423 if (parse_is_percent(v)) {
1424 td->o.start_offset = 0;
1425 td->o.start_offset_percent = -1ULL - v;
1426 dprint(FD_PARSE, "SET start_offset_percent %d\n",
1427 td->o.start_offset_percent);
1428 } else
1429 td->o.start_offset = v;
1430
1431 return 0;
1432}
1433
1434static int str_size_cb(void *data, unsigned long long *__val)
1435{
1436 struct thread_data *td = cb_data_to_td(data);
1437 unsigned long long v = *__val;
1438
1439 if (parse_is_percent(v)) {
1440 td->o.size = 0;
1441 td->o.size_percent = -1ULL - v;
1442 dprint(FD_PARSE, "SET size_percent %d\n",
1443 td->o.size_percent);
1444 } else
1445 td->o.size = v;
1446
1447 return 0;
1448}
1449
1450static int str_write_bw_log_cb(void *data, const char *str)
1451{
1452 struct thread_data *td = cb_data_to_td(data);
1453
1454 if (str)
1455 td->o.bw_log_file = strdup(str);
1456
1457 td->o.write_bw_log = 1;
1458 return 0;
1459}
1460
1461static int str_write_lat_log_cb(void *data, const char *str)
1462{
1463 struct thread_data *td = cb_data_to_td(data);
1464
1465 if (str)
1466 td->o.lat_log_file = strdup(str);
1467
1468 td->o.write_lat_log = 1;
1469 return 0;
1470}
1471
1472static int str_write_iops_log_cb(void *data, const char *str)
1473{
1474 struct thread_data *td = cb_data_to_td(data);
1475
1476 if (str)
1477 td->o.iops_log_file = strdup(str);
1478
1479 td->o.write_iops_log = 1;
1480 return 0;
1481}
1482
1483static int str_write_hist_log_cb(void *data, const char *str)
1484{
1485 struct thread_data *td = cb_data_to_td(data);
1486
1487 if (str)
1488 td->o.hist_log_file = strdup(str);
1489
1490 td->o.write_hist_log = 1;
1491 return 0;
1492}
1493
1494/*
1495 * str is supposed to be a substring of the strdup'd original string,
1496 * and is valid only if it's a regular file path.
1497 * This function keeps the pointer to the path as needed later.
1498 *
1499 * "external:/path/to/so\0" <- original pointer updated with strdup'd
1500 * "external\0" <- above pointer after parsed, i.e. ->ioengine
1501 * "/path/to/so\0" <- str argument, i.e. ->ioengine_so_path
1502 */
1503static int str_ioengine_external_cb(void *data, const char *str)
1504{
1505 struct thread_data *td = cb_data_to_td(data);
1506 struct stat sb;
1507 char *p;
1508
1509 if (!str) {
1510 log_err("fio: null external ioengine path\n");
1511 return 1;
1512 }
1513
1514 p = (char *)str; /* str is mutable */
1515 strip_blank_front(&p);
1516 strip_blank_end(p);
1517
1518 if (stat(p, &sb) || !S_ISREG(sb.st_mode)) {
1519 log_err("fio: invalid external ioengine path \"%s\"\n", p);
1520 return 1;
1521 }
1522
1523 td->o.ioengine_so_path = p;
1524 return 0;
1525}
1526
1527static int rw_verify(const struct fio_option *o, void *data)
1528{
1529 struct thread_data *td = cb_data_to_td(data);
1530
1531 if (read_only && (td_write(td) || td_trim(td))) {
1532 log_err("fio: job <%s> has write or trim bit set, but"
1533 " fio is in read-only mode\n", td->o.name);
1534 return 1;
1535 }
1536
1537 return 0;
1538}
1539
1540static int gtod_cpu_verify(const struct fio_option *o, void *data)
1541{
1542#ifndef FIO_HAVE_CPU_AFFINITY
1543 struct thread_data *td = cb_data_to_td(data);
1544
1545 if (td->o.gtod_cpu) {
1546 log_err("fio: platform must support CPU affinity for"
1547 "gettimeofday() offloading\n");
1548 return 1;
1549 }
1550#endif
1551
1552 return 0;
1553}
1554
1555/*
1556 * Map of job/command line options
1557 */
1558struct fio_option fio_options[FIO_MAX_OPTS] = {
1559 {
1560 .name = "description",
1561 .lname = "Description of job",
1562 .type = FIO_OPT_STR_STORE,
1563 .off1 = offsetof(struct thread_options, description),
1564 .help = "Text job description",
1565 .category = FIO_OPT_C_GENERAL,
1566 .group = FIO_OPT_G_DESC,
1567 },
1568 {
1569 .name = "name",
1570 .lname = "Job name",
1571 .type = FIO_OPT_STR_STORE,
1572 .off1 = offsetof(struct thread_options, name),
1573 .help = "Name of this job",
1574 .category = FIO_OPT_C_GENERAL,
1575 .group = FIO_OPT_G_DESC,
1576 },
1577 {
1578 .name = "wait_for",
1579 .lname = "Waitee name",
1580 .type = FIO_OPT_STR_STORE,
1581 .off1 = offsetof(struct thread_options, wait_for),
1582 .help = "Name of the job this one wants to wait for before starting",
1583 .category = FIO_OPT_C_GENERAL,
1584 .group = FIO_OPT_G_DESC,
1585 },
1586 {
1587 .name = "filename",
1588 .lname = "Filename(s)",
1589 .type = FIO_OPT_STR_STORE,
1590 .off1 = offsetof(struct thread_options, filename),
1591 .cb = str_filename_cb,
1592 .prio = -1, /* must come after "directory" */
1593 .help = "File(s) to use for the workload",
1594 .category = FIO_OPT_C_FILE,
1595 .group = FIO_OPT_G_FILENAME,
1596 },
1597 {
1598 .name = "directory",
1599 .lname = "Directory",
1600 .type = FIO_OPT_STR_STORE,
1601 .off1 = offsetof(struct thread_options, directory),
1602 .cb = str_directory_cb,
1603 .help = "Directory to store files in",
1604 .category = FIO_OPT_C_FILE,
1605 .group = FIO_OPT_G_FILENAME,
1606 },
1607 {
1608 .name = "filename_format",
1609 .lname = "Filename Format",
1610 .type = FIO_OPT_STR_STORE,
1611 .off1 = offsetof(struct thread_options, filename_format),
1612 .prio = -1, /* must come after "directory" */
1613 .help = "Override default $jobname.$jobnum.$filenum naming",
1614 .def = "$jobname.$jobnum.$filenum",
1615 .category = FIO_OPT_C_FILE,
1616 .group = FIO_OPT_G_FILENAME,
1617 },
1618 {
1619 .name = "unique_filename",
1620 .lname = "Unique Filename",
1621 .type = FIO_OPT_BOOL,
1622 .off1 = offsetof(struct thread_options, unique_filename),
1623 .help = "For network clients, prefix file with source IP",
1624 .def = "1",
1625 .category = FIO_OPT_C_FILE,
1626 .group = FIO_OPT_G_FILENAME,
1627 },
1628 {
1629 .name = "lockfile",
1630 .lname = "Lockfile",
1631 .type = FIO_OPT_STR,
1632 .off1 = offsetof(struct thread_options, file_lock_mode),
1633 .help = "Lock file when doing IO to it",
1634 .prio = 1,
1635 .parent = "filename",
1636 .hide = 0,
1637 .def = "none",
1638 .category = FIO_OPT_C_FILE,
1639 .group = FIO_OPT_G_FILENAME,
1640 .posval = {
1641 { .ival = "none",
1642 .oval = FILE_LOCK_NONE,
1643 .help = "No file locking",
1644 },
1645 { .ival = "exclusive",
1646 .oval = FILE_LOCK_EXCLUSIVE,
1647 .help = "Exclusive file lock",
1648 },
1649 {
1650 .ival = "readwrite",
1651 .oval = FILE_LOCK_READWRITE,
1652 .help = "Read vs write lock",
1653 },
1654 },
1655 },
1656 {
1657 .name = "opendir",
1658 .lname = "Open directory",
1659 .type = FIO_OPT_STR_STORE,
1660 .off1 = offsetof(struct thread_options, opendir),
1661 .cb = str_opendir_cb,
1662 .help = "Recursively add files from this directory and down",
1663 .category = FIO_OPT_C_FILE,
1664 .group = FIO_OPT_G_FILENAME,
1665 },
1666 {
1667 .name = "rw",
1668 .lname = "Read/write",
1669 .alias = "readwrite",
1670 .type = FIO_OPT_STR,
1671 .cb = str_rw_cb,
1672 .off1 = offsetof(struct thread_options, td_ddir),
1673 .help = "IO direction",
1674 .def = "read",
1675 .verify = rw_verify,
1676 .category = FIO_OPT_C_IO,
1677 .group = FIO_OPT_G_IO_BASIC,
1678 .posval = {
1679 { .ival = "read",
1680 .oval = TD_DDIR_READ,
1681 .help = "Sequential read",
1682 },
1683 { .ival = "write",
1684 .oval = TD_DDIR_WRITE,
1685 .help = "Sequential write",
1686 },
1687 { .ival = "trim",
1688 .oval = TD_DDIR_TRIM,
1689 .help = "Sequential trim",
1690 },
1691 { .ival = "randread",
1692 .oval = TD_DDIR_RANDREAD,
1693 .help = "Random read",
1694 },
1695 { .ival = "randwrite",
1696 .oval = TD_DDIR_RANDWRITE,
1697 .help = "Random write",
1698 },
1699 { .ival = "randtrim",
1700 .oval = TD_DDIR_RANDTRIM,
1701 .help = "Random trim",
1702 },
1703 { .ival = "rw",
1704 .oval = TD_DDIR_RW,
1705 .help = "Sequential read and write mix",
1706 },
1707 { .ival = "readwrite",
1708 .oval = TD_DDIR_RW,
1709 .help = "Sequential read and write mix",
1710 },
1711 { .ival = "randrw",
1712 .oval = TD_DDIR_RANDRW,
1713 .help = "Random read and write mix"
1714 },
1715 { .ival = "trimwrite",
1716 .oval = TD_DDIR_TRIMWRITE,
1717 .help = "Trim and write mix, trims preceding writes"
1718 },
1719 },
1720 },
1721 {
1722 .name = "rw_sequencer",
1723 .lname = "RW Sequencer",
1724 .type = FIO_OPT_STR,
1725 .off1 = offsetof(struct thread_options, rw_seq),
1726 .help = "IO offset generator modifier",
1727 .def = "sequential",
1728 .category = FIO_OPT_C_IO,
1729 .group = FIO_OPT_G_IO_BASIC,
1730 .posval = {
1731 { .ival = "sequential",
1732 .oval = RW_SEQ_SEQ,
1733 .help = "Generate sequential offsets",
1734 },
1735 { .ival = "identical",
1736 .oval = RW_SEQ_IDENT,
1737 .help = "Generate identical offsets",
1738 },
1739 },
1740 },
1741
1742 {
1743 .name = "ioengine",
1744 .lname = "IO Engine",
1745 .type = FIO_OPT_STR_STORE,
1746 .off1 = offsetof(struct thread_options, ioengine),
1747 .help = "IO engine to use",
1748 .def = FIO_PREFERRED_ENGINE,
1749 .category = FIO_OPT_C_IO,
1750 .group = FIO_OPT_G_IO_BASIC,
1751 .posval = {
1752 { .ival = "sync",
1753 .help = "Use read/write",
1754 },
1755 { .ival = "psync",
1756 .help = "Use pread/pwrite",
1757 },
1758 { .ival = "vsync",
1759 .help = "Use readv/writev",
1760 },
1761#ifdef CONFIG_PWRITEV
1762 { .ival = "pvsync",
1763 .help = "Use preadv/pwritev",
1764 },
1765#endif
1766#ifdef FIO_HAVE_PWRITEV2
1767 { .ival = "pvsync2",
1768 .help = "Use preadv2/pwritev2",
1769 },
1770#endif
1771#ifdef CONFIG_LIBAIO
1772 { .ival = "libaio",
1773 .help = "Linux native asynchronous IO",
1774 },
1775#endif
1776#ifdef CONFIG_LIBAIO
1777#ifdef ARCH_HAVE_AIORING
1778 { .ival = "aio-ring",
1779 .help = "Linux native asynchronous IO",
1780 },
1781#endif
1782#endif
1783#ifdef CONFIG_POSIXAIO
1784 { .ival = "posixaio",
1785 .help = "POSIX asynchronous IO",
1786 },
1787#endif
1788#ifdef CONFIG_SOLARISAIO
1789 { .ival = "solarisaio",
1790 .help = "Solaris native asynchronous IO",
1791 },
1792#endif
1793#ifdef CONFIG_WINDOWSAIO
1794 { .ival = "windowsaio",
1795 .help = "Windows native asynchronous IO"
1796 },
1797#endif
1798#ifdef CONFIG_RBD
1799 { .ival = "rbd",
1800 .help = "Rados Block Device asynchronous IO"
1801 },
1802#endif
1803 { .ival = "mmap",
1804 .help = "Memory mapped IO"
1805 },
1806#ifdef CONFIG_LINUX_SPLICE
1807 { .ival = "splice",
1808 .help = "splice/vmsplice based IO",
1809 },
1810 { .ival = "netsplice",
1811 .help = "splice/vmsplice to/from the network",
1812 },
1813#endif
1814#ifdef FIO_HAVE_SGIO
1815 { .ival = "sg",
1816 .help = "SCSI generic v3 IO",
1817 },
1818#endif
1819 { .ival = "null",
1820 .help = "Testing engine (no data transfer)",
1821 },
1822 { .ival = "net",
1823 .help = "Network IO",
1824 },
1825 { .ival = "cpuio",
1826 .help = "CPU cycle burner engine",
1827 },
1828#ifdef CONFIG_GUASI
1829 { .ival = "guasi",
1830 .help = "GUASI IO engine",
1831 },
1832#endif
1833#ifdef CONFIG_RDMA
1834 { .ival = "rdma",
1835 .help = "RDMA IO engine",
1836 },
1837#endif
1838#ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1839 { .ival = "e4defrag",
1840 .help = "ext4 defrag engine",
1841 },
1842#endif
1843#ifdef CONFIG_LINUX_FALLOCATE
1844 { .ival = "falloc",
1845 .help = "fallocate() file based engine",
1846 },
1847#endif
1848#ifdef CONFIG_GFAPI
1849 { .ival = "gfapi",
1850 .help = "Glusterfs libgfapi(sync) based engine"
1851 },
1852 { .ival = "gfapi_async",
1853 .help = "Glusterfs libgfapi(async) based engine"
1854 },
1855#endif
1856#ifdef CONFIG_LIBHDFS
1857 { .ival = "libhdfs",
1858 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1859 },
1860#endif
1861#ifdef CONFIG_PMEMBLK
1862 { .ival = "pmemblk",
1863 .help = "PMDK libpmemblk based IO engine",
1864 },
1865
1866#endif
1867#ifdef CONFIG_IME
1868 { .ival = "ime_psync",
1869 .help = "DDN's IME synchronous IO engine",
1870 },
1871 { .ival = "ime_psyncv",
1872 .help = "DDN's IME synchronous IO engine using iovecs",
1873 },
1874 { .ival = "ime_aio",
1875 .help = "DDN's IME asynchronous IO engine",
1876 },
1877#endif
1878#ifdef CONFIG_LINUX_DEVDAX
1879 { .ival = "dev-dax",
1880 .help = "DAX Device based IO engine",
1881 },
1882#endif
1883 {
1884 .ival = "filecreate",
1885 .help = "File creation engine",
1886 },
1887 { .ival = "external",
1888 .help = "Load external engine (append name)",
1889 .cb = str_ioengine_external_cb,
1890 },
1891#ifdef CONFIG_LIBPMEM
1892 { .ival = "libpmem",
1893 .help = "PMDK libpmem based IO engine",
1894 },
1895#endif
1896#ifdef CONFIG_HTTP
1897 { .ival = "http",
1898 .help = "HTTP (WebDAV/S3) IO engine",
1899 },
1900#endif
1901 },
1902 },
1903 {
1904 .name = "iodepth",
1905 .lname = "IO Depth",
1906 .type = FIO_OPT_INT,
1907 .off1 = offsetof(struct thread_options, iodepth),
1908 .help = "Number of IO buffers to keep in flight",
1909 .minval = 1,
1910 .interval = 1,
1911 .def = "1",
1912 .category = FIO_OPT_C_IO,
1913 .group = FIO_OPT_G_IO_BASIC,
1914 },
1915 {
1916 .name = "iodepth_batch",
1917 .lname = "IO Depth batch",
1918 .alias = "iodepth_batch_submit",
1919 .type = FIO_OPT_INT,
1920 .off1 = offsetof(struct thread_options, iodepth_batch),
1921 .help = "Number of IO buffers to submit in one go",
1922 .parent = "iodepth",
1923 .hide = 1,
1924 .interval = 1,
1925 .def = "1",
1926 .category = FIO_OPT_C_IO,
1927 .group = FIO_OPT_G_IO_BASIC,
1928 },
1929 {
1930 .name = "iodepth_batch_complete_min",
1931 .lname = "Min IO depth batch complete",
1932 .alias = "iodepth_batch_complete",
1933 .type = FIO_OPT_INT,
1934 .off1 = offsetof(struct thread_options, iodepth_batch_complete_min),
1935 .help = "Min number of IO buffers to retrieve in one go",
1936 .parent = "iodepth",
1937 .hide = 1,
1938 .minval = 0,
1939 .interval = 1,
1940 .def = "1",
1941 .category = FIO_OPT_C_IO,
1942 .group = FIO_OPT_G_IO_BASIC,
1943 },
1944 {
1945 .name = "iodepth_batch_complete_max",
1946 .lname = "Max IO depth batch complete",
1947 .type = FIO_OPT_INT,
1948 .off1 = offsetof(struct thread_options, iodepth_batch_complete_max),
1949 .help = "Max number of IO buffers to retrieve in one go",
1950 .parent = "iodepth",
1951 .hide = 1,
1952 .minval = 0,
1953 .interval = 1,
1954 .category = FIO_OPT_C_IO,
1955 .group = FIO_OPT_G_IO_BASIC,
1956 },
1957 {
1958 .name = "iodepth_low",
1959 .lname = "IO Depth batch low",
1960 .type = FIO_OPT_INT,
1961 .off1 = offsetof(struct thread_options, iodepth_low),
1962 .help = "Low water mark for queuing depth",
1963 .parent = "iodepth",
1964 .hide = 1,
1965 .interval = 1,
1966 .category = FIO_OPT_C_IO,
1967 .group = FIO_OPT_G_IO_BASIC,
1968 },
1969 {
1970 .name = "serialize_overlap",
1971 .lname = "Serialize overlap",
1972 .off1 = offsetof(struct thread_options, serialize_overlap),
1973 .type = FIO_OPT_BOOL,
1974 .help = "Wait for in-flight IOs that collide to complete",
1975 .parent = "iodepth",
1976 .def = "0",
1977 .category = FIO_OPT_C_IO,
1978 .group = FIO_OPT_G_IO_BASIC,
1979 },
1980 {
1981 .name = "io_submit_mode",
1982 .lname = "IO submit mode",
1983 .type = FIO_OPT_STR,
1984 .off1 = offsetof(struct thread_options, io_submit_mode),
1985 .help = "How IO submissions and completions are done",
1986 .def = "inline",
1987 .category = FIO_OPT_C_IO,
1988 .group = FIO_OPT_G_IO_BASIC,
1989 .posval = {
1990 { .ival = "inline",
1991 .oval = IO_MODE_INLINE,
1992 .help = "Submit and complete IO inline",
1993 },
1994 { .ival = "offload",
1995 .oval = IO_MODE_OFFLOAD,
1996 .help = "Offload submit and complete to threads",
1997 },
1998 },
1999 },
2000 {
2001 .name = "size",
2002 .lname = "Size",
2003 .type = FIO_OPT_STR_VAL,
2004 .cb = str_size_cb,
2005 .off1 = offsetof(struct thread_options, size),
2006 .help = "Total size of device or files",
2007 .interval = 1024 * 1024,
2008 .category = FIO_OPT_C_IO,
2009 .group = FIO_OPT_G_INVALID,
2010 },
2011 {
2012 .name = "io_size",
2013 .alias = "io_limit",
2014 .lname = "IO Size",
2015 .type = FIO_OPT_STR_VAL,
2016 .off1 = offsetof(struct thread_options, io_size),
2017 .help = "Total size of I/O to be performed",
2018 .interval = 1024 * 1024,
2019 .category = FIO_OPT_C_IO,
2020 .group = FIO_OPT_G_INVALID,
2021 },
2022 {
2023 .name = "fill_device",
2024 .lname = "Fill device",
2025 .alias = "fill_fs",
2026 .type = FIO_OPT_BOOL,
2027 .off1 = offsetof(struct thread_options, fill_device),
2028 .help = "Write until an ENOSPC error occurs",
2029 .def = "0",
2030 .category = FIO_OPT_C_FILE,
2031 .group = FIO_OPT_G_INVALID,
2032 },
2033 {
2034 .name = "filesize",
2035 .lname = "File size",
2036 .type = FIO_OPT_STR_VAL,
2037 .off1 = offsetof(struct thread_options, file_size_low),
2038 .off2 = offsetof(struct thread_options, file_size_high),
2039 .minval = 1,
2040 .help = "Size of individual files",
2041 .interval = 1024 * 1024,
2042 .category = FIO_OPT_C_FILE,
2043 .group = FIO_OPT_G_INVALID,
2044 },
2045 {
2046 .name = "file_append",
2047 .lname = "File append",
2048 .type = FIO_OPT_BOOL,
2049 .off1 = offsetof(struct thread_options, file_append),
2050 .help = "IO will start at the end of the file(s)",
2051 .def = "0",
2052 .category = FIO_OPT_C_FILE,
2053 .group = FIO_OPT_G_INVALID,
2054 },
2055 {
2056 .name = "offset",
2057 .lname = "IO offset",
2058 .alias = "fileoffset",
2059 .type = FIO_OPT_STR_VAL,
2060 .cb = str_offset_cb,
2061 .off1 = offsetof(struct thread_options, start_offset),
2062 .help = "Start IO from this offset",
2063 .def = "0",
2064 .interval = 1024 * 1024,
2065 .category = FIO_OPT_C_IO,
2066 .group = FIO_OPT_G_INVALID,
2067 },
2068 {
2069 .name = "offset_align",
2070 .lname = "IO offset alignment",
2071 .type = FIO_OPT_INT,
2072 .off1 = offsetof(struct thread_options, start_offset_align),
2073 .help = "Start IO from this offset alignment",
2074 .def = "0",
2075 .interval = 512,
2076 .category = FIO_OPT_C_IO,
2077 .group = FIO_OPT_G_INVALID,
2078 },
2079 {
2080 .name = "offset_increment",
2081 .lname = "IO offset increment",
2082 .type = FIO_OPT_STR_VAL,
2083 .off1 = offsetof(struct thread_options, offset_increment),
2084 .help = "What is the increment from one offset to the next",
2085 .parent = "offset",
2086 .hide = 1,
2087 .def = "0",
2088 .interval = 1024 * 1024,
2089 .category = FIO_OPT_C_IO,
2090 .group = FIO_OPT_G_INVALID,
2091 },
2092 {
2093 .name = "number_ios",
2094 .lname = "Number of IOs to perform",
2095 .type = FIO_OPT_STR_VAL,
2096 .off1 = offsetof(struct thread_options, number_ios),
2097 .help = "Force job completion after this number of IOs",
2098 .def = "0",
2099 .category = FIO_OPT_C_IO,
2100 .group = FIO_OPT_G_INVALID,
2101 },
2102 {
2103 .name = "bs",
2104 .lname = "Block size",
2105 .alias = "blocksize",
2106 .type = FIO_OPT_ULL,
2107 .off1 = offsetof(struct thread_options, bs[DDIR_READ]),
2108 .off2 = offsetof(struct thread_options, bs[DDIR_WRITE]),
2109 .off3 = offsetof(struct thread_options, bs[DDIR_TRIM]),
2110 .minval = 1,
2111 .help = "Block size unit",
2112 .def = "4096",
2113 .parent = "rw",
2114 .hide = 1,
2115 .interval = 512,
2116 .category = FIO_OPT_C_IO,
2117 .group = FIO_OPT_G_INVALID,
2118 },
2119 {
2120 .name = "ba",
2121 .lname = "Block size align",
2122 .alias = "blockalign",
2123 .type = FIO_OPT_ULL,
2124 .off1 = offsetof(struct thread_options, ba[DDIR_READ]),
2125 .off2 = offsetof(struct thread_options, ba[DDIR_WRITE]),
2126 .off3 = offsetof(struct thread_options, ba[DDIR_TRIM]),
2127 .minval = 1,
2128 .help = "IO block offset alignment",
2129 .parent = "rw",
2130 .hide = 1,
2131 .interval = 512,
2132 .category = FIO_OPT_C_IO,
2133 .group = FIO_OPT_G_INVALID,
2134 },
2135 {
2136 .name = "bsrange",
2137 .lname = "Block size range",
2138 .alias = "blocksize_range",
2139 .type = FIO_OPT_RANGE,
2140 .off1 = offsetof(struct thread_options, min_bs[DDIR_READ]),
2141 .off2 = offsetof(struct thread_options, max_bs[DDIR_READ]),
2142 .off3 = offsetof(struct thread_options, min_bs[DDIR_WRITE]),
2143 .off4 = offsetof(struct thread_options, max_bs[DDIR_WRITE]),
2144 .off5 = offsetof(struct thread_options, min_bs[DDIR_TRIM]),
2145 .off6 = offsetof(struct thread_options, max_bs[DDIR_TRIM]),
2146 .minval = 1,
2147 .help = "Set block size range (in more detail than bs)",
2148 .parent = "rw",
2149 .hide = 1,
2150 .interval = 4096,
2151 .category = FIO_OPT_C_IO,
2152 .group = FIO_OPT_G_INVALID,
2153 },
2154 {
2155 .name = "bssplit",
2156 .lname = "Block size split",
2157 .type = FIO_OPT_STR_ULL,
2158 .cb = str_bssplit_cb,
2159 .off1 = offsetof(struct thread_options, bssplit),
2160 .help = "Set a specific mix of block sizes",
2161 .parent = "rw",
2162 .hide = 1,
2163 .category = FIO_OPT_C_IO,
2164 .group = FIO_OPT_G_INVALID,
2165 },
2166 {
2167 .name = "bs_unaligned",
2168 .lname = "Block size unaligned",
2169 .alias = "blocksize_unaligned",
2170 .type = FIO_OPT_STR_SET,
2171 .off1 = offsetof(struct thread_options, bs_unaligned),
2172 .help = "Don't sector align IO buffer sizes",
2173 .parent = "rw",
2174 .hide = 1,
2175 .category = FIO_OPT_C_IO,
2176 .group = FIO_OPT_G_INVALID,
2177 },
2178 {
2179 .name = "bs_is_seq_rand",
2180 .lname = "Block size division is seq/random (not read/write)",
2181 .type = FIO_OPT_BOOL,
2182 .off1 = offsetof(struct thread_options, bs_is_seq_rand),
2183 .help = "Consider any blocksize setting to be sequential,random",
2184 .def = "0",
2185 .parent = "blocksize",
2186 .category = FIO_OPT_C_IO,
2187 .group = FIO_OPT_G_INVALID,
2188 },
2189 {
2190 .name = "randrepeat",
2191 .lname = "Random repeatable",
2192 .type = FIO_OPT_BOOL,
2193 .off1 = offsetof(struct thread_options, rand_repeatable),
2194 .help = "Use repeatable random IO pattern",
2195 .def = "1",
2196 .parent = "rw",
2197 .hide = 1,
2198 .category = FIO_OPT_C_IO,
2199 .group = FIO_OPT_G_RANDOM,
2200 },
2201 {
2202 .name = "randseed",
2203 .lname = "The random generator seed",
2204 .type = FIO_OPT_STR_VAL,
2205 .off1 = offsetof(struct thread_options, rand_seed),
2206 .help = "Set the random generator seed value",
2207 .def = "0x89",
2208 .parent = "rw",
2209 .category = FIO_OPT_C_IO,
2210 .group = FIO_OPT_G_RANDOM,
2211 },
2212 {
2213 .name = "norandommap",
2214 .lname = "No randommap",
2215 .type = FIO_OPT_STR_SET,
2216 .off1 = offsetof(struct thread_options, norandommap),
2217 .help = "Accept potential duplicate random blocks",
2218 .parent = "rw",
2219 .hide = 1,
2220 .hide_on_set = 1,
2221 .category = FIO_OPT_C_IO,
2222 .group = FIO_OPT_G_RANDOM,
2223 },
2224 {
2225 .name = "softrandommap",
2226 .lname = "Soft randommap",
2227 .type = FIO_OPT_BOOL,
2228 .off1 = offsetof(struct thread_options, softrandommap),
2229 .help = "Set norandommap if randommap allocation fails",
2230 .parent = "norandommap",
2231 .hide = 1,
2232 .def = "0",
2233 .category = FIO_OPT_C_IO,
2234 .group = FIO_OPT_G_RANDOM,
2235 },
2236 {
2237 .name = "random_generator",
2238 .lname = "Random Generator",
2239 .type = FIO_OPT_STR,
2240 .off1 = offsetof(struct thread_options, random_generator),
2241 .help = "Type of random number generator to use",
2242 .def = "tausworthe",
2243 .posval = {
2244 { .ival = "tausworthe",
2245 .oval = FIO_RAND_GEN_TAUSWORTHE,
2246 .help = "Strong Tausworthe generator",
2247 },
2248 { .ival = "lfsr",
2249 .oval = FIO_RAND_GEN_LFSR,
2250 .help = "Variable length LFSR",
2251 },
2252 {
2253 .ival = "tausworthe64",
2254 .oval = FIO_RAND_GEN_TAUSWORTHE64,
2255 .help = "64-bit Tausworthe variant",
2256 },
2257 },
2258 .category = FIO_OPT_C_IO,
2259 .group = FIO_OPT_G_RANDOM,
2260 },
2261 {
2262 .name = "random_distribution",
2263 .lname = "Random Distribution",
2264 .type = FIO_OPT_STR,
2265 .off1 = offsetof(struct thread_options, random_distribution),
2266 .cb = str_random_distribution_cb,
2267 .help = "Random offset distribution generator",
2268 .def = "random",
2269 .posval = {
2270 { .ival = "random",
2271 .oval = FIO_RAND_DIST_RANDOM,
2272 .help = "Completely random",
2273 },
2274 { .ival = "zipf",
2275 .oval = FIO_RAND_DIST_ZIPF,
2276 .help = "Zipf distribution",
2277 },
2278 { .ival = "pareto",
2279 .oval = FIO_RAND_DIST_PARETO,
2280 .help = "Pareto distribution",
2281 },
2282 { .ival = "normal",
2283 .oval = FIO_RAND_DIST_GAUSS,
2284 .help = "Normal (Gaussian) distribution",
2285 },
2286 { .ival = "zoned",
2287 .oval = FIO_RAND_DIST_ZONED,
2288 .help = "Zoned random distribution",
2289 },
2290 { .ival = "zoned_abs",
2291 .oval = FIO_RAND_DIST_ZONED_ABS,
2292 .help = "Zoned absolute random distribution",
2293 },
2294 },
2295 .category = FIO_OPT_C_IO,
2296 .group = FIO_OPT_G_RANDOM,
2297 },
2298 {
2299 .name = "percentage_random",
2300 .lname = "Percentage Random",
2301 .type = FIO_OPT_INT,
2302 .off1 = offsetof(struct thread_options, perc_rand[DDIR_READ]),
2303 .off2 = offsetof(struct thread_options, perc_rand[DDIR_WRITE]),
2304 .off3 = offsetof(struct thread_options, perc_rand[DDIR_TRIM]),
2305 .maxval = 100,
2306 .help = "Percentage of seq/random mix that should be random",
2307 .def = "100,100,100",
2308 .interval = 5,
2309 .inverse = "percentage_sequential",
2310 .category = FIO_OPT_C_IO,
2311 .group = FIO_OPT_G_RANDOM,
2312 },
2313 {
2314 .name = "percentage_sequential",
2315 .lname = "Percentage Sequential",
2316 .type = FIO_OPT_DEPRECATED,
2317 .category = FIO_OPT_C_IO,
2318 .group = FIO_OPT_G_RANDOM,
2319 },
2320 {
2321 .name = "allrandrepeat",
2322 .lname = "All Random Repeat",
2323 .type = FIO_OPT_BOOL,
2324 .off1 = offsetof(struct thread_options, allrand_repeatable),
2325 .help = "Use repeatable random numbers for everything",
2326 .def = "0",
2327 .category = FIO_OPT_C_IO,
2328 .group = FIO_OPT_G_RANDOM,
2329 },
2330 {
2331 .name = "nrfiles",
2332 .lname = "Number of files",
2333 .alias = "nr_files",
2334 .type = FIO_OPT_INT,
2335 .off1 = offsetof(struct thread_options, nr_files),
2336 .help = "Split job workload between this number of files",
2337 .def = "1",
2338 .interval = 1,
2339 .category = FIO_OPT_C_FILE,
2340 .group = FIO_OPT_G_INVALID,
2341 },
2342 {
2343 .name = "openfiles",
2344 .lname = "Number of open files",
2345 .type = FIO_OPT_INT,
2346 .off1 = offsetof(struct thread_options, open_files),
2347 .help = "Number of files to keep open at the same time",
2348 .category = FIO_OPT_C_FILE,
2349 .group = FIO_OPT_G_INVALID,
2350 },
2351 {
2352 .name = "file_service_type",
2353 .lname = "File service type",
2354 .type = FIO_OPT_STR,
2355 .cb = str_fst_cb,
2356 .off1 = offsetof(struct thread_options, file_service_type),
2357 .help = "How to select which file to service next",
2358 .def = "roundrobin",
2359 .category = FIO_OPT_C_FILE,
2360 .group = FIO_OPT_G_INVALID,
2361 .posval = {
2362 { .ival = "random",
2363 .oval = FIO_FSERVICE_RANDOM,
2364 .help = "Choose a file at random (uniform)",
2365 },
2366 { .ival = "zipf",
2367 .oval = FIO_FSERVICE_ZIPF,
2368 .help = "Zipf randomized",
2369 },
2370 { .ival = "pareto",
2371 .oval = FIO_FSERVICE_PARETO,
2372 .help = "Pareto randomized",
2373 },
2374 { .ival = "normal",
2375 .oval = FIO_FSERVICE_GAUSS,
2376 .help = "Normal (Gaussian) randomized",
2377 },
2378 { .ival = "gauss",
2379 .oval = FIO_FSERVICE_GAUSS,
2380 .help = "Alias for normal",
2381 },
2382 { .ival = "roundrobin",
2383 .oval = FIO_FSERVICE_RR,
2384 .help = "Round robin select files",
2385 },
2386 { .ival = "sequential",
2387 .oval = FIO_FSERVICE_SEQ,
2388 .help = "Finish one file before moving to the next",
2389 },
2390 },
2391 .parent = "nrfiles",
2392 .hide = 1,
2393 },
2394#ifdef FIO_HAVE_ANY_FALLOCATE
2395 {
2396 .name = "fallocate",
2397 .lname = "Fallocate",
2398 .type = FIO_OPT_STR,
2399 .off1 = offsetof(struct thread_options, fallocate_mode),
2400 .help = "Whether pre-allocation is performed when laying out files",
2401 .def = "native",
2402 .category = FIO_OPT_C_FILE,
2403 .group = FIO_OPT_G_INVALID,
2404 .posval = {
2405 { .ival = "none",
2406 .oval = FIO_FALLOCATE_NONE,
2407 .help = "Do not pre-allocate space",
2408 },
2409 { .ival = "native",
2410 .oval = FIO_FALLOCATE_NATIVE,
2411 .help = "Use native pre-allocation if possible",
2412 },
2413#ifdef CONFIG_POSIX_FALLOCATE
2414 { .ival = "posix",
2415 .oval = FIO_FALLOCATE_POSIX,
2416 .help = "Use posix_fallocate()",
2417 },
2418#endif
2419#ifdef CONFIG_LINUX_FALLOCATE
2420 { .ival = "keep",
2421 .oval = FIO_FALLOCATE_KEEP_SIZE,
2422 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
2423 },
2424#endif
2425 /* Compatibility with former boolean values */
2426 { .ival = "0",
2427 .oval = FIO_FALLOCATE_NONE,
2428 .help = "Alias for 'none'",
2429 },
2430#ifdef CONFIG_POSIX_FALLOCATE
2431 { .ival = "1",
2432 .oval = FIO_FALLOCATE_POSIX,
2433 .help = "Alias for 'posix'",
2434 },
2435#endif
2436 },
2437 },
2438#else /* FIO_HAVE_ANY_FALLOCATE */
2439 {
2440 .name = "fallocate",
2441 .lname = "Fallocate",
2442 .type = FIO_OPT_UNSUPPORTED,
2443 .help = "Your platform does not support fallocate",
2444 },
2445#endif /* FIO_HAVE_ANY_FALLOCATE */
2446 {
2447 .name = "fadvise_hint",
2448 .lname = "Fadvise hint",
2449 .type = FIO_OPT_STR,
2450 .off1 = offsetof(struct thread_options, fadvise_hint),
2451 .posval = {
2452 { .ival = "0",
2453 .oval = F_ADV_NONE,
2454 .help = "Don't issue fadvise/madvise",
2455 },
2456 { .ival = "1",
2457 .oval = F_ADV_TYPE,
2458 .help = "Advise using fio IO pattern",
2459 },
2460 { .ival = "random",
2461 .oval = F_ADV_RANDOM,
2462 .help = "Advise using FADV_RANDOM",
2463 },
2464 { .ival = "sequential",
2465 .oval = F_ADV_SEQUENTIAL,
2466 .help = "Advise using FADV_SEQUENTIAL",
2467 },
2468 },
2469 .help = "Use fadvise() to advise the kernel on IO pattern",
2470 .def = "1",
2471 .category = FIO_OPT_C_FILE,
2472 .group = FIO_OPT_G_INVALID,
2473 },
2474 {
2475 .name = "fsync",
2476 .lname = "Fsync",
2477 .type = FIO_OPT_INT,
2478 .off1 = offsetof(struct thread_options, fsync_blocks),
2479 .help = "Issue fsync for writes every given number of blocks",
2480 .def = "0",
2481 .interval = 1,
2482 .category = FIO_OPT_C_FILE,
2483 .group = FIO_OPT_G_INVALID,
2484 },
2485 {
2486 .name = "fdatasync",
2487 .lname = "Fdatasync",
2488 .type = FIO_OPT_INT,
2489 .off1 = offsetof(struct thread_options, fdatasync_blocks),
2490 .help = "Issue fdatasync for writes every given number of blocks",
2491 .def = "0",
2492 .interval = 1,
2493 .category = FIO_OPT_C_FILE,
2494 .group = FIO_OPT_G_INVALID,
2495 },
2496 {
2497 .name = "write_barrier",
2498 .lname = "Write barrier",
2499 .type = FIO_OPT_INT,
2500 .off1 = offsetof(struct thread_options, barrier_blocks),
2501 .help = "Make every Nth write a barrier write",
2502 .def = "0",
2503 .interval = 1,
2504 .category = FIO_OPT_C_IO,
2505 .group = FIO_OPT_G_INVALID,
2506 },
2507#ifdef CONFIG_SYNC_FILE_RANGE
2508 {
2509 .name = "sync_file_range",
2510 .lname = "Sync file range",
2511 .posval = {
2512 { .ival = "wait_before",
2513 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2514 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2515 .orval = 1,
2516 },
2517 { .ival = "write",
2518 .oval = SYNC_FILE_RANGE_WRITE,
2519 .help = "SYNC_FILE_RANGE_WRITE",
2520 .orval = 1,
2521 },
2522 {
2523 .ival = "wait_after",
2524 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2525 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2526 .orval = 1,
2527 },
2528 },
2529 .type = FIO_OPT_STR_MULTI,
2530 .cb = str_sfr_cb,
2531 .off1 = offsetof(struct thread_options, sync_file_range),
2532 .help = "Use sync_file_range()",
2533 .category = FIO_OPT_C_FILE,
2534 .group = FIO_OPT_G_INVALID,
2535 },
2536#else
2537 {
2538 .name = "sync_file_range",
2539 .lname = "Sync file range",
2540 .type = FIO_OPT_UNSUPPORTED,
2541 .help = "Your platform does not support sync_file_range",
2542 },
2543#endif
2544 {
2545 .name = "direct",
2546 .lname = "Direct I/O",
2547 .type = FIO_OPT_BOOL,
2548 .off1 = offsetof(struct thread_options, odirect),
2549 .help = "Use O_DIRECT IO (negates buffered)",
2550 .def = "0",
2551 .inverse = "buffered",
2552 .category = FIO_OPT_C_IO,
2553 .group = FIO_OPT_G_IO_TYPE,
2554 },
2555 {
2556 .name = "atomic",
2557 .lname = "Atomic I/O",
2558 .type = FIO_OPT_BOOL,
2559 .off1 = offsetof(struct thread_options, oatomic),
2560 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2561 .def = "0",
2562 .category = FIO_OPT_C_IO,
2563 .group = FIO_OPT_G_IO_TYPE,
2564 },
2565 {
2566 .name = "buffered",
2567 .lname = "Buffered I/O",
2568 .type = FIO_OPT_BOOL,
2569 .off1 = offsetof(struct thread_options, odirect),
2570 .neg = 1,
2571 .help = "Use buffered IO (negates direct)",
2572 .def = "1",
2573 .inverse = "direct",
2574 .category = FIO_OPT_C_IO,
2575 .group = FIO_OPT_G_IO_TYPE,
2576 },
2577 {
2578 .name = "overwrite",
2579 .lname = "Overwrite",
2580 .type = FIO_OPT_BOOL,
2581 .off1 = offsetof(struct thread_options, overwrite),
2582 .help = "When writing, set whether to overwrite current data",
2583 .def = "0",
2584 .category = FIO_OPT_C_FILE,
2585 .group = FIO_OPT_G_INVALID,
2586 },
2587 {
2588 .name = "loops",
2589 .lname = "Loops",
2590 .type = FIO_OPT_INT,
2591 .off1 = offsetof(struct thread_options, loops),
2592 .help = "Number of times to run the job",
2593 .def = "1",
2594 .interval = 1,
2595 .category = FIO_OPT_C_GENERAL,
2596 .group = FIO_OPT_G_RUNTIME,
2597 },
2598 {
2599 .name = "numjobs",
2600 .lname = "Number of jobs",
2601 .type = FIO_OPT_INT,
2602 .off1 = offsetof(struct thread_options, numjobs),
2603 .help = "Duplicate this job this many times",
2604 .def = "1",
2605 .interval = 1,
2606 .category = FIO_OPT_C_GENERAL,
2607 .group = FIO_OPT_G_RUNTIME,
2608 },
2609 {
2610 .name = "startdelay",
2611 .lname = "Start delay",
2612 .type = FIO_OPT_STR_VAL_TIME,
2613 .off1 = offsetof(struct thread_options, start_delay),
2614 .off2 = offsetof(struct thread_options, start_delay_high),
2615 .help = "Only start job when this period has passed",
2616 .def = "0",
2617 .is_seconds = 1,
2618 .is_time = 1,
2619 .category = FIO_OPT_C_GENERAL,
2620 .group = FIO_OPT_G_RUNTIME,
2621 },
2622 {
2623 .name = "runtime",
2624 .lname = "Runtime",
2625 .alias = "timeout",
2626 .type = FIO_OPT_STR_VAL_TIME,
2627 .off1 = offsetof(struct thread_options, timeout),
2628 .help = "Stop workload when this amount of time has passed",
2629 .def = "0",
2630 .is_seconds = 1,
2631 .is_time = 1,
2632 .category = FIO_OPT_C_GENERAL,
2633 .group = FIO_OPT_G_RUNTIME,
2634 },
2635 {
2636 .name = "time_based",
2637 .lname = "Time based",
2638 .type = FIO_OPT_STR_SET,
2639 .off1 = offsetof(struct thread_options, time_based),
2640 .help = "Keep running until runtime/timeout is met",
2641 .category = FIO_OPT_C_GENERAL,
2642 .group = FIO_OPT_G_RUNTIME,
2643 },
2644 {
2645 .name = "verify_only",
2646 .lname = "Verify only",
2647 .type = FIO_OPT_STR_SET,
2648 .off1 = offsetof(struct thread_options, verify_only),
2649 .help = "Verifies previously written data is still valid",
2650 .category = FIO_OPT_C_GENERAL,
2651 .group = FIO_OPT_G_RUNTIME,
2652 },
2653 {
2654 .name = "ramp_time",
2655 .lname = "Ramp time",
2656 .type = FIO_OPT_STR_VAL_TIME,
2657 .off1 = offsetof(struct thread_options, ramp_time),
2658 .help = "Ramp up time before measuring performance",
2659 .is_seconds = 1,
2660 .is_time = 1,
2661 .category = FIO_OPT_C_GENERAL,
2662 .group = FIO_OPT_G_RUNTIME,
2663 },
2664 {
2665 .name = "clocksource",
2666 .lname = "Clock source",
2667 .type = FIO_OPT_STR,
2668 .cb = fio_clock_source_cb,
2669 .off1 = offsetof(struct thread_options, clocksource),
2670 .help = "What type of timing source to use",
2671 .category = FIO_OPT_C_GENERAL,
2672 .group = FIO_OPT_G_CLOCK,
2673 .posval = {
2674#ifdef CONFIG_GETTIMEOFDAY
2675 { .ival = "gettimeofday",
2676 .oval = CS_GTOD,
2677 .help = "Use gettimeofday(2) for timing",
2678 },
2679#endif
2680#ifdef CONFIG_CLOCK_GETTIME
2681 { .ival = "clock_gettime",
2682 .oval = CS_CGETTIME,
2683 .help = "Use clock_gettime(2) for timing",
2684 },
2685#endif
2686#ifdef ARCH_HAVE_CPU_CLOCK
2687 { .ival = "cpu",
2688 .oval = CS_CPUCLOCK,
2689 .help = "Use CPU private clock",
2690 },
2691#endif
2692 },
2693 },
2694 {
2695 .name = "mem",
2696 .alias = "iomem",
2697 .lname = "I/O Memory",
2698 .type = FIO_OPT_STR,
2699 .cb = str_mem_cb,
2700 .off1 = offsetof(struct thread_options, mem_type),
2701 .help = "Backing type for IO buffers",
2702 .def = "malloc",
2703 .category = FIO_OPT_C_IO,
2704 .group = FIO_OPT_G_INVALID,
2705 .posval = {
2706 { .ival = "malloc",
2707 .oval = MEM_MALLOC,
2708 .help = "Use malloc(3) for IO buffers",
2709 },
2710#ifndef CONFIG_NO_SHM
2711 { .ival = "shm",
2712 .oval = MEM_SHM,
2713 .help = "Use shared memory segments for IO buffers",
2714 },
2715#ifdef FIO_HAVE_HUGETLB
2716 { .ival = "shmhuge",
2717 .oval = MEM_SHMHUGE,
2718 .help = "Like shm, but use huge pages",
2719 },
2720#endif
2721#endif
2722 { .ival = "mmap",
2723 .oval = MEM_MMAP,
2724 .help = "Use mmap(2) (file or anon) for IO buffers",
2725 },
2726 { .ival = "mmapshared",
2727 .oval = MEM_MMAPSHARED,
2728 .help = "Like mmap, but use the shared flag",
2729 },
2730#ifdef FIO_HAVE_HUGETLB
2731 { .ival = "mmaphuge",
2732 .oval = MEM_MMAPHUGE,
2733 .help = "Like mmap, but use huge pages",
2734 },
2735#endif
2736#ifdef CONFIG_CUDA
2737 { .ival = "cudamalloc",
2738 .oval = MEM_CUDA_MALLOC,
2739 .help = "Allocate GPU device memory for GPUDirect RDMA",
2740 },
2741#endif
2742 },
2743 },
2744 {
2745 .name = "iomem_align",
2746 .alias = "mem_align",
2747 .lname = "I/O memory alignment",
2748 .type = FIO_OPT_INT,
2749 .off1 = offsetof(struct thread_options, mem_align),
2750 .minval = 0,
2751 .help = "IO memory buffer offset alignment",
2752 .def = "0",
2753 .parent = "iomem",
2754 .hide = 1,
2755 .category = FIO_OPT_C_IO,
2756 .group = FIO_OPT_G_INVALID,
2757 },
2758 {
2759 .name = "verify",
2760 .lname = "Verify",
2761 .type = FIO_OPT_STR,
2762 .off1 = offsetof(struct thread_options, verify),
2763 .help = "Verify data written",
2764 .def = "0",
2765 .category = FIO_OPT_C_IO,
2766 .group = FIO_OPT_G_VERIFY,
2767 .posval = {
2768 { .ival = "0",
2769 .oval = VERIFY_NONE,
2770 .help = "Don't do IO verification",
2771 },
2772 { .ival = "md5",
2773 .oval = VERIFY_MD5,
2774 .help = "Use md5 checksums for verification",
2775 },
2776 { .ival = "crc64",
2777 .oval = VERIFY_CRC64,
2778 .help = "Use crc64 checksums for verification",
2779 },
2780 { .ival = "crc32",
2781 .oval = VERIFY_CRC32,
2782 .help = "Use crc32 checksums for verification",
2783 },
2784 { .ival = "crc32c-intel",
2785 .oval = VERIFY_CRC32C,
2786 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2787 },
2788 { .ival = "crc32c",
2789 .oval = VERIFY_CRC32C,
2790 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2791 },
2792 { .ival = "crc16",
2793 .oval = VERIFY_CRC16,
2794 .help = "Use crc16 checksums for verification",
2795 },
2796 { .ival = "crc7",
2797 .oval = VERIFY_CRC7,
2798 .help = "Use crc7 checksums for verification",
2799 },
2800 { .ival = "sha1",
2801 .oval = VERIFY_SHA1,
2802 .help = "Use sha1 checksums for verification",
2803 },
2804 { .ival = "sha256",
2805 .oval = VERIFY_SHA256,
2806 .help = "Use sha256 checksums for verification",
2807 },
2808 { .ival = "sha512",
2809 .oval = VERIFY_SHA512,
2810 .help = "Use sha512 checksums for verification",
2811 },
2812 { .ival = "sha3-224",
2813 .oval = VERIFY_SHA3_224,
2814 .help = "Use sha3-224 checksums for verification",
2815 },
2816 { .ival = "sha3-256",
2817 .oval = VERIFY_SHA3_256,
2818 .help = "Use sha3-256 checksums for verification",
2819 },
2820 { .ival = "sha3-384",
2821 .oval = VERIFY_SHA3_384,
2822 .help = "Use sha3-384 checksums for verification",
2823 },
2824 { .ival = "sha3-512",
2825 .oval = VERIFY_SHA3_512,
2826 .help = "Use sha3-512 checksums for verification",
2827 },
2828 { .ival = "xxhash",
2829 .oval = VERIFY_XXHASH,
2830 .help = "Use xxhash checksums for verification",
2831 },
2832 /* Meta information was included into verify_header,
2833 * 'meta' verification is implied by default. */
2834 { .ival = "meta",
2835 .oval = VERIFY_HDR_ONLY,
2836 .help = "Use io information for verification. "
2837 "Now is implied by default, thus option is obsolete, "
2838 "don't use it",
2839 },
2840 { .ival = "pattern",
2841 .oval = VERIFY_PATTERN_NO_HDR,
2842 .help = "Verify strict pattern",
2843 },
2844 {
2845 .ival = "null",
2846 .oval = VERIFY_NULL,
2847 .help = "Pretend to verify",
2848 },
2849 },
2850 },
2851 {
2852 .name = "do_verify",
2853 .lname = "Perform verify step",
2854 .type = FIO_OPT_BOOL,
2855 .off1 = offsetof(struct thread_options, do_verify),
2856 .help = "Run verification stage after write",
2857 .def = "1",
2858 .parent = "verify",
2859 .hide = 1,
2860 .category = FIO_OPT_C_IO,
2861 .group = FIO_OPT_G_VERIFY,
2862 },
2863 {
2864 .name = "verifysort",
2865 .lname = "Verify sort",
2866 .type = FIO_OPT_SOFT_DEPRECATED,
2867 .category = FIO_OPT_C_IO,
2868 .group = FIO_OPT_G_VERIFY,
2869 },
2870 {
2871 .name = "verifysort_nr",
2872 .lname = "Verify Sort Nr",
2873 .type = FIO_OPT_SOFT_DEPRECATED,
2874 .category = FIO_OPT_C_IO,
2875 .group = FIO_OPT_G_VERIFY,
2876 },
2877 {
2878 .name = "verify_interval",
2879 .lname = "Verify interval",
2880 .type = FIO_OPT_INT,
2881 .off1 = offsetof(struct thread_options, verify_interval),
2882 .minval = 2 * sizeof(struct verify_header),
2883 .help = "Store verify buffer header every N bytes",
2884 .parent = "verify",
2885 .hide = 1,
2886 .interval = 2 * sizeof(struct verify_header),
2887 .category = FIO_OPT_C_IO,
2888 .group = FIO_OPT_G_VERIFY,
2889 },
2890 {
2891 .name = "verify_offset",
2892 .lname = "Verify offset",
2893 .type = FIO_OPT_INT,
2894 .help = "Offset verify header location by N bytes",
2895 .off1 = offsetof(struct thread_options, verify_offset),
2896 .minval = sizeof(struct verify_header),
2897 .parent = "verify",
2898 .hide = 1,
2899 .category = FIO_OPT_C_IO,
2900 .group = FIO_OPT_G_VERIFY,
2901 },
2902 {
2903 .name = "verify_pattern",
2904 .lname = "Verify pattern",
2905 .type = FIO_OPT_STR,
2906 .cb = str_verify_pattern_cb,
2907 .off1 = offsetof(struct thread_options, verify_pattern),
2908 .help = "Fill pattern for IO buffers",
2909 .parent = "verify",
2910 .hide = 1,
2911 .category = FIO_OPT_C_IO,
2912 .group = FIO_OPT_G_VERIFY,
2913 },
2914 {
2915 .name = "verify_fatal",
2916 .lname = "Verify fatal",
2917 .type = FIO_OPT_BOOL,
2918 .off1 = offsetof(struct thread_options, verify_fatal),
2919 .def = "0",
2920 .help = "Exit on a single verify failure, don't continue",
2921 .parent = "verify",
2922 .hide = 1,
2923 .category = FIO_OPT_C_IO,
2924 .group = FIO_OPT_G_VERIFY,
2925 },
2926 {
2927 .name = "verify_dump",
2928 .lname = "Verify dump",
2929 .type = FIO_OPT_BOOL,
2930 .off1 = offsetof(struct thread_options, verify_dump),
2931 .def = "0",
2932 .help = "Dump contents of good and bad blocks on failure",
2933 .parent = "verify",
2934 .hide = 1,
2935 .category = FIO_OPT_C_IO,
2936 .group = FIO_OPT_G_VERIFY,
2937 },
2938 {
2939 .name = "verify_async",
2940 .lname = "Verify asynchronously",
2941 .type = FIO_OPT_INT,
2942 .off1 = offsetof(struct thread_options, verify_async),
2943 .def = "0",
2944 .help = "Number of async verifier threads to use",
2945 .parent = "verify",
2946 .hide = 1,
2947 .category = FIO_OPT_C_IO,
2948 .group = FIO_OPT_G_VERIFY,
2949 },
2950 {
2951 .name = "verify_backlog",
2952 .lname = "Verify backlog",
2953 .type = FIO_OPT_STR_VAL,
2954 .off1 = offsetof(struct thread_options, verify_backlog),
2955 .help = "Verify after this number of blocks are written",
2956 .parent = "verify",
2957 .hide = 1,
2958 .category = FIO_OPT_C_IO,
2959 .group = FIO_OPT_G_VERIFY,
2960 },
2961 {
2962 .name = "verify_backlog_batch",
2963 .lname = "Verify backlog batch",
2964 .type = FIO_OPT_INT,
2965 .off1 = offsetof(struct thread_options, verify_batch),
2966 .help = "Verify this number of IO blocks",
2967 .parent = "verify",
2968 .hide = 1,
2969 .category = FIO_OPT_C_IO,
2970 .group = FIO_OPT_G_VERIFY,
2971 },
2972#ifdef FIO_HAVE_CPU_AFFINITY
2973 {
2974 .name = "verify_async_cpus",
2975 .lname = "Async verify CPUs",
2976 .type = FIO_OPT_STR,
2977 .cb = str_verify_cpus_allowed_cb,
2978 .off1 = offsetof(struct thread_options, verify_cpumask),
2979 .help = "Set CPUs allowed for async verify threads",
2980 .parent = "verify_async",
2981 .hide = 1,
2982 .category = FIO_OPT_C_IO,
2983 .group = FIO_OPT_G_VERIFY,
2984 },
2985#else
2986 {
2987 .name = "verify_async_cpus",
2988 .lname = "Async verify CPUs",
2989 .type = FIO_OPT_UNSUPPORTED,
2990 .help = "Your platform does not support CPU affinities",
2991 },
2992#endif
2993 {
2994 .name = "experimental_verify",
2995 .lname = "Experimental Verify",
2996 .off1 = offsetof(struct thread_options, experimental_verify),
2997 .type = FIO_OPT_BOOL,
2998 .help = "Enable experimental verification",
2999 .parent = "verify",
3000 .category = FIO_OPT_C_IO,
3001 .group = FIO_OPT_G_VERIFY,
3002 },
3003 {
3004 .name = "verify_state_load",
3005 .lname = "Load verify state",
3006 .off1 = offsetof(struct thread_options, verify_state),
3007 .type = FIO_OPT_BOOL,
3008 .help = "Load verify termination state",
3009 .parent = "verify",
3010 .category = FIO_OPT_C_IO,
3011 .group = FIO_OPT_G_VERIFY,
3012 },
3013 {
3014 .name = "verify_state_save",
3015 .lname = "Save verify state",
3016 .off1 = offsetof(struct thread_options, verify_state_save),
3017 .type = FIO_OPT_BOOL,
3018 .def = "1",
3019 .help = "Save verify state on termination",
3020 .parent = "verify",
3021 .category = FIO_OPT_C_IO,
3022 .group = FIO_OPT_G_VERIFY,
3023 },
3024#ifdef FIO_HAVE_TRIM
3025 {
3026 .name = "trim_percentage",
3027 .lname = "Trim percentage",
3028 .type = FIO_OPT_INT,
3029 .off1 = offsetof(struct thread_options, trim_percentage),
3030 .minval = 0,
3031 .maxval = 100,
3032 .help = "Number of verify blocks to trim (i.e., discard)",
3033 .parent = "verify",
3034 .def = "0",
3035 .interval = 1,
3036 .hide = 1,
3037 .category = FIO_OPT_C_IO,
3038 .group = FIO_OPT_G_TRIM,
3039 },
3040 {
3041 .name = "trim_verify_zero",
3042 .lname = "Verify trim zero",
3043 .type = FIO_OPT_BOOL,
3044 .help = "Verify that trimmed (i.e., discarded) blocks are returned as zeroes",
3045 .off1 = offsetof(struct thread_options, trim_zero),
3046 .parent = "trim_percentage",
3047 .hide = 1,
3048 .def = "1",
3049 .category = FIO_OPT_C_IO,
3050 .group = FIO_OPT_G_TRIM,
3051 },
3052 {
3053 .name = "trim_backlog",
3054 .lname = "Trim backlog",
3055 .type = FIO_OPT_STR_VAL,
3056 .off1 = offsetof(struct thread_options, trim_backlog),
3057 .help = "Trim after this number of blocks are written",
3058 .parent = "trim_percentage",
3059 .hide = 1,
3060 .interval = 1,
3061 .category = FIO_OPT_C_IO,
3062 .group = FIO_OPT_G_TRIM,
3063 },
3064 {
3065 .name = "trim_backlog_batch",
3066 .lname = "Trim backlog batch",
3067 .type = FIO_OPT_INT,
3068 .off1 = offsetof(struct thread_options, trim_batch),
3069 .help = "Trim this number of IO blocks",
3070 .parent = "trim_percentage",
3071 .hide = 1,
3072 .interval = 1,
3073 .category = FIO_OPT_C_IO,
3074 .group = FIO_OPT_G_TRIM,
3075 },
3076#else
3077 {
3078 .name = "trim_percentage",
3079 .lname = "Trim percentage",
3080 .type = FIO_OPT_UNSUPPORTED,
3081 .help = "Fio does not support TRIM on your platform",
3082 },
3083 {
3084 .name = "trim_verify_zero",
3085 .lname = "Verify trim zero",
3086 .type = FIO_OPT_UNSUPPORTED,
3087 .help = "Fio does not support TRIM on your platform",
3088 },
3089 {
3090 .name = "trim_backlog",
3091 .lname = "Trim backlog",
3092 .type = FIO_OPT_UNSUPPORTED,
3093 .help = "Fio does not support TRIM on your platform",
3094 },
3095 {
3096 .name = "trim_backlog_batch",
3097 .lname = "Trim backlog batch",
3098 .type = FIO_OPT_UNSUPPORTED,
3099 .help = "Fio does not support TRIM on your platform",
3100 },
3101#endif
3102 {
3103 .name = "write_iolog",
3104 .lname = "Write I/O log",
3105 .type = FIO_OPT_STR_STORE,
3106 .off1 = offsetof(struct thread_options, write_iolog_file),
3107 .help = "Store IO pattern to file",
3108 .category = FIO_OPT_C_IO,
3109 .group = FIO_OPT_G_IOLOG,
3110 },
3111 {
3112 .name = "read_iolog",
3113 .lname = "Read I/O log",
3114 .type = FIO_OPT_STR_STORE,
3115 .off1 = offsetof(struct thread_options, read_iolog_file),
3116 .help = "Playback IO pattern from file",
3117 .category = FIO_OPT_C_IO,
3118 .group = FIO_OPT_G_IOLOG,
3119 },
3120 {
3121 .name = "read_iolog_chunked",
3122 .lname = "Read I/O log in parts",
3123 .type = FIO_OPT_BOOL,
3124 .off1 = offsetof(struct thread_options, read_iolog_chunked),
3125 .def = "0",
3126 .parent = "read_iolog",
3127 .help = "Parse IO pattern in chunks",
3128 .category = FIO_OPT_C_IO,
3129 .group = FIO_OPT_G_IOLOG,
3130 },
3131 {
3132 .name = "replay_no_stall",
3133 .lname = "Don't stall on replay",
3134 .type = FIO_OPT_BOOL,
3135 .off1 = offsetof(struct thread_options, no_stall),
3136 .def = "0",
3137 .parent = "read_iolog",
3138 .hide = 1,
3139 .help = "Playback IO pattern file as fast as possible without stalls",
3140 .category = FIO_OPT_C_IO,
3141 .group = FIO_OPT_G_IOLOG,
3142 },
3143 {
3144 .name = "replay_redirect",
3145 .lname = "Redirect device for replay",
3146 .type = FIO_OPT_STR_STORE,
3147 .off1 = offsetof(struct thread_options, replay_redirect),
3148 .parent = "read_iolog",
3149 .hide = 1,
3150 .help = "Replay all I/O onto this device, regardless of trace device",
3151 .category = FIO_OPT_C_IO,
3152 .group = FIO_OPT_G_IOLOG,
3153 },
3154 {
3155 .name = "replay_scale",
3156 .lname = "Replace offset scale factor",
3157 .type = FIO_OPT_INT,
3158 .off1 = offsetof(struct thread_options, replay_scale),
3159 .parent = "read_iolog",
3160 .def = "1",
3161 .help = "Align offsets to this blocksize",
3162 .category = FIO_OPT_C_IO,
3163 .group = FIO_OPT_G_IOLOG,
3164 },
3165 {
3166 .name = "replay_align",
3167 .lname = "Replace alignment",
3168 .type = FIO_OPT_INT,
3169 .off1 = offsetof(struct thread_options, replay_align),
3170 .parent = "read_iolog",
3171 .help = "Scale offset down by this factor",
3172 .category = FIO_OPT_C_IO,
3173 .group = FIO_OPT_G_IOLOG,
3174 .pow2 = 1,
3175 },
3176 {
3177 .name = "replay_time_scale",
3178 .lname = "Replay Time Scale",
3179 .type = FIO_OPT_INT,
3180 .off1 = offsetof(struct thread_options, replay_time_scale),
3181 .def = "100",
3182 .minval = 1,
3183 .parent = "read_iolog",
3184 .hide = 1,
3185 .help = "Scale time for replay events",
3186 .category = FIO_OPT_C_IO,
3187 .group = FIO_OPT_G_IOLOG,
3188 },
3189 {
3190 .name = "replay_skip",
3191 .lname = "Replay Skip",
3192 .type = FIO_OPT_STR,
3193 .cb = str_replay_skip_cb,
3194 .off1 = offsetof(struct thread_options, replay_skip),
3195 .parent = "read_iolog",
3196 .help = "Skip certain IO types (read,write,trim,flush)",
3197 .category = FIO_OPT_C_IO,
3198 .group = FIO_OPT_G_IOLOG,
3199 },
3200 {
3201 .name = "merge_blktrace_file",
3202 .lname = "Merged blktrace output filename",
3203 .type = FIO_OPT_STR_STORE,
3204 .off1 = offsetof(struct thread_options, merge_blktrace_file),
3205 .help = "Merged blktrace output filename",
3206 .category = FIO_OPT_C_IO,
3207 .group = FIO_OPT_G_IOLOG,
3208 },
3209 {
3210 .name = "merge_blktrace_scalars",
3211 .lname = "Percentage to scale each trace",
3212 .type = FIO_OPT_FLOAT_LIST,
3213 .off1 = offsetof(struct thread_options, merge_blktrace_scalars),
3214 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3215 .help = "Percentage to scale each trace",
3216 .category = FIO_OPT_C_IO,
3217 .group = FIO_OPT_G_IOLOG,
3218 },
3219 {
3220 .name = "merge_blktrace_iters",
3221 .lname = "Number of iterations to run per trace",
3222 .type = FIO_OPT_FLOAT_LIST,
3223 .off1 = offsetof(struct thread_options, merge_blktrace_iters),
3224 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3225 .help = "Number of iterations to run per trace",
3226 .category = FIO_OPT_C_IO,
3227 .group = FIO_OPT_G_IOLOG,
3228 },
3229 {
3230 .name = "exec_prerun",
3231 .lname = "Pre-execute runnable",
3232 .type = FIO_OPT_STR_STORE,
3233 .off1 = offsetof(struct thread_options, exec_prerun),
3234 .help = "Execute this file prior to running job",
3235 .category = FIO_OPT_C_GENERAL,
3236 .group = FIO_OPT_G_INVALID,
3237 },
3238 {
3239 .name = "exec_postrun",
3240 .lname = "Post-execute runnable",
3241 .type = FIO_OPT_STR_STORE,
3242 .off1 = offsetof(struct thread_options, exec_postrun),
3243 .help = "Execute this file after running job",
3244 .category = FIO_OPT_C_GENERAL,
3245 .group = FIO_OPT_G_INVALID,
3246 },
3247#ifdef FIO_HAVE_IOSCHED_SWITCH
3248 {
3249 .name = "ioscheduler",
3250 .lname = "I/O scheduler",
3251 .type = FIO_OPT_STR_STORE,
3252 .off1 = offsetof(struct thread_options, ioscheduler),
3253 .help = "Use this IO scheduler on the backing device",
3254 .category = FIO_OPT_C_FILE,
3255 .group = FIO_OPT_G_INVALID,
3256 },
3257#else
3258 {
3259 .name = "ioscheduler",
3260 .lname = "I/O scheduler",
3261 .type = FIO_OPT_UNSUPPORTED,
3262 .help = "Your platform does not support IO scheduler switching",
3263 },
3264#endif
3265 {
3266 .name = "zonemode",
3267 .lname = "Zone mode",
3268 .help = "Mode for the zonesize, zonerange and zoneskip parameters",
3269 .type = FIO_OPT_STR,
3270 .off1 = offsetof(struct thread_options, zone_mode),
3271 .def = "none",
3272 .category = FIO_OPT_C_IO,
3273 .group = FIO_OPT_G_ZONE,
3274 .posval = {
3275 { .ival = "none",
3276 .oval = ZONE_MODE_NONE,
3277 .help = "no zoning",
3278 },
3279 { .ival = "strided",
3280 .oval = ZONE_MODE_STRIDED,
3281 .help = "strided mode - random I/O is restricted to a single zone",
3282 },
3283 { .ival = "zbd",
3284 .oval = ZONE_MODE_ZBD,
3285 .help = "zoned block device mode - random I/O selects one of multiple zones randomly",
3286 },
3287 },
3288 },
3289 {
3290 .name = "zonesize",
3291 .lname = "Zone size",
3292 .type = FIO_OPT_STR_VAL,
3293 .off1 = offsetof(struct thread_options, zone_size),
3294 .help = "Amount of data to read per zone",
3295 .def = "0",
3296 .interval = 1024 * 1024,
3297 .category = FIO_OPT_C_IO,
3298 .group = FIO_OPT_G_ZONE,
3299 },
3300 {
3301 .name = "zonerange",
3302 .lname = "Zone range",
3303 .type = FIO_OPT_STR_VAL,
3304 .off1 = offsetof(struct thread_options, zone_range),
3305 .help = "Give size of an IO zone",
3306 .def = "0",
3307 .interval = 1024 * 1024,
3308 .category = FIO_OPT_C_IO,
3309 .group = FIO_OPT_G_ZONE,
3310 },
3311 {
3312 .name = "zoneskip",
3313 .lname = "Zone skip",
3314 .type = FIO_OPT_STR_VAL,
3315 .off1 = offsetof(struct thread_options, zone_skip),
3316 .help = "Space between IO zones",
3317 .def = "0",
3318 .interval = 1024 * 1024,
3319 .category = FIO_OPT_C_IO,
3320 .group = FIO_OPT_G_ZONE,
3321 },
3322 {
3323 .name = "read_beyond_wp",
3324 .lname = "Allow reads beyond the zone write pointer",
3325 .type = FIO_OPT_BOOL,
3326 .off1 = offsetof(struct thread_options, read_beyond_wp),
3327 .help = "Allow reads beyond the zone write pointer",
3328 .def = "0",
3329 .category = FIO_OPT_C_IO,
3330 .group = FIO_OPT_G_INVALID,
3331 },
3332 {
3333 .name = "max_open_zones",
3334 .lname = "Maximum number of open zones",
3335 .type = FIO_OPT_INT,
3336 .off1 = offsetof(struct thread_options, max_open_zones),
3337 .maxval = FIO_MAX_OPEN_ZBD_ZONES,
3338 .help = "Limit random writes to SMR drives to the specified"
3339 " number of sequential zones",
3340 .def = "0",
3341 .category = FIO_OPT_C_IO,
3342 .group = FIO_OPT_G_INVALID,
3343 },
3344 {
3345 .name = "zone_reset_threshold",
3346 .lname = "Zone reset threshold",
3347 .help = "Zoned block device reset threshold",
3348 .type = FIO_OPT_FLOAT_LIST,
3349 .maxlen = 1,
3350 .off1 = offsetof(struct thread_options, zrt),
3351 .minfp = 0,
3352 .maxfp = 1,
3353 .category = FIO_OPT_C_IO,
3354 .group = FIO_OPT_G_ZONE,
3355 },
3356 {
3357 .name = "zone_reset_frequency",
3358 .lname = "Zone reset frequency",
3359 .help = "Zoned block device zone reset frequency in HZ",
3360 .type = FIO_OPT_FLOAT_LIST,
3361 .maxlen = 1,
3362 .off1 = offsetof(struct thread_options, zrf),
3363 .minfp = 0,
3364 .maxfp = 1,
3365 .category = FIO_OPT_C_IO,
3366 .group = FIO_OPT_G_ZONE,
3367 },
3368 {
3369 .name = "lockmem",
3370 .lname = "Lock memory",
3371 .type = FIO_OPT_STR_VAL,
3372 .off1 = offsetof(struct thread_options, lockmem),
3373 .help = "Lock down this amount of memory (per worker)",
3374 .def = "0",
3375 .interval = 1024 * 1024,
3376 .category = FIO_OPT_C_GENERAL,
3377 .group = FIO_OPT_G_INVALID,
3378 },
3379 {
3380 .name = "rwmixread",
3381 .lname = "Read/write mix read",
3382 .type = FIO_OPT_INT,
3383 .cb = str_rwmix_read_cb,
3384 .off1 = offsetof(struct thread_options, rwmix[DDIR_READ]),
3385 .maxval = 100,
3386 .help = "Percentage of mixed workload that is reads",
3387 .def = "50",
3388 .interval = 5,
3389 .inverse = "rwmixwrite",
3390 .category = FIO_OPT_C_IO,
3391 .group = FIO_OPT_G_RWMIX,
3392 },
3393 {
3394 .name = "rwmixwrite",
3395 .lname = "Read/write mix write",
3396 .type = FIO_OPT_INT,
3397 .cb = str_rwmix_write_cb,
3398 .off1 = offsetof(struct thread_options, rwmix[DDIR_WRITE]),
3399 .maxval = 100,
3400 .help = "Percentage of mixed workload that is writes",
3401 .def = "50",
3402 .interval = 5,
3403 .inverse = "rwmixread",
3404 .category = FIO_OPT_C_IO,
3405 .group = FIO_OPT_G_RWMIX,
3406 },
3407 {
3408 .name = "rwmixcycle",
3409 .lname = "Read/write mix cycle",
3410 .type = FIO_OPT_DEPRECATED,
3411 .category = FIO_OPT_C_IO,
3412 .group = FIO_OPT_G_RWMIX,
3413 },
3414 {
3415 .name = "nice",
3416 .lname = "Nice",
3417 .type = FIO_OPT_INT,
3418 .off1 = offsetof(struct thread_options, nice),
3419 .help = "Set job CPU nice value",
3420 .minval = -20,
3421 .maxval = 19,
3422 .def = "0",
3423 .interval = 1,
3424 .category = FIO_OPT_C_GENERAL,
3425 .group = FIO_OPT_G_CRED,
3426 },
3427#ifdef FIO_HAVE_IOPRIO
3428 {
3429 .name = "prio",
3430 .lname = "I/O nice priority",
3431 .type = FIO_OPT_INT,
3432 .off1 = offsetof(struct thread_options, ioprio),
3433 .help = "Set job IO priority value",
3434 .minval = IOPRIO_MIN_PRIO,
3435 .maxval = IOPRIO_MAX_PRIO,
3436 .interval = 1,
3437 .category = FIO_OPT_C_GENERAL,
3438 .group = FIO_OPT_G_CRED,
3439 },
3440#else
3441 {
3442 .name = "prio",
3443 .lname = "I/O nice priority",
3444 .type = FIO_OPT_UNSUPPORTED,
3445 .help = "Your platform does not support IO priorities",
3446 },
3447#endif
3448#ifdef FIO_HAVE_IOPRIO_CLASS
3449#ifndef FIO_HAVE_IOPRIO
3450#error "FIO_HAVE_IOPRIO_CLASS requires FIO_HAVE_IOPRIO"
3451#endif
3452 {
3453 .name = "prioclass",
3454 .lname = "I/O nice priority class",
3455 .type = FIO_OPT_INT,
3456 .off1 = offsetof(struct thread_options, ioprio_class),
3457 .help = "Set job IO priority class",
3458 .minval = IOPRIO_MIN_PRIO_CLASS,
3459 .maxval = IOPRIO_MAX_PRIO_CLASS,
3460 .interval = 1,
3461 .category = FIO_OPT_C_GENERAL,
3462 .group = FIO_OPT_G_CRED,
3463 },
3464#else
3465 {
3466 .name = "prioclass",
3467 .lname = "I/O nice priority class",
3468 .type = FIO_OPT_UNSUPPORTED,
3469 .help = "Your platform does not support IO priority classes",
3470 },
3471#endif
3472 {
3473 .name = "thinktime",
3474 .lname = "Thinktime",
3475 .type = FIO_OPT_INT,
3476 .off1 = offsetof(struct thread_options, thinktime),
3477 .help = "Idle time between IO buffers (usec)",
3478 .def = "0",
3479 .is_time = 1,
3480 .category = FIO_OPT_C_IO,
3481 .group = FIO_OPT_G_THINKTIME,
3482 },
3483 {
3484 .name = "thinktime_spin",
3485 .lname = "Thinktime spin",
3486 .type = FIO_OPT_INT,
3487 .off1 = offsetof(struct thread_options, thinktime_spin),
3488 .help = "Start think time by spinning this amount (usec)",
3489 .def = "0",
3490 .is_time = 1,
3491 .parent = "thinktime",
3492 .hide = 1,
3493 .category = FIO_OPT_C_IO,
3494 .group = FIO_OPT_G_THINKTIME,
3495 },
3496 {
3497 .name = "thinktime_blocks",
3498 .lname = "Thinktime blocks",
3499 .type = FIO_OPT_INT,
3500 .off1 = offsetof(struct thread_options, thinktime_blocks),
3501 .help = "IO buffer period between 'thinktime'",
3502 .def = "1",
3503 .parent = "thinktime",
3504 .hide = 1,
3505 .category = FIO_OPT_C_IO,
3506 .group = FIO_OPT_G_THINKTIME,
3507 },
3508 {
3509 .name = "rate",
3510 .lname = "I/O rate",
3511 .type = FIO_OPT_INT,
3512 .off1 = offsetof(struct thread_options, rate[DDIR_READ]),
3513 .off2 = offsetof(struct thread_options, rate[DDIR_WRITE]),
3514 .off3 = offsetof(struct thread_options, rate[DDIR_TRIM]),
3515 .help = "Set bandwidth rate",
3516 .category = FIO_OPT_C_IO,
3517 .group = FIO_OPT_G_RATE,
3518 },
3519 {
3520 .name = "rate_min",
3521 .alias = "ratemin",
3522 .lname = "I/O min rate",
3523 .type = FIO_OPT_INT,
3524 .off1 = offsetof(struct thread_options, ratemin[DDIR_READ]),
3525 .off2 = offsetof(struct thread_options, ratemin[DDIR_WRITE]),
3526 .off3 = offsetof(struct thread_options, ratemin[DDIR_TRIM]),
3527 .help = "Job must meet this rate or it will be shutdown",
3528 .parent = "rate",
3529 .hide = 1,
3530 .category = FIO_OPT_C_IO,
3531 .group = FIO_OPT_G_RATE,
3532 },
3533 {
3534 .name = "rate_iops",
3535 .lname = "I/O rate IOPS",
3536 .type = FIO_OPT_INT,
3537 .off1 = offsetof(struct thread_options, rate_iops[DDIR_READ]),
3538 .off2 = offsetof(struct thread_options, rate_iops[DDIR_WRITE]),
3539 .off3 = offsetof(struct thread_options, rate_iops[DDIR_TRIM]),
3540 .help = "Limit IO used to this number of IO operations/sec",
3541 .hide = 1,
3542 .category = FIO_OPT_C_IO,
3543 .group = FIO_OPT_G_RATE,
3544 },
3545 {
3546 .name = "rate_iops_min",
3547 .lname = "I/O min rate IOPS",
3548 .type = FIO_OPT_INT,
3549 .off1 = offsetof(struct thread_options, rate_iops_min[DDIR_READ]),
3550 .off2 = offsetof(struct thread_options, rate_iops_min[DDIR_WRITE]),
3551 .off3 = offsetof(struct thread_options, rate_iops_min[DDIR_TRIM]),
3552 .help = "Job must meet this rate or it will be shut down",
3553 .parent = "rate_iops",
3554 .hide = 1,
3555 .category = FIO_OPT_C_IO,
3556 .group = FIO_OPT_G_RATE,
3557 },
3558 {
3559 .name = "rate_process",
3560 .lname = "Rate Process",
3561 .type = FIO_OPT_STR,
3562 .off1 = offsetof(struct thread_options, rate_process),
3563 .help = "What process controls how rated IO is managed",
3564 .def = "linear",
3565 .category = FIO_OPT_C_IO,
3566 .group = FIO_OPT_G_RATE,
3567 .posval = {
3568 { .ival = "linear",
3569 .oval = RATE_PROCESS_LINEAR,
3570 .help = "Linear rate of IO",
3571 },
3572 {
3573 .ival = "poisson",
3574 .oval = RATE_PROCESS_POISSON,
3575 .help = "Rate follows Poisson process",
3576 },
3577 },
3578 .parent = "rate",
3579 },
3580 {
3581 .name = "rate_cycle",
3582 .alias = "ratecycle",
3583 .lname = "I/O rate cycle",
3584 .type = FIO_OPT_INT,
3585 .off1 = offsetof(struct thread_options, ratecycle),
3586 .help = "Window average for rate limits (msec)",
3587 .def = "1000",
3588 .parent = "rate",
3589 .hide = 1,
3590 .category = FIO_OPT_C_IO,
3591 .group = FIO_OPT_G_RATE,
3592 },
3593 {
3594 .name = "rate_ignore_thinktime",
3595 .lname = "Rate ignore thinktime",
3596 .type = FIO_OPT_BOOL,
3597 .off1 = offsetof(struct thread_options, rate_ign_think),
3598 .help = "Rated IO ignores thinktime settings",
3599 .parent = "rate",
3600 .category = FIO_OPT_C_IO,
3601 .group = FIO_OPT_G_RATE,
3602 },
3603 {
3604 .name = "max_latency",
3605 .lname = "Max Latency (usec)",
3606 .type = FIO_OPT_STR_VAL_TIME,
3607 .off1 = offsetof(struct thread_options, max_latency),
3608 .help = "Maximum tolerated IO latency (usec)",
3609 .is_time = 1,
3610 .category = FIO_OPT_C_IO,
3611 .group = FIO_OPT_G_LATPROF,
3612 },
3613 {
3614 .name = "latency_target",
3615 .lname = "Latency Target (usec)",
3616 .type = FIO_OPT_STR_VAL_TIME,
3617 .off1 = offsetof(struct thread_options, latency_target),
3618 .help = "Ramp to max queue depth supporting this latency",
3619 .is_time = 1,
3620 .category = FIO_OPT_C_IO,
3621 .group = FIO_OPT_G_LATPROF,
3622 },
3623 {
3624 .name = "latency_window",
3625 .lname = "Latency Window (usec)",
3626 .type = FIO_OPT_STR_VAL_TIME,
3627 .off1 = offsetof(struct thread_options, latency_window),
3628 .help = "Time to sustain latency_target",
3629 .is_time = 1,
3630 .category = FIO_OPT_C_IO,
3631 .group = FIO_OPT_G_LATPROF,
3632 },
3633 {
3634 .name = "latency_percentile",
3635 .lname = "Latency Percentile",
3636 .type = FIO_OPT_FLOAT_LIST,
3637 .off1 = offsetof(struct thread_options, latency_percentile),
3638 .help = "Percentile of IOs must be below latency_target",
3639 .def = "100",
3640 .maxlen = 1,
3641 .minfp = 0.0,
3642 .maxfp = 100.0,
3643 .category = FIO_OPT_C_IO,
3644 .group = FIO_OPT_G_LATPROF,
3645 },
3646 {
3647 .name = "invalidate",
3648 .lname = "Cache invalidate",
3649 .type = FIO_OPT_BOOL,
3650 .off1 = offsetof(struct thread_options, invalidate_cache),
3651 .help = "Invalidate buffer/page cache prior to running job",
3652 .def = "1",
3653 .category = FIO_OPT_C_IO,
3654 .group = FIO_OPT_G_IO_TYPE,
3655 },
3656 {
3657 .name = "sync",
3658 .lname = "Synchronous I/O",
3659 .type = FIO_OPT_BOOL,
3660 .off1 = offsetof(struct thread_options, sync_io),
3661 .help = "Use O_SYNC for buffered writes",
3662 .def = "0",
3663 .parent = "buffered",
3664 .hide = 1,
3665 .category = FIO_OPT_C_IO,
3666 .group = FIO_OPT_G_IO_TYPE,
3667 },
3668#ifdef FIO_HAVE_WRITE_HINT
3669 {
3670 .name = "write_hint",
3671 .lname = "Write hint",
3672 .type = FIO_OPT_STR,
3673 .off1 = offsetof(struct thread_options, write_hint),
3674 .help = "Set expected write life time",
3675 .category = FIO_OPT_C_ENGINE,
3676 .group = FIO_OPT_G_INVALID,
3677 .posval = {
3678 { .ival = "none",
3679 .oval = RWH_WRITE_LIFE_NONE,
3680 },
3681 { .ival = "short",
3682 .oval = RWH_WRITE_LIFE_SHORT,
3683 },
3684 { .ival = "medium",
3685 .oval = RWH_WRITE_LIFE_MEDIUM,
3686 },
3687 { .ival = "long",
3688 .oval = RWH_WRITE_LIFE_LONG,
3689 },
3690 { .ival = "extreme",
3691 .oval = RWH_WRITE_LIFE_EXTREME,
3692 },
3693 },
3694 },
3695#endif
3696 {
3697 .name = "create_serialize",
3698 .lname = "Create serialize",
3699 .type = FIO_OPT_BOOL,
3700 .off1 = offsetof(struct thread_options, create_serialize),
3701 .help = "Serialize creation of job files",
3702 .def = "1",
3703 .category = FIO_OPT_C_FILE,
3704 .group = FIO_OPT_G_INVALID,
3705 },
3706 {
3707 .name = "create_fsync",
3708 .lname = "Create fsync",
3709 .type = FIO_OPT_BOOL,
3710 .off1 = offsetof(struct thread_options, create_fsync),
3711 .help = "fsync file after creation",
3712 .def = "1",
3713 .category = FIO_OPT_C_FILE,
3714 .group = FIO_OPT_G_INVALID,
3715 },
3716 {
3717 .name = "create_on_open",
3718 .lname = "Create on open",
3719 .type = FIO_OPT_BOOL,
3720 .off1 = offsetof(struct thread_options, create_on_open),
3721 .help = "Create files when they are opened for IO",
3722 .def = "0",
3723 .category = FIO_OPT_C_FILE,
3724 .group = FIO_OPT_G_INVALID,
3725 },
3726 {
3727 .name = "create_only",
3728 .lname = "Create Only",
3729 .type = FIO_OPT_BOOL,
3730 .off1 = offsetof(struct thread_options, create_only),
3731 .help = "Only perform file creation phase",
3732 .category = FIO_OPT_C_FILE,
3733 .def = "0",
3734 },
3735 {
3736 .name = "allow_file_create",
3737 .lname = "Allow file create",
3738 .type = FIO_OPT_BOOL,
3739 .off1 = offsetof(struct thread_options, allow_create),
3740 .help = "Permit fio to create files, if they don't exist",
3741 .def = "1",
3742 .category = FIO_OPT_C_FILE,
3743 .group = FIO_OPT_G_FILENAME,
3744 },
3745 {
3746 .name = "allow_mounted_write",
3747 .lname = "Allow mounted write",
3748 .type = FIO_OPT_BOOL,
3749 .off1 = offsetof(struct thread_options, allow_mounted_write),
3750 .help = "Allow writes to a mounted partition",
3751 .def = "0",
3752 .category = FIO_OPT_C_FILE,
3753 .group = FIO_OPT_G_FILENAME,
3754 },
3755 {
3756 .name = "pre_read",
3757 .lname = "Pre-read files",
3758 .type = FIO_OPT_BOOL,
3759 .off1 = offsetof(struct thread_options, pre_read),
3760 .help = "Pre-read files before starting official testing",
3761 .def = "0",
3762 .category = FIO_OPT_C_FILE,
3763 .group = FIO_OPT_G_INVALID,
3764 },
3765#ifdef FIO_HAVE_CPU_AFFINITY
3766 {
3767 .name = "cpumask",
3768 .lname = "CPU mask",
3769 .type = FIO_OPT_INT,
3770 .cb = str_cpumask_cb,
3771 .off1 = offsetof(struct thread_options, cpumask),
3772 .help = "CPU affinity mask",
3773 .category = FIO_OPT_C_GENERAL,
3774 .group = FIO_OPT_G_CRED,
3775 },
3776 {
3777 .name = "cpus_allowed",
3778 .lname = "CPUs allowed",
3779 .type = FIO_OPT_STR,
3780 .cb = str_cpus_allowed_cb,
3781 .off1 = offsetof(struct thread_options, cpumask),
3782 .help = "Set CPUs allowed",
3783 .category = FIO_OPT_C_GENERAL,
3784 .group = FIO_OPT_G_CRED,
3785 },
3786 {
3787 .name = "cpus_allowed_policy",
3788 .lname = "CPUs allowed distribution policy",
3789 .type = FIO_OPT_STR,
3790 .off1 = offsetof(struct thread_options, cpus_allowed_policy),
3791 .help = "Distribution policy for cpus_allowed",
3792 .parent = "cpus_allowed",
3793 .prio = 1,
3794 .posval = {
3795 { .ival = "shared",
3796 .oval = FIO_CPUS_SHARED,
3797 .help = "Mask shared between threads",
3798 },
3799 { .ival = "split",
3800 .oval = FIO_CPUS_SPLIT,
3801 .help = "Mask split between threads",
3802 },
3803 },
3804 .category = FIO_OPT_C_GENERAL,
3805 .group = FIO_OPT_G_CRED,
3806 },
3807#else
3808 {
3809 .name = "cpumask",
3810 .lname = "CPU mask",
3811 .type = FIO_OPT_UNSUPPORTED,
3812 .help = "Your platform does not support CPU affinities",
3813 },
3814 {
3815 .name = "cpus_allowed",
3816 .lname = "CPUs allowed",
3817 .type = FIO_OPT_UNSUPPORTED,
3818 .help = "Your platform does not support CPU affinities",
3819 },
3820 {
3821 .name = "cpus_allowed_policy",
3822 .lname = "CPUs allowed distribution policy",
3823 .type = FIO_OPT_UNSUPPORTED,
3824 .help = "Your platform does not support CPU affinities",
3825 },
3826#endif
3827#ifdef CONFIG_LIBNUMA
3828 {
3829 .name = "numa_cpu_nodes",
3830 .lname = "NUMA CPU Nodes",
3831 .type = FIO_OPT_STR,
3832 .cb = str_numa_cpunodes_cb,
3833 .off1 = offsetof(struct thread_options, numa_cpunodes),
3834 .help = "NUMA CPU nodes bind",
3835 .category = FIO_OPT_C_GENERAL,
3836 .group = FIO_OPT_G_INVALID,
3837 },
3838 {
3839 .name = "numa_mem_policy",
3840 .lname = "NUMA Memory Policy",
3841 .type = FIO_OPT_STR,
3842 .cb = str_numa_mpol_cb,
3843 .off1 = offsetof(struct thread_options, numa_memnodes),
3844 .help = "NUMA memory policy setup",
3845 .category = FIO_OPT_C_GENERAL,
3846 .group = FIO_OPT_G_INVALID,
3847 },
3848#else
3849 {
3850 .name = "numa_cpu_nodes",
3851 .lname = "NUMA CPU Nodes",
3852 .type = FIO_OPT_UNSUPPORTED,
3853 .help = "Build fio with libnuma-dev(el) to enable this option",
3854 },
3855 {
3856 .name = "numa_mem_policy",
3857 .lname = "NUMA Memory Policy",
3858 .type = FIO_OPT_UNSUPPORTED,
3859 .help = "Build fio with libnuma-dev(el) to enable this option",
3860 },
3861#endif
3862#ifdef CONFIG_CUDA
3863 {
3864 .name = "gpu_dev_id",
3865 .lname = "GPU device ID",
3866 .type = FIO_OPT_INT,
3867 .off1 = offsetof(struct thread_options, gpu_dev_id),
3868 .help = "Set GPU device ID for GPUDirect RDMA",
3869 .def = "0",
3870 .category = FIO_OPT_C_GENERAL,
3871 .group = FIO_OPT_G_INVALID,
3872 },
3873#endif
3874 {
3875 .name = "end_fsync",
3876 .lname = "End fsync",
3877 .type = FIO_OPT_BOOL,
3878 .off1 = offsetof(struct thread_options, end_fsync),
3879 .help = "Include fsync at the end of job",
3880 .def = "0",
3881 .category = FIO_OPT_C_FILE,
3882 .group = FIO_OPT_G_INVALID,
3883 },
3884 {
3885 .name = "fsync_on_close",
3886 .lname = "Fsync on close",
3887 .type = FIO_OPT_BOOL,
3888 .off1 = offsetof(struct thread_options, fsync_on_close),
3889 .help = "fsync files on close",
3890 .def = "0",
3891 .category = FIO_OPT_C_FILE,
3892 .group = FIO_OPT_G_INVALID,
3893 },
3894 {
3895 .name = "unlink",
3896 .lname = "Unlink file",
3897 .type = FIO_OPT_BOOL,
3898 .off1 = offsetof(struct thread_options, unlink),
3899 .help = "Unlink created files after job has completed",
3900 .def = "0",
3901 .category = FIO_OPT_C_FILE,
3902 .group = FIO_OPT_G_INVALID,
3903 },
3904 {
3905 .name = "unlink_each_loop",
3906 .lname = "Unlink file after each loop of a job",
3907 .type = FIO_OPT_BOOL,
3908 .off1 = offsetof(struct thread_options, unlink_each_loop),
3909 .help = "Unlink created files after each loop in a job has completed",
3910 .def = "0",
3911 .category = FIO_OPT_C_FILE,
3912 .group = FIO_OPT_G_INVALID,
3913 },
3914 {
3915 .name = "exitall",
3916 .lname = "Exit-all on terminate",
3917 .type = FIO_OPT_STR_SET,
3918 .cb = str_exitall_cb,
3919 .help = "Terminate all jobs when one exits",
3920 .category = FIO_OPT_C_GENERAL,
3921 .group = FIO_OPT_G_PROCESS,
3922 },
3923 {
3924 .name = "exitall_on_error",
3925 .lname = "Exit-all on terminate in error",
3926 .type = FIO_OPT_STR_SET,
3927 .off1 = offsetof(struct thread_options, exitall_error),
3928 .help = "Terminate all jobs when one exits in error",
3929 .category = FIO_OPT_C_GENERAL,
3930 .group = FIO_OPT_G_PROCESS,
3931 },
3932 {
3933 .name = "stonewall",
3934 .lname = "Wait for previous",
3935 .alias = "wait_for_previous",
3936 .type = FIO_OPT_STR_SET,
3937 .off1 = offsetof(struct thread_options, stonewall),
3938 .help = "Insert a hard barrier between this job and previous",
3939 .category = FIO_OPT_C_GENERAL,
3940 .group = FIO_OPT_G_PROCESS,
3941 },
3942 {
3943 .name = "new_group",
3944 .lname = "New group",
3945 .type = FIO_OPT_STR_SET,
3946 .off1 = offsetof(struct thread_options, new_group),
3947 .help = "Mark the start of a new group (for reporting)",
3948 .category = FIO_OPT_C_GENERAL,
3949 .group = FIO_OPT_G_PROCESS,
3950 },
3951 {
3952 .name = "thread",
3953 .lname = "Thread",
3954 .type = FIO_OPT_STR_SET,
3955 .off1 = offsetof(struct thread_options, use_thread),
3956 .help = "Use threads instead of processes",
3957#ifdef CONFIG_NO_SHM
3958 .def = "1",
3959 .no_warn_def = 1,
3960#endif
3961 .category = FIO_OPT_C_GENERAL,
3962 .group = FIO_OPT_G_PROCESS,
3963 },
3964 {
3965 .name = "per_job_logs",
3966 .lname = "Per Job Logs",
3967 .type = FIO_OPT_BOOL,
3968 .off1 = offsetof(struct thread_options, per_job_logs),
3969 .help = "Include job number in generated log files or not",
3970 .def = "1",
3971 .category = FIO_OPT_C_LOG,
3972 .group = FIO_OPT_G_INVALID,
3973 },
3974 {
3975 .name = "write_bw_log",
3976 .lname = "Write bandwidth log",
3977 .type = FIO_OPT_STR,
3978 .off1 = offsetof(struct thread_options, bw_log_file),
3979 .cb = str_write_bw_log_cb,
3980 .help = "Write log of bandwidth during run",
3981 .category = FIO_OPT_C_LOG,
3982 .group = FIO_OPT_G_INVALID,
3983 },
3984 {
3985 .name = "write_lat_log",
3986 .lname = "Write latency log",
3987 .type = FIO_OPT_STR,
3988 .off1 = offsetof(struct thread_options, lat_log_file),
3989 .cb = str_write_lat_log_cb,
3990 .help = "Write log of latency during run",
3991 .category = FIO_OPT_C_LOG,
3992 .group = FIO_OPT_G_INVALID,
3993 },
3994 {
3995 .name = "write_iops_log",
3996 .lname = "Write IOPS log",
3997 .type = FIO_OPT_STR,
3998 .off1 = offsetof(struct thread_options, iops_log_file),
3999 .cb = str_write_iops_log_cb,
4000 .help = "Write log of IOPS during run",
4001 .category = FIO_OPT_C_LOG,
4002 .group = FIO_OPT_G_INVALID,
4003 },
4004 {
4005 .name = "log_avg_msec",
4006 .lname = "Log averaging (msec)",
4007 .type = FIO_OPT_INT,
4008 .off1 = offsetof(struct thread_options, log_avg_msec),
4009 .help = "Average bw/iops/lat logs over this period of time",
4010 .def = "0",
4011 .category = FIO_OPT_C_LOG,
4012 .group = FIO_OPT_G_INVALID,
4013 },
4014 {
4015 .name = "log_hist_msec",
4016 .lname = "Log histograms (msec)",
4017 .type = FIO_OPT_INT,
4018 .off1 = offsetof(struct thread_options, log_hist_msec),
4019 .help = "Dump completion latency histograms at frequency of this time value",
4020 .def = "0",
4021 .category = FIO_OPT_C_LOG,
4022 .group = FIO_OPT_G_INVALID,
4023 },
4024 {
4025 .name = "log_hist_coarseness",
4026 .lname = "Histogram logs coarseness",
4027 .type = FIO_OPT_INT,
4028 .off1 = offsetof(struct thread_options, log_hist_coarseness),
4029 .help = "Integer in range [0,6]. Higher coarseness outputs"
4030 " fewer histogram bins per sample. The number of bins for"
4031 " these are [1216, 608, 304, 152, 76, 38, 19] respectively.",
4032 .def = "0",
4033 .category = FIO_OPT_C_LOG,
4034 .group = FIO_OPT_G_INVALID,
4035 },
4036 {
4037 .name = "write_hist_log",
4038 .lname = "Write latency histogram logs",
4039 .type = FIO_OPT_STR,
4040 .off1 = offsetof(struct thread_options, hist_log_file),
4041 .cb = str_write_hist_log_cb,
4042 .help = "Write log of latency histograms during run",
4043 .category = FIO_OPT_C_LOG,
4044 .group = FIO_OPT_G_INVALID,
4045 },
4046 {
4047 .name = "log_max_value",
4048 .lname = "Log maximum instead of average",
4049 .type = FIO_OPT_BOOL,
4050 .off1 = offsetof(struct thread_options, log_max),
4051 .help = "Log max sample in a window instead of average",
4052 .def = "0",
4053 .category = FIO_OPT_C_LOG,
4054 .group = FIO_OPT_G_INVALID,
4055 },
4056 {
4057 .name = "log_offset",
4058 .lname = "Log offset of IO",
4059 .type = FIO_OPT_BOOL,
4060 .off1 = offsetof(struct thread_options, log_offset),
4061 .help = "Include offset of IO for each log entry",
4062 .def = "0",
4063 .category = FIO_OPT_C_LOG,
4064 .group = FIO_OPT_G_INVALID,
4065 },
4066#ifdef CONFIG_ZLIB
4067 {
4068 .name = "log_compression",
4069 .lname = "Log compression",
4070 .type = FIO_OPT_INT,
4071 .off1 = offsetof(struct thread_options, log_gz),
4072 .help = "Log in compressed chunks of this size",
4073 .minval = 1024ULL,
4074 .maxval = 512 * 1024 * 1024ULL,
4075 .category = FIO_OPT_C_LOG,
4076 .group = FIO_OPT_G_INVALID,
4077 },
4078#ifdef FIO_HAVE_CPU_AFFINITY
4079 {
4080 .name = "log_compression_cpus",
4081 .lname = "Log Compression CPUs",
4082 .type = FIO_OPT_STR,
4083 .cb = str_log_cpus_allowed_cb,
4084 .off1 = offsetof(struct thread_options, log_gz_cpumask),
4085 .parent = "log_compression",
4086 .help = "Limit log compression to these CPUs",
4087 .category = FIO_OPT_C_LOG,
4088 .group = FIO_OPT_G_INVALID,
4089 },
4090#else
4091 {
4092 .name = "log_compression_cpus",
4093 .lname = "Log Compression CPUs",
4094 .type = FIO_OPT_UNSUPPORTED,
4095 .help = "Your platform does not support CPU affinities",
4096 },
4097#endif
4098 {
4099 .name = "log_store_compressed",
4100 .lname = "Log store compressed",
4101 .type = FIO_OPT_BOOL,
4102 .off1 = offsetof(struct thread_options, log_gz_store),
4103 .help = "Store logs in a compressed format",
4104 .category = FIO_OPT_C_LOG,
4105 .group = FIO_OPT_G_INVALID,
4106 },
4107#else
4108 {
4109 .name = "log_compression",
4110 .lname = "Log compression",
4111 .type = FIO_OPT_UNSUPPORTED,
4112 .help = "Install libz-dev(el) to get compression support",
4113 },
4114 {
4115 .name = "log_store_compressed",
4116 .lname = "Log store compressed",
4117 .type = FIO_OPT_UNSUPPORTED,
4118 .help = "Install libz-dev(el) to get compression support",
4119 },
4120#endif
4121 {
4122 .name = "log_unix_epoch",
4123 .lname = "Log epoch unix",
4124 .type = FIO_OPT_BOOL,
4125 .off1 = offsetof(struct thread_options, log_unix_epoch),
4126 .help = "Use Unix time in log files",
4127 .category = FIO_OPT_C_LOG,
4128 .group = FIO_OPT_G_INVALID,
4129 },
4130 {
4131 .name = "block_error_percentiles",
4132 .lname = "Block error percentiles",
4133 .type = FIO_OPT_BOOL,
4134 .off1 = offsetof(struct thread_options, block_error_hist),
4135 .help = "Record trim block errors and make a histogram",
4136 .def = "0",
4137 .category = FIO_OPT_C_LOG,
4138 .group = FIO_OPT_G_INVALID,
4139 },
4140 {
4141 .name = "bwavgtime",
4142 .lname = "Bandwidth average time",
4143 .type = FIO_OPT_INT,
4144 .off1 = offsetof(struct thread_options, bw_avg_time),
4145 .help = "Time window over which to calculate bandwidth"
4146 " (msec)",
4147 .def = "500",
4148 .parent = "write_bw_log",
4149 .hide = 1,
4150 .interval = 100,
4151 .category = FIO_OPT_C_LOG,
4152 .group = FIO_OPT_G_INVALID,
4153 },
4154 {
4155 .name = "iopsavgtime",
4156 .lname = "IOPS average time",
4157 .type = FIO_OPT_INT,
4158 .off1 = offsetof(struct thread_options, iops_avg_time),
4159 .help = "Time window over which to calculate IOPS (msec)",
4160 .def = "500",
4161 .parent = "write_iops_log",
4162 .hide = 1,
4163 .interval = 100,
4164 .category = FIO_OPT_C_LOG,
4165 .group = FIO_OPT_G_INVALID,
4166 },
4167 {
4168 .name = "group_reporting",
4169 .lname = "Group reporting",
4170 .type = FIO_OPT_STR_SET,
4171 .off1 = offsetof(struct thread_options, group_reporting),
4172 .help = "Do reporting on a per-group basis",
4173 .category = FIO_OPT_C_STAT,
4174 .group = FIO_OPT_G_INVALID,
4175 },
4176 {
4177 .name = "stats",
4178 .lname = "Stats",
4179 .type = FIO_OPT_BOOL,
4180 .off1 = offsetof(struct thread_options, stats),
4181 .help = "Enable collection of stats",
4182 .def = "1",
4183 .category = FIO_OPT_C_STAT,
4184 .group = FIO_OPT_G_INVALID,
4185 },
4186 {
4187 .name = "zero_buffers",
4188 .lname = "Zero I/O buffers",
4189 .type = FIO_OPT_STR_SET,
4190 .off1 = offsetof(struct thread_options, zero_buffers),
4191 .help = "Init IO buffers to all zeroes",
4192 .category = FIO_OPT_C_IO,
4193 .group = FIO_OPT_G_IO_BUF,
4194 },
4195 {
4196 .name = "refill_buffers",
4197 .lname = "Refill I/O buffers",
4198 .type = FIO_OPT_STR_SET,
4199 .off1 = offsetof(struct thread_options, refill_buffers),
4200 .help = "Refill IO buffers on every IO submit",
4201 .category = FIO_OPT_C_IO,
4202 .group = FIO_OPT_G_IO_BUF,
4203 },
4204 {
4205 .name = "scramble_buffers",
4206 .lname = "Scramble I/O buffers",
4207 .type = FIO_OPT_BOOL,
4208 .off1 = offsetof(struct thread_options, scramble_buffers),
4209 .help = "Slightly scramble buffers on every IO submit",
4210 .def = "1",
4211 .category = FIO_OPT_C_IO,
4212 .group = FIO_OPT_G_IO_BUF,
4213 },
4214 {
4215 .name = "buffer_pattern",
4216 .lname = "Buffer pattern",
4217 .type = FIO_OPT_STR,
4218 .cb = str_buffer_pattern_cb,
4219 .off1 = offsetof(struct thread_options, buffer_pattern),
4220 .help = "Fill pattern for IO buffers",
4221 .category = FIO_OPT_C_IO,
4222 .group = FIO_OPT_G_IO_BUF,
4223 },
4224 {
4225 .name = "buffer_compress_percentage",
4226 .lname = "Buffer compression percentage",
4227 .type = FIO_OPT_INT,
4228 .cb = str_buffer_compress_cb,
4229 .off1 = offsetof(struct thread_options, compress_percentage),
4230 .maxval = 100,
4231 .minval = 0,
4232 .help = "How compressible the buffer is (approximately)",
4233 .interval = 5,
4234 .category = FIO_OPT_C_IO,
4235 .group = FIO_OPT_G_IO_BUF,
4236 },
4237 {
4238 .name = "buffer_compress_chunk",
4239 .lname = "Buffer compression chunk size",
4240 .type = FIO_OPT_INT,
4241 .off1 = offsetof(struct thread_options, compress_chunk),
4242 .parent = "buffer_compress_percentage",
4243 .hide = 1,
4244 .help = "Size of compressible region in buffer",
4245 .def = "512",
4246 .interval = 256,
4247 .category = FIO_OPT_C_IO,
4248 .group = FIO_OPT_G_IO_BUF,
4249 },
4250 {
4251 .name = "dedupe_percentage",
4252 .lname = "Dedupe percentage",
4253 .type = FIO_OPT_INT,
4254 .cb = str_dedupe_cb,
4255 .off1 = offsetof(struct thread_options, dedupe_percentage),
4256 .maxval = 100,
4257 .minval = 0,
4258 .help = "Percentage of buffers that are dedupable",
4259 .interval = 1,
4260 .category = FIO_OPT_C_IO,
4261 .group = FIO_OPT_G_IO_BUF,
4262 },
4263 {
4264 .name = "clat_percentiles",
4265 .lname = "Completion latency percentiles",
4266 .type = FIO_OPT_BOOL,
4267 .off1 = offsetof(struct thread_options, clat_percentiles),
4268 .help = "Enable the reporting of completion latency percentiles",
4269 .def = "1",
4270 .inverse = "lat_percentiles",
4271 .category = FIO_OPT_C_STAT,
4272 .group = FIO_OPT_G_INVALID,
4273 },
4274 {
4275 .name = "lat_percentiles",
4276 .lname = "IO latency percentiles",
4277 .type = FIO_OPT_BOOL,
4278 .off1 = offsetof(struct thread_options, lat_percentiles),
4279 .help = "Enable the reporting of IO latency percentiles",
4280 .def = "0",
4281 .inverse = "clat_percentiles",
4282 .category = FIO_OPT_C_STAT,
4283 .group = FIO_OPT_G_INVALID,
4284 },
4285 {
4286 .name = "percentile_list",
4287 .lname = "Percentile list",
4288 .type = FIO_OPT_FLOAT_LIST,
4289 .off1 = offsetof(struct thread_options, percentile_list),
4290 .off2 = offsetof(struct thread_options, percentile_precision),
4291 .help = "Specify a custom list of percentiles to report for "
4292 "completion latency and block errors",
4293 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
4294 .maxlen = FIO_IO_U_LIST_MAX_LEN,
4295 .minfp = 0.0,
4296 .maxfp = 100.0,
4297 .category = FIO_OPT_C_STAT,
4298 .group = FIO_OPT_G_INVALID,
4299 },
4300 {
4301 .name = "significant_figures",
4302 .lname = "Significant figures",
4303 .type = FIO_OPT_INT,
4304 .off1 = offsetof(struct thread_options, sig_figs),
4305 .maxval = 10,
4306 .minval = 1,
4307 .help = "Significant figures for output-format set to normal",
4308 .def = "4",
4309 .interval = 1,
4310 .category = FIO_OPT_C_STAT,
4311 .group = FIO_OPT_G_INVALID,
4312 },
4313
4314#ifdef FIO_HAVE_DISK_UTIL
4315 {
4316 .name = "disk_util",
4317 .lname = "Disk utilization",
4318 .type = FIO_OPT_BOOL,
4319 .off1 = offsetof(struct thread_options, do_disk_util),
4320 .help = "Log disk utilization statistics",
4321 .def = "1",
4322 .category = FIO_OPT_C_STAT,
4323 .group = FIO_OPT_G_INVALID,
4324 },
4325#else
4326 {
4327 .name = "disk_util",
4328 .lname = "Disk utilization",
4329 .type = FIO_OPT_UNSUPPORTED,
4330 .help = "Your platform does not support disk utilization",
4331 },
4332#endif
4333 {
4334 .name = "gtod_reduce",
4335 .lname = "Reduce gettimeofday() calls",
4336 .type = FIO_OPT_BOOL,
4337 .help = "Greatly reduce number of gettimeofday() calls",
4338 .cb = str_gtod_reduce_cb,
4339 .def = "0",
4340 .hide_on_set = 1,
4341 .category = FIO_OPT_C_STAT,
4342 .group = FIO_OPT_G_INVALID,
4343 },
4344 {
4345 .name = "disable_lat",
4346 .lname = "Disable all latency stats",
4347 .type = FIO_OPT_BOOL,
4348 .off1 = offsetof(struct thread_options, disable_lat),
4349 .help = "Disable latency numbers",
4350 .parent = "gtod_reduce",
4351 .hide = 1,
4352 .def = "0",
4353 .category = FIO_OPT_C_STAT,
4354 .group = FIO_OPT_G_INVALID,
4355 },
4356 {
4357 .name = "disable_clat",
4358 .lname = "Disable completion latency stats",
4359 .type = FIO_OPT_BOOL,
4360 .off1 = offsetof(struct thread_options, disable_clat),
4361 .help = "Disable completion latency numbers",
4362 .parent = "gtod_reduce",
4363 .hide = 1,
4364 .def = "0",
4365 .category = FIO_OPT_C_STAT,
4366 .group = FIO_OPT_G_INVALID,
4367 },
4368 {
4369 .name = "disable_slat",
4370 .lname = "Disable submission latency stats",
4371 .type = FIO_OPT_BOOL,
4372 .off1 = offsetof(struct thread_options, disable_slat),
4373 .help = "Disable submission latency numbers",
4374 .parent = "gtod_reduce",
4375 .hide = 1,
4376 .def = "0",
4377 .category = FIO_OPT_C_STAT,
4378 .group = FIO_OPT_G_INVALID,
4379 },
4380 {
4381 .name = "disable_bw_measurement",
4382 .alias = "disable_bw",
4383 .lname = "Disable bandwidth stats",
4384 .type = FIO_OPT_BOOL,
4385 .off1 = offsetof(struct thread_options, disable_bw),
4386 .help = "Disable bandwidth logging",
4387 .parent = "gtod_reduce",
4388 .hide = 1,
4389 .def = "0",
4390 .category = FIO_OPT_C_STAT,
4391 .group = FIO_OPT_G_INVALID,
4392 },
4393 {
4394 .name = "gtod_cpu",
4395 .lname = "Dedicated gettimeofday() CPU",
4396 .type = FIO_OPT_INT,
4397 .off1 = offsetof(struct thread_options, gtod_cpu),
4398 .help = "Set up dedicated gettimeofday() thread on this CPU",
4399 .verify = gtod_cpu_verify,
4400 .category = FIO_OPT_C_GENERAL,
4401 .group = FIO_OPT_G_CLOCK,
4402 },
4403 {
4404 .name = "unified_rw_reporting",
4405 .lname = "Unified RW Reporting",
4406 .type = FIO_OPT_BOOL,
4407 .off1 = offsetof(struct thread_options, unified_rw_rep),
4408 .help = "Unify reporting across data direction",
4409 .def = "0",
4410 .category = FIO_OPT_C_GENERAL,
4411 .group = FIO_OPT_G_INVALID,
4412 },
4413 {
4414 .name = "continue_on_error",
4415 .lname = "Continue on error",
4416 .type = FIO_OPT_STR,
4417 .off1 = offsetof(struct thread_options, continue_on_error),
4418 .help = "Continue on non-fatal errors during IO",
4419 .def = "none",
4420 .category = FIO_OPT_C_GENERAL,
4421 .group = FIO_OPT_G_ERR,
4422 .posval = {
4423 { .ival = "none",
4424 .oval = ERROR_TYPE_NONE,
4425 .help = "Exit when an error is encountered",
4426 },
4427 { .ival = "read",
4428 .oval = ERROR_TYPE_READ,
4429 .help = "Continue on read errors only",
4430 },
4431 { .ival = "write",
4432 .oval = ERROR_TYPE_WRITE,
4433 .help = "Continue on write errors only",
4434 },
4435 { .ival = "io",
4436 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
4437 .help = "Continue on any IO errors",
4438 },
4439 { .ival = "verify",
4440 .oval = ERROR_TYPE_VERIFY,
4441 .help = "Continue on verify errors only",
4442 },
4443 { .ival = "all",
4444 .oval = ERROR_TYPE_ANY,
4445 .help = "Continue on all io and verify errors",
4446 },
4447 { .ival = "0",
4448 .oval = ERROR_TYPE_NONE,
4449 .help = "Alias for 'none'",
4450 },
4451 { .ival = "1",
4452 .oval = ERROR_TYPE_ANY,
4453 .help = "Alias for 'all'",
4454 },
4455 },
4456 },
4457 {
4458 .name = "ignore_error",
4459 .lname = "Ignore Error",
4460 .type = FIO_OPT_STR,
4461 .cb = str_ignore_error_cb,
4462 .off1 = offsetof(struct thread_options, ignore_error_nr),
4463 .help = "Set a specific list of errors to ignore",
4464 .parent = "rw",
4465 .category = FIO_OPT_C_GENERAL,
4466 .group = FIO_OPT_G_ERR,
4467 },
4468 {
4469 .name = "error_dump",
4470 .lname = "Error Dump",
4471 .type = FIO_OPT_BOOL,
4472 .off1 = offsetof(struct thread_options, error_dump),
4473 .def = "0",
4474 .help = "Dump info on each error",
4475 .category = FIO_OPT_C_GENERAL,
4476 .group = FIO_OPT_G_ERR,
4477 },
4478 {
4479 .name = "profile",
4480 .lname = "Profile",
4481 .type = FIO_OPT_STR_STORE,
4482 .off1 = offsetof(struct thread_options, profile),
4483 .help = "Select a specific builtin performance test",
4484 .category = FIO_OPT_C_PROFILE,
4485 .group = FIO_OPT_G_INVALID,
4486 },
4487 {
4488 .name = "cgroup",
4489 .lname = "Cgroup",
4490 .type = FIO_OPT_STR_STORE,
4491 .off1 = offsetof(struct thread_options, cgroup),
4492 .help = "Add job to cgroup of this name",
4493 .category = FIO_OPT_C_GENERAL,
4494 .group = FIO_OPT_G_CGROUP,
4495 },
4496 {
4497 .name = "cgroup_nodelete",
4498 .lname = "Cgroup no-delete",
4499 .type = FIO_OPT_BOOL,
4500 .off1 = offsetof(struct thread_options, cgroup_nodelete),
4501 .help = "Do not delete cgroups after job completion",
4502 .def = "0",
4503 .parent = "cgroup",
4504 .category = FIO_OPT_C_GENERAL,
4505 .group = FIO_OPT_G_CGROUP,
4506 },
4507 {
4508 .name = "cgroup_weight",
4509 .lname = "Cgroup weight",
4510 .type = FIO_OPT_INT,
4511 .off1 = offsetof(struct thread_options, cgroup_weight),
4512 .help = "Use given weight for cgroup",
4513 .minval = 100,
4514 .maxval = 1000,
4515 .parent = "cgroup",
4516 .category = FIO_OPT_C_GENERAL,
4517 .group = FIO_OPT_G_CGROUP,
4518 },
4519 {
4520 .name = "uid",
4521 .lname = "User ID",
4522 .type = FIO_OPT_INT,
4523 .off1 = offsetof(struct thread_options, uid),
4524 .help = "Run job with this user ID",
4525 .category = FIO_OPT_C_GENERAL,
4526 .group = FIO_OPT_G_CRED,
4527 },
4528 {
4529 .name = "gid",
4530 .lname = "Group ID",
4531 .type = FIO_OPT_INT,
4532 .off1 = offsetof(struct thread_options, gid),
4533 .help = "Run job with this group ID",
4534 .category = FIO_OPT_C_GENERAL,
4535 .group = FIO_OPT_G_CRED,
4536 },
4537 {
4538 .name = "kb_base",
4539 .lname = "KB Base",
4540 .type = FIO_OPT_STR,
4541 .off1 = offsetof(struct thread_options, kb_base),
4542 .prio = 1,
4543 .def = "1024",
4544 .posval = {
4545 { .ival = "1024",
4546 .oval = 1024,
4547 .help = "Inputs invert IEC and SI prefixes (for compatibility); outputs prefer binary",
4548 },
4549 { .ival = "1000",
4550 .oval = 1000,
4551 .help = "Inputs use IEC and SI prefixes; outputs prefer SI",
4552 },
4553 },
4554 .help = "Unit prefix interpretation for quantities of data (IEC and SI)",
4555 .category = FIO_OPT_C_GENERAL,
4556 .group = FIO_OPT_G_INVALID,
4557 },
4558 {
4559 .name = "unit_base",
4560 .lname = "Unit for quantities of data (Bits or Bytes)",
4561 .type = FIO_OPT_STR,
4562 .off1 = offsetof(struct thread_options, unit_base),
4563 .prio = 1,
4564 .posval = {
4565 { .ival = "0",
4566 .oval = N2S_NONE,
4567 .help = "Auto-detect",
4568 },
4569 { .ival = "8",
4570 .oval = N2S_BYTEPERSEC,
4571 .help = "Normal (byte based)",
4572 },
4573 { .ival = "1",
4574 .oval = N2S_BITPERSEC,
4575 .help = "Bit based",
4576 },
4577 },
4578 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
4579 .category = FIO_OPT_C_GENERAL,
4580 .group = FIO_OPT_G_INVALID,
4581 },
4582 {
4583 .name = "hugepage-size",
4584 .lname = "Hugepage size",
4585 .type = FIO_OPT_INT,
4586 .off1 = offsetof(struct thread_options, hugepage_size),
4587 .help = "When using hugepages, specify size of each page",
4588 .def = __fio_stringify(FIO_HUGE_PAGE),
4589 .interval = 1024 * 1024,
4590 .category = FIO_OPT_C_GENERAL,
4591 .group = FIO_OPT_G_INVALID,
4592 },
4593 {
4594 .name = "flow_id",
4595 .lname = "I/O flow ID",
4596 .type = FIO_OPT_INT,
4597 .off1 = offsetof(struct thread_options, flow_id),
4598 .help = "The flow index ID to use",
4599 .def = "0",
4600 .category = FIO_OPT_C_IO,
4601 .group = FIO_OPT_G_IO_FLOW,
4602 },
4603 {
4604 .name = "flow",
4605 .lname = "I/O flow weight",
4606 .type = FIO_OPT_INT,
4607 .off1 = offsetof(struct thread_options, flow),
4608 .help = "Weight for flow control of this job",
4609 .parent = "flow_id",
4610 .hide = 1,
4611 .def = "0",
4612 .category = FIO_OPT_C_IO,
4613 .group = FIO_OPT_G_IO_FLOW,
4614 },
4615 {
4616 .name = "flow_watermark",
4617 .lname = "I/O flow watermark",
4618 .type = FIO_OPT_INT,
4619 .off1 = offsetof(struct thread_options, flow_watermark),
4620 .help = "High watermark for flow control. This option"
4621 " should be set to the same value for all threads"
4622 " with non-zero flow.",
4623 .parent = "flow_id",
4624 .hide = 1,
4625 .def = "1024",
4626 .category = FIO_OPT_C_IO,
4627 .group = FIO_OPT_G_IO_FLOW,
4628 },
4629 {
4630 .name = "flow_sleep",
4631 .lname = "I/O flow sleep",
4632 .type = FIO_OPT_INT,
4633 .off1 = offsetof(struct thread_options, flow_sleep),
4634 .help = "How many microseconds to sleep after being held"
4635 " back by the flow control mechanism",
4636 .parent = "flow_id",
4637 .hide = 1,
4638 .def = "0",
4639 .category = FIO_OPT_C_IO,
4640 .group = FIO_OPT_G_IO_FLOW,
4641 },
4642 {
4643 .name = "steadystate",
4644 .lname = "Steady state threshold",
4645 .alias = "ss",
4646 .type = FIO_OPT_STR,
4647 .off1 = offsetof(struct thread_options, ss_state),
4648 .cb = str_steadystate_cb,
4649 .help = "Define the criterion and limit to judge when a job has reached steady state",
4650 .def = "iops_slope:0.01%",
4651 .posval = {
4652 { .ival = "iops",
4653 .oval = FIO_SS_IOPS,
4654 .help = "maximum mean deviation of IOPS measurements",
4655 },
4656 { .ival = "iops_slope",
4657 .oval = FIO_SS_IOPS_SLOPE,
4658 .help = "slope calculated from IOPS measurements",
4659 },
4660 { .ival = "bw",
4661 .oval = FIO_SS_BW,
4662 .help = "maximum mean deviation of bandwidth measurements",
4663 },
4664 {
4665 .ival = "bw_slope",
4666 .oval = FIO_SS_BW_SLOPE,
4667 .help = "slope calculated from bandwidth measurements",
4668 },
4669 },
4670 .category = FIO_OPT_C_GENERAL,
4671 .group = FIO_OPT_G_RUNTIME,
4672 },
4673 {
4674 .name = "steadystate_duration",
4675 .lname = "Steady state duration",
4676 .alias = "ss_dur",
4677 .parent = "steadystate",
4678 .type = FIO_OPT_STR_VAL_TIME,
4679 .off1 = offsetof(struct thread_options, ss_dur),
4680 .help = "Stop workload upon attaining steady state for specified duration",
4681 .def = "0",
4682 .is_seconds = 1,
4683 .is_time = 1,
4684 .category = FIO_OPT_C_GENERAL,
4685 .group = FIO_OPT_G_RUNTIME,
4686 },
4687 {
4688 .name = "steadystate_ramp_time",
4689 .lname = "Steady state ramp time",
4690 .alias = "ss_ramp",
4691 .parent = "steadystate",
4692 .type = FIO_OPT_STR_VAL_TIME,
4693 .off1 = offsetof(struct thread_options, ss_ramp_time),
4694 .help = "Delay before initiation of data collection for steady state job termination testing",
4695 .def = "0",
4696 .is_seconds = 1,
4697 .is_time = 1,
4698 .category = FIO_OPT_C_GENERAL,
4699 .group = FIO_OPT_G_RUNTIME,
4700 },
4701 {
4702 .name = NULL,
4703 },
4704};
4705
4706static void add_to_lopt(struct option *lopt, struct fio_option *o,
4707 const char *name, int val)
4708{
4709 lopt->name = (char *) name;
4710 lopt->val = val;
4711 if (o->type == FIO_OPT_STR_SET)
4712 lopt->has_arg = optional_argument;
4713 else
4714 lopt->has_arg = required_argument;
4715}
4716
4717static void options_to_lopts(struct fio_option *opts,
4718 struct option *long_options,
4719 int i, int option_type)
4720{
4721 struct fio_option *o = &opts[0];
4722 while (o->name) {
4723 add_to_lopt(&long_options[i], o, o->name, option_type);
4724 if (o->alias) {
4725 i++;
4726 add_to_lopt(&long_options[i], o, o->alias, option_type);
4727 }
4728
4729 i++;
4730 o++;
4731 assert(i < FIO_NR_OPTIONS);
4732 }
4733}
4734
4735void fio_options_set_ioengine_opts(struct option *long_options,
4736 struct thread_data *td)
4737{
4738 unsigned int i;
4739
4740 i = 0;
4741 while (long_options[i].name) {
4742 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
4743 memset(&long_options[i], 0, sizeof(*long_options));
4744 break;
4745 }
4746 i++;
4747 }
4748
4749 /*
4750 * Just clear out the prior ioengine options.
4751 */
4752 if (!td || !td->eo)
4753 return;
4754
4755 options_to_lopts(td->io_ops->options, long_options, i,
4756 FIO_GETOPT_IOENGINE);
4757}
4758
4759void fio_options_dup_and_init(struct option *long_options)
4760{
4761 unsigned int i;
4762
4763 options_init(fio_options);
4764
4765 i = 0;
4766 while (long_options[i].name)
4767 i++;
4768
4769 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
4770}
4771
4772struct fio_keyword {
4773 const char *word;
4774 const char *desc;
4775 char *replace;
4776};
4777
4778static struct fio_keyword fio_keywords[] = {
4779 {
4780 .word = "$pagesize",
4781 .desc = "Page size in the system",
4782 },
4783 {
4784 .word = "$mb_memory",
4785 .desc = "Megabytes of memory online",
4786 },
4787 {
4788 .word = "$ncpus",
4789 .desc = "Number of CPUs online in the system",
4790 },
4791 {
4792 .word = NULL,
4793 },
4794};
4795
4796void fio_keywords_exit(void)
4797{
4798 struct fio_keyword *kw;
4799
4800 kw = &fio_keywords[0];
4801 while (kw->word) {
4802 free(kw->replace);
4803 kw->replace = NULL;
4804 kw++;
4805 }
4806}
4807
4808void fio_keywords_init(void)
4809{
4810 unsigned long long mb_memory;
4811 char buf[128];
4812 long l;
4813
4814 sprintf(buf, "%lu", (unsigned long) page_size);
4815 fio_keywords[0].replace = strdup(buf);
4816
4817 mb_memory = os_phys_mem() / (1024 * 1024);
4818 sprintf(buf, "%llu", mb_memory);
4819 fio_keywords[1].replace = strdup(buf);
4820
4821 l = cpus_online();
4822 sprintf(buf, "%lu", l);
4823 fio_keywords[2].replace = strdup(buf);
4824}
4825
4826#define BC_APP "bc"
4827
4828static char *bc_calc(char *str)
4829{
4830 char buf[128], *tmp;
4831 FILE *f;
4832 int ret;
4833
4834 /*
4835 * No math, just return string
4836 */
4837 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
4838 !strchr(str, '/')) || strchr(str, '\''))
4839 return str;
4840
4841 /*
4842 * Split option from value, we only need to calculate the value
4843 */
4844 tmp = strchr(str, '=');
4845 if (!tmp)
4846 return str;
4847
4848 tmp++;
4849
4850 /*
4851 * Prevent buffer overflows; such a case isn't reasonable anyway
4852 */
4853 if (strlen(str) >= 128 || strlen(tmp) > 100)
4854 return str;
4855
4856 sprintf(buf, "which %s > /dev/null", BC_APP);
4857 if (system(buf)) {
4858 log_err("fio: bc is needed for performing math\n");
4859 return NULL;
4860 }
4861
4862 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
4863 f = popen(buf, "r");
4864 if (!f)
4865 return NULL;
4866
4867 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
4868 if (ret <= 0) {
4869 pclose(f);
4870 return NULL;
4871 }
4872
4873 pclose(f);
4874 buf[(tmp - str) + ret - 1] = '\0';
4875 memcpy(buf, str, tmp - str);
4876 free(str);
4877 return strdup(buf);
4878}
4879
4880/*
4881 * Return a copy of the input string with substrings of the form ${VARNAME}
4882 * substituted with the value of the environment variable VARNAME. The
4883 * substitution always occurs, even if VARNAME is empty or the corresponding
4884 * environment variable undefined.
4885 */
4886char *fio_option_dup_subs(const char *opt)
4887{
4888 char out[OPT_LEN_MAX+1];
4889 char in[OPT_LEN_MAX+1];
4890 char *outptr = out;
4891 char *inptr = in;
4892 char *ch1, *ch2, *env;
4893 ssize_t nchr = OPT_LEN_MAX;
4894 size_t envlen;
4895
4896 if (strlen(opt) + 1 > OPT_LEN_MAX) {
4897 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
4898 return NULL;
4899 }
4900
4901 in[OPT_LEN_MAX] = '\0';
4902 strncpy(in, opt, OPT_LEN_MAX);
4903
4904 while (*inptr && nchr > 0) {
4905 if (inptr[0] == '$' && inptr[1] == '{') {
4906 ch2 = strchr(inptr, '}');
4907 if (ch2 && inptr+1 < ch2) {
4908 ch1 = inptr+2;
4909 inptr = ch2+1;
4910 *ch2 = '\0';
4911
4912 env = getenv(ch1);
4913 if (env) {
4914 envlen = strlen(env);
4915 if (envlen <= nchr) {
4916 memcpy(outptr, env, envlen);
4917 outptr += envlen;
4918 nchr -= envlen;
4919 }
4920 }
4921
4922 continue;
4923 }
4924 }
4925
4926 *outptr++ = *inptr++;
4927 --nchr;
4928 }
4929
4930 *outptr = '\0';
4931 return strdup(out);
4932}
4933
4934/*
4935 * Look for reserved variable names and replace them with real values
4936 */
4937static char *fio_keyword_replace(char *opt)
4938{
4939 char *s;
4940 int i;
4941 int docalc = 0;
4942
4943 for (i = 0; fio_keywords[i].word != NULL; i++) {
4944 struct fio_keyword *kw = &fio_keywords[i];
4945
4946 while ((s = strstr(opt, kw->word)) != NULL) {
4947 char *new = malloc(strlen(opt) + 1);
4948 char *o_org = opt;
4949 int olen = s - opt;
4950 int len;
4951
4952 /*
4953 * Copy part of the string before the keyword and
4954 * sprintf() the replacement after it.
4955 */
4956 memcpy(new, opt, olen);
4957 len = sprintf(new + olen, "%s", kw->replace);
4958
4959 /*
4960 * If there's more in the original string, copy that
4961 * in too
4962 */
4963 opt += strlen(kw->word) + olen;
4964 if (strlen(opt))
4965 memcpy(new + olen + len, opt, opt - o_org - 1);
4966
4967 /*
4968 * replace opt and free the old opt
4969 */
4970 opt = new;
4971 free(o_org);
4972
4973 docalc = 1;
4974 }
4975 }
4976
4977 /*
4978 * Check for potential math and invoke bc, if possible
4979 */
4980 if (docalc)
4981 opt = bc_calc(opt);
4982
4983 return opt;
4984}
4985
4986static char **dup_and_sub_options(char **opts, int num_opts)
4987{
4988 int i;
4989 char **opts_copy = malloc(num_opts * sizeof(*opts));
4990 for (i = 0; i < num_opts; i++) {
4991 opts_copy[i] = fio_option_dup_subs(opts[i]);
4992 if (!opts_copy[i])
4993 continue;
4994 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
4995 }
4996 return opts_copy;
4997}
4998
4999static void show_closest_option(const char *opt)
5000{
5001 int best_option, best_distance;
5002 int i, distance;
5003 char *name;
5004
5005 if (!strlen(opt))
5006 return;
5007
5008 name = strdup(opt);
5009 i = 0;
5010 while (name[i] != '\0' && name[i] != '=')
5011 i++;
5012 name[i] = '\0';
5013
5014 best_option = -1;
5015 best_distance = INT_MAX;
5016 i = 0;
5017 while (fio_options[i].name) {
5018 distance = string_distance(name, fio_options[i].name);
5019 if (distance < best_distance) {
5020 best_distance = distance;
5021 best_option = i;
5022 }
5023 i++;
5024 }
5025
5026 if (best_option != -1 && string_distance_ok(name, best_distance) &&
5027 fio_options[best_option].type != FIO_OPT_UNSUPPORTED)
5028 log_err("Did you mean %s?\n", fio_options[best_option].name);
5029
5030 free(name);
5031}
5032
5033int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
5034{
5035 int i, ret, unknown;
5036 char **opts_copy;
5037
5038 sort_options(opts, fio_options, num_opts);
5039 opts_copy = dup_and_sub_options(opts, num_opts);
5040
5041 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
5042 const struct fio_option *o;
5043 int newret = parse_option(opts_copy[i], opts[i], fio_options,
5044 &o, &td->o, &td->opt_list);
5045
5046 if (!newret && o)
5047 fio_option_mark_set(&td->o, o);
5048
5049 if (opts_copy[i]) {
5050 if (newret && !o) {
5051 unknown++;
5052 continue;
5053 }
5054 free(opts_copy[i]);
5055 opts_copy[i] = NULL;
5056 }
5057
5058 ret |= newret;
5059 }
5060
5061 if (unknown) {
5062 ret |= ioengine_load(td);
5063 if (td->eo) {
5064 sort_options(opts_copy, td->io_ops->options, num_opts);
5065 opts = opts_copy;
5066 }
5067 for (i = 0; i < num_opts; i++) {
5068 const struct fio_option *o = NULL;
5069 int newret = 1;
5070
5071 if (!opts_copy[i])
5072 continue;
5073
5074 if (td->eo)
5075 newret = parse_option(opts_copy[i], opts[i],
5076 td->io_ops->options, &o,
5077 td->eo, &td->opt_list);
5078
5079 ret |= newret;
5080 if (!o) {
5081 log_err("Bad option <%s>\n", opts[i]);
5082 show_closest_option(opts[i]);
5083 }
5084 free(opts_copy[i]);
5085 opts_copy[i] = NULL;
5086 }
5087 }
5088
5089 free(opts_copy);
5090 return ret;
5091}
5092
5093int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
5094{
5095 int ret;
5096
5097 ret = parse_cmd_option(opt, val, fio_options, &td->o, &td->opt_list);
5098 if (!ret) {
5099 const struct fio_option *o;
5100
5101 o = find_option_c(fio_options, opt);
5102 if (o)
5103 fio_option_mark_set(&td->o, o);
5104 }
5105
5106 return ret;
5107}
5108
5109int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
5110 char *val)
5111{
5112 return parse_cmd_option(opt, val, td->io_ops->options, td->eo,
5113 &td->opt_list);
5114}
5115
5116void fio_fill_default_options(struct thread_data *td)
5117{
5118 td->o.magic = OPT_MAGIC;
5119 fill_default_options(&td->o, fio_options);
5120}
5121
5122int fio_show_option_help(const char *opt)
5123{
5124 return show_cmd_help(fio_options, opt);
5125}
5126
5127/*
5128 * dupe FIO_OPT_STR_STORE options
5129 */
5130void fio_options_mem_dupe(struct thread_data *td)
5131{
5132 options_mem_dupe(fio_options, &td->o);
5133
5134 if (td->eo && td->io_ops) {
5135 void *oldeo = td->eo;
5136
5137 td->eo = malloc(td->io_ops->option_struct_size);
5138 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
5139 options_mem_dupe(td->io_ops->options, td->eo);
5140 }
5141}
5142
5143unsigned int fio_get_kb_base(void *data)
5144{
5145 struct thread_data *td = cb_data_to_td(data);
5146 struct thread_options *o = &td->o;
5147 unsigned int kb_base = 0;
5148
5149 /*
5150 * This is a hack... For private options, *data is not holding
5151 * a pointer to the thread_options, but to private data. This means
5152 * we can't safely dereference it, but magic is first so mem wise
5153 * it is valid. But this also means that if the job first sets
5154 * kb_base and expects that to be honored by private options,
5155 * it will be disappointed. We will return the global default
5156 * for this.
5157 */
5158 if (o && o->magic == OPT_MAGIC)
5159 kb_base = o->kb_base;
5160 if (!kb_base)
5161 kb_base = 1024;
5162
5163 return kb_base;
5164}
5165
5166int add_option(const struct fio_option *o)
5167{
5168 struct fio_option *__o;
5169 int opt_index = 0;
5170
5171 __o = fio_options;
5172 while (__o->name) {
5173 opt_index++;
5174 __o++;
5175 }
5176
5177 if (opt_index + 1 == FIO_MAX_OPTS) {
5178 log_err("fio: FIO_MAX_OPTS is too small\n");
5179 return 1;
5180 }
5181
5182 memcpy(&fio_options[opt_index], o, sizeof(*o));
5183 fio_options[opt_index + 1].name = NULL;
5184 return 0;
5185}
5186
5187void invalidate_profile_options(const char *prof_name)
5188{
5189 struct fio_option *o;
5190
5191 o = fio_options;
5192 while (o->name) {
5193 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
5194 o->type = FIO_OPT_INVALID;
5195 o->prof_name = NULL;
5196 }
5197 o++;
5198 }
5199}
5200
5201void add_opt_posval(const char *optname, const char *ival, const char *help)
5202{
5203 struct fio_option *o;
5204 unsigned int i;
5205
5206 o = find_option(fio_options, optname);
5207 if (!o)
5208 return;
5209
5210 for (i = 0; i < PARSE_MAX_VP; i++) {
5211 if (o->posval[i].ival)
5212 continue;
5213
5214 o->posval[i].ival = ival;
5215 o->posval[i].help = help;
5216 break;
5217 }
5218}
5219
5220void del_opt_posval(const char *optname, const char *ival)
5221{
5222 struct fio_option *o;
5223 unsigned int i;
5224
5225 o = find_option(fio_options, optname);
5226 if (!o)
5227 return;
5228
5229 for (i = 0; i < PARSE_MAX_VP; i++) {
5230 if (!o->posval[i].ival)
5231 continue;
5232 if (strcmp(o->posval[i].ival, ival))
5233 continue;
5234
5235 o->posval[i].ival = NULL;
5236 o->posval[i].help = NULL;
5237 }
5238}
5239
5240void fio_options_free(struct thread_data *td)
5241{
5242 options_free(fio_options, &td->o);
5243 if (td->eo && td->io_ops && td->io_ops->options) {
5244 options_free(td->io_ops->options, td->eo);
5245 free(td->eo);
5246 td->eo = NULL;
5247 }
5248}
5249
5250struct fio_option *fio_option_find(const char *name)
5251{
5252 return find_option(fio_options, name);
5253}
5254
5255static struct fio_option *find_next_opt(struct fio_option *from,
5256 unsigned int off1)
5257{
5258 struct fio_option *opt;
5259
5260 if (!from)
5261 from = &fio_options[0];
5262 else
5263 from++;
5264
5265 opt = NULL;
5266 do {
5267 if (off1 == from->off1) {
5268 opt = from;
5269 break;
5270 }
5271 from++;
5272 } while (from->name);
5273
5274 return opt;
5275}
5276
5277static int opt_is_set(struct thread_options *o, struct fio_option *opt)
5278{
5279 unsigned int opt_off, index, offset;
5280
5281 opt_off = opt - &fio_options[0];
5282 index = opt_off / (8 * sizeof(uint64_t));
5283 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5284 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
5285}
5286
5287bool __fio_option_is_set(struct thread_options *o, unsigned int off1)
5288{
5289 struct fio_option *opt, *next;
5290
5291 next = NULL;
5292 while ((opt = find_next_opt(next, off1)) != NULL) {
5293 if (opt_is_set(o, opt))
5294 return true;
5295
5296 next = opt;
5297 }
5298
5299 return false;
5300}
5301
5302void fio_option_mark_set(struct thread_options *o, const struct fio_option *opt)
5303{
5304 unsigned int opt_off, index, offset;
5305
5306 opt_off = opt - &fio_options[0];
5307 index = opt_off / (8 * sizeof(uint64_t));
5308 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5309 o->set_options[index] |= (uint64_t)1 << offset;
5310}
fio - Flexible IO Tester