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