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