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