Fix _SC_NPROCESSORS_ONLN on Windows
[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
348 return 0;
349}
350
351static int str_verify_cb(void *data, const char *mem)
352{
353 struct thread_data *td = data;
354
355 if (td->o.verify == VERIFY_CRC32C_INTEL ||
356 td->o.verify == VERIFY_CRC32C) {
357 crc32c_intel_probe();
358 }
359
360 return 0;
361}
362
363static int fio_clock_source_cb(void *data, const char *str)
364{
365 struct thread_data *td = data;
366
367 fio_clock_source = td->o.clocksource;
368 fio_clock_source_set = 1;
369 fio_clock_init();
370 return 0;
371}
372
373static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
374{
375 mlock_size = *val;
376 return 0;
377}
378
379static int str_rwmix_read_cb(void *data, unsigned long long *val)
380{
381 struct thread_data *td = data;
382
383 td->o.rwmix[DDIR_READ] = *val;
384 td->o.rwmix[DDIR_WRITE] = 100 - *val;
385 return 0;
386}
387
388static int str_rwmix_write_cb(void *data, unsigned long long *val)
389{
390 struct thread_data *td = data;
391
392 td->o.rwmix[DDIR_WRITE] = *val;
393 td->o.rwmix[DDIR_READ] = 100 - *val;
394 return 0;
395}
396
397#ifdef FIO_HAVE_IOPRIO
398static int str_prioclass_cb(void *data, unsigned long long *val)
399{
400 struct thread_data *td = data;
401 unsigned short mask;
402
403 /*
404 * mask off old class bits, str_prio_cb() may have set a default class
405 */
406 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
407 td->ioprio &= mask;
408
409 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
410 td->ioprio_set = 1;
411 return 0;
412}
413
414static int str_prio_cb(void *data, unsigned long long *val)
415{
416 struct thread_data *td = data;
417
418 td->ioprio |= *val;
419
420 /*
421 * If no class is set, assume BE
422 */
423 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
424 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
425
426 td->ioprio_set = 1;
427 return 0;
428}
429#endif
430
431static int str_exitall_cb(void)
432{
433 exitall_on_terminate = 1;
434 return 0;
435}
436
437#ifdef FIO_HAVE_CPU_AFFINITY
438static int str_cpumask_cb(void *data, unsigned long long *val)
439{
440 struct thread_data *td = data;
441 unsigned int i;
442 long max_cpu;
443 int ret;
444
445 ret = fio_cpuset_init(&td->o.cpumask);
446 if (ret < 0) {
447 log_err("fio: cpuset_init failed\n");
448 td_verror(td, ret, "fio_cpuset_init");
449 return 1;
450 }
451
452 max_cpu = cpus_online();
453
454 for (i = 0; i < sizeof(int) * 8; i++) {
455 if ((1 << i) & *val) {
456 if (i > max_cpu) {
457 log_err("fio: CPU %d too large (max=%ld)\n", i,
458 max_cpu);
459 return 1;
460 }
461 dprint(FD_PARSE, "set cpu allowed %d\n", i);
462 fio_cpu_set(&td->o.cpumask, i);
463 }
464 }
465
466 td->o.cpumask_set = 1;
467 return 0;
468}
469
470static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
471 const char *input)
472{
473 char *cpu, *str, *p;
474 long max_cpu;
475 int ret = 0;
476
477 ret = fio_cpuset_init(mask);
478 if (ret < 0) {
479 log_err("fio: cpuset_init failed\n");
480 td_verror(td, ret, "fio_cpuset_init");
481 return 1;
482 }
483
484 p = str = strdup(input);
485
486 strip_blank_front(&str);
487 strip_blank_end(str);
488
489 max_cpu = cpus_online();
490
491 while ((cpu = strsep(&str, ",")) != NULL) {
492 char *str2, *cpu2;
493 int icpu, icpu2;
494
495 if (!strlen(cpu))
496 break;
497
498 str2 = cpu;
499 icpu2 = -1;
500 while ((cpu2 = strsep(&str2, "-")) != NULL) {
501 if (!strlen(cpu2))
502 break;
503
504 icpu2 = atoi(cpu2);
505 }
506
507 icpu = atoi(cpu);
508 if (icpu2 == -1)
509 icpu2 = icpu;
510 while (icpu <= icpu2) {
511 if (icpu >= FIO_MAX_CPUS) {
512 log_err("fio: your OS only supports up to"
513 " %d CPUs\n", (int) FIO_MAX_CPUS);
514 ret = 1;
515 break;
516 }
517 if (icpu > max_cpu) {
518 log_err("fio: CPU %d too large (max=%ld)\n",
519 icpu, max_cpu);
520 ret = 1;
521 break;
522 }
523
524 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
525 fio_cpu_set(mask, icpu);
526 icpu++;
527 }
528 if (ret)
529 break;
530 }
531
532 free(p);
533 if (!ret)
534 td->o.cpumask_set = 1;
535 return ret;
536}
537
538static int str_cpus_allowed_cb(void *data, const char *input)
539{
540 struct thread_data *td = data;
541 int ret;
542
543 ret = set_cpus_allowed(td, &td->o.cpumask, input);
544 if (!ret)
545 td->o.cpumask_set = 1;
546
547 return ret;
548}
549
550static int str_verify_cpus_allowed_cb(void *data, const char *input)
551{
552 struct thread_data *td = data;
553 int ret;
554
555 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
556 if (!ret)
557 td->o.verify_cpumask_set = 1;
558
559 return ret;
560}
561#endif
562
563#ifdef CONFIG_LIBNUMA
564static int str_numa_cpunodes_cb(void *data, char *input)
565{
566 struct thread_data *td = data;
567
568 /* numa_parse_nodestring() parses a character string list
569 * of nodes into a bit mask. The bit mask is allocated by
570 * numa_allocate_nodemask(), so it should be freed by
571 * numa_free_nodemask().
572 */
573 td->o.numa_cpunodesmask = numa_parse_nodestring(input);
574 if (td->o.numa_cpunodesmask == NULL) {
575 log_err("fio: numa_parse_nodestring failed\n");
576 td_verror(td, 1, "str_numa_cpunodes_cb");
577 return 1;
578 }
579
580 td->o.numa_cpumask_set = 1;
581 return 0;
582}
583
584static int str_numa_mpol_cb(void *data, char *input)
585{
586 struct thread_data *td = data;
587 const char * const policy_types[] =
588 { "default", "prefer", "bind", "interleave", "local" };
589 int i;
590
591 char *nodelist = strchr(input, ':');
592 if (nodelist) {
593 /* NUL-terminate mode */
594 *nodelist++ = '\0';
595 }
596
597 for (i = 0; i <= MPOL_LOCAL; i++) {
598 if (!strcmp(input, policy_types[i])) {
599 td->o.numa_mem_mode = i;
600 break;
601 }
602 }
603 if (i > MPOL_LOCAL) {
604 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
605 goto out;
606 }
607
608 switch (td->o.numa_mem_mode) {
609 case MPOL_PREFERRED:
610 /*
611 * Insist on a nodelist of one node only
612 */
613 if (nodelist) {
614 char *rest = nodelist;
615 while (isdigit(*rest))
616 rest++;
617 if (*rest) {
618 log_err("fio: one node only for \'prefer\'\n");
619 goto out;
620 }
621 } else {
622 log_err("fio: one node is needed for \'prefer\'\n");
623 goto out;
624 }
625 break;
626 case MPOL_INTERLEAVE:
627 /*
628 * Default to online nodes with memory if no nodelist
629 */
630 if (!nodelist)
631 nodelist = strdup("all");
632 break;
633 case MPOL_LOCAL:
634 case MPOL_DEFAULT:
635 /*
636 * Don't allow a nodelist
637 */
638 if (nodelist) {
639 log_err("fio: NO nodelist for \'local\'\n");
640 goto out;
641 }
642 break;
643 case MPOL_BIND:
644 /*
645 * Insist on a nodelist
646 */
647 if (!nodelist) {
648 log_err("fio: a nodelist is needed for \'bind\'\n");
649 goto out;
650 }
651 break;
652 }
653
654
655 /* numa_parse_nodestring() parses a character string list
656 * of nodes into a bit mask. The bit mask is allocated by
657 * numa_allocate_nodemask(), so it should be freed by
658 * numa_free_nodemask().
659 */
660 switch (td->o.numa_mem_mode) {
661 case MPOL_PREFERRED:
662 td->o.numa_mem_prefer_node = atoi(nodelist);
663 break;
664 case MPOL_INTERLEAVE:
665 case MPOL_BIND:
666 td->o.numa_memnodesmask = numa_parse_nodestring(nodelist);
667 if (td->o.numa_memnodesmask == NULL) {
668 log_err("fio: numa_parse_nodestring failed\n");
669 td_verror(td, 1, "str_numa_memnodes_cb");
670 return 1;
671 }
672 break;
673 case MPOL_LOCAL:
674 case MPOL_DEFAULT:
675 default:
676 break;
677 }
678
679 td->o.numa_memmask_set = 1;
680 return 0;
681
682out:
683 return 1;
684}
685#endif
686
687#ifdef FIO_HAVE_TRIM
688static int str_verify_trim_cb(void *data, unsigned long long *val)
689{
690 struct thread_data *td = data;
691
692 td->o.trim_percentage = *val;
693 return 0;
694}
695#endif
696
697static int str_fst_cb(void *data, const char *str)
698{
699 struct thread_data *td = data;
700 char *nr = get_opt_postfix(str);
701
702 td->file_service_nr = 1;
703 if (nr) {
704 td->file_service_nr = atoi(nr);
705 free(nr);
706 }
707
708 return 0;
709}
710
711#ifdef CONFIG_SYNC_FILE_RANGE
712static int str_sfr_cb(void *data, const char *str)
713{
714 struct thread_data *td = data;
715 char *nr = get_opt_postfix(str);
716
717 td->sync_file_range_nr = 1;
718 if (nr) {
719 td->sync_file_range_nr = atoi(nr);
720 free(nr);
721 }
722
723 return 0;
724}
725#endif
726
727static int str_random_distribution_cb(void *data, const char *str)
728{
729 struct thread_data *td = data;
730 double val;
731 char *nr;
732
733 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
734 val = 1.1;
735 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
736 val = 0.2;
737 else
738 return 0;
739
740 nr = get_opt_postfix(str);
741 if (nr && !str_to_float(nr, &val)) {
742 log_err("fio: random postfix parsing failed\n");
743 free(nr);
744 return 1;
745 }
746
747 free(nr);
748
749 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
750 if (val == 1.00) {
751 log_err("fio: zipf theta must different than 1.0\n");
752 return 1;
753 }
754 td->o.zipf_theta = val;
755 } else {
756 if (val <= 0.00 || val >= 1.00) {
757 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
758 return 1;
759 }
760 td->o.pareto_h = val;
761 }
762
763 return 0;
764}
765
766static int check_dir(struct thread_data *td, char *fname)
767{
768#if 0
769 char file[PATH_MAX], *dir;
770 int elen = 0;
771
772 if (td->o.directory) {
773 strcpy(file, td->o.directory);
774 strcat(file, "/");
775 elen = strlen(file);
776 }
777
778 sprintf(file + elen, "%s", fname);
779 dir = dirname(file);
780
781 {
782 struct stat sb;
783 /*
784 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
785 * yet, so we can't do this check right here...
786 */
787 if (lstat(dir, &sb) < 0) {
788 int ret = errno;
789
790 log_err("fio: %s is not a directory\n", dir);
791 td_verror(td, ret, "lstat");
792 return 1;
793 }
794
795 if (!S_ISDIR(sb.st_mode)) {
796 log_err("fio: %s is not a directory\n", dir);
797 return 1;
798 }
799 }
800#endif
801
802 return 0;
803}
804
805/*
806 * Return next file in the string. Files are separated with ':'. If the ':'
807 * is escaped with a '\', then that ':' is part of the filename and does not
808 * indicate a new file.
809 */
810static char *get_next_file_name(char **ptr)
811{
812 char *str = *ptr;
813 char *p, *start;
814
815 if (!str || !strlen(str))
816 return NULL;
817
818 start = str;
819 do {
820 /*
821 * No colon, we are done
822 */
823 p = strchr(str, ':');
824 if (!p) {
825 *ptr = NULL;
826 break;
827 }
828
829 /*
830 * We got a colon, but it's the first character. Skip and
831 * continue
832 */
833 if (p == start) {
834 str = ++start;
835 continue;
836 }
837
838 if (*(p - 1) != '\\') {
839 *p = '\0';
840 *ptr = p + 1;
841 break;
842 }
843
844 memmove(p - 1, p, strlen(p) + 1);
845 str = p;
846 } while (1);
847
848 return start;
849}
850
851static int str_filename_cb(void *data, const char *input)
852{
853 struct thread_data *td = data;
854 char *fname, *str, *p;
855
856 p = str = strdup(input);
857
858 strip_blank_front(&str);
859 strip_blank_end(str);
860
861 if (!td->files_index)
862 td->o.nr_files = 0;
863
864 while ((fname = get_next_file_name(&str)) != NULL) {
865 if (!strlen(fname))
866 break;
867 if (check_dir(td, fname)) {
868 free(p);
869 return 1;
870 }
871 add_file(td, fname);
872 td->o.nr_files++;
873 }
874
875 free(p);
876 return 0;
877}
878
879static int str_directory_cb(void *data, const char fio_unused *str)
880{
881 struct thread_data *td = data;
882 struct stat sb;
883
884 if (lstat(td->o.directory, &sb) < 0) {
885 int ret = errno;
886
887 log_err("fio: %s is not a directory\n", td->o.directory);
888 td_verror(td, ret, "lstat");
889 return 1;
890 }
891 if (!S_ISDIR(sb.st_mode)) {
892 log_err("fio: %s is not a directory\n", td->o.directory);
893 return 1;
894 }
895
896 return 0;
897}
898
899static int str_opendir_cb(void *data, const char fio_unused *str)
900{
901 struct thread_data *td = data;
902
903 if (!td->files_index)
904 td->o.nr_files = 0;
905
906 return add_dir_files(td, td->o.opendir);
907}
908
909static int str_verify_offset_cb(void *data, unsigned long long *off)
910{
911 struct thread_data *td = data;
912
913 if (*off && *off < sizeof(struct verify_header)) {
914 log_err("fio: verify_offset too small\n");
915 return 1;
916 }
917
918 td->o.verify_offset = *off;
919 return 0;
920}
921
922static int str_verify_pattern_cb(void *data, const char *input)
923{
924 struct thread_data *td = data;
925 long off;
926 int i = 0, j = 0, len, k, base = 10;
927 char* loc1, * loc2;
928
929 loc1 = strstr(input, "0x");
930 loc2 = strstr(input, "0X");
931 if (loc1 || loc2)
932 base = 16;
933 off = strtol(input, NULL, base);
934 if (off != LONG_MAX || errno != ERANGE) {
935 while (off) {
936 td->o.verify_pattern[i] = off & 0xff;
937 off >>= 8;
938 i++;
939 }
940 } else {
941 len = strlen(input);
942 k = len - 1;
943 if (base == 16) {
944 if (loc1)
945 j = loc1 - input + 2;
946 else
947 j = loc2 - input + 2;
948 } else
949 return 1;
950 if (len - j < MAX_PATTERN_SIZE * 2) {
951 while (k >= j) {
952 off = converthexchartoint(input[k--]);
953 if (k >= j)
954 off += (converthexchartoint(input[k--])
955 * 16);
956 td->o.verify_pattern[i++] = (char) off;
957 }
958 }
959 }
960
961 /*
962 * Fill the pattern all the way to the end. This greatly reduces
963 * the number of memcpy's we have to do when verifying the IO.
964 */
965 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
966 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
967 i *= 2;
968 }
969 if (i == 1) {
970 /*
971 * The code in verify_io_u_pattern assumes a single byte pattern
972 * fills the whole verify pattern buffer.
973 */
974 memset(td->o.verify_pattern, td->o.verify_pattern[0],
975 MAX_PATTERN_SIZE);
976 }
977
978 td->o.verify_pattern_bytes = i;
979
980 /*
981 * VERIFY_META could already be set
982 */
983 if (td->o.verify == VERIFY_NONE)
984 td->o.verify = VERIFY_PATTERN;
985
986 return 0;
987}
988
989static int str_lockfile_cb(void *data, const char *str)
990{
991 struct thread_data *td = data;
992 char *nr = get_opt_postfix(str);
993
994 td->o.lockfile_batch = 1;
995 if (nr) {
996 td->o.lockfile_batch = atoi(nr);
997 free(nr);
998 }
999
1000 return 0;
1001}
1002
1003static int str_write_bw_log_cb(void *data, const char *str)
1004{
1005 struct thread_data *td = data;
1006
1007 if (str)
1008 td->o.bw_log_file = strdup(str);
1009
1010 td->o.write_bw_log = 1;
1011 return 0;
1012}
1013
1014static int str_write_lat_log_cb(void *data, const char *str)
1015{
1016 struct thread_data *td = data;
1017
1018 if (str)
1019 td->o.lat_log_file = strdup(str);
1020
1021 td->o.write_lat_log = 1;
1022 return 0;
1023}
1024
1025static int str_write_iops_log_cb(void *data, const char *str)
1026{
1027 struct thread_data *td = data;
1028
1029 if (str)
1030 td->o.iops_log_file = strdup(str);
1031
1032 td->o.write_iops_log = 1;
1033 return 0;
1034}
1035
1036static int str_gtod_reduce_cb(void *data, int *il)
1037{
1038 struct thread_data *td = data;
1039 int val = *il;
1040
1041 td->o.disable_lat = !!val;
1042 td->o.disable_clat = !!val;
1043 td->o.disable_slat = !!val;
1044 td->o.disable_bw = !!val;
1045 td->o.clat_percentiles = !val;
1046 if (val)
1047 td->tv_cache_mask = 63;
1048
1049 return 0;
1050}
1051
1052static int str_gtod_cpu_cb(void *data, long long *il)
1053{
1054 struct thread_data *td = data;
1055 int val = *il;
1056
1057 td->o.gtod_cpu = val;
1058 td->o.gtod_offload = 1;
1059 return 0;
1060}
1061
1062static int str_size_cb(void *data, unsigned long long *__val)
1063{
1064 struct thread_data *td = data;
1065 unsigned long long v = *__val;
1066
1067 if (parse_is_percent(v)) {
1068 td->o.size = 0;
1069 td->o.size_percent = -1ULL - v;
1070 } else
1071 td->o.size = v;
1072
1073 return 0;
1074}
1075
1076static int rw_verify(struct fio_option *o, void *data)
1077{
1078 struct thread_data *td = data;
1079
1080 if (read_only && td_write(td)) {
1081 log_err("fio: job <%s> has write bit set, but fio is in"
1082 " read-only mode\n", td->o.name);
1083 return 1;
1084 }
1085
1086 return 0;
1087}
1088
1089static int gtod_cpu_verify(struct fio_option *o, void *data)
1090{
1091#ifndef FIO_HAVE_CPU_AFFINITY
1092 struct thread_data *td = data;
1093
1094 if (td->o.gtod_cpu) {
1095 log_err("fio: platform must support CPU affinity for"
1096 "gettimeofday() offloading\n");
1097 return 1;
1098 }
1099#endif
1100
1101 return 0;
1102}
1103
1104static int kb_base_verify(struct fio_option *o, void *data)
1105{
1106 struct thread_data *td = data;
1107
1108 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
1109 log_err("fio: kb_base set to nonsensical value: %u\n",
1110 td->o.kb_base);
1111 return 1;
1112 }
1113
1114 return 0;
1115}
1116
1117/*
1118 * Map of job/command line options
1119 */
1120static struct fio_option options[FIO_MAX_OPTS] = {
1121 {
1122 .name = "description",
1123 .type = FIO_OPT_STR_STORE,
1124 .off1 = td_var_offset(description),
1125 .help = "Text job description",
1126 },
1127 {
1128 .name = "name",
1129 .type = FIO_OPT_STR_STORE,
1130 .off1 = td_var_offset(name),
1131 .help = "Name of this job",
1132 },
1133 {
1134 .name = "directory",
1135 .type = FIO_OPT_STR_STORE,
1136 .off1 = td_var_offset(directory),
1137 .cb = str_directory_cb,
1138 .help = "Directory to store files in",
1139 },
1140 {
1141 .name = "filename",
1142 .type = FIO_OPT_STR_STORE,
1143 .off1 = td_var_offset(filename),
1144 .cb = str_filename_cb,
1145 .prio = -1, /* must come after "directory" */
1146 .help = "File(s) to use for the workload",
1147 },
1148 {
1149 .name = "kb_base",
1150 .type = FIO_OPT_INT,
1151 .off1 = td_var_offset(kb_base),
1152 .verify = kb_base_verify,
1153 .prio = 1,
1154 .def = "1024",
1155 .help = "How many bytes per KB for reporting (1000 or 1024)",
1156 },
1157 {
1158 .name = "lockfile",
1159 .type = FIO_OPT_STR,
1160 .cb = str_lockfile_cb,
1161 .off1 = td_var_offset(file_lock_mode),
1162 .help = "Lock file when doing IO to it",
1163 .parent = "filename",
1164 .def = "none",
1165 .posval = {
1166 { .ival = "none",
1167 .oval = FILE_LOCK_NONE,
1168 .help = "No file locking",
1169 },
1170 { .ival = "exclusive",
1171 .oval = FILE_LOCK_EXCLUSIVE,
1172 .help = "Exclusive file lock",
1173 },
1174 {
1175 .ival = "readwrite",
1176 .oval = FILE_LOCK_READWRITE,
1177 .help = "Read vs write lock",
1178 },
1179 },
1180 },
1181 {
1182 .name = "opendir",
1183 .type = FIO_OPT_STR_STORE,
1184 .off1 = td_var_offset(opendir),
1185 .cb = str_opendir_cb,
1186 .help = "Recursively add files from this directory and down",
1187 },
1188 {
1189 .name = "rw",
1190 .alias = "readwrite",
1191 .type = FIO_OPT_STR,
1192 .cb = str_rw_cb,
1193 .off1 = td_var_offset(td_ddir),
1194 .help = "IO direction",
1195 .def = "read",
1196 .verify = rw_verify,
1197 .posval = {
1198 { .ival = "read",
1199 .oval = TD_DDIR_READ,
1200 .help = "Sequential read",
1201 },
1202 { .ival = "write",
1203 .oval = TD_DDIR_WRITE,
1204 .help = "Sequential write",
1205 },
1206 { .ival = "trim",
1207 .oval = TD_DDIR_TRIM,
1208 .help = "Sequential trim",
1209 },
1210 { .ival = "randread",
1211 .oval = TD_DDIR_RANDREAD,
1212 .help = "Random read",
1213 },
1214 { .ival = "randwrite",
1215 .oval = TD_DDIR_RANDWRITE,
1216 .help = "Random write",
1217 },
1218 { .ival = "randtrim",
1219 .oval = TD_DDIR_RANDTRIM,
1220 .help = "Random trim",
1221 },
1222 { .ival = "rw",
1223 .oval = TD_DDIR_RW,
1224 .help = "Sequential read and write mix",
1225 },
1226 { .ival = "readwrite",
1227 .oval = TD_DDIR_RW,
1228 .help = "Sequential read and write mix",
1229 },
1230 { .ival = "randrw",
1231 .oval = TD_DDIR_RANDRW,
1232 .help = "Random read and write mix"
1233 },
1234 },
1235 },
1236 {
1237 .name = "rw_sequencer",
1238 .type = FIO_OPT_STR,
1239 .off1 = td_var_offset(rw_seq),
1240 .help = "IO offset generator modifier",
1241 .def = "sequential",
1242 .posval = {
1243 { .ival = "sequential",
1244 .oval = RW_SEQ_SEQ,
1245 .help = "Generate sequential offsets",
1246 },
1247 { .ival = "identical",
1248 .oval = RW_SEQ_IDENT,
1249 .help = "Generate identical offsets",
1250 },
1251 },
1252 },
1253
1254 {
1255 .name = "ioengine",
1256 .type = FIO_OPT_STR_STORE,
1257 .off1 = td_var_offset(ioengine),
1258 .help = "IO engine to use",
1259 .def = FIO_PREFERRED_ENGINE,
1260 .posval = {
1261 { .ival = "sync",
1262 .help = "Use read/write",
1263 },
1264 { .ival = "psync",
1265 .help = "Use pread/pwrite",
1266 },
1267 { .ival = "vsync",
1268 .help = "Use readv/writev",
1269 },
1270#ifdef CONFIG_LIBAIO
1271 { .ival = "libaio",
1272 .help = "Linux native asynchronous IO",
1273 },
1274#endif
1275#ifdef CONFIG_POSIXAIO
1276 { .ival = "posixaio",
1277 .help = "POSIX asynchronous IO",
1278 },
1279#endif
1280#ifdef FIO_HAVE_SOLARISAIO
1281 { .ival = "solarisaio",
1282 .help = "Solaris native asynchronous IO",
1283 },
1284#endif
1285#ifdef FIO_HAVE_WINDOWSAIO
1286 { .ival = "windowsaio",
1287 .help = "Windows native asynchronous IO"
1288 },
1289#endif
1290 { .ival = "mmap",
1291 .help = "Memory mapped IO"
1292 },
1293#ifdef CONFIG_LINUX_SPLICE
1294 { .ival = "splice",
1295 .help = "splice/vmsplice based IO",
1296 },
1297 { .ival = "netsplice",
1298 .help = "splice/vmsplice to/from the network",
1299 },
1300#endif
1301#ifdef FIO_HAVE_SGIO
1302 { .ival = "sg",
1303 .help = "SCSI generic v3 IO",
1304 },
1305#endif
1306 { .ival = "null",
1307 .help = "Testing engine (no data transfer)",
1308 },
1309 { .ival = "net",
1310 .help = "Network IO",
1311 },
1312 { .ival = "cpuio",
1313 .help = "CPU cycle burner engine",
1314 },
1315#ifdef CONFIG_GUASI
1316 { .ival = "guasi",
1317 .help = "GUASI IO engine",
1318 },
1319#endif
1320#ifdef FIO_HAVE_BINJECT
1321 { .ival = "binject",
1322 .help = "binject direct inject block engine",
1323 },
1324#endif
1325#ifdef CONFIG_RDMA
1326 { .ival = "rdma",
1327 .help = "RDMA IO engine",
1328 },
1329#endif
1330#ifdef CONFIG_FUSION_AW
1331 { .ival = "fusion-aw-sync",
1332 .help = "Fusion-io atomic write engine",
1333 },
1334#endif
1335#ifdef FIO_HAVE_E4_ENG
1336 { .ival = "e4defrag",
1337 .help = "ext4 defrag engine",
1338 },
1339#endif
1340#ifdef FIO_HAVE_FALLOC_ENG
1341 { .ival = "falloc",
1342 .help = "fallocate() file based engine",
1343 },
1344#endif
1345 { .ival = "external",
1346 .help = "Load external engine (append name)",
1347 },
1348 },
1349 },
1350 {
1351 .name = "iodepth",
1352 .type = FIO_OPT_INT,
1353 .off1 = td_var_offset(iodepth),
1354 .help = "Number of IO buffers to keep in flight",
1355 .minval = 1,
1356 .def = "1",
1357 },
1358 {
1359 .name = "iodepth_batch",
1360 .alias = "iodepth_batch_submit",
1361 .type = FIO_OPT_INT,
1362 .off1 = td_var_offset(iodepth_batch),
1363 .help = "Number of IO buffers to submit in one go",
1364 .parent = "iodepth",
1365 .minval = 1,
1366 .def = "1",
1367 },
1368 {
1369 .name = "iodepth_batch_complete",
1370 .type = FIO_OPT_INT,
1371 .off1 = td_var_offset(iodepth_batch_complete),
1372 .help = "Number of IO buffers to retrieve in one go",
1373 .parent = "iodepth",
1374 .minval = 0,
1375 .def = "1",
1376 },
1377 {
1378 .name = "iodepth_low",
1379 .type = FIO_OPT_INT,
1380 .off1 = td_var_offset(iodepth_low),
1381 .help = "Low water mark for queuing depth",
1382 .parent = "iodepth",
1383 },
1384 {
1385 .name = "size",
1386 .type = FIO_OPT_STR_VAL,
1387 .cb = str_size_cb,
1388 .help = "Total size of device or files",
1389 },
1390 {
1391 .name = "fill_device",
1392 .alias = "fill_fs",
1393 .type = FIO_OPT_BOOL,
1394 .off1 = td_var_offset(fill_device),
1395 .help = "Write until an ENOSPC error occurs",
1396 .def = "0",
1397 },
1398 {
1399 .name = "filesize",
1400 .type = FIO_OPT_STR_VAL,
1401 .off1 = td_var_offset(file_size_low),
1402 .off2 = td_var_offset(file_size_high),
1403 .minval = 1,
1404 .help = "Size of individual files",
1405 },
1406 {
1407 .name = "offset",
1408 .alias = "fileoffset",
1409 .type = FIO_OPT_STR_VAL,
1410 .off1 = td_var_offset(start_offset),
1411 .help = "Start IO from this offset",
1412 .def = "0",
1413 },
1414 {
1415 .name = "offset_increment",
1416 .type = FIO_OPT_STR_VAL,
1417 .off1 = td_var_offset(offset_increment),
1418 .help = "What is the increment from one offset to the next",
1419 .parent = "offset",
1420 .def = "0",
1421 },
1422 {
1423 .name = "bs",
1424 .alias = "blocksize",
1425 .type = FIO_OPT_INT,
1426 .off1 = td_var_offset(bs[DDIR_READ]),
1427 .off2 = td_var_offset(bs[DDIR_WRITE]),
1428 .off3 = td_var_offset(bs[DDIR_TRIM]),
1429 .minval = 1,
1430 .help = "Block size unit",
1431 .def = "4k",
1432 .parent = "rw",
1433 },
1434 {
1435 .name = "ba",
1436 .alias = "blockalign",
1437 .type = FIO_OPT_INT,
1438 .off1 = td_var_offset(ba[DDIR_READ]),
1439 .off2 = td_var_offset(ba[DDIR_WRITE]),
1440 .off3 = td_var_offset(ba[DDIR_TRIM]),
1441 .minval = 1,
1442 .help = "IO block offset alignment",
1443 .parent = "rw",
1444 },
1445 {
1446 .name = "bsrange",
1447 .alias = "blocksize_range",
1448 .type = FIO_OPT_RANGE,
1449 .off1 = td_var_offset(min_bs[DDIR_READ]),
1450 .off2 = td_var_offset(max_bs[DDIR_READ]),
1451 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1452 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1453 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1454 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1455 .minval = 1,
1456 .help = "Set block size range (in more detail than bs)",
1457 .parent = "rw",
1458 },
1459 {
1460 .name = "bssplit",
1461 .type = FIO_OPT_STR,
1462 .cb = str_bssplit_cb,
1463 .help = "Set a specific mix of block sizes",
1464 .parent = "rw",
1465 },
1466 {
1467 .name = "bs_unaligned",
1468 .alias = "blocksize_unaligned",
1469 .type = FIO_OPT_STR_SET,
1470 .off1 = td_var_offset(bs_unaligned),
1471 .help = "Don't sector align IO buffer sizes",
1472 .parent = "rw",
1473 },
1474 {
1475 .name = "randrepeat",
1476 .type = FIO_OPT_BOOL,
1477 .off1 = td_var_offset(rand_repeatable),
1478 .help = "Use repeatable random IO pattern",
1479 .def = "1",
1480 .parent = "rw",
1481 },
1482 {
1483 .name = "use_os_rand",
1484 .type = FIO_OPT_BOOL,
1485 .off1 = td_var_offset(use_os_rand),
1486 .help = "Set to use OS random generator",
1487 .def = "0",
1488 .parent = "rw",
1489 },
1490 {
1491 .name = "norandommap",
1492 .type = FIO_OPT_STR_SET,
1493 .off1 = td_var_offset(norandommap),
1494 .help = "Accept potential duplicate random blocks",
1495 .parent = "rw",
1496 },
1497 {
1498 .name = "softrandommap",
1499 .type = FIO_OPT_BOOL,
1500 .off1 = td_var_offset(softrandommap),
1501 .help = "Set norandommap if randommap allocation fails",
1502 .parent = "norandommap",
1503 .def = "0",
1504 },
1505 {
1506 .name = "random_generator",
1507 .type = FIO_OPT_STR,
1508 .off1 = td_var_offset(random_generator),
1509 .help = "Type of random number generator to use",
1510 .def = "tausworthe",
1511 .posval = {
1512 { .ival = "tausworthe",
1513 .oval = FIO_RAND_GEN_TAUSWORTHE,
1514 .help = "Strong Tausworthe generator",
1515 },
1516 { .ival = "lfsr",
1517 .oval = FIO_RAND_GEN_LFSR,
1518 .help = "Variable length LFSR",
1519 },
1520 },
1521 },
1522 {
1523 .name = "random_distribution",
1524 .type = FIO_OPT_STR,
1525 .off1 = td_var_offset(random_distribution),
1526 .cb = str_random_distribution_cb,
1527 .help = "Random offset distribution generator",
1528 .def = "random",
1529 .posval = {
1530 { .ival = "random",
1531 .oval = FIO_RAND_DIST_RANDOM,
1532 .help = "Completely random",
1533 },
1534 { .ival = "zipf",
1535 .oval = FIO_RAND_DIST_ZIPF,
1536 .help = "Zipf distribution",
1537 },
1538 { .ival = "pareto",
1539 .oval = FIO_RAND_DIST_PARETO,
1540 .help = "Pareto distribution",
1541 },
1542 },
1543 },
1544 {
1545 .name = "nrfiles",
1546 .alias = "nr_files",
1547 .type = FIO_OPT_INT,
1548 .off1 = td_var_offset(nr_files),
1549 .help = "Split job workload between this number of files",
1550 .def = "1",
1551 },
1552 {
1553 .name = "openfiles",
1554 .type = FIO_OPT_INT,
1555 .off1 = td_var_offset(open_files),
1556 .help = "Number of files to keep open at the same time",
1557 },
1558 {
1559 .name = "file_service_type",
1560 .type = FIO_OPT_STR,
1561 .cb = str_fst_cb,
1562 .off1 = td_var_offset(file_service_type),
1563 .help = "How to select which file to service next",
1564 .def = "roundrobin",
1565 .posval = {
1566 { .ival = "random",
1567 .oval = FIO_FSERVICE_RANDOM,
1568 .help = "Choose a file at random",
1569 },
1570 { .ival = "roundrobin",
1571 .oval = FIO_FSERVICE_RR,
1572 .help = "Round robin select files",
1573 },
1574 { .ival = "sequential",
1575 .oval = FIO_FSERVICE_SEQ,
1576 .help = "Finish one file before moving to the next",
1577 },
1578 },
1579 .parent = "nrfiles",
1580 },
1581#ifdef FIO_HAVE_FALLOCATE
1582 {
1583 .name = "fallocate",
1584 .type = FIO_OPT_STR,
1585 .off1 = td_var_offset(fallocate_mode),
1586 .help = "Whether pre-allocation is performed when laying out files",
1587 .def = "posix",
1588 .posval = {
1589 { .ival = "none",
1590 .oval = FIO_FALLOCATE_NONE,
1591 .help = "Do not pre-allocate space",
1592 },
1593 { .ival = "posix",
1594 .oval = FIO_FALLOCATE_POSIX,
1595 .help = "Use posix_fallocate()",
1596 },
1597#ifdef FIO_HAVE_LINUX_FALLOCATE
1598 { .ival = "keep",
1599 .oval = FIO_FALLOCATE_KEEP_SIZE,
1600 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1601 },
1602#endif
1603 /* Compatibility with former boolean values */
1604 { .ival = "0",
1605 .oval = FIO_FALLOCATE_NONE,
1606 .help = "Alias for 'none'",
1607 },
1608 { .ival = "1",
1609 .oval = FIO_FALLOCATE_POSIX,
1610 .help = "Alias for 'posix'",
1611 },
1612 },
1613 },
1614#endif /* FIO_HAVE_FALLOCATE */
1615 {
1616 .name = "fadvise_hint",
1617 .type = FIO_OPT_BOOL,
1618 .off1 = td_var_offset(fadvise_hint),
1619 .help = "Use fadvise() to advise the kernel on IO pattern",
1620 .def = "1",
1621 },
1622 {
1623 .name = "fsync",
1624 .type = FIO_OPT_INT,
1625 .off1 = td_var_offset(fsync_blocks),
1626 .help = "Issue fsync for writes every given number of blocks",
1627 .def = "0",
1628 },
1629 {
1630 .name = "fdatasync",
1631 .type = FIO_OPT_INT,
1632 .off1 = td_var_offset(fdatasync_blocks),
1633 .help = "Issue fdatasync for writes every given number of blocks",
1634 .def = "0",
1635 },
1636 {
1637 .name = "write_barrier",
1638 .type = FIO_OPT_INT,
1639 .off1 = td_var_offset(barrier_blocks),
1640 .help = "Make every Nth write a barrier write",
1641 .def = "0",
1642 },
1643#ifdef CONFIG_SYNC_FILE_RANGE
1644 {
1645 .name = "sync_file_range",
1646 .posval = {
1647 { .ival = "wait_before",
1648 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1649 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1650 .or = 1,
1651 },
1652 { .ival = "write",
1653 .oval = SYNC_FILE_RANGE_WRITE,
1654 .help = "SYNC_FILE_RANGE_WRITE",
1655 .or = 1,
1656 },
1657 {
1658 .ival = "wait_after",
1659 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1660 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1661 .or = 1,
1662 },
1663 },
1664 .type = FIO_OPT_STR_MULTI,
1665 .cb = str_sfr_cb,
1666 .off1 = td_var_offset(sync_file_range),
1667 .help = "Use sync_file_range()",
1668 },
1669#endif
1670 {
1671 .name = "direct",
1672 .type = FIO_OPT_BOOL,
1673 .off1 = td_var_offset(odirect),
1674 .help = "Use O_DIRECT IO (negates buffered)",
1675 .def = "0",
1676 },
1677 {
1678 .name = "buffered",
1679 .type = FIO_OPT_BOOL,
1680 .off1 = td_var_offset(odirect),
1681 .neg = 1,
1682 .help = "Use buffered IO (negates direct)",
1683 .def = "1",
1684 },
1685 {
1686 .name = "overwrite",
1687 .type = FIO_OPT_BOOL,
1688 .off1 = td_var_offset(overwrite),
1689 .help = "When writing, set whether to overwrite current data",
1690 .def = "0",
1691 },
1692 {
1693 .name = "loops",
1694 .type = FIO_OPT_INT,
1695 .off1 = td_var_offset(loops),
1696 .help = "Number of times to run the job",
1697 .def = "1",
1698 },
1699 {
1700 .name = "numjobs",
1701 .type = FIO_OPT_INT,
1702 .off1 = td_var_offset(numjobs),
1703 .help = "Duplicate this job this many times",
1704 .def = "1",
1705 },
1706 {
1707 .name = "startdelay",
1708 .type = FIO_OPT_STR_VAL_TIME,
1709 .off1 = td_var_offset(start_delay),
1710 .help = "Only start job when this period has passed",
1711 .def = "0",
1712 },
1713 {
1714 .name = "runtime",
1715 .alias = "timeout",
1716 .type = FIO_OPT_STR_VAL_TIME,
1717 .off1 = td_var_offset(timeout),
1718 .help = "Stop workload when this amount of time has passed",
1719 .def = "0",
1720 },
1721 {
1722 .name = "time_based",
1723 .type = FIO_OPT_STR_SET,
1724 .off1 = td_var_offset(time_based),
1725 .help = "Keep running until runtime/timeout is met",
1726 },
1727 {
1728 .name = "ramp_time",
1729 .type = FIO_OPT_STR_VAL_TIME,
1730 .off1 = td_var_offset(ramp_time),
1731 .help = "Ramp up time before measuring performance",
1732 },
1733 {
1734 .name = "clocksource",
1735 .type = FIO_OPT_STR,
1736 .cb = fio_clock_source_cb,
1737 .off1 = td_var_offset(clocksource),
1738 .help = "What type of timing source to use",
1739 .posval = {
1740#ifdef CONFIG_GETTIMEOFDAY
1741 { .ival = "gettimeofday",
1742 .oval = CS_GTOD,
1743 .help = "Use gettimeofday(2) for timing",
1744 },
1745#endif
1746#ifdef CONFIG_CLOCK_GETTIME
1747 { .ival = "clock_gettime",
1748 .oval = CS_CGETTIME,
1749 .help = "Use clock_gettime(2) for timing",
1750 },
1751#endif
1752#ifdef ARCH_HAVE_CPU_CLOCK
1753 { .ival = "cpu",
1754 .oval = CS_CPUCLOCK,
1755 .help = "Use CPU private clock",
1756 },
1757#endif
1758 },
1759 },
1760 {
1761 .name = "mem",
1762 .alias = "iomem",
1763 .type = FIO_OPT_STR,
1764 .cb = str_mem_cb,
1765 .off1 = td_var_offset(mem_type),
1766 .help = "Backing type for IO buffers",
1767 .def = "malloc",
1768 .posval = {
1769 { .ival = "malloc",
1770 .oval = MEM_MALLOC,
1771 .help = "Use malloc(3) for IO buffers",
1772 },
1773 { .ival = "shm",
1774 .oval = MEM_SHM,
1775 .help = "Use shared memory segments for IO buffers",
1776 },
1777#ifdef FIO_HAVE_HUGETLB
1778 { .ival = "shmhuge",
1779 .oval = MEM_SHMHUGE,
1780 .help = "Like shm, but use huge pages",
1781 },
1782#endif
1783 { .ival = "mmap",
1784 .oval = MEM_MMAP,
1785 .help = "Use mmap(2) (file or anon) for IO buffers",
1786 },
1787#ifdef FIO_HAVE_HUGETLB
1788 { .ival = "mmaphuge",
1789 .oval = MEM_MMAPHUGE,
1790 .help = "Like mmap, but use huge pages",
1791 },
1792#endif
1793 },
1794 },
1795 {
1796 .name = "iomem_align",
1797 .alias = "mem_align",
1798 .type = FIO_OPT_INT,
1799 .off1 = td_var_offset(mem_align),
1800 .minval = 0,
1801 .help = "IO memory buffer offset alignment",
1802 .def = "0",
1803 .parent = "iomem",
1804 },
1805 {
1806 .name = "verify",
1807 .type = FIO_OPT_STR,
1808 .off1 = td_var_offset(verify),
1809 .help = "Verify data written",
1810 .cb = str_verify_cb,
1811 .def = "0",
1812 .posval = {
1813 { .ival = "0",
1814 .oval = VERIFY_NONE,
1815 .help = "Don't do IO verification",
1816 },
1817 { .ival = "md5",
1818 .oval = VERIFY_MD5,
1819 .help = "Use md5 checksums for verification",
1820 },
1821 { .ival = "crc64",
1822 .oval = VERIFY_CRC64,
1823 .help = "Use crc64 checksums for verification",
1824 },
1825 { .ival = "crc32",
1826 .oval = VERIFY_CRC32,
1827 .help = "Use crc32 checksums for verification",
1828 },
1829 { .ival = "crc32c-intel",
1830 .oval = VERIFY_CRC32C,
1831 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1832 },
1833 { .ival = "crc32c",
1834 .oval = VERIFY_CRC32C,
1835 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1836 },
1837 { .ival = "crc16",
1838 .oval = VERIFY_CRC16,
1839 .help = "Use crc16 checksums for verification",
1840 },
1841 { .ival = "crc7",
1842 .oval = VERIFY_CRC7,
1843 .help = "Use crc7 checksums for verification",
1844 },
1845 { .ival = "sha1",
1846 .oval = VERIFY_SHA1,
1847 .help = "Use sha1 checksums for verification",
1848 },
1849 { .ival = "sha256",
1850 .oval = VERIFY_SHA256,
1851 .help = "Use sha256 checksums for verification",
1852 },
1853 { .ival = "sha512",
1854 .oval = VERIFY_SHA512,
1855 .help = "Use sha512 checksums for verification",
1856 },
1857 { .ival = "meta",
1858 .oval = VERIFY_META,
1859 .help = "Use io information",
1860 },
1861 {
1862 .ival = "null",
1863 .oval = VERIFY_NULL,
1864 .help = "Pretend to verify",
1865 },
1866 },
1867 },
1868 {
1869 .name = "do_verify",
1870 .type = FIO_OPT_BOOL,
1871 .off1 = td_var_offset(do_verify),
1872 .help = "Run verification stage after write",
1873 .def = "1",
1874 .parent = "verify",
1875 },
1876 {
1877 .name = "verifysort",
1878 .type = FIO_OPT_BOOL,
1879 .off1 = td_var_offset(verifysort),
1880 .help = "Sort written verify blocks for read back",
1881 .def = "1",
1882 .parent = "verify",
1883 },
1884 {
1885 .name = "verifysort_nr",
1886 .type = FIO_OPT_INT,
1887 .off1 = td_var_offset(verifysort_nr),
1888 .help = "Pre-load and sort verify blocks for a read workload",
1889 .minval = 0,
1890 .maxval = 131072,
1891 .def = "1024",
1892 .parent = "verify",
1893 },
1894 {
1895 .name = "verify_interval",
1896 .type = FIO_OPT_INT,
1897 .off1 = td_var_offset(verify_interval),
1898 .minval = 2 * sizeof(struct verify_header),
1899 .help = "Store verify buffer header every N bytes",
1900 .parent = "verify",
1901 },
1902 {
1903 .name = "verify_offset",
1904 .type = FIO_OPT_INT,
1905 .help = "Offset verify header location by N bytes",
1906 .def = "0",
1907 .cb = str_verify_offset_cb,
1908 .parent = "verify",
1909 },
1910 {
1911 .name = "verify_pattern",
1912 .type = FIO_OPT_STR,
1913 .cb = str_verify_pattern_cb,
1914 .help = "Fill pattern for IO buffers",
1915 .parent = "verify",
1916 },
1917 {
1918 .name = "verify_fatal",
1919 .type = FIO_OPT_BOOL,
1920 .off1 = td_var_offset(verify_fatal),
1921 .def = "0",
1922 .help = "Exit on a single verify failure, don't continue",
1923 .parent = "verify",
1924 },
1925 {
1926 .name = "verify_dump",
1927 .type = FIO_OPT_BOOL,
1928 .off1 = td_var_offset(verify_dump),
1929 .def = "0",
1930 .help = "Dump contents of good and bad blocks on failure",
1931 .parent = "verify",
1932 },
1933 {
1934 .name = "verify_async",
1935 .type = FIO_OPT_INT,
1936 .off1 = td_var_offset(verify_async),
1937 .def = "0",
1938 .help = "Number of async verifier threads to use",
1939 .parent = "verify",
1940 },
1941 {
1942 .name = "verify_backlog",
1943 .type = FIO_OPT_STR_VAL,
1944 .off1 = td_var_offset(verify_backlog),
1945 .help = "Verify after this number of blocks are written",
1946 .parent = "verify",
1947 },
1948 {
1949 .name = "verify_backlog_batch",
1950 .type = FIO_OPT_INT,
1951 .off1 = td_var_offset(verify_batch),
1952 .help = "Verify this number of IO blocks",
1953 .parent = "verify",
1954 },
1955#ifdef FIO_HAVE_CPU_AFFINITY
1956 {
1957 .name = "verify_async_cpus",
1958 .type = FIO_OPT_STR,
1959 .cb = str_verify_cpus_allowed_cb,
1960 .help = "Set CPUs allowed for async verify threads",
1961 .parent = "verify_async",
1962 },
1963#endif
1964 {
1965 .name = "experimental_verify",
1966 .off1 = td_var_offset(experimental_verify),
1967 .type = FIO_OPT_BOOL,
1968 },
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}