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