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