8 #include <netinet/in.h>
13 #include "lib/pattern.h"
17 char client_sockaddr_str[INET6_ADDRSTRLEN] = { 0 };
19 #define cb_data_to_td(data) container_of(data, struct thread_data, o)
21 static struct pattern_fmt_desc fmt_desc[] = {
24 .len = FIELD_SIZE(struct io_u *, offset),
25 .paste = paste_blockoff
30 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
32 static char *get_opt_postfix(const char *str)
34 char *p = strstr(str, ":");
40 strip_blank_front(&p);
45 static int bs_cmp(const void *p1, const void *p2)
47 const struct bssplit *bsp1 = p1;
48 const struct bssplit *bsp2 = p2;
50 return (int) bsp1->perc - (int) bsp2->perc;
55 unsigned long long val1[ZONESPLIT_MAX];
56 unsigned long long val2[ZONESPLIT_MAX];
59 static int split_parse_ddir(struct thread_options *o, struct split *split,
60 char *str, bool absolute, unsigned int max_splits)
62 unsigned long long perc;
70 while ((fname = strsep(&str, ":")) != NULL) {
76 perc_str = strstr(fname, "/");
81 if (str_to_decimal(perc_str, &val, 1, o, 0, 0)) {
82 log_err("fio: split conversion failed\n");
87 perc = atoi(perc_str);
100 if (str_to_decimal(fname, &val, 1, o, 0, 0)) {
101 log_err("fio: split conversion failed\n");
105 split->val1[i] = val;
106 split->val2[i] = perc;
108 if (i == max_splits) {
109 log_err("fio: hit max of %d split entries\n", i);
118 static int bssplit_ddir(struct thread_options *o, enum fio_ddir ddir, char *str,
121 unsigned int i, perc, perc_missing;
122 unsigned long long max_bs, min_bs;
125 memset(&split, 0, sizeof(split));
127 if (split_parse_ddir(o, &split, str, data, BSSPLIT_MAX))
134 o->bssplit[ddir] = malloc(split.nr * sizeof(struct bssplit));
135 o->bssplit_nr[ddir] = split.nr;
136 for (i = 0; i < split.nr; i++) {
137 if (split.val1[i] > max_bs)
138 max_bs = split.val1[i];
139 if (split.val1[i] < min_bs)
140 min_bs = split.val1[i];
142 o->bssplit[ddir][i].bs = split.val1[i];
143 o->bssplit[ddir][i].perc =split.val2[i];
147 * Now check if the percentages add up, and how much is missing
149 perc = perc_missing = 0;
150 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
151 struct bssplit *bsp = &o->bssplit[ddir][i];
153 if (bsp->perc == -1U)
159 if (perc > 100 && perc_missing > 1) {
160 log_err("fio: bssplit percentages add to more than 100%%\n");
161 free(o->bssplit[ddir]);
162 o->bssplit[ddir] = NULL;
167 * If values didn't have a percentage set, divide the remains between
171 if (perc_missing == 1 && o->bssplit_nr[ddir] == 1)
173 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
174 struct bssplit *bsp = &o->bssplit[ddir][i];
176 if (bsp->perc == -1U)
177 bsp->perc = (100 - perc) / perc_missing;
181 o->min_bs[ddir] = min_bs;
182 o->max_bs[ddir] = max_bs;
185 * now sort based on percentages, for ease of lookup
187 qsort(o->bssplit[ddir], o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
191 typedef int (split_parse_fn)(struct thread_options *, enum fio_ddir, char *, bool);
193 static int str_split_parse(struct thread_data *td, char *str,
194 split_parse_fn *fn, bool data)
199 odir = strchr(str, ',');
201 ddir = strchr(odir + 1, ',');
203 ret = fn(&td->o, DDIR_TRIM, ddir + 1, data);
209 op = strdup(odir + 1);
210 ret = fn(&td->o, DDIR_TRIM, op, data);
215 ret = fn(&td->o, DDIR_WRITE, odir + 1, data);
218 ret = fn(&td->o, DDIR_READ, str, data);
224 ret = fn(&td->o, DDIR_WRITE, op, data);
229 ret = fn(&td->o, DDIR_TRIM, op, data);
233 ret = fn(&td->o, DDIR_READ, str, data);
239 static int str_bssplit_cb(void *data, const char *input)
241 struct thread_data *td = cb_data_to_td(data);
245 p = str = strdup(input);
247 strip_blank_front(&str);
248 strip_blank_end(str);
250 ret = str_split_parse(td, str, bssplit_ddir, false);
252 if (parse_dryrun()) {
255 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
256 free(td->o.bssplit[i]);
257 td->o.bssplit[i] = NULL;
258 td->o.bssplit_nr[i] = 0;
266 static int str2error(char *str)
268 const char *err[] = { "EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
269 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
270 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
271 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
272 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
273 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
274 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
275 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE" };
276 int i = 0, num = sizeof(err) / sizeof(char *);
279 if (!strcmp(err[i], str))
286 static int ignore_error_type(struct thread_data *td, enum error_type_bit etype,
293 if (etype >= ERROR_TYPE_CNT) {
294 log_err("Illegal error type\n");
298 td->o.ignore_error_nr[etype] = 4;
299 error = calloc(4, sizeof(int));
302 while ((fname = strsep(&str, ":")) != NULL) {
308 * grow struct buffer, if needed
310 if (i == td->o.ignore_error_nr[etype]) {
311 td->o.ignore_error_nr[etype] <<= 1;
312 error = realloc(error, td->o.ignore_error_nr[etype]
315 if (fname[0] == 'E') {
316 error[i] = str2error(fname);
318 error[i] = atoi(fname);
320 error[i] = -error[i];
323 log_err("Unknown error %s, please use number value\n",
325 td->o.ignore_error_nr[etype] = 0;
332 td->o.continue_on_error |= 1 << etype;
333 td->o.ignore_error_nr[etype] = i;
334 td->o.ignore_error[etype] = error;
336 td->o.ignore_error_nr[etype] = 0;
344 static int str_replay_skip_cb(void *data, const char *input)
346 struct thread_data *td = cb_data_to_td(data);
353 p = str = strdup(input);
355 strip_blank_front(&str);
356 strip_blank_end(str);
362 if (!strcmp(p, "read"))
363 td->o.replay_skip |= 1u << DDIR_READ;
364 else if (!strcmp(p, "write"))
365 td->o.replay_skip |= 1u << DDIR_WRITE;
366 else if (!strcmp(p, "trim"))
367 td->o.replay_skip |= 1u << DDIR_TRIM;
368 else if (!strcmp(p, "sync"))
369 td->o.replay_skip |= 1u << DDIR_SYNC;
371 log_err("Unknown skip type: %s\n", p);
381 static int str_ignore_error_cb(void *data, const char *input)
383 struct thread_data *td = cb_data_to_td(data);
386 enum error_type_bit type = 0;
391 p = str = strdup(input);
393 strip_blank_front(&str);
394 strip_blank_end(str);
400 ret = ignore_error_type(td, type, p);
410 static int str_rw_cb(void *data, const char *str)
412 struct thread_data *td = cb_data_to_td(data);
413 struct thread_options *o = &td->o;
422 nr = get_opt_postfix(str);
427 o->ddir_seq_nr = atoi(nr);
431 if (str_to_decimal(nr, &val, 1, o, 0, 0)) {
432 log_err("fio: rw postfix parsing failed\n");
437 o->ddir_seq_add = val;
444 static int str_mem_cb(void *data, const char *mem)
446 struct thread_data *td = cb_data_to_td(data);
448 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP ||
449 td->o.mem_type == MEM_MMAPSHARED)
450 td->o.mmapfile = get_opt_postfix(mem);
455 static int fio_clock_source_cb(void *data, const char *str)
457 struct thread_data *td = cb_data_to_td(data);
459 fio_clock_source = td->o.clocksource;
460 fio_clock_source_set = 1;
465 static int str_rwmix_read_cb(void *data, unsigned long long *val)
467 struct thread_data *td = cb_data_to_td(data);
469 td->o.rwmix[DDIR_READ] = *val;
470 td->o.rwmix[DDIR_WRITE] = 100 - *val;
474 static int str_rwmix_write_cb(void *data, unsigned long long *val)
476 struct thread_data *td = cb_data_to_td(data);
478 td->o.rwmix[DDIR_WRITE] = *val;
479 td->o.rwmix[DDIR_READ] = 100 - *val;
483 static int str_exitall_cb(void)
485 exitall_on_terminate = true;
489 #ifdef FIO_HAVE_CPU_AFFINITY
490 int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
492 unsigned int i, index, cpus_in_mask;
493 const long max_cpu = cpus_online();
495 cpus_in_mask = fio_cpu_count(mask);
499 cpu_index = cpu_index % cpus_in_mask;
502 for (i = 0; i < max_cpu; i++) {
503 if (!fio_cpu_isset(mask, i))
506 if (cpu_index != index)
507 fio_cpu_clear(mask, i);
512 return fio_cpu_count(mask);
515 static int str_cpumask_cb(void *data, unsigned long long *val)
517 struct thread_data *td = cb_data_to_td(data);
525 ret = fio_cpuset_init(&td->o.cpumask);
527 log_err("fio: cpuset_init failed\n");
528 td_verror(td, ret, "fio_cpuset_init");
532 max_cpu = cpus_online();
534 for (i = 0; i < sizeof(int) * 8; i++) {
535 if ((1 << i) & *val) {
537 log_err("fio: CPU %d too large (max=%ld)\n", i,
541 dprint(FD_PARSE, "set cpu allowed %d\n", i);
542 fio_cpu_set(&td->o.cpumask, i);
549 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
556 ret = fio_cpuset_init(mask);
558 log_err("fio: cpuset_init failed\n");
559 td_verror(td, ret, "fio_cpuset_init");
563 p = str = strdup(input);
565 strip_blank_front(&str);
566 strip_blank_end(str);
568 max_cpu = cpus_online();
570 while ((cpu = strsep(&str, ",")) != NULL) {
579 while ((cpu2 = strsep(&str2, "-")) != NULL) {
589 while (icpu <= icpu2) {
590 if (icpu >= FIO_MAX_CPUS) {
591 log_err("fio: your OS only supports up to"
592 " %d CPUs\n", (int) FIO_MAX_CPUS);
596 if (icpu >= max_cpu) {
597 log_err("fio: CPU %d too large (max=%ld)\n",
603 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
604 fio_cpu_set(mask, icpu);
615 static int str_cpus_allowed_cb(void *data, const char *input)
617 struct thread_data *td = cb_data_to_td(data);
622 return set_cpus_allowed(td, &td->o.cpumask, input);
625 static int str_verify_cpus_allowed_cb(void *data, const char *input)
627 struct thread_data *td = cb_data_to_td(data);
632 return set_cpus_allowed(td, &td->o.verify_cpumask, input);
636 static int str_log_cpus_allowed_cb(void *data, const char *input)
638 struct thread_data *td = cb_data_to_td(data);
643 return set_cpus_allowed(td, &td->o.log_gz_cpumask, input);
645 #endif /* CONFIG_ZLIB */
647 #endif /* FIO_HAVE_CPU_AFFINITY */
649 #ifdef CONFIG_LIBNUMA
650 static int str_numa_cpunodes_cb(void *data, char *input)
652 struct thread_data *td = cb_data_to_td(data);
653 struct bitmask *verify_bitmask;
658 /* numa_parse_nodestring() parses a character string list
659 * of nodes into a bit mask. The bit mask is allocated by
660 * numa_allocate_nodemask(), so it should be freed by
661 * numa_free_nodemask().
663 verify_bitmask = numa_parse_nodestring(input);
664 if (verify_bitmask == NULL) {
665 log_err("fio: numa_parse_nodestring failed\n");
666 td_verror(td, 1, "str_numa_cpunodes_cb");
669 numa_free_nodemask(verify_bitmask);
671 td->o.numa_cpunodes = strdup(input);
675 static int str_numa_mpol_cb(void *data, char *input)
677 struct thread_data *td = cb_data_to_td(data);
678 const char * const policy_types[] =
679 { "default", "prefer", "bind", "interleave", "local", NULL };
682 struct bitmask *verify_bitmask;
687 nodelist = strchr(input, ':');
689 /* NUL-terminate mode */
693 for (i = 0; i <= MPOL_LOCAL; i++) {
694 if (!strcmp(input, policy_types[i])) {
695 td->o.numa_mem_mode = i;
699 if (i > MPOL_LOCAL) {
700 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
704 switch (td->o.numa_mem_mode) {
707 * Insist on a nodelist of one node only
710 char *rest = nodelist;
711 while (isdigit(*rest))
714 log_err("fio: one node only for \'prefer\'\n");
718 log_err("fio: one node is needed for \'prefer\'\n");
722 case MPOL_INTERLEAVE:
724 * Default to online nodes with memory if no nodelist
727 nodelist = strdup("all");
732 * Don't allow a nodelist
735 log_err("fio: NO nodelist for \'local\'\n");
741 * Insist on a nodelist
744 log_err("fio: a nodelist is needed for \'bind\'\n");
751 /* numa_parse_nodestring() parses a character string list
752 * of nodes into a bit mask. The bit mask is allocated by
753 * numa_allocate_nodemask(), so it should be freed by
754 * numa_free_nodemask().
756 switch (td->o.numa_mem_mode) {
758 td->o.numa_mem_prefer_node = atoi(nodelist);
760 case MPOL_INTERLEAVE:
762 verify_bitmask = numa_parse_nodestring(nodelist);
763 if (verify_bitmask == NULL) {
764 log_err("fio: numa_parse_nodestring failed\n");
765 td_verror(td, 1, "str_numa_memnodes_cb");
768 td->o.numa_memnodes = strdup(nodelist);
769 numa_free_nodemask(verify_bitmask);
784 static int str_fst_cb(void *data, const char *str)
786 struct thread_data *td = cb_data_to_td(data);
791 td->file_service_nr = 1;
793 switch (td->o.file_service_type) {
794 case FIO_FSERVICE_RANDOM:
795 case FIO_FSERVICE_RR:
796 case FIO_FSERVICE_SEQ:
797 nr = get_opt_postfix(str);
799 td->file_service_nr = atoi(nr);
804 case FIO_FSERVICE_ZIPF:
807 case FIO_FSERVICE_PARETO:
808 val = FIO_DEF_PARETO;
810 case FIO_FSERVICE_GAUSS:
814 log_err("fio: bad file service type: %d\n", td->o.file_service_type);
821 nr = get_opt_postfix(str);
822 if (nr && !str_to_float(nr, &val, 0)) {
823 log_err("fio: file service type random postfix parsing failed\n");
830 switch (td->o.file_service_type) {
831 case FIO_FSERVICE_ZIPF:
833 log_err("fio: zipf theta must be different than 1.0\n");
838 td->zipf_theta = val;
840 case FIO_FSERVICE_PARETO:
841 if (val <= 0.00 || val >= 1.00) {
842 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
849 case FIO_FSERVICE_GAUSS:
850 if (val < 0.00 || val >= 100.00) {
851 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
863 #ifdef CONFIG_SYNC_FILE_RANGE
864 static int str_sfr_cb(void *data, const char *str)
866 struct thread_data *td = cb_data_to_td(data);
867 char *nr = get_opt_postfix(str);
869 td->sync_file_range_nr = 1;
871 td->sync_file_range_nr = atoi(nr);
879 static int zone_split_ddir(struct thread_options *o, enum fio_ddir ddir,
880 char *str, bool absolute)
882 unsigned int i, perc, perc_missing, sperc, sperc_missing;
885 memset(&split, 0, sizeof(split));
887 if (split_parse_ddir(o, &split, str, absolute, ZONESPLIT_MAX))
892 o->zone_split[ddir] = malloc(split.nr * sizeof(struct zone_split));
893 o->zone_split_nr[ddir] = split.nr;
894 for (i = 0; i < split.nr; i++) {
895 o->zone_split[ddir][i].access_perc = split.val1[i];
897 o->zone_split[ddir][i].size = split.val2[i];
899 o->zone_split[ddir][i].size_perc = split.val2[i];
903 * Now check if the percentages add up, and how much is missing
905 perc = perc_missing = 0;
906 sperc = sperc_missing = 0;
907 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
908 struct zone_split *zsp = &o->zone_split[ddir][i];
910 if (zsp->access_perc == (uint8_t) -1U)
913 perc += zsp->access_perc;
916 if (zsp->size_perc == (uint8_t) -1U)
919 sperc += zsp->size_perc;
923 if (perc > 100 || sperc > 100) {
924 log_err("fio: zone_split percentages add to more than 100%%\n");
925 free(o->zone_split[ddir]);
926 o->zone_split[ddir] = NULL;
930 log_err("fio: access percentage don't add up to 100 for zoned "
931 "random distribution (got=%u)\n", perc);
932 free(o->zone_split[ddir]);
933 o->zone_split[ddir] = NULL;
938 * If values didn't have a percentage set, divide the remains between
942 if (perc_missing == 1 && o->zone_split_nr[ddir] == 1)
944 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
945 struct zone_split *zsp = &o->zone_split[ddir][i];
947 if (zsp->access_perc == (uint8_t) -1U)
948 zsp->access_perc = (100 - perc) / perc_missing;
952 if (sperc_missing == 1 && o->zone_split_nr[ddir] == 1)
954 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
955 struct zone_split *zsp = &o->zone_split[ddir][i];
957 if (zsp->size_perc == (uint8_t) -1U)
958 zsp->size_perc = (100 - sperc) / sperc_missing;
965 static int parse_zoned_distribution(struct thread_data *td, const char *input,
968 const char *pre = absolute ? "zoned_abs:" : "zoned:";
972 p = str = strdup(input);
974 strip_blank_front(&str);
975 strip_blank_end(str);
977 /* We expect it to start like that, bail if not */
978 if (strncmp(str, pre, strlen(pre))) {
979 log_err("fio: mismatch in zoned input <%s>\n", str);
985 ret = str_split_parse(td, str, zone_split_ddir, absolute);
989 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
992 dprint(FD_PARSE, "zone ddir %d (nr=%u): \n", i, td->o.zone_split_nr[i]);
994 for (j = 0; j < td->o.zone_split_nr[i]; j++) {
995 struct zone_split *zsp = &td->o.zone_split[i][j];
998 dprint(FD_PARSE, "\t%d: %u/%llu\n", j,
1000 (unsigned long long) zsp->size);
1002 dprint(FD_PARSE, "\t%d: %u/%u\n", j,
1009 if (parse_dryrun()) {
1010 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1011 free(td->o.zone_split[i]);
1012 td->o.zone_split[i] = NULL;
1013 td->o.zone_split_nr[i] = 0;
1020 for (i = 0; i < DDIR_RWDIR_CNT; i++)
1021 td->o.zone_split_nr[i] = 0;
1027 static int str_random_distribution_cb(void *data, const char *str)
1029 struct thread_data *td = cb_data_to_td(data);
1033 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
1035 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
1036 val = FIO_DEF_PARETO;
1037 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
1039 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED)
1040 return parse_zoned_distribution(td, str, false);
1041 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED_ABS)
1042 return parse_zoned_distribution(td, str, true);
1046 nr = get_opt_postfix(str);
1047 if (nr && !str_to_float(nr, &val, 0)) {
1048 log_err("fio: random postfix parsing failed\n");
1055 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
1057 log_err("fio: zipf theta must different than 1.0\n");
1062 td->o.zipf_theta.u.f = val;
1063 } else if (td->o.random_distribution == FIO_RAND_DIST_PARETO) {
1064 if (val <= 0.00 || val >= 1.00) {
1065 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
1070 td->o.pareto_h.u.f = val;
1072 if (val < 0.00 || val >= 100.0) {
1073 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
1078 td->o.gauss_dev.u.f = val;
1084 static int str_steadystate_cb(void *data, const char *str)
1086 struct thread_data *td = cb_data_to_td(data);
1092 if (td->o.ss_state != FIO_SS_IOPS && td->o.ss_state != FIO_SS_IOPS_SLOPE &&
1093 td->o.ss_state != FIO_SS_BW && td->o.ss_state != FIO_SS_BW_SLOPE) {
1094 /* should be impossible to get here */
1095 log_err("fio: unknown steady state criterion\n");
1099 nr = get_opt_postfix(str);
1101 log_err("fio: steadystate threshold must be specified in addition to criterion\n");
1106 /* ENHANCEMENT Allow fio to understand size=10.2% and use here */
1107 pct = strstr(nr, "%");
1110 strip_blank_end(nr);
1111 if (!str_to_float(nr, &val, 0)) {
1112 log_err("fio: could not parse steadystate threshold percentage\n");
1117 dprint(FD_PARSE, "set steady state threshold to %f%%\n", val);
1122 td->o.ss_state |= FIO_SS_PCT;
1123 td->o.ss_limit.u.f = val;
1124 } else if (td->o.ss_state & FIO_SS_IOPS) {
1125 if (!str_to_float(nr, &val, 0)) {
1126 log_err("fio: steadystate IOPS threshold postfix parsing failed\n");
1131 dprint(FD_PARSE, "set steady state IOPS threshold to %f\n", val);
1136 td->o.ss_limit.u.f = val;
1137 } else { /* bandwidth criterion */
1138 if (str_to_decimal(nr, &ll, 1, td, 0, 0)) {
1139 log_err("fio: steadystate BW threshold postfix parsing failed\n");
1144 dprint(FD_PARSE, "set steady state BW threshold to %lld\n", ll);
1149 td->o.ss_limit.u.f = (double) ll;
1152 td->ss.state = td->o.ss_state;
1157 * Return next name in the string. Files are separated with ':'. If the ':'
1158 * is escaped with a '\', then that ':' is part of the filename and does not
1159 * indicate a new file.
1161 char *get_next_str(char **ptr)
1166 if (!str || !strlen(str))
1172 * No colon, we are done
1174 p = strchr(str, ':');
1181 * We got a colon, but it's the first character. Skip and
1189 if (*(p - 1) != '\\') {
1195 memmove(p - 1, p, strlen(p) + 1);
1203 int get_max_str_idx(char *input)
1205 unsigned int cur_idx;
1208 p = str = strdup(input);
1209 for (cur_idx = 0; ; cur_idx++)
1210 if (get_next_str(&str) == NULL)
1218 * Returns the directory at the index, indexes > entires will be
1219 * assigned via modulo division of the index
1221 int set_name_idx(char *target, size_t tlen, char *input, int index,
1222 bool unique_filename)
1224 unsigned int cur_idx;
1226 char *fname, *str, *p;
1228 p = str = strdup(input);
1230 index %= get_max_str_idx(input);
1231 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1232 fname = get_next_str(&str);
1234 if (client_sockaddr_str[0] && unique_filename) {
1235 len = snprintf(target, tlen, "%s/%s.", fname,
1236 client_sockaddr_str);
1238 len = snprintf(target, tlen, "%s/", fname);
1240 target[tlen - 1] = '\0';
1246 char* get_name_by_idx(char *input, int index)
1248 unsigned int cur_idx;
1249 char *fname, *str, *p;
1251 p = str = strdup(input);
1253 index %= get_max_str_idx(input);
1254 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1255 fname = get_next_str(&str);
1257 fname = strdup(fname);
1263 static int str_filename_cb(void *data, const char *input)
1265 struct thread_data *td = cb_data_to_td(data);
1266 char *fname, *str, *p;
1268 p = str = strdup(input);
1270 strip_blank_front(&str);
1271 strip_blank_end(str);
1274 * Ignore what we may already have from nrfiles option.
1276 if (!td->files_index)
1279 while ((fname = get_next_str(&str)) != NULL) {
1282 add_file(td, fname, 0, 1);
1289 static int str_directory_cb(void *data, const char fio_unused *unused)
1291 struct thread_data *td = cb_data_to_td(data);
1293 char *dirname, *str, *p;
1299 p = str = strdup(td->o.directory);
1300 while ((dirname = get_next_str(&str)) != NULL) {
1301 if (lstat(dirname, &sb) < 0) {
1304 log_err("fio: %s is not a directory\n", dirname);
1305 td_verror(td, ret, "lstat");
1308 if (!S_ISDIR(sb.st_mode)) {
1309 log_err("fio: %s is not a directory\n", dirname);
1320 static int str_opendir_cb(void *data, const char fio_unused *str)
1322 struct thread_data *td = cb_data_to_td(data);
1327 if (!td->files_index)
1330 return add_dir_files(td, td->o.opendir);
1333 static int str_buffer_pattern_cb(void *data, const char *input)
1335 struct thread_data *td = cb_data_to_td(data);
1338 /* FIXME: for now buffer pattern does not support formats */
1339 ret = parse_and_fill_pattern(input, strlen(input), td->o.buffer_pattern,
1340 MAX_PATTERN_SIZE, NULL, 0, NULL, NULL);
1345 td->o.buffer_pattern_bytes = ret;
1348 * If this job is doing any reading or has compression set,
1349 * ensure that we refill buffers for writes or we could be
1350 * invalidating the pattern through reads.
1352 if (!td->o.compress_percentage && !td_read(td))
1353 td->o.refill_buffers = 0;
1355 td->o.refill_buffers = 1;
1357 td->o.scramble_buffers = 0;
1358 td->o.zero_buffers = 0;
1363 static int str_buffer_compress_cb(void *data, unsigned long long *il)
1365 struct thread_data *td = cb_data_to_td(data);
1367 td->flags |= TD_F_COMPRESS;
1368 td->o.compress_percentage = *il;
1372 static int str_dedupe_cb(void *data, unsigned long long *il)
1374 struct thread_data *td = cb_data_to_td(data);
1376 td->flags |= TD_F_COMPRESS;
1377 td->o.dedupe_percentage = *il;
1378 td->o.refill_buffers = 1;
1382 static int str_verify_pattern_cb(void *data, const char *input)
1384 struct thread_data *td = cb_data_to_td(data);
1387 td->o.verify_fmt_sz = ARRAY_SIZE(td->o.verify_fmt);
1388 ret = parse_and_fill_pattern(input, strlen(input), td->o.verify_pattern,
1389 MAX_PATTERN_SIZE, fmt_desc, sizeof(fmt_desc),
1390 td->o.verify_fmt, &td->o.verify_fmt_sz);
1395 td->o.verify_pattern_bytes = ret;
1397 * VERIFY_* could already be set
1399 if (!fio_option_is_set(&td->o, verify))
1400 td->o.verify = VERIFY_PATTERN;
1405 static int str_gtod_reduce_cb(void *data, int *il)
1407 struct thread_data *td = cb_data_to_td(data);
1410 td->o.disable_lat = !!val;
1411 td->o.disable_clat = !!val;
1412 td->o.disable_slat = !!val;
1413 td->o.disable_bw = !!val;
1414 td->o.clat_percentiles = !val;
1416 td->ts_cache_mask = 63;
1421 static int str_offset_cb(void *data, unsigned long long *__val)
1423 struct thread_data *td = cb_data_to_td(data);
1424 unsigned long long v = *__val;
1426 if (parse_is_percent(v)) {
1427 td->o.start_offset = 0;
1428 td->o.start_offset_percent = -1ULL - v;
1429 dprint(FD_PARSE, "SET start_offset_percent %d\n",
1430 td->o.start_offset_percent);
1432 td->o.start_offset = v;
1437 static int str_size_cb(void *data, unsigned long long *__val)
1439 struct thread_data *td = cb_data_to_td(data);
1440 unsigned long long v = *__val;
1442 if (parse_is_percent(v)) {
1444 td->o.size_percent = -1ULL - v;
1445 dprint(FD_PARSE, "SET size_percent %d\n",
1446 td->o.size_percent);
1453 static int str_write_bw_log_cb(void *data, const char *str)
1455 struct thread_data *td = cb_data_to_td(data);
1458 td->o.bw_log_file = strdup(str);
1460 td->o.write_bw_log = 1;
1464 static int str_write_lat_log_cb(void *data, const char *str)
1466 struct thread_data *td = cb_data_to_td(data);
1469 td->o.lat_log_file = strdup(str);
1471 td->o.write_lat_log = 1;
1475 static int str_write_iops_log_cb(void *data, const char *str)
1477 struct thread_data *td = cb_data_to_td(data);
1480 td->o.iops_log_file = strdup(str);
1482 td->o.write_iops_log = 1;
1486 static int str_write_hist_log_cb(void *data, const char *str)
1488 struct thread_data *td = cb_data_to_td(data);
1491 td->o.hist_log_file = strdup(str);
1493 td->o.write_hist_log = 1;
1498 * str is supposed to be a substring of the strdup'd original string,
1499 * and is valid only if it's a regular file path.
1500 * This function keeps the pointer to the path as needed later.
1502 * "external:/path/to/so\0" <- original pointer updated with strdup'd
1503 * "external\0" <- above pointer after parsed, i.e. ->ioengine
1504 * "/path/to/so\0" <- str argument, i.e. ->ioengine_so_path
1506 static int str_ioengine_external_cb(void *data, const char *str)
1508 struct thread_data *td = cb_data_to_td(data);
1513 log_err("fio: null external ioengine path\n");
1517 p = (char *)str; /* str is mutable */
1518 strip_blank_front(&p);
1521 if (stat(p, &sb) || !S_ISREG(sb.st_mode)) {
1522 log_err("fio: invalid external ioengine path \"%s\"\n", p);
1526 td->o.ioengine_so_path = p;
1530 static int rw_verify(const struct fio_option *o, void *data)
1532 struct thread_data *td = cb_data_to_td(data);
1534 if (read_only && (td_write(td) || td_trim(td))) {
1535 log_err("fio: job <%s> has write or trim bit set, but"
1536 " fio is in read-only mode\n", td->o.name);
1543 static int gtod_cpu_verify(const struct fio_option *o, void *data)
1545 #ifndef FIO_HAVE_CPU_AFFINITY
1546 struct thread_data *td = cb_data_to_td(data);
1548 if (td->o.gtod_cpu) {
1549 log_err("fio: platform must support CPU affinity for"
1550 "gettimeofday() offloading\n");
1559 * Map of job/command line options
1561 struct fio_option fio_options[FIO_MAX_OPTS] = {
1563 .name = "description",
1564 .lname = "Description of job",
1565 .type = FIO_OPT_STR_STORE,
1566 .off1 = offsetof(struct thread_options, description),
1567 .help = "Text job description",
1568 .category = FIO_OPT_C_GENERAL,
1569 .group = FIO_OPT_G_DESC,
1573 .lname = "Job name",
1574 .type = FIO_OPT_STR_STORE,
1575 .off1 = offsetof(struct thread_options, name),
1576 .help = "Name of this job",
1577 .category = FIO_OPT_C_GENERAL,
1578 .group = FIO_OPT_G_DESC,
1582 .lname = "Waitee name",
1583 .type = FIO_OPT_STR_STORE,
1584 .off1 = offsetof(struct thread_options, wait_for),
1585 .help = "Name of the job this one wants to wait for before starting",
1586 .category = FIO_OPT_C_GENERAL,
1587 .group = FIO_OPT_G_DESC,
1591 .lname = "Filename(s)",
1592 .type = FIO_OPT_STR_STORE,
1593 .off1 = offsetof(struct thread_options, filename),
1594 .cb = str_filename_cb,
1595 .prio = -1, /* must come after "directory" */
1596 .help = "File(s) to use for the workload",
1597 .category = FIO_OPT_C_FILE,
1598 .group = FIO_OPT_G_FILENAME,
1601 .name = "directory",
1602 .lname = "Directory",
1603 .type = FIO_OPT_STR_STORE,
1604 .off1 = offsetof(struct thread_options, directory),
1605 .cb = str_directory_cb,
1606 .help = "Directory to store files in",
1607 .category = FIO_OPT_C_FILE,
1608 .group = FIO_OPT_G_FILENAME,
1611 .name = "filename_format",
1612 .lname = "Filename Format",
1613 .type = FIO_OPT_STR_STORE,
1614 .off1 = offsetof(struct thread_options, filename_format),
1615 .prio = -1, /* must come after "directory" */
1616 .help = "Override default $jobname.$jobnum.$filenum naming",
1617 .def = "$jobname.$jobnum.$filenum",
1618 .category = FIO_OPT_C_FILE,
1619 .group = FIO_OPT_G_FILENAME,
1622 .name = "unique_filename",
1623 .lname = "Unique Filename",
1624 .type = FIO_OPT_BOOL,
1625 .off1 = offsetof(struct thread_options, unique_filename),
1626 .help = "For network clients, prefix file with source IP",
1628 .category = FIO_OPT_C_FILE,
1629 .group = FIO_OPT_G_FILENAME,
1633 .lname = "Lockfile",
1634 .type = FIO_OPT_STR,
1635 .off1 = offsetof(struct thread_options, file_lock_mode),
1636 .help = "Lock file when doing IO to it",
1638 .parent = "filename",
1641 .category = FIO_OPT_C_FILE,
1642 .group = FIO_OPT_G_FILENAME,
1645 .oval = FILE_LOCK_NONE,
1646 .help = "No file locking",
1648 { .ival = "exclusive",
1649 .oval = FILE_LOCK_EXCLUSIVE,
1650 .help = "Exclusive file lock",
1653 .ival = "readwrite",
1654 .oval = FILE_LOCK_READWRITE,
1655 .help = "Read vs write lock",
1661 .lname = "Open directory",
1662 .type = FIO_OPT_STR_STORE,
1663 .off1 = offsetof(struct thread_options, opendir),
1664 .cb = str_opendir_cb,
1665 .help = "Recursively add files from this directory and down",
1666 .category = FIO_OPT_C_FILE,
1667 .group = FIO_OPT_G_FILENAME,
1671 .lname = "Read/write",
1672 .alias = "readwrite",
1673 .type = FIO_OPT_STR,
1675 .off1 = offsetof(struct thread_options, td_ddir),
1676 .help = "IO direction",
1678 .verify = rw_verify,
1679 .category = FIO_OPT_C_IO,
1680 .group = FIO_OPT_G_IO_BASIC,
1683 .oval = TD_DDIR_READ,
1684 .help = "Sequential read",
1687 .oval = TD_DDIR_WRITE,
1688 .help = "Sequential write",
1691 .oval = TD_DDIR_TRIM,
1692 .help = "Sequential trim",
1694 { .ival = "randread",
1695 .oval = TD_DDIR_RANDREAD,
1696 .help = "Random read",
1698 { .ival = "randwrite",
1699 .oval = TD_DDIR_RANDWRITE,
1700 .help = "Random write",
1702 { .ival = "randtrim",
1703 .oval = TD_DDIR_RANDTRIM,
1704 .help = "Random trim",
1708 .help = "Sequential read and write mix",
1710 { .ival = "readwrite",
1712 .help = "Sequential read and write mix",
1715 .oval = TD_DDIR_RANDRW,
1716 .help = "Random read and write mix"
1718 { .ival = "trimwrite",
1719 .oval = TD_DDIR_TRIMWRITE,
1720 .help = "Trim and write mix, trims preceding writes"
1725 .name = "rw_sequencer",
1726 .lname = "RW Sequencer",
1727 .type = FIO_OPT_STR,
1728 .off1 = offsetof(struct thread_options, rw_seq),
1729 .help = "IO offset generator modifier",
1730 .def = "sequential",
1731 .category = FIO_OPT_C_IO,
1732 .group = FIO_OPT_G_IO_BASIC,
1734 { .ival = "sequential",
1736 .help = "Generate sequential offsets",
1738 { .ival = "identical",
1739 .oval = RW_SEQ_IDENT,
1740 .help = "Generate identical offsets",
1747 .lname = "IO Engine",
1748 .type = FIO_OPT_STR_STORE,
1749 .off1 = offsetof(struct thread_options, ioengine),
1750 .help = "IO engine to use",
1751 .def = FIO_PREFERRED_ENGINE,
1752 .category = FIO_OPT_C_IO,
1753 .group = FIO_OPT_G_IO_BASIC,
1756 .help = "Use read/write",
1759 .help = "Use pread/pwrite",
1762 .help = "Use readv/writev",
1764 #ifdef CONFIG_PWRITEV
1766 .help = "Use preadv/pwritev",
1769 #ifdef FIO_HAVE_PWRITEV2
1770 { .ival = "pvsync2",
1771 .help = "Use preadv2/pwritev2",
1774 #ifdef CONFIG_LIBAIO
1776 .help = "Linux native asynchronous IO",
1779 #ifdef ARCH_HAVE_IOURING
1780 { .ival = "io_uring",
1781 .help = "Fast Linux native aio",
1784 #ifdef CONFIG_POSIXAIO
1785 { .ival = "posixaio",
1786 .help = "POSIX asynchronous IO",
1789 #ifdef CONFIG_SOLARISAIO
1790 { .ival = "solarisaio",
1791 .help = "Solaris native asynchronous IO",
1794 #ifdef CONFIG_WINDOWSAIO
1795 { .ival = "windowsaio",
1796 .help = "Windows native asynchronous IO"
1801 .help = "Rados Block Device asynchronous IO"
1805 .help = "Memory mapped IO"
1807 #ifdef CONFIG_LINUX_SPLICE
1809 .help = "splice/vmsplice based IO",
1811 { .ival = "netsplice",
1812 .help = "splice/vmsplice to/from the network",
1815 #ifdef FIO_HAVE_SGIO
1817 .help = "SCSI generic v3 IO",
1821 .help = "Testing engine (no data transfer)",
1824 .help = "Network IO",
1827 .help = "CPU cycle burner engine",
1831 .help = "GUASI IO engine",
1836 .help = "RDMA IO engine",
1839 #ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1840 { .ival = "e4defrag",
1841 .help = "ext4 defrag engine",
1844 #ifdef CONFIG_LINUX_FALLOCATE
1846 .help = "fallocate() file based engine",
1851 .help = "Glusterfs libgfapi(sync) based engine"
1853 { .ival = "gfapi_async",
1854 .help = "Glusterfs libgfapi(async) based engine"
1857 #ifdef CONFIG_LIBHDFS
1858 { .ival = "libhdfs",
1859 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1862 #ifdef CONFIG_PMEMBLK
1863 { .ival = "pmemblk",
1864 .help = "PMDK libpmemblk based IO engine",
1869 { .ival = "ime_psync",
1870 .help = "DDN's IME synchronous IO engine",
1872 { .ival = "ime_psyncv",
1873 .help = "DDN's IME synchronous IO engine using iovecs",
1875 { .ival = "ime_aio",
1876 .help = "DDN's IME asynchronous IO engine",
1879 #ifdef CONFIG_LINUX_DEVDAX
1880 { .ival = "dev-dax",
1881 .help = "DAX Device based IO engine",
1885 .ival = "filecreate",
1886 .help = "File creation engine",
1888 { .ival = "external",
1889 .help = "Load external engine (append name)",
1890 .cb = str_ioengine_external_cb,
1892 #ifdef CONFIG_LIBPMEM
1893 { .ival = "libpmem",
1894 .help = "PMDK libpmem based IO engine",
1899 .help = "HTTP (WebDAV/S3) IO engine",
1906 .lname = "IO Depth",
1907 .type = FIO_OPT_INT,
1908 .off1 = offsetof(struct thread_options, iodepth),
1909 .help = "Number of IO buffers to keep in flight",
1913 .category = FIO_OPT_C_IO,
1914 .group = FIO_OPT_G_IO_BASIC,
1917 .name = "iodepth_batch",
1918 .lname = "IO Depth batch",
1919 .alias = "iodepth_batch_submit",
1920 .type = FIO_OPT_INT,
1921 .off1 = offsetof(struct thread_options, iodepth_batch),
1922 .help = "Number of IO buffers to submit in one go",
1923 .parent = "iodepth",
1927 .category = FIO_OPT_C_IO,
1928 .group = FIO_OPT_G_IO_BASIC,
1931 .name = "iodepth_batch_complete_min",
1932 .lname = "Min IO depth batch complete",
1933 .alias = "iodepth_batch_complete",
1934 .type = FIO_OPT_INT,
1935 .off1 = offsetof(struct thread_options, iodepth_batch_complete_min),
1936 .help = "Min number of IO buffers to retrieve in one go",
1937 .parent = "iodepth",
1942 .category = FIO_OPT_C_IO,
1943 .group = FIO_OPT_G_IO_BASIC,
1946 .name = "iodepth_batch_complete_max",
1947 .lname = "Max IO depth batch complete",
1948 .type = FIO_OPT_INT,
1949 .off1 = offsetof(struct thread_options, iodepth_batch_complete_max),
1950 .help = "Max number of IO buffers to retrieve in one go",
1951 .parent = "iodepth",
1955 .category = FIO_OPT_C_IO,
1956 .group = FIO_OPT_G_IO_BASIC,
1959 .name = "iodepth_low",
1960 .lname = "IO Depth batch low",
1961 .type = FIO_OPT_INT,
1962 .off1 = offsetof(struct thread_options, iodepth_low),
1963 .help = "Low water mark for queuing depth",
1964 .parent = "iodepth",
1967 .category = FIO_OPT_C_IO,
1968 .group = FIO_OPT_G_IO_BASIC,
1971 .name = "serialize_overlap",
1972 .lname = "Serialize overlap",
1973 .off1 = offsetof(struct thread_options, serialize_overlap),
1974 .type = FIO_OPT_BOOL,
1975 .help = "Wait for in-flight IOs that collide to complete",
1976 .parent = "iodepth",
1978 .category = FIO_OPT_C_IO,
1979 .group = FIO_OPT_G_IO_BASIC,
1982 .name = "io_submit_mode",
1983 .lname = "IO submit mode",
1984 .type = FIO_OPT_STR,
1985 .off1 = offsetof(struct thread_options, io_submit_mode),
1986 .help = "How IO submissions and completions are done",
1988 .category = FIO_OPT_C_IO,
1989 .group = FIO_OPT_G_IO_BASIC,
1992 .oval = IO_MODE_INLINE,
1993 .help = "Submit and complete IO inline",
1995 { .ival = "offload",
1996 .oval = IO_MODE_OFFLOAD,
1997 .help = "Offload submit and complete to threads",
2004 .type = FIO_OPT_STR_VAL,
2006 .off1 = offsetof(struct thread_options, size),
2007 .help = "Total size of device or files",
2008 .interval = 1024 * 1024,
2009 .category = FIO_OPT_C_IO,
2010 .group = FIO_OPT_G_INVALID,
2014 .alias = "io_limit",
2016 .type = FIO_OPT_STR_VAL,
2017 .off1 = offsetof(struct thread_options, io_size),
2018 .help = "Total size of I/O to be performed",
2019 .interval = 1024 * 1024,
2020 .category = FIO_OPT_C_IO,
2021 .group = FIO_OPT_G_INVALID,
2024 .name = "fill_device",
2025 .lname = "Fill device",
2027 .type = FIO_OPT_BOOL,
2028 .off1 = offsetof(struct thread_options, fill_device),
2029 .help = "Write until an ENOSPC error occurs",
2031 .category = FIO_OPT_C_FILE,
2032 .group = FIO_OPT_G_INVALID,
2036 .lname = "File size",
2037 .type = FIO_OPT_STR_VAL,
2038 .off1 = offsetof(struct thread_options, file_size_low),
2039 .off2 = offsetof(struct thread_options, file_size_high),
2041 .help = "Size of individual files",
2042 .interval = 1024 * 1024,
2043 .category = FIO_OPT_C_FILE,
2044 .group = FIO_OPT_G_INVALID,
2047 .name = "file_append",
2048 .lname = "File append",
2049 .type = FIO_OPT_BOOL,
2050 .off1 = offsetof(struct thread_options, file_append),
2051 .help = "IO will start at the end of the file(s)",
2053 .category = FIO_OPT_C_FILE,
2054 .group = FIO_OPT_G_INVALID,
2058 .lname = "IO offset",
2059 .alias = "fileoffset",
2060 .type = FIO_OPT_STR_VAL,
2061 .cb = str_offset_cb,
2062 .off1 = offsetof(struct thread_options, start_offset),
2063 .help = "Start IO from this offset",
2065 .interval = 1024 * 1024,
2066 .category = FIO_OPT_C_IO,
2067 .group = FIO_OPT_G_INVALID,
2070 .name = "offset_align",
2071 .lname = "IO offset alignment",
2072 .type = FIO_OPT_INT,
2073 .off1 = offsetof(struct thread_options, start_offset_align),
2074 .help = "Start IO from this offset alignment",
2077 .category = FIO_OPT_C_IO,
2078 .group = FIO_OPT_G_INVALID,
2081 .name = "offset_increment",
2082 .lname = "IO offset increment",
2083 .type = FIO_OPT_STR_VAL,
2084 .off1 = offsetof(struct thread_options, offset_increment),
2085 .help = "What is the increment from one offset to the next",
2089 .interval = 1024 * 1024,
2090 .category = FIO_OPT_C_IO,
2091 .group = FIO_OPT_G_INVALID,
2094 .name = "number_ios",
2095 .lname = "Number of IOs to perform",
2096 .type = FIO_OPT_STR_VAL,
2097 .off1 = offsetof(struct thread_options, number_ios),
2098 .help = "Force job completion after this number of IOs",
2100 .category = FIO_OPT_C_IO,
2101 .group = FIO_OPT_G_INVALID,
2105 .lname = "Block size",
2106 .alias = "blocksize",
2107 .type = FIO_OPT_ULL,
2108 .off1 = offsetof(struct thread_options, bs[DDIR_READ]),
2109 .off2 = offsetof(struct thread_options, bs[DDIR_WRITE]),
2110 .off3 = offsetof(struct thread_options, bs[DDIR_TRIM]),
2112 .help = "Block size unit",
2117 .category = FIO_OPT_C_IO,
2118 .group = FIO_OPT_G_INVALID,
2122 .lname = "Block size align",
2123 .alias = "blockalign",
2124 .type = FIO_OPT_ULL,
2125 .off1 = offsetof(struct thread_options, ba[DDIR_READ]),
2126 .off2 = offsetof(struct thread_options, ba[DDIR_WRITE]),
2127 .off3 = offsetof(struct thread_options, ba[DDIR_TRIM]),
2129 .help = "IO block offset alignment",
2133 .category = FIO_OPT_C_IO,
2134 .group = FIO_OPT_G_INVALID,
2138 .lname = "Block size range",
2139 .alias = "blocksize_range",
2140 .type = FIO_OPT_RANGE,
2141 .off1 = offsetof(struct thread_options, min_bs[DDIR_READ]),
2142 .off2 = offsetof(struct thread_options, max_bs[DDIR_READ]),
2143 .off3 = offsetof(struct thread_options, min_bs[DDIR_WRITE]),
2144 .off4 = offsetof(struct thread_options, max_bs[DDIR_WRITE]),
2145 .off5 = offsetof(struct thread_options, min_bs[DDIR_TRIM]),
2146 .off6 = offsetof(struct thread_options, max_bs[DDIR_TRIM]),
2148 .help = "Set block size range (in more detail than bs)",
2152 .category = FIO_OPT_C_IO,
2153 .group = FIO_OPT_G_INVALID,
2157 .lname = "Block size split",
2158 .type = FIO_OPT_STR_ULL,
2159 .cb = str_bssplit_cb,
2160 .off1 = offsetof(struct thread_options, bssplit),
2161 .help = "Set a specific mix of block sizes",
2164 .category = FIO_OPT_C_IO,
2165 .group = FIO_OPT_G_INVALID,
2168 .name = "bs_unaligned",
2169 .lname = "Block size unaligned",
2170 .alias = "blocksize_unaligned",
2171 .type = FIO_OPT_STR_SET,
2172 .off1 = offsetof(struct thread_options, bs_unaligned),
2173 .help = "Don't sector align IO buffer sizes",
2176 .category = FIO_OPT_C_IO,
2177 .group = FIO_OPT_G_INVALID,
2180 .name = "bs_is_seq_rand",
2181 .lname = "Block size division is seq/random (not read/write)",
2182 .type = FIO_OPT_BOOL,
2183 .off1 = offsetof(struct thread_options, bs_is_seq_rand),
2184 .help = "Consider any blocksize setting to be sequential,random",
2186 .parent = "blocksize",
2187 .category = FIO_OPT_C_IO,
2188 .group = FIO_OPT_G_INVALID,
2191 .name = "randrepeat",
2192 .lname = "Random repeatable",
2193 .type = FIO_OPT_BOOL,
2194 .off1 = offsetof(struct thread_options, rand_repeatable),
2195 .help = "Use repeatable random IO pattern",
2199 .category = FIO_OPT_C_IO,
2200 .group = FIO_OPT_G_RANDOM,
2204 .lname = "The random generator seed",
2205 .type = FIO_OPT_STR_VAL,
2206 .off1 = offsetof(struct thread_options, rand_seed),
2207 .help = "Set the random generator seed value",
2210 .category = FIO_OPT_C_IO,
2211 .group = FIO_OPT_G_RANDOM,
2214 .name = "norandommap",
2215 .lname = "No randommap",
2216 .type = FIO_OPT_STR_SET,
2217 .off1 = offsetof(struct thread_options, norandommap),
2218 .help = "Accept potential duplicate random blocks",
2222 .category = FIO_OPT_C_IO,
2223 .group = FIO_OPT_G_RANDOM,
2226 .name = "softrandommap",
2227 .lname = "Soft randommap",
2228 .type = FIO_OPT_BOOL,
2229 .off1 = offsetof(struct thread_options, softrandommap),
2230 .help = "Set norandommap if randommap allocation fails",
2231 .parent = "norandommap",
2234 .category = FIO_OPT_C_IO,
2235 .group = FIO_OPT_G_RANDOM,
2238 .name = "random_generator",
2239 .lname = "Random Generator",
2240 .type = FIO_OPT_STR,
2241 .off1 = offsetof(struct thread_options, random_generator),
2242 .help = "Type of random number generator to use",
2243 .def = "tausworthe",
2245 { .ival = "tausworthe",
2246 .oval = FIO_RAND_GEN_TAUSWORTHE,
2247 .help = "Strong Tausworthe generator",
2250 .oval = FIO_RAND_GEN_LFSR,
2251 .help = "Variable length LFSR",
2254 .ival = "tausworthe64",
2255 .oval = FIO_RAND_GEN_TAUSWORTHE64,
2256 .help = "64-bit Tausworthe variant",
2259 .category = FIO_OPT_C_IO,
2260 .group = FIO_OPT_G_RANDOM,
2263 .name = "random_distribution",
2264 .lname = "Random Distribution",
2265 .type = FIO_OPT_STR,
2266 .off1 = offsetof(struct thread_options, random_distribution),
2267 .cb = str_random_distribution_cb,
2268 .help = "Random offset distribution generator",
2272 .oval = FIO_RAND_DIST_RANDOM,
2273 .help = "Completely random",
2276 .oval = FIO_RAND_DIST_ZIPF,
2277 .help = "Zipf distribution",
2280 .oval = FIO_RAND_DIST_PARETO,
2281 .help = "Pareto distribution",
2284 .oval = FIO_RAND_DIST_GAUSS,
2285 .help = "Normal (Gaussian) distribution",
2288 .oval = FIO_RAND_DIST_ZONED,
2289 .help = "Zoned random distribution",
2291 { .ival = "zoned_abs",
2292 .oval = FIO_RAND_DIST_ZONED_ABS,
2293 .help = "Zoned absolute random distribution",
2296 .category = FIO_OPT_C_IO,
2297 .group = FIO_OPT_G_RANDOM,
2300 .name = "percentage_random",
2301 .lname = "Percentage Random",
2302 .type = FIO_OPT_INT,
2303 .off1 = offsetof(struct thread_options, perc_rand[DDIR_READ]),
2304 .off2 = offsetof(struct thread_options, perc_rand[DDIR_WRITE]),
2305 .off3 = offsetof(struct thread_options, perc_rand[DDIR_TRIM]),
2307 .help = "Percentage of seq/random mix that should be random",
2308 .def = "100,100,100",
2310 .inverse = "percentage_sequential",
2311 .category = FIO_OPT_C_IO,
2312 .group = FIO_OPT_G_RANDOM,
2315 .name = "percentage_sequential",
2316 .lname = "Percentage Sequential",
2317 .type = FIO_OPT_DEPRECATED,
2318 .category = FIO_OPT_C_IO,
2319 .group = FIO_OPT_G_RANDOM,
2322 .name = "allrandrepeat",
2323 .lname = "All Random Repeat",
2324 .type = FIO_OPT_BOOL,
2325 .off1 = offsetof(struct thread_options, allrand_repeatable),
2326 .help = "Use repeatable random numbers for everything",
2328 .category = FIO_OPT_C_IO,
2329 .group = FIO_OPT_G_RANDOM,
2333 .lname = "Number of files",
2334 .alias = "nr_files",
2335 .type = FIO_OPT_INT,
2336 .off1 = offsetof(struct thread_options, nr_files),
2337 .help = "Split job workload between this number of files",
2340 .category = FIO_OPT_C_FILE,
2341 .group = FIO_OPT_G_INVALID,
2344 .name = "openfiles",
2345 .lname = "Number of open files",
2346 .type = FIO_OPT_INT,
2347 .off1 = offsetof(struct thread_options, open_files),
2348 .help = "Number of files to keep open at the same time",
2349 .category = FIO_OPT_C_FILE,
2350 .group = FIO_OPT_G_INVALID,
2353 .name = "file_service_type",
2354 .lname = "File service type",
2355 .type = FIO_OPT_STR,
2357 .off1 = offsetof(struct thread_options, file_service_type),
2358 .help = "How to select which file to service next",
2359 .def = "roundrobin",
2360 .category = FIO_OPT_C_FILE,
2361 .group = FIO_OPT_G_INVALID,
2364 .oval = FIO_FSERVICE_RANDOM,
2365 .help = "Choose a file at random (uniform)",
2368 .oval = FIO_FSERVICE_ZIPF,
2369 .help = "Zipf randomized",
2372 .oval = FIO_FSERVICE_PARETO,
2373 .help = "Pareto randomized",
2376 .oval = FIO_FSERVICE_GAUSS,
2377 .help = "Normal (Gaussian) randomized",
2380 .oval = FIO_FSERVICE_GAUSS,
2381 .help = "Alias for normal",
2383 { .ival = "roundrobin",
2384 .oval = FIO_FSERVICE_RR,
2385 .help = "Round robin select files",
2387 { .ival = "sequential",
2388 .oval = FIO_FSERVICE_SEQ,
2389 .help = "Finish one file before moving to the next",
2392 .parent = "nrfiles",
2395 #ifdef FIO_HAVE_ANY_FALLOCATE
2397 .name = "fallocate",
2398 .lname = "Fallocate",
2399 .type = FIO_OPT_STR,
2400 .off1 = offsetof(struct thread_options, fallocate_mode),
2401 .help = "Whether pre-allocation is performed when laying out files",
2403 .category = FIO_OPT_C_FILE,
2404 .group = FIO_OPT_G_INVALID,
2407 .oval = FIO_FALLOCATE_NONE,
2408 .help = "Do not pre-allocate space",
2411 .oval = FIO_FALLOCATE_NATIVE,
2412 .help = "Use native pre-allocation if possible",
2414 #ifdef CONFIG_POSIX_FALLOCATE
2416 .oval = FIO_FALLOCATE_POSIX,
2417 .help = "Use posix_fallocate()",
2420 #ifdef CONFIG_LINUX_FALLOCATE
2422 .oval = FIO_FALLOCATE_KEEP_SIZE,
2423 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
2426 /* Compatibility with former boolean values */
2428 .oval = FIO_FALLOCATE_NONE,
2429 .help = "Alias for 'none'",
2431 #ifdef CONFIG_POSIX_FALLOCATE
2433 .oval = FIO_FALLOCATE_POSIX,
2434 .help = "Alias for 'posix'",
2439 #else /* FIO_HAVE_ANY_FALLOCATE */
2441 .name = "fallocate",
2442 .lname = "Fallocate",
2443 .type = FIO_OPT_UNSUPPORTED,
2444 .help = "Your platform does not support fallocate",
2446 #endif /* FIO_HAVE_ANY_FALLOCATE */
2448 .name = "fadvise_hint",
2449 .lname = "Fadvise hint",
2450 .type = FIO_OPT_STR,
2451 .off1 = offsetof(struct thread_options, fadvise_hint),
2455 .help = "Don't issue fadvise/madvise",
2459 .help = "Advise using fio IO pattern",
2462 .oval = F_ADV_RANDOM,
2463 .help = "Advise using FADV_RANDOM",
2465 { .ival = "sequential",
2466 .oval = F_ADV_SEQUENTIAL,
2467 .help = "Advise using FADV_SEQUENTIAL",
2470 .help = "Use fadvise() to advise the kernel on IO pattern",
2472 .category = FIO_OPT_C_FILE,
2473 .group = FIO_OPT_G_INVALID,
2478 .type = FIO_OPT_INT,
2479 .off1 = offsetof(struct thread_options, fsync_blocks),
2480 .help = "Issue fsync for writes every given number of blocks",
2483 .category = FIO_OPT_C_FILE,
2484 .group = FIO_OPT_G_INVALID,
2487 .name = "fdatasync",
2488 .lname = "Fdatasync",
2489 .type = FIO_OPT_INT,
2490 .off1 = offsetof(struct thread_options, fdatasync_blocks),
2491 .help = "Issue fdatasync for writes every given number of blocks",
2494 .category = FIO_OPT_C_FILE,
2495 .group = FIO_OPT_G_INVALID,
2498 .name = "write_barrier",
2499 .lname = "Write barrier",
2500 .type = FIO_OPT_INT,
2501 .off1 = offsetof(struct thread_options, barrier_blocks),
2502 .help = "Make every Nth write a barrier write",
2505 .category = FIO_OPT_C_IO,
2506 .group = FIO_OPT_G_INVALID,
2508 #ifdef CONFIG_SYNC_FILE_RANGE
2510 .name = "sync_file_range",
2511 .lname = "Sync file range",
2513 { .ival = "wait_before",
2514 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2515 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2519 .oval = SYNC_FILE_RANGE_WRITE,
2520 .help = "SYNC_FILE_RANGE_WRITE",
2524 .ival = "wait_after",
2525 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2526 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2530 .type = FIO_OPT_STR_MULTI,
2532 .off1 = offsetof(struct thread_options, sync_file_range),
2533 .help = "Use sync_file_range()",
2534 .category = FIO_OPT_C_FILE,
2535 .group = FIO_OPT_G_INVALID,
2539 .name = "sync_file_range",
2540 .lname = "Sync file range",
2541 .type = FIO_OPT_UNSUPPORTED,
2542 .help = "Your platform does not support sync_file_range",
2547 .lname = "Direct I/O",
2548 .type = FIO_OPT_BOOL,
2549 .off1 = offsetof(struct thread_options, odirect),
2550 .help = "Use O_DIRECT IO (negates buffered)",
2552 .inverse = "buffered",
2553 .category = FIO_OPT_C_IO,
2554 .group = FIO_OPT_G_IO_TYPE,
2558 .lname = "Atomic I/O",
2559 .type = FIO_OPT_BOOL,
2560 .off1 = offsetof(struct thread_options, oatomic),
2561 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2563 .category = FIO_OPT_C_IO,
2564 .group = FIO_OPT_G_IO_TYPE,
2568 .lname = "Buffered I/O",
2569 .type = FIO_OPT_BOOL,
2570 .off1 = offsetof(struct thread_options, odirect),
2572 .help = "Use buffered IO (negates direct)",
2574 .inverse = "direct",
2575 .category = FIO_OPT_C_IO,
2576 .group = FIO_OPT_G_IO_TYPE,
2579 .name = "overwrite",
2580 .lname = "Overwrite",
2581 .type = FIO_OPT_BOOL,
2582 .off1 = offsetof(struct thread_options, overwrite),
2583 .help = "When writing, set whether to overwrite current data",
2585 .category = FIO_OPT_C_FILE,
2586 .group = FIO_OPT_G_INVALID,
2591 .type = FIO_OPT_INT,
2592 .off1 = offsetof(struct thread_options, loops),
2593 .help = "Number of times to run the job",
2596 .category = FIO_OPT_C_GENERAL,
2597 .group = FIO_OPT_G_RUNTIME,
2601 .lname = "Number of jobs",
2602 .type = FIO_OPT_INT,
2603 .off1 = offsetof(struct thread_options, numjobs),
2604 .help = "Duplicate this job this many times",
2607 .category = FIO_OPT_C_GENERAL,
2608 .group = FIO_OPT_G_RUNTIME,
2611 .name = "startdelay",
2612 .lname = "Start delay",
2613 .type = FIO_OPT_STR_VAL_TIME,
2614 .off1 = offsetof(struct thread_options, start_delay),
2615 .off2 = offsetof(struct thread_options, start_delay_high),
2616 .help = "Only start job when this period has passed",
2620 .category = FIO_OPT_C_GENERAL,
2621 .group = FIO_OPT_G_RUNTIME,
2627 .type = FIO_OPT_STR_VAL_TIME,
2628 .off1 = offsetof(struct thread_options, timeout),
2629 .help = "Stop workload when this amount of time has passed",
2633 .category = FIO_OPT_C_GENERAL,
2634 .group = FIO_OPT_G_RUNTIME,
2637 .name = "time_based",
2638 .lname = "Time based",
2639 .type = FIO_OPT_STR_SET,
2640 .off1 = offsetof(struct thread_options, time_based),
2641 .help = "Keep running until runtime/timeout is met",
2642 .category = FIO_OPT_C_GENERAL,
2643 .group = FIO_OPT_G_RUNTIME,
2646 .name = "verify_only",
2647 .lname = "Verify only",
2648 .type = FIO_OPT_STR_SET,
2649 .off1 = offsetof(struct thread_options, verify_only),
2650 .help = "Verifies previously written data is still valid",
2651 .category = FIO_OPT_C_GENERAL,
2652 .group = FIO_OPT_G_RUNTIME,
2655 .name = "ramp_time",
2656 .lname = "Ramp time",
2657 .type = FIO_OPT_STR_VAL_TIME,
2658 .off1 = offsetof(struct thread_options, ramp_time),
2659 .help = "Ramp up time before measuring performance",
2662 .category = FIO_OPT_C_GENERAL,
2663 .group = FIO_OPT_G_RUNTIME,
2666 .name = "clocksource",
2667 .lname = "Clock source",
2668 .type = FIO_OPT_STR,
2669 .cb = fio_clock_source_cb,
2670 .off1 = offsetof(struct thread_options, clocksource),
2671 .help = "What type of timing source to use",
2672 .category = FIO_OPT_C_GENERAL,
2673 .group = FIO_OPT_G_CLOCK,
2675 #ifdef CONFIG_GETTIMEOFDAY
2676 { .ival = "gettimeofday",
2678 .help = "Use gettimeofday(2) for timing",
2681 #ifdef CONFIG_CLOCK_GETTIME
2682 { .ival = "clock_gettime",
2683 .oval = CS_CGETTIME,
2684 .help = "Use clock_gettime(2) for timing",
2687 #ifdef ARCH_HAVE_CPU_CLOCK
2689 .oval = CS_CPUCLOCK,
2690 .help = "Use CPU private clock",
2698 .lname = "I/O Memory",
2699 .type = FIO_OPT_STR,
2701 .off1 = offsetof(struct thread_options, mem_type),
2702 .help = "Backing type for IO buffers",
2704 .category = FIO_OPT_C_IO,
2705 .group = FIO_OPT_G_INVALID,
2709 .help = "Use malloc(3) for IO buffers",
2711 #ifndef CONFIG_NO_SHM
2714 .help = "Use shared memory segments for IO buffers",
2716 #ifdef FIO_HAVE_HUGETLB
2717 { .ival = "shmhuge",
2718 .oval = MEM_SHMHUGE,
2719 .help = "Like shm, but use huge pages",
2725 .help = "Use mmap(2) (file or anon) for IO buffers",
2727 { .ival = "mmapshared",
2728 .oval = MEM_MMAPSHARED,
2729 .help = "Like mmap, but use the shared flag",
2731 #ifdef FIO_HAVE_HUGETLB
2732 { .ival = "mmaphuge",
2733 .oval = MEM_MMAPHUGE,
2734 .help = "Like mmap, but use huge pages",
2738 { .ival = "cudamalloc",
2739 .oval = MEM_CUDA_MALLOC,
2740 .help = "Allocate GPU device memory for GPUDirect RDMA",
2746 .name = "iomem_align",
2747 .alias = "mem_align",
2748 .lname = "I/O memory alignment",
2749 .type = FIO_OPT_INT,
2750 .off1 = offsetof(struct thread_options, mem_align),
2752 .help = "IO memory buffer offset alignment",
2756 .category = FIO_OPT_C_IO,
2757 .group = FIO_OPT_G_INVALID,
2762 .type = FIO_OPT_STR,
2763 .off1 = offsetof(struct thread_options, verify),
2764 .help = "Verify data written",
2766 .category = FIO_OPT_C_IO,
2767 .group = FIO_OPT_G_VERIFY,
2770 .oval = VERIFY_NONE,
2771 .help = "Don't do IO verification",
2775 .help = "Use md5 checksums for verification",
2778 .oval = VERIFY_CRC64,
2779 .help = "Use crc64 checksums for verification",
2782 .oval = VERIFY_CRC32,
2783 .help = "Use crc32 checksums for verification",
2785 { .ival = "crc32c-intel",
2786 .oval = VERIFY_CRC32C,
2787 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2790 .oval = VERIFY_CRC32C,
2791 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2794 .oval = VERIFY_CRC16,
2795 .help = "Use crc16 checksums for verification",
2798 .oval = VERIFY_CRC7,
2799 .help = "Use crc7 checksums for verification",
2802 .oval = VERIFY_SHA1,
2803 .help = "Use sha1 checksums for verification",
2806 .oval = VERIFY_SHA256,
2807 .help = "Use sha256 checksums for verification",
2810 .oval = VERIFY_SHA512,
2811 .help = "Use sha512 checksums for verification",
2813 { .ival = "sha3-224",
2814 .oval = VERIFY_SHA3_224,
2815 .help = "Use sha3-224 checksums for verification",
2817 { .ival = "sha3-256",
2818 .oval = VERIFY_SHA3_256,
2819 .help = "Use sha3-256 checksums for verification",
2821 { .ival = "sha3-384",
2822 .oval = VERIFY_SHA3_384,
2823 .help = "Use sha3-384 checksums for verification",
2825 { .ival = "sha3-512",
2826 .oval = VERIFY_SHA3_512,
2827 .help = "Use sha3-512 checksums for verification",
2830 .oval = VERIFY_XXHASH,
2831 .help = "Use xxhash checksums for verification",
2833 /* Meta information was included into verify_header,
2834 * 'meta' verification is implied by default. */
2836 .oval = VERIFY_HDR_ONLY,
2837 .help = "Use io information for verification. "
2838 "Now is implied by default, thus option is obsolete, "
2841 { .ival = "pattern",
2842 .oval = VERIFY_PATTERN_NO_HDR,
2843 .help = "Verify strict pattern",
2847 .oval = VERIFY_NULL,
2848 .help = "Pretend to verify",
2853 .name = "do_verify",
2854 .lname = "Perform verify step",
2855 .type = FIO_OPT_BOOL,
2856 .off1 = offsetof(struct thread_options, do_verify),
2857 .help = "Run verification stage after write",
2861 .category = FIO_OPT_C_IO,
2862 .group = FIO_OPT_G_VERIFY,
2865 .name = "verifysort",
2866 .lname = "Verify sort",
2867 .type = FIO_OPT_SOFT_DEPRECATED,
2868 .category = FIO_OPT_C_IO,
2869 .group = FIO_OPT_G_VERIFY,
2872 .name = "verifysort_nr",
2873 .lname = "Verify Sort Nr",
2874 .type = FIO_OPT_SOFT_DEPRECATED,
2875 .category = FIO_OPT_C_IO,
2876 .group = FIO_OPT_G_VERIFY,
2879 .name = "verify_interval",
2880 .lname = "Verify interval",
2881 .type = FIO_OPT_INT,
2882 .off1 = offsetof(struct thread_options, verify_interval),
2883 .minval = 2 * sizeof(struct verify_header),
2884 .help = "Store verify buffer header every N bytes",
2887 .interval = 2 * sizeof(struct verify_header),
2888 .category = FIO_OPT_C_IO,
2889 .group = FIO_OPT_G_VERIFY,
2892 .name = "verify_offset",
2893 .lname = "Verify offset",
2894 .type = FIO_OPT_INT,
2895 .help = "Offset verify header location by N bytes",
2896 .off1 = offsetof(struct thread_options, verify_offset),
2897 .minval = sizeof(struct verify_header),
2900 .category = FIO_OPT_C_IO,
2901 .group = FIO_OPT_G_VERIFY,
2904 .name = "verify_pattern",
2905 .lname = "Verify pattern",
2906 .type = FIO_OPT_STR,
2907 .cb = str_verify_pattern_cb,
2908 .off1 = offsetof(struct thread_options, verify_pattern),
2909 .help = "Fill pattern for IO buffers",
2912 .category = FIO_OPT_C_IO,
2913 .group = FIO_OPT_G_VERIFY,
2916 .name = "verify_fatal",
2917 .lname = "Verify fatal",
2918 .type = FIO_OPT_BOOL,
2919 .off1 = offsetof(struct thread_options, verify_fatal),
2921 .help = "Exit on a single verify failure, don't continue",
2924 .category = FIO_OPT_C_IO,
2925 .group = FIO_OPT_G_VERIFY,
2928 .name = "verify_dump",
2929 .lname = "Verify dump",
2930 .type = FIO_OPT_BOOL,
2931 .off1 = offsetof(struct thread_options, verify_dump),
2933 .help = "Dump contents of good and bad blocks on failure",
2936 .category = FIO_OPT_C_IO,
2937 .group = FIO_OPT_G_VERIFY,
2940 .name = "verify_async",
2941 .lname = "Verify asynchronously",
2942 .type = FIO_OPT_INT,
2943 .off1 = offsetof(struct thread_options, verify_async),
2945 .help = "Number of async verifier threads to use",
2948 .category = FIO_OPT_C_IO,
2949 .group = FIO_OPT_G_VERIFY,
2952 .name = "verify_backlog",
2953 .lname = "Verify backlog",
2954 .type = FIO_OPT_STR_VAL,
2955 .off1 = offsetof(struct thread_options, verify_backlog),
2956 .help = "Verify after this number of blocks are written",
2959 .category = FIO_OPT_C_IO,
2960 .group = FIO_OPT_G_VERIFY,
2963 .name = "verify_backlog_batch",
2964 .lname = "Verify backlog batch",
2965 .type = FIO_OPT_INT,
2966 .off1 = offsetof(struct thread_options, verify_batch),
2967 .help = "Verify this number of IO blocks",
2970 .category = FIO_OPT_C_IO,
2971 .group = FIO_OPT_G_VERIFY,
2973 #ifdef FIO_HAVE_CPU_AFFINITY
2975 .name = "verify_async_cpus",
2976 .lname = "Async verify CPUs",
2977 .type = FIO_OPT_STR,
2978 .cb = str_verify_cpus_allowed_cb,
2979 .off1 = offsetof(struct thread_options, verify_cpumask),
2980 .help = "Set CPUs allowed for async verify threads",
2981 .parent = "verify_async",
2983 .category = FIO_OPT_C_IO,
2984 .group = FIO_OPT_G_VERIFY,
2988 .name = "verify_async_cpus",
2989 .lname = "Async verify CPUs",
2990 .type = FIO_OPT_UNSUPPORTED,
2991 .help = "Your platform does not support CPU affinities",
2995 .name = "experimental_verify",
2996 .lname = "Experimental Verify",
2997 .off1 = offsetof(struct thread_options, experimental_verify),
2998 .type = FIO_OPT_BOOL,
2999 .help = "Enable experimental verification",
3001 .category = FIO_OPT_C_IO,
3002 .group = FIO_OPT_G_VERIFY,
3005 .name = "verify_state_load",
3006 .lname = "Load verify state",
3007 .off1 = offsetof(struct thread_options, verify_state),
3008 .type = FIO_OPT_BOOL,
3009 .help = "Load verify termination state",
3011 .category = FIO_OPT_C_IO,
3012 .group = FIO_OPT_G_VERIFY,
3015 .name = "verify_state_save",
3016 .lname = "Save verify state",
3017 .off1 = offsetof(struct thread_options, verify_state_save),
3018 .type = FIO_OPT_BOOL,
3020 .help = "Save verify state on termination",
3022 .category = FIO_OPT_C_IO,
3023 .group = FIO_OPT_G_VERIFY,
3025 #ifdef FIO_HAVE_TRIM
3027 .name = "trim_percentage",
3028 .lname = "Trim percentage",
3029 .type = FIO_OPT_INT,
3030 .off1 = offsetof(struct thread_options, trim_percentage),
3033 .help = "Number of verify blocks to trim (i.e., discard)",
3038 .category = FIO_OPT_C_IO,
3039 .group = FIO_OPT_G_TRIM,
3042 .name = "trim_verify_zero",
3043 .lname = "Verify trim zero",
3044 .type = FIO_OPT_BOOL,
3045 .help = "Verify that trimmed (i.e., discarded) blocks are returned as zeroes",
3046 .off1 = offsetof(struct thread_options, trim_zero),
3047 .parent = "trim_percentage",
3050 .category = FIO_OPT_C_IO,
3051 .group = FIO_OPT_G_TRIM,
3054 .name = "trim_backlog",
3055 .lname = "Trim backlog",
3056 .type = FIO_OPT_STR_VAL,
3057 .off1 = offsetof(struct thread_options, trim_backlog),
3058 .help = "Trim after this number of blocks are written",
3059 .parent = "trim_percentage",
3062 .category = FIO_OPT_C_IO,
3063 .group = FIO_OPT_G_TRIM,
3066 .name = "trim_backlog_batch",
3067 .lname = "Trim backlog batch",
3068 .type = FIO_OPT_INT,
3069 .off1 = offsetof(struct thread_options, trim_batch),
3070 .help = "Trim this number of IO blocks",
3071 .parent = "trim_percentage",
3074 .category = FIO_OPT_C_IO,
3075 .group = FIO_OPT_G_TRIM,
3079 .name = "trim_percentage",
3080 .lname = "Trim percentage",
3081 .type = FIO_OPT_UNSUPPORTED,
3082 .help = "Fio does not support TRIM on your platform",
3085 .name = "trim_verify_zero",
3086 .lname = "Verify trim zero",
3087 .type = FIO_OPT_UNSUPPORTED,
3088 .help = "Fio does not support TRIM on your platform",
3091 .name = "trim_backlog",
3092 .lname = "Trim backlog",
3093 .type = FIO_OPT_UNSUPPORTED,
3094 .help = "Fio does not support TRIM on your platform",
3097 .name = "trim_backlog_batch",
3098 .lname = "Trim backlog batch",
3099 .type = FIO_OPT_UNSUPPORTED,
3100 .help = "Fio does not support TRIM on your platform",
3104 .name = "write_iolog",
3105 .lname = "Write I/O log",
3106 .type = FIO_OPT_STR_STORE,
3107 .off1 = offsetof(struct thread_options, write_iolog_file),
3108 .help = "Store IO pattern to file",
3109 .category = FIO_OPT_C_IO,
3110 .group = FIO_OPT_G_IOLOG,
3113 .name = "read_iolog",
3114 .lname = "Read I/O log",
3115 .type = FIO_OPT_STR_STORE,
3116 .off1 = offsetof(struct thread_options, read_iolog_file),
3117 .help = "Playback IO pattern from file",
3118 .category = FIO_OPT_C_IO,
3119 .group = FIO_OPT_G_IOLOG,
3122 .name = "read_iolog_chunked",
3123 .lname = "Read I/O log in parts",
3124 .type = FIO_OPT_BOOL,
3125 .off1 = offsetof(struct thread_options, read_iolog_chunked),
3127 .parent = "read_iolog",
3128 .help = "Parse IO pattern in chunks",
3129 .category = FIO_OPT_C_IO,
3130 .group = FIO_OPT_G_IOLOG,
3133 .name = "replay_no_stall",
3134 .lname = "Don't stall on replay",
3135 .type = FIO_OPT_BOOL,
3136 .off1 = offsetof(struct thread_options, no_stall),
3138 .parent = "read_iolog",
3140 .help = "Playback IO pattern file as fast as possible without stalls",
3141 .category = FIO_OPT_C_IO,
3142 .group = FIO_OPT_G_IOLOG,
3145 .name = "replay_redirect",
3146 .lname = "Redirect device for replay",
3147 .type = FIO_OPT_STR_STORE,
3148 .off1 = offsetof(struct thread_options, replay_redirect),
3149 .parent = "read_iolog",
3151 .help = "Replay all I/O onto this device, regardless of trace device",
3152 .category = FIO_OPT_C_IO,
3153 .group = FIO_OPT_G_IOLOG,
3156 .name = "replay_scale",
3157 .lname = "Replace offset scale factor",
3158 .type = FIO_OPT_INT,
3159 .off1 = offsetof(struct thread_options, replay_scale),
3160 .parent = "read_iolog",
3162 .help = "Align offsets to this blocksize",
3163 .category = FIO_OPT_C_IO,
3164 .group = FIO_OPT_G_IOLOG,
3167 .name = "replay_align",
3168 .lname = "Replace alignment",
3169 .type = FIO_OPT_INT,
3170 .off1 = offsetof(struct thread_options, replay_align),
3171 .parent = "read_iolog",
3172 .help = "Scale offset down by this factor",
3173 .category = FIO_OPT_C_IO,
3174 .group = FIO_OPT_G_IOLOG,
3178 .name = "replay_time_scale",
3179 .lname = "Replay Time Scale",
3180 .type = FIO_OPT_INT,
3181 .off1 = offsetof(struct thread_options, replay_time_scale),
3184 .parent = "read_iolog",
3186 .help = "Scale time for replay events",
3187 .category = FIO_OPT_C_IO,
3188 .group = FIO_OPT_G_IOLOG,
3191 .name = "replay_skip",
3192 .lname = "Replay Skip",
3193 .type = FIO_OPT_STR,
3194 .cb = str_replay_skip_cb,
3195 .off1 = offsetof(struct thread_options, replay_skip),
3196 .parent = "read_iolog",
3197 .help = "Skip certain IO types (read,write,trim,flush)",
3198 .category = FIO_OPT_C_IO,
3199 .group = FIO_OPT_G_IOLOG,
3202 .name = "merge_blktrace_file",
3203 .lname = "Merged blktrace output filename",
3204 .type = FIO_OPT_STR_STORE,
3205 .off1 = offsetof(struct thread_options, merge_blktrace_file),
3206 .help = "Merged blktrace output filename",
3207 .category = FIO_OPT_C_IO,
3208 .group = FIO_OPT_G_IOLOG,
3211 .name = "merge_blktrace_scalars",
3212 .lname = "Percentage to scale each trace",
3213 .type = FIO_OPT_FLOAT_LIST,
3214 .off1 = offsetof(struct thread_options, merge_blktrace_scalars),
3215 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3216 .help = "Percentage to scale each trace",
3217 .category = FIO_OPT_C_IO,
3218 .group = FIO_OPT_G_IOLOG,
3221 .name = "merge_blktrace_iters",
3222 .lname = "Number of iterations to run per trace",
3223 .type = FIO_OPT_FLOAT_LIST,
3224 .off1 = offsetof(struct thread_options, merge_blktrace_iters),
3225 .maxlen = FIO_IO_U_LIST_MAX_LEN,
3226 .help = "Number of iterations to run per trace",
3227 .category = FIO_OPT_C_IO,
3228 .group = FIO_OPT_G_IOLOG,
3231 .name = "exec_prerun",
3232 .lname = "Pre-execute runnable",
3233 .type = FIO_OPT_STR_STORE,
3234 .off1 = offsetof(struct thread_options, exec_prerun),
3235 .help = "Execute this file prior to running job",
3236 .category = FIO_OPT_C_GENERAL,
3237 .group = FIO_OPT_G_INVALID,
3240 .name = "exec_postrun",
3241 .lname = "Post-execute runnable",
3242 .type = FIO_OPT_STR_STORE,
3243 .off1 = offsetof(struct thread_options, exec_postrun),
3244 .help = "Execute this file after running job",
3245 .category = FIO_OPT_C_GENERAL,
3246 .group = FIO_OPT_G_INVALID,
3248 #ifdef FIO_HAVE_IOSCHED_SWITCH
3250 .name = "ioscheduler",
3251 .lname = "I/O scheduler",
3252 .type = FIO_OPT_STR_STORE,
3253 .off1 = offsetof(struct thread_options, ioscheduler),
3254 .help = "Use this IO scheduler on the backing device",
3255 .category = FIO_OPT_C_FILE,
3256 .group = FIO_OPT_G_INVALID,
3260 .name = "ioscheduler",
3261 .lname = "I/O scheduler",
3262 .type = FIO_OPT_UNSUPPORTED,
3263 .help = "Your platform does not support IO scheduler switching",
3268 .lname = "Zone mode",
3269 .help = "Mode for the zonesize, zonerange and zoneskip parameters",
3270 .type = FIO_OPT_STR,
3271 .off1 = offsetof(struct thread_options, zone_mode),
3273 .category = FIO_OPT_C_IO,
3274 .group = FIO_OPT_G_ZONE,
3277 .oval = ZONE_MODE_NONE,
3278 .help = "no zoning",
3280 { .ival = "strided",
3281 .oval = ZONE_MODE_STRIDED,
3282 .help = "strided mode - random I/O is restricted to a single zone",
3285 .oval = ZONE_MODE_ZBD,
3286 .help = "zoned block device mode - random I/O selects one of multiple zones randomly",
3292 .lname = "Zone size",
3293 .type = FIO_OPT_STR_VAL,
3294 .off1 = offsetof(struct thread_options, zone_size),
3295 .help = "Amount of data to read per zone",
3297 .interval = 1024 * 1024,
3298 .category = FIO_OPT_C_IO,
3299 .group = FIO_OPT_G_ZONE,
3302 .name = "zonerange",
3303 .lname = "Zone range",
3304 .type = FIO_OPT_STR_VAL,
3305 .off1 = offsetof(struct thread_options, zone_range),
3306 .help = "Give size of an IO zone",
3308 .interval = 1024 * 1024,
3309 .category = FIO_OPT_C_IO,
3310 .group = FIO_OPT_G_ZONE,
3314 .lname = "Zone skip",
3315 .type = FIO_OPT_STR_VAL,
3316 .off1 = offsetof(struct thread_options, zone_skip),
3317 .help = "Space between IO zones",
3319 .interval = 1024 * 1024,
3320 .category = FIO_OPT_C_IO,
3321 .group = FIO_OPT_G_ZONE,
3324 .name = "read_beyond_wp",
3325 .lname = "Allow reads beyond the zone write pointer",
3326 .type = FIO_OPT_BOOL,
3327 .off1 = offsetof(struct thread_options, read_beyond_wp),
3328 .help = "Allow reads beyond the zone write pointer",
3330 .category = FIO_OPT_C_IO,
3331 .group = FIO_OPT_G_INVALID,
3334 .name = "max_open_zones",
3335 .lname = "Maximum number of open zones",
3336 .type = FIO_OPT_INT,
3337 .off1 = offsetof(struct thread_options, max_open_zones),
3338 .maxval = FIO_MAX_OPEN_ZBD_ZONES,
3339 .help = "Limit random writes to SMR drives to the specified"
3340 " number of sequential zones",
3342 .category = FIO_OPT_C_IO,
3343 .group = FIO_OPT_G_INVALID,
3346 .name = "zone_reset_threshold",
3347 .lname = "Zone reset threshold",
3348 .help = "Zoned block device reset threshold",
3349 .type = FIO_OPT_FLOAT_LIST,
3351 .off1 = offsetof(struct thread_options, zrt),
3354 .category = FIO_OPT_C_IO,
3355 .group = FIO_OPT_G_ZONE,
3358 .name = "zone_reset_frequency",
3359 .lname = "Zone reset frequency",
3360 .help = "Zoned block device zone reset frequency in HZ",
3361 .type = FIO_OPT_FLOAT_LIST,
3363 .off1 = offsetof(struct thread_options, zrf),
3366 .category = FIO_OPT_C_IO,
3367 .group = FIO_OPT_G_ZONE,
3371 .lname = "Lock memory",
3372 .type = FIO_OPT_STR_VAL,
3373 .off1 = offsetof(struct thread_options, lockmem),
3374 .help = "Lock down this amount of memory (per worker)",
3376 .interval = 1024 * 1024,
3377 .category = FIO_OPT_C_GENERAL,
3378 .group = FIO_OPT_G_INVALID,
3381 .name = "rwmixread",
3382 .lname = "Read/write mix read",
3383 .type = FIO_OPT_INT,
3384 .cb = str_rwmix_read_cb,
3385 .off1 = offsetof(struct thread_options, rwmix[DDIR_READ]),
3387 .help = "Percentage of mixed workload that is reads",
3390 .inverse = "rwmixwrite",
3391 .category = FIO_OPT_C_IO,
3392 .group = FIO_OPT_G_RWMIX,
3395 .name = "rwmixwrite",
3396 .lname = "Read/write mix write",
3397 .type = FIO_OPT_INT,
3398 .cb = str_rwmix_write_cb,
3399 .off1 = offsetof(struct thread_options, rwmix[DDIR_WRITE]),
3401 .help = "Percentage of mixed workload that is writes",
3404 .inverse = "rwmixread",
3405 .category = FIO_OPT_C_IO,
3406 .group = FIO_OPT_G_RWMIX,
3409 .name = "rwmixcycle",
3410 .lname = "Read/write mix cycle",
3411 .type = FIO_OPT_DEPRECATED,
3412 .category = FIO_OPT_C_IO,
3413 .group = FIO_OPT_G_RWMIX,
3418 .type = FIO_OPT_INT,
3419 .off1 = offsetof(struct thread_options, nice),
3420 .help = "Set job CPU nice value",
3425 .category = FIO_OPT_C_GENERAL,
3426 .group = FIO_OPT_G_CRED,
3428 #ifdef FIO_HAVE_IOPRIO
3431 .lname = "I/O nice priority",
3432 .type = FIO_OPT_INT,
3433 .off1 = offsetof(struct thread_options, ioprio),
3434 .help = "Set job IO priority value",
3435 .minval = IOPRIO_MIN_PRIO,
3436 .maxval = IOPRIO_MAX_PRIO,
3438 .category = FIO_OPT_C_GENERAL,
3439 .group = FIO_OPT_G_CRED,
3444 .lname = "I/O nice priority",
3445 .type = FIO_OPT_UNSUPPORTED,
3446 .help = "Your platform does not support IO priorities",
3449 #ifdef FIO_HAVE_IOPRIO_CLASS
3450 #ifndef FIO_HAVE_IOPRIO
3451 #error "FIO_HAVE_IOPRIO_CLASS requires FIO_HAVE_IOPRIO"
3454 .name = "prioclass",
3455 .lname = "I/O nice priority class",
3456 .type = FIO_OPT_INT,
3457 .off1 = offsetof(struct thread_options, ioprio_class),
3458 .help = "Set job IO priority class",
3459 .minval = IOPRIO_MIN_PRIO_CLASS,
3460 .maxval = IOPRIO_MAX_PRIO_CLASS,
3462 .category = FIO_OPT_C_GENERAL,
3463 .group = FIO_OPT_G_CRED,
3467 .name = "prioclass",
3468 .lname = "I/O nice priority class",
3469 .type = FIO_OPT_UNSUPPORTED,
3470 .help = "Your platform does not support IO priority classes",
3474 .name = "thinktime",
3475 .lname = "Thinktime",
3476 .type = FIO_OPT_INT,
3477 .off1 = offsetof(struct thread_options, thinktime),
3478 .help = "Idle time between IO buffers (usec)",
3481 .category = FIO_OPT_C_IO,
3482 .group = FIO_OPT_G_THINKTIME,
3485 .name = "thinktime_spin",
3486 .lname = "Thinktime spin",
3487 .type = FIO_OPT_INT,
3488 .off1 = offsetof(struct thread_options, thinktime_spin),
3489 .help = "Start think time by spinning this amount (usec)",
3492 .parent = "thinktime",
3494 .category = FIO_OPT_C_IO,
3495 .group = FIO_OPT_G_THINKTIME,
3498 .name = "thinktime_blocks",
3499 .lname = "Thinktime blocks",
3500 .type = FIO_OPT_INT,
3501 .off1 = offsetof(struct thread_options, thinktime_blocks),
3502 .help = "IO buffer period between 'thinktime'",
3504 .parent = "thinktime",
3506 .category = FIO_OPT_C_IO,
3507 .group = FIO_OPT_G_THINKTIME,
3511 .lname = "I/O rate",
3512 .type = FIO_OPT_INT,
3513 .off1 = offsetof(struct thread_options, rate[DDIR_READ]),
3514 .off2 = offsetof(struct thread_options, rate[DDIR_WRITE]),
3515 .off3 = offsetof(struct thread_options, rate[DDIR_TRIM]),
3516 .help = "Set bandwidth rate",
3517 .category = FIO_OPT_C_IO,
3518 .group = FIO_OPT_G_RATE,
3523 .lname = "I/O min rate",
3524 .type = FIO_OPT_INT,
3525 .off1 = offsetof(struct thread_options, ratemin[DDIR_READ]),
3526 .off2 = offsetof(struct thread_options, ratemin[DDIR_WRITE]),
3527 .off3 = offsetof(struct thread_options, ratemin[DDIR_TRIM]),
3528 .help = "Job must meet this rate or it will be shutdown",
3531 .category = FIO_OPT_C_IO,
3532 .group = FIO_OPT_G_RATE,
3535 .name = "rate_iops",
3536 .lname = "I/O rate IOPS",
3537 .type = FIO_OPT_INT,
3538 .off1 = offsetof(struct thread_options, rate_iops[DDIR_READ]),
3539 .off2 = offsetof(struct thread_options, rate_iops[DDIR_WRITE]),
3540 .off3 = offsetof(struct thread_options, rate_iops[DDIR_TRIM]),
3541 .help = "Limit IO used to this number of IO operations/sec",
3543 .category = FIO_OPT_C_IO,
3544 .group = FIO_OPT_G_RATE,
3547 .name = "rate_iops_min",
3548 .lname = "I/O min rate IOPS",
3549 .type = FIO_OPT_INT,
3550 .off1 = offsetof(struct thread_options, rate_iops_min[DDIR_READ]),
3551 .off2 = offsetof(struct thread_options, rate_iops_min[DDIR_WRITE]),
3552 .off3 = offsetof(struct thread_options, rate_iops_min[DDIR_TRIM]),
3553 .help = "Job must meet this rate or it will be shut down",
3554 .parent = "rate_iops",
3556 .category = FIO_OPT_C_IO,
3557 .group = FIO_OPT_G_RATE,
3560 .name = "rate_process",
3561 .lname = "Rate Process",
3562 .type = FIO_OPT_STR,
3563 .off1 = offsetof(struct thread_options, rate_process),
3564 .help = "What process controls how rated IO is managed",
3566 .category = FIO_OPT_C_IO,
3567 .group = FIO_OPT_G_RATE,
3570 .oval = RATE_PROCESS_LINEAR,
3571 .help = "Linear rate of IO",
3575 .oval = RATE_PROCESS_POISSON,
3576 .help = "Rate follows Poisson process",
3582 .name = "rate_cycle",
3583 .alias = "ratecycle",
3584 .lname = "I/O rate cycle",
3585 .type = FIO_OPT_INT,
3586 .off1 = offsetof(struct thread_options, ratecycle),
3587 .help = "Window average for rate limits (msec)",
3591 .category = FIO_OPT_C_IO,
3592 .group = FIO_OPT_G_RATE,
3595 .name = "rate_ignore_thinktime",
3596 .lname = "Rate ignore thinktime",
3597 .type = FIO_OPT_BOOL,
3598 .off1 = offsetof(struct thread_options, rate_ign_think),
3599 .help = "Rated IO ignores thinktime settings",
3601 .category = FIO_OPT_C_IO,
3602 .group = FIO_OPT_G_RATE,
3605 .name = "max_latency",
3606 .lname = "Max Latency (usec)",
3607 .type = FIO_OPT_STR_VAL_TIME,
3608 .off1 = offsetof(struct thread_options, max_latency),
3609 .help = "Maximum tolerated IO latency (usec)",
3611 .category = FIO_OPT_C_IO,
3612 .group = FIO_OPT_G_LATPROF,
3615 .name = "latency_target",
3616 .lname = "Latency Target (usec)",
3617 .type = FIO_OPT_STR_VAL_TIME,
3618 .off1 = offsetof(struct thread_options, latency_target),
3619 .help = "Ramp to max queue depth supporting this latency",
3621 .category = FIO_OPT_C_IO,
3622 .group = FIO_OPT_G_LATPROF,
3625 .name = "latency_window",
3626 .lname = "Latency Window (usec)",
3627 .type = FIO_OPT_STR_VAL_TIME,
3628 .off1 = offsetof(struct thread_options, latency_window),
3629 .help = "Time to sustain latency_target",
3631 .category = FIO_OPT_C_IO,
3632 .group = FIO_OPT_G_LATPROF,
3635 .name = "latency_percentile",
3636 .lname = "Latency Percentile",
3637 .type = FIO_OPT_FLOAT_LIST,
3638 .off1 = offsetof(struct thread_options, latency_percentile),
3639 .help = "Percentile of IOs must be below latency_target",
3644 .category = FIO_OPT_C_IO,
3645 .group = FIO_OPT_G_LATPROF,
3648 .name = "invalidate",
3649 .lname = "Cache invalidate",
3650 .type = FIO_OPT_BOOL,
3651 .off1 = offsetof(struct thread_options, invalidate_cache),
3652 .help = "Invalidate buffer/page cache prior to running job",
3654 .category = FIO_OPT_C_IO,
3655 .group = FIO_OPT_G_IO_TYPE,
3659 .lname = "Synchronous I/O",
3660 .type = FIO_OPT_BOOL,
3661 .off1 = offsetof(struct thread_options, sync_io),
3662 .help = "Use O_SYNC for buffered writes",
3664 .parent = "buffered",
3666 .category = FIO_OPT_C_IO,
3667 .group = FIO_OPT_G_IO_TYPE,
3669 #ifdef FIO_HAVE_WRITE_HINT
3671 .name = "write_hint",
3672 .lname = "Write hint",
3673 .type = FIO_OPT_STR,
3674 .off1 = offsetof(struct thread_options, write_hint),
3675 .help = "Set expected write life time",
3676 .category = FIO_OPT_C_ENGINE,
3677 .group = FIO_OPT_G_INVALID,
3680 .oval = RWH_WRITE_LIFE_NONE,
3683 .oval = RWH_WRITE_LIFE_SHORT,
3686 .oval = RWH_WRITE_LIFE_MEDIUM,
3689 .oval = RWH_WRITE_LIFE_LONG,
3691 { .ival = "extreme",
3692 .oval = RWH_WRITE_LIFE_EXTREME,
3698 .name = "create_serialize",
3699 .lname = "Create serialize",
3700 .type = FIO_OPT_BOOL,
3701 .off1 = offsetof(struct thread_options, create_serialize),
3702 .help = "Serialize creation of job files",
3704 .category = FIO_OPT_C_FILE,
3705 .group = FIO_OPT_G_INVALID,
3708 .name = "create_fsync",
3709 .lname = "Create fsync",
3710 .type = FIO_OPT_BOOL,
3711 .off1 = offsetof(struct thread_options, create_fsync),
3712 .help = "fsync file after creation",
3714 .category = FIO_OPT_C_FILE,
3715 .group = FIO_OPT_G_INVALID,
3718 .name = "create_on_open",
3719 .lname = "Create on open",
3720 .type = FIO_OPT_BOOL,
3721 .off1 = offsetof(struct thread_options, create_on_open),
3722 .help = "Create files when they are opened for IO",
3724 .category = FIO_OPT_C_FILE,
3725 .group = FIO_OPT_G_INVALID,
3728 .name = "create_only",
3729 .lname = "Create Only",
3730 .type = FIO_OPT_BOOL,
3731 .off1 = offsetof(struct thread_options, create_only),
3732 .help = "Only perform file creation phase",
3733 .category = FIO_OPT_C_FILE,
3737 .name = "allow_file_create",
3738 .lname = "Allow file create",
3739 .type = FIO_OPT_BOOL,
3740 .off1 = offsetof(struct thread_options, allow_create),
3741 .help = "Permit fio to create files, if they don't exist",
3743 .category = FIO_OPT_C_FILE,
3744 .group = FIO_OPT_G_FILENAME,
3747 .name = "allow_mounted_write",
3748 .lname = "Allow mounted write",
3749 .type = FIO_OPT_BOOL,
3750 .off1 = offsetof(struct thread_options, allow_mounted_write),
3751 .help = "Allow writes to a mounted partition",
3753 .category = FIO_OPT_C_FILE,
3754 .group = FIO_OPT_G_FILENAME,
3758 .lname = "Pre-read files",
3759 .type = FIO_OPT_BOOL,
3760 .off1 = offsetof(struct thread_options, pre_read),
3761 .help = "Pre-read files before starting official testing",
3763 .category = FIO_OPT_C_FILE,
3764 .group = FIO_OPT_G_INVALID,
3766 #ifdef FIO_HAVE_CPU_AFFINITY
3769 .lname = "CPU mask",
3770 .type = FIO_OPT_INT,
3771 .cb = str_cpumask_cb,
3772 .off1 = offsetof(struct thread_options, cpumask),
3773 .help = "CPU affinity mask",
3774 .category = FIO_OPT_C_GENERAL,
3775 .group = FIO_OPT_G_CRED,
3778 .name = "cpus_allowed",
3779 .lname = "CPUs allowed",
3780 .type = FIO_OPT_STR,
3781 .cb = str_cpus_allowed_cb,
3782 .off1 = offsetof(struct thread_options, cpumask),
3783 .help = "Set CPUs allowed",
3784 .category = FIO_OPT_C_GENERAL,
3785 .group = FIO_OPT_G_CRED,
3788 .name = "cpus_allowed_policy",
3789 .lname = "CPUs allowed distribution policy",
3790 .type = FIO_OPT_STR,
3791 .off1 = offsetof(struct thread_options, cpus_allowed_policy),
3792 .help = "Distribution policy for cpus_allowed",
3793 .parent = "cpus_allowed",
3797 .oval = FIO_CPUS_SHARED,
3798 .help = "Mask shared between threads",
3801 .oval = FIO_CPUS_SPLIT,
3802 .help = "Mask split between threads",
3805 .category = FIO_OPT_C_GENERAL,
3806 .group = FIO_OPT_G_CRED,
3811 .lname = "CPU mask",
3812 .type = FIO_OPT_UNSUPPORTED,
3813 .help = "Your platform does not support CPU affinities",
3816 .name = "cpus_allowed",
3817 .lname = "CPUs allowed",
3818 .type = FIO_OPT_UNSUPPORTED,
3819 .help = "Your platform does not support CPU affinities",
3822 .name = "cpus_allowed_policy",
3823 .lname = "CPUs allowed distribution policy",
3824 .type = FIO_OPT_UNSUPPORTED,
3825 .help = "Your platform does not support CPU affinities",
3828 #ifdef CONFIG_LIBNUMA
3830 .name = "numa_cpu_nodes",
3831 .lname = "NUMA CPU Nodes",
3832 .type = FIO_OPT_STR,
3833 .cb = str_numa_cpunodes_cb,
3834 .off1 = offsetof(struct thread_options, numa_cpunodes),
3835 .help = "NUMA CPU nodes bind",
3836 .category = FIO_OPT_C_GENERAL,
3837 .group = FIO_OPT_G_INVALID,
3840 .name = "numa_mem_policy",
3841 .lname = "NUMA Memory Policy",
3842 .type = FIO_OPT_STR,
3843 .cb = str_numa_mpol_cb,
3844 .off1 = offsetof(struct thread_options, numa_memnodes),
3845 .help = "NUMA memory policy setup",
3846 .category = FIO_OPT_C_GENERAL,
3847 .group = FIO_OPT_G_INVALID,
3851 .name = "numa_cpu_nodes",
3852 .lname = "NUMA CPU Nodes",
3853 .type = FIO_OPT_UNSUPPORTED,
3854 .help = "Build fio with libnuma-dev(el) to enable this option",
3857 .name = "numa_mem_policy",
3858 .lname = "NUMA Memory Policy",
3859 .type = FIO_OPT_UNSUPPORTED,
3860 .help = "Build fio with libnuma-dev(el) to enable this option",
3865 .name = "gpu_dev_id",
3866 .lname = "GPU device ID",
3867 .type = FIO_OPT_INT,
3868 .off1 = offsetof(struct thread_options, gpu_dev_id),
3869 .help = "Set GPU device ID for GPUDirect RDMA",
3871 .category = FIO_OPT_C_GENERAL,
3872 .group = FIO_OPT_G_INVALID,
3876 .name = "end_fsync",
3877 .lname = "End fsync",
3878 .type = FIO_OPT_BOOL,
3879 .off1 = offsetof(struct thread_options, end_fsync),
3880 .help = "Include fsync at the end of job",
3882 .category = FIO_OPT_C_FILE,
3883 .group = FIO_OPT_G_INVALID,
3886 .name = "fsync_on_close",
3887 .lname = "Fsync on close",
3888 .type = FIO_OPT_BOOL,
3889 .off1 = offsetof(struct thread_options, fsync_on_close),
3890 .help = "fsync files on close",
3892 .category = FIO_OPT_C_FILE,
3893 .group = FIO_OPT_G_INVALID,
3897 .lname = "Unlink file",
3898 .type = FIO_OPT_BOOL,
3899 .off1 = offsetof(struct thread_options, unlink),
3900 .help = "Unlink created files after job has completed",
3902 .category = FIO_OPT_C_FILE,
3903 .group = FIO_OPT_G_INVALID,
3906 .name = "unlink_each_loop",
3907 .lname = "Unlink file after each loop of a job",
3908 .type = FIO_OPT_BOOL,
3909 .off1 = offsetof(struct thread_options, unlink_each_loop),
3910 .help = "Unlink created files after each loop in a job has completed",
3912 .category = FIO_OPT_C_FILE,
3913 .group = FIO_OPT_G_INVALID,
3917 .lname = "Exit-all on terminate",
3918 .type = FIO_OPT_STR_SET,
3919 .cb = str_exitall_cb,
3920 .help = "Terminate all jobs when one exits",
3921 .category = FIO_OPT_C_GENERAL,
3922 .group = FIO_OPT_G_PROCESS,
3925 .name = "exitall_on_error",
3926 .lname = "Exit-all on terminate in error",
3927 .type = FIO_OPT_STR_SET,
3928 .off1 = offsetof(struct thread_options, exitall_error),
3929 .help = "Terminate all jobs when one exits in error",
3930 .category = FIO_OPT_C_GENERAL,
3931 .group = FIO_OPT_G_PROCESS,
3934 .name = "stonewall",
3935 .lname = "Wait for previous",
3936 .alias = "wait_for_previous",
3937 .type = FIO_OPT_STR_SET,
3938 .off1 = offsetof(struct thread_options, stonewall),
3939 .help = "Insert a hard barrier between this job and previous",
3940 .category = FIO_OPT_C_GENERAL,
3941 .group = FIO_OPT_G_PROCESS,
3944 .name = "new_group",
3945 .lname = "New group",
3946 .type = FIO_OPT_STR_SET,
3947 .off1 = offsetof(struct thread_options, new_group),
3948 .help = "Mark the start of a new group (for reporting)",
3949 .category = FIO_OPT_C_GENERAL,
3950 .group = FIO_OPT_G_PROCESS,
3955 .type = FIO_OPT_STR_SET,
3956 .off1 = offsetof(struct thread_options, use_thread),
3957 .help = "Use threads instead of processes",
3958 #ifdef CONFIG_NO_SHM
3962 .category = FIO_OPT_C_GENERAL,
3963 .group = FIO_OPT_G_PROCESS,
3966 .name = "per_job_logs",
3967 .lname = "Per Job Logs",
3968 .type = FIO_OPT_BOOL,
3969 .off1 = offsetof(struct thread_options, per_job_logs),
3970 .help = "Include job number in generated log files or not",
3972 .category = FIO_OPT_C_LOG,
3973 .group = FIO_OPT_G_INVALID,
3976 .name = "write_bw_log",
3977 .lname = "Write bandwidth log",
3978 .type = FIO_OPT_STR,
3979 .off1 = offsetof(struct thread_options, bw_log_file),
3980 .cb = str_write_bw_log_cb,
3981 .help = "Write log of bandwidth during run",
3982 .category = FIO_OPT_C_LOG,
3983 .group = FIO_OPT_G_INVALID,
3986 .name = "write_lat_log",
3987 .lname = "Write latency log",
3988 .type = FIO_OPT_STR,
3989 .off1 = offsetof(struct thread_options, lat_log_file),
3990 .cb = str_write_lat_log_cb,
3991 .help = "Write log of latency during run",
3992 .category = FIO_OPT_C_LOG,
3993 .group = FIO_OPT_G_INVALID,
3996 .name = "write_iops_log",
3997 .lname = "Write IOPS log",
3998 .type = FIO_OPT_STR,
3999 .off1 = offsetof(struct thread_options, iops_log_file),
4000 .cb = str_write_iops_log_cb,
4001 .help = "Write log of IOPS during run",
4002 .category = FIO_OPT_C_LOG,
4003 .group = FIO_OPT_G_INVALID,
4006 .name = "log_avg_msec",
4007 .lname = "Log averaging (msec)",
4008 .type = FIO_OPT_INT,
4009 .off1 = offsetof(struct thread_options, log_avg_msec),
4010 .help = "Average bw/iops/lat logs over this period of time",
4012 .category = FIO_OPT_C_LOG,
4013 .group = FIO_OPT_G_INVALID,
4016 .name = "log_hist_msec",
4017 .lname = "Log histograms (msec)",
4018 .type = FIO_OPT_INT,
4019 .off1 = offsetof(struct thread_options, log_hist_msec),
4020 .help = "Dump completion latency histograms at frequency of this time value",
4022 .category = FIO_OPT_C_LOG,
4023 .group = FIO_OPT_G_INVALID,
4026 .name = "log_hist_coarseness",
4027 .lname = "Histogram logs coarseness",
4028 .type = FIO_OPT_INT,
4029 .off1 = offsetof(struct thread_options, log_hist_coarseness),
4030 .help = "Integer in range [0,6]. Higher coarseness outputs"
4031 " fewer histogram bins per sample. The number of bins for"
4032 " these are [1216, 608, 304, 152, 76, 38, 19] respectively.",
4034 .category = FIO_OPT_C_LOG,
4035 .group = FIO_OPT_G_INVALID,
4038 .name = "write_hist_log",
4039 .lname = "Write latency histogram logs",
4040 .type = FIO_OPT_STR,
4041 .off1 = offsetof(struct thread_options, hist_log_file),
4042 .cb = str_write_hist_log_cb,
4043 .help = "Write log of latency histograms during run",
4044 .category = FIO_OPT_C_LOG,
4045 .group = FIO_OPT_G_INVALID,
4048 .name = "log_max_value",
4049 .lname = "Log maximum instead of average",
4050 .type = FIO_OPT_BOOL,
4051 .off1 = offsetof(struct thread_options, log_max),
4052 .help = "Log max sample in a window instead of average",
4054 .category = FIO_OPT_C_LOG,
4055 .group = FIO_OPT_G_INVALID,
4058 .name = "log_offset",
4059 .lname = "Log offset of IO",
4060 .type = FIO_OPT_BOOL,
4061 .off1 = offsetof(struct thread_options, log_offset),
4062 .help = "Include offset of IO for each log entry",
4064 .category = FIO_OPT_C_LOG,
4065 .group = FIO_OPT_G_INVALID,
4069 .name = "log_compression",
4070 .lname = "Log compression",
4071 .type = FIO_OPT_INT,
4072 .off1 = offsetof(struct thread_options, log_gz),
4073 .help = "Log in compressed chunks of this size",
4075 .maxval = 512 * 1024 * 1024ULL,
4076 .category = FIO_OPT_C_LOG,
4077 .group = FIO_OPT_G_INVALID,
4079 #ifdef FIO_HAVE_CPU_AFFINITY
4081 .name = "log_compression_cpus",
4082 .lname = "Log Compression CPUs",
4083 .type = FIO_OPT_STR,
4084 .cb = str_log_cpus_allowed_cb,
4085 .off1 = offsetof(struct thread_options, log_gz_cpumask),
4086 .parent = "log_compression",
4087 .help = "Limit log compression to these CPUs",
4088 .category = FIO_OPT_C_LOG,
4089 .group = FIO_OPT_G_INVALID,
4093 .name = "log_compression_cpus",
4094 .lname = "Log Compression CPUs",
4095 .type = FIO_OPT_UNSUPPORTED,
4096 .help = "Your platform does not support CPU affinities",
4100 .name = "log_store_compressed",
4101 .lname = "Log store compressed",
4102 .type = FIO_OPT_BOOL,
4103 .off1 = offsetof(struct thread_options, log_gz_store),
4104 .help = "Store logs in a compressed format",
4105 .category = FIO_OPT_C_LOG,
4106 .group = FIO_OPT_G_INVALID,
4110 .name = "log_compression",
4111 .lname = "Log compression",
4112 .type = FIO_OPT_UNSUPPORTED,
4113 .help = "Install libz-dev(el) to get compression support",
4116 .name = "log_store_compressed",
4117 .lname = "Log store compressed",
4118 .type = FIO_OPT_UNSUPPORTED,
4119 .help = "Install libz-dev(el) to get compression support",
4123 .name = "log_unix_epoch",
4124 .lname = "Log epoch unix",
4125 .type = FIO_OPT_BOOL,
4126 .off1 = offsetof(struct thread_options, log_unix_epoch),
4127 .help = "Use Unix time in log files",
4128 .category = FIO_OPT_C_LOG,
4129 .group = FIO_OPT_G_INVALID,
4132 .name = "block_error_percentiles",
4133 .lname = "Block error percentiles",
4134 .type = FIO_OPT_BOOL,
4135 .off1 = offsetof(struct thread_options, block_error_hist),
4136 .help = "Record trim block errors and make a histogram",
4138 .category = FIO_OPT_C_LOG,
4139 .group = FIO_OPT_G_INVALID,
4142 .name = "bwavgtime",
4143 .lname = "Bandwidth average time",
4144 .type = FIO_OPT_INT,
4145 .off1 = offsetof(struct thread_options, bw_avg_time),
4146 .help = "Time window over which to calculate bandwidth"
4149 .parent = "write_bw_log",
4152 .category = FIO_OPT_C_LOG,
4153 .group = FIO_OPT_G_INVALID,
4156 .name = "iopsavgtime",
4157 .lname = "IOPS average time",
4158 .type = FIO_OPT_INT,
4159 .off1 = offsetof(struct thread_options, iops_avg_time),
4160 .help = "Time window over which to calculate IOPS (msec)",
4162 .parent = "write_iops_log",
4165 .category = FIO_OPT_C_LOG,
4166 .group = FIO_OPT_G_INVALID,
4169 .name = "group_reporting",
4170 .lname = "Group reporting",
4171 .type = FIO_OPT_STR_SET,
4172 .off1 = offsetof(struct thread_options, group_reporting),
4173 .help = "Do reporting on a per-group basis",
4174 .category = FIO_OPT_C_STAT,
4175 .group = FIO_OPT_G_INVALID,
4180 .type = FIO_OPT_BOOL,
4181 .off1 = offsetof(struct thread_options, stats),
4182 .help = "Enable collection of stats",
4184 .category = FIO_OPT_C_STAT,
4185 .group = FIO_OPT_G_INVALID,
4188 .name = "zero_buffers",
4189 .lname = "Zero I/O buffers",
4190 .type = FIO_OPT_STR_SET,
4191 .off1 = offsetof(struct thread_options, zero_buffers),
4192 .help = "Init IO buffers to all zeroes",
4193 .category = FIO_OPT_C_IO,
4194 .group = FIO_OPT_G_IO_BUF,
4197 .name = "refill_buffers",
4198 .lname = "Refill I/O buffers",
4199 .type = FIO_OPT_STR_SET,
4200 .off1 = offsetof(struct thread_options, refill_buffers),
4201 .help = "Refill IO buffers on every IO submit",
4202 .category = FIO_OPT_C_IO,
4203 .group = FIO_OPT_G_IO_BUF,
4206 .name = "scramble_buffers",
4207 .lname = "Scramble I/O buffers",
4208 .type = FIO_OPT_BOOL,
4209 .off1 = offsetof(struct thread_options, scramble_buffers),
4210 .help = "Slightly scramble buffers on every IO submit",
4212 .category = FIO_OPT_C_IO,
4213 .group = FIO_OPT_G_IO_BUF,
4216 .name = "buffer_pattern",
4217 .lname = "Buffer pattern",
4218 .type = FIO_OPT_STR,
4219 .cb = str_buffer_pattern_cb,
4220 .off1 = offsetof(struct thread_options, buffer_pattern),
4221 .help = "Fill pattern for IO buffers",
4222 .category = FIO_OPT_C_IO,
4223 .group = FIO_OPT_G_IO_BUF,
4226 .name = "buffer_compress_percentage",
4227 .lname = "Buffer compression percentage",
4228 .type = FIO_OPT_INT,
4229 .cb = str_buffer_compress_cb,
4230 .off1 = offsetof(struct thread_options, compress_percentage),
4233 .help = "How compressible the buffer is (approximately)",
4235 .category = FIO_OPT_C_IO,
4236 .group = FIO_OPT_G_IO_BUF,
4239 .name = "buffer_compress_chunk",
4240 .lname = "Buffer compression chunk size",
4241 .type = FIO_OPT_INT,
4242 .off1 = offsetof(struct thread_options, compress_chunk),
4243 .parent = "buffer_compress_percentage",
4245 .help = "Size of compressible region in buffer",
4248 .category = FIO_OPT_C_IO,
4249 .group = FIO_OPT_G_IO_BUF,
4252 .name = "dedupe_percentage",
4253 .lname = "Dedupe percentage",
4254 .type = FIO_OPT_INT,
4255 .cb = str_dedupe_cb,
4256 .off1 = offsetof(struct thread_options, dedupe_percentage),
4259 .help = "Percentage of buffers that are dedupable",
4261 .category = FIO_OPT_C_IO,
4262 .group = FIO_OPT_G_IO_BUF,
4265 .name = "clat_percentiles",
4266 .lname = "Completion latency percentiles",
4267 .type = FIO_OPT_BOOL,
4268 .off1 = offsetof(struct thread_options, clat_percentiles),
4269 .help = "Enable the reporting of completion latency percentiles",
4271 .inverse = "lat_percentiles",
4272 .category = FIO_OPT_C_STAT,
4273 .group = FIO_OPT_G_INVALID,
4276 .name = "lat_percentiles",
4277 .lname = "IO latency percentiles",
4278 .type = FIO_OPT_BOOL,
4279 .off1 = offsetof(struct thread_options, lat_percentiles),
4280 .help = "Enable the reporting of IO latency percentiles",
4282 .inverse = "clat_percentiles",
4283 .category = FIO_OPT_C_STAT,
4284 .group = FIO_OPT_G_INVALID,
4287 .name = "percentile_list",
4288 .lname = "Percentile list",
4289 .type = FIO_OPT_FLOAT_LIST,
4290 .off1 = offsetof(struct thread_options, percentile_list),
4291 .off2 = offsetof(struct thread_options, percentile_precision),
4292 .help = "Specify a custom list of percentiles to report for "
4293 "completion latency and block errors",
4294 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
4295 .maxlen = FIO_IO_U_LIST_MAX_LEN,
4298 .category = FIO_OPT_C_STAT,
4299 .group = FIO_OPT_G_INVALID,
4302 .name = "significant_figures",
4303 .lname = "Significant figures",
4304 .type = FIO_OPT_INT,
4305 .off1 = offsetof(struct thread_options, sig_figs),
4308 .help = "Significant figures for output-format set to normal",
4311 .category = FIO_OPT_C_STAT,
4312 .group = FIO_OPT_G_INVALID,
4315 #ifdef FIO_HAVE_DISK_UTIL
4317 .name = "disk_util",
4318 .lname = "Disk utilization",
4319 .type = FIO_OPT_BOOL,
4320 .off1 = offsetof(struct thread_options, do_disk_util),
4321 .help = "Log disk utilization statistics",
4323 .category = FIO_OPT_C_STAT,
4324 .group = FIO_OPT_G_INVALID,
4328 .name = "disk_util",
4329 .lname = "Disk utilization",
4330 .type = FIO_OPT_UNSUPPORTED,
4331 .help = "Your platform does not support disk utilization",
4335 .name = "gtod_reduce",
4336 .lname = "Reduce gettimeofday() calls",
4337 .type = FIO_OPT_BOOL,
4338 .help = "Greatly reduce number of gettimeofday() calls",
4339 .cb = str_gtod_reduce_cb,
4342 .category = FIO_OPT_C_STAT,
4343 .group = FIO_OPT_G_INVALID,
4346 .name = "disable_lat",
4347 .lname = "Disable all latency stats",
4348 .type = FIO_OPT_BOOL,
4349 .off1 = offsetof(struct thread_options, disable_lat),
4350 .help = "Disable latency numbers",
4351 .parent = "gtod_reduce",
4354 .category = FIO_OPT_C_STAT,
4355 .group = FIO_OPT_G_INVALID,
4358 .name = "disable_clat",
4359 .lname = "Disable completion latency stats",
4360 .type = FIO_OPT_BOOL,
4361 .off1 = offsetof(struct thread_options, disable_clat),
4362 .help = "Disable completion latency numbers",
4363 .parent = "gtod_reduce",
4366 .category = FIO_OPT_C_STAT,
4367 .group = FIO_OPT_G_INVALID,
4370 .name = "disable_slat",
4371 .lname = "Disable submission latency stats",
4372 .type = FIO_OPT_BOOL,
4373 .off1 = offsetof(struct thread_options, disable_slat),
4374 .help = "Disable submission latency numbers",
4375 .parent = "gtod_reduce",
4378 .category = FIO_OPT_C_STAT,
4379 .group = FIO_OPT_G_INVALID,
4382 .name = "disable_bw_measurement",
4383 .alias = "disable_bw",
4384 .lname = "Disable bandwidth stats",
4385 .type = FIO_OPT_BOOL,
4386 .off1 = offsetof(struct thread_options, disable_bw),
4387 .help = "Disable bandwidth logging",
4388 .parent = "gtod_reduce",
4391 .category = FIO_OPT_C_STAT,
4392 .group = FIO_OPT_G_INVALID,
4396 .lname = "Dedicated gettimeofday() CPU",
4397 .type = FIO_OPT_INT,
4398 .off1 = offsetof(struct thread_options, gtod_cpu),
4399 .help = "Set up dedicated gettimeofday() thread on this CPU",
4400 .verify = gtod_cpu_verify,
4401 .category = FIO_OPT_C_GENERAL,
4402 .group = FIO_OPT_G_CLOCK,
4405 .name = "unified_rw_reporting",
4406 .lname = "Unified RW Reporting",
4407 .type = FIO_OPT_BOOL,
4408 .off1 = offsetof(struct thread_options, unified_rw_rep),
4409 .help = "Unify reporting across data direction",
4411 .category = FIO_OPT_C_GENERAL,
4412 .group = FIO_OPT_G_INVALID,
4415 .name = "continue_on_error",
4416 .lname = "Continue on error",
4417 .type = FIO_OPT_STR,
4418 .off1 = offsetof(struct thread_options, continue_on_error),
4419 .help = "Continue on non-fatal errors during IO",
4421 .category = FIO_OPT_C_GENERAL,
4422 .group = FIO_OPT_G_ERR,
4425 .oval = ERROR_TYPE_NONE,
4426 .help = "Exit when an error is encountered",
4429 .oval = ERROR_TYPE_READ,
4430 .help = "Continue on read errors only",
4433 .oval = ERROR_TYPE_WRITE,
4434 .help = "Continue on write errors only",
4437 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
4438 .help = "Continue on any IO errors",
4441 .oval = ERROR_TYPE_VERIFY,
4442 .help = "Continue on verify errors only",
4445 .oval = ERROR_TYPE_ANY,
4446 .help = "Continue on all io and verify errors",
4449 .oval = ERROR_TYPE_NONE,
4450 .help = "Alias for 'none'",
4453 .oval = ERROR_TYPE_ANY,
4454 .help = "Alias for 'all'",
4459 .name = "ignore_error",
4460 .lname = "Ignore Error",
4461 .type = FIO_OPT_STR,
4462 .cb = str_ignore_error_cb,
4463 .off1 = offsetof(struct thread_options, ignore_error_nr),
4464 .help = "Set a specific list of errors to ignore",
4466 .category = FIO_OPT_C_GENERAL,
4467 .group = FIO_OPT_G_ERR,
4470 .name = "error_dump",
4471 .lname = "Error Dump",
4472 .type = FIO_OPT_BOOL,
4473 .off1 = offsetof(struct thread_options, error_dump),
4475 .help = "Dump info on each error",
4476 .category = FIO_OPT_C_GENERAL,
4477 .group = FIO_OPT_G_ERR,
4482 .type = FIO_OPT_STR_STORE,
4483 .off1 = offsetof(struct thread_options, profile),
4484 .help = "Select a specific builtin performance test",
4485 .category = FIO_OPT_C_PROFILE,
4486 .group = FIO_OPT_G_INVALID,
4491 .type = FIO_OPT_STR_STORE,
4492 .off1 = offsetof(struct thread_options, cgroup),
4493 .help = "Add job to cgroup of this name",
4494 .category = FIO_OPT_C_GENERAL,
4495 .group = FIO_OPT_G_CGROUP,
4498 .name = "cgroup_nodelete",
4499 .lname = "Cgroup no-delete",
4500 .type = FIO_OPT_BOOL,
4501 .off1 = offsetof(struct thread_options, cgroup_nodelete),
4502 .help = "Do not delete cgroups after job completion",
4505 .category = FIO_OPT_C_GENERAL,
4506 .group = FIO_OPT_G_CGROUP,
4509 .name = "cgroup_weight",
4510 .lname = "Cgroup weight",
4511 .type = FIO_OPT_INT,
4512 .off1 = offsetof(struct thread_options, cgroup_weight),
4513 .help = "Use given weight for cgroup",
4517 .category = FIO_OPT_C_GENERAL,
4518 .group = FIO_OPT_G_CGROUP,
4523 .type = FIO_OPT_INT,
4524 .off1 = offsetof(struct thread_options, uid),
4525 .help = "Run job with this user ID",
4526 .category = FIO_OPT_C_GENERAL,
4527 .group = FIO_OPT_G_CRED,
4531 .lname = "Group ID",
4532 .type = FIO_OPT_INT,
4533 .off1 = offsetof(struct thread_options, gid),
4534 .help = "Run job with this group ID",
4535 .category = FIO_OPT_C_GENERAL,
4536 .group = FIO_OPT_G_CRED,
4541 .type = FIO_OPT_STR,
4542 .off1 = offsetof(struct thread_options, kb_base),
4548 .help = "Inputs invert IEC and SI prefixes (for compatibility); outputs prefer binary",
4552 .help = "Inputs use IEC and SI prefixes; outputs prefer SI",
4555 .help = "Unit prefix interpretation for quantities of data (IEC and SI)",
4556 .category = FIO_OPT_C_GENERAL,
4557 .group = FIO_OPT_G_INVALID,
4560 .name = "unit_base",
4561 .lname = "Unit for quantities of data (Bits or Bytes)",
4562 .type = FIO_OPT_STR,
4563 .off1 = offsetof(struct thread_options, unit_base),
4568 .help = "Auto-detect",
4571 .oval = N2S_BYTEPERSEC,
4572 .help = "Normal (byte based)",
4575 .oval = N2S_BITPERSEC,
4576 .help = "Bit based",
4579 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
4580 .category = FIO_OPT_C_GENERAL,
4581 .group = FIO_OPT_G_INVALID,
4584 .name = "hugepage-size",
4585 .lname = "Hugepage size",
4586 .type = FIO_OPT_INT,
4587 .off1 = offsetof(struct thread_options, hugepage_size),
4588 .help = "When using hugepages, specify size of each page",
4589 .def = __fio_stringify(FIO_HUGE_PAGE),
4590 .interval = 1024 * 1024,
4591 .category = FIO_OPT_C_GENERAL,
4592 .group = FIO_OPT_G_INVALID,
4596 .lname = "I/O flow ID",
4597 .type = FIO_OPT_INT,
4598 .off1 = offsetof(struct thread_options, flow_id),
4599 .help = "The flow index ID to use",
4601 .category = FIO_OPT_C_IO,
4602 .group = FIO_OPT_G_IO_FLOW,
4606 .lname = "I/O flow weight",
4607 .type = FIO_OPT_INT,
4608 .off1 = offsetof(struct thread_options, flow),
4609 .help = "Weight for flow control of this job",
4610 .parent = "flow_id",
4613 .category = FIO_OPT_C_IO,
4614 .group = FIO_OPT_G_IO_FLOW,
4617 .name = "flow_watermark",
4618 .lname = "I/O flow watermark",
4619 .type = FIO_OPT_INT,
4620 .off1 = offsetof(struct thread_options, flow_watermark),
4621 .help = "High watermark for flow control. This option"
4622 " should be set to the same value for all threads"
4623 " with non-zero flow.",
4624 .parent = "flow_id",
4627 .category = FIO_OPT_C_IO,
4628 .group = FIO_OPT_G_IO_FLOW,
4631 .name = "flow_sleep",
4632 .lname = "I/O flow sleep",
4633 .type = FIO_OPT_INT,
4634 .off1 = offsetof(struct thread_options, flow_sleep),
4635 .help = "How many microseconds to sleep after being held"
4636 " back by the flow control mechanism",
4637 .parent = "flow_id",
4640 .category = FIO_OPT_C_IO,
4641 .group = FIO_OPT_G_IO_FLOW,
4644 .name = "steadystate",
4645 .lname = "Steady state threshold",
4647 .type = FIO_OPT_STR,
4648 .off1 = offsetof(struct thread_options, ss_state),
4649 .cb = str_steadystate_cb,
4650 .help = "Define the criterion and limit to judge when a job has reached steady state",
4651 .def = "iops_slope:0.01%",
4654 .oval = FIO_SS_IOPS,
4655 .help = "maximum mean deviation of IOPS measurements",
4657 { .ival = "iops_slope",
4658 .oval = FIO_SS_IOPS_SLOPE,
4659 .help = "slope calculated from IOPS measurements",
4663 .help = "maximum mean deviation of bandwidth measurements",
4667 .oval = FIO_SS_BW_SLOPE,
4668 .help = "slope calculated from bandwidth measurements",
4671 .category = FIO_OPT_C_GENERAL,
4672 .group = FIO_OPT_G_RUNTIME,
4675 .name = "steadystate_duration",
4676 .lname = "Steady state duration",
4678 .parent = "steadystate",
4679 .type = FIO_OPT_STR_VAL_TIME,
4680 .off1 = offsetof(struct thread_options, ss_dur),
4681 .help = "Stop workload upon attaining steady state for specified duration",
4685 .category = FIO_OPT_C_GENERAL,
4686 .group = FIO_OPT_G_RUNTIME,
4689 .name = "steadystate_ramp_time",
4690 .lname = "Steady state ramp time",
4692 .parent = "steadystate",
4693 .type = FIO_OPT_STR_VAL_TIME,
4694 .off1 = offsetof(struct thread_options, ss_ramp_time),
4695 .help = "Delay before initiation of data collection for steady state job termination testing",
4699 .category = FIO_OPT_C_GENERAL,
4700 .group = FIO_OPT_G_RUNTIME,
4707 static void add_to_lopt(struct option *lopt, struct fio_option *o,
4708 const char *name, int val)
4710 lopt->name = (char *) name;
4712 if (o->type == FIO_OPT_STR_SET)
4713 lopt->has_arg = optional_argument;
4715 lopt->has_arg = required_argument;
4718 static void options_to_lopts(struct fio_option *opts,
4719 struct option *long_options,
4720 int i, int option_type)
4722 struct fio_option *o = &opts[0];
4724 add_to_lopt(&long_options[i], o, o->name, option_type);
4727 add_to_lopt(&long_options[i], o, o->alias, option_type);
4732 assert(i < FIO_NR_OPTIONS);
4736 void fio_options_set_ioengine_opts(struct option *long_options,
4737 struct thread_data *td)
4742 while (long_options[i].name) {
4743 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
4744 memset(&long_options[i], 0, sizeof(*long_options));
4751 * Just clear out the prior ioengine options.
4756 options_to_lopts(td->io_ops->options, long_options, i,
4757 FIO_GETOPT_IOENGINE);
4760 void fio_options_dup_and_init(struct option *long_options)
4764 options_init(fio_options);
4767 while (long_options[i].name)
4770 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
4773 struct fio_keyword {
4779 static struct fio_keyword fio_keywords[] = {
4781 .word = "$pagesize",
4782 .desc = "Page size in the system",
4785 .word = "$mb_memory",
4786 .desc = "Megabytes of memory online",
4790 .desc = "Number of CPUs online in the system",
4797 void fio_keywords_exit(void)
4799 struct fio_keyword *kw;
4801 kw = &fio_keywords[0];
4809 void fio_keywords_init(void)
4811 unsigned long long mb_memory;
4815 sprintf(buf, "%lu", (unsigned long) page_size);
4816 fio_keywords[0].replace = strdup(buf);
4818 mb_memory = os_phys_mem() / (1024 * 1024);
4819 sprintf(buf, "%llu", mb_memory);
4820 fio_keywords[1].replace = strdup(buf);
4823 sprintf(buf, "%lu", l);
4824 fio_keywords[2].replace = strdup(buf);
4829 static char *bc_calc(char *str)
4831 char buf[128], *tmp;
4836 * No math, just return string
4838 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
4839 !strchr(str, '/')) || strchr(str, '\''))
4843 * Split option from value, we only need to calculate the value
4845 tmp = strchr(str, '=');
4852 * Prevent buffer overflows; such a case isn't reasonable anyway
4854 if (strlen(str) >= 128 || strlen(tmp) > 100)
4857 sprintf(buf, "which %s > /dev/null", BC_APP);
4859 log_err("fio: bc is needed for performing math\n");
4863 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
4864 f = popen(buf, "r");
4868 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
4875 buf[(tmp - str) + ret - 1] = '\0';
4876 memcpy(buf, str, tmp - str);
4882 * Return a copy of the input string with substrings of the form ${VARNAME}
4883 * substituted with the value of the environment variable VARNAME. The
4884 * substitution always occurs, even if VARNAME is empty or the corresponding
4885 * environment variable undefined.
4887 char *fio_option_dup_subs(const char *opt)
4889 char out[OPT_LEN_MAX+1];
4890 char in[OPT_LEN_MAX+1];
4893 char *ch1, *ch2, *env;
4894 ssize_t nchr = OPT_LEN_MAX;
4897 if (strlen(opt) + 1 > OPT_LEN_MAX) {
4898 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
4902 in[OPT_LEN_MAX] = '\0';
4903 strncpy(in, opt, OPT_LEN_MAX);
4905 while (*inptr && nchr > 0) {
4906 if (inptr[0] == '$' && inptr[1] == '{') {
4907 ch2 = strchr(inptr, '}');
4908 if (ch2 && inptr+1 < ch2) {
4915 envlen = strlen(env);
4916 if (envlen <= nchr) {
4917 memcpy(outptr, env, envlen);
4927 *outptr++ = *inptr++;
4936 * Look for reserved variable names and replace them with real values
4938 static char *fio_keyword_replace(char *opt)
4944 for (i = 0; fio_keywords[i].word != NULL; i++) {
4945 struct fio_keyword *kw = &fio_keywords[i];
4947 while ((s = strstr(opt, kw->word)) != NULL) {
4948 char *new = malloc(strlen(opt) + 1);
4954 * Copy part of the string before the keyword and
4955 * sprintf() the replacement after it.
4957 memcpy(new, opt, olen);
4958 len = sprintf(new + olen, "%s", kw->replace);
4961 * If there's more in the original string, copy that
4964 opt += strlen(kw->word) + olen;
4966 memcpy(new + olen + len, opt, opt - o_org - 1);
4969 * replace opt and free the old opt
4979 * Check for potential math and invoke bc, if possible
4987 static char **dup_and_sub_options(char **opts, int num_opts)
4990 char **opts_copy = malloc(num_opts * sizeof(*opts));
4991 for (i = 0; i < num_opts; i++) {
4992 opts_copy[i] = fio_option_dup_subs(opts[i]);
4995 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
5000 static void show_closest_option(const char *opt)
5002 int best_option, best_distance;
5011 while (name[i] != '\0' && name[i] != '=')
5016 best_distance = INT_MAX;
5018 while (fio_options[i].name) {
5019 distance = string_distance(name, fio_options[i].name);
5020 if (distance < best_distance) {
5021 best_distance = distance;
5027 if (best_option != -1 && string_distance_ok(name, best_distance) &&
5028 fio_options[best_option].type != FIO_OPT_UNSUPPORTED)
5029 log_err("Did you mean %s?\n", fio_options[best_option].name);
5034 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
5036 int i, ret, unknown;
5039 sort_options(opts, fio_options, num_opts);
5040 opts_copy = dup_and_sub_options(opts, num_opts);
5042 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
5043 const struct fio_option *o;
5044 int newret = parse_option(opts_copy[i], opts[i], fio_options,
5045 &o, &td->o, &td->opt_list);
5048 fio_option_mark_set(&td->o, o);
5056 opts_copy[i] = NULL;
5063 ret |= ioengine_load(td);
5065 sort_options(opts_copy, td->io_ops->options, num_opts);
5068 for (i = 0; i < num_opts; i++) {
5069 const struct fio_option *o = NULL;
5076 newret = parse_option(opts_copy[i], opts[i],
5077 td->io_ops->options, &o,
5078 td->eo, &td->opt_list);
5082 log_err("Bad option <%s>\n", opts[i]);
5083 show_closest_option(opts[i]);
5086 opts_copy[i] = NULL;
5094 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
5098 ret = parse_cmd_option(opt, val, fio_options, &td->o, &td->opt_list);
5100 const struct fio_option *o;
5102 o = find_option_c(fio_options, opt);
5104 fio_option_mark_set(&td->o, o);
5110 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
5113 return parse_cmd_option(opt, val, td->io_ops->options, td->eo,
5117 void fio_fill_default_options(struct thread_data *td)
5119 td->o.magic = OPT_MAGIC;
5120 fill_default_options(&td->o, fio_options);
5123 int fio_show_option_help(const char *opt)
5125 return show_cmd_help(fio_options, opt);
5129 * dupe FIO_OPT_STR_STORE options
5131 void fio_options_mem_dupe(struct thread_data *td)
5133 options_mem_dupe(fio_options, &td->o);
5135 if (td->eo && td->io_ops) {
5136 void *oldeo = td->eo;
5138 td->eo = malloc(td->io_ops->option_struct_size);
5139 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
5140 options_mem_dupe(td->io_ops->options, td->eo);
5144 unsigned int fio_get_kb_base(void *data)
5146 struct thread_data *td = cb_data_to_td(data);
5147 struct thread_options *o = &td->o;
5148 unsigned int kb_base = 0;
5151 * This is a hack... For private options, *data is not holding
5152 * a pointer to the thread_options, but to private data. This means
5153 * we can't safely dereference it, but magic is first so mem wise
5154 * it is valid. But this also means that if the job first sets
5155 * kb_base and expects that to be honored by private options,
5156 * it will be disappointed. We will return the global default
5159 if (o && o->magic == OPT_MAGIC)
5160 kb_base = o->kb_base;
5167 int add_option(const struct fio_option *o)
5169 struct fio_option *__o;
5178 if (opt_index + 1 == FIO_MAX_OPTS) {
5179 log_err("fio: FIO_MAX_OPTS is too small\n");
5183 memcpy(&fio_options[opt_index], o, sizeof(*o));
5184 fio_options[opt_index + 1].name = NULL;
5188 void invalidate_profile_options(const char *prof_name)
5190 struct fio_option *o;
5194 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
5195 o->type = FIO_OPT_INVALID;
5196 o->prof_name = NULL;
5202 void add_opt_posval(const char *optname, const char *ival, const char *help)
5204 struct fio_option *o;
5207 o = find_option(fio_options, optname);
5211 for (i = 0; i < PARSE_MAX_VP; i++) {
5212 if (o->posval[i].ival)
5215 o->posval[i].ival = ival;
5216 o->posval[i].help = help;
5221 void del_opt_posval(const char *optname, const char *ival)
5223 struct fio_option *o;
5226 o = find_option(fio_options, optname);
5230 for (i = 0; i < PARSE_MAX_VP; i++) {
5231 if (!o->posval[i].ival)
5233 if (strcmp(o->posval[i].ival, ival))
5236 o->posval[i].ival = NULL;
5237 o->posval[i].help = NULL;
5241 void fio_options_free(struct thread_data *td)
5243 options_free(fio_options, &td->o);
5244 if (td->eo && td->io_ops && td->io_ops->options) {
5245 options_free(td->io_ops->options, td->eo);
5251 struct fio_option *fio_option_find(const char *name)
5253 return find_option(fio_options, name);
5256 static struct fio_option *find_next_opt(struct fio_option *from,
5259 struct fio_option *opt;
5262 from = &fio_options[0];
5268 if (off1 == from->off1) {
5273 } while (from->name);
5278 static int opt_is_set(struct thread_options *o, struct fio_option *opt)
5280 unsigned int opt_off, index, offset;
5282 opt_off = opt - &fio_options[0];
5283 index = opt_off / (8 * sizeof(uint64_t));
5284 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5285 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
5288 bool __fio_option_is_set(struct thread_options *o, unsigned int off1)
5290 struct fio_option *opt, *next;
5293 while ((opt = find_next_opt(next, off1)) != NULL) {
5294 if (opt_is_set(o, opt))
5303 void fio_option_mark_set(struct thread_options *o, const struct fio_option *opt)
5305 unsigned int opt_off, index, offset;
5307 opt_off = opt - &fio_options[0];
5308 index = opt_off / (8 * sizeof(uint64_t));
5309 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5310 o->set_options[index] |= (uint64_t)1 << offset;