projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Fio 3.11
[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 = 1;
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_POSIXAIO
1777 { .ival = "posixaio",
1778 .help = "POSIX asynchronous IO",
1779 },
1780#endif
1781#ifdef CONFIG_SOLARISAIO
1782 { .ival = "solarisaio",
1783 .help = "Solaris native asynchronous IO",
1784 },
1785#endif
1786#ifdef CONFIG_WINDOWSAIO
1787 { .ival = "windowsaio",
1788 .help = "Windows native asynchronous IO"
1789 },
1790#endif
1791#ifdef CONFIG_RBD
1792 { .ival = "rbd",
1793 .help = "Rados Block Device asynchronous IO"
1794 },
1795#endif
1796 { .ival = "mmap",
1797 .help = "Memory mapped IO"
1798 },
1799#ifdef CONFIG_LINUX_SPLICE
1800 { .ival = "splice",
1801 .help = "splice/vmsplice based IO",
1802 },
1803 { .ival = "netsplice",
1804 .help = "splice/vmsplice to/from the network",
1805 },
1806#endif
1807#ifdef FIO_HAVE_SGIO
1808 { .ival = "sg",
1809 .help = "SCSI generic v3 IO",
1810 },
1811#endif
1812 { .ival = "null",
1813 .help = "Testing engine (no data transfer)",
1814 },
1815 { .ival = "net",
1816 .help = "Network IO",
1817 },
1818 { .ival = "cpuio",
1819 .help = "CPU cycle burner engine",
1820 },
1821#ifdef CONFIG_GUASI
1822 { .ival = "guasi",
1823 .help = "GUASI IO engine",
1824 },
1825#endif
1826#ifdef CONFIG_RDMA
1827 { .ival = "rdma",
1828 .help = "RDMA IO engine",
1829 },
1830#endif
1831#ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1832 { .ival = "e4defrag",
1833 .help = "ext4 defrag engine",
1834 },
1835#endif
1836#ifdef CONFIG_LINUX_FALLOCATE
1837 { .ival = "falloc",
1838 .help = "fallocate() file based engine",
1839 },
1840#endif
1841#ifdef CONFIG_GFAPI
1842 { .ival = "gfapi",
1843 .help = "Glusterfs libgfapi(sync) based engine"
1844 },
1845 { .ival = "gfapi_async",
1846 .help = "Glusterfs libgfapi(async) based engine"
1847 },
1848#endif
1849#ifdef CONFIG_LIBHDFS
1850 { .ival = "libhdfs",
1851 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1852 },
1853#endif
1854#ifdef CONFIG_PMEMBLK
1855 { .ival = "pmemblk",
1856 .help = "PMDK libpmemblk based IO engine",
1857 },
1858
1859#endif
1860#ifdef CONFIG_IME
1861 { .ival = "ime_psync",
1862 .help = "DDN's IME synchronous IO engine",
1863 },
1864 { .ival = "ime_psyncv",
1865 .help = "DDN's IME synchronous IO engine using iovecs",
1866 },
1867 { .ival = "ime_aio",
1868 .help = "DDN's IME asynchronous IO engine",
1869 },
1870#endif
1871#ifdef CONFIG_LINUX_DEVDAX
1872 { .ival = "dev-dax",
1873 .help = "DAX Device based IO engine",
1874 },
1875#endif
1876 {
1877 .ival = "filecreate",
1878 .help = "File creation engine",
1879 },
1880 { .ival = "external",
1881 .help = "Load external engine (append name)",
1882 .cb = str_ioengine_external_cb,
1883 },
1884#ifdef CONFIG_LIBPMEM
1885 { .ival = "libpmem",
1886 .help = "PMDK libpmem based IO engine",
1887 },
1888#endif
1889#ifdef CONFIG_HTTP
1890 { .ival = "http",
1891 .help = "HTTP (WebDAV/S3) IO engine",
1892 },
1893#endif
1894 },
1895 },
1896 {
1897 .name = "iodepth",
1898 .lname = "IO Depth",
1899 .type = FIO_OPT_INT,
1900 .off1 = offsetof(struct thread_options, iodepth),
1901 .help = "Number of IO buffers to keep in flight",
1902 .minval = 1,
1903 .interval = 1,
1904 .def = "1",
1905 .category = FIO_OPT_C_IO,
1906 .group = FIO_OPT_G_IO_BASIC,
1907 },
1908 {
1909 .name = "iodepth_batch",
1910 .lname = "IO Depth batch",
1911 .alias = "iodepth_batch_submit",
1912 .type = FIO_OPT_INT,
1913 .off1 = offsetof(struct thread_options, iodepth_batch),
1914 .help = "Number of IO buffers to submit in one go",
1915 .parent = "iodepth",
1916 .hide = 1,
1917 .interval = 1,
1918 .def = "1",
1919 .category = FIO_OPT_C_IO,
1920 .group = FIO_OPT_G_IO_BASIC,
1921 },
1922 {
1923 .name = "iodepth_batch_complete_min",
1924 .lname = "Min IO depth batch complete",
1925 .alias = "iodepth_batch_complete",
1926 .type = FIO_OPT_INT,
1927 .off1 = offsetof(struct thread_options, iodepth_batch_complete_min),
1928 .help = "Min number of IO buffers to retrieve in one go",
1929 .parent = "iodepth",
1930 .hide = 1,
1931 .minval = 0,
1932 .interval = 1,
1933 .def = "1",
1934 .category = FIO_OPT_C_IO,
1935 .group = FIO_OPT_G_IO_BASIC,
1936 },
1937 {
1938 .name = "iodepth_batch_complete_max",
1939 .lname = "Max IO depth batch complete",
1940 .type = FIO_OPT_INT,
1941 .off1 = offsetof(struct thread_options, iodepth_batch_complete_max),
1942 .help = "Max number of IO buffers to retrieve in one go",
1943 .parent = "iodepth",
1944 .hide = 1,
1945 .minval = 0,
1946 .interval = 1,
1947 .category = FIO_OPT_C_IO,
1948 .group = FIO_OPT_G_IO_BASIC,
1949 },
1950 {
1951 .name = "iodepth_low",
1952 .lname = "IO Depth batch low",
1953 .type = FIO_OPT_INT,
1954 .off1 = offsetof(struct thread_options, iodepth_low),
1955 .help = "Low water mark for queuing depth",
1956 .parent = "iodepth",
1957 .hide = 1,
1958 .interval = 1,
1959 .category = FIO_OPT_C_IO,
1960 .group = FIO_OPT_G_IO_BASIC,
1961 },
1962 {
1963 .name = "serialize_overlap",
1964 .lname = "Serialize overlap",
1965 .off1 = offsetof(struct thread_options, serialize_overlap),
1966 .type = FIO_OPT_BOOL,
1967 .help = "Wait for in-flight IOs that collide to complete",
1968 .parent = "iodepth",
1969 .def = "0",
1970 .category = FIO_OPT_C_IO,
1971 .group = FIO_OPT_G_IO_BASIC,
1972 },
1973 {
1974 .name = "io_submit_mode",
1975 .lname = "IO submit mode",
1976 .type = FIO_OPT_STR,
1977 .off1 = offsetof(struct thread_options, io_submit_mode),
1978 .help = "How IO submissions and completions are done",
1979 .def = "inline",
1980 .category = FIO_OPT_C_IO,
1981 .group = FIO_OPT_G_IO_BASIC,
1982 .posval = {
1983 { .ival = "inline",
1984 .oval = IO_MODE_INLINE,
1985 .help = "Submit and complete IO inline",
1986 },
1987 { .ival = "offload",
1988 .oval = IO_MODE_OFFLOAD,
1989 .help = "Offload submit and complete to threads",
1990 },
1991 },
1992 },
1993 {
1994 .name = "size",
1995 .lname = "Size",
1996 .type = FIO_OPT_STR_VAL,
1997 .cb = str_size_cb,
1998 .off1 = offsetof(struct thread_options, size),
1999 .help = "Total size of device or files",
2000 .interval = 1024 * 1024,
2001 .category = FIO_OPT_C_IO,
2002 .group = FIO_OPT_G_INVALID,
2003 },
2004 {
2005 .name = "io_size",
2006 .alias = "io_limit",
2007 .lname = "IO Size",
2008 .type = FIO_OPT_STR_VAL,
2009 .off1 = offsetof(struct thread_options, io_size),
2010 .help = "Total size of I/O to be performed",
2011 .interval = 1024 * 1024,
2012 .category = FIO_OPT_C_IO,
2013 .group = FIO_OPT_G_INVALID,
2014 },
2015 {
2016 .name = "fill_device",
2017 .lname = "Fill device",
2018 .alias = "fill_fs",
2019 .type = FIO_OPT_BOOL,
2020 .off1 = offsetof(struct thread_options, fill_device),
2021 .help = "Write until an ENOSPC error occurs",
2022 .def = "0",
2023 .category = FIO_OPT_C_FILE,
2024 .group = FIO_OPT_G_INVALID,
2025 },
2026 {
2027 .name = "filesize",
2028 .lname = "File size",
2029 .type = FIO_OPT_STR_VAL,
2030 .off1 = offsetof(struct thread_options, file_size_low),
2031 .off2 = offsetof(struct thread_options, file_size_high),
2032 .minval = 1,
2033 .help = "Size of individual files",
2034 .interval = 1024 * 1024,
2035 .category = FIO_OPT_C_FILE,
2036 .group = FIO_OPT_G_INVALID,
2037 },
2038 {
2039 .name = "file_append",
2040 .lname = "File append",
2041 .type = FIO_OPT_BOOL,
2042 .off1 = offsetof(struct thread_options, file_append),
2043 .help = "IO will start at the end of the file(s)",
2044 .def = "0",
2045 .category = FIO_OPT_C_FILE,
2046 .group = FIO_OPT_G_INVALID,
2047 },
2048 {
2049 .name = "offset",
2050 .lname = "IO offset",
2051 .alias = "fileoffset",
2052 .type = FIO_OPT_STR_VAL,
2053 .cb = str_offset_cb,
2054 .off1 = offsetof(struct thread_options, start_offset),
2055 .help = "Start IO from this offset",
2056 .def = "0",
2057 .interval = 1024 * 1024,
2058 .category = FIO_OPT_C_IO,
2059 .group = FIO_OPT_G_INVALID,
2060 },
2061 {
2062 .name = "offset_align",
2063 .lname = "IO offset alignment",
2064 .type = FIO_OPT_INT,
2065 .off1 = offsetof(struct thread_options, start_offset_align),
2066 .help = "Start IO from this offset alignment",
2067 .def = "0",
2068 .interval = 512,
2069 .category = FIO_OPT_C_IO,
2070 .group = FIO_OPT_G_INVALID,
2071 },
2072 {
2073 .name = "offset_increment",
2074 .lname = "IO offset increment",
2075 .type = FIO_OPT_STR_VAL,
2076 .off1 = offsetof(struct thread_options, offset_increment),
2077 .help = "What is the increment from one offset to the next",
2078 .parent = "offset",
2079 .hide = 1,
2080 .def = "0",
2081 .interval = 1024 * 1024,
2082 .category = FIO_OPT_C_IO,
2083 .group = FIO_OPT_G_INVALID,
2084 },
2085 {
2086 .name = "number_ios",
2087 .lname = "Number of IOs to perform",
2088 .type = FIO_OPT_STR_VAL,
2089 .off1 = offsetof(struct thread_options, number_ios),
2090 .help = "Force job completion after this number of IOs",
2091 .def = "0",
2092 .category = FIO_OPT_C_IO,
2093 .group = FIO_OPT_G_INVALID,
2094 },
2095 {
2096 .name = "bs",
2097 .lname = "Block size",
2098 .alias = "blocksize",
2099 .type = FIO_OPT_ULL,
2100 .off1 = offsetof(struct thread_options, bs[DDIR_READ]),
2101 .off2 = offsetof(struct thread_options, bs[DDIR_WRITE]),
2102 .off3 = offsetof(struct thread_options, bs[DDIR_TRIM]),
2103 .minval = 1,
2104 .help = "Block size unit",
2105 .def = "4096",
2106 .parent = "rw",
2107 .hide = 1,
2108 .interval = 512,
2109 .category = FIO_OPT_C_IO,
2110 .group = FIO_OPT_G_INVALID,
2111 },
2112 {
2113 .name = "ba",
2114 .lname = "Block size align",
2115 .alias = "blockalign",
2116 .type = FIO_OPT_ULL,
2117 .off1 = offsetof(struct thread_options, ba[DDIR_READ]),
2118 .off2 = offsetof(struct thread_options, ba[DDIR_WRITE]),
2119 .off3 = offsetof(struct thread_options, ba[DDIR_TRIM]),
2120 .minval = 1,
2121 .help = "IO block offset alignment",
2122 .parent = "rw",
2123 .hide = 1,
2124 .interval = 512,
2125 .category = FIO_OPT_C_IO,
2126 .group = FIO_OPT_G_INVALID,
2127 },
2128 {
2129 .name = "bsrange",
2130 .lname = "Block size range",
2131 .alias = "blocksize_range",
2132 .type = FIO_OPT_RANGE,
2133 .off1 = offsetof(struct thread_options, min_bs[DDIR_READ]),
2134 .off2 = offsetof(struct thread_options, max_bs[DDIR_READ]),
2135 .off3 = offsetof(struct thread_options, min_bs[DDIR_WRITE]),
2136 .off4 = offsetof(struct thread_options, max_bs[DDIR_WRITE]),
2137 .off5 = offsetof(struct thread_options, min_bs[DDIR_TRIM]),
2138 .off6 = offsetof(struct thread_options, max_bs[DDIR_TRIM]),
2139 .minval = 1,
2140 .help = "Set block size range (in more detail than bs)",
2141 .parent = "rw",
2142 .hide = 1,
2143 .interval = 4096,
2144 .category = FIO_OPT_C_IO,
2145 .group = FIO_OPT_G_INVALID,
2146 },
2147 {
2148 .name = "bssplit",
2149 .lname = "Block size split",
2150 .type = FIO_OPT_STR_ULL,
2151 .cb = str_bssplit_cb,
2152 .off1 = offsetof(struct thread_options, bssplit),
2153 .help = "Set a specific mix of block sizes",
2154 .parent = "rw",
2155 .hide = 1,
2156 .category = FIO_OPT_C_IO,
2157 .group = FIO_OPT_G_INVALID,
2158 },
2159 {
2160 .name = "bs_unaligned",
2161 .lname = "Block size unaligned",
2162 .alias = "blocksize_unaligned",
2163 .type = FIO_OPT_STR_SET,
2164 .off1 = offsetof(struct thread_options, bs_unaligned),
2165 .help = "Don't sector align IO buffer sizes",
2166 .parent = "rw",
2167 .hide = 1,
2168 .category = FIO_OPT_C_IO,
2169 .group = FIO_OPT_G_INVALID,
2170 },
2171 {
2172 .name = "bs_is_seq_rand",
2173 .lname = "Block size division is seq/random (not read/write)",
2174 .type = FIO_OPT_BOOL,
2175 .off1 = offsetof(struct thread_options, bs_is_seq_rand),
2176 .help = "Consider any blocksize setting to be sequential,random",
2177 .def = "0",
2178 .parent = "blocksize",
2179 .category = FIO_OPT_C_IO,
2180 .group = FIO_OPT_G_INVALID,
2181 },
2182 {
2183 .name = "randrepeat",
2184 .lname = "Random repeatable",
2185 .type = FIO_OPT_BOOL,
2186 .off1 = offsetof(struct thread_options, rand_repeatable),
2187 .help = "Use repeatable random IO pattern",
2188 .def = "1",
2189 .parent = "rw",
2190 .hide = 1,
2191 .category = FIO_OPT_C_IO,
2192 .group = FIO_OPT_G_RANDOM,
2193 },
2194 {
2195 .name = "randseed",
2196 .lname = "The random generator seed",
2197 .type = FIO_OPT_STR_VAL,
2198 .off1 = offsetof(struct thread_options, rand_seed),
2199 .help = "Set the random generator seed value",
2200 .def = "0x89",
2201 .parent = "rw",
2202 .category = FIO_OPT_C_IO,
2203 .group = FIO_OPT_G_RANDOM,
2204 },
2205 {
2206 .name = "use_os_rand",
2207 .lname = "Use OS random",
2208 .type = FIO_OPT_DEPRECATED,
2209 .off1 = offsetof(struct thread_options, dep_use_os_rand),
2210 .category = FIO_OPT_C_IO,
2211 .group = FIO_OPT_G_RANDOM,
2212 },
2213 {
2214 .name = "norandommap",
2215 .lname = "No randommap",
2216 .type = FIO_OPT_STR_SET,
2217 .off1 = offsetof(struct thread_options, norandommap),
2218 .help = "Accept potential duplicate random blocks",
2219 .parent = "rw",
2220 .hide = 1,
2221 .hide_on_set = 1,
2222 .category = FIO_OPT_C_IO,
2223 .group = FIO_OPT_G_RANDOM,
2224 },
2225 {
2226 .name = "softrandommap",
2227 .lname = "Soft randommap",
2228 .type = FIO_OPT_BOOL,
2229 .off1 = offsetof(struct thread_options, softrandommap),
2230 .help = "Set norandommap if randommap allocation fails",
2231 .parent = "norandommap",
2232 .hide = 1,
2233 .def = "0",
2234 .category = FIO_OPT_C_IO,
2235 .group = FIO_OPT_G_RANDOM,
2236 },
2237 {
2238 .name = "random_generator",
2239 .lname = "Random Generator",
2240 .type = FIO_OPT_STR,
2241 .off1 = offsetof(struct thread_options, random_generator),
2242 .help = "Type of random number generator to use",
2243 .def = "tausworthe",
2244 .posval = {
2245 { .ival = "tausworthe",
2246 .oval = FIO_RAND_GEN_TAUSWORTHE,
2247 .help = "Strong Tausworthe generator",
2248 },
2249 { .ival = "lfsr",
2250 .oval = FIO_RAND_GEN_LFSR,
2251 .help = "Variable length LFSR",
2252 },
2253 {
2254 .ival = "tausworthe64",
2255 .oval = FIO_RAND_GEN_TAUSWORTHE64,
2256 .help = "64-bit Tausworthe variant",
2257 },
2258 },
2259 .category = FIO_OPT_C_IO,
2260 .group = FIO_OPT_G_RANDOM,
2261 },
2262 {
2263 .name = "random_distribution",
2264 .lname = "Random Distribution",
2265 .type = FIO_OPT_STR,
2266 .off1 = offsetof(struct thread_options, random_distribution),
2267 .cb = str_random_distribution_cb,
2268 .help = "Random offset distribution generator",
2269 .def = "random",
2270 .posval = {
2271 { .ival = "random",
2272 .oval = FIO_RAND_DIST_RANDOM,
2273 .help = "Completely random",
2274 },
2275 { .ival = "zipf",
2276 .oval = FIO_RAND_DIST_ZIPF,
2277 .help = "Zipf distribution",
2278 },
2279 { .ival = "pareto",
2280 .oval = FIO_RAND_DIST_PARETO,
2281 .help = "Pareto distribution",
2282 },
2283 { .ival = "normal",
2284 .oval = FIO_RAND_DIST_GAUSS,
2285 .help = "Normal (Gaussian) distribution",
2286 },
2287 { .ival = "zoned",
2288 .oval = FIO_RAND_DIST_ZONED,
2289 .help = "Zoned random distribution",
2290 },
2291 { .ival = "zoned_abs",
2292 .oval = FIO_RAND_DIST_ZONED_ABS,
2293 .help = "Zoned absolute random distribution",
2294 },
2295 },
2296 .category = FIO_OPT_C_IO,
2297 .group = FIO_OPT_G_RANDOM,
2298 },
2299 {
2300 .name = "percentage_random",
2301 .lname = "Percentage Random",
2302 .type = FIO_OPT_INT,
2303 .off1 = offsetof(struct thread_options, perc_rand[DDIR_READ]),
2304 .off2 = offsetof(struct thread_options, perc_rand[DDIR_WRITE]),
2305 .off3 = offsetof(struct thread_options, perc_rand[DDIR_TRIM]),
2306 .maxval = 100,
2307 .help = "Percentage of seq/random mix that should be random",
2308 .def = "100,100,100",
2309 .interval = 5,
2310 .inverse = "percentage_sequential",
2311 .category = FIO_OPT_C_IO,
2312 .group = FIO_OPT_G_RANDOM,
2313 },
2314 {
2315 .name = "percentage_sequential",
2316 .lname = "Percentage Sequential",
2317 .type = FIO_OPT_DEPRECATED,
2318 .category = FIO_OPT_C_IO,
2319 .group = FIO_OPT_G_RANDOM,
2320 },
2321 {
2322 .name = "allrandrepeat",
2323 .lname = "All Random Repeat",
2324 .type = FIO_OPT_BOOL,
2325 .off1 = offsetof(struct thread_options, allrand_repeatable),
2326 .help = "Use repeatable random numbers for everything",
2327 .def = "0",
2328 .category = FIO_OPT_C_IO,
2329 .group = FIO_OPT_G_RANDOM,
2330 },
2331 {
2332 .name = "nrfiles",
2333 .lname = "Number of files",
2334 .alias = "nr_files",
2335 .type = FIO_OPT_INT,
2336 .off1 = offsetof(struct thread_options, nr_files),
2337 .help = "Split job workload between this number of files",
2338 .def = "1",
2339 .interval = 1,
2340 .category = FIO_OPT_C_FILE,
2341 .group = FIO_OPT_G_INVALID,
2342 },
2343 {
2344 .name = "openfiles",
2345 .lname = "Number of open files",
2346 .type = FIO_OPT_INT,
2347 .off1 = offsetof(struct thread_options, open_files),
2348 .help = "Number of files to keep open at the same time",
2349 .category = FIO_OPT_C_FILE,
2350 .group = FIO_OPT_G_INVALID,
2351 },
2352 {
2353 .name = "file_service_type",
2354 .lname = "File service type",
2355 .type = FIO_OPT_STR,
2356 .cb = str_fst_cb,
2357 .off1 = offsetof(struct thread_options, file_service_type),
2358 .help = "How to select which file to service next",
2359 .def = "roundrobin",
2360 .category = FIO_OPT_C_FILE,
2361 .group = FIO_OPT_G_INVALID,
2362 .posval = {
2363 { .ival = "random",
2364 .oval = FIO_FSERVICE_RANDOM,
2365 .help = "Choose a file at random (uniform)",
2366 },
2367 { .ival = "zipf",
2368 .oval = FIO_FSERVICE_ZIPF,
2369 .help = "Zipf randomized",
2370 },
2371 { .ival = "pareto",
2372 .oval = FIO_FSERVICE_PARETO,
2373 .help = "Pareto randomized",
2374 },
2375 { .ival = "normal",
2376 .oval = FIO_FSERVICE_GAUSS,
2377 .help = "Normal (Gaussian) randomized",
2378 },
2379 { .ival = "gauss",
2380 .oval = FIO_FSERVICE_GAUSS,
2381 .help = "Alias for normal",
2382 },
2383 { .ival = "roundrobin",
2384 .oval = FIO_FSERVICE_RR,
2385 .help = "Round robin select files",
2386 },
2387 { .ival = "sequential",
2388 .oval = FIO_FSERVICE_SEQ,
2389 .help = "Finish one file before moving to the next",
2390 },
2391 },
2392 .parent = "nrfiles",
2393 .hide = 1,
2394 },
2395#ifdef FIO_HAVE_ANY_FALLOCATE
2396 {
2397 .name = "fallocate",
2398 .lname = "Fallocate",
2399 .type = FIO_OPT_STR,
2400 .off1 = offsetof(struct thread_options, fallocate_mode),
2401 .help = "Whether pre-allocation is performed when laying out files",
2402 .def = "native",
2403 .category = FIO_OPT_C_FILE,
2404 .group = FIO_OPT_G_INVALID,
2405 .posval = {
2406 { .ival = "none",
2407 .oval = FIO_FALLOCATE_NONE,
2408 .help = "Do not pre-allocate space",
2409 },
2410 { .ival = "native",
2411 .oval = FIO_FALLOCATE_NATIVE,
2412 .help = "Use native pre-allocation if possible",
2413 },
2414#ifdef CONFIG_POSIX_FALLOCATE
2415 { .ival = "posix",
2416 .oval = FIO_FALLOCATE_POSIX,
2417 .help = "Use posix_fallocate()",
2418 },
2419#endif
2420#ifdef CONFIG_LINUX_FALLOCATE
2421 { .ival = "keep",
2422 .oval = FIO_FALLOCATE_KEEP_SIZE,
2423 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
2424 },
2425#endif
2426 /* Compatibility with former boolean values */
2427 { .ival = "0",
2428 .oval = FIO_FALLOCATE_NONE,
2429 .help = "Alias for 'none'",
2430 },
2431#ifdef CONFIG_POSIX_FALLOCATE
2432 { .ival = "1",
2433 .oval = FIO_FALLOCATE_POSIX,
2434 .help = "Alias for 'posix'",
2435 },
2436#endif
2437 },
2438 },
2439#else /* FIO_HAVE_ANY_FALLOCATE */
2440 {
2441 .name = "fallocate",
2442 .lname = "Fallocate",
2443 .type = FIO_OPT_UNSUPPORTED,
2444 .help = "Your platform does not support fallocate",
2445 },
2446#endif /* FIO_HAVE_ANY_FALLOCATE */
2447 {
2448 .name = "fadvise_hint",
2449 .lname = "Fadvise hint",
2450 .type = FIO_OPT_STR,
2451 .off1 = offsetof(struct thread_options, fadvise_hint),
2452 .posval = {
2453 { .ival = "0",
2454 .oval = F_ADV_NONE,
2455 .help = "Don't issue fadvise/madvise",
2456 },
2457 { .ival = "1",
2458 .oval = F_ADV_TYPE,
2459 .help = "Advise using fio IO pattern",
2460 },
2461 { .ival = "random",
2462 .oval = F_ADV_RANDOM,
2463 .help = "Advise using FADV_RANDOM",
2464 },
2465 { .ival = "sequential",
2466 .oval = F_ADV_SEQUENTIAL,
2467 .help = "Advise using FADV_SEQUENTIAL",
2468 },
2469 },
2470 .help = "Use fadvise() to advise the kernel on IO pattern",
2471 .def = "1",
2472 .category = FIO_OPT_C_FILE,
2473 .group = FIO_OPT_G_INVALID,
2474 },
2475 {
2476 .name = "fsync",
2477 .lname = "Fsync",
2478 .type = FIO_OPT_INT,
2479 .off1 = offsetof(struct thread_options, fsync_blocks),
2480 .help = "Issue fsync for writes every given number of blocks",
2481 .def = "0",
2482 .interval = 1,
2483 .category = FIO_OPT_C_FILE,
2484 .group = FIO_OPT_G_INVALID,
2485 },
2486 {
2487 .name = "fdatasync",
2488 .lname = "Fdatasync",
2489 .type = FIO_OPT_INT,
2490 .off1 = offsetof(struct thread_options, fdatasync_blocks),
2491 .help = "Issue fdatasync for writes every given number of blocks",
2492 .def = "0",
2493 .interval = 1,
2494 .category = FIO_OPT_C_FILE,
2495 .group = FIO_OPT_G_INVALID,
2496 },
2497 {
2498 .name = "write_barrier",
2499 .lname = "Write barrier",
2500 .type = FIO_OPT_INT,
2501 .off1 = offsetof(struct thread_options, barrier_blocks),
2502 .help = "Make every Nth write a barrier write",
2503 .def = "0",
2504 .interval = 1,
2505 .category = FIO_OPT_C_IO,
2506 .group = FIO_OPT_G_INVALID,
2507 },
2508#ifdef CONFIG_SYNC_FILE_RANGE
2509 {
2510 .name = "sync_file_range",
2511 .lname = "Sync file range",
2512 .posval = {
2513 { .ival = "wait_before",
2514 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2515 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2516 .orval = 1,
2517 },
2518 { .ival = "write",
2519 .oval = SYNC_FILE_RANGE_WRITE,
2520 .help = "SYNC_FILE_RANGE_WRITE",
2521 .orval = 1,
2522 },
2523 {
2524 .ival = "wait_after",
2525 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2526 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2527 .orval = 1,
2528 },
2529 },
2530 .type = FIO_OPT_STR_MULTI,
2531 .cb = str_sfr_cb,
2532 .off1 = offsetof(struct thread_options, sync_file_range),
2533 .help = "Use sync_file_range()",
2534 .category = FIO_OPT_C_FILE,
2535 .group = FIO_OPT_G_INVALID,
2536 },
2537#else
2538 {
2539 .name = "sync_file_range",
2540 .lname = "Sync file range",
2541 .type = FIO_OPT_UNSUPPORTED,
2542 .help = "Your platform does not support sync_file_range",
2543 },
2544#endif
2545 {
2546 .name = "direct",
2547 .lname = "Direct I/O",
2548 .type = FIO_OPT_BOOL,
2549 .off1 = offsetof(struct thread_options, odirect),
2550 .help = "Use O_DIRECT IO (negates buffered)",
2551 .def = "0",
2552 .inverse = "buffered",
2553 .category = FIO_OPT_C_IO,
2554 .group = FIO_OPT_G_IO_TYPE,
2555 },
2556 {
2557 .name = "atomic",
2558 .lname = "Atomic I/O",
2559 .type = FIO_OPT_BOOL,
2560 .off1 = offsetof(struct thread_options, oatomic),
2561 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2562 .def = "0",
2563 .category = FIO_OPT_C_IO,
2564 .group = FIO_OPT_G_IO_TYPE,
2565 },
2566 {
2567 .name = "buffered",
2568 .lname = "Buffered I/O",
2569 .type = FIO_OPT_BOOL,
2570 .off1 = offsetof(struct thread_options, odirect),
2571 .neg = 1,
2572 .help = "Use buffered IO (negates direct)",
2573 .def = "1",
2574 .inverse = "direct",
2575 .category = FIO_OPT_C_IO,
2576 .group = FIO_OPT_G_IO_TYPE,
2577 },
2578 {
2579 .name = "overwrite",
2580 .lname = "Overwrite",
2581 .type = FIO_OPT_BOOL,
2582 .off1 = offsetof(struct thread_options, overwrite),
2583 .help = "When writing, set whether to overwrite current data",
2584 .def = "0",
2585 .category = FIO_OPT_C_FILE,
2586 .group = FIO_OPT_G_INVALID,
2587 },
2588 {
2589 .name = "loops",
2590 .lname = "Loops",
2591 .type = FIO_OPT_INT,
2592 .off1 = offsetof(struct thread_options, loops),
2593 .help = "Number of times to run the job",
2594 .def = "1",
2595 .interval = 1,
2596 .category = FIO_OPT_C_GENERAL,
2597 .group = FIO_OPT_G_RUNTIME,
2598 },
2599 {
2600 .name = "numjobs",
2601 .lname = "Number of jobs",
2602 .type = FIO_OPT_INT,
2603 .off1 = offsetof(struct thread_options, numjobs),
2604 .help = "Duplicate this job this many times",
2605 .def = "1",
2606 .interval = 1,
2607 .category = FIO_OPT_C_GENERAL,
2608 .group = FIO_OPT_G_RUNTIME,
2609 },
2610 {
2611 .name = "startdelay",
2612 .lname = "Start delay",
2613 .type = FIO_OPT_STR_VAL_TIME,
2614 .off1 = offsetof(struct thread_options, start_delay),
2615 .off2 = offsetof(struct thread_options, start_delay_high),
2616 .help = "Only start job when this period has passed",
2617 .def = "0",
2618 .is_seconds = 1,
2619 .is_time = 1,
2620 .category = FIO_OPT_C_GENERAL,
2621 .group = FIO_OPT_G_RUNTIME,
2622 },
2623 {
2624 .name = "runtime",
2625 .lname = "Runtime",
2626 .alias = "timeout",
2627 .type = FIO_OPT_STR_VAL_TIME,
2628 .off1 = offsetof(struct thread_options, timeout),
2629 .help = "Stop workload when this amount of time has passed",
2630 .def = "0",
2631 .is_seconds = 1,
2632 .is_time = 1,
2633 .category = FIO_OPT_C_GENERAL,
2634 .group = FIO_OPT_G_RUNTIME,
2635 },
2636 {
2637 .name = "time_based",
2638 .lname = "Time based",
2639 .type = FIO_OPT_STR_SET,
2640 .off1 = offsetof(struct thread_options, time_based),
2641 .help = "Keep running until runtime/timeout is met",
2642 .category = FIO_OPT_C_GENERAL,
2643 .group = FIO_OPT_G_RUNTIME,
2644 },
2645 {
2646 .name = "verify_only",
2647 .lname = "Verify only",
2648 .type = FIO_OPT_STR_SET,
2649 .off1 = offsetof(struct thread_options, verify_only),
2650 .help = "Verifies previously written data is still valid",
2651 .category = FIO_OPT_C_GENERAL,
2652 .group = FIO_OPT_G_RUNTIME,
2653 },
2654 {
2655 .name = "ramp_time",
2656 .lname = "Ramp time",
2657 .type = FIO_OPT_STR_VAL_TIME,
2658 .off1 = offsetof(struct thread_options, ramp_time),
2659 .help = "Ramp up time before measuring performance",
2660 .is_seconds = 1,
2661 .is_time = 1,
2662 .category = FIO_OPT_C_GENERAL,
2663 .group = FIO_OPT_G_RUNTIME,
2664 },
2665 {
2666 .name = "clocksource",
2667 .lname = "Clock source",
2668 .type = FIO_OPT_STR,
2669 .cb = fio_clock_source_cb,
2670 .off1 = offsetof(struct thread_options, clocksource),
2671 .help = "What type of timing source to use",
2672 .category = FIO_OPT_C_GENERAL,
2673 .group = FIO_OPT_G_CLOCK,
2674 .posval = {
2675#ifdef CONFIG_GETTIMEOFDAY
2676 { .ival = "gettimeofday",
2677 .oval = CS_GTOD,
2678 .help = "Use gettimeofday(2) for timing",
2679 },
2680#endif
2681#ifdef CONFIG_CLOCK_GETTIME
2682 { .ival = "clock_gettime",
2683 .oval = CS_CGETTIME,
2684 .help = "Use clock_gettime(2) for timing",
2685 },
2686#endif
2687#ifdef ARCH_HAVE_CPU_CLOCK
2688 { .ival = "cpu",
2689 .oval = CS_CPUCLOCK,
2690 .help = "Use CPU private clock",
2691 },
2692#endif
2693 },
2694 },
2695 {
2696 .name = "mem",
2697 .alias = "iomem",
2698 .lname = "I/O Memory",
2699 .type = FIO_OPT_STR,
2700 .cb = str_mem_cb,
2701 .off1 = offsetof(struct thread_options, mem_type),
2702 .help = "Backing type for IO buffers",
2703 .def = "malloc",
2704 .category = FIO_OPT_C_IO,
2705 .group = FIO_OPT_G_INVALID,
2706 .posval = {
2707 { .ival = "malloc",
2708 .oval = MEM_MALLOC,
2709 .help = "Use malloc(3) for IO buffers",
2710 },
2711#ifndef CONFIG_NO_SHM
2712 { .ival = "shm",
2713 .oval = MEM_SHM,
2714 .help = "Use shared memory segments for IO buffers",
2715 },
2716#ifdef FIO_HAVE_HUGETLB
2717 { .ival = "shmhuge",
2718 .oval = MEM_SHMHUGE,
2719 .help = "Like shm, but use huge pages",
2720 },
2721#endif
2722#endif
2723 { .ival = "mmap",
2724 .oval = MEM_MMAP,
2725 .help = "Use mmap(2) (file or anon) for IO buffers",
2726 },
2727 { .ival = "mmapshared",
2728 .oval = MEM_MMAPSHARED,
2729 .help = "Like mmap, but use the shared flag",
2730 },
2731#ifdef FIO_HAVE_HUGETLB
2732 { .ival = "mmaphuge",
2733 .oval = MEM_MMAPHUGE,
2734 .help = "Like mmap, but use huge pages",
2735 },
2736#endif
2737#ifdef CONFIG_CUDA
2738 { .ival = "cudamalloc",
2739 .oval = MEM_CUDA_MALLOC,
2740 .help = "Allocate GPU device memory for GPUDirect RDMA",
2741 },
2742#endif
2743 },
2744 },
2745 {
2746 .name = "iomem_align",
2747 .alias = "mem_align",
2748 .lname = "I/O memory alignment",
2749 .type = FIO_OPT_INT,
2750 .off1 = offsetof(struct thread_options, mem_align),
2751 .minval = 0,
2752 .help = "IO memory buffer offset alignment",
2753 .def = "0",
2754 .parent = "iomem",
2755 .hide = 1,
2756 .category = FIO_OPT_C_IO,
2757 .group = FIO_OPT_G_INVALID,
2758 },
2759 {
2760 .name = "verify",
2761 .lname = "Verify",
2762 .type = FIO_OPT_STR,
2763 .off1 = offsetof(struct thread_options, verify),
2764 .help = "Verify data written",
2765 .def = "0",
2766 .category = FIO_OPT_C_IO,
2767 .group = FIO_OPT_G_VERIFY,
2768 .posval = {
2769 { .ival = "0",
2770 .oval = VERIFY_NONE,
2771 .help = "Don't do IO verification",
2772 },
2773 { .ival = "md5",
2774 .oval = VERIFY_MD5,
2775 .help = "Use md5 checksums for verification",
2776 },
2777 { .ival = "crc64",
2778 .oval = VERIFY_CRC64,
2779 .help = "Use crc64 checksums for verification",
2780 },
2781 { .ival = "crc32",
2782 .oval = VERIFY_CRC32,
2783 .help = "Use crc32 checksums for verification",
2784 },
2785 { .ival = "crc32c-intel",
2786 .oval = VERIFY_CRC32C,
2787 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2788 },
2789 { .ival = "crc32c",
2790 .oval = VERIFY_CRC32C,
2791 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2792 },
2793 { .ival = "crc16",
2794 .oval = VERIFY_CRC16,
2795 .help = "Use crc16 checksums for verification",
2796 },
2797 { .ival = "crc7",
2798 .oval = VERIFY_CRC7,
2799 .help = "Use crc7 checksums for verification",
2800 },
2801 { .ival = "sha1",
2802 .oval = VERIFY_SHA1,
2803 .help = "Use sha1 checksums for verification",
2804 },
2805 { .ival = "sha256",
2806 .oval = VERIFY_SHA256,
2807 .help = "Use sha256 checksums for verification",
2808 },
2809 { .ival = "sha512",
2810 .oval = VERIFY_SHA512,
2811 .help = "Use sha512 checksums for verification",
2812 },
2813 { .ival = "sha3-224",
2814 .oval = VERIFY_SHA3_224,
2815 .help = "Use sha3-224 checksums for verification",
2816 },
2817 { .ival = "sha3-256",
2818 .oval = VERIFY_SHA3_256,
2819 .help = "Use sha3-256 checksums for verification",
2820 },
2821 { .ival = "sha3-384",
2822 .oval = VERIFY_SHA3_384,
2823 .help = "Use sha3-384 checksums for verification",
2824 },
2825 { .ival = "sha3-512",
2826 .oval = VERIFY_SHA3_512,
2827 .help = "Use sha3-512 checksums for verification",
2828 },
2829 { .ival = "xxhash",
2830 .oval = VERIFY_XXHASH,
2831 .help = "Use xxhash checksums for verification",
2832 },
2833 /* Meta information was included into verify_header,
2834 * 'meta' verification is implied by default. */
2835 { .ival = "meta",
2836 .oval = VERIFY_HDR_ONLY,
2837 .help = "Use io information for verification. "
2838 "Now is implied by default, thus option is obsolete, "
2839 "don't use it",
2840 },
2841 { .ival = "pattern",
2842 .oval = VERIFY_PATTERN_NO_HDR,
2843 .help = "Verify strict pattern",
2844 },
2845 {
2846 .ival = "null",
2847 .oval = VERIFY_NULL,
2848 .help = "Pretend to verify",
2849 },
2850 },
2851 },
2852 {
2853 .name = "do_verify",
2854 .lname = "Perform verify step",
2855 .type = FIO_OPT_BOOL,
2856 .off1 = offsetof(struct thread_options, do_verify),
2857 .help = "Run verification stage after write",
2858 .def = "1",
2859 .parent = "verify",
2860 .hide = 1,
2861 .category = FIO_OPT_C_IO,
2862 .group = FIO_OPT_G_VERIFY,
2863 },
2864 {
2865 .name = "verifysort",
2866 .lname = "Verify sort",
2867 .type = FIO_OPT_SOFT_DEPRECATED,
2868 .category = FIO_OPT_C_IO,
2869 .group = FIO_OPT_G_VERIFY,
2870 },
2871 {
2872 .name = "verifysort_nr",
2873 .lname = "Verify Sort Nr",
2874 .type = FIO_OPT_SOFT_DEPRECATED,
2875 .category = FIO_OPT_C_IO,
2876 .group = FIO_OPT_G_VERIFY,
2877 },
2878 {
2879 .name = "verify_interval",
2880 .lname = "Verify interval",
2881 .type = FIO_OPT_INT,
2882 .off1 = offsetof(struct thread_options, verify_interval),
2883 .minval = 2 * sizeof(struct verify_header),
2884 .help = "Store verify buffer header every N bytes",
2885 .parent = "verify",
2886 .hide = 1,
2887 .interval = 2 * sizeof(struct verify_header),
2888 .category = FIO_OPT_C_IO,
2889 .group = FIO_OPT_G_VERIFY,
2890 },
2891 {
2892 .name = "verify_offset",
2893 .lname = "Verify offset",
2894 .type = FIO_OPT_INT,
2895 .help = "Offset verify header location by N bytes",
2896 .off1 = offsetof(struct thread_options, verify_offset),
2897 .minval = sizeof(struct verify_header),
2898 .parent = "verify",
2899 .hide = 1,
2900 .category = FIO_OPT_C_IO,
2901 .group = FIO_OPT_G_VERIFY,
2902 },
2903 {
2904 .name = "verify_pattern",
2905 .lname = "Verify pattern",
2906 .type = FIO_OPT_STR,
2907 .cb = str_verify_pattern_cb,
2908 .off1 = offsetof(struct thread_options, verify_pattern),
2909 .help = "Fill pattern for IO buffers",
2910 .parent = "verify",
2911 .hide = 1,
2912 .category = FIO_OPT_C_IO,
2913 .group = FIO_OPT_G_VERIFY,
2914 },
2915 {
2916 .name = "verify_fatal",
2917 .lname = "Verify fatal",
2918 .type = FIO_OPT_BOOL,
2919 .off1 = offsetof(struct thread_options, verify_fatal),
2920 .def = "0",
2921 .help = "Exit on a single verify failure, don't continue",
2922 .parent = "verify",
2923 .hide = 1,
2924 .category = FIO_OPT_C_IO,
2925 .group = FIO_OPT_G_VERIFY,
2926 },
2927 {
2928 .name = "verify_dump",
2929 .lname = "Verify dump",
2930 .type = FIO_OPT_BOOL,
2931 .off1 = offsetof(struct thread_options, verify_dump),
2932 .def = "0",
2933 .help = "Dump contents of good and bad blocks on failure",
2934 .parent = "verify",
2935 .hide = 1,
2936 .category = FIO_OPT_C_IO,
2937 .group = FIO_OPT_G_VERIFY,
2938 },
2939 {
2940 .name = "verify_async",
2941 .lname = "Verify asynchronously",
2942 .type = FIO_OPT_INT,
2943 .off1 = offsetof(struct thread_options, verify_async),
2944 .def = "0",
2945 .help = "Number of async verifier threads to use",
2946 .parent = "verify",
2947 .hide = 1,
2948 .category = FIO_OPT_C_IO,
2949 .group = FIO_OPT_G_VERIFY,
2950 },
2951 {
2952 .name = "verify_backlog",
2953 .lname = "Verify backlog",
2954 .type = FIO_OPT_STR_VAL,
2955 .off1 = offsetof(struct thread_options, verify_backlog),
2956 .help = "Verify after this number of blocks are written",
2957 .parent = "verify",
2958 .hide = 1,
2959 .category = FIO_OPT_C_IO,
2960 .group = FIO_OPT_G_VERIFY,
2961 },
2962 {
2963 .name = "verify_backlog_batch",
2964 .lname = "Verify backlog batch",
2965 .type = FIO_OPT_INT,
2966 .off1 = offsetof(struct thread_options, verify_batch),
2967 .help = "Verify this number of IO blocks",
2968 .parent = "verify",
2969 .hide = 1,
2970 .category = FIO_OPT_C_IO,
2971 .group = FIO_OPT_G_VERIFY,
2972 },
2973#ifdef FIO_HAVE_CPU_AFFINITY
2974 {
2975 .name = "verify_async_cpus",
2976 .lname = "Async verify CPUs",
2977 .type = FIO_OPT_STR,
2978 .cb = str_verify_cpus_allowed_cb,
2979 .off1 = offsetof(struct thread_options, verify_cpumask),
2980 .help = "Set CPUs allowed for async verify threads",
2981 .parent = "verify_async",
2982 .hide = 1,
2983 .category = FIO_OPT_C_IO,
2984 .group = FIO_OPT_G_VERIFY,
2985 },
2986#else
2987 {
2988 .name = "verify_async_cpus",
2989 .lname = "Async verify CPUs",
2990 .type = FIO_OPT_UNSUPPORTED,
2991 .help = "Your platform does not support CPU affinities",
2992 },
2993#endif
2994 {
2995 .name = "experimental_verify",
2996 .lname = "Experimental Verify",
2997 .off1 = offsetof(struct thread_options, experimental_verify),
2998 .type = FIO_OPT_BOOL,
2999 .help = "Enable experimental verification",
3000 .parent = "verify",
3001 .category = FIO_OPT_C_IO,
3002 .group = FIO_OPT_G_VERIFY,
3003 },
3004 {
3005 .name = "verify_state_load",
3006 .lname = "Load verify state",
3007 .off1 = offsetof(struct thread_options, verify_state),
3008 .type = FIO_OPT_BOOL,
3009 .help = "Load verify termination state",
3010 .parent = "verify",
3011 .category = FIO_OPT_C_IO,
3012 .group = FIO_OPT_G_VERIFY,
3013 },
3014 {
3015 .name = "verify_state_save",
3016 .lname = "Save verify state",
3017 .off1 = offsetof(struct thread_options, verify_state_save),
3018 .type = FIO_OPT_BOOL,
3019 .def = "1",
3020 .help = "Save verify state on termination",
3021 .parent = "verify",
3022 .category = FIO_OPT_C_IO,
3023 .group = FIO_OPT_G_VERIFY,
3024 },
3025#ifdef FIO_HAVE_TRIM
3026 {
3027 .name = "trim_percentage",
3028 .lname = "Trim percentage",
3029 .type = FIO_OPT_INT,
3030 .off1 = offsetof(struct thread_options, trim_percentage),
3031 .minval = 0,
3032 .maxval = 100,
3033 .help = "Number of verify blocks to trim (i.e., discard)",
3034 .parent = "verify",
3035 .def = "0",
3036 .interval = 1,
3037 .hide = 1,
3038 .category = FIO_OPT_C_IO,
3039 .group = FIO_OPT_G_TRIM,
3040 },
3041 {
3042 .name = "trim_verify_zero",
3043 .lname = "Verify trim zero",
3044 .type = FIO_OPT_BOOL,
3045 .help = "Verify that trimmed (i.e., discarded) blocks are returned as zeroes",
3046 .off1 = offsetof(struct thread_options, trim_zero),
3047 .parent = "trim_percentage",
3048 .hide = 1,
3049 .def = "1",
3050 .category = FIO_OPT_C_IO,
3051 .group = FIO_OPT_G_TRIM,
3052 },
3053 {
3054 .name = "trim_backlog",
3055 .lname = "Trim backlog",
3056 .type = FIO_OPT_STR_VAL,
3057 .off1 = offsetof(struct thread_options, trim_backlog),
3058 .help = "Trim after this number of blocks are written",
3059 .parent = "trim_percentage",
3060 .hide = 1,
3061 .interval = 1,
3062 .category = FIO_OPT_C_IO,
3063 .group = FIO_OPT_G_TRIM,
3064 },
3065 {
3066 .name = "trim_backlog_batch",
3067 .lname = "Trim backlog batch",
3068 .type = FIO_OPT_INT,
3069 .off1 = offsetof(struct thread_options, trim_batch),
3070 .help = "Trim this number of IO blocks",
3071 .parent = "trim_percentage",
3072 .hide = 1,
3073 .interval = 1,
3074 .category = FIO_OPT_C_IO,
3075 .group = FIO_OPT_G_TRIM,
3076 },
3077#else
3078 {
3079 .name = "trim_percentage",
3080 .lname = "Trim percentage",
3081 .type = FIO_OPT_UNSUPPORTED,
3082 .help = "Fio does not support TRIM on your platform",
3083 },
3084 {
3085 .name = "trim_verify_zero",
3086 .lname = "Verify trim zero",
3087 .type = FIO_OPT_UNSUPPORTED,
3088 .help = "Fio does not support TRIM on your platform",
3089 },
3090 {
3091 .name = "trim_backlog",
3092 .lname = "Trim backlog",
3093 .type = FIO_OPT_UNSUPPORTED,
3094 .help = "Fio does not support TRIM on your platform",
3095 },
3096 {
3097 .name = "trim_backlog_batch",
3098 .lname = "Trim backlog batch",
3099 .type = FIO_OPT_UNSUPPORTED,
3100 .help = "Fio does not support TRIM on your platform",
3101 },
3102#endif
3103 {
3104 .name = "write_iolog",
3105 .lname = "Write I/O log",
3106 .type = FIO_OPT_STR_STORE,
3107 .off1 = offsetof(struct thread_options, write_iolog_file),
3108 .help = "Store IO pattern to file",
3109 .category = FIO_OPT_C_IO,
3110 .group = FIO_OPT_G_IOLOG,
3111 },
3112 {
3113 .name = "read_iolog",
3114 .lname = "Read I/O log",
3115 .type = FIO_OPT_STR_STORE,
3116 .off1 = offsetof(struct thread_options, read_iolog_file),
3117 .help = "Playback IO pattern from file",
3118 .category = FIO_OPT_C_IO,
3119 .group = FIO_OPT_G_IOLOG,
3120 },
3121 {
3122 .name = "read_iolog_chunked",
3123 .lname = "Read I/O log in parts",
3124 .type = FIO_OPT_BOOL,
3125 .off1 = offsetof(struct thread_options, read_iolog_chunked),
3126 .def = "0",
3127 .parent = "read_iolog",
3128 .help = "Parse IO pattern in chunks",
3129 .category = FIO_OPT_C_IO,
3130 .group = FIO_OPT_G_IOLOG,
3131 },
3132 {
3133 .name = "replay_no_stall",
3134 .lname = "Don't stall on replay",
3135 .type = FIO_OPT_BOOL,
3136 .off1 = offsetof(struct thread_options, no_stall),
3137 .def = "0",
3138 .parent = "read_iolog",
3139 .hide = 1,
3140 .help = "Playback IO pattern file as fast as possible without stalls",
3141 .category = FIO_OPT_C_IO,
3142 .group = FIO_OPT_G_IOLOG,
3143 },
3144 {
3145 .name = "replay_redirect",
3146 .lname = "Redirect device for replay",
3147 .type = FIO_OPT_STR_STORE,
3148 .off1 = offsetof(struct thread_options, replay_redirect),
3149 .parent = "read_iolog",
3150 .hide = 1,
3151 .help = "Replay all I/O onto this device, regardless of trace device",
3152 .category = FIO_OPT_C_IO,
3153 .group = FIO_OPT_G_IOLOG,
3154 },
3155 {
3156 .name = "replay_scale",
3157 .lname = "Replace offset scale factor",
3158 .type = FIO_OPT_INT,
3159 .off1 = offsetof(struct thread_options, replay_scale),
3160 .parent = "read_iolog",
3161 .def = "1",
3162 .help = "Align offsets to this blocksize",
3163 .category = FIO_OPT_C_IO,
3164 .group = FIO_OPT_G_IOLOG,
3165 },
3166 {
3167 .name = "replay_align",
3168 .lname = "Replace alignment",
3169 .type = FIO_OPT_INT,
3170 .off1 = offsetof(struct thread_options, replay_align),
3171 .parent = "read_iolog",
3172 .help = "Scale offset down by this factor",
3173 .category = FIO_OPT_C_IO,
3174 .group = FIO_OPT_G_IOLOG,
3175 .pow2 = 1,
3176 },
3177 {
3178 .name = "replay_time_scale",
3179 .lname = "Replay Time Scale",
3180 .type = FIO_OPT_INT,
3181 .off1 = offsetof(struct thread_options, replay_time_scale),
3182 .def = "100",
3183 .minval = 1,
3184 .parent = "read_iolog",
3185 .hide = 1,
3186 .help = "Scale time for replay events",
3187 .category = FIO_OPT_C_IO,
3188 .group = FIO_OPT_G_IOLOG,
3189 },
3190 {
3191 .name = "replay_skip",
3192 .lname = "Replay Skip",
3193 .type = FIO_OPT_STR,
3194 .cb = str_replay_skip_cb,
3195 .off1 = offsetof(struct thread_options, replay_skip),
3196 .parent = "read_iolog",
3197 .help = "Skip certain IO types (read,write,trim,flush)",
3198 .category = FIO_OPT_C_IO,
3199 .group = FIO_OPT_G_IOLOG,
3200 },
3201 {
3202 .name = "merge_blktrace_file",
3203 .lname = "Merged blktrace output filename",
3204 .type = FIO_OPT_STR_STORE,
3205 .off1 = offsetof(struct thread_options, merge_blktrace_file),
3206 .help = "Merged blktrace output filename",
3207 .category = FIO_OPT_C_IO,
3208 .group = FIO_OPT_G_IOLOG,
3209 },
3210 {
3211 .name = "merge_blktrace_scalars",
3212 .lname = "Percentage to scale each trace",
3213 .type = FIO_OPT_FLOAT_LIST,
3214 .off1 = offsetof(struct thread_options, merge_blktrace_scalars),
3215 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3216 .help = "Percentage to scale each trace",
3217 .category = FIO_OPT_C_IO,
3218 .group = FIO_OPT_G_IOLOG,
3219 },
3220 {
3221 .name = "merge_blktrace_iters",
3222 .lname = "Number of iterations to run per trace",
3223 .type = FIO_OPT_FLOAT_LIST,
3224 .off1 = offsetof(struct thread_options, merge_blktrace_iters),
3225 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3226 .help = "Number of iterations to run per trace",
3227 .category = FIO_OPT_C_IO,
3228 .group = FIO_OPT_G_IOLOG,
3229 },
3230 {
3231 .name = "exec_prerun",
3232 .lname = "Pre-execute runnable",
3233 .type = FIO_OPT_STR_STORE,
3234 .off1 = offsetof(struct thread_options, exec_prerun),
3235 .help = "Execute this file prior to running job",
3236 .category = FIO_OPT_C_GENERAL,
3237 .group = FIO_OPT_G_INVALID,
3238 },
3239 {
3240 .name = "exec_postrun",
3241 .lname = "Post-execute runnable",
3242 .type = FIO_OPT_STR_STORE,
3243 .off1 = offsetof(struct thread_options, exec_postrun),
3244 .help = "Execute this file after running job",
3245 .category = FIO_OPT_C_GENERAL,
3246 .group = FIO_OPT_G_INVALID,
3247 },
3248#ifdef FIO_HAVE_IOSCHED_SWITCH
3249 {
3250 .name = "ioscheduler",
3251 .lname = "I/O scheduler",
3252 .type = FIO_OPT_STR_STORE,
3253 .off1 = offsetof(struct thread_options, ioscheduler),
3254 .help = "Use this IO scheduler on the backing device",
3255 .category = FIO_OPT_C_FILE,
3256 .group = FIO_OPT_G_INVALID,
3257 },
3258#else
3259 {
3260 .name = "ioscheduler",
3261 .lname = "I/O scheduler",
3262 .type = FIO_OPT_UNSUPPORTED,
3263 .help = "Your platform does not support IO scheduler switching",
3264 },
3265#endif
3266 {
3267 .name = "zonemode",
3268 .lname = "Zone mode",
3269 .help = "Mode for the zonesize, zonerange and zoneskip parameters",
3270 .type = FIO_OPT_STR,
3271 .off1 = offsetof(struct thread_options, zone_mode),
3272 .def = "none",
3273 .category = FIO_OPT_C_IO,
3274 .group = FIO_OPT_G_ZONE,
3275 .posval = {
3276 { .ival = "none",
3277 .oval = ZONE_MODE_NONE,
3278 .help = "no zoning",
3279 },
3280 { .ival = "strided",
3281 .oval = ZONE_MODE_STRIDED,
3282 .help = "strided mode - random I/O is restricted to a single zone",
3283 },
3284 { .ival = "zbd",
3285 .oval = ZONE_MODE_ZBD,
3286 .help = "zoned block device mode - random I/O selects one of multiple zones randomly",
3287 },
3288 },
3289 },
3290 {
3291 .name = "zonesize",
3292 .lname = "Zone size",
3293 .type = FIO_OPT_STR_VAL,
3294 .off1 = offsetof(struct thread_options, zone_size),
3295 .help = "Amount of data to read per zone",
3296 .def = "0",
3297 .interval = 1024 * 1024,
3298 .category = FIO_OPT_C_IO,
3299 .group = FIO_OPT_G_ZONE,
3300 },
3301 {
3302 .name = "zonerange",
3303 .lname = "Zone range",
3304 .type = FIO_OPT_STR_VAL,
3305 .off1 = offsetof(struct thread_options, zone_range),
3306 .help = "Give size of an IO zone",
3307 .def = "0",
3308 .interval = 1024 * 1024,
3309 .category = FIO_OPT_C_IO,
3310 .group = FIO_OPT_G_ZONE,
3311 },
3312 {
3313 .name = "zoneskip",
3314 .lname = "Zone skip",
3315 .type = FIO_OPT_STR_VAL,
3316 .off1 = offsetof(struct thread_options, zone_skip),
3317 .help = "Space between IO zones",
3318 .def = "0",
3319 .interval = 1024 * 1024,
3320 .category = FIO_OPT_C_IO,
3321 .group = FIO_OPT_G_ZONE,
3322 },
3323 {
3324 .name = "read_beyond_wp",
3325 .lname = "Allow reads beyond the zone write pointer",
3326 .type = FIO_OPT_BOOL,
3327 .off1 = offsetof(struct thread_options, read_beyond_wp),
3328 .help = "Allow reads beyond the zone write pointer",
3329 .def = "0",
3330 .category = FIO_OPT_C_IO,
3331 .group = FIO_OPT_G_INVALID,
3332 },
3333 {
3334 .name = "max_open_zones",
3335 .lname = "Maximum number of open zones",
3336 .type = FIO_OPT_INT,
3337 .off1 = offsetof(struct thread_options, max_open_zones),
3338 .maxval = FIO_MAX_OPEN_ZBD_ZONES,
3339 .help = "Limit random writes to SMR drives to the specified"
3340 " number of sequential zones",
3341 .def = "0",
3342 .category = FIO_OPT_C_IO,
3343 .group = FIO_OPT_G_INVALID,
3344 },
3345 {
3346 .name = "zone_reset_threshold",
3347 .lname = "Zone reset threshold",
3348 .help = "Zoned block device reset threshold",
3349 .type = FIO_OPT_FLOAT_LIST,
3350 .maxlen = 1,
3351 .off1 = offsetof(struct thread_options, zrt),
3352 .minfp = 0,
3353 .maxfp = 1,
3354 .category = FIO_OPT_C_IO,
3355 .group = FIO_OPT_G_ZONE,
3356 },
3357 {
3358 .name = "zone_reset_frequency",
3359 .lname = "Zone reset frequency",
3360 .help = "Zoned block device zone reset frequency in HZ",
3361 .type = FIO_OPT_FLOAT_LIST,
3362 .maxlen = 1,
3363 .off1 = offsetof(struct thread_options, zrf),
3364 .minfp = 0,
3365 .maxfp = 1,
3366 .category = FIO_OPT_C_IO,
3367 .group = FIO_OPT_G_ZONE,
3368 },
3369 {
3370 .name = "lockmem",
3371 .lname = "Lock memory",
3372 .type = FIO_OPT_STR_VAL,
3373 .off1 = offsetof(struct thread_options, lockmem),
3374 .help = "Lock down this amount of memory (per worker)",
3375 .def = "0",
3376 .interval = 1024 * 1024,
3377 .category = FIO_OPT_C_GENERAL,
3378 .group = FIO_OPT_G_INVALID,
3379 },
3380 {
3381 .name = "rwmixread",
3382 .lname = "Read/write mix read",
3383 .type = FIO_OPT_INT,
3384 .cb = str_rwmix_read_cb,
3385 .off1 = offsetof(struct thread_options, rwmix[DDIR_READ]),
3386 .maxval = 100,
3387 .help = "Percentage of mixed workload that is reads",
3388 .def = "50",
3389 .interval = 5,
3390 .inverse = "rwmixwrite",
3391 .category = FIO_OPT_C_IO,
3392 .group = FIO_OPT_G_RWMIX,
3393 },
3394 {
3395 .name = "rwmixwrite",
3396 .lname = "Read/write mix write",
3397 .type = FIO_OPT_INT,
3398 .cb = str_rwmix_write_cb,
3399 .off1 = offsetof(struct thread_options, rwmix[DDIR_WRITE]),
3400 .maxval = 100,
3401 .help = "Percentage of mixed workload that is writes",
3402 .def = "50",
3403 .interval = 5,
3404 .inverse = "rwmixread",
3405 .category = FIO_OPT_C_IO,
3406 .group = FIO_OPT_G_RWMIX,
3407 },
3408 {
3409 .name = "rwmixcycle",
3410 .lname = "Read/write mix cycle",
3411 .type = FIO_OPT_DEPRECATED,
3412 .category = FIO_OPT_C_IO,
3413 .group = FIO_OPT_G_RWMIX,
3414 },
3415 {
3416 .name = "nice",
3417 .lname = "Nice",
3418 .type = FIO_OPT_INT,
3419 .off1 = offsetof(struct thread_options, nice),
3420 .help = "Set job CPU nice value",
3421 .minval = -20,
3422 .maxval = 19,
3423 .def = "0",
3424 .interval = 1,
3425 .category = FIO_OPT_C_GENERAL,
3426 .group = FIO_OPT_G_CRED,
3427 },
3428#ifdef FIO_HAVE_IOPRIO
3429 {
3430 .name = "prio",
3431 .lname = "I/O nice priority",
3432 .type = FIO_OPT_INT,
3433 .off1 = offsetof(struct thread_options, ioprio),
3434 .help = "Set job IO priority value",
3435 .minval = IOPRIO_MIN_PRIO,
3436 .maxval = IOPRIO_MAX_PRIO,
3437 .interval = 1,
3438 .category = FIO_OPT_C_GENERAL,
3439 .group = FIO_OPT_G_CRED,
3440 },
3441#else
3442 {
3443 .name = "prio",
3444 .lname = "I/O nice priority",
3445 .type = FIO_OPT_UNSUPPORTED,
3446 .help = "Your platform does not support IO priorities",
3447 },
3448#endif
3449#ifdef FIO_HAVE_IOPRIO_CLASS
3450#ifndef FIO_HAVE_IOPRIO
3451#error "FIO_HAVE_IOPRIO_CLASS requires FIO_HAVE_IOPRIO"
3452#endif
3453 {
3454 .name = "prioclass",
3455 .lname = "I/O nice priority class",
3456 .type = FIO_OPT_INT,
3457 .off1 = offsetof(struct thread_options, ioprio_class),
3458 .help = "Set job IO priority class",
3459 .minval = IOPRIO_MIN_PRIO_CLASS,
3460 .maxval = IOPRIO_MAX_PRIO_CLASS,
3461 .interval = 1,
3462 .category = FIO_OPT_C_GENERAL,
3463 .group = FIO_OPT_G_CRED,
3464 },
3465#else
3466 {
3467 .name = "prioclass",
3468 .lname = "I/O nice priority class",
3469 .type = FIO_OPT_UNSUPPORTED,
3470 .help = "Your platform does not support IO priority classes",
3471 },
3472#endif
3473 {
3474 .name = "thinktime",
3475 .lname = "Thinktime",
3476 .type = FIO_OPT_INT,
3477 .off1 = offsetof(struct thread_options, thinktime),
3478 .help = "Idle time between IO buffers (usec)",
3479 .def = "0",
3480 .is_time = 1,
3481 .category = FIO_OPT_C_IO,
3482 .group = FIO_OPT_G_THINKTIME,
3483 },
3484 {
3485 .name = "thinktime_spin",
3486 .lname = "Thinktime spin",
3487 .type = FIO_OPT_INT,
3488 .off1 = offsetof(struct thread_options, thinktime_spin),
3489 .help = "Start think time by spinning this amount (usec)",
3490 .def = "0",
3491 .is_time = 1,
3492 .parent = "thinktime",
3493 .hide = 1,
3494 .category = FIO_OPT_C_IO,
3495 .group = FIO_OPT_G_THINKTIME,
3496 },
3497 {
3498 .name = "thinktime_blocks",
3499 .lname = "Thinktime blocks",
3500 .type = FIO_OPT_INT,
3501 .off1 = offsetof(struct thread_options, thinktime_blocks),
3502 .help = "IO buffer period between 'thinktime'",
3503 .def = "1",
3504 .parent = "thinktime",
3505 .hide = 1,
3506 .category = FIO_OPT_C_IO,
3507 .group = FIO_OPT_G_THINKTIME,
3508 },
3509 {
3510 .name = "rate",
3511 .lname = "I/O rate",
3512 .type = FIO_OPT_INT,
3513 .off1 = offsetof(struct thread_options, rate[DDIR_READ]),
3514 .off2 = offsetof(struct thread_options, rate[DDIR_WRITE]),
3515 .off3 = offsetof(struct thread_options, rate[DDIR_TRIM]),
3516 .help = "Set bandwidth rate",
3517 .category = FIO_OPT_C_IO,
3518 .group = FIO_OPT_G_RATE,
3519 },
3520 {
3521 .name = "rate_min",
3522 .alias = "ratemin",
3523 .lname = "I/O min rate",
3524 .type = FIO_OPT_INT,
3525 .off1 = offsetof(struct thread_options, ratemin[DDIR_READ]),
3526 .off2 = offsetof(struct thread_options, ratemin[DDIR_WRITE]),
3527 .off3 = offsetof(struct thread_options, ratemin[DDIR_TRIM]),
3528 .help = "Job must meet this rate or it will be shutdown",
3529 .parent = "rate",
3530 .hide = 1,
3531 .category = FIO_OPT_C_IO,
3532 .group = FIO_OPT_G_RATE,
3533 },
3534 {
3535 .name = "rate_iops",
3536 .lname = "I/O rate IOPS",
3537 .type = FIO_OPT_INT,
3538 .off1 = offsetof(struct thread_options, rate_iops[DDIR_READ]),
3539 .off2 = offsetof(struct thread_options, rate_iops[DDIR_WRITE]),
3540 .off3 = offsetof(struct thread_options, rate_iops[DDIR_TRIM]),
3541 .help = "Limit IO used to this number of IO operations/sec",
3542 .hide = 1,
3543 .category = FIO_OPT_C_IO,
3544 .group = FIO_OPT_G_RATE,
3545 },
3546 {
3547 .name = "rate_iops_min",
3548 .lname = "I/O min rate IOPS",
3549 .type = FIO_OPT_INT,
3550 .off1 = offsetof(struct thread_options, rate_iops_min[DDIR_READ]),
3551 .off2 = offsetof(struct thread_options, rate_iops_min[DDIR_WRITE]),
3552 .off3 = offsetof(struct thread_options, rate_iops_min[DDIR_TRIM]),
3553 .help = "Job must meet this rate or it will be shut down",
3554 .parent = "rate_iops",
3555 .hide = 1,
3556 .category = FIO_OPT_C_IO,
3557 .group = FIO_OPT_G_RATE,
3558 },
3559 {
3560 .name = "rate_process",
3561 .lname = "Rate Process",
3562 .type = FIO_OPT_STR,
3563 .off1 = offsetof(struct thread_options, rate_process),
3564 .help = "What process controls how rated IO is managed",
3565 .def = "linear",
3566 .category = FIO_OPT_C_IO,
3567 .group = FIO_OPT_G_RATE,
3568 .posval = {
3569 { .ival = "linear",
3570 .oval = RATE_PROCESS_LINEAR,
3571 .help = "Linear rate of IO",
3572 },
3573 {
3574 .ival = "poisson",
3575 .oval = RATE_PROCESS_POISSON,
3576 .help = "Rate follows Poisson process",
3577 },
3578 },
3579 .parent = "rate",
3580 },
3581 {
3582 .name = "rate_cycle",
3583 .alias = "ratecycle",
3584 .lname = "I/O rate cycle",
3585 .type = FIO_OPT_INT,
3586 .off1 = offsetof(struct thread_options, ratecycle),
3587 .help = "Window average for rate limits (msec)",
3588 .def = "1000",
3589 .parent = "rate",
3590 .hide = 1,
3591 .category = FIO_OPT_C_IO,
3592 .group = FIO_OPT_G_RATE,
3593 },
3594 {
3595 .name = "rate_ignore_thinktime",
3596 .lname = "Rate ignore thinktime",
3597 .type = FIO_OPT_BOOL,
3598 .off1 = offsetof(struct thread_options, rate_ign_think),
3599 .help = "Rated IO ignores thinktime settings",
3600 .parent = "rate",
3601 .category = FIO_OPT_C_IO,
3602 .group = FIO_OPT_G_RATE,
3603 },
3604 {
3605 .name = "max_latency",
3606 .lname = "Max Latency (usec)",
3607 .type = FIO_OPT_STR_VAL_TIME,
3608 .off1 = offsetof(struct thread_options, max_latency),
3609 .help = "Maximum tolerated IO latency (usec)",
3610 .is_time = 1,
3611 .category = FIO_OPT_C_IO,
3612 .group = FIO_OPT_G_LATPROF,
3613 },
3614 {
3615 .name = "latency_target",
3616 .lname = "Latency Target (usec)",
3617 .type = FIO_OPT_STR_VAL_TIME,
3618 .off1 = offsetof(struct thread_options, latency_target),
3619 .help = "Ramp to max queue depth supporting this latency",
3620 .is_time = 1,
3621 .category = FIO_OPT_C_IO,
3622 .group = FIO_OPT_G_LATPROF,
3623 },
3624 {
3625 .name = "latency_window",
3626 .lname = "Latency Window (usec)",
3627 .type = FIO_OPT_STR_VAL_TIME,
3628 .off1 = offsetof(struct thread_options, latency_window),
3629 .help = "Time to sustain latency_target",
3630 .is_time = 1,
3631 .category = FIO_OPT_C_IO,
3632 .group = FIO_OPT_G_LATPROF,
3633 },
3634 {
3635 .name = "latency_percentile",
3636 .lname = "Latency Percentile",
3637 .type = FIO_OPT_FLOAT_LIST,
3638 .off1 = offsetof(struct thread_options, latency_percentile),
3639 .help = "Percentile of IOs must be below latency_target",
3640 .def = "100",
3641 .maxlen = 1,
3642 .minfp = 0.0,
3643 .maxfp = 100.0,
3644 .category = FIO_OPT_C_IO,
3645 .group = FIO_OPT_G_LATPROF,
3646 },
3647 {
3648 .name = "invalidate",
3649 .lname = "Cache invalidate",
3650 .type = FIO_OPT_BOOL,
3651 .off1 = offsetof(struct thread_options, invalidate_cache),
3652 .help = "Invalidate buffer/page cache prior to running job",
3653 .def = "1",
3654 .category = FIO_OPT_C_IO,
3655 .group = FIO_OPT_G_IO_TYPE,
3656 },
3657 {
3658 .name = "sync",
3659 .lname = "Synchronous I/O",
3660 .type = FIO_OPT_BOOL,
3661 .off1 = offsetof(struct thread_options, sync_io),
3662 .help = "Use O_SYNC for buffered writes",
3663 .def = "0",
3664 .parent = "buffered",
3665 .hide = 1,
3666 .category = FIO_OPT_C_IO,
3667 .group = FIO_OPT_G_IO_TYPE,
3668 },
3669#ifdef FIO_HAVE_WRITE_HINT
3670 {
3671 .name = "write_hint",
3672 .lname = "Write hint",
3673 .type = FIO_OPT_STR,
3674 .off1 = offsetof(struct thread_options, write_hint),
3675 .help = "Set expected write life time",
3676 .category = FIO_OPT_C_ENGINE,
3677 .group = FIO_OPT_G_INVALID,
3678 .posval = {
3679 { .ival = "none",
3680 .oval = RWH_WRITE_LIFE_NONE,
3681 },
3682 { .ival = "short",
3683 .oval = RWH_WRITE_LIFE_SHORT,
3684 },
3685 { .ival = "medium",
3686 .oval = RWH_WRITE_LIFE_MEDIUM,
3687 },
3688 { .ival = "long",
3689 .oval = RWH_WRITE_LIFE_LONG,
3690 },
3691 { .ival = "extreme",
3692 .oval = RWH_WRITE_LIFE_EXTREME,
3693 },
3694 },
3695 },
3696#endif
3697 {
3698 .name = "create_serialize",
3699 .lname = "Create serialize",
3700 .type = FIO_OPT_BOOL,
3701 .off1 = offsetof(struct thread_options, create_serialize),
3702 .help = "Serialize creation of job files",
3703 .def = "1",
3704 .category = FIO_OPT_C_FILE,
3705 .group = FIO_OPT_G_INVALID,
3706 },
3707 {
3708 .name = "create_fsync",
3709 .lname = "Create fsync",
3710 .type = FIO_OPT_BOOL,
3711 .off1 = offsetof(struct thread_options, create_fsync),
3712 .help = "fsync file after creation",
3713 .def = "1",
3714 .category = FIO_OPT_C_FILE,
3715 .group = FIO_OPT_G_INVALID,
3716 },
3717 {
3718 .name = "create_on_open",
3719 .lname = "Create on open",
3720 .type = FIO_OPT_BOOL,
3721 .off1 = offsetof(struct thread_options, create_on_open),
3722 .help = "Create files when they are opened for IO",
3723 .def = "0",
3724 .category = FIO_OPT_C_FILE,
3725 .group = FIO_OPT_G_INVALID,
3726 },
3727 {
3728 .name = "create_only",
3729 .lname = "Create Only",
3730 .type = FIO_OPT_BOOL,
3731 .off1 = offsetof(struct thread_options, create_only),
3732 .help = "Only perform file creation phase",
3733 .category = FIO_OPT_C_FILE,
3734 .def = "0",
3735 },
3736 {
3737 .name = "allow_file_create",
3738 .lname = "Allow file create",
3739 .type = FIO_OPT_BOOL,
3740 .off1 = offsetof(struct thread_options, allow_create),
3741 .help = "Permit fio to create files, if they don't exist",
3742 .def = "1",
3743 .category = FIO_OPT_C_FILE,
3744 .group = FIO_OPT_G_FILENAME,
3745 },
3746 {
3747 .name = "allow_mounted_write",
3748 .lname = "Allow mounted write",
3749 .type = FIO_OPT_BOOL,
3750 .off1 = offsetof(struct thread_options, allow_mounted_write),
3751 .help = "Allow writes to a mounted partition",
3752 .def = "0",
3753 .category = FIO_OPT_C_FILE,
3754 .group = FIO_OPT_G_FILENAME,
3755 },
3756 {
3757 .name = "pre_read",
3758 .lname = "Pre-read files",
3759 .type = FIO_OPT_BOOL,
3760 .off1 = offsetof(struct thread_options, pre_read),
3761 .help = "Pre-read files before starting official testing",
3762 .def = "0",
3763 .category = FIO_OPT_C_FILE,
3764 .group = FIO_OPT_G_INVALID,
3765 },
3766#ifdef FIO_HAVE_CPU_AFFINITY
3767 {
3768 .name = "cpumask",
3769 .lname = "CPU mask",
3770 .type = FIO_OPT_INT,
3771 .cb = str_cpumask_cb,
3772 .off1 = offsetof(struct thread_options, cpumask),
3773 .help = "CPU affinity mask",
3774 .category = FIO_OPT_C_GENERAL,
3775 .group = FIO_OPT_G_CRED,
3776 },
3777 {
3778 .name = "cpus_allowed",
3779 .lname = "CPUs allowed",
3780 .type = FIO_OPT_STR,
3781 .cb = str_cpus_allowed_cb,
3782 .off1 = offsetof(struct thread_options, cpumask),
3783 .help = "Set CPUs allowed",
3784 .category = FIO_OPT_C_GENERAL,
3785 .group = FIO_OPT_G_CRED,
3786 },
3787 {
3788 .name = "cpus_allowed_policy",
3789 .lname = "CPUs allowed distribution policy",
3790 .type = FIO_OPT_STR,
3791 .off1 = offsetof(struct thread_options, cpus_allowed_policy),
3792 .help = "Distribution policy for cpus_allowed",
3793 .parent = "cpus_allowed",
3794 .prio = 1,
3795 .posval = {
3796 { .ival = "shared",
3797 .oval = FIO_CPUS_SHARED,
3798 .help = "Mask shared between threads",
3799 },
3800 { .ival = "split",
3801 .oval = FIO_CPUS_SPLIT,
3802 .help = "Mask split between threads",
3803 },
3804 },
3805 .category = FIO_OPT_C_GENERAL,
3806 .group = FIO_OPT_G_CRED,
3807 },
3808#else
3809 {
3810 .name = "cpumask",
3811 .lname = "CPU mask",
3812 .type = FIO_OPT_UNSUPPORTED,
3813 .help = "Your platform does not support CPU affinities",
3814 },
3815 {
3816 .name = "cpus_allowed",
3817 .lname = "CPUs allowed",
3818 .type = FIO_OPT_UNSUPPORTED,
3819 .help = "Your platform does not support CPU affinities",
3820 },
3821 {
3822 .name = "cpus_allowed_policy",
3823 .lname = "CPUs allowed distribution policy",
3824 .type = FIO_OPT_UNSUPPORTED,
3825 .help = "Your platform does not support CPU affinities",
3826 },
3827#endif
3828#ifdef CONFIG_LIBNUMA
3829 {
3830 .name = "numa_cpu_nodes",
3831 .lname = "NUMA CPU Nodes",
3832 .type = FIO_OPT_STR,
3833 .cb = str_numa_cpunodes_cb,
3834 .off1 = offsetof(struct thread_options, numa_cpunodes),
3835 .help = "NUMA CPU nodes bind",
3836 .category = FIO_OPT_C_GENERAL,
3837 .group = FIO_OPT_G_INVALID,
3838 },
3839 {
3840 .name = "numa_mem_policy",
3841 .lname = "NUMA Memory Policy",
3842 .type = FIO_OPT_STR,
3843 .cb = str_numa_mpol_cb,
3844 .off1 = offsetof(struct thread_options, numa_memnodes),
3845 .help = "NUMA memory policy setup",
3846 .category = FIO_OPT_C_GENERAL,
3847 .group = FIO_OPT_G_INVALID,
3848 },
3849#else
3850 {
3851 .name = "numa_cpu_nodes",
3852 .lname = "NUMA CPU Nodes",
3853 .type = FIO_OPT_UNSUPPORTED,
3854 .help = "Build fio with libnuma-dev(el) to enable this option",
3855 },
3856 {
3857 .name = "numa_mem_policy",
3858 .lname = "NUMA Memory Policy",
3859 .type = FIO_OPT_UNSUPPORTED,
3860 .help = "Build fio with libnuma-dev(el) to enable this option",
3861 },
3862#endif
3863#ifdef CONFIG_CUDA
3864 {
3865 .name = "gpu_dev_id",
3866 .lname = "GPU device ID",
3867 .type = FIO_OPT_INT,
3868 .off1 = offsetof(struct thread_options, gpu_dev_id),
3869 .help = "Set GPU device ID for GPUDirect RDMA",
3870 .def = "0",
3871 .category = FIO_OPT_C_GENERAL,
3872 .group = FIO_OPT_G_INVALID,
3873 },
3874#endif
3875 {
3876 .name = "end_fsync",
3877 .lname = "End fsync",
3878 .type = FIO_OPT_BOOL,
3879 .off1 = offsetof(struct thread_options, end_fsync),
3880 .help = "Include fsync at the end of job",
3881 .def = "0",
3882 .category = FIO_OPT_C_FILE,
3883 .group = FIO_OPT_G_INVALID,
3884 },
3885 {
3886 .name = "fsync_on_close",
3887 .lname = "Fsync on close",
3888 .type = FIO_OPT_BOOL,
3889 .off1 = offsetof(struct thread_options, fsync_on_close),
3890 .help = "fsync files on close",
3891 .def = "0",
3892 .category = FIO_OPT_C_FILE,
3893 .group = FIO_OPT_G_INVALID,
3894 },
3895 {
3896 .name = "unlink",
3897 .lname = "Unlink file",
3898 .type = FIO_OPT_BOOL,
3899 .off1 = offsetof(struct thread_options, unlink),
3900 .help = "Unlink created files after job has completed",
3901 .def = "0",
3902 .category = FIO_OPT_C_FILE,
3903 .group = FIO_OPT_G_INVALID,
3904 },
3905 {
3906 .name = "unlink_each_loop",
3907 .lname = "Unlink file after each loop of a job",
3908 .type = FIO_OPT_BOOL,
3909 .off1 = offsetof(struct thread_options, unlink_each_loop),
3910 .help = "Unlink created files after each loop in a job has completed",
3911 .def = "0",
3912 .category = FIO_OPT_C_FILE,
3913 .group = FIO_OPT_G_INVALID,
3914 },
3915 {
3916 .name = "exitall",
3917 .lname = "Exit-all on terminate",
3918 .type = FIO_OPT_STR_SET,
3919 .cb = str_exitall_cb,
3920 .help = "Terminate all jobs when one exits",
3921 .category = FIO_OPT_C_GENERAL,
3922 .group = FIO_OPT_G_PROCESS,
3923 },
3924 {
3925 .name = "exitall_on_error",
3926 .lname = "Exit-all on terminate in error",
3927 .type = FIO_OPT_STR_SET,
3928 .off1 = offsetof(struct thread_options, exitall_error),
3929 .help = "Terminate all jobs when one exits in error",
3930 .category = FIO_OPT_C_GENERAL,
3931 .group = FIO_OPT_G_PROCESS,
3932 },
3933 {
3934 .name = "stonewall",
3935 .lname = "Wait for previous",
3936 .alias = "wait_for_previous",
3937 .type = FIO_OPT_STR_SET,
3938 .off1 = offsetof(struct thread_options, stonewall),
3939 .help = "Insert a hard barrier between this job and previous",
3940 .category = FIO_OPT_C_GENERAL,
3941 .group = FIO_OPT_G_PROCESS,
3942 },
3943 {
3944 .name = "new_group",
3945 .lname = "New group",
3946 .type = FIO_OPT_STR_SET,
3947 .off1 = offsetof(struct thread_options, new_group),
3948 .help = "Mark the start of a new group (for reporting)",
3949 .category = FIO_OPT_C_GENERAL,
3950 .group = FIO_OPT_G_PROCESS,
3951 },
3952 {
3953 .name = "thread",
3954 .lname = "Thread",
3955 .type = FIO_OPT_STR_SET,
3956 .off1 = offsetof(struct thread_options, use_thread),
3957 .help = "Use threads instead of processes",
3958#ifdef CONFIG_NO_SHM
3959 .def = "1",
3960 .no_warn_def = 1,
3961#endif
3962 .category = FIO_OPT_C_GENERAL,
3963 .group = FIO_OPT_G_PROCESS,
3964 },
3965 {
3966 .name = "per_job_logs",
3967 .lname = "Per Job Logs",
3968 .type = FIO_OPT_BOOL,
3969 .off1 = offsetof(struct thread_options, per_job_logs),
3970 .help = "Include job number in generated log files or not",
3971 .def = "1",
3972 .category = FIO_OPT_C_LOG,
3973 .group = FIO_OPT_G_INVALID,
3974 },
3975 {
3976 .name = "write_bw_log",
3977 .lname = "Write bandwidth log",
3978 .type = FIO_OPT_STR,
3979 .off1 = offsetof(struct thread_options, bw_log_file),
3980 .cb = str_write_bw_log_cb,
3981 .help = "Write log of bandwidth during run",
3982 .category = FIO_OPT_C_LOG,
3983 .group = FIO_OPT_G_INVALID,
3984 },
3985 {
3986 .name = "write_lat_log",
3987 .lname = "Write latency log",
3988 .type = FIO_OPT_STR,
3989 .off1 = offsetof(struct thread_options, lat_log_file),
3990 .cb = str_write_lat_log_cb,
3991 .help = "Write log of latency during run",
3992 .category = FIO_OPT_C_LOG,
3993 .group = FIO_OPT_G_INVALID,
3994 },
3995 {
3996 .name = "write_iops_log",
3997 .lname = "Write IOPS log",
3998 .type = FIO_OPT_STR,
3999 .off1 = offsetof(struct thread_options, iops_log_file),
4000 .cb = str_write_iops_log_cb,
4001 .help = "Write log of IOPS during run",
4002 .category = FIO_OPT_C_LOG,
4003 .group = FIO_OPT_G_INVALID,
4004 },
4005 {
4006 .name = "log_avg_msec",
4007 .lname = "Log averaging (msec)",
4008 .type = FIO_OPT_INT,
4009 .off1 = offsetof(struct thread_options, log_avg_msec),
4010 .help = "Average bw/iops/lat logs over this period of time",
4011 .def = "0",
4012 .category = FIO_OPT_C_LOG,
4013 .group = FIO_OPT_G_INVALID,
4014 },
4015 {
4016 .name = "log_hist_msec",
4017 .lname = "Log histograms (msec)",
4018 .type = FIO_OPT_INT,
4019 .off1 = offsetof(struct thread_options, log_hist_msec),
4020 .help = "Dump completion latency histograms at frequency of this time value",
4021 .def = "0",
4022 .category = FIO_OPT_C_LOG,
4023 .group = FIO_OPT_G_INVALID,
4024 },
4025 {
4026 .name = "log_hist_coarseness",
4027 .lname = "Histogram logs coarseness",
4028 .type = FIO_OPT_INT,
4029 .off1 = offsetof(struct thread_options, log_hist_coarseness),
4030 .help = "Integer in range [0,6]. Higher coarseness outputs"
4031 " fewer histogram bins per sample. The number of bins for"
4032 " these are [1216, 608, 304, 152, 76, 38, 19] respectively.",
4033 .def = "0",
4034 .category = FIO_OPT_C_LOG,
4035 .group = FIO_OPT_G_INVALID,
4036 },
4037 {
4038 .name = "write_hist_log",
4039 .lname = "Write latency histogram logs",
4040 .type = FIO_OPT_STR,
4041 .off1 = offsetof(struct thread_options, hist_log_file),
4042 .cb = str_write_hist_log_cb,
4043 .help = "Write log of latency histograms during run",
4044 .category = FIO_OPT_C_LOG,
4045 .group = FIO_OPT_G_INVALID,
4046 },
4047 {
4048 .name = "log_max_value",
4049 .lname = "Log maximum instead of average",
4050 .type = FIO_OPT_BOOL,
4051 .off1 = offsetof(struct thread_options, log_max),
4052 .help = "Log max sample in a window instead of average",
4053 .def = "0",
4054 .category = FIO_OPT_C_LOG,
4055 .group = FIO_OPT_G_INVALID,
4056 },
4057 {
4058 .name = "log_offset",
4059 .lname = "Log offset of IO",
4060 .type = FIO_OPT_BOOL,
4061 .off1 = offsetof(struct thread_options, log_offset),
4062 .help = "Include offset of IO for each log entry",
4063 .def = "0",
4064 .category = FIO_OPT_C_LOG,
4065 .group = FIO_OPT_G_INVALID,
4066 },
4067#ifdef CONFIG_ZLIB
4068 {
4069 .name = "log_compression",
4070 .lname = "Log compression",
4071 .type = FIO_OPT_INT,
4072 .off1 = offsetof(struct thread_options, log_gz),
4073 .help = "Log in compressed chunks of this size",
4074 .minval = 1024ULL,
4075 .maxval = 512 * 1024 * 1024ULL,
4076 .category = FIO_OPT_C_LOG,
4077 .group = FIO_OPT_G_INVALID,
4078 },
4079#ifdef FIO_HAVE_CPU_AFFINITY
4080 {
4081 .name = "log_compression_cpus",
4082 .lname = "Log Compression CPUs",
4083 .type = FIO_OPT_STR,
4084 .cb = str_log_cpus_allowed_cb,
4085 .off1 = offsetof(struct thread_options, log_gz_cpumask),
4086 .parent = "log_compression",
4087 .help = "Limit log compression to these CPUs",
4088 .category = FIO_OPT_C_LOG,
4089 .group = FIO_OPT_G_INVALID,
4090 },
4091#else
4092 {
4093 .name = "log_compression_cpus",
4094 .lname = "Log Compression CPUs",
4095 .type = FIO_OPT_UNSUPPORTED,
4096 .help = "Your platform does not support CPU affinities",
4097 },
4098#endif
4099 {
4100 .name = "log_store_compressed",
4101 .lname = "Log store compressed",
4102 .type = FIO_OPT_BOOL,
4103 .off1 = offsetof(struct thread_options, log_gz_store),
4104 .help = "Store logs in a compressed format",
4105 .category = FIO_OPT_C_LOG,
4106 .group = FIO_OPT_G_INVALID,
4107 },
4108#else
4109 {
4110 .name = "log_compression",
4111 .lname = "Log compression",
4112 .type = FIO_OPT_UNSUPPORTED,
4113 .help = "Install libz-dev(el) to get compression support",
4114 },
4115 {
4116 .name = "log_store_compressed",
4117 .lname = "Log store compressed",
4118 .type = FIO_OPT_UNSUPPORTED,
4119 .help = "Install libz-dev(el) to get compression support",
4120 },
4121#endif
4122 {
4123 .name = "log_unix_epoch",
4124 .lname = "Log epoch unix",
4125 .type = FIO_OPT_BOOL,
4126 .off1 = offsetof(struct thread_options, log_unix_epoch),
4127 .help = "Use Unix time in log files",
4128 .category = FIO_OPT_C_LOG,
4129 .group = FIO_OPT_G_INVALID,
4130 },
4131 {
4132 .name = "block_error_percentiles",
4133 .lname = "Block error percentiles",
4134 .type = FIO_OPT_BOOL,
4135 .off1 = offsetof(struct thread_options, block_error_hist),
4136 .help = "Record trim block errors and make a histogram",
4137 .def = "0",
4138 .category = FIO_OPT_C_LOG,
4139 .group = FIO_OPT_G_INVALID,
4140 },
4141 {
4142 .name = "bwavgtime",
4143 .lname = "Bandwidth average time",
4144 .type = FIO_OPT_INT,
4145 .off1 = offsetof(struct thread_options, bw_avg_time),
4146 .help = "Time window over which to calculate bandwidth"
4147 " (msec)",
4148 .def = "500",
4149 .parent = "write_bw_log",
4150 .hide = 1,
4151 .interval = 100,
4152 .category = FIO_OPT_C_LOG,
4153 .group = FIO_OPT_G_INVALID,
4154 },
4155 {
4156 .name = "iopsavgtime",
4157 .lname = "IOPS average time",
4158 .type = FIO_OPT_INT,
4159 .off1 = offsetof(struct thread_options, iops_avg_time),
4160 .help = "Time window over which to calculate IOPS (msec)",
4161 .def = "500",
4162 .parent = "write_iops_log",
4163 .hide = 1,
4164 .interval = 100,
4165 .category = FIO_OPT_C_LOG,
4166 .group = FIO_OPT_G_INVALID,
4167 },
4168 {
4169 .name = "group_reporting",
4170 .lname = "Group reporting",
4171 .type = FIO_OPT_STR_SET,
4172 .off1 = offsetof(struct thread_options, group_reporting),
4173 .help = "Do reporting on a per-group basis",
4174 .category = FIO_OPT_C_STAT,
4175 .group = FIO_OPT_G_INVALID,
4176 },
4177 {
4178 .name = "stats",
4179 .lname = "Stats",
4180 .type = FIO_OPT_BOOL,
4181 .off1 = offsetof(struct thread_options, stats),
4182 .help = "Enable collection of stats",
4183 .def = "1",
4184 .category = FIO_OPT_C_STAT,
4185 .group = FIO_OPT_G_INVALID,
4186 },
4187 {
4188 .name = "zero_buffers",
4189 .lname = "Zero I/O buffers",
4190 .type = FIO_OPT_STR_SET,
4191 .off1 = offsetof(struct thread_options, zero_buffers),
4192 .help = "Init IO buffers to all zeroes",
4193 .category = FIO_OPT_C_IO,
4194 .group = FIO_OPT_G_IO_BUF,
4195 },
4196 {
4197 .name = "refill_buffers",
4198 .lname = "Refill I/O buffers",
4199 .type = FIO_OPT_STR_SET,
4200 .off1 = offsetof(struct thread_options, refill_buffers),
4201 .help = "Refill IO buffers on every IO submit",
4202 .category = FIO_OPT_C_IO,
4203 .group = FIO_OPT_G_IO_BUF,
4204 },
4205 {
4206 .name = "scramble_buffers",
4207 .lname = "Scramble I/O buffers",
4208 .type = FIO_OPT_BOOL,
4209 .off1 = offsetof(struct thread_options, scramble_buffers),
4210 .help = "Slightly scramble buffers on every IO submit",
4211 .def = "1",
4212 .category = FIO_OPT_C_IO,
4213 .group = FIO_OPT_G_IO_BUF,
4214 },
4215 {
4216 .name = "buffer_pattern",
4217 .lname = "Buffer pattern",
4218 .type = FIO_OPT_STR,
4219 .cb = str_buffer_pattern_cb,
4220 .off1 = offsetof(struct thread_options, buffer_pattern),
4221 .help = "Fill pattern for IO buffers",
4222 .category = FIO_OPT_C_IO,
4223 .group = FIO_OPT_G_IO_BUF,
4224 },
4225 {
4226 .name = "buffer_compress_percentage",
4227 .lname = "Buffer compression percentage",
4228 .type = FIO_OPT_INT,
4229 .cb = str_buffer_compress_cb,
4230 .off1 = offsetof(struct thread_options, compress_percentage),
4231 .maxval = 100,
4232 .minval = 0,
4233 .help = "How compressible the buffer is (approximately)",
4234 .interval = 5,
4235 .category = FIO_OPT_C_IO,
4236 .group = FIO_OPT_G_IO_BUF,
4237 },
4238 {
4239 .name = "buffer_compress_chunk",
4240 .lname = "Buffer compression chunk size",
4241 .type = FIO_OPT_INT,
4242 .off1 = offsetof(struct thread_options, compress_chunk),
4243 .parent = "buffer_compress_percentage",
4244 .hide = 1,
4245 .help = "Size of compressible region in buffer",
4246 .def = "512",
4247 .interval = 256,
4248 .category = FIO_OPT_C_IO,
4249 .group = FIO_OPT_G_IO_BUF,
4250 },
4251 {
4252 .name = "dedupe_percentage",
4253 .lname = "Dedupe percentage",
4254 .type = FIO_OPT_INT,
4255 .cb = str_dedupe_cb,
4256 .off1 = offsetof(struct thread_options, dedupe_percentage),
4257 .maxval = 100,
4258 .minval = 0,
4259 .help = "Percentage of buffers that are dedupable",
4260 .interval = 1,
4261 .category = FIO_OPT_C_IO,
4262 .group = FIO_OPT_G_IO_BUF,
4263 },
4264 {
4265 .name = "clat_percentiles",
4266 .lname = "Completion latency percentiles",
4267 .type = FIO_OPT_BOOL,
4268 .off1 = offsetof(struct thread_options, clat_percentiles),
4269 .help = "Enable the reporting of completion latency percentiles",
4270 .def = "1",
4271 .inverse = "lat_percentiles",
4272 .category = FIO_OPT_C_STAT,
4273 .group = FIO_OPT_G_INVALID,
4274 },
4275 {
4276 .name = "lat_percentiles",
4277 .lname = "IO latency percentiles",
4278 .type = FIO_OPT_BOOL,
4279 .off1 = offsetof(struct thread_options, lat_percentiles),
4280 .help = "Enable the reporting of IO latency percentiles",
4281 .def = "0",
4282 .inverse = "clat_percentiles",
4283 .category = FIO_OPT_C_STAT,
4284 .group = FIO_OPT_G_INVALID,
4285 },
4286 {
4287 .name = "percentile_list",
4288 .lname = "Percentile list",
4289 .type = FIO_OPT_FLOAT_LIST,
4290 .off1 = offsetof(struct thread_options, percentile_list),
4291 .off2 = offsetof(struct thread_options, percentile_precision),
4292 .help = "Specify a custom list of percentiles to report for "
4293 "completion latency and block errors",
4294 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
4295 .maxlen = FIO_IO_U_LIST_MAX_LEN,
4296 .minfp = 0.0,
4297 .maxfp = 100.0,
4298 .category = FIO_OPT_C_STAT,
4299 .group = FIO_OPT_G_INVALID,
4300 },
4301 {
4302 .name = "significant_figures",
4303 .lname = "Significant figures",
4304 .type = FIO_OPT_INT,
4305 .off1 = offsetof(struct thread_options, sig_figs),
4306 .maxval = 10,
4307 .minval = 1,
4308 .help = "Significant figures for output-format set to normal",
4309 .def = "4",
4310 .interval = 1,
4311 .category = FIO_OPT_C_STAT,
4312 .group = FIO_OPT_G_INVALID,
4313 },
4314
4315#ifdef FIO_HAVE_DISK_UTIL
4316 {
4317 .name = "disk_util",
4318 .lname = "Disk utilization",
4319 .type = FIO_OPT_BOOL,
4320 .off1 = offsetof(struct thread_options, do_disk_util),
4321 .help = "Log disk utilization statistics",
4322 .def = "1",
4323 .category = FIO_OPT_C_STAT,
4324 .group = FIO_OPT_G_INVALID,
4325 },
4326#else
4327 {
4328 .name = "disk_util",
4329 .lname = "Disk utilization",
4330 .type = FIO_OPT_UNSUPPORTED,
4331 .help = "Your platform does not support disk utilization",
4332 },
4333#endif
4334 {
4335 .name = "gtod_reduce",
4336 .lname = "Reduce gettimeofday() calls",
4337 .type = FIO_OPT_BOOL,
4338 .help = "Greatly reduce number of gettimeofday() calls",
4339 .cb = str_gtod_reduce_cb,
4340 .def = "0",
4341 .hide_on_set = 1,
4342 .category = FIO_OPT_C_STAT,
4343 .group = FIO_OPT_G_INVALID,
4344 },
4345 {
4346 .name = "disable_lat",
4347 .lname = "Disable all latency stats",
4348 .type = FIO_OPT_BOOL,
4349 .off1 = offsetof(struct thread_options, disable_lat),
4350 .help = "Disable latency numbers",
4351 .parent = "gtod_reduce",
4352 .hide = 1,
4353 .def = "0",
4354 .category = FIO_OPT_C_STAT,
4355 .group = FIO_OPT_G_INVALID,
4356 },
4357 {
4358 .name = "disable_clat",
4359 .lname = "Disable completion latency stats",
4360 .type = FIO_OPT_BOOL,
4361 .off1 = offsetof(struct thread_options, disable_clat),
4362 .help = "Disable completion latency numbers",
4363 .parent = "gtod_reduce",
4364 .hide = 1,
4365 .def = "0",
4366 .category = FIO_OPT_C_STAT,
4367 .group = FIO_OPT_G_INVALID,
4368 },
4369 {
4370 .name = "disable_slat",
4371 .lname = "Disable submission latency stats",
4372 .type = FIO_OPT_BOOL,
4373 .off1 = offsetof(struct thread_options, disable_slat),
4374 .help = "Disable submission latency numbers",
4375 .parent = "gtod_reduce",
4376 .hide = 1,
4377 .def = "0",
4378 .category = FIO_OPT_C_STAT,
4379 .group = FIO_OPT_G_INVALID,
4380 },
4381 {
4382 .name = "disable_bw_measurement",
4383 .alias = "disable_bw",
4384 .lname = "Disable bandwidth stats",
4385 .type = FIO_OPT_BOOL,
4386 .off1 = offsetof(struct thread_options, disable_bw),
4387 .help = "Disable bandwidth logging",
4388 .parent = "gtod_reduce",
4389 .hide = 1,
4390 .def = "0",
4391 .category = FIO_OPT_C_STAT,
4392 .group = FIO_OPT_G_INVALID,
4393 },
4394 {
4395 .name = "gtod_cpu",
4396 .lname = "Dedicated gettimeofday() CPU",
4397 .type = FIO_OPT_INT,
4398 .off1 = offsetof(struct thread_options, gtod_cpu),
4399 .help = "Set up dedicated gettimeofday() thread on this CPU",
4400 .verify = gtod_cpu_verify,
4401 .category = FIO_OPT_C_GENERAL,
4402 .group = FIO_OPT_G_CLOCK,
4403 },
4404 {
4405 .name = "unified_rw_reporting",
4406 .lname = "Unified RW Reporting",
4407 .type = FIO_OPT_BOOL,
4408 .off1 = offsetof(struct thread_options, unified_rw_rep),
4409 .help = "Unify reporting across data direction",
4410 .def = "0",
4411 .category = FIO_OPT_C_GENERAL,
4412 .group = FIO_OPT_G_INVALID,
4413 },
4414 {
4415 .name = "continue_on_error",
4416 .lname = "Continue on error",
4417 .type = FIO_OPT_STR,
4418 .off1 = offsetof(struct thread_options, continue_on_error),
4419 .help = "Continue on non-fatal errors during IO",
4420 .def = "none",
4421 .category = FIO_OPT_C_GENERAL,
4422 .group = FIO_OPT_G_ERR,
4423 .posval = {
4424 { .ival = "none",
4425 .oval = ERROR_TYPE_NONE,
4426 .help = "Exit when an error is encountered",
4427 },
4428 { .ival = "read",
4429 .oval = ERROR_TYPE_READ,
4430 .help = "Continue on read errors only",
4431 },
4432 { .ival = "write",
4433 .oval = ERROR_TYPE_WRITE,
4434 .help = "Continue on write errors only",
4435 },
4436 { .ival = "io",
4437 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
4438 .help = "Continue on any IO errors",
4439 },
4440 { .ival = "verify",
4441 .oval = ERROR_TYPE_VERIFY,
4442 .help = "Continue on verify errors only",
4443 },
4444 { .ival = "all",
4445 .oval = ERROR_TYPE_ANY,
4446 .help = "Continue on all io and verify errors",
4447 },
4448 { .ival = "0",
4449 .oval = ERROR_TYPE_NONE,
4450 .help = "Alias for 'none'",
4451 },
4452 { .ival = "1",
4453 .oval = ERROR_TYPE_ANY,
4454 .help = "Alias for 'all'",
4455 },
4456 },
4457 },
4458 {
4459 .name = "ignore_error",
4460 .lname = "Ignore Error",
4461 .type = FIO_OPT_STR,
4462 .cb = str_ignore_error_cb,
4463 .off1 = offsetof(struct thread_options, ignore_error_nr),
4464 .help = "Set a specific list of errors to ignore",
4465 .parent = "rw",
4466 .category = FIO_OPT_C_GENERAL,
4467 .group = FIO_OPT_G_ERR,
4468 },
4469 {
4470 .name = "error_dump",
4471 .lname = "Error Dump",
4472 .type = FIO_OPT_BOOL,
4473 .off1 = offsetof(struct thread_options, error_dump),
4474 .def = "0",
4475 .help = "Dump info on each error",
4476 .category = FIO_OPT_C_GENERAL,
4477 .group = FIO_OPT_G_ERR,
4478 },
4479 {
4480 .name = "profile",
4481 .lname = "Profile",
4482 .type = FIO_OPT_STR_STORE,
4483 .off1 = offsetof(struct thread_options, profile),
4484 .help = "Select a specific builtin performance test",
4485 .category = FIO_OPT_C_PROFILE,
4486 .group = FIO_OPT_G_INVALID,
4487 },
4488 {
4489 .name = "cgroup",
4490 .lname = "Cgroup",
4491 .type = FIO_OPT_STR_STORE,
4492 .off1 = offsetof(struct thread_options, cgroup),
4493 .help = "Add job to cgroup of this name",
4494 .category = FIO_OPT_C_GENERAL,
4495 .group = FIO_OPT_G_CGROUP,
4496 },
4497 {
4498 .name = "cgroup_nodelete",
4499 .lname = "Cgroup no-delete",
4500 .type = FIO_OPT_BOOL,
4501 .off1 = offsetof(struct thread_options, cgroup_nodelete),
4502 .help = "Do not delete cgroups after job completion",
4503 .def = "0",
4504 .parent = "cgroup",
4505 .category = FIO_OPT_C_GENERAL,
4506 .group = FIO_OPT_G_CGROUP,
4507 },
4508 {
4509 .name = "cgroup_weight",
4510 .lname = "Cgroup weight",
4511 .type = FIO_OPT_INT,
4512 .off1 = offsetof(struct thread_options, cgroup_weight),
4513 .help = "Use given weight for cgroup",
4514 .minval = 100,
4515 .maxval = 1000,
4516 .parent = "cgroup",
4517 .category = FIO_OPT_C_GENERAL,
4518 .group = FIO_OPT_G_CGROUP,
4519 },
4520 {
4521 .name = "uid",
4522 .lname = "User ID",
4523 .type = FIO_OPT_INT,
4524 .off1 = offsetof(struct thread_options, uid),
4525 .help = "Run job with this user ID",
4526 .category = FIO_OPT_C_GENERAL,
4527 .group = FIO_OPT_G_CRED,
4528 },
4529 {
4530 .name = "gid",
4531 .lname = "Group ID",
4532 .type = FIO_OPT_INT,
4533 .off1 = offsetof(struct thread_options, gid),
4534 .help = "Run job with this group ID",
4535 .category = FIO_OPT_C_GENERAL,
4536 .group = FIO_OPT_G_CRED,
4537 },
4538 {
4539 .name = "kb_base",
4540 .lname = "KB Base",
4541 .type = FIO_OPT_INT,
4542 .off1 = offsetof(struct thread_options, kb_base),
4543 .prio = 1,
4544 .def = "1024",
4545 .posval = {
4546 { .ival = "1024",
4547 .oval = 1024,
4548 .help = "Inputs invert IEC and SI prefixes (for compatibility); outputs prefer binary",
4549 },
4550 { .ival = "1000",
4551 .oval = 1000,
4552 .help = "Inputs use IEC and SI prefixes; outputs prefer SI",
4553 },
4554 },
4555 .help = "Unit prefix interpretation for quantities of data (IEC and SI)",
4556 .category = FIO_OPT_C_GENERAL,
4557 .group = FIO_OPT_G_INVALID,
4558 },
4559 {
4560 .name = "unit_base",
4561 .lname = "Unit for quantities of data (Bits or Bytes)",
4562 .type = FIO_OPT_INT,
4563 .off1 = offsetof(struct thread_options, unit_base),
4564 .prio = 1,
4565 .posval = {
4566 { .ival = "0",
4567 .oval = N2S_NONE,
4568 .help = "Auto-detect",
4569 },
4570 { .ival = "8",
4571 .oval = N2S_BYTEPERSEC,
4572 .help = "Normal (byte based)",
4573 },
4574 { .ival = "1",
4575 .oval = N2S_BITPERSEC,
4576 .help = "Bit based",
4577 },
4578 },
4579 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
4580 .category = FIO_OPT_C_GENERAL,
4581 .group = FIO_OPT_G_INVALID,
4582 },
4583 {
4584 .name = "hugepage-size",
4585 .lname = "Hugepage size",
4586 .type = FIO_OPT_INT,
4587 .off1 = offsetof(struct thread_options, hugepage_size),
4588 .help = "When using hugepages, specify size of each page",
4589 .def = __fio_stringify(FIO_HUGE_PAGE),
4590 .interval = 1024 * 1024,
4591 .category = FIO_OPT_C_GENERAL,
4592 .group = FIO_OPT_G_INVALID,
4593 },
4594 {
4595 .name = "flow_id",
4596 .lname = "I/O flow ID",
4597 .type = FIO_OPT_INT,
4598 .off1 = offsetof(struct thread_options, flow_id),
4599 .help = "The flow index ID to use",
4600 .def = "0",
4601 .category = FIO_OPT_C_IO,
4602 .group = FIO_OPT_G_IO_FLOW,
4603 },
4604 {
4605 .name = "flow",
4606 .lname = "I/O flow weight",
4607 .type = FIO_OPT_INT,
4608 .off1 = offsetof(struct thread_options, flow),
4609 .help = "Weight for flow control of this job",
4610 .parent = "flow_id",
4611 .hide = 1,
4612 .def = "0",
4613 .category = FIO_OPT_C_IO,
4614 .group = FIO_OPT_G_IO_FLOW,
4615 },
4616 {
4617 .name = "flow_watermark",
4618 .lname = "I/O flow watermark",
4619 .type = FIO_OPT_INT,
4620 .off1 = offsetof(struct thread_options, flow_watermark),
4621 .help = "High watermark for flow control. This option"
4622 " should be set to the same value for all threads"
4623 " with non-zero flow.",
4624 .parent = "flow_id",
4625 .hide = 1,
4626 .def = "1024",
4627 .category = FIO_OPT_C_IO,
4628 .group = FIO_OPT_G_IO_FLOW,
4629 },
4630 {
4631 .name = "flow_sleep",
4632 .lname = "I/O flow sleep",
4633 .type = FIO_OPT_INT,
4634 .off1 = offsetof(struct thread_options, flow_sleep),
4635 .help = "How many microseconds to sleep after being held"
4636 " back by the flow control mechanism",
4637 .parent = "flow_id",
4638 .hide = 1,
4639 .def = "0",
4640 .category = FIO_OPT_C_IO,
4641 .group = FIO_OPT_G_IO_FLOW,
4642 },
4643 {
4644 .name = "steadystate",
4645 .lname = "Steady state threshold",
4646 .alias = "ss",
4647 .type = FIO_OPT_STR,
4648 .off1 = offsetof(struct thread_options, ss_state),
4649 .cb = str_steadystate_cb,
4650 .help = "Define the criterion and limit to judge when a job has reached steady state",
4651 .def = "iops_slope:0.01%",
4652 .posval = {
4653 { .ival = "iops",
4654 .oval = FIO_SS_IOPS,
4655 .help = "maximum mean deviation of IOPS measurements",
4656 },
4657 { .ival = "iops_slope",
4658 .oval = FIO_SS_IOPS_SLOPE,
4659 .help = "slope calculated from IOPS measurements",
4660 },
4661 { .ival = "bw",
4662 .oval = FIO_SS_BW,
4663 .help = "maximum mean deviation of bandwidth measurements",
4664 },
4665 {
4666 .ival = "bw_slope",
4667 .oval = FIO_SS_BW_SLOPE,
4668 .help = "slope calculated from bandwidth measurements",
4669 },
4670 },
4671 .category = FIO_OPT_C_GENERAL,
4672 .group = FIO_OPT_G_RUNTIME,
4673 },
4674 {
4675 .name = "steadystate_duration",
4676 .lname = "Steady state duration",
4677 .alias = "ss_dur",
4678 .parent = "steadystate",
4679 .type = FIO_OPT_STR_VAL_TIME,
4680 .off1 = offsetof(struct thread_options, ss_dur),
4681 .help = "Stop workload upon attaining steady state for specified duration",
4682 .def = "0",
4683 .is_seconds = 1,
4684 .is_time = 1,
4685 .category = FIO_OPT_C_GENERAL,
4686 .group = FIO_OPT_G_RUNTIME,
4687 },
4688 {
4689 .name = "steadystate_ramp_time",
4690 .lname = "Steady state ramp time",
4691 .alias = "ss_ramp",
4692 .parent = "steadystate",
4693 .type = FIO_OPT_STR_VAL_TIME,
4694 .off1 = offsetof(struct thread_options, ss_ramp_time),
4695 .help = "Delay before initiation of data collection for steady state job termination testing",
4696 .def = "0",
4697 .is_seconds = 1,
4698 .is_time = 1,
4699 .category = FIO_OPT_C_GENERAL,
4700 .group = FIO_OPT_G_RUNTIME,
4701 },
4702 {
4703 .name = NULL,
4704 },
4705};
4706
4707static void add_to_lopt(struct option *lopt, struct fio_option *o,
4708 const char *name, int val)
4709{
4710 lopt->name = (char *) name;
4711 lopt->val = val;
4712 if (o->type == FIO_OPT_STR_SET)
4713 lopt->has_arg = optional_argument;
4714 else
4715 lopt->has_arg = required_argument;
4716}
4717
4718static void options_to_lopts(struct fio_option *opts,
4719 struct option *long_options,
4720 int i, int option_type)
4721{
4722 struct fio_option *o = &opts[0];
4723 while (o->name) {
4724 add_to_lopt(&long_options[i], o, o->name, option_type);
4725 if (o->alias) {
4726 i++;
4727 add_to_lopt(&long_options[i], o, o->alias, option_type);
4728 }
4729
4730 i++;
4731 o++;
4732 assert(i < FIO_NR_OPTIONS);
4733 }
4734}
4735
4736void fio_options_set_ioengine_opts(struct option *long_options,
4737 struct thread_data *td)
4738{
4739 unsigned int i;
4740
4741 i = 0;
4742 while (long_options[i].name) {
4743 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
4744 memset(&long_options[i], 0, sizeof(*long_options));
4745 break;
4746 }
4747 i++;
4748 }
4749
4750 /*
4751 * Just clear out the prior ioengine options.
4752 */
4753 if (!td || !td->eo)
4754 return;
4755
4756 options_to_lopts(td->io_ops->options, long_options, i,
4757 FIO_GETOPT_IOENGINE);
4758}
4759
4760void fio_options_dup_and_init(struct option *long_options)
4761{
4762 unsigned int i;
4763
4764 options_init(fio_options);
4765
4766 i = 0;
4767 while (long_options[i].name)
4768 i++;
4769
4770 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
4771}
4772
4773struct fio_keyword {
4774 const char *word;
4775 const char *desc;
4776 char *replace;
4777};
4778
4779static struct fio_keyword fio_keywords[] = {
4780 {
4781 .word = "$pagesize",
4782 .desc = "Page size in the system",
4783 },
4784 {
4785 .word = "$mb_memory",
4786 .desc = "Megabytes of memory online",
4787 },
4788 {
4789 .word = "$ncpus",
4790 .desc = "Number of CPUs online in the system",
4791 },
4792 {
4793 .word = NULL,
4794 },
4795};
4796
4797void fio_keywords_exit(void)
4798{
4799 struct fio_keyword *kw;
4800
4801 kw = &fio_keywords[0];
4802 while (kw->word) {
4803 free(kw->replace);
4804 kw->replace = NULL;
4805 kw++;
4806 }
4807}
4808
4809void fio_keywords_init(void)
4810{
4811 unsigned long long mb_memory;
4812 char buf[128];
4813 long l;
4814
4815 sprintf(buf, "%lu", (unsigned long) page_size);
4816 fio_keywords[0].replace = strdup(buf);
4817
4818 mb_memory = os_phys_mem() / (1024 * 1024);
4819 sprintf(buf, "%llu", mb_memory);
4820 fio_keywords[1].replace = strdup(buf);
4821
4822 l = cpus_online();
4823 sprintf(buf, "%lu", l);
4824 fio_keywords[2].replace = strdup(buf);
4825}
4826
4827#define BC_APP "bc"
4828
4829static char *bc_calc(char *str)
4830{
4831 char buf[128], *tmp;
4832 FILE *f;
4833 int ret;
4834
4835 /*
4836 * No math, just return string
4837 */
4838 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
4839 !strchr(str, '/')) || strchr(str, '\''))
4840 return str;
4841
4842 /*
4843 * Split option from value, we only need to calculate the value
4844 */
4845 tmp = strchr(str, '=');
4846 if (!tmp)
4847 return str;
4848
4849 tmp++;
4850
4851 /*
4852 * Prevent buffer overflows; such a case isn't reasonable anyway
4853 */
4854 if (strlen(str) >= 128 || strlen(tmp) > 100)
4855 return str;
4856
4857 sprintf(buf, "which %s > /dev/null", BC_APP);
4858 if (system(buf)) {
4859 log_err("fio: bc is needed for performing math\n");
4860 return NULL;
4861 }
4862
4863 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
4864 f = popen(buf, "r");
4865 if (!f)
4866 return NULL;
4867
4868 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
4869 if (ret <= 0) {
4870 pclose(f);
4871 return NULL;
4872 }
4873
4874 pclose(f);
4875 buf[(tmp - str) + ret - 1] = '\0';
4876 memcpy(buf, str, tmp - str);
4877 free(str);
4878 return strdup(buf);
4879}
4880
4881/*
4882 * Return a copy of the input string with substrings of the form ${VARNAME}
4883 * substituted with the value of the environment variable VARNAME. The
4884 * substitution always occurs, even if VARNAME is empty or the corresponding
4885 * environment variable undefined.
4886 */
4887char *fio_option_dup_subs(const char *opt)
4888{
4889 char out[OPT_LEN_MAX+1];
4890 char in[OPT_LEN_MAX+1];
4891 char *outptr = out;
4892 char *inptr = in;
4893 char *ch1, *ch2, *env;
4894 ssize_t nchr = OPT_LEN_MAX;
4895 size_t envlen;
4896
4897 if (strlen(opt) + 1 > OPT_LEN_MAX) {
4898 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
4899 return NULL;
4900 }
4901
4902 in[OPT_LEN_MAX] = '\0';
4903 strncpy(in, opt, OPT_LEN_MAX);
4904
4905 while (*inptr && nchr > 0) {
4906 if (inptr[0] == '$' && inptr[1] == '{') {
4907 ch2 = strchr(inptr, '}');
4908 if (ch2 && inptr+1 < ch2) {
4909 ch1 = inptr+2;
4910 inptr = ch2+1;
4911 *ch2 = '\0';
4912
4913 env = getenv(ch1);
4914 if (env) {
4915 envlen = strlen(env);
4916 if (envlen <= nchr) {
4917 memcpy(outptr, env, envlen);
4918 outptr += envlen;
4919 nchr -= envlen;
4920 }
4921 }
4922
4923 continue;
4924 }
4925 }
4926
4927 *outptr++ = *inptr++;
4928 --nchr;
4929 }
4930
4931 *outptr = '\0';
4932 return strdup(out);
4933}
4934
4935/*
4936 * Look for reserved variable names and replace them with real values
4937 */
4938static char *fio_keyword_replace(char *opt)
4939{
4940 char *s;
4941 int i;
4942 int docalc = 0;
4943
4944 for (i = 0; fio_keywords[i].word != NULL; i++) {
4945 struct fio_keyword *kw = &fio_keywords[i];
4946
4947 while ((s = strstr(opt, kw->word)) != NULL) {
4948 char *new = malloc(strlen(opt) + 1);
4949 char *o_org = opt;
4950 int olen = s - opt;
4951 int len;
4952
4953 /*
4954 * Copy part of the string before the keyword and
4955 * sprintf() the replacement after it.
4956 */
4957 memcpy(new, opt, olen);
4958 len = sprintf(new + olen, "%s", kw->replace);
4959
4960 /*
4961 * If there's more in the original string, copy that
4962 * in too
4963 */
4964 opt += strlen(kw->word) + olen;
4965 if (strlen(opt))
4966 memcpy(new + olen + len, opt, opt - o_org - 1);
4967
4968 /*
4969 * replace opt and free the old opt
4970 */
4971 opt = new;
4972 free(o_org);
4973
4974 docalc = 1;
4975 }
4976 }
4977
4978 /*
4979 * Check for potential math and invoke bc, if possible
4980 */
4981 if (docalc)
4982 opt = bc_calc(opt);
4983
4984 return opt;
4985}
4986
4987static char **dup_and_sub_options(char **opts, int num_opts)
4988{
4989 int i;
4990 char **opts_copy = malloc(num_opts * sizeof(*opts));
4991 for (i = 0; i < num_opts; i++) {
4992 opts_copy[i] = fio_option_dup_subs(opts[i]);
4993 if (!opts_copy[i])
4994 continue;
4995 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
4996 }
4997 return opts_copy;
4998}
4999
5000static void show_closest_option(const char *opt)
5001{
5002 int best_option, best_distance;
5003 int i, distance;
5004 char *name;
5005
5006 if (!strlen(opt))
5007 return;
5008
5009 name = strdup(opt);
5010 i = 0;
5011 while (name[i] != '\0' && name[i] != '=')
5012 i++;
5013 name[i] = '\0';
5014
5015 best_option = -1;
5016 best_distance = INT_MAX;
5017 i = 0;
5018 while (fio_options[i].name) {
5019 distance = string_distance(name, fio_options[i].name);
5020 if (distance < best_distance) {
5021 best_distance = distance;
5022 best_option = i;
5023 }
5024 i++;
5025 }
5026
5027 if (best_option != -1 && string_distance_ok(name, best_distance) &&
5028 fio_options[best_option].type != FIO_OPT_UNSUPPORTED)
5029 log_err("Did you mean %s?\n", fio_options[best_option].name);
5030
5031 free(name);
5032}
5033
5034int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
5035{
5036 int i, ret, unknown;
5037 char **opts_copy;
5038
5039 sort_options(opts, fio_options, num_opts);
5040 opts_copy = dup_and_sub_options(opts, num_opts);
5041
5042 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
5043 const struct fio_option *o;
5044 int newret = parse_option(opts_copy[i], opts[i], fio_options,
5045 &o, &td->o, &td->opt_list);
5046
5047 if (!newret && o)
5048 fio_option_mark_set(&td->o, o);
5049
5050 if (opts_copy[i]) {
5051 if (newret && !o) {
5052 unknown++;
5053 continue;
5054 }
5055 free(opts_copy[i]);
5056 opts_copy[i] = NULL;
5057 }
5058
5059 ret |= newret;
5060 }
5061
5062 if (unknown) {
5063 ret |= ioengine_load(td);
5064 if (td->eo) {
5065 sort_options(opts_copy, td->io_ops->options, num_opts);
5066 opts = opts_copy;
5067 }
5068 for (i = 0; i < num_opts; i++) {
5069 const struct fio_option *o = NULL;
5070 int newret = 1;
5071
5072 if (!opts_copy[i])
5073 continue;
5074
5075 if (td->eo)
5076 newret = parse_option(opts_copy[i], opts[i],
5077 td->io_ops->options, &o,
5078 td->eo, &td->opt_list);
5079
5080 ret |= newret;
5081 if (!o) {
5082 log_err("Bad option <%s>\n", opts[i]);
5083 show_closest_option(opts[i]);
5084 }
5085 free(opts_copy[i]);
5086 opts_copy[i] = NULL;
5087 }
5088 }
5089
5090 free(opts_copy);
5091 return ret;
5092}
5093
5094int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
5095{
5096 int ret;
5097
5098 ret = parse_cmd_option(opt, val, fio_options, &td->o, &td->opt_list);
5099 if (!ret) {
5100 const struct fio_option *o;
5101
5102 o = find_option_c(fio_options, opt);
5103 if (o)
5104 fio_option_mark_set(&td->o, o);
5105 }
5106
5107 return ret;
5108}
5109
5110int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
5111 char *val)
5112{
5113 return parse_cmd_option(opt, val, td->io_ops->options, td->eo,
5114 &td->opt_list);
5115}
5116
5117void fio_fill_default_options(struct thread_data *td)
5118{
5119 td->o.magic = OPT_MAGIC;
5120 fill_default_options(&td->o, fio_options);
5121}
5122
5123int fio_show_option_help(const char *opt)
5124{
5125 return show_cmd_help(fio_options, opt);
5126}
5127
5128/*
5129 * dupe FIO_OPT_STR_STORE options
5130 */
5131void fio_options_mem_dupe(struct thread_data *td)
5132{
5133 options_mem_dupe(fio_options, &td->o);
5134
5135 if (td->eo && td->io_ops) {
5136 void *oldeo = td->eo;
5137
5138 td->eo = malloc(td->io_ops->option_struct_size);
5139 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
5140 options_mem_dupe(td->io_ops->options, td->eo);
5141 }
5142}
5143
5144unsigned int fio_get_kb_base(void *data)
5145{
5146 struct thread_data *td = cb_data_to_td(data);
5147 struct thread_options *o = &td->o;
5148 unsigned int kb_base = 0;
5149
5150 /*
5151 * This is a hack... For private options, *data is not holding
5152 * a pointer to the thread_options, but to private data. This means
5153 * we can't safely dereference it, but magic is first so mem wise
5154 * it is valid. But this also means that if the job first sets
5155 * kb_base and expects that to be honored by private options,
5156 * it will be disappointed. We will return the global default
5157 * for this.
5158 */
5159 if (o && o->magic == OPT_MAGIC)
5160 kb_base = o->kb_base;
5161 if (!kb_base)
5162 kb_base = 1024;
5163
5164 return kb_base;
5165}
5166
5167int add_option(const struct fio_option *o)
5168{
5169 struct fio_option *__o;
5170 int opt_index = 0;
5171
5172 __o = fio_options;
5173 while (__o->name) {
5174 opt_index++;
5175 __o++;
5176 }
5177
5178 if (opt_index + 1 == FIO_MAX_OPTS) {
5179 log_err("fio: FIO_MAX_OPTS is too small\n");
5180 return 1;
5181 }
5182
5183 memcpy(&fio_options[opt_index], o, sizeof(*o));
5184 fio_options[opt_index + 1].name = NULL;
5185 return 0;
5186}
5187
5188void invalidate_profile_options(const char *prof_name)
5189{
5190 struct fio_option *o;
5191
5192 o = fio_options;
5193 while (o->name) {
5194 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
5195 o->type = FIO_OPT_INVALID;
5196 o->prof_name = NULL;
5197 }
5198 o++;
5199 }
5200}
5201
5202void add_opt_posval(const char *optname, const char *ival, const char *help)
5203{
5204 struct fio_option *o;
5205 unsigned int i;
5206
5207 o = find_option(fio_options, optname);
5208 if (!o)
5209 return;
5210
5211 for (i = 0; i < PARSE_MAX_VP; i++) {
5212 if (o->posval[i].ival)
5213 continue;
5214
5215 o->posval[i].ival = ival;
5216 o->posval[i].help = help;
5217 break;
5218 }
5219}
5220
5221void del_opt_posval(const char *optname, const char *ival)
5222{
5223 struct fio_option *o;
5224 unsigned int i;
5225
5226 o = find_option(fio_options, optname);
5227 if (!o)
5228 return;
5229
5230 for (i = 0; i < PARSE_MAX_VP; i++) {
5231 if (!o->posval[i].ival)
5232 continue;
5233 if (strcmp(o->posval[i].ival, ival))
5234 continue;
5235
5236 o->posval[i].ival = NULL;
5237 o->posval[i].help = NULL;
5238 }
5239}
5240
5241void fio_options_free(struct thread_data *td)
5242{
5243 options_free(fio_options, &td->o);
5244 if (td->eo && td->io_ops && td->io_ops->options) {
5245 options_free(td->io_ops->options, td->eo);
5246 free(td->eo);
5247 td->eo = NULL;
5248 }
5249}
5250
5251struct fio_option *fio_option_find(const char *name)
5252{
5253 return find_option(fio_options, name);
5254}
5255
5256static struct fio_option *find_next_opt(struct fio_option *from,
5257 unsigned int off1)
5258{
5259 struct fio_option *opt;
5260
5261 if (!from)
5262 from = &fio_options[0];
5263 else
5264 from++;
5265
5266 opt = NULL;
5267 do {
5268 if (off1 == from->off1) {
5269 opt = from;
5270 break;
5271 }
5272 from++;
5273 } while (from->name);
5274
5275 return opt;
5276}
5277
5278static int opt_is_set(struct thread_options *o, struct fio_option *opt)
5279{
5280 unsigned int opt_off, index, offset;
5281
5282 opt_off = opt - &fio_options[0];
5283 index = opt_off / (8 * sizeof(uint64_t));
5284 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5285 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
5286}
5287
5288bool __fio_option_is_set(struct thread_options *o, unsigned int off1)
5289{
5290 struct fio_option *opt, *next;
5291
5292 next = NULL;
5293 while ((opt = find_next_opt(next, off1)) != NULL) {
5294 if (opt_is_set(o, opt))
5295 return true;
5296
5297 next = opt;
5298 }
5299
5300 return false;
5301}
5302
5303void fio_option_mark_set(struct thread_options *o, const struct fio_option *opt)
5304{
5305 unsigned int opt_off, index, offset;
5306
5307 opt_off = opt - &fio_options[0];
5308 index = opt_off / (8 * sizeof(uint64_t));
5309 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5310 o->set_options[index] |= (uint64_t)1 << offset;
5311}
fio - Flexible IO Tester