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 int 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 int 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 = 1;
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);
496 cpu_index = cpu_index % cpus_in_mask;
499 for (i = 0; i < max_cpu; i++) {
500 if (!fio_cpu_isset(mask, i))
503 if (cpu_index != index)
504 fio_cpu_clear(mask, i);
509 return fio_cpu_count(mask);
512 static int str_cpumask_cb(void *data, unsigned long long *val)
514 struct thread_data *td = cb_data_to_td(data);
522 ret = fio_cpuset_init(&td->o.cpumask);
524 log_err("fio: cpuset_init failed\n");
525 td_verror(td, ret, "fio_cpuset_init");
529 max_cpu = cpus_online();
531 for (i = 0; i < sizeof(int) * 8; i++) {
532 if ((1 << i) & *val) {
534 log_err("fio: CPU %d too large (max=%ld)\n", i,
538 dprint(FD_PARSE, "set cpu allowed %d\n", i);
539 fio_cpu_set(&td->o.cpumask, i);
546 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
553 ret = fio_cpuset_init(mask);
555 log_err("fio: cpuset_init failed\n");
556 td_verror(td, ret, "fio_cpuset_init");
560 p = str = strdup(input);
562 strip_blank_front(&str);
563 strip_blank_end(str);
565 max_cpu = cpus_online();
567 while ((cpu = strsep(&str, ",")) != NULL) {
576 while ((cpu2 = strsep(&str2, "-")) != NULL) {
586 while (icpu <= icpu2) {
587 if (icpu >= FIO_MAX_CPUS) {
588 log_err("fio: your OS only supports up to"
589 " %d CPUs\n", (int) FIO_MAX_CPUS);
593 if (icpu >= max_cpu) {
594 log_err("fio: CPU %d too large (max=%ld)\n",
600 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
601 fio_cpu_set(mask, icpu);
612 static int str_cpus_allowed_cb(void *data, const char *input)
614 struct thread_data *td = cb_data_to_td(data);
619 return set_cpus_allowed(td, &td->o.cpumask, input);
622 static int str_verify_cpus_allowed_cb(void *data, const char *input)
624 struct thread_data *td = cb_data_to_td(data);
629 return set_cpus_allowed(td, &td->o.verify_cpumask, input);
633 static int str_log_cpus_allowed_cb(void *data, const char *input)
635 struct thread_data *td = cb_data_to_td(data);
640 return set_cpus_allowed(td, &td->o.log_gz_cpumask, input);
642 #endif /* CONFIG_ZLIB */
644 #endif /* FIO_HAVE_CPU_AFFINITY */
646 #ifdef CONFIG_LIBNUMA
647 static int str_numa_cpunodes_cb(void *data, char *input)
649 struct thread_data *td = cb_data_to_td(data);
650 struct bitmask *verify_bitmask;
655 /* numa_parse_nodestring() parses a character string list
656 * of nodes into a bit mask. The bit mask is allocated by
657 * numa_allocate_nodemask(), so it should be freed by
658 * numa_free_nodemask().
660 verify_bitmask = numa_parse_nodestring(input);
661 if (verify_bitmask == NULL) {
662 log_err("fio: numa_parse_nodestring failed\n");
663 td_verror(td, 1, "str_numa_cpunodes_cb");
666 numa_free_nodemask(verify_bitmask);
668 td->o.numa_cpunodes = strdup(input);
672 static int str_numa_mpol_cb(void *data, char *input)
674 struct thread_data *td = cb_data_to_td(data);
675 const char * const policy_types[] =
676 { "default", "prefer", "bind", "interleave", "local", NULL };
679 struct bitmask *verify_bitmask;
684 nodelist = strchr(input, ':');
686 /* NUL-terminate mode */
690 for (i = 0; i <= MPOL_LOCAL; i++) {
691 if (!strcmp(input, policy_types[i])) {
692 td->o.numa_mem_mode = i;
696 if (i > MPOL_LOCAL) {
697 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
701 switch (td->o.numa_mem_mode) {
704 * Insist on a nodelist of one node only
707 char *rest = nodelist;
708 while (isdigit(*rest))
711 log_err("fio: one node only for \'prefer\'\n");
715 log_err("fio: one node is needed for \'prefer\'\n");
719 case MPOL_INTERLEAVE:
721 * Default to online nodes with memory if no nodelist
724 nodelist = strdup("all");
729 * Don't allow a nodelist
732 log_err("fio: NO nodelist for \'local\'\n");
738 * Insist on a nodelist
741 log_err("fio: a nodelist is needed for \'bind\'\n");
748 /* numa_parse_nodestring() parses a character string list
749 * of nodes into a bit mask. The bit mask is allocated by
750 * numa_allocate_nodemask(), so it should be freed by
751 * numa_free_nodemask().
753 switch (td->o.numa_mem_mode) {
755 td->o.numa_mem_prefer_node = atoi(nodelist);
757 case MPOL_INTERLEAVE:
759 verify_bitmask = numa_parse_nodestring(nodelist);
760 if (verify_bitmask == NULL) {
761 log_err("fio: numa_parse_nodestring failed\n");
762 td_verror(td, 1, "str_numa_memnodes_cb");
765 td->o.numa_memnodes = strdup(nodelist);
766 numa_free_nodemask(verify_bitmask);
781 static int str_fst_cb(void *data, const char *str)
783 struct thread_data *td = cb_data_to_td(data);
788 td->file_service_nr = 1;
790 switch (td->o.file_service_type) {
791 case FIO_FSERVICE_RANDOM:
792 case FIO_FSERVICE_RR:
793 case FIO_FSERVICE_SEQ:
794 nr = get_opt_postfix(str);
796 td->file_service_nr = atoi(nr);
801 case FIO_FSERVICE_ZIPF:
804 case FIO_FSERVICE_PARETO:
805 val = FIO_DEF_PARETO;
807 case FIO_FSERVICE_GAUSS:
811 log_err("fio: bad file service type: %d\n", td->o.file_service_type);
818 nr = get_opt_postfix(str);
819 if (nr && !str_to_float(nr, &val, 0)) {
820 log_err("fio: file service type random postfix parsing failed\n");
827 switch (td->o.file_service_type) {
828 case FIO_FSERVICE_ZIPF:
830 log_err("fio: zipf theta must be different than 1.0\n");
835 td->zipf_theta = val;
837 case FIO_FSERVICE_PARETO:
838 if (val <= 0.00 || val >= 1.00) {
839 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
846 case FIO_FSERVICE_GAUSS:
847 if (val < 0.00 || val >= 100.00) {
848 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
860 #ifdef CONFIG_SYNC_FILE_RANGE
861 static int str_sfr_cb(void *data, const char *str)
863 struct thread_data *td = cb_data_to_td(data);
864 char *nr = get_opt_postfix(str);
866 td->sync_file_range_nr = 1;
868 td->sync_file_range_nr = atoi(nr);
876 static int zone_split_ddir(struct thread_options *o, enum fio_ddir ddir,
877 char *str, bool absolute)
879 unsigned int i, perc, perc_missing, sperc, sperc_missing;
882 memset(&split, 0, sizeof(split));
884 if (split_parse_ddir(o, &split, str, absolute, ZONESPLIT_MAX))
889 o->zone_split[ddir] = malloc(split.nr * sizeof(struct zone_split));
890 o->zone_split_nr[ddir] = split.nr;
891 for (i = 0; i < split.nr; i++) {
892 o->zone_split[ddir][i].access_perc = split.val1[i];
894 o->zone_split[ddir][i].size = split.val2[i];
896 o->zone_split[ddir][i].size_perc = split.val2[i];
900 * Now check if the percentages add up, and how much is missing
902 perc = perc_missing = 0;
903 sperc = sperc_missing = 0;
904 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
905 struct zone_split *zsp = &o->zone_split[ddir][i];
907 if (zsp->access_perc == (uint8_t) -1U)
910 perc += zsp->access_perc;
913 if (zsp->size_perc == (uint8_t) -1U)
916 sperc += zsp->size_perc;
920 if (perc > 100 || sperc > 100) {
921 log_err("fio: zone_split percentages add to more than 100%%\n");
922 free(o->zone_split[ddir]);
923 o->zone_split[ddir] = NULL;
927 log_err("fio: access percentage don't add up to 100 for zoned "
928 "random distribution (got=%u)\n", perc);
929 free(o->zone_split[ddir]);
930 o->zone_split[ddir] = NULL;
935 * If values didn't have a percentage set, divide the remains between
939 if (perc_missing == 1 && o->zone_split_nr[ddir] == 1)
941 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
942 struct zone_split *zsp = &o->zone_split[ddir][i];
944 if (zsp->access_perc == (uint8_t) -1U)
945 zsp->access_perc = (100 - perc) / perc_missing;
949 if (sperc_missing == 1 && o->zone_split_nr[ddir] == 1)
951 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
952 struct zone_split *zsp = &o->zone_split[ddir][i];
954 if (zsp->size_perc == (uint8_t) -1U)
955 zsp->size_perc = (100 - sperc) / sperc_missing;
962 static void __td_zone_gen_index(struct thread_data *td, enum fio_ddir ddir)
964 unsigned int i, j, sprev, aprev;
967 td->zone_state_index[ddir] = malloc(sizeof(struct zone_split_index) * 100);
969 sprev_sz = sprev = aprev = 0;
970 for (i = 0; i < td->o.zone_split_nr[ddir]; i++) {
971 struct zone_split *zsp = &td->o.zone_split[ddir][i];
973 for (j = aprev; j < aprev + zsp->access_perc; j++) {
974 struct zone_split_index *zsi = &td->zone_state_index[ddir][j];
976 zsi->size_perc = sprev + zsp->size_perc;
977 zsi->size_perc_prev = sprev;
979 zsi->size = sprev_sz + zsp->size;
980 zsi->size_prev = sprev_sz;
983 aprev += zsp->access_perc;
984 sprev += zsp->size_perc;
985 sprev_sz += zsp->size;
990 * Generate state table for indexes, so we don't have to do it inline from
993 static void td_zone_gen_index(struct thread_data *td)
997 td->zone_state_index = malloc(DDIR_RWDIR_CNT *
998 sizeof(struct zone_split_index *));
1000 for (i = 0; i < DDIR_RWDIR_CNT; i++)
1001 __td_zone_gen_index(td, i);
1004 static int parse_zoned_distribution(struct thread_data *td, const char *input,
1007 const char *pre = absolute ? "zoned_abs:" : "zoned:";
1011 p = str = strdup(input);
1013 strip_blank_front(&str);
1014 strip_blank_end(str);
1016 /* We expect it to start like that, bail if not */
1017 if (strncmp(str, pre, strlen(pre))) {
1018 log_err("fio: mismatch in zoned input <%s>\n", str);
1024 ret = str_split_parse(td, str, zone_split_ddir, absolute);
1028 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1031 dprint(FD_PARSE, "zone ddir %d (nr=%u): \n", i, td->o.zone_split_nr[i]);
1033 for (j = 0; j < td->o.zone_split_nr[i]; j++) {
1034 struct zone_split *zsp = &td->o.zone_split[i][j];
1037 dprint(FD_PARSE, "\t%d: %u/%llu\n", j,
1039 (unsigned long long) zsp->size);
1041 dprint(FD_PARSE, "\t%d: %u/%u\n", j,
1048 if (parse_dryrun()) {
1049 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1050 free(td->o.zone_split[i]);
1051 td->o.zone_split[i] = NULL;
1052 td->o.zone_split_nr[i] = 0;
1059 td_zone_gen_index(td);
1061 for (i = 0; i < DDIR_RWDIR_CNT; i++)
1062 td->o.zone_split_nr[i] = 0;
1068 static int str_random_distribution_cb(void *data, const char *str)
1070 struct thread_data *td = cb_data_to_td(data);
1074 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
1076 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
1077 val = FIO_DEF_PARETO;
1078 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
1080 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED)
1081 return parse_zoned_distribution(td, str, false);
1082 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED_ABS)
1083 return parse_zoned_distribution(td, str, true);
1087 nr = get_opt_postfix(str);
1088 if (nr && !str_to_float(nr, &val, 0)) {
1089 log_err("fio: random postfix parsing failed\n");
1096 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
1098 log_err("fio: zipf theta must different than 1.0\n");
1103 td->o.zipf_theta.u.f = val;
1104 } else if (td->o.random_distribution == FIO_RAND_DIST_PARETO) {
1105 if (val <= 0.00 || val >= 1.00) {
1106 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
1111 td->o.pareto_h.u.f = val;
1113 if (val < 0.00 || val >= 100.0) {
1114 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
1119 td->o.gauss_dev.u.f = val;
1125 static int str_steadystate_cb(void *data, const char *str)
1127 struct thread_data *td = cb_data_to_td(data);
1133 if (td->o.ss_state != FIO_SS_IOPS && td->o.ss_state != FIO_SS_IOPS_SLOPE &&
1134 td->o.ss_state != FIO_SS_BW && td->o.ss_state != FIO_SS_BW_SLOPE) {
1135 /* should be impossible to get here */
1136 log_err("fio: unknown steady state criterion\n");
1140 nr = get_opt_postfix(str);
1142 log_err("fio: steadystate threshold must be specified in addition to criterion\n");
1147 /* ENHANCEMENT Allow fio to understand size=10.2% and use here */
1148 pct = strstr(nr, "%");
1151 strip_blank_end(nr);
1152 if (!str_to_float(nr, &val, 0)) {
1153 log_err("fio: could not parse steadystate threshold percentage\n");
1158 dprint(FD_PARSE, "set steady state threshold to %f%%\n", val);
1163 td->o.ss_state |= FIO_SS_PCT;
1164 td->o.ss_limit.u.f = val;
1165 } else if (td->o.ss_state & FIO_SS_IOPS) {
1166 if (!str_to_float(nr, &val, 0)) {
1167 log_err("fio: steadystate IOPS threshold postfix parsing failed\n");
1172 dprint(FD_PARSE, "set steady state IOPS threshold to %f\n", val);
1177 td->o.ss_limit.u.f = val;
1178 } else { /* bandwidth criterion */
1179 if (str_to_decimal(nr, &ll, 1, td, 0, 0)) {
1180 log_err("fio: steadystate BW threshold postfix parsing failed\n");
1185 dprint(FD_PARSE, "set steady state BW threshold to %lld\n", ll);
1190 td->o.ss_limit.u.f = (double) ll;
1193 td->ss.state = td->o.ss_state;
1198 * Return next name in the string. Files are separated with ':'. If the ':'
1199 * is escaped with a '\', then that ':' is part of the filename and does not
1200 * indicate a new file.
1202 static char *get_next_name(char **ptr)
1207 if (!str || !strlen(str))
1213 * No colon, we are done
1215 p = strchr(str, ':');
1222 * We got a colon, but it's the first character. Skip and
1230 if (*(p - 1) != '\\') {
1236 memmove(p - 1, p, strlen(p) + 1);
1244 static int get_max_name_idx(char *input)
1246 unsigned int cur_idx;
1249 p = str = strdup(input);
1250 for (cur_idx = 0; ; cur_idx++)
1251 if (get_next_name(&str) == NULL)
1259 * Returns the directory at the index, indexes > entires will be
1260 * assigned via modulo division of the index
1262 int set_name_idx(char *target, size_t tlen, char *input, int index,
1263 bool unique_filename)
1265 unsigned int cur_idx;
1267 char *fname, *str, *p;
1269 p = str = strdup(input);
1271 index %= get_max_name_idx(input);
1272 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1273 fname = get_next_name(&str);
1275 if (client_sockaddr_str[0] && unique_filename) {
1276 len = snprintf(target, tlen, "%s/%s.", fname,
1277 client_sockaddr_str);
1279 len = snprintf(target, tlen, "%s/", fname);
1281 target[tlen - 1] = '\0';
1287 static int str_filename_cb(void *data, const char *input)
1289 struct thread_data *td = cb_data_to_td(data);
1290 char *fname, *str, *p;
1292 p = str = strdup(input);
1294 strip_blank_front(&str);
1295 strip_blank_end(str);
1298 * Ignore what we may already have from nrfiles option.
1300 if (!td->files_index)
1303 while ((fname = get_next_name(&str)) != NULL) {
1306 add_file(td, fname, 0, 1);
1313 static int str_directory_cb(void *data, const char fio_unused *unused)
1315 struct thread_data *td = cb_data_to_td(data);
1317 char *dirname, *str, *p;
1323 p = str = strdup(td->o.directory);
1324 while ((dirname = get_next_name(&str)) != NULL) {
1325 if (lstat(dirname, &sb) < 0) {
1328 log_err("fio: %s is not a directory\n", dirname);
1329 td_verror(td, ret, "lstat");
1332 if (!S_ISDIR(sb.st_mode)) {
1333 log_err("fio: %s is not a directory\n", dirname);
1344 static int str_opendir_cb(void *data, const char fio_unused *str)
1346 struct thread_data *td = cb_data_to_td(data);
1351 if (!td->files_index)
1354 return add_dir_files(td, td->o.opendir);
1357 static int str_buffer_pattern_cb(void *data, const char *input)
1359 struct thread_data *td = cb_data_to_td(data);
1362 /* FIXME: for now buffer pattern does not support formats */
1363 ret = parse_and_fill_pattern(input, strlen(input), td->o.buffer_pattern,
1364 MAX_PATTERN_SIZE, NULL, 0, NULL, NULL);
1369 td->o.buffer_pattern_bytes = ret;
1372 * If this job is doing any reading or has compression set,
1373 * ensure that we refill buffers for writes or we could be
1374 * invalidating the pattern through reads.
1376 if (!td->o.compress_percentage && !td_read(td))
1377 td->o.refill_buffers = 0;
1379 td->o.refill_buffers = 1;
1381 td->o.scramble_buffers = 0;
1382 td->o.zero_buffers = 0;
1387 static int str_buffer_compress_cb(void *data, unsigned long long *il)
1389 struct thread_data *td = cb_data_to_td(data);
1391 td->flags |= TD_F_COMPRESS;
1392 td->o.compress_percentage = *il;
1396 static int str_dedupe_cb(void *data, unsigned long long *il)
1398 struct thread_data *td = cb_data_to_td(data);
1400 td->flags |= TD_F_COMPRESS;
1401 td->o.dedupe_percentage = *il;
1402 td->o.refill_buffers = 1;
1406 static int str_verify_pattern_cb(void *data, const char *input)
1408 struct thread_data *td = cb_data_to_td(data);
1411 td->o.verify_fmt_sz = ARRAY_SIZE(td->o.verify_fmt);
1412 ret = parse_and_fill_pattern(input, strlen(input), td->o.verify_pattern,
1413 MAX_PATTERN_SIZE, fmt_desc, sizeof(fmt_desc),
1414 td->o.verify_fmt, &td->o.verify_fmt_sz);
1419 td->o.verify_pattern_bytes = ret;
1421 * VERIFY_* could already be set
1423 if (!fio_option_is_set(&td->o, verify))
1424 td->o.verify = VERIFY_PATTERN;
1429 static int str_gtod_reduce_cb(void *data, int *il)
1431 struct thread_data *td = cb_data_to_td(data);
1434 td->o.disable_lat = !!val;
1435 td->o.disable_clat = !!val;
1436 td->o.disable_slat = !!val;
1437 td->o.disable_bw = !!val;
1438 td->o.clat_percentiles = !val;
1440 td->ts_cache_mask = 63;
1445 static int str_offset_cb(void *data, unsigned long long *__val)
1447 struct thread_data *td = cb_data_to_td(data);
1448 unsigned long long v = *__val;
1450 if (parse_is_percent(v)) {
1451 td->o.start_offset = 0;
1452 td->o.start_offset_percent = -1ULL - v;
1453 dprint(FD_PARSE, "SET start_offset_percent %d\n",
1454 td->o.start_offset_percent);
1456 td->o.start_offset = v;
1461 static int str_size_cb(void *data, unsigned long long *__val)
1463 struct thread_data *td = cb_data_to_td(data);
1464 unsigned long long v = *__val;
1466 if (parse_is_percent(v)) {
1468 td->o.size_percent = -1ULL - v;
1469 dprint(FD_PARSE, "SET size_percent %d\n",
1470 td->o.size_percent);
1477 static int str_write_bw_log_cb(void *data, const char *str)
1479 struct thread_data *td = cb_data_to_td(data);
1482 td->o.bw_log_file = strdup(str);
1484 td->o.write_bw_log = 1;
1488 static int str_write_lat_log_cb(void *data, const char *str)
1490 struct thread_data *td = cb_data_to_td(data);
1493 td->o.lat_log_file = strdup(str);
1495 td->o.write_lat_log = 1;
1499 static int str_write_iops_log_cb(void *data, const char *str)
1501 struct thread_data *td = cb_data_to_td(data);
1504 td->o.iops_log_file = strdup(str);
1506 td->o.write_iops_log = 1;
1510 static int str_write_hist_log_cb(void *data, const char *str)
1512 struct thread_data *td = cb_data_to_td(data);
1515 td->o.hist_log_file = strdup(str);
1517 td->o.write_hist_log = 1;
1522 * str is supposed to be a substring of the strdup'd original string,
1523 * and is valid only if it's a regular file path.
1524 * This function keeps the pointer to the path as needed later.
1526 * "external:/path/to/so\0" <- original pointer updated with strdup'd
1527 * "external\0" <- above pointer after parsed, i.e. ->ioengine
1528 * "/path/to/so\0" <- str argument, i.e. ->ioengine_so_path
1530 static int str_ioengine_external_cb(void *data, const char *str)
1532 struct thread_data *td = cb_data_to_td(data);
1537 log_err("fio: null external ioengine path\n");
1541 p = (char *)str; /* str is mutable */
1542 strip_blank_front(&p);
1545 if (stat(p, &sb) || !S_ISREG(sb.st_mode)) {
1546 log_err("fio: invalid external ioengine path \"%s\"\n", p);
1550 td->o.ioengine_so_path = p;
1554 static int rw_verify(const struct fio_option *o, void *data)
1556 struct thread_data *td = cb_data_to_td(data);
1558 if (read_only && (td_write(td) || td_trim(td))) {
1559 log_err("fio: job <%s> has write or trim bit set, but"
1560 " fio is in read-only mode\n", td->o.name);
1567 static int gtod_cpu_verify(const struct fio_option *o, void *data)
1569 #ifndef FIO_HAVE_CPU_AFFINITY
1570 struct thread_data *td = cb_data_to_td(data);
1572 if (td->o.gtod_cpu) {
1573 log_err("fio: platform must support CPU affinity for"
1574 "gettimeofday() offloading\n");
1583 * Map of job/command line options
1585 struct fio_option fio_options[FIO_MAX_OPTS] = {
1587 .name = "description",
1588 .lname = "Description of job",
1589 .type = FIO_OPT_STR_STORE,
1590 .off1 = offsetof(struct thread_options, description),
1591 .help = "Text job description",
1592 .category = FIO_OPT_C_GENERAL,
1593 .group = FIO_OPT_G_DESC,
1597 .lname = "Job name",
1598 .type = FIO_OPT_STR_STORE,
1599 .off1 = offsetof(struct thread_options, name),
1600 .help = "Name of this job",
1601 .category = FIO_OPT_C_GENERAL,
1602 .group = FIO_OPT_G_DESC,
1606 .lname = "Waitee name",
1607 .type = FIO_OPT_STR_STORE,
1608 .off1 = offsetof(struct thread_options, wait_for),
1609 .help = "Name of the job this one wants to wait for before starting",
1610 .category = FIO_OPT_C_GENERAL,
1611 .group = FIO_OPT_G_DESC,
1615 .lname = "Filename(s)",
1616 .type = FIO_OPT_STR_STORE,
1617 .off1 = offsetof(struct thread_options, filename),
1618 .cb = str_filename_cb,
1619 .prio = -1, /* must come after "directory" */
1620 .help = "File(s) to use for the workload",
1621 .category = FIO_OPT_C_FILE,
1622 .group = FIO_OPT_G_FILENAME,
1625 .name = "directory",
1626 .lname = "Directory",
1627 .type = FIO_OPT_STR_STORE,
1628 .off1 = offsetof(struct thread_options, directory),
1629 .cb = str_directory_cb,
1630 .help = "Directory to store files in",
1631 .category = FIO_OPT_C_FILE,
1632 .group = FIO_OPT_G_FILENAME,
1635 .name = "filename_format",
1636 .lname = "Filename Format",
1637 .type = FIO_OPT_STR_STORE,
1638 .off1 = offsetof(struct thread_options, filename_format),
1639 .prio = -1, /* must come after "directory" */
1640 .help = "Override default $jobname.$jobnum.$filenum naming",
1641 .def = "$jobname.$jobnum.$filenum",
1642 .category = FIO_OPT_C_FILE,
1643 .group = FIO_OPT_G_FILENAME,
1646 .name = "unique_filename",
1647 .lname = "Unique Filename",
1648 .type = FIO_OPT_BOOL,
1649 .off1 = offsetof(struct thread_options, unique_filename),
1650 .help = "For network clients, prefix file with source IP",
1652 .category = FIO_OPT_C_FILE,
1653 .group = FIO_OPT_G_FILENAME,
1657 .lname = "Lockfile",
1658 .type = FIO_OPT_STR,
1659 .off1 = offsetof(struct thread_options, file_lock_mode),
1660 .help = "Lock file when doing IO to it",
1662 .parent = "filename",
1665 .category = FIO_OPT_C_FILE,
1666 .group = FIO_OPT_G_FILENAME,
1669 .oval = FILE_LOCK_NONE,
1670 .help = "No file locking",
1672 { .ival = "exclusive",
1673 .oval = FILE_LOCK_EXCLUSIVE,
1674 .help = "Exclusive file lock",
1677 .ival = "readwrite",
1678 .oval = FILE_LOCK_READWRITE,
1679 .help = "Read vs write lock",
1685 .lname = "Open directory",
1686 .type = FIO_OPT_STR_STORE,
1687 .off1 = offsetof(struct thread_options, opendir),
1688 .cb = str_opendir_cb,
1689 .help = "Recursively add files from this directory and down",
1690 .category = FIO_OPT_C_FILE,
1691 .group = FIO_OPT_G_FILENAME,
1695 .lname = "Read/write",
1696 .alias = "readwrite",
1697 .type = FIO_OPT_STR,
1699 .off1 = offsetof(struct thread_options, td_ddir),
1700 .help = "IO direction",
1702 .verify = rw_verify,
1703 .category = FIO_OPT_C_IO,
1704 .group = FIO_OPT_G_IO_BASIC,
1707 .oval = TD_DDIR_READ,
1708 .help = "Sequential read",
1711 .oval = TD_DDIR_WRITE,
1712 .help = "Sequential write",
1715 .oval = TD_DDIR_TRIM,
1716 .help = "Sequential trim",
1718 { .ival = "randread",
1719 .oval = TD_DDIR_RANDREAD,
1720 .help = "Random read",
1722 { .ival = "randwrite",
1723 .oval = TD_DDIR_RANDWRITE,
1724 .help = "Random write",
1726 { .ival = "randtrim",
1727 .oval = TD_DDIR_RANDTRIM,
1728 .help = "Random trim",
1732 .help = "Sequential read and write mix",
1734 { .ival = "readwrite",
1736 .help = "Sequential read and write mix",
1739 .oval = TD_DDIR_RANDRW,
1740 .help = "Random read and write mix"
1742 { .ival = "trimwrite",
1743 .oval = TD_DDIR_TRIMWRITE,
1744 .help = "Trim and write mix, trims preceding writes"
1749 .name = "rw_sequencer",
1750 .lname = "RW Sequencer",
1751 .type = FIO_OPT_STR,
1752 .off1 = offsetof(struct thread_options, rw_seq),
1753 .help = "IO offset generator modifier",
1754 .def = "sequential",
1755 .category = FIO_OPT_C_IO,
1756 .group = FIO_OPT_G_IO_BASIC,
1758 { .ival = "sequential",
1760 .help = "Generate sequential offsets",
1762 { .ival = "identical",
1763 .oval = RW_SEQ_IDENT,
1764 .help = "Generate identical offsets",
1771 .lname = "IO Engine",
1772 .type = FIO_OPT_STR_STORE,
1773 .off1 = offsetof(struct thread_options, ioengine),
1774 .help = "IO engine to use",
1775 .def = FIO_PREFERRED_ENGINE,
1776 .category = FIO_OPT_C_IO,
1777 .group = FIO_OPT_G_IO_BASIC,
1780 .help = "Use read/write",
1783 .help = "Use pread/pwrite",
1786 .help = "Use readv/writev",
1788 #ifdef CONFIG_PWRITEV
1790 .help = "Use preadv/pwritev",
1793 #ifdef FIO_HAVE_PWRITEV2
1794 { .ival = "pvsync2",
1795 .help = "Use preadv2/pwritev2",
1798 #ifdef CONFIG_LIBAIO
1800 .help = "Linux native asynchronous IO",
1803 #ifdef CONFIG_POSIXAIO
1804 { .ival = "posixaio",
1805 .help = "POSIX asynchronous IO",
1808 #ifdef CONFIG_SOLARISAIO
1809 { .ival = "solarisaio",
1810 .help = "Solaris native asynchronous IO",
1813 #ifdef CONFIG_WINDOWSAIO
1814 { .ival = "windowsaio",
1815 .help = "Windows native asynchronous IO"
1820 .help = "Rados Block Device asynchronous IO"
1824 .help = "Memory mapped IO"
1826 #ifdef CONFIG_LINUX_SPLICE
1828 .help = "splice/vmsplice based IO",
1830 { .ival = "netsplice",
1831 .help = "splice/vmsplice to/from the network",
1834 #ifdef FIO_HAVE_SGIO
1836 .help = "SCSI generic v3 IO",
1840 .help = "Testing engine (no data transfer)",
1843 .help = "Network IO",
1846 .help = "CPU cycle burner engine",
1850 .help = "GUASI IO engine",
1855 .help = "RDMA IO engine",
1858 #ifdef CONFIG_FUSION_AW
1859 { .ival = "fusion-aw-sync",
1860 .help = "Fusion-io atomic write engine",
1863 #ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1864 { .ival = "e4defrag",
1865 .help = "ext4 defrag engine",
1868 #ifdef CONFIG_LINUX_FALLOCATE
1870 .help = "fallocate() file based engine",
1875 .help = "Glusterfs libgfapi(sync) based engine"
1877 { .ival = "gfapi_async",
1878 .help = "Glusterfs libgfapi(async) based engine"
1881 #ifdef CONFIG_LIBHDFS
1882 { .ival = "libhdfs",
1883 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1886 #ifdef CONFIG_PMEMBLK
1887 { .ival = "pmemblk",
1888 .help = "PMDK libpmemblk based IO engine",
1892 #ifdef CONFIG_LINUX_DEVDAX
1893 { .ival = "dev-dax",
1894 .help = "DAX Device based IO engine",
1898 .ival = "filecreate",
1899 .help = "File creation engine",
1901 { .ival = "external",
1902 .help = "Load external engine (append name)",
1903 .cb = str_ioengine_external_cb,
1905 #ifdef CONFIG_LIBPMEM
1906 { .ival = "libpmem",
1907 .help = "PMDK libpmem based IO engine",
1914 .lname = "IO Depth",
1915 .type = FIO_OPT_INT,
1916 .off1 = offsetof(struct thread_options, iodepth),
1917 .help = "Number of IO buffers to keep in flight",
1921 .category = FIO_OPT_C_IO,
1922 .group = FIO_OPT_G_IO_BASIC,
1925 .name = "iodepth_batch",
1926 .lname = "IO Depth batch",
1927 .alias = "iodepth_batch_submit",
1928 .type = FIO_OPT_INT,
1929 .off1 = offsetof(struct thread_options, iodepth_batch),
1930 .help = "Number of IO buffers to submit in one go",
1931 .parent = "iodepth",
1935 .category = FIO_OPT_C_IO,
1936 .group = FIO_OPT_G_IO_BASIC,
1939 .name = "iodepth_batch_complete_min",
1940 .lname = "Min IO depth batch complete",
1941 .alias = "iodepth_batch_complete",
1942 .type = FIO_OPT_INT,
1943 .off1 = offsetof(struct thread_options, iodepth_batch_complete_min),
1944 .help = "Min number of IO buffers to retrieve in one go",
1945 .parent = "iodepth",
1950 .category = FIO_OPT_C_IO,
1951 .group = FIO_OPT_G_IO_BASIC,
1954 .name = "iodepth_batch_complete_max",
1955 .lname = "Max IO depth batch complete",
1956 .type = FIO_OPT_INT,
1957 .off1 = offsetof(struct thread_options, iodepth_batch_complete_max),
1958 .help = "Max number of IO buffers to retrieve in one go",
1959 .parent = "iodepth",
1963 .category = FIO_OPT_C_IO,
1964 .group = FIO_OPT_G_IO_BASIC,
1967 .name = "iodepth_low",
1968 .lname = "IO Depth batch low",
1969 .type = FIO_OPT_INT,
1970 .off1 = offsetof(struct thread_options, iodepth_low),
1971 .help = "Low water mark for queuing depth",
1972 .parent = "iodepth",
1975 .category = FIO_OPT_C_IO,
1976 .group = FIO_OPT_G_IO_BASIC,
1979 .name = "serialize_overlap",
1980 .lname = "Serialize overlap",
1981 .off1 = offsetof(struct thread_options, serialize_overlap),
1982 .type = FIO_OPT_BOOL,
1983 .help = "Wait for in-flight IOs that collide to complete",
1984 .parent = "iodepth",
1986 .category = FIO_OPT_C_IO,
1987 .group = FIO_OPT_G_IO_BASIC,
1990 .name = "io_submit_mode",
1991 .lname = "IO submit mode",
1992 .type = FIO_OPT_STR,
1993 .off1 = offsetof(struct thread_options, io_submit_mode),
1994 .help = "How IO submissions and completions are done",
1996 .category = FIO_OPT_C_IO,
1997 .group = FIO_OPT_G_IO_BASIC,
2000 .oval = IO_MODE_INLINE,
2001 .help = "Submit and complete IO inline",
2003 { .ival = "offload",
2004 .oval = IO_MODE_OFFLOAD,
2005 .help = "Offload submit and complete to threads",
2012 .type = FIO_OPT_STR_VAL,
2014 .off1 = offsetof(struct thread_options, size),
2015 .help = "Total size of device or files",
2016 .interval = 1024 * 1024,
2017 .category = FIO_OPT_C_IO,
2018 .group = FIO_OPT_G_INVALID,
2022 .alias = "io_limit",
2024 .type = FIO_OPT_STR_VAL,
2025 .off1 = offsetof(struct thread_options, io_size),
2026 .help = "Total size of I/O to be performed",
2027 .interval = 1024 * 1024,
2028 .category = FIO_OPT_C_IO,
2029 .group = FIO_OPT_G_INVALID,
2032 .name = "fill_device",
2033 .lname = "Fill device",
2035 .type = FIO_OPT_BOOL,
2036 .off1 = offsetof(struct thread_options, fill_device),
2037 .help = "Write until an ENOSPC error occurs",
2039 .category = FIO_OPT_C_FILE,
2040 .group = FIO_OPT_G_INVALID,
2044 .lname = "File size",
2045 .type = FIO_OPT_STR_VAL,
2046 .off1 = offsetof(struct thread_options, file_size_low),
2047 .off2 = offsetof(struct thread_options, file_size_high),
2049 .help = "Size of individual files",
2050 .interval = 1024 * 1024,
2051 .category = FIO_OPT_C_FILE,
2052 .group = FIO_OPT_G_INVALID,
2055 .name = "file_append",
2056 .lname = "File append",
2057 .type = FIO_OPT_BOOL,
2058 .off1 = offsetof(struct thread_options, file_append),
2059 .help = "IO will start at the end of the file(s)",
2061 .category = FIO_OPT_C_FILE,
2062 .group = FIO_OPT_G_INVALID,
2066 .lname = "IO offset",
2067 .alias = "fileoffset",
2068 .type = FIO_OPT_STR_VAL,
2069 .cb = str_offset_cb,
2070 .off1 = offsetof(struct thread_options, start_offset),
2071 .help = "Start IO from this offset",
2073 .interval = 1024 * 1024,
2074 .category = FIO_OPT_C_IO,
2075 .group = FIO_OPT_G_INVALID,
2078 .name = "offset_align",
2079 .lname = "IO offset alignment",
2080 .type = FIO_OPT_INT,
2081 .off1 = offsetof(struct thread_options, start_offset_align),
2082 .help = "Start IO from this offset alignment",
2085 .category = FIO_OPT_C_IO,
2086 .group = FIO_OPT_G_INVALID,
2089 .name = "offset_increment",
2090 .lname = "IO offset increment",
2091 .type = FIO_OPT_STR_VAL,
2092 .off1 = offsetof(struct thread_options, offset_increment),
2093 .help = "What is the increment from one offset to the next",
2097 .interval = 1024 * 1024,
2098 .category = FIO_OPT_C_IO,
2099 .group = FIO_OPT_G_INVALID,
2102 .name = "number_ios",
2103 .lname = "Number of IOs to perform",
2104 .type = FIO_OPT_STR_VAL,
2105 .off1 = offsetof(struct thread_options, number_ios),
2106 .help = "Force job completion after this number of IOs",
2108 .category = FIO_OPT_C_IO,
2109 .group = FIO_OPT_G_INVALID,
2113 .lname = "Block size",
2114 .alias = "blocksize",
2115 .type = FIO_OPT_INT,
2116 .off1 = offsetof(struct thread_options, bs[DDIR_READ]),
2117 .off2 = offsetof(struct thread_options, bs[DDIR_WRITE]),
2118 .off3 = offsetof(struct thread_options, bs[DDIR_TRIM]),
2120 .help = "Block size unit",
2125 .category = FIO_OPT_C_IO,
2126 .group = FIO_OPT_G_INVALID,
2130 .lname = "Block size align",
2131 .alias = "blockalign",
2132 .type = FIO_OPT_INT,
2133 .off1 = offsetof(struct thread_options, ba[DDIR_READ]),
2134 .off2 = offsetof(struct thread_options, ba[DDIR_WRITE]),
2135 .off3 = offsetof(struct thread_options, ba[DDIR_TRIM]),
2137 .help = "IO block offset alignment",
2141 .category = FIO_OPT_C_IO,
2142 .group = FIO_OPT_G_INVALID,
2146 .lname = "Block size range",
2147 .alias = "blocksize_range",
2148 .type = FIO_OPT_RANGE,
2149 .off1 = offsetof(struct thread_options, min_bs[DDIR_READ]),
2150 .off2 = offsetof(struct thread_options, max_bs[DDIR_READ]),
2151 .off3 = offsetof(struct thread_options, min_bs[DDIR_WRITE]),
2152 .off4 = offsetof(struct thread_options, max_bs[DDIR_WRITE]),
2153 .off5 = offsetof(struct thread_options, min_bs[DDIR_TRIM]),
2154 .off6 = offsetof(struct thread_options, max_bs[DDIR_TRIM]),
2156 .help = "Set block size range (in more detail than bs)",
2160 .category = FIO_OPT_C_IO,
2161 .group = FIO_OPT_G_INVALID,
2165 .lname = "Block size split",
2166 .type = FIO_OPT_STR,
2167 .cb = str_bssplit_cb,
2168 .off1 = offsetof(struct thread_options, bssplit),
2169 .help = "Set a specific mix of block sizes",
2172 .category = FIO_OPT_C_IO,
2173 .group = FIO_OPT_G_INVALID,
2176 .name = "bs_unaligned",
2177 .lname = "Block size unaligned",
2178 .alias = "blocksize_unaligned",
2179 .type = FIO_OPT_STR_SET,
2180 .off1 = offsetof(struct thread_options, bs_unaligned),
2181 .help = "Don't sector align IO buffer sizes",
2184 .category = FIO_OPT_C_IO,
2185 .group = FIO_OPT_G_INVALID,
2188 .name = "bs_is_seq_rand",
2189 .lname = "Block size division is seq/random (not read/write)",
2190 .type = FIO_OPT_BOOL,
2191 .off1 = offsetof(struct thread_options, bs_is_seq_rand),
2192 .help = "Consider any blocksize setting to be sequential,random",
2194 .parent = "blocksize",
2195 .category = FIO_OPT_C_IO,
2196 .group = FIO_OPT_G_INVALID,
2199 .name = "randrepeat",
2200 .lname = "Random repeatable",
2201 .type = FIO_OPT_BOOL,
2202 .off1 = offsetof(struct thread_options, rand_repeatable),
2203 .help = "Use repeatable random IO pattern",
2207 .category = FIO_OPT_C_IO,
2208 .group = FIO_OPT_G_RANDOM,
2212 .lname = "The random generator seed",
2213 .type = FIO_OPT_STR_VAL,
2214 .off1 = offsetof(struct thread_options, rand_seed),
2215 .help = "Set the random generator seed value",
2218 .category = FIO_OPT_C_IO,
2219 .group = FIO_OPT_G_RANDOM,
2222 .name = "use_os_rand",
2223 .lname = "Use OS random",
2224 .type = FIO_OPT_DEPRECATED,
2225 .off1 = offsetof(struct thread_options, dep_use_os_rand),
2226 .category = FIO_OPT_C_IO,
2227 .group = FIO_OPT_G_RANDOM,
2230 .name = "norandommap",
2231 .lname = "No randommap",
2232 .type = FIO_OPT_STR_SET,
2233 .off1 = offsetof(struct thread_options, norandommap),
2234 .help = "Accept potential duplicate random blocks",
2238 .category = FIO_OPT_C_IO,
2239 .group = FIO_OPT_G_RANDOM,
2242 .name = "softrandommap",
2243 .lname = "Soft randommap",
2244 .type = FIO_OPT_BOOL,
2245 .off1 = offsetof(struct thread_options, softrandommap),
2246 .help = "Set norandommap if randommap allocation fails",
2247 .parent = "norandommap",
2250 .category = FIO_OPT_C_IO,
2251 .group = FIO_OPT_G_RANDOM,
2254 .name = "random_generator",
2255 .lname = "Random Generator",
2256 .type = FIO_OPT_STR,
2257 .off1 = offsetof(struct thread_options, random_generator),
2258 .help = "Type of random number generator to use",
2259 .def = "tausworthe",
2261 { .ival = "tausworthe",
2262 .oval = FIO_RAND_GEN_TAUSWORTHE,
2263 .help = "Strong Tausworthe generator",
2266 .oval = FIO_RAND_GEN_LFSR,
2267 .help = "Variable length LFSR",
2270 .ival = "tausworthe64",
2271 .oval = FIO_RAND_GEN_TAUSWORTHE64,
2272 .help = "64-bit Tausworthe variant",
2275 .category = FIO_OPT_C_IO,
2276 .group = FIO_OPT_G_RANDOM,
2279 .name = "random_distribution",
2280 .lname = "Random Distribution",
2281 .type = FIO_OPT_STR,
2282 .off1 = offsetof(struct thread_options, random_distribution),
2283 .cb = str_random_distribution_cb,
2284 .help = "Random offset distribution generator",
2288 .oval = FIO_RAND_DIST_RANDOM,
2289 .help = "Completely random",
2292 .oval = FIO_RAND_DIST_ZIPF,
2293 .help = "Zipf distribution",
2296 .oval = FIO_RAND_DIST_PARETO,
2297 .help = "Pareto distribution",
2300 .oval = FIO_RAND_DIST_GAUSS,
2301 .help = "Normal (Gaussian) distribution",
2304 .oval = FIO_RAND_DIST_ZONED,
2305 .help = "Zoned random distribution",
2307 { .ival = "zoned_abs",
2308 .oval = FIO_RAND_DIST_ZONED_ABS,
2309 .help = "Zoned absolute random distribution",
2312 .category = FIO_OPT_C_IO,
2313 .group = FIO_OPT_G_RANDOM,
2316 .name = "percentage_random",
2317 .lname = "Percentage Random",
2318 .type = FIO_OPT_INT,
2319 .off1 = offsetof(struct thread_options, perc_rand[DDIR_READ]),
2320 .off2 = offsetof(struct thread_options, perc_rand[DDIR_WRITE]),
2321 .off3 = offsetof(struct thread_options, perc_rand[DDIR_TRIM]),
2323 .help = "Percentage of seq/random mix that should be random",
2324 .def = "100,100,100",
2326 .inverse = "percentage_sequential",
2327 .category = FIO_OPT_C_IO,
2328 .group = FIO_OPT_G_RANDOM,
2331 .name = "percentage_sequential",
2332 .lname = "Percentage Sequential",
2333 .type = FIO_OPT_DEPRECATED,
2334 .category = FIO_OPT_C_IO,
2335 .group = FIO_OPT_G_RANDOM,
2338 .name = "allrandrepeat",
2339 .lname = "All Random Repeat",
2340 .type = FIO_OPT_BOOL,
2341 .off1 = offsetof(struct thread_options, allrand_repeatable),
2342 .help = "Use repeatable random numbers for everything",
2344 .category = FIO_OPT_C_IO,
2345 .group = FIO_OPT_G_RANDOM,
2349 .lname = "Number of files",
2350 .alias = "nr_files",
2351 .type = FIO_OPT_INT,
2352 .off1 = offsetof(struct thread_options, nr_files),
2353 .help = "Split job workload between this number of files",
2356 .category = FIO_OPT_C_FILE,
2357 .group = FIO_OPT_G_INVALID,
2360 .name = "openfiles",
2361 .lname = "Number of open files",
2362 .type = FIO_OPT_INT,
2363 .off1 = offsetof(struct thread_options, open_files),
2364 .help = "Number of files to keep open at the same time",
2365 .category = FIO_OPT_C_FILE,
2366 .group = FIO_OPT_G_INVALID,
2369 .name = "file_service_type",
2370 .lname = "File service type",
2371 .type = FIO_OPT_STR,
2373 .off1 = offsetof(struct thread_options, file_service_type),
2374 .help = "How to select which file to service next",
2375 .def = "roundrobin",
2376 .category = FIO_OPT_C_FILE,
2377 .group = FIO_OPT_G_INVALID,
2380 .oval = FIO_FSERVICE_RANDOM,
2381 .help = "Choose a file at random (uniform)",
2384 .oval = FIO_FSERVICE_ZIPF,
2385 .help = "Zipf randomized",
2388 .oval = FIO_FSERVICE_PARETO,
2389 .help = "Pareto randomized",
2392 .oval = FIO_FSERVICE_GAUSS,
2393 .help = "Normal (Gaussian) randomized",
2396 .oval = FIO_FSERVICE_GAUSS,
2397 .help = "Alias for normal",
2399 { .ival = "roundrobin",
2400 .oval = FIO_FSERVICE_RR,
2401 .help = "Round robin select files",
2403 { .ival = "sequential",
2404 .oval = FIO_FSERVICE_SEQ,
2405 .help = "Finish one file before moving to the next",
2408 .parent = "nrfiles",
2411 #ifdef FIO_HAVE_ANY_FALLOCATE
2413 .name = "fallocate",
2414 .lname = "Fallocate",
2415 .type = FIO_OPT_STR,
2416 .off1 = offsetof(struct thread_options, fallocate_mode),
2417 .help = "Whether pre-allocation is performed when laying out files",
2419 .category = FIO_OPT_C_FILE,
2420 .group = FIO_OPT_G_INVALID,
2423 .oval = FIO_FALLOCATE_NONE,
2424 .help = "Do not pre-allocate space",
2427 .oval = FIO_FALLOCATE_NATIVE,
2428 .help = "Use native pre-allocation if possible",
2430 #ifdef CONFIG_POSIX_FALLOCATE
2432 .oval = FIO_FALLOCATE_POSIX,
2433 .help = "Use posix_fallocate()",
2436 #ifdef CONFIG_LINUX_FALLOCATE
2438 .oval = FIO_FALLOCATE_KEEP_SIZE,
2439 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
2442 /* Compatibility with former boolean values */
2444 .oval = FIO_FALLOCATE_NONE,
2445 .help = "Alias for 'none'",
2447 #ifdef CONFIG_POSIX_FALLOCATE
2449 .oval = FIO_FALLOCATE_POSIX,
2450 .help = "Alias for 'posix'",
2455 #else /* FIO_HAVE_ANY_FALLOCATE */
2457 .name = "fallocate",
2458 .lname = "Fallocate",
2459 .type = FIO_OPT_UNSUPPORTED,
2460 .help = "Your platform does not support fallocate",
2462 #endif /* FIO_HAVE_ANY_FALLOCATE */
2464 .name = "fadvise_hint",
2465 .lname = "Fadvise hint",
2466 .type = FIO_OPT_STR,
2467 .off1 = offsetof(struct thread_options, fadvise_hint),
2471 .help = "Don't issue fadvise/madvise",
2475 .help = "Advise using fio IO pattern",
2478 .oval = F_ADV_RANDOM,
2479 .help = "Advise using FADV_RANDOM",
2481 { .ival = "sequential",
2482 .oval = F_ADV_SEQUENTIAL,
2483 .help = "Advise using FADV_SEQUENTIAL",
2486 .help = "Use fadvise() to advise the kernel on IO pattern",
2488 .category = FIO_OPT_C_FILE,
2489 .group = FIO_OPT_G_INVALID,
2494 .type = FIO_OPT_INT,
2495 .off1 = offsetof(struct thread_options, fsync_blocks),
2496 .help = "Issue fsync for writes every given number of blocks",
2499 .category = FIO_OPT_C_FILE,
2500 .group = FIO_OPT_G_INVALID,
2503 .name = "fdatasync",
2504 .lname = "Fdatasync",
2505 .type = FIO_OPT_INT,
2506 .off1 = offsetof(struct thread_options, fdatasync_blocks),
2507 .help = "Issue fdatasync for writes every given number of blocks",
2510 .category = FIO_OPT_C_FILE,
2511 .group = FIO_OPT_G_INVALID,
2514 .name = "write_barrier",
2515 .lname = "Write barrier",
2516 .type = FIO_OPT_INT,
2517 .off1 = offsetof(struct thread_options, barrier_blocks),
2518 .help = "Make every Nth write a barrier write",
2521 .category = FIO_OPT_C_IO,
2522 .group = FIO_OPT_G_INVALID,
2524 #ifdef CONFIG_SYNC_FILE_RANGE
2526 .name = "sync_file_range",
2527 .lname = "Sync file range",
2529 { .ival = "wait_before",
2530 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2531 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2535 .oval = SYNC_FILE_RANGE_WRITE,
2536 .help = "SYNC_FILE_RANGE_WRITE",
2540 .ival = "wait_after",
2541 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2542 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2546 .type = FIO_OPT_STR_MULTI,
2548 .off1 = offsetof(struct thread_options, sync_file_range),
2549 .help = "Use sync_file_range()",
2550 .category = FIO_OPT_C_FILE,
2551 .group = FIO_OPT_G_INVALID,
2555 .name = "sync_file_range",
2556 .lname = "Sync file range",
2557 .type = FIO_OPT_UNSUPPORTED,
2558 .help = "Your platform does not support sync_file_range",
2563 .lname = "Direct I/O",
2564 .type = FIO_OPT_BOOL,
2565 .off1 = offsetof(struct thread_options, odirect),
2566 .help = "Use O_DIRECT IO (negates buffered)",
2568 .inverse = "buffered",
2569 .category = FIO_OPT_C_IO,
2570 .group = FIO_OPT_G_IO_TYPE,
2574 .lname = "Atomic I/O",
2575 .type = FIO_OPT_BOOL,
2576 .off1 = offsetof(struct thread_options, oatomic),
2577 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2579 .category = FIO_OPT_C_IO,
2580 .group = FIO_OPT_G_IO_TYPE,
2584 .lname = "Buffered I/O",
2585 .type = FIO_OPT_BOOL,
2586 .off1 = offsetof(struct thread_options, odirect),
2588 .help = "Use buffered IO (negates direct)",
2590 .inverse = "direct",
2591 .category = FIO_OPT_C_IO,
2592 .group = FIO_OPT_G_IO_TYPE,
2595 .name = "overwrite",
2596 .lname = "Overwrite",
2597 .type = FIO_OPT_BOOL,
2598 .off1 = offsetof(struct thread_options, overwrite),
2599 .help = "When writing, set whether to overwrite current data",
2601 .category = FIO_OPT_C_FILE,
2602 .group = FIO_OPT_G_INVALID,
2607 .type = FIO_OPT_INT,
2608 .off1 = offsetof(struct thread_options, loops),
2609 .help = "Number of times to run the job",
2612 .category = FIO_OPT_C_GENERAL,
2613 .group = FIO_OPT_G_RUNTIME,
2617 .lname = "Number of jobs",
2618 .type = FIO_OPT_INT,
2619 .off1 = offsetof(struct thread_options, numjobs),
2620 .help = "Duplicate this job this many times",
2623 .category = FIO_OPT_C_GENERAL,
2624 .group = FIO_OPT_G_RUNTIME,
2627 .name = "startdelay",
2628 .lname = "Start delay",
2629 .type = FIO_OPT_STR_VAL_TIME,
2630 .off1 = offsetof(struct thread_options, start_delay),
2631 .off2 = offsetof(struct thread_options, start_delay_high),
2632 .help = "Only start job when this period has passed",
2636 .category = FIO_OPT_C_GENERAL,
2637 .group = FIO_OPT_G_RUNTIME,
2643 .type = FIO_OPT_STR_VAL_TIME,
2644 .off1 = offsetof(struct thread_options, timeout),
2645 .help = "Stop workload when this amount of time has passed",
2649 .category = FIO_OPT_C_GENERAL,
2650 .group = FIO_OPT_G_RUNTIME,
2653 .name = "time_based",
2654 .lname = "Time based",
2655 .type = FIO_OPT_STR_SET,
2656 .off1 = offsetof(struct thread_options, time_based),
2657 .help = "Keep running until runtime/timeout is met",
2658 .category = FIO_OPT_C_GENERAL,
2659 .group = FIO_OPT_G_RUNTIME,
2662 .name = "verify_only",
2663 .lname = "Verify only",
2664 .type = FIO_OPT_STR_SET,
2665 .off1 = offsetof(struct thread_options, verify_only),
2666 .help = "Verifies previously written data is still valid",
2667 .category = FIO_OPT_C_GENERAL,
2668 .group = FIO_OPT_G_RUNTIME,
2671 .name = "ramp_time",
2672 .lname = "Ramp time",
2673 .type = FIO_OPT_STR_VAL_TIME,
2674 .off1 = offsetof(struct thread_options, ramp_time),
2675 .help = "Ramp up time before measuring performance",
2678 .category = FIO_OPT_C_GENERAL,
2679 .group = FIO_OPT_G_RUNTIME,
2682 .name = "clocksource",
2683 .lname = "Clock source",
2684 .type = FIO_OPT_STR,
2685 .cb = fio_clock_source_cb,
2686 .off1 = offsetof(struct thread_options, clocksource),
2687 .help = "What type of timing source to use",
2688 .category = FIO_OPT_C_GENERAL,
2689 .group = FIO_OPT_G_CLOCK,
2691 #ifdef CONFIG_GETTIMEOFDAY
2692 { .ival = "gettimeofday",
2694 .help = "Use gettimeofday(2) for timing",
2697 #ifdef CONFIG_CLOCK_GETTIME
2698 { .ival = "clock_gettime",
2699 .oval = CS_CGETTIME,
2700 .help = "Use clock_gettime(2) for timing",
2703 #ifdef ARCH_HAVE_CPU_CLOCK
2705 .oval = CS_CPUCLOCK,
2706 .help = "Use CPU private clock",
2714 .lname = "I/O Memory",
2715 .type = FIO_OPT_STR,
2717 .off1 = offsetof(struct thread_options, mem_type),
2718 .help = "Backing type for IO buffers",
2720 .category = FIO_OPT_C_IO,
2721 .group = FIO_OPT_G_INVALID,
2725 .help = "Use malloc(3) for IO buffers",
2727 #ifndef CONFIG_NO_SHM
2730 .help = "Use shared memory segments for IO buffers",
2732 #ifdef FIO_HAVE_HUGETLB
2733 { .ival = "shmhuge",
2734 .oval = MEM_SHMHUGE,
2735 .help = "Like shm, but use huge pages",
2741 .help = "Use mmap(2) (file or anon) for IO buffers",
2743 { .ival = "mmapshared",
2744 .oval = MEM_MMAPSHARED,
2745 .help = "Like mmap, but use the shared flag",
2747 #ifdef FIO_HAVE_HUGETLB
2748 { .ival = "mmaphuge",
2749 .oval = MEM_MMAPHUGE,
2750 .help = "Like mmap, but use huge pages",
2754 { .ival = "cudamalloc",
2755 .oval = MEM_CUDA_MALLOC,
2756 .help = "Allocate GPU device memory for GPUDirect RDMA",
2762 .name = "iomem_align",
2763 .alias = "mem_align",
2764 .lname = "I/O memory alignment",
2765 .type = FIO_OPT_INT,
2766 .off1 = offsetof(struct thread_options, mem_align),
2768 .help = "IO memory buffer offset alignment",
2772 .category = FIO_OPT_C_IO,
2773 .group = FIO_OPT_G_INVALID,
2778 .type = FIO_OPT_STR,
2779 .off1 = offsetof(struct thread_options, verify),
2780 .help = "Verify data written",
2782 .category = FIO_OPT_C_IO,
2783 .group = FIO_OPT_G_VERIFY,
2786 .oval = VERIFY_NONE,
2787 .help = "Don't do IO verification",
2791 .help = "Use md5 checksums for verification",
2794 .oval = VERIFY_CRC64,
2795 .help = "Use crc64 checksums for verification",
2798 .oval = VERIFY_CRC32,
2799 .help = "Use crc32 checksums for verification",
2801 { .ival = "crc32c-intel",
2802 .oval = VERIFY_CRC32C,
2803 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2806 .oval = VERIFY_CRC32C,
2807 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2810 .oval = VERIFY_CRC16,
2811 .help = "Use crc16 checksums for verification",
2814 .oval = VERIFY_CRC7,
2815 .help = "Use crc7 checksums for verification",
2818 .oval = VERIFY_SHA1,
2819 .help = "Use sha1 checksums for verification",
2822 .oval = VERIFY_SHA256,
2823 .help = "Use sha256 checksums for verification",
2826 .oval = VERIFY_SHA512,
2827 .help = "Use sha512 checksums for verification",
2829 { .ival = "sha3-224",
2830 .oval = VERIFY_SHA3_224,
2831 .help = "Use sha3-224 checksums for verification",
2833 { .ival = "sha3-256",
2834 .oval = VERIFY_SHA3_256,
2835 .help = "Use sha3-256 checksums for verification",
2837 { .ival = "sha3-384",
2838 .oval = VERIFY_SHA3_384,
2839 .help = "Use sha3-384 checksums for verification",
2841 { .ival = "sha3-512",
2842 .oval = VERIFY_SHA3_512,
2843 .help = "Use sha3-512 checksums for verification",
2846 .oval = VERIFY_XXHASH,
2847 .help = "Use xxhash checksums for verification",
2849 /* Meta information was included into verify_header,
2850 * 'meta' verification is implied by default. */
2852 .oval = VERIFY_HDR_ONLY,
2853 .help = "Use io information for verification. "
2854 "Now is implied by default, thus option is obsolete, "
2857 { .ival = "pattern",
2858 .oval = VERIFY_PATTERN_NO_HDR,
2859 .help = "Verify strict pattern",
2863 .oval = VERIFY_NULL,
2864 .help = "Pretend to verify",
2869 .name = "do_verify",
2870 .lname = "Perform verify step",
2871 .type = FIO_OPT_BOOL,
2872 .off1 = offsetof(struct thread_options, do_verify),
2873 .help = "Run verification stage after write",
2877 .category = FIO_OPT_C_IO,
2878 .group = FIO_OPT_G_VERIFY,
2881 .name = "verifysort",
2882 .lname = "Verify sort",
2883 .type = FIO_OPT_SOFT_DEPRECATED,
2884 .category = FIO_OPT_C_IO,
2885 .group = FIO_OPT_G_VERIFY,
2888 .name = "verifysort_nr",
2889 .lname = "Verify Sort Nr",
2890 .type = FIO_OPT_SOFT_DEPRECATED,
2891 .category = FIO_OPT_C_IO,
2892 .group = FIO_OPT_G_VERIFY,
2895 .name = "verify_interval",
2896 .lname = "Verify interval",
2897 .type = FIO_OPT_INT,
2898 .off1 = offsetof(struct thread_options, verify_interval),
2899 .minval = 2 * sizeof(struct verify_header),
2900 .help = "Store verify buffer header every N bytes",
2903 .interval = 2 * sizeof(struct verify_header),
2904 .category = FIO_OPT_C_IO,
2905 .group = FIO_OPT_G_VERIFY,
2908 .name = "verify_offset",
2909 .lname = "Verify offset",
2910 .type = FIO_OPT_INT,
2911 .help = "Offset verify header location by N bytes",
2912 .off1 = offsetof(struct thread_options, verify_offset),
2913 .minval = sizeof(struct verify_header),
2916 .category = FIO_OPT_C_IO,
2917 .group = FIO_OPT_G_VERIFY,
2920 .name = "verify_pattern",
2921 .lname = "Verify pattern",
2922 .type = FIO_OPT_STR,
2923 .cb = str_verify_pattern_cb,
2924 .off1 = offsetof(struct thread_options, verify_pattern),
2925 .help = "Fill pattern for IO buffers",
2928 .category = FIO_OPT_C_IO,
2929 .group = FIO_OPT_G_VERIFY,
2932 .name = "verify_fatal",
2933 .lname = "Verify fatal",
2934 .type = FIO_OPT_BOOL,
2935 .off1 = offsetof(struct thread_options, verify_fatal),
2937 .help = "Exit on a single verify failure, don't continue",
2940 .category = FIO_OPT_C_IO,
2941 .group = FIO_OPT_G_VERIFY,
2944 .name = "verify_dump",
2945 .lname = "Verify dump",
2946 .type = FIO_OPT_BOOL,
2947 .off1 = offsetof(struct thread_options, verify_dump),
2949 .help = "Dump contents of good and bad blocks on failure",
2952 .category = FIO_OPT_C_IO,
2953 .group = FIO_OPT_G_VERIFY,
2956 .name = "verify_async",
2957 .lname = "Verify asynchronously",
2958 .type = FIO_OPT_INT,
2959 .off1 = offsetof(struct thread_options, verify_async),
2961 .help = "Number of async verifier threads to use",
2964 .category = FIO_OPT_C_IO,
2965 .group = FIO_OPT_G_VERIFY,
2968 .name = "verify_backlog",
2969 .lname = "Verify backlog",
2970 .type = FIO_OPT_STR_VAL,
2971 .off1 = offsetof(struct thread_options, verify_backlog),
2972 .help = "Verify after this number of blocks are written",
2975 .category = FIO_OPT_C_IO,
2976 .group = FIO_OPT_G_VERIFY,
2979 .name = "verify_backlog_batch",
2980 .lname = "Verify backlog batch",
2981 .type = FIO_OPT_INT,
2982 .off1 = offsetof(struct thread_options, verify_batch),
2983 .help = "Verify this number of IO blocks",
2986 .category = FIO_OPT_C_IO,
2987 .group = FIO_OPT_G_VERIFY,
2989 #ifdef FIO_HAVE_CPU_AFFINITY
2991 .name = "verify_async_cpus",
2992 .lname = "Async verify CPUs",
2993 .type = FIO_OPT_STR,
2994 .cb = str_verify_cpus_allowed_cb,
2995 .off1 = offsetof(struct thread_options, verify_cpumask),
2996 .help = "Set CPUs allowed for async verify threads",
2997 .parent = "verify_async",
2999 .category = FIO_OPT_C_IO,
3000 .group = FIO_OPT_G_VERIFY,
3004 .name = "verify_async_cpus",
3005 .lname = "Async verify CPUs",
3006 .type = FIO_OPT_UNSUPPORTED,
3007 .help = "Your platform does not support CPU affinities",
3011 .name = "experimental_verify",
3012 .lname = "Experimental Verify",
3013 .off1 = offsetof(struct thread_options, experimental_verify),
3014 .type = FIO_OPT_BOOL,
3015 .help = "Enable experimental verification",
3017 .category = FIO_OPT_C_IO,
3018 .group = FIO_OPT_G_VERIFY,
3021 .name = "verify_state_load",
3022 .lname = "Load verify state",
3023 .off1 = offsetof(struct thread_options, verify_state),
3024 .type = FIO_OPT_BOOL,
3025 .help = "Load verify termination state",
3027 .category = FIO_OPT_C_IO,
3028 .group = FIO_OPT_G_VERIFY,
3031 .name = "verify_state_save",
3032 .lname = "Save verify state",
3033 .off1 = offsetof(struct thread_options, verify_state_save),
3034 .type = FIO_OPT_BOOL,
3036 .help = "Save verify state on termination",
3038 .category = FIO_OPT_C_IO,
3039 .group = FIO_OPT_G_VERIFY,
3041 #ifdef FIO_HAVE_TRIM
3043 .name = "trim_percentage",
3044 .lname = "Trim percentage",
3045 .type = FIO_OPT_INT,
3046 .off1 = offsetof(struct thread_options, trim_percentage),
3049 .help = "Number of verify blocks to trim (i.e., discard)",
3054 .category = FIO_OPT_C_IO,
3055 .group = FIO_OPT_G_TRIM,
3058 .name = "trim_verify_zero",
3059 .lname = "Verify trim zero",
3060 .type = FIO_OPT_BOOL,
3061 .help = "Verify that trimmed (i.e., discarded) blocks are returned as zeroes",
3062 .off1 = offsetof(struct thread_options, trim_zero),
3063 .parent = "trim_percentage",
3066 .category = FIO_OPT_C_IO,
3067 .group = FIO_OPT_G_TRIM,
3070 .name = "trim_backlog",
3071 .lname = "Trim backlog",
3072 .type = FIO_OPT_STR_VAL,
3073 .off1 = offsetof(struct thread_options, trim_backlog),
3074 .help = "Trim after this number of blocks are written",
3075 .parent = "trim_percentage",
3078 .category = FIO_OPT_C_IO,
3079 .group = FIO_OPT_G_TRIM,
3082 .name = "trim_backlog_batch",
3083 .lname = "Trim backlog batch",
3084 .type = FIO_OPT_INT,
3085 .off1 = offsetof(struct thread_options, trim_batch),
3086 .help = "Trim this number of IO blocks",
3087 .parent = "trim_percentage",
3090 .category = FIO_OPT_C_IO,
3091 .group = FIO_OPT_G_TRIM,
3095 .name = "trim_percentage",
3096 .lname = "Trim percentage",
3097 .type = FIO_OPT_UNSUPPORTED,
3098 .help = "Fio does not support TRIM on your platform",
3101 .name = "trim_verify_zero",
3102 .lname = "Verify trim zero",
3103 .type = FIO_OPT_UNSUPPORTED,
3104 .help = "Fio does not support TRIM on your platform",
3107 .name = "trim_backlog",
3108 .lname = "Trim backlog",
3109 .type = FIO_OPT_UNSUPPORTED,
3110 .help = "Fio does not support TRIM on your platform",
3113 .name = "trim_backlog_batch",
3114 .lname = "Trim backlog batch",
3115 .type = FIO_OPT_UNSUPPORTED,
3116 .help = "Fio does not support TRIM on your platform",
3120 .name = "write_iolog",
3121 .lname = "Write I/O log",
3122 .type = FIO_OPT_STR_STORE,
3123 .off1 = offsetof(struct thread_options, write_iolog_file),
3124 .help = "Store IO pattern to file",
3125 .category = FIO_OPT_C_IO,
3126 .group = FIO_OPT_G_IOLOG,
3129 .name = "read_iolog",
3130 .lname = "Read I/O log",
3131 .type = FIO_OPT_STR_STORE,
3132 .off1 = offsetof(struct thread_options, read_iolog_file),
3133 .help = "Playback IO pattern from file",
3134 .category = FIO_OPT_C_IO,
3135 .group = FIO_OPT_G_IOLOG,
3138 .name = "read_iolog_chunked",
3139 .lname = "Read I/O log in parts",
3140 .type = FIO_OPT_BOOL,
3141 .off1 = offsetof(struct thread_options, read_iolog_chunked),
3143 .parent = "read_iolog",
3144 .help = "Parse IO pattern in chunks",
3145 .category = FIO_OPT_C_IO,
3146 .group = FIO_OPT_G_IOLOG,
3149 .name = "replay_no_stall",
3150 .lname = "Don't stall on replay",
3151 .type = FIO_OPT_BOOL,
3152 .off1 = offsetof(struct thread_options, no_stall),
3154 .parent = "read_iolog",
3156 .help = "Playback IO pattern file as fast as possible without stalls",
3157 .category = FIO_OPT_C_IO,
3158 .group = FIO_OPT_G_IOLOG,
3161 .name = "replay_redirect",
3162 .lname = "Redirect device for replay",
3163 .type = FIO_OPT_STR_STORE,
3164 .off1 = offsetof(struct thread_options, replay_redirect),
3165 .parent = "read_iolog",
3167 .help = "Replay all I/O onto this device, regardless of trace device",
3168 .category = FIO_OPT_C_IO,
3169 .group = FIO_OPT_G_IOLOG,
3172 .name = "replay_scale",
3173 .lname = "Replace offset scale factor",
3174 .type = FIO_OPT_INT,
3175 .off1 = offsetof(struct thread_options, replay_scale),
3176 .parent = "read_iolog",
3178 .help = "Align offsets to this blocksize",
3179 .category = FIO_OPT_C_IO,
3180 .group = FIO_OPT_G_IOLOG,
3183 .name = "replay_align",
3184 .lname = "Replace alignment",
3185 .type = FIO_OPT_INT,
3186 .off1 = offsetof(struct thread_options, replay_align),
3187 .parent = "read_iolog",
3188 .help = "Scale offset down by this factor",
3189 .category = FIO_OPT_C_IO,
3190 .group = FIO_OPT_G_IOLOG,
3194 .name = "replay_time_scale",
3195 .lname = "Replay Time Scale",
3196 .type = FIO_OPT_INT,
3197 .off1 = offsetof(struct thread_options, replay_time_scale),
3200 .parent = "read_iolog",
3202 .help = "Scale time for replay events",
3203 .category = FIO_OPT_C_IO,
3204 .group = FIO_OPT_G_IOLOG,
3207 .name = "replay_skip",
3208 .lname = "Replay Skip",
3209 .type = FIO_OPT_STR,
3210 .cb = str_replay_skip_cb,
3211 .off1 = offsetof(struct thread_options, replay_skip),
3212 .parent = "read_iolog",
3213 .help = "Skip certain IO types (read,write,trim,flush)",
3214 .category = FIO_OPT_C_IO,
3215 .group = FIO_OPT_G_IOLOG,
3218 .name = "exec_prerun",
3219 .lname = "Pre-execute runnable",
3220 .type = FIO_OPT_STR_STORE,
3221 .off1 = offsetof(struct thread_options, exec_prerun),
3222 .help = "Execute this file prior to running job",
3223 .category = FIO_OPT_C_GENERAL,
3224 .group = FIO_OPT_G_INVALID,
3227 .name = "exec_postrun",
3228 .lname = "Post-execute runnable",
3229 .type = FIO_OPT_STR_STORE,
3230 .off1 = offsetof(struct thread_options, exec_postrun),
3231 .help = "Execute this file after running job",
3232 .category = FIO_OPT_C_GENERAL,
3233 .group = FIO_OPT_G_INVALID,
3235 #ifdef FIO_HAVE_IOSCHED_SWITCH
3237 .name = "ioscheduler",
3238 .lname = "I/O scheduler",
3239 .type = FIO_OPT_STR_STORE,
3240 .off1 = offsetof(struct thread_options, ioscheduler),
3241 .help = "Use this IO scheduler on the backing device",
3242 .category = FIO_OPT_C_FILE,
3243 .group = FIO_OPT_G_INVALID,
3247 .name = "ioscheduler",
3248 .lname = "I/O scheduler",
3249 .type = FIO_OPT_UNSUPPORTED,
3250 .help = "Your platform does not support IO scheduler switching",
3255 .lname = "Zone size",
3256 .type = FIO_OPT_STR_VAL,
3257 .off1 = offsetof(struct thread_options, zone_size),
3258 .help = "Amount of data to read per zone",
3260 .interval = 1024 * 1024,
3261 .category = FIO_OPT_C_IO,
3262 .group = FIO_OPT_G_ZONE,
3265 .name = "zonerange",
3266 .lname = "Zone range",
3267 .type = FIO_OPT_STR_VAL,
3268 .off1 = offsetof(struct thread_options, zone_range),
3269 .help = "Give size of an IO zone",
3271 .interval = 1024 * 1024,
3272 .category = FIO_OPT_C_IO,
3273 .group = FIO_OPT_G_ZONE,
3277 .lname = "Zone skip",
3278 .type = FIO_OPT_STR_VAL,
3279 .off1 = offsetof(struct thread_options, zone_skip),
3280 .help = "Space between IO zones",
3282 .interval = 1024 * 1024,
3283 .category = FIO_OPT_C_IO,
3284 .group = FIO_OPT_G_ZONE,
3288 .lname = "Lock memory",
3289 .type = FIO_OPT_STR_VAL,
3290 .off1 = offsetof(struct thread_options, lockmem),
3291 .help = "Lock down this amount of memory (per worker)",
3293 .interval = 1024 * 1024,
3294 .category = FIO_OPT_C_GENERAL,
3295 .group = FIO_OPT_G_INVALID,
3298 .name = "rwmixread",
3299 .lname = "Read/write mix read",
3300 .type = FIO_OPT_INT,
3301 .cb = str_rwmix_read_cb,
3302 .off1 = offsetof(struct thread_options, rwmix[DDIR_READ]),
3304 .help = "Percentage of mixed workload that is reads",
3307 .inverse = "rwmixwrite",
3308 .category = FIO_OPT_C_IO,
3309 .group = FIO_OPT_G_RWMIX,
3312 .name = "rwmixwrite",
3313 .lname = "Read/write mix write",
3314 .type = FIO_OPT_INT,
3315 .cb = str_rwmix_write_cb,
3316 .off1 = offsetof(struct thread_options, rwmix[DDIR_WRITE]),
3318 .help = "Percentage of mixed workload that is writes",
3321 .inverse = "rwmixread",
3322 .category = FIO_OPT_C_IO,
3323 .group = FIO_OPT_G_RWMIX,
3326 .name = "rwmixcycle",
3327 .lname = "Read/write mix cycle",
3328 .type = FIO_OPT_DEPRECATED,
3329 .category = FIO_OPT_C_IO,
3330 .group = FIO_OPT_G_RWMIX,
3335 .type = FIO_OPT_INT,
3336 .off1 = offsetof(struct thread_options, nice),
3337 .help = "Set job CPU nice value",
3342 .category = FIO_OPT_C_GENERAL,
3343 .group = FIO_OPT_G_CRED,
3345 #ifdef FIO_HAVE_IOPRIO
3348 .lname = "I/O nice priority",
3349 .type = FIO_OPT_INT,
3350 .off1 = offsetof(struct thread_options, ioprio),
3351 .help = "Set job IO priority value",
3352 .minval = IOPRIO_MIN_PRIO,
3353 .maxval = IOPRIO_MAX_PRIO,
3355 .category = FIO_OPT_C_GENERAL,
3356 .group = FIO_OPT_G_CRED,
3361 .lname = "I/O nice priority",
3362 .type = FIO_OPT_UNSUPPORTED,
3363 .help = "Your platform does not support IO priorities",
3366 #ifdef FIO_HAVE_IOPRIO_CLASS
3367 #ifndef FIO_HAVE_IOPRIO
3368 #error "FIO_HAVE_IOPRIO_CLASS requires FIO_HAVE_IOPRIO"
3371 .name = "prioclass",
3372 .lname = "I/O nice priority class",
3373 .type = FIO_OPT_INT,
3374 .off1 = offsetof(struct thread_options, ioprio_class),
3375 .help = "Set job IO priority class",
3376 .minval = IOPRIO_MIN_PRIO_CLASS,
3377 .maxval = IOPRIO_MAX_PRIO_CLASS,
3379 .category = FIO_OPT_C_GENERAL,
3380 .group = FIO_OPT_G_CRED,
3384 .name = "prioclass",
3385 .lname = "I/O nice priority class",
3386 .type = FIO_OPT_UNSUPPORTED,
3387 .help = "Your platform does not support IO priority classes",
3391 .name = "thinktime",
3392 .lname = "Thinktime",
3393 .type = FIO_OPT_INT,
3394 .off1 = offsetof(struct thread_options, thinktime),
3395 .help = "Idle time between IO buffers (usec)",
3398 .category = FIO_OPT_C_IO,
3399 .group = FIO_OPT_G_THINKTIME,
3402 .name = "thinktime_spin",
3403 .lname = "Thinktime spin",
3404 .type = FIO_OPT_INT,
3405 .off1 = offsetof(struct thread_options, thinktime_spin),
3406 .help = "Start think time by spinning this amount (usec)",
3409 .parent = "thinktime",
3411 .category = FIO_OPT_C_IO,
3412 .group = FIO_OPT_G_THINKTIME,
3415 .name = "thinktime_blocks",
3416 .lname = "Thinktime blocks",
3417 .type = FIO_OPT_INT,
3418 .off1 = offsetof(struct thread_options, thinktime_blocks),
3419 .help = "IO buffer period between 'thinktime'",
3421 .parent = "thinktime",
3423 .category = FIO_OPT_C_IO,
3424 .group = FIO_OPT_G_THINKTIME,
3428 .lname = "I/O rate",
3429 .type = FIO_OPT_INT,
3430 .off1 = offsetof(struct thread_options, rate[DDIR_READ]),
3431 .off2 = offsetof(struct thread_options, rate[DDIR_WRITE]),
3432 .off3 = offsetof(struct thread_options, rate[DDIR_TRIM]),
3433 .help = "Set bandwidth rate",
3434 .category = FIO_OPT_C_IO,
3435 .group = FIO_OPT_G_RATE,
3440 .lname = "I/O min rate",
3441 .type = FIO_OPT_INT,
3442 .off1 = offsetof(struct thread_options, ratemin[DDIR_READ]),
3443 .off2 = offsetof(struct thread_options, ratemin[DDIR_WRITE]),
3444 .off3 = offsetof(struct thread_options, ratemin[DDIR_TRIM]),
3445 .help = "Job must meet this rate or it will be shutdown",
3448 .category = FIO_OPT_C_IO,
3449 .group = FIO_OPT_G_RATE,
3452 .name = "rate_iops",
3453 .lname = "I/O rate IOPS",
3454 .type = FIO_OPT_INT,
3455 .off1 = offsetof(struct thread_options, rate_iops[DDIR_READ]),
3456 .off2 = offsetof(struct thread_options, rate_iops[DDIR_WRITE]),
3457 .off3 = offsetof(struct thread_options, rate_iops[DDIR_TRIM]),
3458 .help = "Limit IO used to this number of IO operations/sec",
3460 .category = FIO_OPT_C_IO,
3461 .group = FIO_OPT_G_RATE,
3464 .name = "rate_iops_min",
3465 .lname = "I/O min rate IOPS",
3466 .type = FIO_OPT_INT,
3467 .off1 = offsetof(struct thread_options, rate_iops_min[DDIR_READ]),
3468 .off2 = offsetof(struct thread_options, rate_iops_min[DDIR_WRITE]),
3469 .off3 = offsetof(struct thread_options, rate_iops_min[DDIR_TRIM]),
3470 .help = "Job must meet this rate or it will be shut down",
3471 .parent = "rate_iops",
3473 .category = FIO_OPT_C_IO,
3474 .group = FIO_OPT_G_RATE,
3477 .name = "rate_process",
3478 .lname = "Rate Process",
3479 .type = FIO_OPT_STR,
3480 .off1 = offsetof(struct thread_options, rate_process),
3481 .help = "What process controls how rated IO is managed",
3483 .category = FIO_OPT_C_IO,
3484 .group = FIO_OPT_G_RATE,
3487 .oval = RATE_PROCESS_LINEAR,
3488 .help = "Linear rate of IO",
3492 .oval = RATE_PROCESS_POISSON,
3493 .help = "Rate follows Poisson process",
3499 .name = "rate_cycle",
3500 .alias = "ratecycle",
3501 .lname = "I/O rate cycle",
3502 .type = FIO_OPT_INT,
3503 .off1 = offsetof(struct thread_options, ratecycle),
3504 .help = "Window average for rate limits (msec)",
3508 .category = FIO_OPT_C_IO,
3509 .group = FIO_OPT_G_RATE,
3512 .name = "rate_ignore_thinktime",
3513 .lname = "Rate ignore thinktime",
3514 .type = FIO_OPT_BOOL,
3515 .off1 = offsetof(struct thread_options, rate_ign_think),
3516 .help = "Rated IO ignores thinktime settings",
3518 .category = FIO_OPT_C_IO,
3519 .group = FIO_OPT_G_RATE,
3522 .name = "max_latency",
3523 .lname = "Max Latency (usec)",
3524 .type = FIO_OPT_STR_VAL_TIME,
3525 .off1 = offsetof(struct thread_options, max_latency),
3526 .help = "Maximum tolerated IO latency (usec)",
3528 .category = FIO_OPT_C_IO,
3529 .group = FIO_OPT_G_LATPROF,
3532 .name = "latency_target",
3533 .lname = "Latency Target (usec)",
3534 .type = FIO_OPT_STR_VAL_TIME,
3535 .off1 = offsetof(struct thread_options, latency_target),
3536 .help = "Ramp to max queue depth supporting this latency",
3538 .category = FIO_OPT_C_IO,
3539 .group = FIO_OPT_G_LATPROF,
3542 .name = "latency_window",
3543 .lname = "Latency Window (usec)",
3544 .type = FIO_OPT_STR_VAL_TIME,
3545 .off1 = offsetof(struct thread_options, latency_window),
3546 .help = "Time to sustain latency_target",
3548 .category = FIO_OPT_C_IO,
3549 .group = FIO_OPT_G_LATPROF,
3552 .name = "latency_percentile",
3553 .lname = "Latency Percentile",
3554 .type = FIO_OPT_FLOAT_LIST,
3555 .off1 = offsetof(struct thread_options, latency_percentile),
3556 .help = "Percentile of IOs must be below latency_target",
3561 .category = FIO_OPT_C_IO,
3562 .group = FIO_OPT_G_LATPROF,
3565 .name = "invalidate",
3566 .lname = "Cache invalidate",
3567 .type = FIO_OPT_BOOL,
3568 .off1 = offsetof(struct thread_options, invalidate_cache),
3569 .help = "Invalidate buffer/page cache prior to running job",
3571 .category = FIO_OPT_C_IO,
3572 .group = FIO_OPT_G_IO_TYPE,
3576 .lname = "Synchronous I/O",
3577 .type = FIO_OPT_BOOL,
3578 .off1 = offsetof(struct thread_options, sync_io),
3579 .help = "Use O_SYNC for buffered writes",
3581 .parent = "buffered",
3583 .category = FIO_OPT_C_IO,
3584 .group = FIO_OPT_G_IO_TYPE,
3586 #ifdef FIO_HAVE_WRITE_HINT
3588 .name = "write_hint",
3589 .lname = "Write hint",
3590 .type = FIO_OPT_STR,
3591 .off1 = offsetof(struct thread_options, write_hint),
3592 .help = "Set expected write life time",
3593 .category = FIO_OPT_C_ENGINE,
3594 .group = FIO_OPT_G_INVALID,
3597 .oval = RWH_WRITE_LIFE_NONE,
3600 .oval = RWH_WRITE_LIFE_SHORT,
3603 .oval = RWH_WRITE_LIFE_MEDIUM,
3606 .oval = RWH_WRITE_LIFE_LONG,
3608 { .ival = "extreme",
3609 .oval = RWH_WRITE_LIFE_EXTREME,
3615 .name = "create_serialize",
3616 .lname = "Create serialize",
3617 .type = FIO_OPT_BOOL,
3618 .off1 = offsetof(struct thread_options, create_serialize),
3619 .help = "Serialize creation of job files",
3621 .category = FIO_OPT_C_FILE,
3622 .group = FIO_OPT_G_INVALID,
3625 .name = "create_fsync",
3626 .lname = "Create fsync",
3627 .type = FIO_OPT_BOOL,
3628 .off1 = offsetof(struct thread_options, create_fsync),
3629 .help = "fsync file after creation",
3631 .category = FIO_OPT_C_FILE,
3632 .group = FIO_OPT_G_INVALID,
3635 .name = "create_on_open",
3636 .lname = "Create on open",
3637 .type = FIO_OPT_BOOL,
3638 .off1 = offsetof(struct thread_options, create_on_open),
3639 .help = "Create files when they are opened for IO",
3641 .category = FIO_OPT_C_FILE,
3642 .group = FIO_OPT_G_INVALID,
3645 .name = "create_only",
3646 .lname = "Create Only",
3647 .type = FIO_OPT_BOOL,
3648 .off1 = offsetof(struct thread_options, create_only),
3649 .help = "Only perform file creation phase",
3650 .category = FIO_OPT_C_FILE,
3654 .name = "allow_file_create",
3655 .lname = "Allow file create",
3656 .type = FIO_OPT_BOOL,
3657 .off1 = offsetof(struct thread_options, allow_create),
3658 .help = "Permit fio to create files, if they don't exist",
3660 .category = FIO_OPT_C_FILE,
3661 .group = FIO_OPT_G_FILENAME,
3664 .name = "allow_mounted_write",
3665 .lname = "Allow mounted write",
3666 .type = FIO_OPT_BOOL,
3667 .off1 = offsetof(struct thread_options, allow_mounted_write),
3668 .help = "Allow writes to a mounted partition",
3670 .category = FIO_OPT_C_FILE,
3671 .group = FIO_OPT_G_FILENAME,
3675 .lname = "Pre-read files",
3676 .type = FIO_OPT_BOOL,
3677 .off1 = offsetof(struct thread_options, pre_read),
3678 .help = "Pre-read files before starting official testing",
3680 .category = FIO_OPT_C_FILE,
3681 .group = FIO_OPT_G_INVALID,
3683 #ifdef FIO_HAVE_CPU_AFFINITY
3686 .lname = "CPU mask",
3687 .type = FIO_OPT_INT,
3688 .cb = str_cpumask_cb,
3689 .off1 = offsetof(struct thread_options, cpumask),
3690 .help = "CPU affinity mask",
3691 .category = FIO_OPT_C_GENERAL,
3692 .group = FIO_OPT_G_CRED,
3695 .name = "cpus_allowed",
3696 .lname = "CPUs allowed",
3697 .type = FIO_OPT_STR,
3698 .cb = str_cpus_allowed_cb,
3699 .off1 = offsetof(struct thread_options, cpumask),
3700 .help = "Set CPUs allowed",
3701 .category = FIO_OPT_C_GENERAL,
3702 .group = FIO_OPT_G_CRED,
3705 .name = "cpus_allowed_policy",
3706 .lname = "CPUs allowed distribution policy",
3707 .type = FIO_OPT_STR,
3708 .off1 = offsetof(struct thread_options, cpus_allowed_policy),
3709 .help = "Distribution policy for cpus_allowed",
3710 .parent = "cpus_allowed",
3714 .oval = FIO_CPUS_SHARED,
3715 .help = "Mask shared between threads",
3718 .oval = FIO_CPUS_SPLIT,
3719 .help = "Mask split between threads",
3722 .category = FIO_OPT_C_GENERAL,
3723 .group = FIO_OPT_G_CRED,
3728 .lname = "CPU mask",
3729 .type = FIO_OPT_UNSUPPORTED,
3730 .help = "Your platform does not support CPU affinities",
3733 .name = "cpus_allowed",
3734 .lname = "CPUs allowed",
3735 .type = FIO_OPT_UNSUPPORTED,
3736 .help = "Your platform does not support CPU affinities",
3739 .name = "cpus_allowed_policy",
3740 .lname = "CPUs allowed distribution policy",
3741 .type = FIO_OPT_UNSUPPORTED,
3742 .help = "Your platform does not support CPU affinities",
3745 #ifdef CONFIG_LIBNUMA
3747 .name = "numa_cpu_nodes",
3748 .lname = "NUMA CPU Nodes",
3749 .type = FIO_OPT_STR,
3750 .cb = str_numa_cpunodes_cb,
3751 .off1 = offsetof(struct thread_options, numa_cpunodes),
3752 .help = "NUMA CPU nodes bind",
3753 .category = FIO_OPT_C_GENERAL,
3754 .group = FIO_OPT_G_INVALID,
3757 .name = "numa_mem_policy",
3758 .lname = "NUMA Memory Policy",
3759 .type = FIO_OPT_STR,
3760 .cb = str_numa_mpol_cb,
3761 .off1 = offsetof(struct thread_options, numa_memnodes),
3762 .help = "NUMA memory policy setup",
3763 .category = FIO_OPT_C_GENERAL,
3764 .group = FIO_OPT_G_INVALID,
3768 .name = "numa_cpu_nodes",
3769 .lname = "NUMA CPU Nodes",
3770 .type = FIO_OPT_UNSUPPORTED,
3771 .help = "Build fio with libnuma-dev(el) to enable this option",
3774 .name = "numa_mem_policy",
3775 .lname = "NUMA Memory Policy",
3776 .type = FIO_OPT_UNSUPPORTED,
3777 .help = "Build fio with libnuma-dev(el) to enable this option",
3782 .name = "gpu_dev_id",
3783 .lname = "GPU device ID",
3784 .type = FIO_OPT_INT,
3785 .off1 = offsetof(struct thread_options, gpu_dev_id),
3786 .help = "Set GPU device ID for GPUDirect RDMA",
3788 .category = FIO_OPT_C_GENERAL,
3789 .group = FIO_OPT_G_INVALID,
3793 .name = "end_fsync",
3794 .lname = "End fsync",
3795 .type = FIO_OPT_BOOL,
3796 .off1 = offsetof(struct thread_options, end_fsync),
3797 .help = "Include fsync at the end of job",
3799 .category = FIO_OPT_C_FILE,
3800 .group = FIO_OPT_G_INVALID,
3803 .name = "fsync_on_close",
3804 .lname = "Fsync on close",
3805 .type = FIO_OPT_BOOL,
3806 .off1 = offsetof(struct thread_options, fsync_on_close),
3807 .help = "fsync files on close",
3809 .category = FIO_OPT_C_FILE,
3810 .group = FIO_OPT_G_INVALID,
3814 .lname = "Unlink file",
3815 .type = FIO_OPT_BOOL,
3816 .off1 = offsetof(struct thread_options, unlink),
3817 .help = "Unlink created files after job has completed",
3819 .category = FIO_OPT_C_FILE,
3820 .group = FIO_OPT_G_INVALID,
3823 .name = "unlink_each_loop",
3824 .lname = "Unlink file after each loop of a job",
3825 .type = FIO_OPT_BOOL,
3826 .off1 = offsetof(struct thread_options, unlink_each_loop),
3827 .help = "Unlink created files after each loop in a job has completed",
3829 .category = FIO_OPT_C_FILE,
3830 .group = FIO_OPT_G_INVALID,
3834 .lname = "Exit-all on terminate",
3835 .type = FIO_OPT_STR_SET,
3836 .cb = str_exitall_cb,
3837 .help = "Terminate all jobs when one exits",
3838 .category = FIO_OPT_C_GENERAL,
3839 .group = FIO_OPT_G_PROCESS,
3842 .name = "exitall_on_error",
3843 .lname = "Exit-all on terminate in error",
3844 .type = FIO_OPT_STR_SET,
3845 .off1 = offsetof(struct thread_options, exitall_error),
3846 .help = "Terminate all jobs when one exits in error",
3847 .category = FIO_OPT_C_GENERAL,
3848 .group = FIO_OPT_G_PROCESS,
3851 .name = "stonewall",
3852 .lname = "Wait for previous",
3853 .alias = "wait_for_previous",
3854 .type = FIO_OPT_STR_SET,
3855 .off1 = offsetof(struct thread_options, stonewall),
3856 .help = "Insert a hard barrier between this job and previous",
3857 .category = FIO_OPT_C_GENERAL,
3858 .group = FIO_OPT_G_PROCESS,
3861 .name = "new_group",
3862 .lname = "New group",
3863 .type = FIO_OPT_STR_SET,
3864 .off1 = offsetof(struct thread_options, new_group),
3865 .help = "Mark the start of a new group (for reporting)",
3866 .category = FIO_OPT_C_GENERAL,
3867 .group = FIO_OPT_G_PROCESS,
3872 .type = FIO_OPT_STR_SET,
3873 .off1 = offsetof(struct thread_options, use_thread),
3874 .help = "Use threads instead of processes",
3875 #ifdef CONFIG_NO_SHM
3879 .category = FIO_OPT_C_GENERAL,
3880 .group = FIO_OPT_G_PROCESS,
3883 .name = "per_job_logs",
3884 .lname = "Per Job Logs",
3885 .type = FIO_OPT_BOOL,
3886 .off1 = offsetof(struct thread_options, per_job_logs),
3887 .help = "Include job number in generated log files or not",
3889 .category = FIO_OPT_C_LOG,
3890 .group = FIO_OPT_G_INVALID,
3893 .name = "write_bw_log",
3894 .lname = "Write bandwidth log",
3895 .type = FIO_OPT_STR,
3896 .off1 = offsetof(struct thread_options, bw_log_file),
3897 .cb = str_write_bw_log_cb,
3898 .help = "Write log of bandwidth during run",
3899 .category = FIO_OPT_C_LOG,
3900 .group = FIO_OPT_G_INVALID,
3903 .name = "write_lat_log",
3904 .lname = "Write latency log",
3905 .type = FIO_OPT_STR,
3906 .off1 = offsetof(struct thread_options, lat_log_file),
3907 .cb = str_write_lat_log_cb,
3908 .help = "Write log of latency during run",
3909 .category = FIO_OPT_C_LOG,
3910 .group = FIO_OPT_G_INVALID,
3913 .name = "write_iops_log",
3914 .lname = "Write IOPS log",
3915 .type = FIO_OPT_STR,
3916 .off1 = offsetof(struct thread_options, iops_log_file),
3917 .cb = str_write_iops_log_cb,
3918 .help = "Write log of IOPS during run",
3919 .category = FIO_OPT_C_LOG,
3920 .group = FIO_OPT_G_INVALID,
3923 .name = "log_avg_msec",
3924 .lname = "Log averaging (msec)",
3925 .type = FIO_OPT_INT,
3926 .off1 = offsetof(struct thread_options, log_avg_msec),
3927 .help = "Average bw/iops/lat logs over this period of time",
3929 .category = FIO_OPT_C_LOG,
3930 .group = FIO_OPT_G_INVALID,
3933 .name = "log_hist_msec",
3934 .lname = "Log histograms (msec)",
3935 .type = FIO_OPT_INT,
3936 .off1 = offsetof(struct thread_options, log_hist_msec),
3937 .help = "Dump completion latency histograms at frequency of this time value",
3939 .category = FIO_OPT_C_LOG,
3940 .group = FIO_OPT_G_INVALID,
3943 .name = "log_hist_coarseness",
3944 .lname = "Histogram logs coarseness",
3945 .type = FIO_OPT_INT,
3946 .off1 = offsetof(struct thread_options, log_hist_coarseness),
3947 .help = "Integer in range [0,6]. Higher coarseness outputs"
3948 " fewer histogram bins per sample. The number of bins for"
3949 " these are [1216, 608, 304, 152, 76, 38, 19] respectively.",
3951 .category = FIO_OPT_C_LOG,
3952 .group = FIO_OPT_G_INVALID,
3955 .name = "write_hist_log",
3956 .lname = "Write latency histogram logs",
3957 .type = FIO_OPT_STR,
3958 .off1 = offsetof(struct thread_options, hist_log_file),
3959 .cb = str_write_hist_log_cb,
3960 .help = "Write log of latency histograms during run",
3961 .category = FIO_OPT_C_LOG,
3962 .group = FIO_OPT_G_INVALID,
3965 .name = "log_max_value",
3966 .lname = "Log maximum instead of average",
3967 .type = FIO_OPT_BOOL,
3968 .off1 = offsetof(struct thread_options, log_max),
3969 .help = "Log max sample in a window instead of average",
3971 .category = FIO_OPT_C_LOG,
3972 .group = FIO_OPT_G_INVALID,
3975 .name = "log_offset",
3976 .lname = "Log offset of IO",
3977 .type = FIO_OPT_BOOL,
3978 .off1 = offsetof(struct thread_options, log_offset),
3979 .help = "Include offset of IO for each log entry",
3981 .category = FIO_OPT_C_LOG,
3982 .group = FIO_OPT_G_INVALID,
3986 .name = "log_compression",
3987 .lname = "Log compression",
3988 .type = FIO_OPT_INT,
3989 .off1 = offsetof(struct thread_options, log_gz),
3990 .help = "Log in compressed chunks of this size",
3992 .maxval = 512 * 1024 * 1024ULL,
3993 .category = FIO_OPT_C_LOG,
3994 .group = FIO_OPT_G_INVALID,
3996 #ifdef FIO_HAVE_CPU_AFFINITY
3998 .name = "log_compression_cpus",
3999 .lname = "Log Compression CPUs",
4000 .type = FIO_OPT_STR,
4001 .cb = str_log_cpus_allowed_cb,
4002 .off1 = offsetof(struct thread_options, log_gz_cpumask),
4003 .parent = "log_compression",
4004 .help = "Limit log compression to these CPUs",
4005 .category = FIO_OPT_C_LOG,
4006 .group = FIO_OPT_G_INVALID,
4010 .name = "log_compression_cpus",
4011 .lname = "Log Compression CPUs",
4012 .type = FIO_OPT_UNSUPPORTED,
4013 .help = "Your platform does not support CPU affinities",
4017 .name = "log_store_compressed",
4018 .lname = "Log store compressed",
4019 .type = FIO_OPT_BOOL,
4020 .off1 = offsetof(struct thread_options, log_gz_store),
4021 .help = "Store logs in a compressed format",
4022 .category = FIO_OPT_C_LOG,
4023 .group = FIO_OPT_G_INVALID,
4027 .name = "log_compression",
4028 .lname = "Log compression",
4029 .type = FIO_OPT_UNSUPPORTED,
4030 .help = "Install libz-dev(el) to get compression support",
4033 .name = "log_store_compressed",
4034 .lname = "Log store compressed",
4035 .type = FIO_OPT_UNSUPPORTED,
4036 .help = "Install libz-dev(el) to get compression support",
4040 .name = "log_unix_epoch",
4041 .lname = "Log epoch unix",
4042 .type = FIO_OPT_BOOL,
4043 .off1 = offsetof(struct thread_options, log_unix_epoch),
4044 .help = "Use Unix time in log files",
4045 .category = FIO_OPT_C_LOG,
4046 .group = FIO_OPT_G_INVALID,
4049 .name = "block_error_percentiles",
4050 .lname = "Block error percentiles",
4051 .type = FIO_OPT_BOOL,
4052 .off1 = offsetof(struct thread_options, block_error_hist),
4053 .help = "Record trim block errors and make a histogram",
4055 .category = FIO_OPT_C_LOG,
4056 .group = FIO_OPT_G_INVALID,
4059 .name = "bwavgtime",
4060 .lname = "Bandwidth average time",
4061 .type = FIO_OPT_INT,
4062 .off1 = offsetof(struct thread_options, bw_avg_time),
4063 .help = "Time window over which to calculate bandwidth"
4066 .parent = "write_bw_log",
4069 .category = FIO_OPT_C_LOG,
4070 .group = FIO_OPT_G_INVALID,
4073 .name = "iopsavgtime",
4074 .lname = "IOPS average time",
4075 .type = FIO_OPT_INT,
4076 .off1 = offsetof(struct thread_options, iops_avg_time),
4077 .help = "Time window over which to calculate IOPS (msec)",
4079 .parent = "write_iops_log",
4082 .category = FIO_OPT_C_LOG,
4083 .group = FIO_OPT_G_INVALID,
4086 .name = "group_reporting",
4087 .lname = "Group reporting",
4088 .type = FIO_OPT_STR_SET,
4089 .off1 = offsetof(struct thread_options, group_reporting),
4090 .help = "Do reporting on a per-group basis",
4091 .category = FIO_OPT_C_STAT,
4092 .group = FIO_OPT_G_INVALID,
4097 .type = FIO_OPT_BOOL,
4098 .off1 = offsetof(struct thread_options, stats),
4099 .help = "Enable collection of stats",
4101 .category = FIO_OPT_C_STAT,
4102 .group = FIO_OPT_G_INVALID,
4105 .name = "zero_buffers",
4106 .lname = "Zero I/O buffers",
4107 .type = FIO_OPT_STR_SET,
4108 .off1 = offsetof(struct thread_options, zero_buffers),
4109 .help = "Init IO buffers to all zeroes",
4110 .category = FIO_OPT_C_IO,
4111 .group = FIO_OPT_G_IO_BUF,
4114 .name = "refill_buffers",
4115 .lname = "Refill I/O buffers",
4116 .type = FIO_OPT_STR_SET,
4117 .off1 = offsetof(struct thread_options, refill_buffers),
4118 .help = "Refill IO buffers on every IO submit",
4119 .category = FIO_OPT_C_IO,
4120 .group = FIO_OPT_G_IO_BUF,
4123 .name = "scramble_buffers",
4124 .lname = "Scramble I/O buffers",
4125 .type = FIO_OPT_BOOL,
4126 .off1 = offsetof(struct thread_options, scramble_buffers),
4127 .help = "Slightly scramble buffers on every IO submit",
4129 .category = FIO_OPT_C_IO,
4130 .group = FIO_OPT_G_IO_BUF,
4133 .name = "buffer_pattern",
4134 .lname = "Buffer pattern",
4135 .type = FIO_OPT_STR,
4136 .cb = str_buffer_pattern_cb,
4137 .off1 = offsetof(struct thread_options, buffer_pattern),
4138 .help = "Fill pattern for IO buffers",
4139 .category = FIO_OPT_C_IO,
4140 .group = FIO_OPT_G_IO_BUF,
4143 .name = "buffer_compress_percentage",
4144 .lname = "Buffer compression percentage",
4145 .type = FIO_OPT_INT,
4146 .cb = str_buffer_compress_cb,
4147 .off1 = offsetof(struct thread_options, compress_percentage),
4150 .help = "How compressible the buffer is (approximately)",
4152 .category = FIO_OPT_C_IO,
4153 .group = FIO_OPT_G_IO_BUF,
4156 .name = "buffer_compress_chunk",
4157 .lname = "Buffer compression chunk size",
4158 .type = FIO_OPT_INT,
4159 .off1 = offsetof(struct thread_options, compress_chunk),
4160 .parent = "buffer_compress_percentage",
4162 .help = "Size of compressible region in buffer",
4165 .category = FIO_OPT_C_IO,
4166 .group = FIO_OPT_G_IO_BUF,
4169 .name = "dedupe_percentage",
4170 .lname = "Dedupe percentage",
4171 .type = FIO_OPT_INT,
4172 .cb = str_dedupe_cb,
4173 .off1 = offsetof(struct thread_options, dedupe_percentage),
4176 .help = "Percentage of buffers that are dedupable",
4178 .category = FIO_OPT_C_IO,
4179 .group = FIO_OPT_G_IO_BUF,
4182 .name = "clat_percentiles",
4183 .lname = "Completion latency percentiles",
4184 .type = FIO_OPT_BOOL,
4185 .off1 = offsetof(struct thread_options, clat_percentiles),
4186 .help = "Enable the reporting of completion latency percentiles",
4188 .inverse = "lat_percentiles",
4189 .category = FIO_OPT_C_STAT,
4190 .group = FIO_OPT_G_INVALID,
4193 .name = "lat_percentiles",
4194 .lname = "IO latency percentiles",
4195 .type = FIO_OPT_BOOL,
4196 .off1 = offsetof(struct thread_options, lat_percentiles),
4197 .help = "Enable the reporting of IO latency percentiles",
4199 .inverse = "clat_percentiles",
4200 .category = FIO_OPT_C_STAT,
4201 .group = FIO_OPT_G_INVALID,
4204 .name = "percentile_list",
4205 .lname = "Percentile list",
4206 .type = FIO_OPT_FLOAT_LIST,
4207 .off1 = offsetof(struct thread_options, percentile_list),
4208 .off2 = offsetof(struct thread_options, percentile_precision),
4209 .help = "Specify a custom list of percentiles to report for "
4210 "completion latency and block errors",
4211 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
4212 .maxlen = FIO_IO_U_LIST_MAX_LEN,
4215 .category = FIO_OPT_C_STAT,
4216 .group = FIO_OPT_G_INVALID,
4219 .name = "significant_figures",
4220 .lname = "Significant figures",
4221 .type = FIO_OPT_INT,
4222 .off1 = offsetof(struct thread_options, sig_figs),
4225 .help = "Significant figures for output-format set to normal",
4228 .category = FIO_OPT_C_STAT,
4229 .group = FIO_OPT_G_INVALID,
4232 #ifdef FIO_HAVE_DISK_UTIL
4234 .name = "disk_util",
4235 .lname = "Disk utilization",
4236 .type = FIO_OPT_BOOL,
4237 .off1 = offsetof(struct thread_options, do_disk_util),
4238 .help = "Log disk utilization statistics",
4240 .category = FIO_OPT_C_STAT,
4241 .group = FIO_OPT_G_INVALID,
4245 .name = "disk_util",
4246 .lname = "Disk utilization",
4247 .type = FIO_OPT_UNSUPPORTED,
4248 .help = "Your platform does not support disk utilization",
4252 .name = "gtod_reduce",
4253 .lname = "Reduce gettimeofday() calls",
4254 .type = FIO_OPT_BOOL,
4255 .help = "Greatly reduce number of gettimeofday() calls",
4256 .cb = str_gtod_reduce_cb,
4259 .category = FIO_OPT_C_STAT,
4260 .group = FIO_OPT_G_INVALID,
4263 .name = "disable_lat",
4264 .lname = "Disable all latency stats",
4265 .type = FIO_OPT_BOOL,
4266 .off1 = offsetof(struct thread_options, disable_lat),
4267 .help = "Disable latency numbers",
4268 .parent = "gtod_reduce",
4271 .category = FIO_OPT_C_STAT,
4272 .group = FIO_OPT_G_INVALID,
4275 .name = "disable_clat",
4276 .lname = "Disable completion latency stats",
4277 .type = FIO_OPT_BOOL,
4278 .off1 = offsetof(struct thread_options, disable_clat),
4279 .help = "Disable completion latency numbers",
4280 .parent = "gtod_reduce",
4283 .category = FIO_OPT_C_STAT,
4284 .group = FIO_OPT_G_INVALID,
4287 .name = "disable_slat",
4288 .lname = "Disable submission latency stats",
4289 .type = FIO_OPT_BOOL,
4290 .off1 = offsetof(struct thread_options, disable_slat),
4291 .help = "Disable submission latency numbers",
4292 .parent = "gtod_reduce",
4295 .category = FIO_OPT_C_STAT,
4296 .group = FIO_OPT_G_INVALID,
4299 .name = "disable_bw_measurement",
4300 .alias = "disable_bw",
4301 .lname = "Disable bandwidth stats",
4302 .type = FIO_OPT_BOOL,
4303 .off1 = offsetof(struct thread_options, disable_bw),
4304 .help = "Disable bandwidth logging",
4305 .parent = "gtod_reduce",
4308 .category = FIO_OPT_C_STAT,
4309 .group = FIO_OPT_G_INVALID,
4313 .lname = "Dedicated gettimeofday() CPU",
4314 .type = FIO_OPT_INT,
4315 .off1 = offsetof(struct thread_options, gtod_cpu),
4316 .help = "Set up dedicated gettimeofday() thread on this CPU",
4317 .verify = gtod_cpu_verify,
4318 .category = FIO_OPT_C_GENERAL,
4319 .group = FIO_OPT_G_CLOCK,
4322 .name = "unified_rw_reporting",
4323 .lname = "Unified RW Reporting",
4324 .type = FIO_OPT_BOOL,
4325 .off1 = offsetof(struct thread_options, unified_rw_rep),
4326 .help = "Unify reporting across data direction",
4328 .category = FIO_OPT_C_GENERAL,
4329 .group = FIO_OPT_G_INVALID,
4332 .name = "continue_on_error",
4333 .lname = "Continue on error",
4334 .type = FIO_OPT_STR,
4335 .off1 = offsetof(struct thread_options, continue_on_error),
4336 .help = "Continue on non-fatal errors during IO",
4338 .category = FIO_OPT_C_GENERAL,
4339 .group = FIO_OPT_G_ERR,
4342 .oval = ERROR_TYPE_NONE,
4343 .help = "Exit when an error is encountered",
4346 .oval = ERROR_TYPE_READ,
4347 .help = "Continue on read errors only",
4350 .oval = ERROR_TYPE_WRITE,
4351 .help = "Continue on write errors only",
4354 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
4355 .help = "Continue on any IO errors",
4358 .oval = ERROR_TYPE_VERIFY,
4359 .help = "Continue on verify errors only",
4362 .oval = ERROR_TYPE_ANY,
4363 .help = "Continue on all io and verify errors",
4366 .oval = ERROR_TYPE_NONE,
4367 .help = "Alias for 'none'",
4370 .oval = ERROR_TYPE_ANY,
4371 .help = "Alias for 'all'",
4376 .name = "ignore_error",
4377 .lname = "Ignore Error",
4378 .type = FIO_OPT_STR,
4379 .cb = str_ignore_error_cb,
4380 .off1 = offsetof(struct thread_options, ignore_error_nr),
4381 .help = "Set a specific list of errors to ignore",
4383 .category = FIO_OPT_C_GENERAL,
4384 .group = FIO_OPT_G_ERR,
4387 .name = "error_dump",
4388 .lname = "Error Dump",
4389 .type = FIO_OPT_BOOL,
4390 .off1 = offsetof(struct thread_options, error_dump),
4392 .help = "Dump info on each error",
4393 .category = FIO_OPT_C_GENERAL,
4394 .group = FIO_OPT_G_ERR,
4399 .type = FIO_OPT_STR_STORE,
4400 .off1 = offsetof(struct thread_options, profile),
4401 .help = "Select a specific builtin performance test",
4402 .category = FIO_OPT_C_PROFILE,
4403 .group = FIO_OPT_G_INVALID,
4408 .type = FIO_OPT_STR_STORE,
4409 .off1 = offsetof(struct thread_options, cgroup),
4410 .help = "Add job to cgroup of this name",
4411 .category = FIO_OPT_C_GENERAL,
4412 .group = FIO_OPT_G_CGROUP,
4415 .name = "cgroup_nodelete",
4416 .lname = "Cgroup no-delete",
4417 .type = FIO_OPT_BOOL,
4418 .off1 = offsetof(struct thread_options, cgroup_nodelete),
4419 .help = "Do not delete cgroups after job completion",
4422 .category = FIO_OPT_C_GENERAL,
4423 .group = FIO_OPT_G_CGROUP,
4426 .name = "cgroup_weight",
4427 .lname = "Cgroup weight",
4428 .type = FIO_OPT_INT,
4429 .off1 = offsetof(struct thread_options, cgroup_weight),
4430 .help = "Use given weight for cgroup",
4434 .category = FIO_OPT_C_GENERAL,
4435 .group = FIO_OPT_G_CGROUP,
4440 .type = FIO_OPT_INT,
4441 .off1 = offsetof(struct thread_options, uid),
4442 .help = "Run job with this user ID",
4443 .category = FIO_OPT_C_GENERAL,
4444 .group = FIO_OPT_G_CRED,
4448 .lname = "Group ID",
4449 .type = FIO_OPT_INT,
4450 .off1 = offsetof(struct thread_options, gid),
4451 .help = "Run job with this group ID",
4452 .category = FIO_OPT_C_GENERAL,
4453 .group = FIO_OPT_G_CRED,
4458 .type = FIO_OPT_INT,
4459 .off1 = offsetof(struct thread_options, kb_base),
4465 .help = "Inputs invert IEC and SI prefixes (for compatibility); outputs prefer binary",
4469 .help = "Inputs use IEC and SI prefixes; outputs prefer SI",
4472 .help = "Unit prefix interpretation for quantities of data (IEC and SI)",
4473 .category = FIO_OPT_C_GENERAL,
4474 .group = FIO_OPT_G_INVALID,
4477 .name = "unit_base",
4478 .lname = "Unit for quantities of data (Bits or Bytes)",
4479 .type = FIO_OPT_INT,
4480 .off1 = offsetof(struct thread_options, unit_base),
4485 .help = "Auto-detect",
4488 .oval = N2S_BYTEPERSEC,
4489 .help = "Normal (byte based)",
4492 .oval = N2S_BITPERSEC,
4493 .help = "Bit based",
4496 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
4497 .category = FIO_OPT_C_GENERAL,
4498 .group = FIO_OPT_G_INVALID,
4501 .name = "hugepage-size",
4502 .lname = "Hugepage size",
4503 .type = FIO_OPT_INT,
4504 .off1 = offsetof(struct thread_options, hugepage_size),
4505 .help = "When using hugepages, specify size of each page",
4506 .def = __fio_stringify(FIO_HUGE_PAGE),
4507 .interval = 1024 * 1024,
4508 .category = FIO_OPT_C_GENERAL,
4509 .group = FIO_OPT_G_INVALID,
4513 .lname = "I/O flow ID",
4514 .type = FIO_OPT_INT,
4515 .off1 = offsetof(struct thread_options, flow_id),
4516 .help = "The flow index ID to use",
4518 .category = FIO_OPT_C_IO,
4519 .group = FIO_OPT_G_IO_FLOW,
4523 .lname = "I/O flow weight",
4524 .type = FIO_OPT_INT,
4525 .off1 = offsetof(struct thread_options, flow),
4526 .help = "Weight for flow control of this job",
4527 .parent = "flow_id",
4530 .category = FIO_OPT_C_IO,
4531 .group = FIO_OPT_G_IO_FLOW,
4534 .name = "flow_watermark",
4535 .lname = "I/O flow watermark",
4536 .type = FIO_OPT_INT,
4537 .off1 = offsetof(struct thread_options, flow_watermark),
4538 .help = "High watermark for flow control. This option"
4539 " should be set to the same value for all threads"
4540 " with non-zero flow.",
4541 .parent = "flow_id",
4544 .category = FIO_OPT_C_IO,
4545 .group = FIO_OPT_G_IO_FLOW,
4548 .name = "flow_sleep",
4549 .lname = "I/O flow sleep",
4550 .type = FIO_OPT_INT,
4551 .off1 = offsetof(struct thread_options, flow_sleep),
4552 .help = "How many microseconds to sleep after being held"
4553 " back by the flow control mechanism",
4554 .parent = "flow_id",
4557 .category = FIO_OPT_C_IO,
4558 .group = FIO_OPT_G_IO_FLOW,
4561 .name = "steadystate",
4562 .lname = "Steady state threshold",
4564 .type = FIO_OPT_STR,
4565 .off1 = offsetof(struct thread_options, ss_state),
4566 .cb = str_steadystate_cb,
4567 .help = "Define the criterion and limit to judge when a job has reached steady state",
4568 .def = "iops_slope:0.01%",
4571 .oval = FIO_SS_IOPS,
4572 .help = "maximum mean deviation of IOPS measurements",
4574 { .ival = "iops_slope",
4575 .oval = FIO_SS_IOPS_SLOPE,
4576 .help = "slope calculated from IOPS measurements",
4580 .help = "maximum mean deviation of bandwidth measurements",
4584 .oval = FIO_SS_BW_SLOPE,
4585 .help = "slope calculated from bandwidth measurements",
4588 .category = FIO_OPT_C_GENERAL,
4589 .group = FIO_OPT_G_RUNTIME,
4592 .name = "steadystate_duration",
4593 .lname = "Steady state duration",
4595 .parent = "steadystate",
4596 .type = FIO_OPT_STR_VAL_TIME,
4597 .off1 = offsetof(struct thread_options, ss_dur),
4598 .help = "Stop workload upon attaining steady state for specified duration",
4602 .category = FIO_OPT_C_GENERAL,
4603 .group = FIO_OPT_G_RUNTIME,
4606 .name = "steadystate_ramp_time",
4607 .lname = "Steady state ramp time",
4609 .parent = "steadystate",
4610 .type = FIO_OPT_STR_VAL_TIME,
4611 .off1 = offsetof(struct thread_options, ss_ramp_time),
4612 .help = "Delay before initiation of data collection for steady state job termination testing",
4616 .category = FIO_OPT_C_GENERAL,
4617 .group = FIO_OPT_G_RUNTIME,
4624 static void add_to_lopt(struct option *lopt, struct fio_option *o,
4625 const char *name, int val)
4627 lopt->name = (char *) name;
4629 if (o->type == FIO_OPT_STR_SET)
4630 lopt->has_arg = optional_argument;
4632 lopt->has_arg = required_argument;
4635 static void options_to_lopts(struct fio_option *opts,
4636 struct option *long_options,
4637 int i, int option_type)
4639 struct fio_option *o = &opts[0];
4641 add_to_lopt(&long_options[i], o, o->name, option_type);
4644 add_to_lopt(&long_options[i], o, o->alias, option_type);
4649 assert(i < FIO_NR_OPTIONS);
4653 void fio_options_set_ioengine_opts(struct option *long_options,
4654 struct thread_data *td)
4659 while (long_options[i].name) {
4660 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
4661 memset(&long_options[i], 0, sizeof(*long_options));
4668 * Just clear out the prior ioengine options.
4673 options_to_lopts(td->io_ops->options, long_options, i,
4674 FIO_GETOPT_IOENGINE);
4677 void fio_options_dup_and_init(struct option *long_options)
4681 options_init(fio_options);
4684 while (long_options[i].name)
4687 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
4690 struct fio_keyword {
4696 static struct fio_keyword fio_keywords[] = {
4698 .word = "$pagesize",
4699 .desc = "Page size in the system",
4702 .word = "$mb_memory",
4703 .desc = "Megabytes of memory online",
4707 .desc = "Number of CPUs online in the system",
4714 void fio_keywords_exit(void)
4716 struct fio_keyword *kw;
4718 kw = &fio_keywords[0];
4726 void fio_keywords_init(void)
4728 unsigned long long mb_memory;
4732 sprintf(buf, "%lu", (unsigned long) page_size);
4733 fio_keywords[0].replace = strdup(buf);
4735 mb_memory = os_phys_mem() / (1024 * 1024);
4736 sprintf(buf, "%llu", mb_memory);
4737 fio_keywords[1].replace = strdup(buf);
4740 sprintf(buf, "%lu", l);
4741 fio_keywords[2].replace = strdup(buf);
4746 static char *bc_calc(char *str)
4748 char buf[128], *tmp;
4753 * No math, just return string
4755 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
4756 !strchr(str, '/')) || strchr(str, '\''))
4760 * Split option from value, we only need to calculate the value
4762 tmp = strchr(str, '=');
4769 * Prevent buffer overflows; such a case isn't reasonable anyway
4771 if (strlen(str) >= 128 || strlen(tmp) > 100)
4774 sprintf(buf, "which %s > /dev/null", BC_APP);
4776 log_err("fio: bc is needed for performing math\n");
4780 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
4781 f = popen(buf, "r");
4785 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
4792 buf[(tmp - str) + ret - 1] = '\0';
4793 memcpy(buf, str, tmp - str);
4799 * Return a copy of the input string with substrings of the form ${VARNAME}
4800 * substituted with the value of the environment variable VARNAME. The
4801 * substitution always occurs, even if VARNAME is empty or the corresponding
4802 * environment variable undefined.
4804 char *fio_option_dup_subs(const char *opt)
4806 char out[OPT_LEN_MAX+1];
4807 char in[OPT_LEN_MAX+1];
4810 char *ch1, *ch2, *env;
4811 ssize_t nchr = OPT_LEN_MAX;
4814 if (strlen(opt) + 1 > OPT_LEN_MAX) {
4815 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
4819 in[OPT_LEN_MAX] = '\0';
4820 strncpy(in, opt, OPT_LEN_MAX);
4822 while (*inptr && nchr > 0) {
4823 if (inptr[0] == '$' && inptr[1] == '{') {
4824 ch2 = strchr(inptr, '}');
4825 if (ch2 && inptr+1 < ch2) {
4832 envlen = strlen(env);
4833 if (envlen <= nchr) {
4834 memcpy(outptr, env, envlen);
4844 *outptr++ = *inptr++;
4853 * Look for reserved variable names and replace them with real values
4855 static char *fio_keyword_replace(char *opt)
4861 for (i = 0; fio_keywords[i].word != NULL; i++) {
4862 struct fio_keyword *kw = &fio_keywords[i];
4864 while ((s = strstr(opt, kw->word)) != NULL) {
4865 char *new = malloc(strlen(opt) + 1);
4871 * Copy part of the string before the keyword and
4872 * sprintf() the replacement after it.
4874 memcpy(new, opt, olen);
4875 len = sprintf(new + olen, "%s", kw->replace);
4878 * If there's more in the original string, copy that
4881 opt += strlen(kw->word) + olen;
4883 memcpy(new + olen + len, opt, opt - o_org - 1);
4886 * replace opt and free the old opt
4896 * Check for potential math and invoke bc, if possible
4904 static char **dup_and_sub_options(char **opts, int num_opts)
4907 char **opts_copy = malloc(num_opts * sizeof(*opts));
4908 for (i = 0; i < num_opts; i++) {
4909 opts_copy[i] = fio_option_dup_subs(opts[i]);
4912 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
4917 static void show_closest_option(const char *opt)
4919 int best_option, best_distance;
4928 while (name[i] != '\0' && name[i] != '=')
4933 best_distance = INT_MAX;
4935 while (fio_options[i].name) {
4936 distance = string_distance(name, fio_options[i].name);
4937 if (distance < best_distance) {
4938 best_distance = distance;
4944 if (best_option != -1 && string_distance_ok(name, best_distance) &&
4945 fio_options[best_option].type != FIO_OPT_UNSUPPORTED)
4946 log_err("Did you mean %s?\n", fio_options[best_option].name);
4951 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
4953 int i, ret, unknown;
4956 sort_options(opts, fio_options, num_opts);
4957 opts_copy = dup_and_sub_options(opts, num_opts);
4959 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
4960 const struct fio_option *o;
4961 int newret = parse_option(opts_copy[i], opts[i], fio_options,
4962 &o, &td->o, &td->opt_list);
4965 fio_option_mark_set(&td->o, o);
4973 opts_copy[i] = NULL;
4980 ret |= ioengine_load(td);
4982 sort_options(opts_copy, td->io_ops->options, num_opts);
4985 for (i = 0; i < num_opts; i++) {
4986 const struct fio_option *o = NULL;
4993 newret = parse_option(opts_copy[i], opts[i],
4994 td->io_ops->options, &o,
4995 td->eo, &td->opt_list);
4999 log_err("Bad option <%s>\n", opts[i]);
5000 show_closest_option(opts[i]);
5003 opts_copy[i] = NULL;
5011 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
5015 ret = parse_cmd_option(opt, val, fio_options, &td->o, &td->opt_list);
5017 const struct fio_option *o;
5019 o = find_option_c(fio_options, opt);
5021 fio_option_mark_set(&td->o, o);
5027 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
5030 return parse_cmd_option(opt, val, td->io_ops->options, td->eo,
5034 void fio_fill_default_options(struct thread_data *td)
5036 td->o.magic = OPT_MAGIC;
5037 fill_default_options(&td->o, fio_options);
5040 int fio_show_option_help(const char *opt)
5042 return show_cmd_help(fio_options, opt);
5046 * dupe FIO_OPT_STR_STORE options
5048 void fio_options_mem_dupe(struct thread_data *td)
5050 options_mem_dupe(fio_options, &td->o);
5052 if (td->eo && td->io_ops) {
5053 void *oldeo = td->eo;
5055 td->eo = malloc(td->io_ops->option_struct_size);
5056 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
5057 options_mem_dupe(td->io_ops->options, td->eo);
5061 unsigned int fio_get_kb_base(void *data)
5063 struct thread_data *td = cb_data_to_td(data);
5064 struct thread_options *o = &td->o;
5065 unsigned int kb_base = 0;
5068 * This is a hack... For private options, *data is not holding
5069 * a pointer to the thread_options, but to private data. This means
5070 * we can't safely dereference it, but magic is first so mem wise
5071 * it is valid. But this also means that if the job first sets
5072 * kb_base and expects that to be honored by private options,
5073 * it will be disappointed. We will return the global default
5076 if (o && o->magic == OPT_MAGIC)
5077 kb_base = o->kb_base;
5084 int add_option(const struct fio_option *o)
5086 struct fio_option *__o;
5095 if (opt_index + 1 == FIO_MAX_OPTS) {
5096 log_err("fio: FIO_MAX_OPTS is too small\n");
5100 memcpy(&fio_options[opt_index], o, sizeof(*o));
5101 fio_options[opt_index + 1].name = NULL;
5105 void invalidate_profile_options(const char *prof_name)
5107 struct fio_option *o;
5111 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
5112 o->type = FIO_OPT_INVALID;
5113 o->prof_name = NULL;
5119 void add_opt_posval(const char *optname, const char *ival, const char *help)
5121 struct fio_option *o;
5124 o = find_option(fio_options, optname);
5128 for (i = 0; i < PARSE_MAX_VP; i++) {
5129 if (o->posval[i].ival)
5132 o->posval[i].ival = ival;
5133 o->posval[i].help = help;
5138 void del_opt_posval(const char *optname, const char *ival)
5140 struct fio_option *o;
5143 o = find_option(fio_options, optname);
5147 for (i = 0; i < PARSE_MAX_VP; i++) {
5148 if (!o->posval[i].ival)
5150 if (strcmp(o->posval[i].ival, ival))
5153 o->posval[i].ival = NULL;
5154 o->posval[i].help = NULL;
5158 void fio_options_free(struct thread_data *td)
5160 options_free(fio_options, &td->o);
5161 if (td->eo && td->io_ops && td->io_ops->options) {
5162 options_free(td->io_ops->options, td->eo);
5168 struct fio_option *fio_option_find(const char *name)
5170 return find_option(fio_options, name);
5173 static struct fio_option *find_next_opt(struct fio_option *from,
5176 struct fio_option *opt;
5179 from = &fio_options[0];
5185 if (off1 == from->off1) {
5190 } while (from->name);
5195 static int opt_is_set(struct thread_options *o, struct fio_option *opt)
5197 unsigned int opt_off, index, offset;
5199 opt_off = opt - &fio_options[0];
5200 index = opt_off / (8 * sizeof(uint64_t));
5201 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5202 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
5205 bool __fio_option_is_set(struct thread_options *o, unsigned int off1)
5207 struct fio_option *opt, *next;
5210 while ((opt = find_next_opt(next, off1)) != NULL) {
5211 if (opt_is_set(o, opt))
5220 void fio_option_mark_set(struct thread_options *o, const struct fio_option *opt)
5222 unsigned int opt_off, index, offset;
5224 opt_off = opt - &fio_options[0];
5225 index = opt_off / (8 * sizeof(uint64_t));
5226 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5227 o->set_options[index] |= (uint64_t)1 << offset;