11 #include <netinet/in.h>
17 #include "lib/pattern.h"
20 #include "crc/crc32c.h"
22 char client_sockaddr_str[INET6_ADDRSTRLEN] = { 0 };
24 struct pattern_fmt_desc fmt_desc[] = {
27 .len = FIELD_SIZE(struct io_u *, offset),
28 .paste = paste_blockoff
33 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
35 static char *get_opt_postfix(const char *str)
37 char *p = strstr(str, ":");
43 strip_blank_front(&p);
48 static int bs_cmp(const void *p1, const void *p2)
50 const struct bssplit *bsp1 = p1;
51 const struct bssplit *bsp2 = p2;
53 return bsp1->perc < bsp2->perc;
56 static int bssplit_ddir(struct thread_options *o, int ddir, char *str)
58 struct bssplit *bssplit;
59 unsigned int i, perc, perc_missing;
60 unsigned int max_bs, min_bs;
64 o->bssplit_nr[ddir] = 4;
65 bssplit = malloc(4 * sizeof(struct bssplit));
70 while ((fname = strsep(&str, ":")) != NULL) {
77 * grow struct buffer, if needed
79 if (i == o->bssplit_nr[ddir]) {
80 o->bssplit_nr[ddir] <<= 1;
81 bssplit = realloc(bssplit, o->bssplit_nr[ddir]
82 * sizeof(struct bssplit));
85 perc_str = strstr(fname, "/");
89 perc = atoi(perc_str);
97 if (str_to_decimal(fname, &val, 1, o, 0, 0)) {
98 log_err("fio: bssplit conversion failed\n");
109 bssplit[i].perc = perc;
113 o->bssplit_nr[ddir] = i;
116 * Now check if the percentages add up, and how much is missing
118 perc = perc_missing = 0;
119 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
120 struct bssplit *bsp = &bssplit[i];
122 if (bsp->perc == -1U)
128 if (perc > 100 && perc_missing > 1) {
129 log_err("fio: bssplit percentages add to more than 100%%\n");
135 * If values didn't have a percentage set, divide the remains between
139 if (perc_missing == 1 && o->bssplit_nr[ddir] == 1)
141 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
142 struct bssplit *bsp = &bssplit[i];
144 if (bsp->perc == -1U)
145 bsp->perc = (100 - perc) / perc_missing;
149 o->min_bs[ddir] = min_bs;
150 o->max_bs[ddir] = max_bs;
153 * now sort based on percentages, for ease of lookup
155 qsort(bssplit, o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
156 o->bssplit[ddir] = bssplit;
160 static int str_bssplit_cb(void *data, const char *input)
162 struct thread_data *td = data;
163 char *str, *p, *odir, *ddir;
169 p = str = strdup(input);
171 strip_blank_front(&str);
172 strip_blank_end(str);
174 odir = strchr(str, ',');
176 ddir = strchr(odir + 1, ',');
178 ret = bssplit_ddir(&td->o, DDIR_TRIM, ddir + 1);
184 op = strdup(odir + 1);
185 ret = bssplit_ddir(&td->o, DDIR_TRIM, op);
190 ret = bssplit_ddir(&td->o, DDIR_WRITE, odir + 1);
193 ret = bssplit_ddir(&td->o, DDIR_READ, str);
199 ret = bssplit_ddir(&td->o, DDIR_WRITE, op);
204 ret = bssplit_ddir(&td->o, DDIR_TRIM, op);
207 ret = bssplit_ddir(&td->o, DDIR_READ, str);
214 static int str2error(char *str)
216 const char *err[] = { "EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
217 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
218 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
219 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
220 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
221 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
222 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
223 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE" };
224 int i = 0, num = sizeof(err) / sizeof(void *);
227 if (!strcmp(err[i], str))
234 static int ignore_error_type(struct thread_data *td, int etype, char *str)
240 if (etype >= ERROR_TYPE_CNT) {
241 log_err("Illegal error type\n");
245 td->o.ignore_error_nr[etype] = 4;
246 error = malloc(4 * sizeof(struct bssplit));
249 while ((fname = strsep(&str, ":")) != NULL) {
255 * grow struct buffer, if needed
257 if (i == td->o.ignore_error_nr[etype]) {
258 td->o.ignore_error_nr[etype] <<= 1;
259 error = realloc(error, td->o.ignore_error_nr[etype]
262 if (fname[0] == 'E') {
263 error[i] = str2error(fname);
265 error[i] = atoi(fname);
267 error[i] = -error[i];
270 log_err("Unknown error %s, please use number value \n",
278 td->o.continue_on_error |= 1 << etype;
279 td->o.ignore_error_nr[etype] = i;
280 td->o.ignore_error[etype] = error;
288 static int str_ignore_error_cb(void *data, const char *input)
290 struct thread_data *td = data;
292 int type = 0, ret = 1;
297 p = str = strdup(input);
299 strip_blank_front(&str);
300 strip_blank_end(str);
306 ret = ignore_error_type(td, type, p);
316 static int str_rw_cb(void *data, const char *str)
318 struct thread_data *td = data;
319 struct thread_options *o = &td->o;
328 nr = get_opt_postfix(str);
333 o->ddir_seq_nr = atoi(nr);
337 if (str_to_decimal(nr, &val, 1, o, 0, 0)) {
338 log_err("fio: rw postfix parsing failed\n");
343 o->ddir_seq_add = val;
350 static int str_mem_cb(void *data, const char *mem)
352 struct thread_data *td = data;
354 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP)
355 td->o.mmapfile = get_opt_postfix(mem);
360 static int fio_clock_source_cb(void *data, const char *str)
362 struct thread_data *td = data;
364 fio_clock_source = td->o.clocksource;
365 fio_clock_source_set = 1;
370 static int str_rwmix_read_cb(void *data, unsigned long long *val)
372 struct thread_data *td = data;
374 td->o.rwmix[DDIR_READ] = *val;
375 td->o.rwmix[DDIR_WRITE] = 100 - *val;
379 static int str_rwmix_write_cb(void *data, unsigned long long *val)
381 struct thread_data *td = data;
383 td->o.rwmix[DDIR_WRITE] = *val;
384 td->o.rwmix[DDIR_READ] = 100 - *val;
388 static int str_exitall_cb(void)
390 exitall_on_terminate = 1;
394 #ifdef FIO_HAVE_CPU_AFFINITY
395 int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
397 unsigned int i, index, cpus_in_mask;
398 const long max_cpu = cpus_online();
400 cpus_in_mask = fio_cpu_count(mask);
401 cpu_index = cpu_index % cpus_in_mask;
404 for (i = 0; i < max_cpu; i++) {
405 if (!fio_cpu_isset(mask, i))
408 if (cpu_index != index)
409 fio_cpu_clear(mask, i);
414 return fio_cpu_count(mask);
417 static int str_cpumask_cb(void *data, unsigned long long *val)
419 struct thread_data *td = data;
427 ret = fio_cpuset_init(&td->o.cpumask);
429 log_err("fio: cpuset_init failed\n");
430 td_verror(td, ret, "fio_cpuset_init");
434 max_cpu = cpus_online();
436 for (i = 0; i < sizeof(int) * 8; i++) {
437 if ((1 << i) & *val) {
439 log_err("fio: CPU %d too large (max=%ld)\n", i,
443 dprint(FD_PARSE, "set cpu allowed %d\n", i);
444 fio_cpu_set(&td->o.cpumask, i);
451 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
458 ret = fio_cpuset_init(mask);
460 log_err("fio: cpuset_init failed\n");
461 td_verror(td, ret, "fio_cpuset_init");
465 p = str = strdup(input);
467 strip_blank_front(&str);
468 strip_blank_end(str);
470 max_cpu = cpus_online();
472 while ((cpu = strsep(&str, ",")) != NULL) {
481 while ((cpu2 = strsep(&str2, "-")) != NULL) {
491 while (icpu <= icpu2) {
492 if (icpu >= FIO_MAX_CPUS) {
493 log_err("fio: your OS only supports up to"
494 " %d CPUs\n", (int) FIO_MAX_CPUS);
498 if (icpu >= max_cpu) {
499 log_err("fio: CPU %d too large (max=%ld)\n",
505 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
506 fio_cpu_set(mask, icpu);
517 static int str_cpus_allowed_cb(void *data, const char *input)
519 struct thread_data *td = data;
524 return set_cpus_allowed(td, &td->o.cpumask, input);
527 static int str_verify_cpus_allowed_cb(void *data, const char *input)
529 struct thread_data *td = data;
531 return set_cpus_allowed(td, &td->o.verify_cpumask, input);
535 #ifdef CONFIG_LIBNUMA
536 static int str_numa_cpunodes_cb(void *data, char *input)
538 struct thread_data *td = data;
539 struct bitmask *verify_bitmask;
544 /* numa_parse_nodestring() parses a character string list
545 * of nodes into a bit mask. The bit mask is allocated by
546 * numa_allocate_nodemask(), so it should be freed by
547 * numa_free_nodemask().
549 verify_bitmask = numa_parse_nodestring(input);
550 if (verify_bitmask == NULL) {
551 log_err("fio: numa_parse_nodestring failed\n");
552 td_verror(td, 1, "str_numa_cpunodes_cb");
555 numa_free_nodemask(verify_bitmask);
557 td->o.numa_cpunodes = strdup(input);
561 static int str_numa_mpol_cb(void *data, char *input)
563 struct thread_data *td = data;
564 const char * const policy_types[] =
565 { "default", "prefer", "bind", "interleave", "local", NULL };
568 struct bitmask *verify_bitmask;
573 nodelist = strchr(input, ':');
575 /* NUL-terminate mode */
579 for (i = 0; i <= MPOL_LOCAL; i++) {
580 if (!strcmp(input, policy_types[i])) {
581 td->o.numa_mem_mode = i;
585 if (i > MPOL_LOCAL) {
586 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
590 switch (td->o.numa_mem_mode) {
593 * Insist on a nodelist of one node only
596 char *rest = nodelist;
597 while (isdigit(*rest))
600 log_err("fio: one node only for \'prefer\'\n");
604 log_err("fio: one node is needed for \'prefer\'\n");
608 case MPOL_INTERLEAVE:
610 * Default to online nodes with memory if no nodelist
613 nodelist = strdup("all");
618 * Don't allow a nodelist
621 log_err("fio: NO nodelist for \'local\'\n");
627 * Insist on a nodelist
630 log_err("fio: a nodelist is needed for \'bind\'\n");
637 /* numa_parse_nodestring() parses a character string list
638 * of nodes into a bit mask. The bit mask is allocated by
639 * numa_allocate_nodemask(), so it should be freed by
640 * numa_free_nodemask().
642 switch (td->o.numa_mem_mode) {
644 td->o.numa_mem_prefer_node = atoi(nodelist);
646 case MPOL_INTERLEAVE:
648 verify_bitmask = numa_parse_nodestring(nodelist);
649 if (verify_bitmask == NULL) {
650 log_err("fio: numa_parse_nodestring failed\n");
651 td_verror(td, 1, "str_numa_memnodes_cb");
654 td->o.numa_memnodes = strdup(nodelist);
655 numa_free_nodemask(verify_bitmask);
670 static int str_fst_cb(void *data, const char *str)
672 struct thread_data *td = data;
673 char *nr = get_opt_postfix(str);
675 td->file_service_nr = 1;
677 td->file_service_nr = atoi(nr);
684 #ifdef CONFIG_SYNC_FILE_RANGE
685 static int str_sfr_cb(void *data, const char *str)
687 struct thread_data *td = data;
688 char *nr = get_opt_postfix(str);
690 td->sync_file_range_nr = 1;
692 td->sync_file_range_nr = atoi(nr);
700 static int str_random_distribution_cb(void *data, const char *str)
702 struct thread_data *td = data;
709 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
711 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
712 val = FIO_DEF_PARETO;
713 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
718 nr = get_opt_postfix(str);
719 if (nr && !str_to_float(nr, &val, 0)) {
720 log_err("fio: random postfix parsing failed\n");
727 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
729 log_err("fio: zipf theta must different than 1.0\n");
732 td->o.zipf_theta.u.f = val;
733 } else if (td->o.random_distribution == FIO_RAND_DIST_PARETO) {
734 if (val <= 0.00 || val >= 1.00) {
735 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
738 td->o.pareto_h.u.f = val;
740 if (val <= 0.00 || val >= 100.0) {
741 log_err("fio: normal deviation out of range (0 < input < 100.0)\n");
744 td->o.gauss_dev.u.f = val;
751 * Return next name in the string. Files are separated with ':'. If the ':'
752 * is escaped with a '\', then that ':' is part of the filename and does not
753 * indicate a new file.
755 static char *get_next_name(char **ptr)
760 if (!str || !strlen(str))
766 * No colon, we are done
768 p = strchr(str, ':');
775 * We got a colon, but it's the first character. Skip and
783 if (*(p - 1) != '\\') {
789 memmove(p - 1, p, strlen(p) + 1);
797 static int get_max_name_idx(char *input)
799 unsigned int cur_idx;
802 p = str = strdup(input);
803 for (cur_idx = 0; ; cur_idx++)
804 if (get_next_name(&str) == NULL)
812 * Returns the directory at the index, indexes > entires will be
813 * assigned via modulo division of the index
815 int set_name_idx(char *target, size_t tlen, char *input, int index)
817 unsigned int cur_idx;
819 char *fname, *str, *p;
821 p = str = strdup(input);
823 index %= get_max_name_idx(input);
824 for (cur_idx = 0; cur_idx <= index; cur_idx++)
825 fname = get_next_name(&str);
827 if (client_sockaddr_str[0]) {
828 len = snprintf(target, tlen, "%s/%s.", fname,
829 client_sockaddr_str);
831 len = snprintf(target, tlen, "%s/", fname);
833 target[tlen - 1] = '\0';
839 static int str_filename_cb(void *data, const char *input)
841 struct thread_data *td = data;
842 char *fname, *str, *p;
844 p = str = strdup(input);
846 strip_blank_front(&str);
847 strip_blank_end(str);
849 if (!td->files_index)
852 while ((fname = get_next_name(&str)) != NULL) {
855 add_file(td, fname, 0, 1);
862 static int str_directory_cb(void *data, const char fio_unused *unused)
864 struct thread_data *td = data;
866 char *dirname, *str, *p;
872 p = str = strdup(td->o.directory);
873 while ((dirname = get_next_name(&str)) != NULL) {
874 if (lstat(dirname, &sb) < 0) {
877 log_err("fio: %s is not a directory\n", dirname);
878 td_verror(td, ret, "lstat");
881 if (!S_ISDIR(sb.st_mode)) {
882 log_err("fio: %s is not a directory\n", dirname);
893 static int str_opendir_cb(void *data, const char fio_unused *str)
895 struct thread_data *td = data;
900 if (!td->files_index)
903 return add_dir_files(td, td->o.opendir);
906 static int str_buffer_pattern_cb(void *data, const char *input)
908 struct thread_data *td = data;
911 /* FIXME: for now buffer pattern does not support formats */
912 ret = parse_and_fill_pattern(input, strlen(input), td->o.buffer_pattern,
913 MAX_PATTERN_SIZE, NULL, 0, NULL, NULL);
918 td->o.buffer_pattern_bytes = ret;
919 if (!td->o.compress_percentage)
920 td->o.refill_buffers = 0;
921 td->o.scramble_buffers = 0;
922 td->o.zero_buffers = 0;
927 static int str_buffer_compress_cb(void *data, unsigned long long *il)
929 struct thread_data *td = data;
931 td->flags |= TD_F_COMPRESS;
932 td->o.compress_percentage = *il;
936 static int str_dedupe_cb(void *data, unsigned long long *il)
938 struct thread_data *td = data;
940 td->flags |= TD_F_COMPRESS;
941 td->o.dedupe_percentage = *il;
942 td->o.refill_buffers = 1;
946 static int str_verify_pattern_cb(void *data, const char *input)
948 struct thread_data *td = data;
951 td->o.verify_fmt_sz = ARRAY_SIZE(td->o.verify_fmt);
952 ret = parse_and_fill_pattern(input, strlen(input), td->o.verify_pattern,
953 MAX_PATTERN_SIZE, fmt_desc, sizeof(fmt_desc),
954 td->o.verify_fmt, &td->o.verify_fmt_sz);
959 td->o.verify_pattern_bytes = ret;
961 * VERIFY_* could already be set
963 if (!fio_option_is_set(&td->o, verify))
964 td->o.verify = VERIFY_PATTERN;
969 static int str_gtod_reduce_cb(void *data, int *il)
971 struct thread_data *td = data;
974 td->o.disable_lat = !!val;
975 td->o.disable_clat = !!val;
976 td->o.disable_slat = !!val;
977 td->o.disable_bw = !!val;
978 td->o.clat_percentiles = !val;
980 td->tv_cache_mask = 63;
985 static int str_size_cb(void *data, unsigned long long *__val)
987 struct thread_data *td = data;
988 unsigned long long v = *__val;
990 if (parse_is_percent(v)) {
992 td->o.size_percent = -1ULL - v;
999 static int rw_verify(struct fio_option *o, void *data)
1001 struct thread_data *td = data;
1003 if (read_only && td_write(td)) {
1004 log_err("fio: job <%s> has write bit set, but fio is in"
1005 " read-only mode\n", td->o.name);
1012 static int gtod_cpu_verify(struct fio_option *o, void *data)
1014 #ifndef FIO_HAVE_CPU_AFFINITY
1015 struct thread_data *td = data;
1017 if (td->o.gtod_cpu) {
1018 log_err("fio: platform must support CPU affinity for"
1019 "gettimeofday() offloading\n");
1030 static struct opt_group fio_opt_groups[] = {
1033 .mask = FIO_OPT_C_GENERAL,
1037 .mask = FIO_OPT_C_IO,
1041 .mask = FIO_OPT_C_FILE,
1044 .name = "Statistics",
1045 .mask = FIO_OPT_C_STAT,
1049 .mask = FIO_OPT_C_LOG,
1053 .mask = FIO_OPT_C_PROFILE,
1060 static struct opt_group *__opt_group_from_mask(struct opt_group *ogs, unsigned int *mask,
1061 unsigned int inv_mask)
1063 struct opt_group *og;
1066 if (*mask == inv_mask || !*mask)
1069 for (i = 0; ogs[i].name; i++) {
1072 if (*mask & og->mask) {
1073 *mask &= ~(og->mask);
1081 struct opt_group *opt_group_from_mask(unsigned int *mask)
1083 return __opt_group_from_mask(fio_opt_groups, mask, FIO_OPT_C_INVALID);
1086 static struct opt_group fio_opt_cat_groups[] = {
1088 .name = "Latency profiling",
1089 .mask = FIO_OPT_G_LATPROF,
1093 .mask = FIO_OPT_G_RATE,
1097 .mask = FIO_OPT_G_ZONE,
1100 .name = "Read/write mix",
1101 .mask = FIO_OPT_G_RWMIX,
1105 .mask = FIO_OPT_G_VERIFY,
1109 .mask = FIO_OPT_G_TRIM,
1112 .name = "I/O Logging",
1113 .mask = FIO_OPT_G_IOLOG,
1116 .name = "I/O Depth",
1117 .mask = FIO_OPT_G_IO_DEPTH,
1121 .mask = FIO_OPT_G_IO_FLOW,
1124 .name = "Description",
1125 .mask = FIO_OPT_G_DESC,
1129 .mask = FIO_OPT_G_FILENAME,
1132 .name = "General I/O",
1133 .mask = FIO_OPT_G_IO_BASIC,
1137 .mask = FIO_OPT_G_CGROUP,
1141 .mask = FIO_OPT_G_RUNTIME,
1145 .mask = FIO_OPT_G_PROCESS,
1148 .name = "Job credentials / priority",
1149 .mask = FIO_OPT_G_CRED,
1152 .name = "Clock settings",
1153 .mask = FIO_OPT_G_CLOCK,
1157 .mask = FIO_OPT_G_IO_TYPE,
1160 .name = "I/O Thinktime",
1161 .mask = FIO_OPT_G_THINKTIME,
1164 .name = "Randomizations",
1165 .mask = FIO_OPT_G_RANDOM,
1168 .name = "I/O buffers",
1169 .mask = FIO_OPT_G_IO_BUF,
1172 .name = "Tiobench profile",
1173 .mask = FIO_OPT_G_TIOBENCH,
1177 .mask = FIO_OPT_G_MTD,
1185 struct opt_group *opt_group_cat_from_mask(unsigned int *mask)
1187 return __opt_group_from_mask(fio_opt_cat_groups, mask, FIO_OPT_G_INVALID);
1191 * Map of job/command line options
1193 struct fio_option fio_options[FIO_MAX_OPTS] = {
1195 .name = "description",
1196 .lname = "Description of job",
1197 .type = FIO_OPT_STR_STORE,
1198 .off1 = td_var_offset(description),
1199 .help = "Text job description",
1200 .category = FIO_OPT_C_GENERAL,
1201 .group = FIO_OPT_G_DESC,
1205 .lname = "Job name",
1206 .type = FIO_OPT_STR_STORE,
1207 .off1 = td_var_offset(name),
1208 .help = "Name of this job",
1209 .category = FIO_OPT_C_GENERAL,
1210 .group = FIO_OPT_G_DESC,
1214 .lname = "Filename(s)",
1215 .type = FIO_OPT_STR_STORE,
1216 .off1 = td_var_offset(filename),
1217 .cb = str_filename_cb,
1218 .prio = -1, /* must come after "directory" */
1219 .help = "File(s) to use for the workload",
1220 .category = FIO_OPT_C_FILE,
1221 .group = FIO_OPT_G_FILENAME,
1224 .name = "directory",
1225 .lname = "Directory",
1226 .type = FIO_OPT_STR_STORE,
1227 .off1 = td_var_offset(directory),
1228 .cb = str_directory_cb,
1229 .help = "Directory to store files in",
1230 .category = FIO_OPT_C_FILE,
1231 .group = FIO_OPT_G_FILENAME,
1234 .name = "filename_format",
1235 .type = FIO_OPT_STR_STORE,
1236 .off1 = td_var_offset(filename_format),
1237 .prio = -1, /* must come after "directory" */
1238 .help = "Override default $jobname.$jobnum.$filenum naming",
1239 .def = "$jobname.$jobnum.$filenum",
1240 .category = FIO_OPT_C_FILE,
1241 .group = FIO_OPT_G_FILENAME,
1245 .lname = "Lockfile",
1246 .type = FIO_OPT_STR,
1247 .off1 = td_var_offset(file_lock_mode),
1248 .help = "Lock file when doing IO to it",
1250 .parent = "filename",
1253 .category = FIO_OPT_C_FILE,
1254 .group = FIO_OPT_G_FILENAME,
1257 .oval = FILE_LOCK_NONE,
1258 .help = "No file locking",
1260 { .ival = "exclusive",
1261 .oval = FILE_LOCK_EXCLUSIVE,
1262 .help = "Exclusive file lock",
1265 .ival = "readwrite",
1266 .oval = FILE_LOCK_READWRITE,
1267 .help = "Read vs write lock",
1273 .lname = "Open directory",
1274 .type = FIO_OPT_STR_STORE,
1275 .off1 = td_var_offset(opendir),
1276 .cb = str_opendir_cb,
1277 .help = "Recursively add files from this directory and down",
1278 .category = FIO_OPT_C_FILE,
1279 .group = FIO_OPT_G_FILENAME,
1283 .lname = "Read/write",
1284 .alias = "readwrite",
1285 .type = FIO_OPT_STR,
1287 .off1 = td_var_offset(td_ddir),
1288 .help = "IO direction",
1290 .verify = rw_verify,
1291 .category = FIO_OPT_C_IO,
1292 .group = FIO_OPT_G_IO_BASIC,
1295 .oval = TD_DDIR_READ,
1296 .help = "Sequential read",
1299 .oval = TD_DDIR_WRITE,
1300 .help = "Sequential write",
1303 .oval = TD_DDIR_TRIM,
1304 .help = "Sequential trim",
1306 { .ival = "randread",
1307 .oval = TD_DDIR_RANDREAD,
1308 .help = "Random read",
1310 { .ival = "randwrite",
1311 .oval = TD_DDIR_RANDWRITE,
1312 .help = "Random write",
1314 { .ival = "randtrim",
1315 .oval = TD_DDIR_RANDTRIM,
1316 .help = "Random trim",
1320 .help = "Sequential read and write mix",
1322 { .ival = "readwrite",
1324 .help = "Sequential read and write mix",
1327 .oval = TD_DDIR_RANDRW,
1328 .help = "Random read and write mix"
1330 { .ival = "trimwrite",
1331 .oval = TD_DDIR_TRIMWRITE,
1332 .help = "Trim and write mix, trims preceding writes"
1337 .name = "rw_sequencer",
1338 .lname = "RW Sequencer",
1339 .type = FIO_OPT_STR,
1340 .off1 = td_var_offset(rw_seq),
1341 .help = "IO offset generator modifier",
1342 .def = "sequential",
1343 .category = FIO_OPT_C_IO,
1344 .group = FIO_OPT_G_IO_BASIC,
1346 { .ival = "sequential",
1348 .help = "Generate sequential offsets",
1350 { .ival = "identical",
1351 .oval = RW_SEQ_IDENT,
1352 .help = "Generate identical offsets",
1359 .lname = "IO Engine",
1360 .type = FIO_OPT_STR_STORE,
1361 .off1 = td_var_offset(ioengine),
1362 .help = "IO engine to use",
1363 .def = FIO_PREFERRED_ENGINE,
1364 .category = FIO_OPT_C_IO,
1365 .group = FIO_OPT_G_IO_BASIC,
1368 .help = "Use read/write",
1371 .help = "Use pread/pwrite",
1374 .help = "Use readv/writev",
1376 #ifdef CONFIG_PWRITEV
1378 .help = "Use preadv/pwritev",
1381 #ifdef CONFIG_LIBAIO
1383 .help = "Linux native asynchronous IO",
1386 #ifdef CONFIG_POSIXAIO
1387 { .ival = "posixaio",
1388 .help = "POSIX asynchronous IO",
1391 #ifdef CONFIG_SOLARISAIO
1392 { .ival = "solarisaio",
1393 .help = "Solaris native asynchronous IO",
1396 #ifdef CONFIG_WINDOWSAIO
1397 { .ival = "windowsaio",
1398 .help = "Windows native asynchronous IO"
1403 .help = "Rados Block Device asynchronous IO"
1407 .help = "Memory mapped IO"
1409 #ifdef CONFIG_LINUX_SPLICE
1411 .help = "splice/vmsplice based IO",
1413 { .ival = "netsplice",
1414 .help = "splice/vmsplice to/from the network",
1417 #ifdef FIO_HAVE_SGIO
1419 .help = "SCSI generic v3 IO",
1423 .help = "Testing engine (no data transfer)",
1426 .help = "Network IO",
1429 .help = "CPU cycle burner engine",
1433 .help = "GUASI IO engine",
1436 #ifdef FIO_HAVE_BINJECT
1437 { .ival = "binject",
1438 .help = "binject direct inject block engine",
1443 .help = "RDMA IO engine",
1446 #ifdef CONFIG_FUSION_AW
1447 { .ival = "fusion-aw-sync",
1448 .help = "Fusion-io atomic write engine",
1451 #ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1452 { .ival = "e4defrag",
1453 .help = "ext4 defrag engine",
1456 #ifdef CONFIG_LINUX_FALLOCATE
1458 .help = "fallocate() file based engine",
1463 .help = "Glusterfs libgfapi(sync) based engine"
1465 { .ival = "gfapi_async",
1466 .help = "Glusterfs libgfapi(async) based engine"
1469 #ifdef CONFIG_LIBHDFS
1470 { .ival = "libhdfs",
1471 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1474 { .ival = "external",
1475 .help = "Load external engine (append name)",
1481 .lname = "IO Depth",
1482 .type = FIO_OPT_INT,
1483 .off1 = td_var_offset(iodepth),
1484 .help = "Number of IO buffers to keep in flight",
1488 .category = FIO_OPT_C_IO,
1489 .group = FIO_OPT_G_IO_BASIC,
1492 .name = "iodepth_batch",
1493 .lname = "IO Depth batch",
1494 .alias = "iodepth_batch_submit",
1495 .type = FIO_OPT_INT,
1496 .off1 = td_var_offset(iodepth_batch),
1497 .help = "Number of IO buffers to submit in one go",
1498 .parent = "iodepth",
1503 .category = FIO_OPT_C_IO,
1504 .group = FIO_OPT_G_IO_BASIC,
1507 .name = "iodepth_batch_complete_min",
1508 .lname = "Min IO depth batch complete",
1509 .alias = "iodepth_batch_complete",
1510 .type = FIO_OPT_INT,
1511 .off1 = td_var_offset(iodepth_batch_complete_min),
1512 .help = "Min number of IO buffers to retrieve in one go",
1513 .parent = "iodepth",
1518 .category = FIO_OPT_C_IO,
1519 .group = FIO_OPT_G_IO_BASIC,
1522 .name = "iodepth_batch_complete_max",
1523 .lname = "Max IO depth batch complete",
1524 .type = FIO_OPT_INT,
1525 .off1 = td_var_offset(iodepth_batch_complete_max),
1526 .help = "Max number of IO buffers to retrieve in one go",
1527 .parent = "iodepth",
1531 .category = FIO_OPT_C_IO,
1532 .group = FIO_OPT_G_IO_BASIC,
1535 .name = "iodepth_low",
1536 .lname = "IO Depth batch low",
1537 .type = FIO_OPT_INT,
1538 .off1 = td_var_offset(iodepth_low),
1539 .help = "Low water mark for queuing depth",
1540 .parent = "iodepth",
1543 .category = FIO_OPT_C_IO,
1544 .group = FIO_OPT_G_IO_BASIC,
1547 .name = "io_submit_mode",
1548 .lname = "IO submit mode",
1549 .type = FIO_OPT_STR,
1550 .off1 = td_var_offset(io_submit_mode),
1551 .help = "How IO submissions and completions are done",
1553 .category = FIO_OPT_C_IO,
1554 .group = FIO_OPT_G_IO_BASIC,
1557 .oval = IO_MODE_INLINE,
1558 .help = "Submit and complete IO inline",
1560 { .ival = "offload",
1561 .oval = IO_MODE_OFFLOAD,
1562 .help = "Offload submit and complete to threads",
1569 .type = FIO_OPT_STR_VAL,
1571 .off1 = td_var_offset(size),
1572 .help = "Total size of device or files",
1573 .interval = 1024 * 1024,
1574 .category = FIO_OPT_C_IO,
1575 .group = FIO_OPT_G_INVALID,
1579 .alias = "io_limit",
1581 .type = FIO_OPT_STR_VAL,
1582 .off1 = td_var_offset(io_limit),
1583 .interval = 1024 * 1024,
1584 .category = FIO_OPT_C_IO,
1585 .group = FIO_OPT_G_INVALID,
1588 .name = "fill_device",
1589 .lname = "Fill device",
1591 .type = FIO_OPT_BOOL,
1592 .off1 = td_var_offset(fill_device),
1593 .help = "Write until an ENOSPC error occurs",
1595 .category = FIO_OPT_C_FILE,
1596 .group = FIO_OPT_G_INVALID,
1600 .lname = "File size",
1601 .type = FIO_OPT_STR_VAL,
1602 .off1 = td_var_offset(file_size_low),
1603 .off2 = td_var_offset(file_size_high),
1605 .help = "Size of individual files",
1606 .interval = 1024 * 1024,
1607 .category = FIO_OPT_C_FILE,
1608 .group = FIO_OPT_G_INVALID,
1611 .name = "file_append",
1612 .lname = "File append",
1613 .type = FIO_OPT_BOOL,
1614 .off1 = td_var_offset(file_append),
1615 .help = "IO will start at the end of the file(s)",
1617 .category = FIO_OPT_C_FILE,
1618 .group = FIO_OPT_G_INVALID,
1622 .lname = "IO offset",
1623 .alias = "fileoffset",
1624 .type = FIO_OPT_STR_VAL,
1625 .off1 = td_var_offset(start_offset),
1626 .help = "Start IO from this offset",
1628 .interval = 1024 * 1024,
1629 .category = FIO_OPT_C_IO,
1630 .group = FIO_OPT_G_INVALID,
1633 .name = "offset_increment",
1634 .lname = "IO offset increment",
1635 .type = FIO_OPT_STR_VAL,
1636 .off1 = td_var_offset(offset_increment),
1637 .help = "What is the increment from one offset to the next",
1641 .interval = 1024 * 1024,
1642 .category = FIO_OPT_C_IO,
1643 .group = FIO_OPT_G_INVALID,
1646 .name = "number_ios",
1647 .lname = "Number of IOs to perform",
1648 .type = FIO_OPT_STR_VAL,
1649 .off1 = td_var_offset(number_ios),
1650 .help = "Force job completion after this number of IOs",
1652 .category = FIO_OPT_C_IO,
1653 .group = FIO_OPT_G_INVALID,
1657 .lname = "Block size",
1658 .alias = "blocksize",
1659 .type = FIO_OPT_INT,
1660 .off1 = td_var_offset(bs[DDIR_READ]),
1661 .off2 = td_var_offset(bs[DDIR_WRITE]),
1662 .off3 = td_var_offset(bs[DDIR_TRIM]),
1664 .help = "Block size unit",
1669 .category = FIO_OPT_C_IO,
1670 .group = FIO_OPT_G_INVALID,
1674 .lname = "Block size align",
1675 .alias = "blockalign",
1676 .type = FIO_OPT_INT,
1677 .off1 = td_var_offset(ba[DDIR_READ]),
1678 .off2 = td_var_offset(ba[DDIR_WRITE]),
1679 .off3 = td_var_offset(ba[DDIR_TRIM]),
1681 .help = "IO block offset alignment",
1685 .category = FIO_OPT_C_IO,
1686 .group = FIO_OPT_G_INVALID,
1690 .lname = "Block size range",
1691 .alias = "blocksize_range",
1692 .type = FIO_OPT_RANGE,
1693 .off1 = td_var_offset(min_bs[DDIR_READ]),
1694 .off2 = td_var_offset(max_bs[DDIR_READ]),
1695 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1696 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1697 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1698 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1700 .help = "Set block size range (in more detail than bs)",
1704 .category = FIO_OPT_C_IO,
1705 .group = FIO_OPT_G_INVALID,
1709 .lname = "Block size split",
1710 .type = FIO_OPT_STR,
1711 .cb = str_bssplit_cb,
1712 .off1 = td_var_offset(bssplit),
1713 .help = "Set a specific mix of block sizes",
1716 .category = FIO_OPT_C_IO,
1717 .group = FIO_OPT_G_INVALID,
1720 .name = "bs_unaligned",
1721 .lname = "Block size unaligned",
1722 .alias = "blocksize_unaligned",
1723 .type = FIO_OPT_STR_SET,
1724 .off1 = td_var_offset(bs_unaligned),
1725 .help = "Don't sector align IO buffer sizes",
1728 .category = FIO_OPT_C_IO,
1729 .group = FIO_OPT_G_INVALID,
1732 .name = "bs_is_seq_rand",
1733 .lname = "Block size division is seq/random (not read/write)",
1734 .type = FIO_OPT_BOOL,
1735 .off1 = td_var_offset(bs_is_seq_rand),
1736 .help = "Consider any blocksize setting to be sequential,random",
1738 .parent = "blocksize",
1739 .category = FIO_OPT_C_IO,
1740 .group = FIO_OPT_G_INVALID,
1743 .name = "randrepeat",
1744 .lname = "Random repeatable",
1745 .type = FIO_OPT_BOOL,
1746 .off1 = td_var_offset(rand_repeatable),
1747 .help = "Use repeatable random IO pattern",
1751 .category = FIO_OPT_C_IO,
1752 .group = FIO_OPT_G_RANDOM,
1756 .lname = "The random generator seed",
1757 .type = FIO_OPT_STR_VAL,
1758 .off1 = td_var_offset(rand_seed),
1759 .help = "Set the random generator seed value",
1762 .category = FIO_OPT_C_IO,
1763 .group = FIO_OPT_G_RANDOM,
1766 .name = "use_os_rand",
1767 .lname = "Use OS random",
1768 .type = FIO_OPT_DEPRECATED,
1769 .off1 = td_var_offset(dep_use_os_rand),
1770 .category = FIO_OPT_C_IO,
1771 .group = FIO_OPT_G_RANDOM,
1774 .name = "norandommap",
1775 .lname = "No randommap",
1776 .type = FIO_OPT_STR_SET,
1777 .off1 = td_var_offset(norandommap),
1778 .help = "Accept potential duplicate random blocks",
1782 .category = FIO_OPT_C_IO,
1783 .group = FIO_OPT_G_RANDOM,
1786 .name = "softrandommap",
1787 .lname = "Soft randommap",
1788 .type = FIO_OPT_BOOL,
1789 .off1 = td_var_offset(softrandommap),
1790 .help = "Set norandommap if randommap allocation fails",
1791 .parent = "norandommap",
1794 .category = FIO_OPT_C_IO,
1795 .group = FIO_OPT_G_RANDOM,
1798 .name = "random_generator",
1799 .type = FIO_OPT_STR,
1800 .off1 = td_var_offset(random_generator),
1801 .help = "Type of random number generator to use",
1802 .def = "tausworthe",
1804 { .ival = "tausworthe",
1805 .oval = FIO_RAND_GEN_TAUSWORTHE,
1806 .help = "Strong Tausworthe generator",
1809 .oval = FIO_RAND_GEN_LFSR,
1810 .help = "Variable length LFSR",
1813 .ival = "tausworthe64",
1814 .oval = FIO_RAND_GEN_TAUSWORTHE64,
1815 .help = "64-bit Tausworthe variant",
1818 .category = FIO_OPT_C_IO,
1819 .group = FIO_OPT_G_RANDOM,
1822 .name = "random_distribution",
1823 .type = FIO_OPT_STR,
1824 .off1 = td_var_offset(random_distribution),
1825 .cb = str_random_distribution_cb,
1826 .help = "Random offset distribution generator",
1830 .oval = FIO_RAND_DIST_RANDOM,
1831 .help = "Completely random",
1834 .oval = FIO_RAND_DIST_ZIPF,
1835 .help = "Zipf distribution",
1838 .oval = FIO_RAND_DIST_PARETO,
1839 .help = "Pareto distribution",
1842 .oval = FIO_RAND_DIST_GAUSS,
1843 .help = "Normal (gaussian) distribution",
1846 .category = FIO_OPT_C_IO,
1847 .group = FIO_OPT_G_RANDOM,
1850 .name = "percentage_random",
1851 .lname = "Percentage Random",
1852 .type = FIO_OPT_INT,
1853 .off1 = td_var_offset(perc_rand[DDIR_READ]),
1854 .off2 = td_var_offset(perc_rand[DDIR_WRITE]),
1855 .off3 = td_var_offset(perc_rand[DDIR_TRIM]),
1857 .help = "Percentage of seq/random mix that should be random",
1858 .def = "100,100,100",
1860 .inverse = "percentage_sequential",
1861 .category = FIO_OPT_C_IO,
1862 .group = FIO_OPT_G_RANDOM,
1865 .name = "percentage_sequential",
1866 .lname = "Percentage Sequential",
1867 .type = FIO_OPT_DEPRECATED,
1868 .category = FIO_OPT_C_IO,
1869 .group = FIO_OPT_G_RANDOM,
1872 .name = "allrandrepeat",
1873 .type = FIO_OPT_BOOL,
1874 .off1 = td_var_offset(allrand_repeatable),
1875 .help = "Use repeatable random numbers for everything",
1877 .category = FIO_OPT_C_IO,
1878 .group = FIO_OPT_G_RANDOM,
1882 .lname = "Number of files",
1883 .alias = "nr_files",
1884 .type = FIO_OPT_INT,
1885 .off1 = td_var_offset(nr_files),
1886 .help = "Split job workload between this number of files",
1889 .category = FIO_OPT_C_FILE,
1890 .group = FIO_OPT_G_INVALID,
1893 .name = "openfiles",
1894 .lname = "Number of open files",
1895 .type = FIO_OPT_INT,
1896 .off1 = td_var_offset(open_files),
1897 .help = "Number of files to keep open at the same time",
1898 .category = FIO_OPT_C_FILE,
1899 .group = FIO_OPT_G_INVALID,
1902 .name = "file_service_type",
1903 .lname = "File service type",
1904 .type = FIO_OPT_STR,
1906 .off1 = td_var_offset(file_service_type),
1907 .help = "How to select which file to service next",
1908 .def = "roundrobin",
1909 .category = FIO_OPT_C_FILE,
1910 .group = FIO_OPT_G_INVALID,
1913 .oval = FIO_FSERVICE_RANDOM,
1914 .help = "Choose a file at random",
1916 { .ival = "roundrobin",
1917 .oval = FIO_FSERVICE_RR,
1918 .help = "Round robin select files",
1920 { .ival = "sequential",
1921 .oval = FIO_FSERVICE_SEQ,
1922 .help = "Finish one file before moving to the next",
1925 .parent = "nrfiles",
1928 #ifdef CONFIG_POSIX_FALLOCATE
1930 .name = "fallocate",
1931 .lname = "Fallocate",
1932 .type = FIO_OPT_STR,
1933 .off1 = td_var_offset(fallocate_mode),
1934 .help = "Whether pre-allocation is performed when laying out files",
1936 .category = FIO_OPT_C_FILE,
1937 .group = FIO_OPT_G_INVALID,
1940 .oval = FIO_FALLOCATE_NONE,
1941 .help = "Do not pre-allocate space",
1944 .oval = FIO_FALLOCATE_POSIX,
1945 .help = "Use posix_fallocate()",
1947 #ifdef CONFIG_LINUX_FALLOCATE
1949 .oval = FIO_FALLOCATE_KEEP_SIZE,
1950 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1953 /* Compatibility with former boolean values */
1955 .oval = FIO_FALLOCATE_NONE,
1956 .help = "Alias for 'none'",
1959 .oval = FIO_FALLOCATE_POSIX,
1960 .help = "Alias for 'posix'",
1964 #endif /* CONFIG_POSIX_FALLOCATE */
1966 .name = "fadvise_hint",
1967 .lname = "Fadvise hint",
1968 .type = FIO_OPT_BOOL,
1969 .off1 = td_var_offset(fadvise_hint),
1970 .help = "Use fadvise() to advise the kernel on IO pattern",
1972 .category = FIO_OPT_C_FILE,
1973 .group = FIO_OPT_G_INVALID,
1975 #ifdef FIO_HAVE_STREAMID
1977 .name = "fadvise_stream",
1978 .lname = "Fadvise stream",
1979 .type = FIO_OPT_INT,
1980 .off1 = td_var_offset(fadvise_stream),
1981 .help = "Use fadvise() to set stream ID",
1982 .category = FIO_OPT_C_FILE,
1983 .group = FIO_OPT_G_INVALID,
1989 .type = FIO_OPT_INT,
1990 .off1 = td_var_offset(fsync_blocks),
1991 .help = "Issue fsync for writes every given number of blocks",
1994 .category = FIO_OPT_C_FILE,
1995 .group = FIO_OPT_G_INVALID,
1998 .name = "fdatasync",
1999 .lname = "Fdatasync",
2000 .type = FIO_OPT_INT,
2001 .off1 = td_var_offset(fdatasync_blocks),
2002 .help = "Issue fdatasync for writes every given number of blocks",
2005 .category = FIO_OPT_C_FILE,
2006 .group = FIO_OPT_G_INVALID,
2009 .name = "write_barrier",
2010 .lname = "Write barrier",
2011 .type = FIO_OPT_INT,
2012 .off1 = td_var_offset(barrier_blocks),
2013 .help = "Make every Nth write a barrier write",
2016 .category = FIO_OPT_C_IO,
2017 .group = FIO_OPT_G_INVALID,
2019 #ifdef CONFIG_SYNC_FILE_RANGE
2021 .name = "sync_file_range",
2022 .lname = "Sync file range",
2024 { .ival = "wait_before",
2025 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2026 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2030 .oval = SYNC_FILE_RANGE_WRITE,
2031 .help = "SYNC_FILE_RANGE_WRITE",
2035 .ival = "wait_after",
2036 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2037 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2041 .type = FIO_OPT_STR_MULTI,
2043 .off1 = td_var_offset(sync_file_range),
2044 .help = "Use sync_file_range()",
2045 .category = FIO_OPT_C_FILE,
2046 .group = FIO_OPT_G_INVALID,
2051 .lname = "Direct I/O",
2052 .type = FIO_OPT_BOOL,
2053 .off1 = td_var_offset(odirect),
2054 .help = "Use O_DIRECT IO (negates buffered)",
2056 .inverse = "buffered",
2057 .category = FIO_OPT_C_IO,
2058 .group = FIO_OPT_G_IO_TYPE,
2062 .lname = "Atomic I/O",
2063 .type = FIO_OPT_BOOL,
2064 .off1 = td_var_offset(oatomic),
2065 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2067 .category = FIO_OPT_C_IO,
2068 .group = FIO_OPT_G_IO_TYPE,
2072 .lname = "Buffered I/O",
2073 .type = FIO_OPT_BOOL,
2074 .off1 = td_var_offset(odirect),
2076 .help = "Use buffered IO (negates direct)",
2078 .inverse = "direct",
2079 .category = FIO_OPT_C_IO,
2080 .group = FIO_OPT_G_IO_TYPE,
2083 .name = "overwrite",
2084 .lname = "Overwrite",
2085 .type = FIO_OPT_BOOL,
2086 .off1 = td_var_offset(overwrite),
2087 .help = "When writing, set whether to overwrite current data",
2089 .category = FIO_OPT_C_FILE,
2090 .group = FIO_OPT_G_INVALID,
2095 .type = FIO_OPT_INT,
2096 .off1 = td_var_offset(loops),
2097 .help = "Number of times to run the job",
2100 .category = FIO_OPT_C_GENERAL,
2101 .group = FIO_OPT_G_RUNTIME,
2105 .lname = "Number of jobs",
2106 .type = FIO_OPT_INT,
2107 .off1 = td_var_offset(numjobs),
2108 .help = "Duplicate this job this many times",
2111 .category = FIO_OPT_C_GENERAL,
2112 .group = FIO_OPT_G_RUNTIME,
2115 .name = "startdelay",
2116 .lname = "Start delay",
2117 .type = FIO_OPT_STR_VAL_TIME,
2118 .off1 = td_var_offset(start_delay),
2119 .off2 = td_var_offset(start_delay_high),
2120 .help = "Only start job when this period has passed",
2124 .category = FIO_OPT_C_GENERAL,
2125 .group = FIO_OPT_G_RUNTIME,
2131 .type = FIO_OPT_STR_VAL_TIME,
2132 .off1 = td_var_offset(timeout),
2133 .help = "Stop workload when this amount of time has passed",
2137 .category = FIO_OPT_C_GENERAL,
2138 .group = FIO_OPT_G_RUNTIME,
2141 .name = "time_based",
2142 .lname = "Time based",
2143 .type = FIO_OPT_STR_SET,
2144 .off1 = td_var_offset(time_based),
2145 .help = "Keep running until runtime/timeout is met",
2146 .category = FIO_OPT_C_GENERAL,
2147 .group = FIO_OPT_G_RUNTIME,
2150 .name = "verify_only",
2151 .lname = "Verify only",
2152 .type = FIO_OPT_STR_SET,
2153 .off1 = td_var_offset(verify_only),
2154 .help = "Verifies previously written data is still valid",
2155 .category = FIO_OPT_C_GENERAL,
2156 .group = FIO_OPT_G_RUNTIME,
2159 .name = "ramp_time",
2160 .lname = "Ramp time",
2161 .type = FIO_OPT_STR_VAL_TIME,
2162 .off1 = td_var_offset(ramp_time),
2163 .help = "Ramp up time before measuring performance",
2166 .category = FIO_OPT_C_GENERAL,
2167 .group = FIO_OPT_G_RUNTIME,
2170 .name = "clocksource",
2171 .lname = "Clock source",
2172 .type = FIO_OPT_STR,
2173 .cb = fio_clock_source_cb,
2174 .off1 = td_var_offset(clocksource),
2175 .help = "What type of timing source to use",
2176 .category = FIO_OPT_C_GENERAL,
2177 .group = FIO_OPT_G_CLOCK,
2179 #ifdef CONFIG_GETTIMEOFDAY
2180 { .ival = "gettimeofday",
2182 .help = "Use gettimeofday(2) for timing",
2185 #ifdef CONFIG_CLOCK_GETTIME
2186 { .ival = "clock_gettime",
2187 .oval = CS_CGETTIME,
2188 .help = "Use clock_gettime(2) for timing",
2191 #ifdef ARCH_HAVE_CPU_CLOCK
2193 .oval = CS_CPUCLOCK,
2194 .help = "Use CPU private clock",
2202 .lname = "I/O Memory",
2203 .type = FIO_OPT_STR,
2205 .off1 = td_var_offset(mem_type),
2206 .help = "Backing type for IO buffers",
2208 .category = FIO_OPT_C_IO,
2209 .group = FIO_OPT_G_INVALID,
2213 .help = "Use malloc(3) for IO buffers",
2215 #ifndef CONFIG_NO_SHM
2218 .help = "Use shared memory segments for IO buffers",
2220 #ifdef FIO_HAVE_HUGETLB
2221 { .ival = "shmhuge",
2222 .oval = MEM_SHMHUGE,
2223 .help = "Like shm, but use huge pages",
2229 .help = "Use mmap(2) (file or anon) for IO buffers",
2231 #ifdef FIO_HAVE_HUGETLB
2232 { .ival = "mmaphuge",
2233 .oval = MEM_MMAPHUGE,
2234 .help = "Like mmap, but use huge pages",
2240 .name = "iomem_align",
2241 .alias = "mem_align",
2242 .lname = "I/O memory alignment",
2243 .type = FIO_OPT_INT,
2244 .off1 = td_var_offset(mem_align),
2246 .help = "IO memory buffer offset alignment",
2250 .category = FIO_OPT_C_IO,
2251 .group = FIO_OPT_G_INVALID,
2256 .type = FIO_OPT_STR,
2257 .off1 = td_var_offset(verify),
2258 .help = "Verify data written",
2260 .category = FIO_OPT_C_IO,
2261 .group = FIO_OPT_G_VERIFY,
2264 .oval = VERIFY_NONE,
2265 .help = "Don't do IO verification",
2269 .help = "Use md5 checksums for verification",
2272 .oval = VERIFY_CRC64,
2273 .help = "Use crc64 checksums for verification",
2276 .oval = VERIFY_CRC32,
2277 .help = "Use crc32 checksums for verification",
2279 { .ival = "crc32c-intel",
2280 .oval = VERIFY_CRC32C,
2281 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2284 .oval = VERIFY_CRC32C,
2285 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2288 .oval = VERIFY_CRC16,
2289 .help = "Use crc16 checksums for verification",
2292 .oval = VERIFY_CRC7,
2293 .help = "Use crc7 checksums for verification",
2296 .oval = VERIFY_SHA1,
2297 .help = "Use sha1 checksums for verification",
2300 .oval = VERIFY_SHA256,
2301 .help = "Use sha256 checksums for verification",
2304 .oval = VERIFY_SHA512,
2305 .help = "Use sha512 checksums for verification",
2308 .oval = VERIFY_XXHASH,
2309 .help = "Use xxhash checksums for verification",
2311 /* Meta information was included into verify_header,
2312 * 'meta' verification is implied by default. */
2314 .oval = VERIFY_HDR_ONLY,
2315 .help = "Use io information for verification. "
2316 "Now is implied by default, thus option is obsolete, "
2319 { .ival = "pattern",
2320 .oval = VERIFY_PATTERN_NO_HDR,
2321 .help = "Verify strict pattern",
2325 .oval = VERIFY_NULL,
2326 .help = "Pretend to verify",
2331 .name = "do_verify",
2332 .lname = "Perform verify step",
2333 .type = FIO_OPT_BOOL,
2334 .off1 = td_var_offset(do_verify),
2335 .help = "Run verification stage after write",
2339 .category = FIO_OPT_C_IO,
2340 .group = FIO_OPT_G_VERIFY,
2343 .name = "verifysort",
2344 .lname = "Verify sort",
2345 .type = FIO_OPT_BOOL,
2346 .off1 = td_var_offset(verifysort),
2347 .help = "Sort written verify blocks for read back",
2351 .category = FIO_OPT_C_IO,
2352 .group = FIO_OPT_G_VERIFY,
2355 .name = "verifysort_nr",
2356 .type = FIO_OPT_INT,
2357 .off1 = td_var_offset(verifysort_nr),
2358 .help = "Pre-load and sort verify blocks for a read workload",
2363 .category = FIO_OPT_C_IO,
2364 .group = FIO_OPT_G_VERIFY,
2367 .name = "verify_interval",
2368 .lname = "Verify interval",
2369 .type = FIO_OPT_INT,
2370 .off1 = td_var_offset(verify_interval),
2371 .minval = 2 * sizeof(struct verify_header),
2372 .help = "Store verify buffer header every N bytes",
2375 .interval = 2 * sizeof(struct verify_header),
2376 .category = FIO_OPT_C_IO,
2377 .group = FIO_OPT_G_VERIFY,
2380 .name = "verify_offset",
2381 .lname = "Verify offset",
2382 .type = FIO_OPT_INT,
2383 .help = "Offset verify header location by N bytes",
2384 .off1 = td_var_offset(verify_offset),
2385 .minval = sizeof(struct verify_header),
2388 .category = FIO_OPT_C_IO,
2389 .group = FIO_OPT_G_VERIFY,
2392 .name = "verify_pattern",
2393 .lname = "Verify pattern",
2394 .type = FIO_OPT_STR,
2395 .cb = str_verify_pattern_cb,
2396 .off1 = td_var_offset(verify_pattern),
2397 .help = "Fill pattern for IO buffers",
2400 .category = FIO_OPT_C_IO,
2401 .group = FIO_OPT_G_VERIFY,
2404 .name = "verify_fatal",
2405 .lname = "Verify fatal",
2406 .type = FIO_OPT_BOOL,
2407 .off1 = td_var_offset(verify_fatal),
2409 .help = "Exit on a single verify failure, don't continue",
2412 .category = FIO_OPT_C_IO,
2413 .group = FIO_OPT_G_VERIFY,
2416 .name = "verify_dump",
2417 .lname = "Verify dump",
2418 .type = FIO_OPT_BOOL,
2419 .off1 = td_var_offset(verify_dump),
2421 .help = "Dump contents of good and bad blocks on failure",
2424 .category = FIO_OPT_C_IO,
2425 .group = FIO_OPT_G_VERIFY,
2428 .name = "verify_async",
2429 .lname = "Verify asynchronously",
2430 .type = FIO_OPT_INT,
2431 .off1 = td_var_offset(verify_async),
2433 .help = "Number of async verifier threads to use",
2436 .category = FIO_OPT_C_IO,
2437 .group = FIO_OPT_G_VERIFY,
2440 .name = "verify_backlog",
2441 .lname = "Verify backlog",
2442 .type = FIO_OPT_STR_VAL,
2443 .off1 = td_var_offset(verify_backlog),
2444 .help = "Verify after this number of blocks are written",
2447 .category = FIO_OPT_C_IO,
2448 .group = FIO_OPT_G_VERIFY,
2451 .name = "verify_backlog_batch",
2452 .lname = "Verify backlog batch",
2453 .type = FIO_OPT_INT,
2454 .off1 = td_var_offset(verify_batch),
2455 .help = "Verify this number of IO blocks",
2458 .category = FIO_OPT_C_IO,
2459 .group = FIO_OPT_G_VERIFY,
2461 #ifdef FIO_HAVE_CPU_AFFINITY
2463 .name = "verify_async_cpus",
2464 .lname = "Async verify CPUs",
2465 .type = FIO_OPT_STR,
2466 .cb = str_verify_cpus_allowed_cb,
2467 .off1 = td_var_offset(verify_cpumask),
2468 .help = "Set CPUs allowed for async verify threads",
2469 .parent = "verify_async",
2471 .category = FIO_OPT_C_IO,
2472 .group = FIO_OPT_G_VERIFY,
2476 .name = "experimental_verify",
2477 .off1 = td_var_offset(experimental_verify),
2478 .type = FIO_OPT_BOOL,
2479 .help = "Enable experimental verification",
2481 .category = FIO_OPT_C_IO,
2482 .group = FIO_OPT_G_VERIFY,
2485 .name = "verify_state_load",
2486 .lname = "Load verify state",
2487 .off1 = td_var_offset(verify_state),
2488 .type = FIO_OPT_BOOL,
2489 .help = "Load verify termination state",
2491 .category = FIO_OPT_C_IO,
2492 .group = FIO_OPT_G_VERIFY,
2495 .name = "verify_state_save",
2496 .lname = "Save verify state",
2497 .off1 = td_var_offset(verify_state_save),
2498 .type = FIO_OPT_BOOL,
2500 .help = "Save verify state on termination",
2502 .category = FIO_OPT_C_IO,
2503 .group = FIO_OPT_G_VERIFY,
2505 #ifdef FIO_HAVE_TRIM
2507 .name = "trim_percentage",
2508 .lname = "Trim percentage",
2509 .type = FIO_OPT_INT,
2510 .off1 = td_var_offset(trim_percentage),
2513 .help = "Number of verify blocks to discard/trim",
2518 .category = FIO_OPT_C_IO,
2519 .group = FIO_OPT_G_TRIM,
2522 .name = "trim_verify_zero",
2523 .lname = "Verify trim zero",
2524 .type = FIO_OPT_BOOL,
2525 .help = "Verify that trim/discarded blocks are returned as zeroes",
2526 .off1 = td_var_offset(trim_zero),
2527 .parent = "trim_percentage",
2530 .category = FIO_OPT_C_IO,
2531 .group = FIO_OPT_G_TRIM,
2534 .name = "trim_backlog",
2535 .lname = "Trim backlog",
2536 .type = FIO_OPT_STR_VAL,
2537 .off1 = td_var_offset(trim_backlog),
2538 .help = "Trim after this number of blocks are written",
2539 .parent = "trim_percentage",
2542 .category = FIO_OPT_C_IO,
2543 .group = FIO_OPT_G_TRIM,
2546 .name = "trim_backlog_batch",
2547 .lname = "Trim backlog batch",
2548 .type = FIO_OPT_INT,
2549 .off1 = td_var_offset(trim_batch),
2550 .help = "Trim this number of IO blocks",
2551 .parent = "trim_percentage",
2554 .category = FIO_OPT_C_IO,
2555 .group = FIO_OPT_G_TRIM,
2559 .name = "write_iolog",
2560 .lname = "Write I/O log",
2561 .type = FIO_OPT_STR_STORE,
2562 .off1 = td_var_offset(write_iolog_file),
2563 .help = "Store IO pattern to file",
2564 .category = FIO_OPT_C_IO,
2565 .group = FIO_OPT_G_IOLOG,
2568 .name = "read_iolog",
2569 .lname = "Read I/O log",
2570 .type = FIO_OPT_STR_STORE,
2571 .off1 = td_var_offset(read_iolog_file),
2572 .help = "Playback IO pattern from file",
2573 .category = FIO_OPT_C_IO,
2574 .group = FIO_OPT_G_IOLOG,
2577 .name = "replay_no_stall",
2578 .lname = "Don't stall on replay",
2579 .type = FIO_OPT_BOOL,
2580 .off1 = td_var_offset(no_stall),
2582 .parent = "read_iolog",
2584 .help = "Playback IO pattern file as fast as possible without stalls",
2585 .category = FIO_OPT_C_IO,
2586 .group = FIO_OPT_G_IOLOG,
2589 .name = "replay_redirect",
2590 .lname = "Redirect device for replay",
2591 .type = FIO_OPT_STR_STORE,
2592 .off1 = td_var_offset(replay_redirect),
2593 .parent = "read_iolog",
2595 .help = "Replay all I/O onto this device, regardless of trace device",
2596 .category = FIO_OPT_C_IO,
2597 .group = FIO_OPT_G_IOLOG,
2600 .name = "replay_scale",
2601 .lname = "Replace offset scale factor",
2602 .type = FIO_OPT_INT,
2603 .off1 = td_var_offset(replay_scale),
2604 .parent = "read_iolog",
2606 .help = "Align offsets to this blocksize",
2607 .category = FIO_OPT_C_IO,
2608 .group = FIO_OPT_G_IOLOG,
2611 .name = "replay_align",
2612 .lname = "Replace alignment",
2613 .type = FIO_OPT_INT,
2614 .off1 = td_var_offset(replay_align),
2615 .parent = "read_iolog",
2616 .help = "Scale offset down by this factor",
2617 .category = FIO_OPT_C_IO,
2618 .group = FIO_OPT_G_IOLOG,
2622 .name = "exec_prerun",
2623 .lname = "Pre-execute runnable",
2624 .type = FIO_OPT_STR_STORE,
2625 .off1 = td_var_offset(exec_prerun),
2626 .help = "Execute this file prior to running job",
2627 .category = FIO_OPT_C_GENERAL,
2628 .group = FIO_OPT_G_INVALID,
2631 .name = "exec_postrun",
2632 .lname = "Post-execute runnable",
2633 .type = FIO_OPT_STR_STORE,
2634 .off1 = td_var_offset(exec_postrun),
2635 .help = "Execute this file after running job",
2636 .category = FIO_OPT_C_GENERAL,
2637 .group = FIO_OPT_G_INVALID,
2639 #ifdef FIO_HAVE_IOSCHED_SWITCH
2641 .name = "ioscheduler",
2642 .lname = "I/O scheduler",
2643 .type = FIO_OPT_STR_STORE,
2644 .off1 = td_var_offset(ioscheduler),
2645 .help = "Use this IO scheduler on the backing device",
2646 .category = FIO_OPT_C_FILE,
2647 .group = FIO_OPT_G_INVALID,
2652 .lname = "Zone size",
2653 .type = FIO_OPT_STR_VAL,
2654 .off1 = td_var_offset(zone_size),
2655 .help = "Amount of data to read per zone",
2657 .interval = 1024 * 1024,
2658 .category = FIO_OPT_C_IO,
2659 .group = FIO_OPT_G_ZONE,
2662 .name = "zonerange",
2663 .lname = "Zone range",
2664 .type = FIO_OPT_STR_VAL,
2665 .off1 = td_var_offset(zone_range),
2666 .help = "Give size of an IO zone",
2668 .interval = 1024 * 1024,
2669 .category = FIO_OPT_C_IO,
2670 .group = FIO_OPT_G_ZONE,
2674 .lname = "Zone skip",
2675 .type = FIO_OPT_STR_VAL,
2676 .off1 = td_var_offset(zone_skip),
2677 .help = "Space between IO zones",
2679 .interval = 1024 * 1024,
2680 .category = FIO_OPT_C_IO,
2681 .group = FIO_OPT_G_ZONE,
2685 .lname = "Lock memory",
2686 .type = FIO_OPT_STR_VAL,
2687 .off1 = td_var_offset(lockmem),
2688 .help = "Lock down this amount of memory (per worker)",
2690 .interval = 1024 * 1024,
2691 .category = FIO_OPT_C_GENERAL,
2692 .group = FIO_OPT_G_INVALID,
2695 .name = "rwmixread",
2696 .lname = "Read/write mix read",
2697 .type = FIO_OPT_INT,
2698 .cb = str_rwmix_read_cb,
2699 .off1 = td_var_offset(rwmix[DDIR_READ]),
2701 .help = "Percentage of mixed workload that is reads",
2704 .inverse = "rwmixwrite",
2705 .category = FIO_OPT_C_IO,
2706 .group = FIO_OPT_G_RWMIX,
2709 .name = "rwmixwrite",
2710 .lname = "Read/write mix write",
2711 .type = FIO_OPT_INT,
2712 .cb = str_rwmix_write_cb,
2713 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
2715 .help = "Percentage of mixed workload that is writes",
2718 .inverse = "rwmixread",
2719 .category = FIO_OPT_C_IO,
2720 .group = FIO_OPT_G_RWMIX,
2723 .name = "rwmixcycle",
2724 .lname = "Read/write mix cycle",
2725 .type = FIO_OPT_DEPRECATED,
2726 .category = FIO_OPT_C_IO,
2727 .group = FIO_OPT_G_RWMIX,
2732 .type = FIO_OPT_INT,
2733 .off1 = td_var_offset(nice),
2734 .help = "Set job CPU nice value",
2739 .category = FIO_OPT_C_GENERAL,
2740 .group = FIO_OPT_G_CRED,
2742 #ifdef FIO_HAVE_IOPRIO
2745 .lname = "I/O nice priority",
2746 .type = FIO_OPT_INT,
2747 .off1 = td_var_offset(ioprio),
2748 .help = "Set job IO priority value",
2752 .category = FIO_OPT_C_GENERAL,
2753 .group = FIO_OPT_G_CRED,
2756 .name = "prioclass",
2757 .lname = "I/O nice priority class",
2758 .type = FIO_OPT_INT,
2759 .off1 = td_var_offset(ioprio_class),
2760 .help = "Set job IO priority class",
2764 .category = FIO_OPT_C_GENERAL,
2765 .group = FIO_OPT_G_CRED,
2769 .name = "thinktime",
2770 .lname = "Thinktime",
2771 .type = FIO_OPT_INT,
2772 .off1 = td_var_offset(thinktime),
2773 .help = "Idle time between IO buffers (usec)",
2776 .category = FIO_OPT_C_IO,
2777 .group = FIO_OPT_G_THINKTIME,
2780 .name = "thinktime_spin",
2781 .lname = "Thinktime spin",
2782 .type = FIO_OPT_INT,
2783 .off1 = td_var_offset(thinktime_spin),
2784 .help = "Start think time by spinning this amount (usec)",
2787 .parent = "thinktime",
2789 .category = FIO_OPT_C_IO,
2790 .group = FIO_OPT_G_THINKTIME,
2793 .name = "thinktime_blocks",
2794 .lname = "Thinktime blocks",
2795 .type = FIO_OPT_INT,
2796 .off1 = td_var_offset(thinktime_blocks),
2797 .help = "IO buffer period between 'thinktime'",
2799 .parent = "thinktime",
2801 .category = FIO_OPT_C_IO,
2802 .group = FIO_OPT_G_THINKTIME,
2806 .lname = "I/O rate",
2807 .type = FIO_OPT_INT,
2808 .off1 = td_var_offset(rate[DDIR_READ]),
2809 .off2 = td_var_offset(rate[DDIR_WRITE]),
2810 .off3 = td_var_offset(rate[DDIR_TRIM]),
2811 .help = "Set bandwidth rate",
2812 .category = FIO_OPT_C_IO,
2813 .group = FIO_OPT_G_RATE,
2817 .lname = "I/O min rate",
2818 .type = FIO_OPT_INT,
2819 .off1 = td_var_offset(ratemin[DDIR_READ]),
2820 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
2821 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
2822 .help = "Job must meet this rate or it will be shutdown",
2825 .category = FIO_OPT_C_IO,
2826 .group = FIO_OPT_G_RATE,
2829 .name = "rate_iops",
2830 .lname = "I/O rate IOPS",
2831 .type = FIO_OPT_INT,
2832 .off1 = td_var_offset(rate_iops[DDIR_READ]),
2833 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
2834 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
2835 .help = "Limit IO used to this number of IO operations/sec",
2837 .category = FIO_OPT_C_IO,
2838 .group = FIO_OPT_G_RATE,
2841 .name = "rate_iops_min",
2842 .lname = "I/O min rate IOPS",
2843 .type = FIO_OPT_INT,
2844 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
2845 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
2846 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
2847 .help = "Job must meet this rate or it will be shut down",
2848 .parent = "rate_iops",
2850 .category = FIO_OPT_C_IO,
2851 .group = FIO_OPT_G_RATE,
2854 .name = "ratecycle",
2855 .lname = "I/O rate cycle",
2856 .type = FIO_OPT_INT,
2857 .off1 = td_var_offset(ratecycle),
2858 .help = "Window average for rate limits (msec)",
2862 .category = FIO_OPT_C_IO,
2863 .group = FIO_OPT_G_RATE,
2866 .name = "max_latency",
2867 .type = FIO_OPT_INT,
2868 .off1 = td_var_offset(max_latency),
2869 .help = "Maximum tolerated IO latency (usec)",
2871 .category = FIO_OPT_C_IO,
2872 .group = FIO_OPT_G_LATPROF,
2875 .name = "latency_target",
2876 .lname = "Latency Target (usec)",
2877 .type = FIO_OPT_STR_VAL_TIME,
2878 .off1 = td_var_offset(latency_target),
2879 .help = "Ramp to max queue depth supporting this latency",
2881 .category = FIO_OPT_C_IO,
2882 .group = FIO_OPT_G_LATPROF,
2885 .name = "latency_window",
2886 .lname = "Latency Window (usec)",
2887 .type = FIO_OPT_STR_VAL_TIME,
2888 .off1 = td_var_offset(latency_window),
2889 .help = "Time to sustain latency_target",
2891 .category = FIO_OPT_C_IO,
2892 .group = FIO_OPT_G_LATPROF,
2895 .name = "latency_percentile",
2896 .lname = "Latency Percentile",
2897 .type = FIO_OPT_FLOAT_LIST,
2898 .off1 = td_var_offset(latency_percentile),
2899 .help = "Percentile of IOs must be below latency_target",
2904 .category = FIO_OPT_C_IO,
2905 .group = FIO_OPT_G_LATPROF,
2908 .name = "invalidate",
2909 .lname = "Cache invalidate",
2910 .type = FIO_OPT_BOOL,
2911 .off1 = td_var_offset(invalidate_cache),
2912 .help = "Invalidate buffer/page cache prior to running job",
2914 .category = FIO_OPT_C_IO,
2915 .group = FIO_OPT_G_IO_TYPE,
2919 .lname = "Synchronous I/O",
2920 .type = FIO_OPT_BOOL,
2921 .off1 = td_var_offset(sync_io),
2922 .help = "Use O_SYNC for buffered writes",
2924 .parent = "buffered",
2926 .category = FIO_OPT_C_IO,
2927 .group = FIO_OPT_G_IO_TYPE,
2930 .name = "create_serialize",
2931 .lname = "Create serialize",
2932 .type = FIO_OPT_BOOL,
2933 .off1 = td_var_offset(create_serialize),
2934 .help = "Serialize creating of job files",
2936 .category = FIO_OPT_C_FILE,
2937 .group = FIO_OPT_G_INVALID,
2940 .name = "create_fsync",
2941 .lname = "Create fsync",
2942 .type = FIO_OPT_BOOL,
2943 .off1 = td_var_offset(create_fsync),
2944 .help = "fsync file after creation",
2946 .category = FIO_OPT_C_FILE,
2947 .group = FIO_OPT_G_INVALID,
2950 .name = "create_on_open",
2951 .lname = "Create on open",
2952 .type = FIO_OPT_BOOL,
2953 .off1 = td_var_offset(create_on_open),
2954 .help = "Create files when they are opened for IO",
2956 .category = FIO_OPT_C_FILE,
2957 .group = FIO_OPT_G_INVALID,
2960 .name = "create_only",
2961 .type = FIO_OPT_BOOL,
2962 .off1 = td_var_offset(create_only),
2963 .help = "Only perform file creation phase",
2964 .category = FIO_OPT_C_FILE,
2968 .name = "allow_file_create",
2969 .lname = "Allow file create",
2970 .type = FIO_OPT_BOOL,
2971 .off1 = td_var_offset(allow_create),
2972 .help = "Permit fio to create files, if they don't exist",
2974 .category = FIO_OPT_C_FILE,
2975 .group = FIO_OPT_G_FILENAME,
2978 .name = "allow_mounted_write",
2979 .lname = "Allow mounted write",
2980 .type = FIO_OPT_BOOL,
2981 .off1 = td_var_offset(allow_mounted_write),
2982 .help = "Allow writes to a mounted partition",
2984 .category = FIO_OPT_C_FILE,
2985 .group = FIO_OPT_G_FILENAME,
2989 .lname = "Pre-read files",
2990 .type = FIO_OPT_BOOL,
2991 .off1 = td_var_offset(pre_read),
2992 .help = "Pre-read files before starting official testing",
2994 .category = FIO_OPT_C_FILE,
2995 .group = FIO_OPT_G_INVALID,
2997 #ifdef FIO_HAVE_CPU_AFFINITY
3000 .lname = "CPU mask",
3001 .type = FIO_OPT_INT,
3002 .cb = str_cpumask_cb,
3003 .off1 = td_var_offset(cpumask),
3004 .help = "CPU affinity mask",
3005 .category = FIO_OPT_C_GENERAL,
3006 .group = FIO_OPT_G_CRED,
3009 .name = "cpus_allowed",
3010 .lname = "CPUs allowed",
3011 .type = FIO_OPT_STR,
3012 .cb = str_cpus_allowed_cb,
3013 .off1 = td_var_offset(cpumask),
3014 .help = "Set CPUs allowed",
3015 .category = FIO_OPT_C_GENERAL,
3016 .group = FIO_OPT_G_CRED,
3019 .name = "cpus_allowed_policy",
3020 .lname = "CPUs allowed distribution policy",
3021 .type = FIO_OPT_STR,
3022 .off1 = td_var_offset(cpus_allowed_policy),
3023 .help = "Distribution policy for cpus_allowed",
3024 .parent = "cpus_allowed",
3028 .oval = FIO_CPUS_SHARED,
3029 .help = "Mask shared between threads",
3032 .oval = FIO_CPUS_SPLIT,
3033 .help = "Mask split between threads",
3036 .category = FIO_OPT_C_GENERAL,
3037 .group = FIO_OPT_G_CRED,
3040 #ifdef CONFIG_LIBNUMA
3042 .name = "numa_cpu_nodes",
3043 .type = FIO_OPT_STR,
3044 .cb = str_numa_cpunodes_cb,
3045 .off1 = td_var_offset(numa_cpunodes),
3046 .help = "NUMA CPU nodes bind",
3047 .category = FIO_OPT_C_GENERAL,
3048 .group = FIO_OPT_G_INVALID,
3051 .name = "numa_mem_policy",
3052 .type = FIO_OPT_STR,
3053 .cb = str_numa_mpol_cb,
3054 .off1 = td_var_offset(numa_memnodes),
3055 .help = "NUMA memory policy setup",
3056 .category = FIO_OPT_C_GENERAL,
3057 .group = FIO_OPT_G_INVALID,
3061 .name = "end_fsync",
3062 .lname = "End fsync",
3063 .type = FIO_OPT_BOOL,
3064 .off1 = td_var_offset(end_fsync),
3065 .help = "Include fsync at the end of job",
3067 .category = FIO_OPT_C_FILE,
3068 .group = FIO_OPT_G_INVALID,
3071 .name = "fsync_on_close",
3072 .lname = "Fsync on close",
3073 .type = FIO_OPT_BOOL,
3074 .off1 = td_var_offset(fsync_on_close),
3075 .help = "fsync files on close",
3077 .category = FIO_OPT_C_FILE,
3078 .group = FIO_OPT_G_INVALID,
3082 .lname = "Unlink file",
3083 .type = FIO_OPT_BOOL,
3084 .off1 = td_var_offset(unlink),
3085 .help = "Unlink created files after job has completed",
3087 .category = FIO_OPT_C_FILE,
3088 .group = FIO_OPT_G_INVALID,
3092 .lname = "Exit-all on terminate",
3093 .type = FIO_OPT_STR_SET,
3094 .cb = str_exitall_cb,
3095 .help = "Terminate all jobs when one exits",
3096 .category = FIO_OPT_C_GENERAL,
3097 .group = FIO_OPT_G_PROCESS,
3100 .name = "stonewall",
3101 .lname = "Wait for previous",
3102 .alias = "wait_for_previous",
3103 .type = FIO_OPT_STR_SET,
3104 .off1 = td_var_offset(stonewall),
3105 .help = "Insert a hard barrier between this job and previous",
3106 .category = FIO_OPT_C_GENERAL,
3107 .group = FIO_OPT_G_PROCESS,
3110 .name = "new_group",
3111 .lname = "New group",
3112 .type = FIO_OPT_STR_SET,
3113 .off1 = td_var_offset(new_group),
3114 .help = "Mark the start of a new group (for reporting)",
3115 .category = FIO_OPT_C_GENERAL,
3116 .group = FIO_OPT_G_PROCESS,
3121 .type = FIO_OPT_STR_SET,
3122 .off1 = td_var_offset(use_thread),
3123 .help = "Use threads instead of processes",
3124 #ifdef CONFIG_NO_SHM
3128 .category = FIO_OPT_C_GENERAL,
3129 .group = FIO_OPT_G_PROCESS,
3132 .name = "per_job_logs",
3133 .type = FIO_OPT_BOOL,
3134 .off1 = td_var_offset(per_job_logs),
3135 .help = "Include job number in generated log files or not",
3137 .category = FIO_OPT_C_LOG,
3138 .group = FIO_OPT_G_INVALID,
3141 .name = "write_bw_log",
3142 .lname = "Write bandwidth log",
3143 .type = FIO_OPT_STR_STORE,
3144 .off1 = td_var_offset(bw_log_file),
3145 .help = "Write log of bandwidth during run",
3146 .category = FIO_OPT_C_LOG,
3147 .group = FIO_OPT_G_INVALID,
3150 .name = "write_lat_log",
3151 .lname = "Write latency log",
3152 .type = FIO_OPT_STR_STORE,
3153 .off1 = td_var_offset(lat_log_file),
3154 .help = "Write log of latency during run",
3155 .category = FIO_OPT_C_LOG,
3156 .group = FIO_OPT_G_INVALID,
3159 .name = "write_iops_log",
3160 .lname = "Write IOPS log",
3161 .type = FIO_OPT_STR_STORE,
3162 .off1 = td_var_offset(iops_log_file),
3163 .help = "Write log of IOPS during run",
3164 .category = FIO_OPT_C_LOG,
3165 .group = FIO_OPT_G_INVALID,
3168 .name = "log_avg_msec",
3169 .lname = "Log averaging (msec)",
3170 .type = FIO_OPT_INT,
3171 .off1 = td_var_offset(log_avg_msec),
3172 .help = "Average bw/iops/lat logs over this period of time",
3174 .category = FIO_OPT_C_LOG,
3175 .group = FIO_OPT_G_INVALID,
3178 .name = "log_offset",
3179 .lname = "Log offset of IO",
3180 .type = FIO_OPT_BOOL,
3181 .off1 = td_var_offset(log_offset),
3182 .help = "Include offset of IO for each log entry",
3184 .category = FIO_OPT_C_LOG,
3185 .group = FIO_OPT_G_INVALID,
3189 .name = "log_compression",
3190 .lname = "Log compression",
3191 .type = FIO_OPT_INT,
3192 .off1 = td_var_offset(log_gz),
3193 .help = "Log in compressed chunks of this size",
3195 .maxval = 512 * 1024 * 1024ULL,
3196 .category = FIO_OPT_C_LOG,
3197 .group = FIO_OPT_G_INVALID,
3200 .name = "log_store_compressed",
3201 .lname = "Log store compressed",
3202 .type = FIO_OPT_BOOL,
3203 .off1 = td_var_offset(log_gz_store),
3204 .help = "Store logs in a compressed format",
3205 .category = FIO_OPT_C_LOG,
3206 .group = FIO_OPT_G_INVALID,
3210 .name = "block_error_percentiles",
3211 .lname = "Block error percentiles",
3212 .type = FIO_OPT_BOOL,
3213 .off1 = td_var_offset(block_error_hist),
3214 .help = "Record trim block errors and make a histogram",
3216 .category = FIO_OPT_C_LOG,
3217 .group = FIO_OPT_G_INVALID,
3220 .name = "bwavgtime",
3221 .lname = "Bandwidth average time",
3222 .type = FIO_OPT_INT,
3223 .off1 = td_var_offset(bw_avg_time),
3224 .help = "Time window over which to calculate bandwidth"
3227 .parent = "write_bw_log",
3230 .category = FIO_OPT_C_LOG,
3231 .group = FIO_OPT_G_INVALID,
3234 .name = "iopsavgtime",
3235 .lname = "IOPS average time",
3236 .type = FIO_OPT_INT,
3237 .off1 = td_var_offset(iops_avg_time),
3238 .help = "Time window over which to calculate IOPS (msec)",
3240 .parent = "write_iops_log",
3243 .category = FIO_OPT_C_LOG,
3244 .group = FIO_OPT_G_INVALID,
3247 .name = "group_reporting",
3248 .lname = "Group reporting",
3249 .type = FIO_OPT_STR_SET,
3250 .off1 = td_var_offset(group_reporting),
3251 .help = "Do reporting on a per-group basis",
3252 .category = FIO_OPT_C_STAT,
3253 .group = FIO_OPT_G_INVALID,
3256 .name = "zero_buffers",
3257 .lname = "Zero I/O buffers",
3258 .type = FIO_OPT_STR_SET,
3259 .off1 = td_var_offset(zero_buffers),
3260 .help = "Init IO buffers to all zeroes",
3261 .category = FIO_OPT_C_IO,
3262 .group = FIO_OPT_G_IO_BUF,
3265 .name = "refill_buffers",
3266 .lname = "Refill I/O buffers",
3267 .type = FIO_OPT_STR_SET,
3268 .off1 = td_var_offset(refill_buffers),
3269 .help = "Refill IO buffers on every IO submit",
3270 .category = FIO_OPT_C_IO,
3271 .group = FIO_OPT_G_IO_BUF,
3274 .name = "scramble_buffers",
3275 .lname = "Scramble I/O buffers",
3276 .type = FIO_OPT_BOOL,
3277 .off1 = td_var_offset(scramble_buffers),
3278 .help = "Slightly scramble buffers on every IO submit",
3280 .category = FIO_OPT_C_IO,
3281 .group = FIO_OPT_G_IO_BUF,
3284 .name = "buffer_pattern",
3285 .lname = "Buffer pattern",
3286 .type = FIO_OPT_STR,
3287 .cb = str_buffer_pattern_cb,
3288 .off1 = td_var_offset(buffer_pattern),
3289 .help = "Fill pattern for IO buffers",
3290 .category = FIO_OPT_C_IO,
3291 .group = FIO_OPT_G_IO_BUF,
3294 .name = "buffer_compress_percentage",
3295 .lname = "Buffer compression percentage",
3296 .type = FIO_OPT_INT,
3297 .cb = str_buffer_compress_cb,
3298 .off1 = td_var_offset(compress_percentage),
3301 .help = "How compressible the buffer is (approximately)",
3303 .category = FIO_OPT_C_IO,
3304 .group = FIO_OPT_G_IO_BUF,
3307 .name = "buffer_compress_chunk",
3308 .lname = "Buffer compression chunk size",
3309 .type = FIO_OPT_INT,
3310 .off1 = td_var_offset(compress_chunk),
3311 .parent = "buffer_compress_percentage",
3313 .help = "Size of compressible region in buffer",
3315 .category = FIO_OPT_C_IO,
3316 .group = FIO_OPT_G_IO_BUF,
3319 .name = "dedupe_percentage",
3320 .lname = "Dedupe percentage",
3321 .type = FIO_OPT_INT,
3322 .cb = str_dedupe_cb,
3323 .off1 = td_var_offset(dedupe_percentage),
3326 .help = "Percentage of buffers that are dedupable",
3328 .category = FIO_OPT_C_IO,
3329 .group = FIO_OPT_G_IO_BUF,
3332 .name = "clat_percentiles",
3333 .lname = "Completion latency percentiles",
3334 .type = FIO_OPT_BOOL,
3335 .off1 = td_var_offset(clat_percentiles),
3336 .help = "Enable the reporting of completion latency percentiles",
3338 .category = FIO_OPT_C_STAT,
3339 .group = FIO_OPT_G_INVALID,
3342 .name = "percentile_list",
3343 .lname = "Percentile list",
3344 .type = FIO_OPT_FLOAT_LIST,
3345 .off1 = td_var_offset(percentile_list),
3346 .off2 = td_var_offset(percentile_precision),
3347 .help = "Specify a custom list of percentiles to report for "
3348 "completion latency and block errors",
3349 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
3350 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3353 .category = FIO_OPT_C_STAT,
3354 .group = FIO_OPT_G_INVALID,
3357 #ifdef FIO_HAVE_DISK_UTIL
3359 .name = "disk_util",
3360 .lname = "Disk utilization",
3361 .type = FIO_OPT_BOOL,
3362 .off1 = td_var_offset(do_disk_util),
3363 .help = "Log disk utilization statistics",
3365 .category = FIO_OPT_C_STAT,
3366 .group = FIO_OPT_G_INVALID,
3370 .name = "gtod_reduce",
3371 .lname = "Reduce gettimeofday() calls",
3372 .type = FIO_OPT_BOOL,
3373 .help = "Greatly reduce number of gettimeofday() calls",
3374 .cb = str_gtod_reduce_cb,
3377 .category = FIO_OPT_C_STAT,
3378 .group = FIO_OPT_G_INVALID,
3381 .name = "disable_lat",
3382 .lname = "Disable all latency stats",
3383 .type = FIO_OPT_BOOL,
3384 .off1 = td_var_offset(disable_lat),
3385 .help = "Disable latency numbers",
3386 .parent = "gtod_reduce",
3389 .category = FIO_OPT_C_STAT,
3390 .group = FIO_OPT_G_INVALID,
3393 .name = "disable_clat",
3394 .lname = "Disable completion latency stats",
3395 .type = FIO_OPT_BOOL,
3396 .off1 = td_var_offset(disable_clat),
3397 .help = "Disable completion latency numbers",
3398 .parent = "gtod_reduce",
3401 .category = FIO_OPT_C_STAT,
3402 .group = FIO_OPT_G_INVALID,
3405 .name = "disable_slat",
3406 .lname = "Disable submission latency stats",
3407 .type = FIO_OPT_BOOL,
3408 .off1 = td_var_offset(disable_slat),
3409 .help = "Disable submission latency numbers",
3410 .parent = "gtod_reduce",
3413 .category = FIO_OPT_C_STAT,
3414 .group = FIO_OPT_G_INVALID,
3417 .name = "disable_bw_measurement",
3418 .lname = "Disable bandwidth stats",
3419 .type = FIO_OPT_BOOL,
3420 .off1 = td_var_offset(disable_bw),
3421 .help = "Disable bandwidth logging",
3422 .parent = "gtod_reduce",
3425 .category = FIO_OPT_C_STAT,
3426 .group = FIO_OPT_G_INVALID,
3430 .lname = "Dedicated gettimeofday() CPU",
3431 .type = FIO_OPT_INT,
3432 .off1 = td_var_offset(gtod_cpu),
3433 .help = "Set up dedicated gettimeofday() thread on this CPU",
3434 .verify = gtod_cpu_verify,
3435 .category = FIO_OPT_C_GENERAL,
3436 .group = FIO_OPT_G_CLOCK,
3439 .name = "unified_rw_reporting",
3440 .type = FIO_OPT_BOOL,
3441 .off1 = td_var_offset(unified_rw_rep),
3442 .help = "Unify reporting across data direction",
3444 .category = FIO_OPT_C_GENERAL,
3445 .group = FIO_OPT_G_INVALID,
3448 .name = "continue_on_error",
3449 .lname = "Continue on error",
3450 .type = FIO_OPT_STR,
3451 .off1 = td_var_offset(continue_on_error),
3452 .help = "Continue on non-fatal errors during IO",
3454 .category = FIO_OPT_C_GENERAL,
3455 .group = FIO_OPT_G_ERR,
3458 .oval = ERROR_TYPE_NONE,
3459 .help = "Exit when an error is encountered",
3462 .oval = ERROR_TYPE_READ,
3463 .help = "Continue on read errors only",
3466 .oval = ERROR_TYPE_WRITE,
3467 .help = "Continue on write errors only",
3470 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
3471 .help = "Continue on any IO errors",
3474 .oval = ERROR_TYPE_VERIFY,
3475 .help = "Continue on verify errors only",
3478 .oval = ERROR_TYPE_ANY,
3479 .help = "Continue on all io and verify errors",
3482 .oval = ERROR_TYPE_NONE,
3483 .help = "Alias for 'none'",
3486 .oval = ERROR_TYPE_ANY,
3487 .help = "Alias for 'all'",
3492 .name = "ignore_error",
3493 .type = FIO_OPT_STR,
3494 .cb = str_ignore_error_cb,
3495 .off1 = td_var_offset(ignore_error_nr),
3496 .help = "Set a specific list of errors to ignore",
3498 .category = FIO_OPT_C_GENERAL,
3499 .group = FIO_OPT_G_ERR,
3502 .name = "error_dump",
3503 .type = FIO_OPT_BOOL,
3504 .off1 = td_var_offset(error_dump),
3506 .help = "Dump info on each error",
3507 .category = FIO_OPT_C_GENERAL,
3508 .group = FIO_OPT_G_ERR,
3513 .type = FIO_OPT_STR_STORE,
3514 .off1 = td_var_offset(profile),
3515 .help = "Select a specific builtin performance test",
3516 .category = FIO_OPT_C_PROFILE,
3517 .group = FIO_OPT_G_INVALID,
3522 .type = FIO_OPT_STR_STORE,
3523 .off1 = td_var_offset(cgroup),
3524 .help = "Add job to cgroup of this name",
3525 .category = FIO_OPT_C_GENERAL,
3526 .group = FIO_OPT_G_CGROUP,
3529 .name = "cgroup_nodelete",
3530 .lname = "Cgroup no-delete",
3531 .type = FIO_OPT_BOOL,
3532 .off1 = td_var_offset(cgroup_nodelete),
3533 .help = "Do not delete cgroups after job completion",
3536 .category = FIO_OPT_C_GENERAL,
3537 .group = FIO_OPT_G_CGROUP,
3540 .name = "cgroup_weight",
3541 .lname = "Cgroup weight",
3542 .type = FIO_OPT_INT,
3543 .off1 = td_var_offset(cgroup_weight),
3544 .help = "Use given weight for cgroup",
3548 .category = FIO_OPT_C_GENERAL,
3549 .group = FIO_OPT_G_CGROUP,
3554 .type = FIO_OPT_INT,
3555 .off1 = td_var_offset(uid),
3556 .help = "Run job with this user ID",
3557 .category = FIO_OPT_C_GENERAL,
3558 .group = FIO_OPT_G_CRED,
3562 .lname = "Group ID",
3563 .type = FIO_OPT_INT,
3564 .off1 = td_var_offset(gid),
3565 .help = "Run job with this group ID",
3566 .category = FIO_OPT_C_GENERAL,
3567 .group = FIO_OPT_G_CRED,
3572 .type = FIO_OPT_INT,
3573 .off1 = td_var_offset(kb_base),
3579 .help = "Use 1024 as the K base",
3583 .help = "Use 1000 as the K base",
3586 .help = "How many bytes per KB for reporting (1000 or 1024)",
3587 .category = FIO_OPT_C_GENERAL,
3588 .group = FIO_OPT_G_INVALID,
3591 .name = "unit_base",
3592 .lname = "Base unit for reporting (Bits or Bytes)",
3593 .type = FIO_OPT_INT,
3594 .off1 = td_var_offset(unit_base),
3599 .help = "Auto-detect",
3603 .help = "Normal (byte based)",
3607 .help = "Bit based",
3610 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
3611 .category = FIO_OPT_C_GENERAL,
3612 .group = FIO_OPT_G_INVALID,
3615 .name = "hugepage-size",
3616 .lname = "Hugepage size",
3617 .type = FIO_OPT_INT,
3618 .off1 = td_var_offset(hugepage_size),
3619 .help = "When using hugepages, specify size of each page",
3620 .def = __fio_stringify(FIO_HUGE_PAGE),
3621 .interval = 1024 * 1024,
3622 .category = FIO_OPT_C_GENERAL,
3623 .group = FIO_OPT_G_INVALID,
3627 .lname = "I/O flow ID",
3628 .type = FIO_OPT_INT,
3629 .off1 = td_var_offset(flow_id),
3630 .help = "The flow index ID to use",
3632 .category = FIO_OPT_C_IO,
3633 .group = FIO_OPT_G_IO_FLOW,
3637 .lname = "I/O flow weight",
3638 .type = FIO_OPT_INT,
3639 .off1 = td_var_offset(flow),
3640 .help = "Weight for flow control of this job",
3641 .parent = "flow_id",
3644 .category = FIO_OPT_C_IO,
3645 .group = FIO_OPT_G_IO_FLOW,
3648 .name = "flow_watermark",
3649 .lname = "I/O flow watermark",
3650 .type = FIO_OPT_INT,
3651 .off1 = td_var_offset(flow_watermark),
3652 .help = "High watermark for flow control. This option"
3653 " should be set to the same value for all threads"
3654 " with non-zero flow.",
3655 .parent = "flow_id",
3658 .category = FIO_OPT_C_IO,
3659 .group = FIO_OPT_G_IO_FLOW,
3662 .name = "flow_sleep",
3663 .lname = "I/O flow sleep",
3664 .type = FIO_OPT_INT,
3665 .off1 = td_var_offset(flow_sleep),
3666 .help = "How many microseconds to sleep after being held"
3667 " back by the flow control mechanism",
3668 .parent = "flow_id",
3671 .category = FIO_OPT_C_IO,
3672 .group = FIO_OPT_G_IO_FLOW,
3676 .lname = "Skip operations against bad blocks",
3677 .type = FIO_OPT_BOOL,
3678 .off1 = td_var_offset(skip_bad),
3679 .help = "Skip operations against known bad blocks.",
3682 .category = FIO_OPT_C_IO,
3683 .group = FIO_OPT_G_MTD,
3690 static void add_to_lopt(struct option *lopt, struct fio_option *o,
3691 const char *name, int val)
3693 lopt->name = (char *) name;
3695 if (o->type == FIO_OPT_STR_SET)
3696 lopt->has_arg = optional_argument;
3698 lopt->has_arg = required_argument;
3701 static void options_to_lopts(struct fio_option *opts,
3702 struct option *long_options,
3703 int i, int option_type)
3705 struct fio_option *o = &opts[0];
3707 add_to_lopt(&long_options[i], o, o->name, option_type);
3710 add_to_lopt(&long_options[i], o, o->alias, option_type);
3715 assert(i < FIO_NR_OPTIONS);
3719 void fio_options_set_ioengine_opts(struct option *long_options,
3720 struct thread_data *td)
3725 while (long_options[i].name) {
3726 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
3727 memset(&long_options[i], 0, sizeof(*long_options));
3734 * Just clear out the prior ioengine options.
3739 options_to_lopts(td->io_ops->options, long_options, i,
3740 FIO_GETOPT_IOENGINE);
3743 void fio_options_dup_and_init(struct option *long_options)
3747 options_init(fio_options);
3750 while (long_options[i].name)
3753 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
3756 struct fio_keyword {
3762 static struct fio_keyword fio_keywords[] = {
3764 .word = "$pagesize",
3765 .desc = "Page size in the system",
3768 .word = "$mb_memory",
3769 .desc = "Megabytes of memory online",
3773 .desc = "Number of CPUs online in the system",
3780 void fio_keywords_exit(void)
3782 struct fio_keyword *kw;
3784 kw = &fio_keywords[0];
3792 void fio_keywords_init(void)
3794 unsigned long long mb_memory;
3798 sprintf(buf, "%lu", (unsigned long) page_size);
3799 fio_keywords[0].replace = strdup(buf);
3801 mb_memory = os_phys_mem() / (1024 * 1024);
3802 sprintf(buf, "%llu", mb_memory);
3803 fio_keywords[1].replace = strdup(buf);
3806 sprintf(buf, "%lu", l);
3807 fio_keywords[2].replace = strdup(buf);
3812 static char *bc_calc(char *str)
3814 char buf[128], *tmp;
3819 * No math, just return string
3821 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
3822 !strchr(str, '/')) || strchr(str, '\''))
3826 * Split option from value, we only need to calculate the value
3828 tmp = strchr(str, '=');
3835 * Prevent buffer overflows; such a case isn't reasonable anyway
3837 if (strlen(str) >= 128 || strlen(tmp) > 100)
3840 sprintf(buf, "which %s > /dev/null", BC_APP);
3842 log_err("fio: bc is needed for performing math\n");
3846 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
3847 f = popen(buf, "r");
3851 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
3858 buf[(tmp - str) + ret - 1] = '\0';
3859 memcpy(buf, str, tmp - str);
3865 * Return a copy of the input string with substrings of the form ${VARNAME}
3866 * substituted with the value of the environment variable VARNAME. The
3867 * substitution always occurs, even if VARNAME is empty or the corresponding
3868 * environment variable undefined.
3870 static char *option_dup_subs(const char *opt)
3872 char out[OPT_LEN_MAX+1];
3873 char in[OPT_LEN_MAX+1];
3876 char *ch1, *ch2, *env;
3877 ssize_t nchr = OPT_LEN_MAX;
3880 if (strlen(opt) + 1 > OPT_LEN_MAX) {
3881 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
3885 in[OPT_LEN_MAX] = '\0';
3886 strncpy(in, opt, OPT_LEN_MAX);
3888 while (*inptr && nchr > 0) {
3889 if (inptr[0] == '$' && inptr[1] == '{') {
3890 ch2 = strchr(inptr, '}');
3891 if (ch2 && inptr+1 < ch2) {
3898 envlen = strlen(env);
3899 if (envlen <= nchr) {
3900 memcpy(outptr, env, envlen);
3910 *outptr++ = *inptr++;
3919 * Look for reserved variable names and replace them with real values
3921 static char *fio_keyword_replace(char *opt)
3927 for (i = 0; fio_keywords[i].word != NULL; i++) {
3928 struct fio_keyword *kw = &fio_keywords[i];
3930 while ((s = strstr(opt, kw->word)) != NULL) {
3931 char *new = malloc(strlen(opt) + 1);
3937 * Copy part of the string before the keyword and
3938 * sprintf() the replacement after it.
3940 memcpy(new, opt, olen);
3941 len = sprintf(new + olen, "%s", kw->replace);
3944 * If there's more in the original string, copy that
3947 opt += strlen(kw->word) + olen;
3949 memcpy(new + olen + len, opt, opt - o_org - 1);
3952 * replace opt and free the old opt
3962 * Check for potential math and invoke bc, if possible
3970 static char **dup_and_sub_options(char **opts, int num_opts)
3973 char **opts_copy = malloc(num_opts * sizeof(*opts));
3974 for (i = 0; i < num_opts; i++) {
3975 opts_copy[i] = option_dup_subs(opts[i]);
3978 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
3983 static void show_closest_option(const char *opt)
3985 int best_option, best_distance;
3994 while (name[i] != '\0' && name[i] != '=')
3999 best_distance = INT_MAX;
4001 while (fio_options[i].name) {
4002 distance = string_distance(name, fio_options[i].name);
4003 if (distance < best_distance) {
4004 best_distance = distance;
4010 if (best_option != -1 && string_distance_ok(name, best_distance))
4011 log_err("Did you mean %s?\n", fio_options[best_option].name);
4016 int fio_options_parse(struct thread_data *td, char **opts, int num_opts,
4019 int i, ret, unknown;
4022 sort_options(opts, fio_options, num_opts);
4023 opts_copy = dup_and_sub_options(opts, num_opts);
4025 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
4026 struct fio_option *o;
4027 int newret = parse_option(opts_copy[i], opts[i], fio_options,
4028 &o, td, dump_cmdline);
4031 fio_option_mark_set(&td->o, o);
4039 opts_copy[i] = NULL;
4046 ret |= ioengine_load(td);
4048 sort_options(opts_copy, td->io_ops->options, num_opts);
4051 for (i = 0; i < num_opts; i++) {
4052 struct fio_option *o = NULL;
4059 newret = parse_option(opts_copy[i], opts[i],
4060 td->io_ops->options, &o,
4061 td->eo, dump_cmdline);
4065 log_err("Bad option <%s>\n", opts[i]);
4066 show_closest_option(opts[i]);
4069 opts_copy[i] = NULL;
4077 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
4081 ret = parse_cmd_option(opt, val, fio_options, td);
4083 struct fio_option *o;
4085 o = find_option(fio_options, opt);
4087 fio_option_mark_set(&td->o, o);
4093 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
4096 return parse_cmd_option(opt, val, td->io_ops->options, td->eo);
4099 void fio_fill_default_options(struct thread_data *td)
4101 td->o.magic = OPT_MAGIC;
4102 fill_default_options(td, fio_options);
4105 int fio_show_option_help(const char *opt)
4107 return show_cmd_help(fio_options, opt);
4110 void options_mem_dupe(void *data, struct fio_option *options)
4112 struct fio_option *o;
4115 for (o = &options[0]; o->name; o++) {
4116 if (o->type != FIO_OPT_STR_STORE)
4119 ptr = td_var(data, o, o->off1);
4121 *ptr = strdup(*ptr);
4126 * dupe FIO_OPT_STR_STORE options
4128 void fio_options_mem_dupe(struct thread_data *td)
4130 options_mem_dupe(&td->o, fio_options);
4132 if (td->eo && td->io_ops) {
4133 void *oldeo = td->eo;
4135 td->eo = malloc(td->io_ops->option_struct_size);
4136 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
4137 options_mem_dupe(td->eo, td->io_ops->options);
4141 unsigned int fio_get_kb_base(void *data)
4143 struct thread_options *o = data;
4144 unsigned int kb_base = 0;
4147 * This is a hack... For private options, *data is not holding
4148 * a pointer to the thread_options, but to private data. This means
4149 * we can't safely dereference it, but magic is first so mem wise
4150 * it is valid. But this also means that if the job first sets
4151 * kb_base and expects that to be honored by private options,
4152 * it will be disappointed. We will return the global default
4155 if (o && o->magic == OPT_MAGIC)
4156 kb_base = o->kb_base;
4163 int add_option(struct fio_option *o)
4165 struct fio_option *__o;
4174 if (opt_index + 1 == FIO_MAX_OPTS) {
4175 log_err("fio: FIO_MAX_OPTS is too small\n");
4179 memcpy(&fio_options[opt_index], o, sizeof(*o));
4180 fio_options[opt_index + 1].name = NULL;
4184 void invalidate_profile_options(const char *prof_name)
4186 struct fio_option *o;
4190 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
4191 o->type = FIO_OPT_INVALID;
4192 o->prof_name = NULL;
4198 void add_opt_posval(const char *optname, const char *ival, const char *help)
4200 struct fio_option *o;
4203 o = find_option(fio_options, optname);
4207 for (i = 0; i < PARSE_MAX_VP; i++) {
4208 if (o->posval[i].ival)
4211 o->posval[i].ival = ival;
4212 o->posval[i].help = help;
4217 void del_opt_posval(const char *optname, const char *ival)
4219 struct fio_option *o;
4222 o = find_option(fio_options, optname);
4226 for (i = 0; i < PARSE_MAX_VP; i++) {
4227 if (!o->posval[i].ival)
4229 if (strcmp(o->posval[i].ival, ival))
4232 o->posval[i].ival = NULL;
4233 o->posval[i].help = NULL;
4237 void fio_options_free(struct thread_data *td)
4239 options_free(fio_options, td);
4240 if (td->eo && td->io_ops && td->io_ops->options) {
4241 options_free(td->io_ops->options, td->eo);
4247 struct fio_option *fio_option_find(const char *name)
4249 return find_option(fio_options, name);
4252 static struct fio_option *find_next_opt(struct thread_options *o,
4253 struct fio_option *from,
4256 struct fio_option *opt;
4259 from = &fio_options[0];
4265 if (off1 == from->off1) {
4270 } while (from->name);
4275 static int opt_is_set(struct thread_options *o, struct fio_option *opt)
4277 unsigned int opt_off, index, offset;
4279 opt_off = opt - &fio_options[0];
4280 index = opt_off / (8 * sizeof(uint64_t));
4281 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
4282 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
4285 int __fio_option_is_set(struct thread_options *o, unsigned int off1)
4287 struct fio_option *opt, *next;
4290 while ((opt = find_next_opt(o, next, off1)) != NULL) {
4291 if (opt_is_set(o, opt))
4300 void fio_option_mark_set(struct thread_options *o, struct fio_option *opt)
4302 unsigned int opt_off, index, offset;
4304 opt_off = opt - &fio_options[0];
4305 index = opt_off / (8 * sizeof(uint64_t));
4306 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
4307 o->set_options[index] |= (uint64_t)1 << offset;