projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
fusion-aw: fixes
[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
12#include "fio.h"
13#include "verify.h"
14#include "parse.h"
15#include "lib/fls.h"
16#include "options.h"
17
18#include "crc/crc32c.h"
19
20/*
21 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
22 */
23static char *get_opt_postfix(const char *str)
24{
25 char *p = strstr(str, ":");
26
27 if (!p)
28 return NULL;
29
30 p++;
31 strip_blank_front(&p);
32 strip_blank_end(p);
33 return strdup(p);
34}
35
36static int converthexchartoint(char a)
37{
38 int base;
39
40 switch(a) {
41 case '0'...'9':
42 base = '0';
43 break;
44 case 'A'...'F':
45 base = 'A' - 10;
46 break;
47 case 'a'...'f':
48 base = 'a' - 10;
49 break;
50 default:
51 base = 0;
52 }
53 return (a - base);
54}
55
56static int bs_cmp(const void *p1, const void *p2)
57{
58 const struct bssplit *bsp1 = p1;
59 const struct bssplit *bsp2 = p2;
60
61 return bsp1->perc < bsp2->perc;
62}
63
64static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
65{
66 struct bssplit *bssplit;
67 unsigned int i, perc, perc_missing;
68 unsigned int max_bs, min_bs;
69 long long val;
70 char *fname;
71
72 td->o.bssplit_nr[ddir] = 4;
73 bssplit = malloc(4 * sizeof(struct bssplit));
74
75 i = 0;
76 max_bs = 0;
77 min_bs = -1;
78 while ((fname = strsep(&str, ":")) != NULL) {
79 char *perc_str;
80
81 if (!strlen(fname))
82 break;
83
84 /*
85 * grow struct buffer, if needed
86 */
87 if (i == td->o.bssplit_nr[ddir]) {
88 td->o.bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
90 * sizeof(struct bssplit));
91 }
92
93 perc_str = strstr(fname, "/");
94 if (perc_str) {
95 *perc_str = '\0';
96 perc_str++;
97 perc = atoi(perc_str);
98 if (perc > 100)
99 perc = 100;
100 else if (!perc)
101 perc = -1;
102 } else
103 perc = -1;
104
105 if (str_to_decimal(fname, &val, 1, td)) {
106 log_err("fio: bssplit conversion failed\n");
107 free(td->o.bssplit);
108 return 1;
109 }
110
111 if (val > max_bs)
112 max_bs = val;
113 if (val < min_bs)
114 min_bs = val;
115
116 bssplit[i].bs = val;
117 bssplit[i].perc = perc;
118 i++;
119 }
120
121 td->o.bssplit_nr[ddir] = i;
122
123 /*
124 * Now check if the percentages add up, and how much is missing
125 */
126 perc = perc_missing = 0;
127 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
128 struct bssplit *bsp = &bssplit[i];
129
130 if (bsp->perc == (unsigned char) -1)
131 perc_missing++;
132 else
133 perc += bsp->perc;
134 }
135
136 if (perc > 100) {
137 log_err("fio: bssplit percentages add to more than 100%%\n");
138 free(bssplit);
139 return 1;
140 }
141 /*
142 * If values didn't have a percentage set, divide the remains between
143 * them.
144 */
145 if (perc_missing) {
146 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
147 struct bssplit *bsp = &bssplit[i];
148
149 if (bsp->perc == (unsigned char) -1)
150 bsp->perc = (100 - perc) / perc_missing;
151 }
152 }
153
154 td->o.min_bs[ddir] = min_bs;
155 td->o.max_bs[ddir] = max_bs;
156
157 /*
158 * now sort based on percentages, for ease of lookup
159 */
160 qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 td->o.bssplit[ddir] = bssplit;
162 return 0;
163
164}
165
166static int str_bssplit_cb(void *data, const char *input)
167{
168 struct thread_data *td = data;
169 char *str, *p, *odir, *ddir;
170 int ret = 0;
171
172 p = str = strdup(input);
173
174 strip_blank_front(&str);
175 strip_blank_end(str);
176
177 odir = strchr(str, ',');
178 if (odir) {
179 ddir = strchr(odir + 1, ',');
180 if (ddir) {
181 ret = bssplit_ddir(td, DDIR_TRIM, ddir + 1);
182 if (!ret)
183 *ddir = '\0';
184 } else {
185 char *op;
186
187 op = strdup(odir + 1);
188 ret = bssplit_ddir(td, DDIR_TRIM, op);
189
190 free(op);
191 }
192 if (!ret)
193 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
194 if (!ret) {
195 *odir = '\0';
196 ret = bssplit_ddir(td, DDIR_READ, str);
197 }
198 } else {
199 char *op;
200
201 op = strdup(str);
202 ret = bssplit_ddir(td, DDIR_WRITE, op);
203 free(op);
204
205 if (!ret) {
206 op = strdup(str);
207 ret = bssplit_ddir(td, DDIR_TRIM, op);
208 free(op);
209 }
210 ret = bssplit_ddir(td, DDIR_READ, str);
211 }
212
213 free(p);
214 return ret;
215}
216
217static int str2error(char *str)
218{
219 const char * err[] = {"EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
220 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
221 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
222 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
223 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
224 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
225 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
226 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE"};
227 int i = 0, num = sizeof(err) / sizeof(void *);
228
229 while( i < num) {
230 if (!strcmp(err[i], str))
231 return i + 1;
232 i++;
233 }
234 return 0;
235}
236
237static int ignore_error_type(struct thread_data *td, int etype, char *str)
238{
239 unsigned int i;
240 int *error;
241 char *fname;
242
243 if (etype >= ERROR_TYPE_CNT) {
244 log_err("Illegal error type\n");
245 return 1;
246 }
247
248 td->o.ignore_error_nr[etype] = 4;
249 error = malloc(4 * sizeof(struct bssplit));
250
251 i = 0;
252 while ((fname = strsep(&str, ":")) != NULL) {
253
254 if (!strlen(fname))
255 break;
256
257 /*
258 * grow struct buffer, if needed
259 */
260 if (i == td->o.ignore_error_nr[etype]) {
261 td->o.ignore_error_nr[etype] <<= 1;
262 error = realloc(error, td->o.ignore_error_nr[etype]
263 * sizeof(int));
264 }
265 if (fname[0] == 'E') {
266 error[i] = str2error(fname);
267 } else {
268 error[i] = atoi(fname);
269 if (error[i] < 0)
270 error[i] = error[i];
271 }
272 if (!error[i]) {
273 log_err("Unknown error %s, please use number value \n",
274 fname);
275 return 1;
276 }
277 i++;
278 }
279 if (i) {
280 td->o.continue_on_error |= 1 << etype;
281 td->o.ignore_error_nr[etype] = i;
282 td->o.ignore_error[etype] = error;
283 }
284 return 0;
285
286}
287
288static int str_ignore_error_cb(void *data, const char *input)
289{
290 struct thread_data *td = data;
291 char *str, *p, *n;
292 int type = 0, ret = 1;
293 p = str = strdup(input);
294
295 strip_blank_front(&str);
296 strip_blank_end(str);
297
298 while (p) {
299 n = strchr(p, ',');
300 if (n)
301 *n++ = '\0';
302 ret = ignore_error_type(td, type, p);
303 if (ret)
304 break;
305 p = n;
306 type++;
307 }
308 free(str);
309 return ret;
310}
311
312static int str_rw_cb(void *data, const char *str)
313{
314 struct thread_data *td = data;
315 char *nr = get_opt_postfix(str);
316
317 td->o.ddir_seq_nr = 1;
318 td->o.ddir_seq_add = 0;
319
320 if (!nr)
321 return 0;
322
323 if (td_random(td))
324 td->o.ddir_seq_nr = atoi(nr);
325 else {
326 long long val;
327
328 if (str_to_decimal(nr, &val, 1, td)) {
329 log_err("fio: rw postfix parsing failed\n");
330 free(nr);
331 return 1;
332 }
333
334 td->o.ddir_seq_add = val;
335 }
336
337 free(nr);
338 return 0;
339}
340
341static int str_mem_cb(void *data, const char *mem)
342{
343 struct thread_data *td = data;
344
345 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
346 td->mmapfile = get_opt_postfix(mem);
347 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
348 log_err("fio: mmaphuge:/path/to/file\n");
349 return 1;
350 }
351 }
352
353 return 0;
354}
355
356static int str_verify_cb(void *data, const char *mem)
357{
358 struct thread_data *td = data;
359
360 if (td->o.verify == VERIFY_CRC32C_INTEL ||
361 td->o.verify == VERIFY_CRC32C) {
362 crc32c_intel_probe();
363 }
364
365 return 0;
366}
367
368static int fio_clock_source_cb(void *data, const char *str)
369{
370 struct thread_data *td = data;
371
372 fio_clock_source = td->o.clocksource;
373 fio_clock_source_set = 1;
374 fio_clock_init();
375 return 0;
376}
377
378static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
379{
380 mlock_size = *val;
381 return 0;
382}
383
384static int str_rwmix_read_cb(void *data, unsigned long long *val)
385{
386 struct thread_data *td = data;
387
388 td->o.rwmix[DDIR_READ] = *val;
389 td->o.rwmix[DDIR_WRITE] = 100 - *val;
390 return 0;
391}
392
393static int str_rwmix_write_cb(void *data, unsigned long long *val)
394{
395 struct thread_data *td = data;
396
397 td->o.rwmix[DDIR_WRITE] = *val;
398 td->o.rwmix[DDIR_READ] = 100 - *val;
399 return 0;
400}
401
402#ifdef FIO_HAVE_IOPRIO
403static int str_prioclass_cb(void *data, unsigned long long *val)
404{
405 struct thread_data *td = data;
406 unsigned short mask;
407
408 /*
409 * mask off old class bits, str_prio_cb() may have set a default class
410 */
411 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
412 td->ioprio &= mask;
413
414 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
415 td->ioprio_set = 1;
416 return 0;
417}
418
419static int str_prio_cb(void *data, unsigned long long *val)
420{
421 struct thread_data *td = data;
422
423 td->ioprio |= *val;
424
425 /*
426 * If no class is set, assume BE
427 */
428 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
429 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
430
431 td->ioprio_set = 1;
432 return 0;
433}
434#endif
435
436static int str_exitall_cb(void)
437{
438 exitall_on_terminate = 1;
439 return 0;
440}
441
442#ifdef FIO_HAVE_CPU_AFFINITY
443static int str_cpumask_cb(void *data, unsigned long long *val)
444{
445 struct thread_data *td = data;
446 unsigned int i;
447 long max_cpu;
448 int ret;
449
450 ret = fio_cpuset_init(&td->o.cpumask);
451 if (ret < 0) {
452 log_err("fio: cpuset_init failed\n");
453 td_verror(td, ret, "fio_cpuset_init");
454 return 1;
455 }
456
457 max_cpu = cpus_online();
458
459 for (i = 0; i < sizeof(int) * 8; i++) {
460 if ((1 << i) & *val) {
461 if (i > max_cpu) {
462 log_err("fio: CPU %d too large (max=%ld)\n", i,
463 max_cpu);
464 return 1;
465 }
466 dprint(FD_PARSE, "set cpu allowed %d\n", i);
467 fio_cpu_set(&td->o.cpumask, i);
468 }
469 }
470
471 td->o.cpumask_set = 1;
472 return 0;
473}
474
475static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
476 const char *input)
477{
478 char *cpu, *str, *p;
479 long max_cpu;
480 int ret = 0;
481
482 ret = fio_cpuset_init(mask);
483 if (ret < 0) {
484 log_err("fio: cpuset_init failed\n");
485 td_verror(td, ret, "fio_cpuset_init");
486 return 1;
487 }
488
489 p = str = strdup(input);
490
491 strip_blank_front(&str);
492 strip_blank_end(str);
493
494 max_cpu = cpus_online();
495
496 while ((cpu = strsep(&str, ",")) != NULL) {
497 char *str2, *cpu2;
498 int icpu, icpu2;
499
500 if (!strlen(cpu))
501 break;
502
503 str2 = cpu;
504 icpu2 = -1;
505 while ((cpu2 = strsep(&str2, "-")) != NULL) {
506 if (!strlen(cpu2))
507 break;
508
509 icpu2 = atoi(cpu2);
510 }
511
512 icpu = atoi(cpu);
513 if (icpu2 == -1)
514 icpu2 = icpu;
515 while (icpu <= icpu2) {
516 if (icpu >= FIO_MAX_CPUS) {
517 log_err("fio: your OS only supports up to"
518 " %d CPUs\n", (int) FIO_MAX_CPUS);
519 ret = 1;
520 break;
521 }
522 if (icpu > max_cpu) {
523 log_err("fio: CPU %d too large (max=%ld)\n",
524 icpu, max_cpu);
525 ret = 1;
526 break;
527 }
528
529 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
530 fio_cpu_set(mask, icpu);
531 icpu++;
532 }
533 if (ret)
534 break;
535 }
536
537 free(p);
538 if (!ret)
539 td->o.cpumask_set = 1;
540 return ret;
541}
542
543static int str_cpus_allowed_cb(void *data, const char *input)
544{
545 struct thread_data *td = data;
546 int ret;
547
548 ret = set_cpus_allowed(td, &td->o.cpumask, input);
549 if (!ret)
550 td->o.cpumask_set = 1;
551
552 return ret;
553}
554
555static int str_verify_cpus_allowed_cb(void *data, const char *input)
556{
557 struct thread_data *td = data;
558 int ret;
559
560 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
561 if (!ret)
562 td->o.verify_cpumask_set = 1;
563
564 return ret;
565}
566#endif
567
568#ifdef CONFIG_LIBNUMA
569static int str_numa_cpunodes_cb(void *data, char *input)
570{
571 struct thread_data *td = data;
572
573 /* numa_parse_nodestring() parses a character string list
574 * of nodes into a bit mask. The bit mask is allocated by
575 * numa_allocate_nodemask(), so it should be freed by
576 * numa_free_nodemask().
577 */
578 td->o.numa_cpunodesmask = numa_parse_nodestring(input);
579 if (td->o.numa_cpunodesmask == NULL) {
580 log_err("fio: numa_parse_nodestring failed\n");
581 td_verror(td, 1, "str_numa_cpunodes_cb");
582 return 1;
583 }
584
585 td->o.numa_cpumask_set = 1;
586 return 0;
587}
588
589static int str_numa_mpol_cb(void *data, char *input)
590{
591 struct thread_data *td = data;
592 const char * const policy_types[] =
593 { "default", "prefer", "bind", "interleave", "local" };
594 int i;
595
596 char *nodelist = strchr(input, ':');
597 if (nodelist) {
598 /* NUL-terminate mode */
599 *nodelist++ = '\0';
600 }
601
602 for (i = 0; i <= MPOL_LOCAL; i++) {
603 if (!strcmp(input, policy_types[i])) {
604 td->o.numa_mem_mode = i;
605 break;
606 }
607 }
608 if (i > MPOL_LOCAL) {
609 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
610 goto out;
611 }
612
613 switch (td->o.numa_mem_mode) {
614 case MPOL_PREFERRED:
615 /*
616 * Insist on a nodelist of one node only
617 */
618 if (nodelist) {
619 char *rest = nodelist;
620 while (isdigit(*rest))
621 rest++;
622 if (*rest) {
623 log_err("fio: one node only for \'prefer\'\n");
624 goto out;
625 }
626 } else {
627 log_err("fio: one node is needed for \'prefer\'\n");
628 goto out;
629 }
630 break;
631 case MPOL_INTERLEAVE:
632 /*
633 * Default to online nodes with memory if no nodelist
634 */
635 if (!nodelist)
636 nodelist = strdup("all");
637 break;
638 case MPOL_LOCAL:
639 case MPOL_DEFAULT:
640 /*
641 * Don't allow a nodelist
642 */
643 if (nodelist) {
644 log_err("fio: NO nodelist for \'local\'\n");
645 goto out;
646 }
647 break;
648 case MPOL_BIND:
649 /*
650 * Insist on a nodelist
651 */
652 if (!nodelist) {
653 log_err("fio: a nodelist is needed for \'bind\'\n");
654 goto out;
655 }
656 break;
657 }
658
659
660 /* numa_parse_nodestring() parses a character string list
661 * of nodes into a bit mask. The bit mask is allocated by
662 * numa_allocate_nodemask(), so it should be freed by
663 * numa_free_nodemask().
664 */
665 switch (td->o.numa_mem_mode) {
666 case MPOL_PREFERRED:
667 td->o.numa_mem_prefer_node = atoi(nodelist);
668 break;
669 case MPOL_INTERLEAVE:
670 case MPOL_BIND:
671 td->o.numa_memnodesmask = numa_parse_nodestring(nodelist);
672 if (td->o.numa_memnodesmask == NULL) {
673 log_err("fio: numa_parse_nodestring failed\n");
674 td_verror(td, 1, "str_numa_memnodes_cb");
675 return 1;
676 }
677 break;
678 case MPOL_LOCAL:
679 case MPOL_DEFAULT:
680 default:
681 break;
682 }
683
684 td->o.numa_memmask_set = 1;
685 return 0;
686
687out:
688 return 1;
689}
690#endif
691
692#ifdef FIO_HAVE_TRIM
693static int str_verify_trim_cb(void *data, unsigned long long *val)
694{
695 struct thread_data *td = data;
696
697 td->o.trim_percentage = *val;
698 return 0;
699}
700#endif
701
702static int str_fst_cb(void *data, const char *str)
703{
704 struct thread_data *td = data;
705 char *nr = get_opt_postfix(str);
706
707 td->file_service_nr = 1;
708 if (nr) {
709 td->file_service_nr = atoi(nr);
710 free(nr);
711 }
712
713 return 0;
714}
715
716#ifdef CONFIG_SYNC_FILE_RANGE
717static int str_sfr_cb(void *data, const char *str)
718{
719 struct thread_data *td = data;
720 char *nr = get_opt_postfix(str);
721
722 td->sync_file_range_nr = 1;
723 if (nr) {
724 td->sync_file_range_nr = atoi(nr);
725 free(nr);
726 }
727
728 return 0;
729}
730#endif
731
732static int str_random_distribution_cb(void *data, const char *str)
733{
734 struct thread_data *td = data;
735 double val;
736 char *nr;
737
738 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
739 val = 1.1;
740 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
741 val = 0.2;
742 else
743 return 0;
744
745 nr = get_opt_postfix(str);
746 if (nr && !str_to_float(nr, &val)) {
747 log_err("fio: random postfix parsing failed\n");
748 free(nr);
749 return 1;
750 }
751
752 free(nr);
753
754 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
755 if (val == 1.00) {
756 log_err("fio: zipf theta must different than 1.0\n");
757 return 1;
758 }
759 td->o.zipf_theta = val;
760 } else {
761 if (val <= 0.00 || val >= 1.00) {
762 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
763 return 1;
764 }
765 td->o.pareto_h = val;
766 }
767
768 return 0;
769}
770
771static int check_dir(struct thread_data *td, char *fname)
772{
773#if 0
774 char file[PATH_MAX], *dir;
775 int elen = 0;
776
777 if (td->o.directory) {
778 strcpy(file, td->o.directory);
779 strcat(file, "/");
780 elen = strlen(file);
781 }
782
783 sprintf(file + elen, "%s", fname);
784 dir = dirname(file);
785
786 {
787 struct stat sb;
788 /*
789 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
790 * yet, so we can't do this check right here...
791 */
792 if (lstat(dir, &sb) < 0) {
793 int ret = errno;
794
795 log_err("fio: %s is not a directory\n", dir);
796 td_verror(td, ret, "lstat");
797 return 1;
798 }
799
800 if (!S_ISDIR(sb.st_mode)) {
801 log_err("fio: %s is not a directory\n", dir);
802 return 1;
803 }
804 }
805#endif
806
807 return 0;
808}
809
810/*
811 * Return next file in the string. Files are separated with ':'. If the ':'
812 * is escaped with a '\', then that ':' is part of the filename and does not
813 * indicate a new file.
814 */
815static char *get_next_file_name(char **ptr)
816{
817 char *str = *ptr;
818 char *p, *start;
819
820 if (!str || !strlen(str))
821 return NULL;
822
823 start = str;
824 do {
825 /*
826 * No colon, we are done
827 */
828 p = strchr(str, ':');
829 if (!p) {
830 *ptr = NULL;
831 break;
832 }
833
834 /*
835 * We got a colon, but it's the first character. Skip and
836 * continue
837 */
838 if (p == start) {
839 str = ++start;
840 continue;
841 }
842
843 if (*(p - 1) != '\\') {
844 *p = '\0';
845 *ptr = p + 1;
846 break;
847 }
848
849 memmove(p - 1, p, strlen(p) + 1);
850 str = p;
851 } while (1);
852
853 return start;
854}
855
856static int str_filename_cb(void *data, const char *input)
857{
858 struct thread_data *td = data;
859 char *fname, *str, *p;
860
861 p = str = strdup(input);
862
863 strip_blank_front(&str);
864 strip_blank_end(str);
865
866 if (!td->files_index)
867 td->o.nr_files = 0;
868
869 while ((fname = get_next_file_name(&str)) != NULL) {
870 if (!strlen(fname))
871 break;
872 if (check_dir(td, fname)) {
873 free(p);
874 return 1;
875 }
876 add_file(td, fname);
877 td->o.nr_files++;
878 }
879
880 free(p);
881 return 0;
882}
883
884static int str_directory_cb(void *data, const char fio_unused *str)
885{
886 struct thread_data *td = data;
887 struct stat sb;
888
889 if (lstat(td->o.directory, &sb) < 0) {
890 int ret = errno;
891
892 log_err("fio: %s is not a directory\n", td->o.directory);
893 td_verror(td, ret, "lstat");
894 return 1;
895 }
896 if (!S_ISDIR(sb.st_mode)) {
897 log_err("fio: %s is not a directory\n", td->o.directory);
898 return 1;
899 }
900
901 return 0;
902}
903
904static int str_opendir_cb(void *data, const char fio_unused *str)
905{
906 struct thread_data *td = data;
907
908 if (!td->files_index)
909 td->o.nr_files = 0;
910
911 return add_dir_files(td, td->o.opendir);
912}
913
914static int str_verify_offset_cb(void *data, unsigned long long *off)
915{
916 struct thread_data *td = data;
917
918 if (*off && *off < sizeof(struct verify_header)) {
919 log_err("fio: verify_offset too small\n");
920 return 1;
921 }
922
923 td->o.verify_offset = *off;
924 return 0;
925}
926
927static int str_verify_pattern_cb(void *data, const char *input)
928{
929 struct thread_data *td = data;
930 long off;
931 int i = 0, j = 0, len, k, base = 10;
932 char* loc1, * loc2;
933
934 loc1 = strstr(input, "0x");
935 loc2 = strstr(input, "0X");
936 if (loc1 || loc2)
937 base = 16;
938 off = strtol(input, NULL, base);
939 if (off != LONG_MAX || errno != ERANGE) {
940 while (off) {
941 td->o.verify_pattern[i] = off & 0xff;
942 off >>= 8;
943 i++;
944 }
945 } else {
946 len = strlen(input);
947 k = len - 1;
948 if (base == 16) {
949 if (loc1)
950 j = loc1 - input + 2;
951 else
952 j = loc2 - input + 2;
953 } else
954 return 1;
955 if (len - j < MAX_PATTERN_SIZE * 2) {
956 while (k >= j) {
957 off = converthexchartoint(input[k--]);
958 if (k >= j)
959 off += (converthexchartoint(input[k--])
960 * 16);
961 td->o.verify_pattern[i++] = (char) off;
962 }
963 }
964 }
965
966 /*
967 * Fill the pattern all the way to the end. This greatly reduces
968 * the number of memcpy's we have to do when verifying the IO.
969 */
970 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
971 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
972 i *= 2;
973 }
974 if (i == 1) {
975 /*
976 * The code in verify_io_u_pattern assumes a single byte pattern
977 * fills the whole verify pattern buffer.
978 */
979 memset(td->o.verify_pattern, td->o.verify_pattern[0],
980 MAX_PATTERN_SIZE);
981 }
982
983 td->o.verify_pattern_bytes = i;
984
985 /*
986 * VERIFY_META could already be set
987 */
988 if (td->o.verify == VERIFY_NONE)
989 td->o.verify = VERIFY_PATTERN;
990
991 return 0;
992}
993
994static int str_lockfile_cb(void *data, const char *str)
995{
996 struct thread_data *td = data;
997 char *nr = get_opt_postfix(str);
998
999 td->o.lockfile_batch = 1;
1000 if (nr) {
1001 td->o.lockfile_batch = atoi(nr);
1002 free(nr);
1003 }
1004
1005 return 0;
1006}
1007
1008static int str_write_bw_log_cb(void *data, const char *str)
1009{
1010 struct thread_data *td = data;
1011
1012 if (str)
1013 td->o.bw_log_file = strdup(str);
1014
1015 td->o.write_bw_log = 1;
1016 return 0;
1017}
1018
1019static int str_write_lat_log_cb(void *data, const char *str)
1020{
1021 struct thread_data *td = data;
1022
1023 if (str)
1024 td->o.lat_log_file = strdup(str);
1025
1026 td->o.write_lat_log = 1;
1027 return 0;
1028}
1029
1030static int str_write_iops_log_cb(void *data, const char *str)
1031{
1032 struct thread_data *td = data;
1033
1034 if (str)
1035 td->o.iops_log_file = strdup(str);
1036
1037 td->o.write_iops_log = 1;
1038 return 0;
1039}
1040
1041static int str_gtod_reduce_cb(void *data, int *il)
1042{
1043 struct thread_data *td = data;
1044 int val = *il;
1045
1046 td->o.disable_lat = !!val;
1047 td->o.disable_clat = !!val;
1048 td->o.disable_slat = !!val;
1049 td->o.disable_bw = !!val;
1050 td->o.clat_percentiles = !val;
1051 if (val)
1052 td->tv_cache_mask = 63;
1053
1054 return 0;
1055}
1056
1057static int str_gtod_cpu_cb(void *data, long long *il)
1058{
1059 struct thread_data *td = data;
1060 int val = *il;
1061
1062 td->o.gtod_cpu = val;
1063 td->o.gtod_offload = 1;
1064 return 0;
1065}
1066
1067static int str_size_cb(void *data, unsigned long long *__val)
1068{
1069 struct thread_data *td = data;
1070 unsigned long long v = *__val;
1071
1072 if (parse_is_percent(v)) {
1073 td->o.size = 0;
1074 td->o.size_percent = -1ULL - v;
1075 } else
1076 td->o.size = v;
1077
1078 return 0;
1079}
1080
1081static int rw_verify(struct fio_option *o, void *data)
1082{
1083 struct thread_data *td = data;
1084
1085 if (read_only && td_write(td)) {
1086 log_err("fio: job <%s> has write bit set, but fio is in"
1087 " read-only mode\n", td->o.name);
1088 return 1;
1089 }
1090
1091 return 0;
1092}
1093
1094static int gtod_cpu_verify(struct fio_option *o, void *data)
1095{
1096#ifndef FIO_HAVE_CPU_AFFINITY
1097 struct thread_data *td = data;
1098
1099 if (td->o.gtod_cpu) {
1100 log_err("fio: platform must support CPU affinity for"
1101 "gettimeofday() offloading\n");
1102 return 1;
1103 }
1104#endif
1105
1106 return 0;
1107}
1108
1109static int kb_base_verify(struct fio_option *o, void *data)
1110{
1111 struct thread_data *td = data;
1112
1113 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
1114 log_err("fio: kb_base set to nonsensical value: %u\n",
1115 td->o.kb_base);
1116 return 1;
1117 }
1118
1119 return 0;
1120}
1121
1122/*
1123 * Map of job/command line options
1124 */
1125static struct fio_option options[FIO_MAX_OPTS] = {
1126 {
1127 .name = "description",
1128 .type = FIO_OPT_STR_STORE,
1129 .off1 = td_var_offset(description),
1130 .help = "Text job description",
1131 },
1132 {
1133 .name = "name",
1134 .type = FIO_OPT_STR_STORE,
1135 .off1 = td_var_offset(name),
1136 .help = "Name of this job",
1137 },
1138 {
1139 .name = "directory",
1140 .type = FIO_OPT_STR_STORE,
1141 .off1 = td_var_offset(directory),
1142 .cb = str_directory_cb,
1143 .help = "Directory to store files in",
1144 },
1145 {
1146 .name = "filename",
1147 .type = FIO_OPT_STR_STORE,
1148 .off1 = td_var_offset(filename),
1149 .cb = str_filename_cb,
1150 .prio = -1, /* must come after "directory" */
1151 .help = "File(s) to use for the workload",
1152 },
1153 {
1154 .name = "kb_base",
1155 .type = FIO_OPT_INT,
1156 .off1 = td_var_offset(kb_base),
1157 .verify = kb_base_verify,
1158 .prio = 1,
1159 .def = "1024",
1160 .help = "How many bytes per KB for reporting (1000 or 1024)",
1161 },
1162 {
1163 .name = "lockfile",
1164 .type = FIO_OPT_STR,
1165 .cb = str_lockfile_cb,
1166 .off1 = td_var_offset(file_lock_mode),
1167 .help = "Lock file when doing IO to it",
1168 .parent = "filename",
1169 .def = "none",
1170 .posval = {
1171 { .ival = "none",
1172 .oval = FILE_LOCK_NONE,
1173 .help = "No file locking",
1174 },
1175 { .ival = "exclusive",
1176 .oval = FILE_LOCK_EXCLUSIVE,
1177 .help = "Exclusive file lock",
1178 },
1179 {
1180 .ival = "readwrite",
1181 .oval = FILE_LOCK_READWRITE,
1182 .help = "Read vs write lock",
1183 },
1184 },
1185 },
1186 {
1187 .name = "opendir",
1188 .type = FIO_OPT_STR_STORE,
1189 .off1 = td_var_offset(opendir),
1190 .cb = str_opendir_cb,
1191 .help = "Recursively add files from this directory and down",
1192 },
1193 {
1194 .name = "rw",
1195 .alias = "readwrite",
1196 .type = FIO_OPT_STR,
1197 .cb = str_rw_cb,
1198 .off1 = td_var_offset(td_ddir),
1199 .help = "IO direction",
1200 .def = "read",
1201 .verify = rw_verify,
1202 .posval = {
1203 { .ival = "read",
1204 .oval = TD_DDIR_READ,
1205 .help = "Sequential read",
1206 },
1207 { .ival = "write",
1208 .oval = TD_DDIR_WRITE,
1209 .help = "Sequential write",
1210 },
1211 { .ival = "trim",
1212 .oval = TD_DDIR_TRIM,
1213 .help = "Sequential trim",
1214 },
1215 { .ival = "randread",
1216 .oval = TD_DDIR_RANDREAD,
1217 .help = "Random read",
1218 },
1219 { .ival = "randwrite",
1220 .oval = TD_DDIR_RANDWRITE,
1221 .help = "Random write",
1222 },
1223 { .ival = "randtrim",
1224 .oval = TD_DDIR_RANDTRIM,
1225 .help = "Random trim",
1226 },
1227 { .ival = "rw",
1228 .oval = TD_DDIR_RW,
1229 .help = "Sequential read and write mix",
1230 },
1231 { .ival = "readwrite",
1232 .oval = TD_DDIR_RW,
1233 .help = "Sequential read and write mix",
1234 },
1235 { .ival = "randrw",
1236 .oval = TD_DDIR_RANDRW,
1237 .help = "Random read and write mix"
1238 },
1239 },
1240 },
1241 {
1242 .name = "rw_sequencer",
1243 .type = FIO_OPT_STR,
1244 .off1 = td_var_offset(rw_seq),
1245 .help = "IO offset generator modifier",
1246 .def = "sequential",
1247 .posval = {
1248 { .ival = "sequential",
1249 .oval = RW_SEQ_SEQ,
1250 .help = "Generate sequential offsets",
1251 },
1252 { .ival = "identical",
1253 .oval = RW_SEQ_IDENT,
1254 .help = "Generate identical offsets",
1255 },
1256 },
1257 },
1258
1259 {
1260 .name = "ioengine",
1261 .type = FIO_OPT_STR_STORE,
1262 .off1 = td_var_offset(ioengine),
1263 .help = "IO engine to use",
1264 .def = FIO_PREFERRED_ENGINE,
1265 .posval = {
1266 { .ival = "sync",
1267 .help = "Use read/write",
1268 },
1269 { .ival = "psync",
1270 .help = "Use pread/pwrite",
1271 },
1272 { .ival = "vsync",
1273 .help = "Use readv/writev",
1274 },
1275#ifdef CONFIG_LIBAIO
1276 { .ival = "libaio",
1277 .help = "Linux native asynchronous IO",
1278 },
1279#endif
1280#ifdef CONFIG_POSIXAIO
1281 { .ival = "posixaio",
1282 .help = "POSIX asynchronous IO",
1283 },
1284#endif
1285#ifdef FIO_HAVE_SOLARISAIO
1286 { .ival = "solarisaio",
1287 .help = "Solaris native asynchronous IO",
1288 },
1289#endif
1290#ifdef FIO_HAVE_WINDOWSAIO
1291 { .ival = "windowsaio",
1292 .help = "Windows native asynchronous IO"
1293 },
1294#endif
1295 { .ival = "mmap",
1296 .help = "Memory mapped IO"
1297 },
1298#ifdef CONFIG_LINUX_SPLICE
1299 { .ival = "splice",
1300 .help = "splice/vmsplice based IO",
1301 },
1302 { .ival = "netsplice",
1303 .help = "splice/vmsplice to/from the network",
1304 },
1305#endif
1306#ifdef FIO_HAVE_SGIO
1307 { .ival = "sg",
1308 .help = "SCSI generic v3 IO",
1309 },
1310#endif
1311 { .ival = "null",
1312 .help = "Testing engine (no data transfer)",
1313 },
1314 { .ival = "net",
1315 .help = "Network IO",
1316 },
1317 { .ival = "cpuio",
1318 .help = "CPU cycle burner engine",
1319 },
1320#ifdef CONFIG_GUASI
1321 { .ival = "guasi",
1322 .help = "GUASI IO engine",
1323 },
1324#endif
1325#ifdef FIO_HAVE_BINJECT
1326 { .ival = "binject",
1327 .help = "binject direct inject block engine",
1328 },
1329#endif
1330#ifdef CONFIG_RDMA
1331 { .ival = "rdma",
1332 .help = "RDMA IO engine",
1333 },
1334#endif
1335#ifdef CONFIG_FUSION_AW
1336 { .ival = "fusion-aw-sync",
1337 .help = "Fusion-io atomic write engine",
1338 },
1339#endif
1340#ifdef FIO_HAVE_E4_ENG
1341 { .ival = "e4defrag",
1342 .help = "ext4 defrag engine",
1343 },
1344#endif
1345#ifdef FIO_HAVE_FALLOC_ENG
1346 { .ival = "falloc",
1347 .help = "fallocate() file based engine",
1348 },
1349#endif
1350 { .ival = "external",
1351 .help = "Load external engine (append name)",
1352 },
1353 },
1354 },
1355 {
1356 .name = "iodepth",
1357 .type = FIO_OPT_INT,
1358 .off1 = td_var_offset(iodepth),
1359 .help = "Number of IO buffers to keep in flight",
1360 .minval = 1,
1361 .def = "1",
1362 },
1363 {
1364 .name = "iodepth_batch",
1365 .alias = "iodepth_batch_submit",
1366 .type = FIO_OPT_INT,
1367 .off1 = td_var_offset(iodepth_batch),
1368 .help = "Number of IO buffers to submit in one go",
1369 .parent = "iodepth",
1370 .minval = 1,
1371 .def = "1",
1372 },
1373 {
1374 .name = "iodepth_batch_complete",
1375 .type = FIO_OPT_INT,
1376 .off1 = td_var_offset(iodepth_batch_complete),
1377 .help = "Number of IO buffers to retrieve in one go",
1378 .parent = "iodepth",
1379 .minval = 0,
1380 .def = "1",
1381 },
1382 {
1383 .name = "iodepth_low",
1384 .type = FIO_OPT_INT,
1385 .off1 = td_var_offset(iodepth_low),
1386 .help = "Low water mark for queuing depth",
1387 .parent = "iodepth",
1388 },
1389 {
1390 .name = "size",
1391 .type = FIO_OPT_STR_VAL,
1392 .cb = str_size_cb,
1393 .help = "Total size of device or files",
1394 },
1395 {
1396 .name = "fill_device",
1397 .alias = "fill_fs",
1398 .type = FIO_OPT_BOOL,
1399 .off1 = td_var_offset(fill_device),
1400 .help = "Write until an ENOSPC error occurs",
1401 .def = "0",
1402 },
1403 {
1404 .name = "filesize",
1405 .type = FIO_OPT_STR_VAL,
1406 .off1 = td_var_offset(file_size_low),
1407 .off2 = td_var_offset(file_size_high),
1408 .minval = 1,
1409 .help = "Size of individual files",
1410 },
1411 {
1412 .name = "offset",
1413 .alias = "fileoffset",
1414 .type = FIO_OPT_STR_VAL,
1415 .off1 = td_var_offset(start_offset),
1416 .help = "Start IO from this offset",
1417 .def = "0",
1418 },
1419 {
1420 .name = "offset_increment",
1421 .type = FIO_OPT_STR_VAL,
1422 .off1 = td_var_offset(offset_increment),
1423 .help = "What is the increment from one offset to the next",
1424 .parent = "offset",
1425 .def = "0",
1426 },
1427 {
1428 .name = "bs",
1429 .alias = "blocksize",
1430 .type = FIO_OPT_INT,
1431 .off1 = td_var_offset(bs[DDIR_READ]),
1432 .off2 = td_var_offset(bs[DDIR_WRITE]),
1433 .off3 = td_var_offset(bs[DDIR_TRIM]),
1434 .minval = 1,
1435 .help = "Block size unit",
1436 .def = "4k",
1437 .parent = "rw",
1438 },
1439 {
1440 .name = "ba",
1441 .alias = "blockalign",
1442 .type = FIO_OPT_INT,
1443 .off1 = td_var_offset(ba[DDIR_READ]),
1444 .off2 = td_var_offset(ba[DDIR_WRITE]),
1445 .off3 = td_var_offset(ba[DDIR_TRIM]),
1446 .minval = 1,
1447 .help = "IO block offset alignment",
1448 .parent = "rw",
1449 },
1450 {
1451 .name = "bsrange",
1452 .alias = "blocksize_range",
1453 .type = FIO_OPT_RANGE,
1454 .off1 = td_var_offset(min_bs[DDIR_READ]),
1455 .off2 = td_var_offset(max_bs[DDIR_READ]),
1456 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1457 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1458 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1459 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1460 .minval = 1,
1461 .help = "Set block size range (in more detail than bs)",
1462 .parent = "rw",
1463 },
1464 {
1465 .name = "bssplit",
1466 .type = FIO_OPT_STR,
1467 .cb = str_bssplit_cb,
1468 .help = "Set a specific mix of block sizes",
1469 .parent = "rw",
1470 },
1471 {
1472 .name = "bs_unaligned",
1473 .alias = "blocksize_unaligned",
1474 .type = FIO_OPT_STR_SET,
1475 .off1 = td_var_offset(bs_unaligned),
1476 .help = "Don't sector align IO buffer sizes",
1477 .parent = "rw",
1478 },
1479 {
1480 .name = "randrepeat",
1481 .type = FIO_OPT_BOOL,
1482 .off1 = td_var_offset(rand_repeatable),
1483 .help = "Use repeatable random IO pattern",
1484 .def = "1",
1485 .parent = "rw",
1486 },
1487 {
1488 .name = "use_os_rand",
1489 .type = FIO_OPT_BOOL,
1490 .off1 = td_var_offset(use_os_rand),
1491 .help = "Set to use OS random generator",
1492 .def = "0",
1493 .parent = "rw",
1494 },
1495 {
1496 .name = "norandommap",
1497 .type = FIO_OPT_STR_SET,
1498 .off1 = td_var_offset(norandommap),
1499 .help = "Accept potential duplicate random blocks",
1500 .parent = "rw",
1501 },
1502 {
1503 .name = "softrandommap",
1504 .type = FIO_OPT_BOOL,
1505 .off1 = td_var_offset(softrandommap),
1506 .help = "Set norandommap if randommap allocation fails",
1507 .parent = "norandommap",
1508 .def = "0",
1509 },
1510 {
1511 .name = "random_generator",
1512 .type = FIO_OPT_STR,
1513 .off1 = td_var_offset(random_generator),
1514 .help = "Type of random number generator to use",
1515 .def = "tausworthe",
1516 .posval = {
1517 { .ival = "tausworthe",
1518 .oval = FIO_RAND_GEN_TAUSWORTHE,
1519 .help = "Strong Tausworthe generator",
1520 },
1521 { .ival = "lfsr",
1522 .oval = FIO_RAND_GEN_LFSR,
1523 .help = "Variable length LFSR",
1524 },
1525 },
1526 },
1527 {
1528 .name = "random_distribution",
1529 .type = FIO_OPT_STR,
1530 .off1 = td_var_offset(random_distribution),
1531 .cb = str_random_distribution_cb,
1532 .help = "Random offset distribution generator",
1533 .def = "random",
1534 .posval = {
1535 { .ival = "random",
1536 .oval = FIO_RAND_DIST_RANDOM,
1537 .help = "Completely random",
1538 },
1539 { .ival = "zipf",
1540 .oval = FIO_RAND_DIST_ZIPF,
1541 .help = "Zipf distribution",
1542 },
1543 { .ival = "pareto",
1544 .oval = FIO_RAND_DIST_PARETO,
1545 .help = "Pareto distribution",
1546 },
1547 },
1548 },
1549 {
1550 .name = "nrfiles",
1551 .alias = "nr_files",
1552 .type = FIO_OPT_INT,
1553 .off1 = td_var_offset(nr_files),
1554 .help = "Split job workload between this number of files",
1555 .def = "1",
1556 },
1557 {
1558 .name = "openfiles",
1559 .type = FIO_OPT_INT,
1560 .off1 = td_var_offset(open_files),
1561 .help = "Number of files to keep open at the same time",
1562 },
1563 {
1564 .name = "file_service_type",
1565 .type = FIO_OPT_STR,
1566 .cb = str_fst_cb,
1567 .off1 = td_var_offset(file_service_type),
1568 .help = "How to select which file to service next",
1569 .def = "roundrobin",
1570 .posval = {
1571 { .ival = "random",
1572 .oval = FIO_FSERVICE_RANDOM,
1573 .help = "Choose a file at random",
1574 },
1575 { .ival = "roundrobin",
1576 .oval = FIO_FSERVICE_RR,
1577 .help = "Round robin select files",
1578 },
1579 { .ival = "sequential",
1580 .oval = FIO_FSERVICE_SEQ,
1581 .help = "Finish one file before moving to the next",
1582 },
1583 },
1584 .parent = "nrfiles",
1585 },
1586#ifdef FIO_HAVE_FALLOCATE
1587 {
1588 .name = "fallocate",
1589 .type = FIO_OPT_STR,
1590 .off1 = td_var_offset(fallocate_mode),
1591 .help = "Whether pre-allocation is performed when laying out files",
1592 .def = "posix",
1593 .posval = {
1594 { .ival = "none",
1595 .oval = FIO_FALLOCATE_NONE,
1596 .help = "Do not pre-allocate space",
1597 },
1598 { .ival = "posix",
1599 .oval = FIO_FALLOCATE_POSIX,
1600 .help = "Use posix_fallocate()",
1601 },
1602#ifdef FIO_HAVE_LINUX_FALLOCATE
1603 { .ival = "keep",
1604 .oval = FIO_FALLOCATE_KEEP_SIZE,
1605 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1606 },
1607#endif
1608 /* Compatibility with former boolean values */
1609 { .ival = "0",
1610 .oval = FIO_FALLOCATE_NONE,
1611 .help = "Alias for 'none'",
1612 },
1613 { .ival = "1",
1614 .oval = FIO_FALLOCATE_POSIX,
1615 .help = "Alias for 'posix'",
1616 },
1617 },
1618 },
1619#endif /* FIO_HAVE_FALLOCATE */
1620 {
1621 .name = "fadvise_hint",
1622 .type = FIO_OPT_BOOL,
1623 .off1 = td_var_offset(fadvise_hint),
1624 .help = "Use fadvise() to advise the kernel on IO pattern",
1625 .def = "1",
1626 },
1627 {
1628 .name = "fsync",
1629 .type = FIO_OPT_INT,
1630 .off1 = td_var_offset(fsync_blocks),
1631 .help = "Issue fsync for writes every given number of blocks",
1632 .def = "0",
1633 },
1634 {
1635 .name = "fdatasync",
1636 .type = FIO_OPT_INT,
1637 .off1 = td_var_offset(fdatasync_blocks),
1638 .help = "Issue fdatasync for writes every given number of blocks",
1639 .def = "0",
1640 },
1641 {
1642 .name = "write_barrier",
1643 .type = FIO_OPT_INT,
1644 .off1 = td_var_offset(barrier_blocks),
1645 .help = "Make every Nth write a barrier write",
1646 .def = "0",
1647 },
1648#ifdef CONFIG_SYNC_FILE_RANGE
1649 {
1650 .name = "sync_file_range",
1651 .posval = {
1652 { .ival = "wait_before",
1653 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1654 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1655 .or = 1,
1656 },
1657 { .ival = "write",
1658 .oval = SYNC_FILE_RANGE_WRITE,
1659 .help = "SYNC_FILE_RANGE_WRITE",
1660 .or = 1,
1661 },
1662 {
1663 .ival = "wait_after",
1664 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1665 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1666 .or = 1,
1667 },
1668 },
1669 .type = FIO_OPT_STR_MULTI,
1670 .cb = str_sfr_cb,
1671 .off1 = td_var_offset(sync_file_range),
1672 .help = "Use sync_file_range()",
1673 },
1674#endif
1675 {
1676 .name = "direct",
1677 .type = FIO_OPT_BOOL,
1678 .off1 = td_var_offset(odirect),
1679 .help = "Use O_DIRECT IO (negates buffered)",
1680 .def = "0",
1681 },
1682 {
1683 .name = "buffered",
1684 .type = FIO_OPT_BOOL,
1685 .off1 = td_var_offset(odirect),
1686 .neg = 1,
1687 .help = "Use buffered IO (negates direct)",
1688 .def = "1",
1689 },
1690 {
1691 .name = "overwrite",
1692 .type = FIO_OPT_BOOL,
1693 .off1 = td_var_offset(overwrite),
1694 .help = "When writing, set whether to overwrite current data",
1695 .def = "0",
1696 },
1697 {
1698 .name = "loops",
1699 .type = FIO_OPT_INT,
1700 .off1 = td_var_offset(loops),
1701 .help = "Number of times to run the job",
1702 .def = "1",
1703 },
1704 {
1705 .name = "numjobs",
1706 .type = FIO_OPT_INT,
1707 .off1 = td_var_offset(numjobs),
1708 .help = "Duplicate this job this many times",
1709 .def = "1",
1710 },
1711 {
1712 .name = "startdelay",
1713 .type = FIO_OPT_STR_VAL_TIME,
1714 .off1 = td_var_offset(start_delay),
1715 .help = "Only start job when this period has passed",
1716 .def = "0",
1717 },
1718 {
1719 .name = "runtime",
1720 .alias = "timeout",
1721 .type = FIO_OPT_STR_VAL_TIME,
1722 .off1 = td_var_offset(timeout),
1723 .help = "Stop workload when this amount of time has passed",
1724 .def = "0",
1725 },
1726 {
1727 .name = "time_based",
1728 .type = FIO_OPT_STR_SET,
1729 .off1 = td_var_offset(time_based),
1730 .help = "Keep running until runtime/timeout is met",
1731 },
1732 {
1733 .name = "ramp_time",
1734 .type = FIO_OPT_STR_VAL_TIME,
1735 .off1 = td_var_offset(ramp_time),
1736 .help = "Ramp up time before measuring performance",
1737 },
1738 {
1739 .name = "clocksource",
1740 .type = FIO_OPT_STR,
1741 .cb = fio_clock_source_cb,
1742 .off1 = td_var_offset(clocksource),
1743 .help = "What type of timing source to use",
1744 .posval = {
1745#ifdef CONFIG_GETTIMEOFDAY
1746 { .ival = "gettimeofday",
1747 .oval = CS_GTOD,
1748 .help = "Use gettimeofday(2) for timing",
1749 },
1750#endif
1751#ifdef CONFIG_CLOCK_GETTIME
1752 { .ival = "clock_gettime",
1753 .oval = CS_CGETTIME,
1754 .help = "Use clock_gettime(2) for timing",
1755 },
1756#endif
1757#ifdef ARCH_HAVE_CPU_CLOCK
1758 { .ival = "cpu",
1759 .oval = CS_CPUCLOCK,
1760 .help = "Use CPU private clock",
1761 },
1762#endif
1763 },
1764 },
1765 {
1766 .name = "mem",
1767 .alias = "iomem",
1768 .type = FIO_OPT_STR,
1769 .cb = str_mem_cb,
1770 .off1 = td_var_offset(mem_type),
1771 .help = "Backing type for IO buffers",
1772 .def = "malloc",
1773 .posval = {
1774 { .ival = "malloc",
1775 .oval = MEM_MALLOC,
1776 .help = "Use malloc(3) for IO buffers",
1777 },
1778 { .ival = "shm",
1779 .oval = MEM_SHM,
1780 .help = "Use shared memory segments for IO buffers",
1781 },
1782#ifdef FIO_HAVE_HUGETLB
1783 { .ival = "shmhuge",
1784 .oval = MEM_SHMHUGE,
1785 .help = "Like shm, but use huge pages",
1786 },
1787#endif
1788 { .ival = "mmap",
1789 .oval = MEM_MMAP,
1790 .help = "Use mmap(2) (file or anon) for IO buffers",
1791 },
1792#ifdef FIO_HAVE_HUGETLB
1793 { .ival = "mmaphuge",
1794 .oval = MEM_MMAPHUGE,
1795 .help = "Like mmap, but use huge pages",
1796 },
1797#endif
1798 },
1799 },
1800 {
1801 .name = "iomem_align",
1802 .alias = "mem_align",
1803 .type = FIO_OPT_INT,
1804 .off1 = td_var_offset(mem_align),
1805 .minval = 0,
1806 .help = "IO memory buffer offset alignment",
1807 .def = "0",
1808 .parent = "iomem",
1809 },
1810 {
1811 .name = "verify",
1812 .type = FIO_OPT_STR,
1813 .off1 = td_var_offset(verify),
1814 .help = "Verify data written",
1815 .cb = str_verify_cb,
1816 .def = "0",
1817 .posval = {
1818 { .ival = "0",
1819 .oval = VERIFY_NONE,
1820 .help = "Don't do IO verification",
1821 },
1822 { .ival = "md5",
1823 .oval = VERIFY_MD5,
1824 .help = "Use md5 checksums for verification",
1825 },
1826 { .ival = "crc64",
1827 .oval = VERIFY_CRC64,
1828 .help = "Use crc64 checksums for verification",
1829 },
1830 { .ival = "crc32",
1831 .oval = VERIFY_CRC32,
1832 .help = "Use crc32 checksums for verification",
1833 },
1834 { .ival = "crc32c-intel",
1835 .oval = VERIFY_CRC32C,
1836 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1837 },
1838 { .ival = "crc32c",
1839 .oval = VERIFY_CRC32C,
1840 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1841 },
1842 { .ival = "crc16",
1843 .oval = VERIFY_CRC16,
1844 .help = "Use crc16 checksums for verification",
1845 },
1846 { .ival = "crc7",
1847 .oval = VERIFY_CRC7,
1848 .help = "Use crc7 checksums for verification",
1849 },
1850 { .ival = "sha1",
1851 .oval = VERIFY_SHA1,
1852 .help = "Use sha1 checksums for verification",
1853 },
1854 { .ival = "sha256",
1855 .oval = VERIFY_SHA256,
1856 .help = "Use sha256 checksums for verification",
1857 },
1858 { .ival = "sha512",
1859 .oval = VERIFY_SHA512,
1860 .help = "Use sha512 checksums for verification",
1861 },
1862 { .ival = "meta",
1863 .oval = VERIFY_META,
1864 .help = "Use io information",
1865 },
1866 {
1867 .ival = "null",
1868 .oval = VERIFY_NULL,
1869 .help = "Pretend to verify",
1870 },
1871 },
1872 },
1873 {
1874 .name = "do_verify",
1875 .type = FIO_OPT_BOOL,
1876 .off1 = td_var_offset(do_verify),
1877 .help = "Run verification stage after write",
1878 .def = "1",
1879 .parent = "verify",
1880 },
1881 {
1882 .name = "verifysort",
1883 .type = FIO_OPT_BOOL,
1884 .off1 = td_var_offset(verifysort),
1885 .help = "Sort written verify blocks for read back",
1886 .def = "1",
1887 .parent = "verify",
1888 },
1889 {
1890 .name = "verifysort_nr",
1891 .type = FIO_OPT_INT,
1892 .off1 = td_var_offset(verifysort_nr),
1893 .help = "Pre-load and sort verify blocks for a read workload",
1894 .minval = 0,
1895 .maxval = 131072,
1896 .def = "1024",
1897 .parent = "verify",
1898 },
1899 {
1900 .name = "verify_interval",
1901 .type = FIO_OPT_INT,
1902 .off1 = td_var_offset(verify_interval),
1903 .minval = 2 * sizeof(struct verify_header),
1904 .help = "Store verify buffer header every N bytes",
1905 .parent = "verify",
1906 },
1907 {
1908 .name = "verify_offset",
1909 .type = FIO_OPT_INT,
1910 .help = "Offset verify header location by N bytes",
1911 .def = "0",
1912 .cb = str_verify_offset_cb,
1913 .parent = "verify",
1914 },
1915 {
1916 .name = "verify_pattern",
1917 .type = FIO_OPT_STR,
1918 .cb = str_verify_pattern_cb,
1919 .help = "Fill pattern for IO buffers",
1920 .parent = "verify",
1921 },
1922 {
1923 .name = "verify_fatal",
1924 .type = FIO_OPT_BOOL,
1925 .off1 = td_var_offset(verify_fatal),
1926 .def = "0",
1927 .help = "Exit on a single verify failure, don't continue",
1928 .parent = "verify",
1929 },
1930 {
1931 .name = "verify_dump",
1932 .type = FIO_OPT_BOOL,
1933 .off1 = td_var_offset(verify_dump),
1934 .def = "0",
1935 .help = "Dump contents of good and bad blocks on failure",
1936 .parent = "verify",
1937 },
1938 {
1939 .name = "verify_async",
1940 .type = FIO_OPT_INT,
1941 .off1 = td_var_offset(verify_async),
1942 .def = "0",
1943 .help = "Number of async verifier threads to use",
1944 .parent = "verify",
1945 },
1946 {
1947 .name = "verify_backlog",
1948 .type = FIO_OPT_STR_VAL,
1949 .off1 = td_var_offset(verify_backlog),
1950 .help = "Verify after this number of blocks are written",
1951 .parent = "verify",
1952 },
1953 {
1954 .name = "verify_backlog_batch",
1955 .type = FIO_OPT_INT,
1956 .off1 = td_var_offset(verify_batch),
1957 .help = "Verify this number of IO blocks",
1958 .parent = "verify",
1959 },
1960#ifdef FIO_HAVE_CPU_AFFINITY
1961 {
1962 .name = "verify_async_cpus",
1963 .type = FIO_OPT_STR,
1964 .cb = str_verify_cpus_allowed_cb,
1965 .help = "Set CPUs allowed for async verify threads",
1966 .parent = "verify_async",
1967 },
1968#endif
1969#ifdef FIO_HAVE_TRIM
1970 {
1971 .name = "trim_percentage",
1972 .type = FIO_OPT_INT,
1973 .cb = str_verify_trim_cb,
1974 .maxval = 100,
1975 .help = "Number of verify blocks to discard/trim",
1976 .parent = "verify",
1977 .def = "0",
1978 },
1979 {
1980 .name = "trim_verify_zero",
1981 .type = FIO_OPT_INT,
1982 .help = "Verify that trim/discarded blocks are returned as zeroes",
1983 .off1 = td_var_offset(trim_zero),
1984 .parent = "trim_percentage",
1985 .def = "1",
1986 },
1987 {
1988 .name = "trim_backlog",
1989 .type = FIO_OPT_STR_VAL,
1990 .off1 = td_var_offset(trim_backlog),
1991 .help = "Trim after this number of blocks are written",
1992 .parent = "trim_percentage",
1993 },
1994 {
1995 .name = "trim_backlog_batch",
1996 .type = FIO_OPT_INT,
1997 .off1 = td_var_offset(trim_batch),
1998 .help = "Trim this number of IO blocks",
1999 .parent = "trim_percentage",
2000 },
2001#endif
2002 {
2003 .name = "write_iolog",
2004 .type = FIO_OPT_STR_STORE,
2005 .off1 = td_var_offset(write_iolog_file),
2006 .help = "Store IO pattern to file",
2007 },
2008 {
2009 .name = "read_iolog",
2010 .type = FIO_OPT_STR_STORE,
2011 .off1 = td_var_offset(read_iolog_file),
2012 .help = "Playback IO pattern from file",
2013 },
2014 {
2015 .name = "replay_no_stall",
2016 .type = FIO_OPT_INT,
2017 .off1 = td_var_offset(no_stall),
2018 .def = "0",
2019 .parent = "read_iolog",
2020 .help = "Playback IO pattern file as fast as possible without stalls",
2021 },
2022 {
2023 .name = "replay_redirect",
2024 .type = FIO_OPT_STR_STORE,
2025 .off1 = td_var_offset(replay_redirect),
2026 .parent = "read_iolog",
2027 .help = "Replay all I/O onto this device, regardless of trace device",
2028 },
2029 {
2030 .name = "exec_prerun",
2031 .type = FIO_OPT_STR_STORE,
2032 .off1 = td_var_offset(exec_prerun),
2033 .help = "Execute this file prior to running job",
2034 },
2035 {
2036 .name = "exec_postrun",
2037 .type = FIO_OPT_STR_STORE,
2038 .off1 = td_var_offset(exec_postrun),
2039 .help = "Execute this file after running job",
2040 },
2041#ifdef FIO_HAVE_IOSCHED_SWITCH
2042 {
2043 .name = "ioscheduler",
2044 .type = FIO_OPT_STR_STORE,
2045 .off1 = td_var_offset(ioscheduler),
2046 .help = "Use this IO scheduler on the backing device",
2047 },
2048#endif
2049 {
2050 .name = "zonesize",
2051 .type = FIO_OPT_STR_VAL,
2052 .off1 = td_var_offset(zone_size),
2053 .help = "Amount of data to read per zone",
2054 .def = "0",
2055 },
2056 {
2057 .name = "zonerange",
2058 .type = FIO_OPT_STR_VAL,
2059 .off1 = td_var_offset(zone_range),
2060 .help = "Give size of an IO zone",
2061 .def = "0",
2062 },
2063 {
2064 .name = "zoneskip",
2065 .type = FIO_OPT_STR_VAL,
2066 .off1 = td_var_offset(zone_skip),
2067 .help = "Space between IO zones",
2068 .def = "0",
2069 },
2070 {
2071 .name = "lockmem",
2072 .type = FIO_OPT_STR_VAL,
2073 .cb = str_lockmem_cb,
2074 .help = "Lock down this amount of memory",
2075 .def = "0",
2076 },
2077 {
2078 .name = "rwmixread",
2079 .type = FIO_OPT_INT,
2080 .cb = str_rwmix_read_cb,
2081 .maxval = 100,
2082 .help = "Percentage of mixed workload that is reads",
2083 .def = "50",
2084 },
2085 {
2086 .name = "rwmixwrite",
2087 .type = FIO_OPT_INT,
2088 .cb = str_rwmix_write_cb,
2089 .maxval = 100,
2090 .help = "Percentage of mixed workload that is writes",
2091 .def = "50",
2092 },
2093 {
2094 .name = "rwmixcycle",
2095 .type = FIO_OPT_DEPRECATED,
2096 },
2097 {
2098 .name = "nice",
2099 .type = FIO_OPT_INT,
2100 .off1 = td_var_offset(nice),
2101 .help = "Set job CPU nice value",
2102 .minval = -19,
2103 .maxval = 20,
2104 .def = "0",
2105 },
2106#ifdef FIO_HAVE_IOPRIO
2107 {
2108 .name = "prio",
2109 .type = FIO_OPT_INT,
2110 .cb = str_prio_cb,
2111 .help = "Set job IO priority value",
2112 .minval = 0,
2113 .maxval = 7,
2114 },
2115 {
2116 .name = "prioclass",
2117 .type = FIO_OPT_INT,
2118 .cb = str_prioclass_cb,
2119 .help = "Set job IO priority class",
2120 .minval = 0,
2121 .maxval = 3,
2122 },
2123#endif
2124 {
2125 .name = "thinktime",
2126 .type = FIO_OPT_INT,
2127 .off1 = td_var_offset(thinktime),
2128 .help = "Idle time between IO buffers (usec)",
2129 .def = "0",
2130 },
2131 {
2132 .name = "thinktime_spin",
2133 .type = FIO_OPT_INT,
2134 .off1 = td_var_offset(thinktime_spin),
2135 .help = "Start think time by spinning this amount (usec)",
2136 .def = "0",
2137 .parent = "thinktime",
2138 },
2139 {
2140 .name = "thinktime_blocks",
2141 .type = FIO_OPT_INT,
2142 .off1 = td_var_offset(thinktime_blocks),
2143 .help = "IO buffer period between 'thinktime'",
2144 .def = "1",
2145 .parent = "thinktime",
2146 },
2147 {
2148 .name = "rate",
2149 .type = FIO_OPT_INT,
2150 .off1 = td_var_offset(rate[DDIR_READ]),
2151 .off2 = td_var_offset(rate[DDIR_WRITE]),
2152 .off3 = td_var_offset(rate[DDIR_TRIM]),
2153 .help = "Set bandwidth rate",
2154 },
2155 {
2156 .name = "ratemin",
2157 .type = FIO_OPT_INT,
2158 .off1 = td_var_offset(ratemin[DDIR_READ]),
2159 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
2160 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
2161 .help = "Job must meet this rate or it will be shutdown",
2162 .parent = "rate",
2163 },
2164 {
2165 .name = "rate_iops",
2166 .type = FIO_OPT_INT,
2167 .off1 = td_var_offset(rate_iops[DDIR_READ]),
2168 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
2169 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
2170 .help = "Limit IO used to this number of IO operations/sec",
2171 },
2172 {
2173 .name = "rate_iops_min",
2174 .type = FIO_OPT_INT,
2175 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
2176 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
2177 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
2178 .help = "Job must meet this rate or it will be shut down",
2179 .parent = "rate_iops",
2180 },
2181 {
2182 .name = "ratecycle",
2183 .type = FIO_OPT_INT,
2184 .off1 = td_var_offset(ratecycle),
2185 .help = "Window average for rate limits (msec)",
2186 .def = "1000",
2187 .parent = "rate",
2188 },
2189 {
2190 .name = "max_latency",
2191 .type = FIO_OPT_INT,
2192 .off1 = td_var_offset(max_latency),
2193 .help = "Maximum tolerated IO latency (usec)",
2194 },
2195 {
2196 .name = "invalidate",
2197 .type = FIO_OPT_BOOL,
2198 .off1 = td_var_offset(invalidate_cache),
2199 .help = "Invalidate buffer/page cache prior to running job",
2200 .def = "1",
2201 },
2202 {
2203 .name = "sync",
2204 .type = FIO_OPT_BOOL,
2205 .off1 = td_var_offset(sync_io),
2206 .help = "Use O_SYNC for buffered writes",
2207 .def = "0",
2208 .parent = "buffered",
2209 },
2210 {
2211 .name = "bwavgtime",
2212 .type = FIO_OPT_INT,
2213 .off1 = td_var_offset(bw_avg_time),
2214 .help = "Time window over which to calculate bandwidth"
2215 " (msec)",
2216 .def = "500",
2217 .parent = "write_bw_log",
2218 },
2219 {
2220 .name = "iopsavgtime",
2221 .type = FIO_OPT_INT,
2222 .off1 = td_var_offset(iops_avg_time),
2223 .help = "Time window over which to calculate IOPS (msec)",
2224 .def = "500",
2225 .parent = "write_iops_log",
2226 },
2227 {
2228 .name = "create_serialize",
2229 .type = FIO_OPT_BOOL,
2230 .off1 = td_var_offset(create_serialize),
2231 .help = "Serialize creating of job files",
2232 .def = "1",
2233 },
2234 {
2235 .name = "create_fsync",
2236 .type = FIO_OPT_BOOL,
2237 .off1 = td_var_offset(create_fsync),
2238 .help = "fsync file after creation",
2239 .def = "1",
2240 },
2241 {
2242 .name = "create_on_open",
2243 .type = FIO_OPT_BOOL,
2244 .off1 = td_var_offset(create_on_open),
2245 .help = "Create files when they are opened for IO",
2246 .def = "0",
2247 },
2248 {
2249 .name = "create_only",
2250 .type = FIO_OPT_BOOL,
2251 .off1 = td_var_offset(create_only),
2252 .help = "Only perform file creation phase",
2253 .def = "0",
2254 },
2255 {
2256 .name = "pre_read",
2257 .type = FIO_OPT_BOOL,
2258 .off1 = td_var_offset(pre_read),
2259 .help = "Pre-read files before starting official testing",
2260 .def = "0",
2261 },
2262 {
2263 .name = "cpuload",
2264 .type = FIO_OPT_INT,
2265 .off1 = td_var_offset(cpuload),
2266 .help = "Use this percentage of CPU",
2267 },
2268 {
2269 .name = "cpuchunks",
2270 .type = FIO_OPT_INT,
2271 .off1 = td_var_offset(cpucycle),
2272 .help = "Length of the CPU burn cycles (usecs)",
2273 .def = "50000",
2274 .parent = "cpuload",
2275 },
2276#ifdef FIO_HAVE_CPU_AFFINITY
2277 {
2278 .name = "cpumask",
2279 .type = FIO_OPT_INT,
2280 .cb = str_cpumask_cb,
2281 .help = "CPU affinity mask",
2282 },
2283 {
2284 .name = "cpus_allowed",
2285 .type = FIO_OPT_STR,
2286 .cb = str_cpus_allowed_cb,
2287 .help = "Set CPUs allowed",
2288 },
2289#endif
2290#ifdef CONFIG_LIBNUMA
2291 {
2292 .name = "numa_cpu_nodes",
2293 .type = FIO_OPT_STR,
2294 .cb = str_numa_cpunodes_cb,
2295 .help = "NUMA CPU nodes bind",
2296 },
2297 {
2298 .name = "numa_mem_policy",
2299 .type = FIO_OPT_STR,
2300 .cb = str_numa_mpol_cb,
2301 .help = "NUMA memory policy setup",
2302 },
2303#endif
2304 {
2305 .name = "end_fsync",
2306 .type = FIO_OPT_BOOL,
2307 .off1 = td_var_offset(end_fsync),
2308 .help = "Include fsync at the end of job",
2309 .def = "0",
2310 },
2311 {
2312 .name = "fsync_on_close",
2313 .type = FIO_OPT_BOOL,
2314 .off1 = td_var_offset(fsync_on_close),
2315 .help = "fsync files on close",
2316 .def = "0",
2317 },
2318 {
2319 .name = "unlink",
2320 .type = FIO_OPT_BOOL,
2321 .off1 = td_var_offset(unlink),
2322 .help = "Unlink created files after job has completed",
2323 .def = "0",
2324 },
2325 {
2326 .name = "exitall",
2327 .type = FIO_OPT_STR_SET,
2328 .cb = str_exitall_cb,
2329 .help = "Terminate all jobs when one exits",
2330 },
2331 {
2332 .name = "stonewall",
2333 .alias = "wait_for_previous",
2334 .type = FIO_OPT_STR_SET,
2335 .off1 = td_var_offset(stonewall),
2336 .help = "Insert a hard barrier between this job and previous",
2337 },
2338 {
2339 .name = "new_group",
2340 .type = FIO_OPT_STR_SET,
2341 .off1 = td_var_offset(new_group),
2342 .help = "Mark the start of a new group (for reporting)",
2343 },
2344 {
2345 .name = "thread",
2346 .type = FIO_OPT_STR_SET,
2347 .off1 = td_var_offset(use_thread),
2348 .help = "Use threads instead of forks",
2349 },
2350 {
2351 .name = "write_bw_log",
2352 .type = FIO_OPT_STR,
2353 .off1 = td_var_offset(write_bw_log),
2354 .cb = str_write_bw_log_cb,
2355 .help = "Write log of bandwidth during run",
2356 },
2357 {
2358 .name = "write_lat_log",
2359 .type = FIO_OPT_STR,
2360 .off1 = td_var_offset(write_lat_log),
2361 .cb = str_write_lat_log_cb,
2362 .help = "Write log of latency during run",
2363 },
2364 {
2365 .name = "write_iops_log",
2366 .type = FIO_OPT_STR,
2367 .off1 = td_var_offset(write_iops_log),
2368 .cb = str_write_iops_log_cb,
2369 .help = "Write log of IOPS during run",
2370 },
2371 {
2372 .name = "log_avg_msec",
2373 .type = FIO_OPT_INT,
2374 .off1 = td_var_offset(log_avg_msec),
2375 .help = "Average bw/iops/lat logs over this period of time",
2376 .def = "0",
2377 },
2378 {
2379 .name = "hugepage-size",
2380 .type = FIO_OPT_INT,
2381 .off1 = td_var_offset(hugepage_size),
2382 .help = "When using hugepages, specify size of each page",
2383 .def = __fio_stringify(FIO_HUGE_PAGE),
2384 },
2385 {
2386 .name = "group_reporting",
2387 .type = FIO_OPT_STR_SET,
2388 .off1 = td_var_offset(group_reporting),
2389 .help = "Do reporting on a per-group basis",
2390 },
2391 {
2392 .name = "zero_buffers",
2393 .type = FIO_OPT_STR_SET,
2394 .off1 = td_var_offset(zero_buffers),
2395 .help = "Init IO buffers to all zeroes",
2396 },
2397 {
2398 .name = "refill_buffers",
2399 .type = FIO_OPT_STR_SET,
2400 .off1 = td_var_offset(refill_buffers),
2401 .help = "Refill IO buffers on every IO submit",
2402 },
2403 {
2404 .name = "scramble_buffers",
2405 .type = FIO_OPT_BOOL,
2406 .off1 = td_var_offset(scramble_buffers),
2407 .help = "Slightly scramble buffers on every IO submit",
2408 .def = "1",
2409 },
2410 {
2411 .name = "buffer_compress_percentage",
2412 .type = FIO_OPT_INT,
2413 .off1 = td_var_offset(compress_percentage),
2414 .maxval = 100,
2415 .minval = 1,
2416 .help = "How compressible the buffer is (approximately)",
2417 },
2418 {
2419 .name = "buffer_compress_chunk",
2420 .type = FIO_OPT_INT,
2421 .off1 = td_var_offset(compress_chunk),
2422 .parent = "buffer_compress_percentage",
2423 .help = "Size of compressible region in buffer",
2424 },
2425 {
2426 .name = "clat_percentiles",
2427 .type = FIO_OPT_BOOL,
2428 .off1 = td_var_offset(clat_percentiles),
2429 .help = "Enable the reporting of completion latency percentiles",
2430 .def = "1",
2431 },
2432 {
2433 .name = "percentile_list",
2434 .type = FIO_OPT_FLOAT_LIST,
2435 .off1 = td_var_offset(percentile_list),
2436 .off2 = td_var_offset(overwrite_plist),
2437 .help = "Specify a custom list of percentiles to report",
2438 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2439 .minfp = 0.0,
2440 .maxfp = 100.0,
2441 },
2442
2443#ifdef FIO_HAVE_DISK_UTIL
2444 {
2445 .name = "disk_util",
2446 .type = FIO_OPT_BOOL,
2447 .off1 = td_var_offset(do_disk_util),
2448 .help = "Log disk utilization statistics",
2449 .def = "1",
2450 },
2451#endif
2452 {
2453 .name = "gtod_reduce",
2454 .type = FIO_OPT_BOOL,
2455 .help = "Greatly reduce number of gettimeofday() calls",
2456 .cb = str_gtod_reduce_cb,
2457 .def = "0",
2458 },
2459 {
2460 .name = "disable_lat",
2461 .type = FIO_OPT_BOOL,
2462 .off1 = td_var_offset(disable_lat),
2463 .help = "Disable latency numbers",
2464 .parent = "gtod_reduce",
2465 .def = "0",
2466 },
2467 {
2468 .name = "disable_clat",
2469 .type = FIO_OPT_BOOL,
2470 .off1 = td_var_offset(disable_clat),
2471 .help = "Disable completion latency numbers",
2472 .parent = "gtod_reduce",
2473 .def = "0",
2474 },
2475 {
2476 .name = "disable_slat",
2477 .type = FIO_OPT_BOOL,
2478 .off1 = td_var_offset(disable_slat),
2479 .help = "Disable submission latency numbers",
2480 .parent = "gtod_reduce",
2481 .def = "0",
2482 },
2483 {
2484 .name = "disable_bw_measurement",
2485 .type = FIO_OPT_BOOL,
2486 .off1 = td_var_offset(disable_bw),
2487 .help = "Disable bandwidth logging",
2488 .parent = "gtod_reduce",
2489 .def = "0",
2490 },
2491 {
2492 .name = "gtod_cpu",
2493 .type = FIO_OPT_INT,
2494 .cb = str_gtod_cpu_cb,
2495 .help = "Set up dedicated gettimeofday() thread on this CPU",
2496 .verify = gtod_cpu_verify,
2497 },
2498 {
2499 .name = "continue_on_error",
2500 .type = FIO_OPT_STR,
2501 .off1 = td_var_offset(continue_on_error),
2502 .help = "Continue on non-fatal errors during IO",
2503 .def = "none",
2504 .posval = {
2505 { .ival = "none",
2506 .oval = ERROR_TYPE_NONE,
2507 .help = "Exit when an error is encountered",
2508 },
2509 { .ival = "read",
2510 .oval = ERROR_TYPE_READ,
2511 .help = "Continue on read errors only",
2512 },
2513 { .ival = "write",
2514 .oval = ERROR_TYPE_WRITE,
2515 .help = "Continue on write errors only",
2516 },
2517 { .ival = "io",
2518 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2519 .help = "Continue on any IO errors",
2520 },
2521 { .ival = "verify",
2522 .oval = ERROR_TYPE_VERIFY,
2523 .help = "Continue on verify errors only",
2524 },
2525 { .ival = "all",
2526 .oval = ERROR_TYPE_ANY,
2527 .help = "Continue on all io and verify errors",
2528 },
2529 { .ival = "0",
2530 .oval = ERROR_TYPE_NONE,
2531 .help = "Alias for 'none'",
2532 },
2533 { .ival = "1",
2534 .oval = ERROR_TYPE_ANY,
2535 .help = "Alias for 'all'",
2536 },
2537 },
2538 },
2539 {
2540 .name = "ignore_error",
2541 .type = FIO_OPT_STR,
2542 .cb = str_ignore_error_cb,
2543 .help = "Set a specific list of errors to ignore",
2544 .parent = "rw",
2545 },
2546 {
2547 .name = "error_dump",
2548 .type = FIO_OPT_BOOL,
2549 .off1 = td_var_offset(error_dump),
2550 .def = "0",
2551 .help = "Dump info on each error",
2552 },
2553
2554 {
2555 .name = "profile",
2556 .type = FIO_OPT_STR_STORE,
2557 .off1 = td_var_offset(profile),
2558 .help = "Select a specific builtin performance test",
2559 },
2560 {
2561 .name = "cgroup",
2562 .type = FIO_OPT_STR_STORE,
2563 .off1 = td_var_offset(cgroup),
2564 .help = "Add job to cgroup of this name",
2565 },
2566 {
2567 .name = "cgroup_weight",
2568 .type = FIO_OPT_INT,
2569 .off1 = td_var_offset(cgroup_weight),
2570 .help = "Use given weight for cgroup",
2571 .minval = 100,
2572 .maxval = 1000,
2573 },
2574 {
2575 .name = "cgroup_nodelete",
2576 .type = FIO_OPT_BOOL,
2577 .off1 = td_var_offset(cgroup_nodelete),
2578 .help = "Do not delete cgroups after job completion",
2579 .def = "0",
2580 },
2581 {
2582 .name = "uid",
2583 .type = FIO_OPT_INT,
2584 .off1 = td_var_offset(uid),
2585 .help = "Run job with this user ID",
2586 },
2587 {
2588 .name = "gid",
2589 .type = FIO_OPT_INT,
2590 .off1 = td_var_offset(gid),
2591 .help = "Run job with this group ID",
2592 },
2593 {
2594 .name = "flow_id",
2595 .type = FIO_OPT_INT,
2596 .off1 = td_var_offset(flow_id),
2597 .help = "The flow index ID to use",
2598 .def = "0",
2599 },
2600 {
2601 .name = "flow",
2602 .type = FIO_OPT_INT,
2603 .off1 = td_var_offset(flow),
2604 .help = "Weight for flow control of this job",
2605 .parent = "flow_id",
2606 .def = "0",
2607 },
2608 {
2609 .name = "flow_watermark",
2610 .type = FIO_OPT_INT,
2611 .off1 = td_var_offset(flow_watermark),
2612 .help = "High watermark for flow control. This option"
2613 " should be set to the same value for all threads"
2614 " with non-zero flow.",
2615 .parent = "flow_id",
2616 .def = "1024",
2617 },
2618 {
2619 .name = "flow_sleep",
2620 .type = FIO_OPT_INT,
2621 .off1 = td_var_offset(flow_sleep),
2622 .help = "How many microseconds to sleep after being held"
2623 " back by the flow control mechanism",
2624 .parent = "flow_id",
2625 .def = "0",
2626 },
2627 {
2628 .name = NULL,
2629 },
2630};
2631
2632static void add_to_lopt(struct option *lopt, struct fio_option *o,
2633 const char *name, int val)
2634{
2635 lopt->name = (char *) name;
2636 lopt->val = val;
2637 if (o->type == FIO_OPT_STR_SET)
2638 lopt->has_arg = no_argument;
2639 else
2640 lopt->has_arg = required_argument;
2641}
2642
2643static void options_to_lopts(struct fio_option *opts,
2644 struct option *long_options,
2645 int i, int option_type)
2646{
2647 struct fio_option *o = &opts[0];
2648 while (o->name) {
2649 add_to_lopt(&long_options[i], o, o->name, option_type);
2650 if (o->alias) {
2651 i++;
2652 add_to_lopt(&long_options[i], o, o->alias, option_type);
2653 }
2654
2655 i++;
2656 o++;
2657 assert(i < FIO_NR_OPTIONS);
2658 }
2659}
2660
2661void fio_options_set_ioengine_opts(struct option *long_options,
2662 struct thread_data *td)
2663{
2664 unsigned int i;
2665
2666 i = 0;
2667 while (long_options[i].name) {
2668 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2669 memset(&long_options[i], 0, sizeof(*long_options));
2670 break;
2671 }
2672 i++;
2673 }
2674
2675 /*
2676 * Just clear out the prior ioengine options.
2677 */
2678 if (!td || !td->eo)
2679 return;
2680
2681 options_to_lopts(td->io_ops->options, long_options, i,
2682 FIO_GETOPT_IOENGINE);
2683}
2684
2685void fio_options_dup_and_init(struct option *long_options)
2686{
2687 unsigned int i;
2688
2689 options_init(options);
2690
2691 i = 0;
2692 while (long_options[i].name)
2693 i++;
2694
2695 options_to_lopts(options, long_options, i, FIO_GETOPT_JOB);
2696}
2697
2698struct fio_keyword {
2699 const char *word;
2700 const char *desc;
2701 char *replace;
2702};
2703
2704static struct fio_keyword fio_keywords[] = {
2705 {
2706 .word = "$pagesize",
2707 .desc = "Page size in the system",
2708 },
2709 {
2710 .word = "$mb_memory",
2711 .desc = "Megabytes of memory online",
2712 },
2713 {
2714 .word = "$ncpus",
2715 .desc = "Number of CPUs online in the system",
2716 },
2717 {
2718 .word = NULL,
2719 },
2720};
2721
2722void fio_keywords_init(void)
2723{
2724 unsigned long long mb_memory;
2725 char buf[128];
2726 long l;
2727
2728 sprintf(buf, "%lu", (unsigned long) page_size);
2729 fio_keywords[0].replace = strdup(buf);
2730
2731 mb_memory = os_phys_mem() / (1024 * 1024);
2732 sprintf(buf, "%llu", mb_memory);
2733 fio_keywords[1].replace = strdup(buf);
2734
2735 l = cpus_online();
2736 sprintf(buf, "%lu", l);
2737 fio_keywords[2].replace = strdup(buf);
2738}
2739
2740#define BC_APP "bc"
2741
2742static char *bc_calc(char *str)
2743{
2744 char buf[128], *tmp;
2745 FILE *f;
2746 int ret;
2747
2748 /*
2749 * No math, just return string
2750 */
2751 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2752 !strchr(str, '/')) || strchr(str, '\''))
2753 return str;
2754
2755 /*
2756 * Split option from value, we only need to calculate the value
2757 */
2758 tmp = strchr(str, '=');
2759 if (!tmp)
2760 return str;
2761
2762 tmp++;
2763
2764 /*
2765 * Prevent buffer overflows; such a case isn't reasonable anyway
2766 */
2767 if (strlen(str) >= 128 || strlen(tmp) > 100)
2768 return str;
2769
2770 sprintf(buf, "which %s > /dev/null", BC_APP);
2771 if (system(buf)) {
2772 log_err("fio: bc is needed for performing math\n");
2773 return NULL;
2774 }
2775
2776 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2777 f = popen(buf, "r");
2778 if (!f) {
2779 return NULL;
2780 }
2781
2782 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2783 if (ret <= 0) {
2784 return NULL;
2785 }
2786
2787 pclose(f);
2788 buf[(tmp - str) + ret - 1] = '\0';
2789 memcpy(buf, str, tmp - str);
2790 free(str);
2791 return strdup(buf);
2792}
2793
2794/*
2795 * Return a copy of the input string with substrings of the form ${VARNAME}
2796 * substituted with the value of the environment variable VARNAME. The
2797 * substitution always occurs, even if VARNAME is empty or the corresponding
2798 * environment variable undefined.
2799 */
2800static char *option_dup_subs(const char *opt)
2801{
2802 char out[OPT_LEN_MAX+1];
2803 char in[OPT_LEN_MAX+1];
2804 char *outptr = out;
2805 char *inptr = in;
2806 char *ch1, *ch2, *env;
2807 ssize_t nchr = OPT_LEN_MAX;
2808 size_t envlen;
2809
2810 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2811 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2812 return NULL;
2813 }
2814
2815 in[OPT_LEN_MAX] = '\0';
2816 strncpy(in, opt, OPT_LEN_MAX);
2817
2818 while (*inptr && nchr > 0) {
2819 if (inptr[0] == '$' && inptr[1] == '{') {
2820 ch2 = strchr(inptr, '}');
2821 if (ch2 && inptr+1 < ch2) {
2822 ch1 = inptr+2;
2823 inptr = ch2+1;
2824 *ch2 = '\0';
2825
2826 env = getenv(ch1);
2827 if (env) {
2828 envlen = strlen(env);
2829 if (envlen <= nchr) {
2830 memcpy(outptr, env, envlen);
2831 outptr += envlen;
2832 nchr -= envlen;
2833 }
2834 }
2835
2836 continue;
2837 }
2838 }
2839
2840 *outptr++ = *inptr++;
2841 --nchr;
2842 }
2843
2844 *outptr = '\0';
2845 return strdup(out);
2846}
2847
2848/*
2849 * Look for reserved variable names and replace them with real values
2850 */
2851static char *fio_keyword_replace(char *opt)
2852{
2853 char *s;
2854 int i;
2855 int docalc = 0;
2856
2857 for (i = 0; fio_keywords[i].word != NULL; i++) {
2858 struct fio_keyword *kw = &fio_keywords[i];
2859
2860 while ((s = strstr(opt, kw->word)) != NULL) {
2861 char *new = malloc(strlen(opt) + 1);
2862 char *o_org = opt;
2863 int olen = s - opt;
2864 int len;
2865
2866 /*
2867 * Copy part of the string before the keyword and
2868 * sprintf() the replacement after it.
2869 */
2870 memcpy(new, opt, olen);
2871 len = sprintf(new + olen, "%s", kw->replace);
2872
2873 /*
2874 * If there's more in the original string, copy that
2875 * in too
2876 */
2877 opt += strlen(kw->word) + olen;
2878 if (strlen(opt))
2879 memcpy(new + olen + len, opt, opt - o_org - 1);
2880
2881 /*
2882 * replace opt and free the old opt
2883 */
2884 opt = new;
2885 free(o_org);
2886
2887 docalc = 1;
2888 }
2889 }
2890
2891 /*
2892 * Check for potential math and invoke bc, if possible
2893 */
2894 if (docalc)
2895 opt = bc_calc(opt);
2896
2897 return opt;
2898}
2899
2900static char **dup_and_sub_options(char **opts, int num_opts)
2901{
2902 int i;
2903 char **opts_copy = malloc(num_opts * sizeof(*opts));
2904 for (i = 0; i < num_opts; i++) {
2905 opts_copy[i] = option_dup_subs(opts[i]);
2906 if (!opts_copy[i])
2907 continue;
2908 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2909 }
2910 return opts_copy;
2911}
2912
2913int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2914{
2915 int i, ret, unknown;
2916 char **opts_copy;
2917
2918 sort_options(opts, options, num_opts);
2919 opts_copy = dup_and_sub_options(opts, num_opts);
2920
2921 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2922 struct fio_option *o;
2923 int newret = parse_option(opts_copy[i], opts[i], options, &o,
2924 td);
2925
2926 if (opts_copy[i]) {
2927 if (newret && !o) {
2928 unknown++;
2929 continue;
2930 }
2931 free(opts_copy[i]);
2932 opts_copy[i] = NULL;
2933 }
2934
2935 ret |= newret;
2936 }
2937
2938 if (unknown) {
2939 ret |= ioengine_load(td);
2940 if (td->eo) {
2941 sort_options(opts_copy, td->io_ops->options, num_opts);
2942 opts = opts_copy;
2943 }
2944 for (i = 0; i < num_opts; i++) {
2945 struct fio_option *o = NULL;
2946 int newret = 1;
2947 if (!opts_copy[i])
2948 continue;
2949
2950 if (td->eo)
2951 newret = parse_option(opts_copy[i], opts[i],
2952 td->io_ops->options, &o,
2953 td->eo);
2954
2955 ret |= newret;
2956 if (!o)
2957 log_err("Bad option <%s>\n", opts[i]);
2958
2959 free(opts_copy[i]);
2960 opts_copy[i] = NULL;
2961 }
2962 }
2963
2964 free(opts_copy);
2965 return ret;
2966}
2967
2968int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2969{
2970 return parse_cmd_option(opt, val, options, td);
2971}
2972
2973int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2974 char *val)
2975{
2976 return parse_cmd_option(opt, val, td->io_ops->options, td);
2977}
2978
2979void fio_fill_default_options(struct thread_data *td)
2980{
2981 fill_default_options(td, options);
2982}
2983
2984int fio_show_option_help(const char *opt)
2985{
2986 return show_cmd_help(options, opt);
2987}
2988
2989void options_mem_dupe(void *data, struct fio_option *options)
2990{
2991 struct fio_option *o;
2992 char **ptr;
2993
2994 for (o = &options[0]; o->name; o++) {
2995 if (o->type != FIO_OPT_STR_STORE)
2996 continue;
2997
2998 ptr = td_var(data, o->off1);
2999 if (*ptr)
3000 *ptr = strdup(*ptr);
3001 }
3002}
3003
3004/*
3005 * dupe FIO_OPT_STR_STORE options
3006 */
3007void fio_options_mem_dupe(struct thread_data *td)
3008{
3009 options_mem_dupe(&td->o, options);
3010
3011 if (td->eo && td->io_ops) {
3012 void *oldeo = td->eo;
3013
3014 td->eo = malloc(td->io_ops->option_struct_size);
3015 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3016 options_mem_dupe(td->eo, td->io_ops->options);
3017 }
3018}
3019
3020unsigned int fio_get_kb_base(void *data)
3021{
3022 struct thread_data *td = data;
3023 unsigned int kb_base = 0;
3024
3025 if (td)
3026 kb_base = td->o.kb_base;
3027 if (!kb_base)
3028 kb_base = 1024;
3029
3030 return kb_base;
3031}
3032
3033int add_option(struct fio_option *o)
3034{
3035 struct fio_option *__o;
3036 int opt_index = 0;
3037
3038 __o = options;
3039 while (__o->name) {
3040 opt_index++;
3041 __o++;
3042 }
3043
3044 memcpy(&options[opt_index], o, sizeof(*o));
3045 return 0;
3046}
3047
3048void invalidate_profile_options(const char *prof_name)
3049{
3050 struct fio_option *o;
3051
3052 o = options;
3053 while (o->name) {
3054 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3055 o->type = FIO_OPT_INVALID;
3056 o->prof_name = NULL;
3057 }
3058 o++;
3059 }
3060}
3061
3062void add_opt_posval(const char *optname, const char *ival, const char *help)
3063{
3064 struct fio_option *o;
3065 unsigned int i;
3066
3067 o = find_option(options, optname);
3068 if (!o)
3069 return;
3070
3071 for (i = 0; i < PARSE_MAX_VP; i++) {
3072 if (o->posval[i].ival)
3073 continue;
3074
3075 o->posval[i].ival = ival;
3076 o->posval[i].help = help;
3077 break;
3078 }
3079}
3080
3081void del_opt_posval(const char *optname, const char *ival)
3082{
3083 struct fio_option *o;
3084 unsigned int i;
3085
3086 o = find_option(options, optname);
3087 if (!o)
3088 return;
3089
3090 for (i = 0; i < PARSE_MAX_VP; i++) {
3091 if (!o->posval[i].ival)
3092 continue;
3093 if (strcmp(o->posval[i].ival, ival))
3094 continue;
3095
3096 o->posval[i].ival = NULL;
3097 o->posval[i].help = NULL;
3098 }
3099}
3100
3101void fio_options_free(struct thread_data *td)
3102{
3103 options_free(options, td);
3104 if (td->eo && td->io_ops && td->io_ops->options) {
3105 options_free(td->io_ops->options, td->eo);
3106 free(td->eo);
3107 td->eo = NULL;
3108 }
3109}
fio - Flexible IO Tester