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