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