11 #include <netinet/in.h>
17 #include "lib/pattern.h"
21 char client_sockaddr_str[INET6_ADDRSTRLEN] = { 0 };
23 #define cb_data_to_td(data) container_of(data, struct thread_data, o)
25 static struct pattern_fmt_desc fmt_desc[] = {
28 .len = FIELD_SIZE(struct io_u *, offset),
29 .paste = paste_blockoff
34 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
36 static char *get_opt_postfix(const char *str)
38 char *p = strstr(str, ":");
44 strip_blank_front(&p);
49 static int bs_cmp(const void *p1, const void *p2)
51 const struct bssplit *bsp1 = p1;
52 const struct bssplit *bsp2 = p2;
54 return (int) bsp1->perc - (int) bsp2->perc;
59 unsigned int val1[100];
60 unsigned int val2[100];
63 static int split_parse_ddir(struct thread_options *o, struct split *split,
64 enum fio_ddir ddir, char *str)
73 while ((fname = strsep(&str, ":")) != NULL) {
79 perc_str = strstr(fname, "/");
83 perc = atoi(perc_str);
91 if (str_to_decimal(fname, &val, 1, o, 0, 0)) {
92 log_err("fio: bssplit conversion failed\n");
97 split->val2[i] = perc;
107 static int bssplit_ddir(struct thread_options *o, enum fio_ddir ddir, char *str)
109 unsigned int i, perc, perc_missing;
110 unsigned int max_bs, min_bs;
113 memset(&split, 0, sizeof(split));
115 if (split_parse_ddir(o, &split, ddir, str))
122 o->bssplit[ddir] = malloc(split.nr * sizeof(struct bssplit));
123 o->bssplit_nr[ddir] = split.nr;
124 for (i = 0; i < split.nr; i++) {
125 if (split.val1[i] > max_bs)
126 max_bs = split.val1[i];
127 if (split.val1[i] < min_bs)
128 min_bs = split.val1[i];
130 o->bssplit[ddir][i].bs = split.val1[i];
131 o->bssplit[ddir][i].perc =split.val2[i];
135 * Now check if the percentages add up, and how much is missing
137 perc = perc_missing = 0;
138 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
139 struct bssplit *bsp = &o->bssplit[ddir][i];
141 if (bsp->perc == -1U)
147 if (perc > 100 && perc_missing > 1) {
148 log_err("fio: bssplit percentages add to more than 100%%\n");
149 free(o->bssplit[ddir]);
150 o->bssplit[ddir] = NULL;
155 * If values didn't have a percentage set, divide the remains between
159 if (perc_missing == 1 && o->bssplit_nr[ddir] == 1)
161 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
162 struct bssplit *bsp = &o->bssplit[ddir][i];
164 if (bsp->perc == -1U)
165 bsp->perc = (100 - perc) / perc_missing;
169 o->min_bs[ddir] = min_bs;
170 o->max_bs[ddir] = max_bs;
173 * now sort based on percentages, for ease of lookup
175 qsort(o->bssplit[ddir], o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
179 typedef int (split_parse_fn)(struct thread_options *, enum fio_ddir, char *);
181 static int str_split_parse(struct thread_data *td, char *str, split_parse_fn *fn)
186 odir = strchr(str, ',');
188 ddir = strchr(odir + 1, ',');
190 ret = fn(&td->o, DDIR_TRIM, ddir + 1);
196 op = strdup(odir + 1);
197 ret = fn(&td->o, DDIR_TRIM, op);
202 ret = fn(&td->o, DDIR_WRITE, odir + 1);
205 ret = fn(&td->o, DDIR_READ, str);
211 ret = fn(&td->o, DDIR_WRITE, op);
216 ret = fn(&td->o, DDIR_TRIM, op);
220 ret = fn(&td->o, DDIR_READ, str);
226 static int str_bssplit_cb(void *data, const char *input)
228 struct thread_data *td = cb_data_to_td(data);
232 p = str = strdup(input);
234 strip_blank_front(&str);
235 strip_blank_end(str);
237 ret = str_split_parse(td, str, bssplit_ddir);
239 if (parse_dryrun()) {
242 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
243 free(td->o.bssplit[i]);
244 td->o.bssplit[i] = NULL;
245 td->o.bssplit_nr[i] = 0;
253 static int str2error(char *str)
255 const char *err[] = { "EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
256 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
257 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
258 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
259 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
260 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
261 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
262 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE" };
263 int i = 0, num = sizeof(err) / sizeof(char *);
266 if (!strcmp(err[i], str))
273 static int ignore_error_type(struct thread_data *td, enum error_type_bit etype,
280 if (etype >= ERROR_TYPE_CNT) {
281 log_err("Illegal error type\n");
285 td->o.ignore_error_nr[etype] = 4;
286 error = calloc(4, sizeof(int));
289 while ((fname = strsep(&str, ":")) != NULL) {
295 * grow struct buffer, if needed
297 if (i == td->o.ignore_error_nr[etype]) {
298 td->o.ignore_error_nr[etype] <<= 1;
299 error = realloc(error, td->o.ignore_error_nr[etype]
302 if (fname[0] == 'E') {
303 error[i] = str2error(fname);
305 error[i] = atoi(fname);
307 error[i] = -error[i];
310 log_err("Unknown error %s, please use number value\n",
312 td->o.ignore_error_nr[etype] = 0;
319 td->o.continue_on_error |= 1 << etype;
320 td->o.ignore_error_nr[etype] = i;
321 td->o.ignore_error[etype] = error;
323 td->o.ignore_error_nr[etype] = 0;
331 static int str_ignore_error_cb(void *data, const char *input)
333 struct thread_data *td = cb_data_to_td(data);
336 enum error_type_bit type = 0;
341 p = str = strdup(input);
343 strip_blank_front(&str);
344 strip_blank_end(str);
350 ret = ignore_error_type(td, type, p);
360 static int str_rw_cb(void *data, const char *str)
362 struct thread_data *td = cb_data_to_td(data);
363 struct thread_options *o = &td->o;
372 nr = get_opt_postfix(str);
377 o->ddir_seq_nr = atoi(nr);
381 if (str_to_decimal(nr, &val, 1, o, 0, 0)) {
382 log_err("fio: rw postfix parsing failed\n");
387 o->ddir_seq_add = val;
394 static int str_mem_cb(void *data, const char *mem)
396 struct thread_data *td = cb_data_to_td(data);
398 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP ||
399 td->o.mem_type == MEM_MMAPSHARED)
400 td->o.mmapfile = get_opt_postfix(mem);
405 static int fio_clock_source_cb(void *data, const char *str)
407 struct thread_data *td = cb_data_to_td(data);
409 fio_clock_source = td->o.clocksource;
410 fio_clock_source_set = 1;
415 static int str_rwmix_read_cb(void *data, unsigned long long *val)
417 struct thread_data *td = cb_data_to_td(data);
419 td->o.rwmix[DDIR_READ] = *val;
420 td->o.rwmix[DDIR_WRITE] = 100 - *val;
424 static int str_rwmix_write_cb(void *data, unsigned long long *val)
426 struct thread_data *td = cb_data_to_td(data);
428 td->o.rwmix[DDIR_WRITE] = *val;
429 td->o.rwmix[DDIR_READ] = 100 - *val;
433 static int str_exitall_cb(void)
435 exitall_on_terminate = 1;
439 #ifdef FIO_HAVE_CPU_AFFINITY
440 int fio_cpus_split(os_cpu_mask_t *mask, unsigned int cpu_index)
442 unsigned int i, index, cpus_in_mask;
443 const long max_cpu = cpus_online();
445 cpus_in_mask = fio_cpu_count(mask);
446 cpu_index = cpu_index % cpus_in_mask;
449 for (i = 0; i < max_cpu; i++) {
450 if (!fio_cpu_isset(mask, i))
453 if (cpu_index != index)
454 fio_cpu_clear(mask, i);
459 return fio_cpu_count(mask);
462 static int str_cpumask_cb(void *data, unsigned long long *val)
464 struct thread_data *td = cb_data_to_td(data);
472 ret = fio_cpuset_init(&td->o.cpumask);
474 log_err("fio: cpuset_init failed\n");
475 td_verror(td, ret, "fio_cpuset_init");
479 max_cpu = cpus_online();
481 for (i = 0; i < sizeof(int) * 8; i++) {
482 if ((1 << i) & *val) {
484 log_err("fio: CPU %d too large (max=%ld)\n", i,
488 dprint(FD_PARSE, "set cpu allowed %d\n", i);
489 fio_cpu_set(&td->o.cpumask, i);
496 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
503 ret = fio_cpuset_init(mask);
505 log_err("fio: cpuset_init failed\n");
506 td_verror(td, ret, "fio_cpuset_init");
510 p = str = strdup(input);
512 strip_blank_front(&str);
513 strip_blank_end(str);
515 max_cpu = cpus_online();
517 while ((cpu = strsep(&str, ",")) != NULL) {
526 while ((cpu2 = strsep(&str2, "-")) != NULL) {
536 while (icpu <= icpu2) {
537 if (icpu >= FIO_MAX_CPUS) {
538 log_err("fio: your OS only supports up to"
539 " %d CPUs\n", (int) FIO_MAX_CPUS);
543 if (icpu >= max_cpu) {
544 log_err("fio: CPU %d too large (max=%ld)\n",
550 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
551 fio_cpu_set(mask, icpu);
562 static int str_cpus_allowed_cb(void *data, const char *input)
564 struct thread_data *td = cb_data_to_td(data);
569 return set_cpus_allowed(td, &td->o.cpumask, input);
572 static int str_verify_cpus_allowed_cb(void *data, const char *input)
574 struct thread_data *td = cb_data_to_td(data);
579 return set_cpus_allowed(td, &td->o.verify_cpumask, input);
583 static int str_log_cpus_allowed_cb(void *data, const char *input)
585 struct thread_data *td = cb_data_to_td(data);
590 return set_cpus_allowed(td, &td->o.log_gz_cpumask, input);
592 #endif /* CONFIG_ZLIB */
594 #endif /* FIO_HAVE_CPU_AFFINITY */
596 #ifdef CONFIG_LIBNUMA
597 static int str_numa_cpunodes_cb(void *data, char *input)
599 struct thread_data *td = cb_data_to_td(data);
600 struct bitmask *verify_bitmask;
605 /* numa_parse_nodestring() parses a character string list
606 * of nodes into a bit mask. The bit mask is allocated by
607 * numa_allocate_nodemask(), so it should be freed by
608 * numa_free_nodemask().
610 verify_bitmask = numa_parse_nodestring(input);
611 if (verify_bitmask == NULL) {
612 log_err("fio: numa_parse_nodestring failed\n");
613 td_verror(td, 1, "str_numa_cpunodes_cb");
616 numa_free_nodemask(verify_bitmask);
618 td->o.numa_cpunodes = strdup(input);
622 static int str_numa_mpol_cb(void *data, char *input)
624 struct thread_data *td = cb_data_to_td(data);
625 const char * const policy_types[] =
626 { "default", "prefer", "bind", "interleave", "local", NULL };
629 struct bitmask *verify_bitmask;
634 nodelist = strchr(input, ':');
636 /* NUL-terminate mode */
640 for (i = 0; i <= MPOL_LOCAL; i++) {
641 if (!strcmp(input, policy_types[i])) {
642 td->o.numa_mem_mode = i;
646 if (i > MPOL_LOCAL) {
647 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
651 switch (td->o.numa_mem_mode) {
654 * Insist on a nodelist of one node only
657 char *rest = nodelist;
658 while (isdigit(*rest))
661 log_err("fio: one node only for \'prefer\'\n");
665 log_err("fio: one node is needed for \'prefer\'\n");
669 case MPOL_INTERLEAVE:
671 * Default to online nodes with memory if no nodelist
674 nodelist = strdup("all");
679 * Don't allow a nodelist
682 log_err("fio: NO nodelist for \'local\'\n");
688 * Insist on a nodelist
691 log_err("fio: a nodelist is needed for \'bind\'\n");
698 /* numa_parse_nodestring() parses a character string list
699 * of nodes into a bit mask. The bit mask is allocated by
700 * numa_allocate_nodemask(), so it should be freed by
701 * numa_free_nodemask().
703 switch (td->o.numa_mem_mode) {
705 td->o.numa_mem_prefer_node = atoi(nodelist);
707 case MPOL_INTERLEAVE:
709 verify_bitmask = numa_parse_nodestring(nodelist);
710 if (verify_bitmask == NULL) {
711 log_err("fio: numa_parse_nodestring failed\n");
712 td_verror(td, 1, "str_numa_memnodes_cb");
715 td->o.numa_memnodes = strdup(nodelist);
716 numa_free_nodemask(verify_bitmask);
731 static int str_fst_cb(void *data, const char *str)
733 struct thread_data *td = cb_data_to_td(data);
738 td->file_service_nr = 1;
740 switch (td->o.file_service_type) {
741 case FIO_FSERVICE_RANDOM:
742 case FIO_FSERVICE_RR:
743 case FIO_FSERVICE_SEQ:
744 nr = get_opt_postfix(str);
746 td->file_service_nr = atoi(nr);
751 case FIO_FSERVICE_ZIPF:
754 case FIO_FSERVICE_PARETO:
755 val = FIO_DEF_PARETO;
757 case FIO_FSERVICE_GAUSS:
761 log_err("fio: bad file service type: %d\n", td->o.file_service_type);
768 nr = get_opt_postfix(str);
769 if (nr && !str_to_float(nr, &val, 0)) {
770 log_err("fio: file service type random postfix parsing failed\n");
777 switch (td->o.file_service_type) {
778 case FIO_FSERVICE_ZIPF:
780 log_err("fio: zipf theta must be different than 1.0\n");
785 td->zipf_theta = val;
787 case FIO_FSERVICE_PARETO:
788 if (val <= 0.00 || val >= 1.00) {
789 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
796 case FIO_FSERVICE_GAUSS:
797 if (val < 0.00 || val >= 100.00) {
798 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
810 #ifdef CONFIG_SYNC_FILE_RANGE
811 static int str_sfr_cb(void *data, const char *str)
813 struct thread_data *td = cb_data_to_td(data);
814 char *nr = get_opt_postfix(str);
816 td->sync_file_range_nr = 1;
818 td->sync_file_range_nr = atoi(nr);
826 static int zone_cmp(const void *p1, const void *p2)
828 const struct zone_split *zsp1 = p1;
829 const struct zone_split *zsp2 = p2;
831 return (int) zsp2->access_perc - (int) zsp1->access_perc;
834 static int zone_split_ddir(struct thread_options *o, enum fio_ddir ddir,
837 unsigned int i, perc, perc_missing, sperc, sperc_missing;
840 memset(&split, 0, sizeof(split));
842 if (split_parse_ddir(o, &split, ddir, str))
847 o->zone_split[ddir] = malloc(split.nr * sizeof(struct zone_split));
848 o->zone_split_nr[ddir] = split.nr;
849 for (i = 0; i < split.nr; i++) {
850 o->zone_split[ddir][i].access_perc = split.val1[i];
851 o->zone_split[ddir][i].size_perc = split.val2[i];
855 * Now check if the percentages add up, and how much is missing
857 perc = perc_missing = 0;
858 sperc = sperc_missing = 0;
859 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
860 struct zone_split *zsp = &o->zone_split[ddir][i];
862 if (zsp->access_perc == (uint8_t) -1U)
865 perc += zsp->access_perc;
867 if (zsp->size_perc == (uint8_t) -1U)
870 sperc += zsp->size_perc;
874 if (perc > 100 || sperc > 100) {
875 log_err("fio: zone_split percentages add to more than 100%%\n");
876 free(o->zone_split[ddir]);
877 o->zone_split[ddir] = NULL;
881 log_err("fio: access percentage don't add up to 100 for zoned "
882 "random distribution (got=%u)\n", perc);
883 free(o->zone_split[ddir]);
884 o->zone_split[ddir] = NULL;
889 * If values didn't have a percentage set, divide the remains between
893 if (perc_missing == 1 && o->zone_split_nr[ddir] == 1)
895 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
896 struct zone_split *zsp = &o->zone_split[ddir][i];
898 if (zsp->access_perc == (uint8_t) -1U)
899 zsp->access_perc = (100 - perc) / perc_missing;
903 if (sperc_missing == 1 && o->zone_split_nr[ddir] == 1)
905 for (i = 0; i < o->zone_split_nr[ddir]; i++) {
906 struct zone_split *zsp = &o->zone_split[ddir][i];
908 if (zsp->size_perc == (uint8_t) -1U)
909 zsp->size_perc = (100 - sperc) / sperc_missing;
914 * now sort based on percentages, for ease of lookup
916 qsort(o->zone_split[ddir], o->zone_split_nr[ddir], sizeof(struct zone_split), zone_cmp);
920 static void __td_zone_gen_index(struct thread_data *td, enum fio_ddir ddir)
922 unsigned int i, j, sprev, aprev;
924 td->zone_state_index[ddir] = malloc(sizeof(struct zone_split_index) * 100);
927 for (i = 0; i < td->o.zone_split_nr[ddir]; i++) {
928 struct zone_split *zsp = &td->o.zone_split[ddir][i];
930 for (j = aprev; j < aprev + zsp->access_perc; j++) {
931 struct zone_split_index *zsi = &td->zone_state_index[ddir][j];
933 zsi->size_perc = sprev + zsp->size_perc;
934 zsi->size_perc_prev = sprev;
937 aprev += zsp->access_perc;
938 sprev += zsp->size_perc;
943 * Generate state table for indexes, so we don't have to do it inline from
946 static void td_zone_gen_index(struct thread_data *td)
950 td->zone_state_index = malloc(DDIR_RWDIR_CNT *
951 sizeof(struct zone_split_index *));
953 for (i = 0; i < DDIR_RWDIR_CNT; i++)
954 __td_zone_gen_index(td, i);
957 static int parse_zoned_distribution(struct thread_data *td, const char *input)
962 p = str = strdup(input);
964 strip_blank_front(&str);
965 strip_blank_end(str);
967 /* We expect it to start like that, bail if not */
968 if (strncmp(str, "zoned:", 6)) {
969 log_err("fio: mismatch in zoned input <%s>\n", str);
973 str += strlen("zoned:");
975 ret = str_split_parse(td, str, zone_split_ddir);
979 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
982 dprint(FD_PARSE, "zone ddir %d (nr=%u): \n", i, td->o.zone_split_nr[i]);
984 for (j = 0; j < td->o.zone_split_nr[i]; j++) {
985 struct zone_split *zsp = &td->o.zone_split[i][j];
987 dprint(FD_PARSE, "\t%d: %u/%u\n", j, zsp->access_perc,
992 if (parse_dryrun()) {
995 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
996 free(td->o.zone_split[i]);
997 td->o.zone_split[i] = NULL;
998 td->o.zone_split_nr[i] = 0;
1005 td_zone_gen_index(td);
1007 for (i = 0; i < DDIR_RWDIR_CNT; i++)
1008 td->o.zone_split_nr[i] = 0;
1014 static int str_random_distribution_cb(void *data, const char *str)
1016 struct thread_data *td = cb_data_to_td(data);
1020 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
1022 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
1023 val = FIO_DEF_PARETO;
1024 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
1026 else if (td->o.random_distribution == FIO_RAND_DIST_ZONED)
1027 return parse_zoned_distribution(td, str);
1031 nr = get_opt_postfix(str);
1032 if (nr && !str_to_float(nr, &val, 0)) {
1033 log_err("fio: random postfix parsing failed\n");
1040 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
1042 log_err("fio: zipf theta must different than 1.0\n");
1047 td->o.zipf_theta.u.f = val;
1048 } else if (td->o.random_distribution == FIO_RAND_DIST_PARETO) {
1049 if (val <= 0.00 || val >= 1.00) {
1050 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
1055 td->o.pareto_h.u.f = val;
1057 if (val < 0.00 || val >= 100.0) {
1058 log_err("fio: normal deviation out of range (0 <= input < 100.0)\n");
1063 td->o.gauss_dev.u.f = val;
1069 static int str_steadystate_cb(void *data, const char *str)
1071 struct thread_data *td = cb_data_to_td(data);
1077 if (td->o.ss_state != FIO_SS_IOPS && td->o.ss_state != FIO_SS_IOPS_SLOPE &&
1078 td->o.ss_state != FIO_SS_BW && td->o.ss_state != FIO_SS_BW_SLOPE) {
1079 /* should be impossible to get here */
1080 log_err("fio: unknown steady state criterion\n");
1084 nr = get_opt_postfix(str);
1086 log_err("fio: steadystate threshold must be specified in addition to criterion\n");
1091 /* ENHANCEMENT Allow fio to understand size=10.2% and use here */
1092 pct = strstr(nr, "%");
1095 strip_blank_end(nr);
1096 if (!str_to_float(nr, &val, 0)) {
1097 log_err("fio: could not parse steadystate threshold percentage\n");
1102 dprint(FD_PARSE, "set steady state threshold to %f%%\n", val);
1107 td->o.ss_state |= __FIO_SS_PCT;
1108 td->o.ss_limit.u.f = val;
1109 } else if (td->o.ss_state & __FIO_SS_IOPS) {
1110 if (!str_to_float(nr, &val, 0)) {
1111 log_err("fio: steadystate IOPS threshold postfix parsing failed\n");
1116 dprint(FD_PARSE, "set steady state IOPS threshold to %f\n", val);
1121 td->o.ss_limit.u.f = val;
1122 } else { /* bandwidth criterion */
1123 if (str_to_decimal(nr, &ll, 1, td, 0, 0)) {
1124 log_err("fio: steadystate BW threshold postfix parsing failed\n");
1129 dprint(FD_PARSE, "set steady state BW threshold to %lld\n", ll);
1134 td->o.ss_limit.u.f = (double) ll;
1137 td->ss.state = td->o.ss_state;
1142 * Return next name in the string. Files are separated with ':'. If the ':'
1143 * is escaped with a '\', then that ':' is part of the filename and does not
1144 * indicate a new file.
1146 static char *get_next_name(char **ptr)
1151 if (!str || !strlen(str))
1157 * No colon, we are done
1159 p = strchr(str, ':');
1166 * We got a colon, but it's the first character. Skip and
1174 if (*(p - 1) != '\\') {
1180 memmove(p - 1, p, strlen(p) + 1);
1188 static int get_max_name_idx(char *input)
1190 unsigned int cur_idx;
1193 p = str = strdup(input);
1194 for (cur_idx = 0; ; cur_idx++)
1195 if (get_next_name(&str) == NULL)
1203 * Returns the directory at the index, indexes > entires will be
1204 * assigned via modulo division of the index
1206 int set_name_idx(char *target, size_t tlen, char *input, int index,
1207 bool unique_filename)
1209 unsigned int cur_idx;
1211 char *fname, *str, *p;
1213 p = str = strdup(input);
1215 index %= get_max_name_idx(input);
1216 for (cur_idx = 0; cur_idx <= index; cur_idx++)
1217 fname = get_next_name(&str);
1219 if (client_sockaddr_str[0] && unique_filename) {
1220 len = snprintf(target, tlen, "%s/%s.", fname,
1221 client_sockaddr_str);
1223 len = snprintf(target, tlen, "%s/", fname);
1225 target[tlen - 1] = '\0';
1231 static int str_filename_cb(void *data, const char *input)
1233 struct thread_data *td = cb_data_to_td(data);
1234 char *fname, *str, *p;
1236 p = str = strdup(input);
1238 strip_blank_front(&str);
1239 strip_blank_end(str);
1242 * Ignore what we may already have from nrfiles option.
1244 if (!td->files_index)
1247 while ((fname = get_next_name(&str)) != NULL) {
1250 add_file(td, fname, 0, 1);
1257 static int str_directory_cb(void *data, const char fio_unused *unused)
1259 struct thread_data *td = cb_data_to_td(data);
1261 char *dirname, *str, *p;
1267 p = str = strdup(td->o.directory);
1268 while ((dirname = get_next_name(&str)) != NULL) {
1269 if (lstat(dirname, &sb) < 0) {
1272 log_err("fio: %s is not a directory\n", dirname);
1273 td_verror(td, ret, "lstat");
1276 if (!S_ISDIR(sb.st_mode)) {
1277 log_err("fio: %s is not a directory\n", dirname);
1288 static int str_opendir_cb(void *data, const char fio_unused *str)
1290 struct thread_data *td = cb_data_to_td(data);
1295 if (!td->files_index)
1298 return add_dir_files(td, td->o.opendir);
1301 static int str_buffer_pattern_cb(void *data, const char *input)
1303 struct thread_data *td = cb_data_to_td(data);
1306 /* FIXME: for now buffer pattern does not support formats */
1307 ret = parse_and_fill_pattern(input, strlen(input), td->o.buffer_pattern,
1308 MAX_PATTERN_SIZE, NULL, 0, NULL, NULL);
1313 td->o.buffer_pattern_bytes = ret;
1316 * If this job is doing any reading or has compression set,
1317 * ensure that we refill buffers for writes or we could be
1318 * invalidating the pattern through reads.
1320 if (!td->o.compress_percentage && !td_read(td))
1321 td->o.refill_buffers = 0;
1323 td->o.refill_buffers = 1;
1325 td->o.scramble_buffers = 0;
1326 td->o.zero_buffers = 0;
1331 static int str_buffer_compress_cb(void *data, unsigned long long *il)
1333 struct thread_data *td = cb_data_to_td(data);
1335 td->flags |= TD_F_COMPRESS;
1336 td->o.compress_percentage = *il;
1340 static int str_dedupe_cb(void *data, unsigned long long *il)
1342 struct thread_data *td = cb_data_to_td(data);
1344 td->flags |= TD_F_COMPRESS;
1345 td->o.dedupe_percentage = *il;
1346 td->o.refill_buffers = 1;
1350 static int str_verify_pattern_cb(void *data, const char *input)
1352 struct thread_data *td = cb_data_to_td(data);
1355 td->o.verify_fmt_sz = ARRAY_SIZE(td->o.verify_fmt);
1356 ret = parse_and_fill_pattern(input, strlen(input), td->o.verify_pattern,
1357 MAX_PATTERN_SIZE, fmt_desc, sizeof(fmt_desc),
1358 td->o.verify_fmt, &td->o.verify_fmt_sz);
1363 td->o.verify_pattern_bytes = ret;
1365 * VERIFY_* could already be set
1367 if (!fio_option_is_set(&td->o, verify))
1368 td->o.verify = VERIFY_PATTERN;
1373 static int str_gtod_reduce_cb(void *data, int *il)
1375 struct thread_data *td = cb_data_to_td(data);
1378 td->o.disable_lat = !!val;
1379 td->o.disable_clat = !!val;
1380 td->o.disable_slat = !!val;
1381 td->o.disable_bw = !!val;
1382 td->o.clat_percentiles = !val;
1384 td->ts_cache_mask = 63;
1389 static int str_offset_cb(void *data, unsigned long long *__val)
1391 struct thread_data *td = cb_data_to_td(data);
1392 unsigned long long v = *__val;
1394 if (parse_is_percent(v)) {
1395 td->o.start_offset = 0;
1396 td->o.start_offset_percent = -1ULL - v;
1397 dprint(FD_PARSE, "SET start_offset_percent %d\n",
1398 td->o.start_offset_percent);
1400 td->o.start_offset = v;
1405 static int str_size_cb(void *data, unsigned long long *__val)
1407 struct thread_data *td = cb_data_to_td(data);
1408 unsigned long long v = *__val;
1410 if (parse_is_percent(v)) {
1412 td->o.size_percent = -1ULL - v;
1419 static int str_write_bw_log_cb(void *data, const char *str)
1421 struct thread_data *td = cb_data_to_td(data);
1424 td->o.bw_log_file = strdup(str);
1426 td->o.write_bw_log = 1;
1430 static int str_write_lat_log_cb(void *data, const char *str)
1432 struct thread_data *td = cb_data_to_td(data);
1435 td->o.lat_log_file = strdup(str);
1437 td->o.write_lat_log = 1;
1441 static int str_write_iops_log_cb(void *data, const char *str)
1443 struct thread_data *td = cb_data_to_td(data);
1446 td->o.iops_log_file = strdup(str);
1448 td->o.write_iops_log = 1;
1452 static int str_write_hist_log_cb(void *data, const char *str)
1454 struct thread_data *td = cb_data_to_td(data);
1457 td->o.hist_log_file = strdup(str);
1459 td->o.write_hist_log = 1;
1463 static int rw_verify(struct fio_option *o, void *data)
1465 struct thread_data *td = cb_data_to_td(data);
1467 if (read_only && td_write(td)) {
1468 log_err("fio: job <%s> has write bit set, but fio is in"
1469 " read-only mode\n", td->o.name);
1476 static int gtod_cpu_verify(struct fio_option *o, void *data)
1478 #ifndef FIO_HAVE_CPU_AFFINITY
1479 struct thread_data *td = cb_data_to_td(data);
1481 if (td->o.gtod_cpu) {
1482 log_err("fio: platform must support CPU affinity for"
1483 "gettimeofday() offloading\n");
1492 * Map of job/command line options
1494 struct fio_option fio_options[FIO_MAX_OPTS] = {
1496 .name = "description",
1497 .lname = "Description of job",
1498 .type = FIO_OPT_STR_STORE,
1499 .off1 = offsetof(struct thread_options, description),
1500 .help = "Text job description",
1501 .category = FIO_OPT_C_GENERAL,
1502 .group = FIO_OPT_G_DESC,
1506 .lname = "Job name",
1507 .type = FIO_OPT_STR_STORE,
1508 .off1 = offsetof(struct thread_options, name),
1509 .help = "Name of this job",
1510 .category = FIO_OPT_C_GENERAL,
1511 .group = FIO_OPT_G_DESC,
1515 .lname = "Waitee name",
1516 .type = FIO_OPT_STR_STORE,
1517 .off1 = offsetof(struct thread_options, wait_for),
1518 .help = "Name of the job this one wants to wait for before starting",
1519 .category = FIO_OPT_C_GENERAL,
1520 .group = FIO_OPT_G_DESC,
1524 .lname = "Filename(s)",
1525 .type = FIO_OPT_STR_STORE,
1526 .off1 = offsetof(struct thread_options, filename),
1527 .cb = str_filename_cb,
1528 .prio = -1, /* must come after "directory" */
1529 .help = "File(s) to use for the workload",
1530 .category = FIO_OPT_C_FILE,
1531 .group = FIO_OPT_G_FILENAME,
1534 .name = "directory",
1535 .lname = "Directory",
1536 .type = FIO_OPT_STR_STORE,
1537 .off1 = offsetof(struct thread_options, directory),
1538 .cb = str_directory_cb,
1539 .help = "Directory to store files in",
1540 .category = FIO_OPT_C_FILE,
1541 .group = FIO_OPT_G_FILENAME,
1544 .name = "filename_format",
1545 .lname = "Filename Format",
1546 .type = FIO_OPT_STR_STORE,
1547 .off1 = offsetof(struct thread_options, filename_format),
1548 .prio = -1, /* must come after "directory" */
1549 .help = "Override default $jobname.$jobnum.$filenum naming",
1550 .def = "$jobname.$jobnum.$filenum",
1551 .category = FIO_OPT_C_FILE,
1552 .group = FIO_OPT_G_FILENAME,
1555 .name = "unique_filename",
1556 .lname = "Unique Filename",
1557 .type = FIO_OPT_BOOL,
1558 .off1 = offsetof(struct thread_options, unique_filename),
1559 .help = "For network clients, prefix file with source IP",
1561 .category = FIO_OPT_C_FILE,
1562 .group = FIO_OPT_G_FILENAME,
1566 .lname = "Lockfile",
1567 .type = FIO_OPT_STR,
1568 .off1 = offsetof(struct thread_options, file_lock_mode),
1569 .help = "Lock file when doing IO to it",
1571 .parent = "filename",
1574 .category = FIO_OPT_C_FILE,
1575 .group = FIO_OPT_G_FILENAME,
1578 .oval = FILE_LOCK_NONE,
1579 .help = "No file locking",
1581 { .ival = "exclusive",
1582 .oval = FILE_LOCK_EXCLUSIVE,
1583 .help = "Exclusive file lock",
1586 .ival = "readwrite",
1587 .oval = FILE_LOCK_READWRITE,
1588 .help = "Read vs write lock",
1594 .lname = "Open directory",
1595 .type = FIO_OPT_STR_STORE,
1596 .off1 = offsetof(struct thread_options, opendir),
1597 .cb = str_opendir_cb,
1598 .help = "Recursively add files from this directory and down",
1599 .category = FIO_OPT_C_FILE,
1600 .group = FIO_OPT_G_FILENAME,
1604 .lname = "Read/write",
1605 .alias = "readwrite",
1606 .type = FIO_OPT_STR,
1608 .off1 = offsetof(struct thread_options, td_ddir),
1609 .help = "IO direction",
1611 .verify = rw_verify,
1612 .category = FIO_OPT_C_IO,
1613 .group = FIO_OPT_G_IO_BASIC,
1616 .oval = TD_DDIR_READ,
1617 .help = "Sequential read",
1620 .oval = TD_DDIR_WRITE,
1621 .help = "Sequential write",
1624 .oval = TD_DDIR_TRIM,
1625 .help = "Sequential trim",
1627 { .ival = "randread",
1628 .oval = TD_DDIR_RANDREAD,
1629 .help = "Random read",
1631 { .ival = "randwrite",
1632 .oval = TD_DDIR_RANDWRITE,
1633 .help = "Random write",
1635 { .ival = "randtrim",
1636 .oval = TD_DDIR_RANDTRIM,
1637 .help = "Random trim",
1641 .help = "Sequential read and write mix",
1643 { .ival = "readwrite",
1645 .help = "Sequential read and write mix",
1648 .oval = TD_DDIR_RANDRW,
1649 .help = "Random read and write mix"
1651 { .ival = "trimwrite",
1652 .oval = TD_DDIR_TRIMWRITE,
1653 .help = "Trim and write mix, trims preceding writes"
1658 .name = "rw_sequencer",
1659 .lname = "RW Sequencer",
1660 .type = FIO_OPT_STR,
1661 .off1 = offsetof(struct thread_options, rw_seq),
1662 .help = "IO offset generator modifier",
1663 .def = "sequential",
1664 .category = FIO_OPT_C_IO,
1665 .group = FIO_OPT_G_IO_BASIC,
1667 { .ival = "sequential",
1669 .help = "Generate sequential offsets",
1671 { .ival = "identical",
1672 .oval = RW_SEQ_IDENT,
1673 .help = "Generate identical offsets",
1680 .lname = "IO Engine",
1681 .type = FIO_OPT_STR_STORE,
1682 .off1 = offsetof(struct thread_options, ioengine),
1683 .help = "IO engine to use",
1684 .def = FIO_PREFERRED_ENGINE,
1685 .category = FIO_OPT_C_IO,
1686 .group = FIO_OPT_G_IO_BASIC,
1689 .help = "Use read/write",
1692 .help = "Use pread/pwrite",
1695 .help = "Use readv/writev",
1697 #ifdef CONFIG_PWRITEV
1699 .help = "Use preadv/pwritev",
1702 #ifdef FIO_HAVE_PWRITEV2
1703 { .ival = "pvsync2",
1704 .help = "Use preadv2/pwritev2",
1707 #ifdef CONFIG_LIBAIO
1709 .help = "Linux native asynchronous IO",
1712 #ifdef CONFIG_POSIXAIO
1713 { .ival = "posixaio",
1714 .help = "POSIX asynchronous IO",
1717 #ifdef CONFIG_SOLARISAIO
1718 { .ival = "solarisaio",
1719 .help = "Solaris native asynchronous IO",
1722 #ifdef CONFIG_WINDOWSAIO
1723 { .ival = "windowsaio",
1724 .help = "Windows native asynchronous IO"
1729 .help = "Rados Block Device asynchronous IO"
1733 .help = "Memory mapped IO"
1735 #ifdef CONFIG_LINUX_SPLICE
1737 .help = "splice/vmsplice based IO",
1739 { .ival = "netsplice",
1740 .help = "splice/vmsplice to/from the network",
1743 #ifdef FIO_HAVE_SGIO
1745 .help = "SCSI generic v3 IO",
1749 .help = "Testing engine (no data transfer)",
1752 .help = "Network IO",
1755 .help = "CPU cycle burner engine",
1759 .help = "GUASI IO engine",
1762 #ifdef FIO_HAVE_BINJECT
1763 { .ival = "binject",
1764 .help = "binject direct inject block engine",
1769 .help = "RDMA IO engine",
1772 #ifdef CONFIG_FUSION_AW
1773 { .ival = "fusion-aw-sync",
1774 .help = "Fusion-io atomic write engine",
1777 #ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1778 { .ival = "e4defrag",
1779 .help = "ext4 defrag engine",
1782 #ifdef CONFIG_LINUX_FALLOCATE
1784 .help = "fallocate() file based engine",
1789 .help = "Glusterfs libgfapi(sync) based engine"
1791 { .ival = "gfapi_async",
1792 .help = "Glusterfs libgfapi(async) based engine"
1795 #ifdef CONFIG_LIBHDFS
1796 { .ival = "libhdfs",
1797 .help = "Hadoop Distributed Filesystem (HDFS) engine"
1800 #ifdef CONFIG_PMEMBLK
1801 { .ival = "pmemblk",
1802 .help = "NVML libpmemblk based IO engine",
1806 #ifdef CONFIG_LINUX_DEVDAX
1807 { .ival = "dev-dax",
1808 .help = "DAX Device based IO engine",
1811 { .ival = "external",
1812 .help = "Load external engine (append name)",
1818 .lname = "IO Depth",
1819 .type = FIO_OPT_INT,
1820 .off1 = offsetof(struct thread_options, iodepth),
1821 .help = "Number of IO buffers to keep in flight",
1825 .category = FIO_OPT_C_IO,
1826 .group = FIO_OPT_G_IO_BASIC,
1829 .name = "iodepth_batch",
1830 .lname = "IO Depth batch",
1831 .alias = "iodepth_batch_submit",
1832 .type = FIO_OPT_INT,
1833 .off1 = offsetof(struct thread_options, iodepth_batch),
1834 .help = "Number of IO buffers to submit in one go",
1835 .parent = "iodepth",
1839 .category = FIO_OPT_C_IO,
1840 .group = FIO_OPT_G_IO_BASIC,
1843 .name = "iodepth_batch_complete_min",
1844 .lname = "Min IO depth batch complete",
1845 .alias = "iodepth_batch_complete",
1846 .type = FIO_OPT_INT,
1847 .off1 = offsetof(struct thread_options, iodepth_batch_complete_min),
1848 .help = "Min number of IO buffers to retrieve in one go",
1849 .parent = "iodepth",
1854 .category = FIO_OPT_C_IO,
1855 .group = FIO_OPT_G_IO_BASIC,
1858 .name = "iodepth_batch_complete_max",
1859 .lname = "Max IO depth batch complete",
1860 .type = FIO_OPT_INT,
1861 .off1 = offsetof(struct thread_options, iodepth_batch_complete_max),
1862 .help = "Max number of IO buffers to retrieve in one go",
1863 .parent = "iodepth",
1867 .category = FIO_OPT_C_IO,
1868 .group = FIO_OPT_G_IO_BASIC,
1871 .name = "iodepth_low",
1872 .lname = "IO Depth batch low",
1873 .type = FIO_OPT_INT,
1874 .off1 = offsetof(struct thread_options, iodepth_low),
1875 .help = "Low water mark for queuing depth",
1876 .parent = "iodepth",
1879 .category = FIO_OPT_C_IO,
1880 .group = FIO_OPT_G_IO_BASIC,
1883 .name = "io_submit_mode",
1884 .lname = "IO submit mode",
1885 .type = FIO_OPT_STR,
1886 .off1 = offsetof(struct thread_options, io_submit_mode),
1887 .help = "How IO submissions and completions are done",
1889 .category = FIO_OPT_C_IO,
1890 .group = FIO_OPT_G_IO_BASIC,
1893 .oval = IO_MODE_INLINE,
1894 .help = "Submit and complete IO inline",
1896 { .ival = "offload",
1897 .oval = IO_MODE_OFFLOAD,
1898 .help = "Offload submit and complete to threads",
1905 .type = FIO_OPT_STR_VAL,
1907 .off1 = offsetof(struct thread_options, size),
1908 .help = "Total size of device or files",
1909 .interval = 1024 * 1024,
1910 .category = FIO_OPT_C_IO,
1911 .group = FIO_OPT_G_INVALID,
1915 .alias = "io_limit",
1917 .type = FIO_OPT_STR_VAL,
1918 .off1 = offsetof(struct thread_options, io_size),
1919 .help = "Total size of I/O to be performed",
1920 .interval = 1024 * 1024,
1921 .category = FIO_OPT_C_IO,
1922 .group = FIO_OPT_G_INVALID,
1925 .name = "fill_device",
1926 .lname = "Fill device",
1928 .type = FIO_OPT_BOOL,
1929 .off1 = offsetof(struct thread_options, fill_device),
1930 .help = "Write until an ENOSPC error occurs",
1932 .category = FIO_OPT_C_FILE,
1933 .group = FIO_OPT_G_INVALID,
1937 .lname = "File size",
1938 .type = FIO_OPT_STR_VAL,
1939 .off1 = offsetof(struct thread_options, file_size_low),
1940 .off2 = offsetof(struct thread_options, file_size_high),
1942 .help = "Size of individual files",
1943 .interval = 1024 * 1024,
1944 .category = FIO_OPT_C_FILE,
1945 .group = FIO_OPT_G_INVALID,
1948 .name = "file_append",
1949 .lname = "File append",
1950 .type = FIO_OPT_BOOL,
1951 .off1 = offsetof(struct thread_options, file_append),
1952 .help = "IO will start at the end of the file(s)",
1954 .category = FIO_OPT_C_FILE,
1955 .group = FIO_OPT_G_INVALID,
1959 .lname = "IO offset",
1960 .alias = "fileoffset",
1961 .type = FIO_OPT_STR_VAL,
1962 .cb = str_offset_cb,
1963 .off1 = offsetof(struct thread_options, start_offset),
1964 .help = "Start IO from this offset",
1966 .interval = 1024 * 1024,
1967 .category = FIO_OPT_C_IO,
1968 .group = FIO_OPT_G_INVALID,
1971 .name = "offset_increment",
1972 .lname = "IO offset increment",
1973 .type = FIO_OPT_STR_VAL,
1974 .off1 = offsetof(struct thread_options, offset_increment),
1975 .help = "What is the increment from one offset to the next",
1979 .interval = 1024 * 1024,
1980 .category = FIO_OPT_C_IO,
1981 .group = FIO_OPT_G_INVALID,
1984 .name = "number_ios",
1985 .lname = "Number of IOs to perform",
1986 .type = FIO_OPT_STR_VAL,
1987 .off1 = offsetof(struct thread_options, number_ios),
1988 .help = "Force job completion after this number of IOs",
1990 .category = FIO_OPT_C_IO,
1991 .group = FIO_OPT_G_INVALID,
1995 .lname = "Block size",
1996 .alias = "blocksize",
1997 .type = FIO_OPT_INT,
1998 .off1 = offsetof(struct thread_options, bs[DDIR_READ]),
1999 .off2 = offsetof(struct thread_options, bs[DDIR_WRITE]),
2000 .off3 = offsetof(struct thread_options, bs[DDIR_TRIM]),
2002 .help = "Block size unit",
2007 .category = FIO_OPT_C_IO,
2008 .group = FIO_OPT_G_INVALID,
2012 .lname = "Block size align",
2013 .alias = "blockalign",
2014 .type = FIO_OPT_INT,
2015 .off1 = offsetof(struct thread_options, ba[DDIR_READ]),
2016 .off2 = offsetof(struct thread_options, ba[DDIR_WRITE]),
2017 .off3 = offsetof(struct thread_options, ba[DDIR_TRIM]),
2019 .help = "IO block offset alignment",
2023 .category = FIO_OPT_C_IO,
2024 .group = FIO_OPT_G_INVALID,
2028 .lname = "Block size range",
2029 .alias = "blocksize_range",
2030 .type = FIO_OPT_RANGE,
2031 .off1 = offsetof(struct thread_options, min_bs[DDIR_READ]),
2032 .off2 = offsetof(struct thread_options, max_bs[DDIR_READ]),
2033 .off3 = offsetof(struct thread_options, min_bs[DDIR_WRITE]),
2034 .off4 = offsetof(struct thread_options, max_bs[DDIR_WRITE]),
2035 .off5 = offsetof(struct thread_options, min_bs[DDIR_TRIM]),
2036 .off6 = offsetof(struct thread_options, max_bs[DDIR_TRIM]),
2038 .help = "Set block size range (in more detail than bs)",
2042 .category = FIO_OPT_C_IO,
2043 .group = FIO_OPT_G_INVALID,
2047 .lname = "Block size split",
2048 .type = FIO_OPT_STR,
2049 .cb = str_bssplit_cb,
2050 .off1 = offsetof(struct thread_options, bssplit),
2051 .help = "Set a specific mix of block sizes",
2054 .category = FIO_OPT_C_IO,
2055 .group = FIO_OPT_G_INVALID,
2058 .name = "bs_unaligned",
2059 .lname = "Block size unaligned",
2060 .alias = "blocksize_unaligned",
2061 .type = FIO_OPT_STR_SET,
2062 .off1 = offsetof(struct thread_options, bs_unaligned),
2063 .help = "Don't sector align IO buffer sizes",
2066 .category = FIO_OPT_C_IO,
2067 .group = FIO_OPT_G_INVALID,
2070 .name = "bs_is_seq_rand",
2071 .lname = "Block size division is seq/random (not read/write)",
2072 .type = FIO_OPT_BOOL,
2073 .off1 = offsetof(struct thread_options, bs_is_seq_rand),
2074 .help = "Consider any blocksize setting to be sequential,random",
2076 .parent = "blocksize",
2077 .category = FIO_OPT_C_IO,
2078 .group = FIO_OPT_G_INVALID,
2081 .name = "randrepeat",
2082 .lname = "Random repeatable",
2083 .type = FIO_OPT_BOOL,
2084 .off1 = offsetof(struct thread_options, rand_repeatable),
2085 .help = "Use repeatable random IO pattern",
2089 .category = FIO_OPT_C_IO,
2090 .group = FIO_OPT_G_RANDOM,
2094 .lname = "The random generator seed",
2095 .type = FIO_OPT_STR_VAL,
2096 .off1 = offsetof(struct thread_options, rand_seed),
2097 .help = "Set the random generator seed value",
2100 .category = FIO_OPT_C_IO,
2101 .group = FIO_OPT_G_RANDOM,
2104 .name = "use_os_rand",
2105 .lname = "Use OS random",
2106 .type = FIO_OPT_DEPRECATED,
2107 .off1 = offsetof(struct thread_options, dep_use_os_rand),
2108 .category = FIO_OPT_C_IO,
2109 .group = FIO_OPT_G_RANDOM,
2112 .name = "norandommap",
2113 .lname = "No randommap",
2114 .type = FIO_OPT_STR_SET,
2115 .off1 = offsetof(struct thread_options, norandommap),
2116 .help = "Accept potential duplicate random blocks",
2120 .category = FIO_OPT_C_IO,
2121 .group = FIO_OPT_G_RANDOM,
2124 .name = "softrandommap",
2125 .lname = "Soft randommap",
2126 .type = FIO_OPT_BOOL,
2127 .off1 = offsetof(struct thread_options, softrandommap),
2128 .help = "Set norandommap if randommap allocation fails",
2129 .parent = "norandommap",
2132 .category = FIO_OPT_C_IO,
2133 .group = FIO_OPT_G_RANDOM,
2136 .name = "random_generator",
2137 .lname = "Random Generator",
2138 .type = FIO_OPT_STR,
2139 .off1 = offsetof(struct thread_options, random_generator),
2140 .help = "Type of random number generator to use",
2141 .def = "tausworthe",
2143 { .ival = "tausworthe",
2144 .oval = FIO_RAND_GEN_TAUSWORTHE,
2145 .help = "Strong Tausworthe generator",
2148 .oval = FIO_RAND_GEN_LFSR,
2149 .help = "Variable length LFSR",
2152 .ival = "tausworthe64",
2153 .oval = FIO_RAND_GEN_TAUSWORTHE64,
2154 .help = "64-bit Tausworthe variant",
2157 .category = FIO_OPT_C_IO,
2158 .group = FIO_OPT_G_RANDOM,
2161 .name = "random_distribution",
2162 .lname = "Random Distribution",
2163 .type = FIO_OPT_STR,
2164 .off1 = offsetof(struct thread_options, random_distribution),
2165 .cb = str_random_distribution_cb,
2166 .help = "Random offset distribution generator",
2170 .oval = FIO_RAND_DIST_RANDOM,
2171 .help = "Completely random",
2174 .oval = FIO_RAND_DIST_ZIPF,
2175 .help = "Zipf distribution",
2178 .oval = FIO_RAND_DIST_PARETO,
2179 .help = "Pareto distribution",
2182 .oval = FIO_RAND_DIST_GAUSS,
2183 .help = "Normal (Gaussian) distribution",
2186 .oval = FIO_RAND_DIST_ZONED,
2187 .help = "Zoned random distribution",
2191 .category = FIO_OPT_C_IO,
2192 .group = FIO_OPT_G_RANDOM,
2195 .name = "percentage_random",
2196 .lname = "Percentage Random",
2197 .type = FIO_OPT_INT,
2198 .off1 = offsetof(struct thread_options, perc_rand[DDIR_READ]),
2199 .off2 = offsetof(struct thread_options, perc_rand[DDIR_WRITE]),
2200 .off3 = offsetof(struct thread_options, perc_rand[DDIR_TRIM]),
2202 .help = "Percentage of seq/random mix that should be random",
2203 .def = "100,100,100",
2205 .inverse = "percentage_sequential",
2206 .category = FIO_OPT_C_IO,
2207 .group = FIO_OPT_G_RANDOM,
2210 .name = "percentage_sequential",
2211 .lname = "Percentage Sequential",
2212 .type = FIO_OPT_DEPRECATED,
2213 .category = FIO_OPT_C_IO,
2214 .group = FIO_OPT_G_RANDOM,
2217 .name = "allrandrepeat",
2218 .lname = "All Random Repeat",
2219 .type = FIO_OPT_BOOL,
2220 .off1 = offsetof(struct thread_options, allrand_repeatable),
2221 .help = "Use repeatable random numbers for everything",
2223 .category = FIO_OPT_C_IO,
2224 .group = FIO_OPT_G_RANDOM,
2228 .lname = "Number of files",
2229 .alias = "nr_files",
2230 .type = FIO_OPT_INT,
2231 .off1 = offsetof(struct thread_options, nr_files),
2232 .help = "Split job workload between this number of files",
2235 .category = FIO_OPT_C_FILE,
2236 .group = FIO_OPT_G_INVALID,
2239 .name = "openfiles",
2240 .lname = "Number of open files",
2241 .type = FIO_OPT_INT,
2242 .off1 = offsetof(struct thread_options, open_files),
2243 .help = "Number of files to keep open at the same time",
2244 .category = FIO_OPT_C_FILE,
2245 .group = FIO_OPT_G_INVALID,
2248 .name = "file_service_type",
2249 .lname = "File service type",
2250 .type = FIO_OPT_STR,
2252 .off1 = offsetof(struct thread_options, file_service_type),
2253 .help = "How to select which file to service next",
2254 .def = "roundrobin",
2255 .category = FIO_OPT_C_FILE,
2256 .group = FIO_OPT_G_INVALID,
2259 .oval = FIO_FSERVICE_RANDOM,
2260 .help = "Choose a file at random (uniform)",
2263 .oval = FIO_FSERVICE_ZIPF,
2264 .help = "Zipf randomized",
2267 .oval = FIO_FSERVICE_PARETO,
2268 .help = "Pareto randomized",
2271 .oval = FIO_FSERVICE_GAUSS,
2272 .help = "Normal (Gaussian) distribution",
2274 { .ival = "roundrobin",
2275 .oval = FIO_FSERVICE_RR,
2276 .help = "Round robin select files",
2278 { .ival = "sequential",
2279 .oval = FIO_FSERVICE_SEQ,
2280 .help = "Finish one file before moving to the next",
2283 .parent = "nrfiles",
2286 #ifdef CONFIG_POSIX_FALLOCATE
2288 .name = "fallocate",
2289 .lname = "Fallocate",
2290 .type = FIO_OPT_STR,
2291 .off1 = offsetof(struct thread_options, fallocate_mode),
2292 .help = "Whether pre-allocation is performed when laying out files",
2294 .category = FIO_OPT_C_FILE,
2295 .group = FIO_OPT_G_INVALID,
2298 .oval = FIO_FALLOCATE_NONE,
2299 .help = "Do not pre-allocate space",
2302 .oval = FIO_FALLOCATE_POSIX,
2303 .help = "Use posix_fallocate()",
2305 #ifdef CONFIG_LINUX_FALLOCATE
2307 .oval = FIO_FALLOCATE_KEEP_SIZE,
2308 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
2311 /* Compatibility with former boolean values */
2313 .oval = FIO_FALLOCATE_NONE,
2314 .help = "Alias for 'none'",
2317 .oval = FIO_FALLOCATE_POSIX,
2318 .help = "Alias for 'posix'",
2322 #else /* CONFIG_POSIX_FALLOCATE */
2324 .name = "fallocate",
2325 .lname = "Fallocate",
2326 .type = FIO_OPT_UNSUPPORTED,
2327 .help = "Your platform does not support fallocate",
2329 #endif /* CONFIG_POSIX_FALLOCATE */
2331 .name = "fadvise_hint",
2332 .lname = "Fadvise hint",
2333 .type = FIO_OPT_STR,
2334 .off1 = offsetof(struct thread_options, fadvise_hint),
2338 .help = "Don't issue fadvise",
2342 .help = "Advise using fio IO pattern",
2345 .oval = F_ADV_RANDOM,
2346 .help = "Advise using FADV_RANDOM",
2348 { .ival = "sequential",
2349 .oval = F_ADV_SEQUENTIAL,
2350 .help = "Advise using FADV_SEQUENTIAL",
2353 .help = "Use fadvise() to advise the kernel on IO pattern",
2355 .category = FIO_OPT_C_FILE,
2356 .group = FIO_OPT_G_INVALID,
2361 .type = FIO_OPT_INT,
2362 .off1 = offsetof(struct thread_options, fsync_blocks),
2363 .help = "Issue fsync for writes every given number of blocks",
2366 .category = FIO_OPT_C_FILE,
2367 .group = FIO_OPT_G_INVALID,
2370 .name = "fdatasync",
2371 .lname = "Fdatasync",
2372 .type = FIO_OPT_INT,
2373 .off1 = offsetof(struct thread_options, fdatasync_blocks),
2374 .help = "Issue fdatasync for writes every given number of blocks",
2377 .category = FIO_OPT_C_FILE,
2378 .group = FIO_OPT_G_INVALID,
2381 .name = "write_barrier",
2382 .lname = "Write barrier",
2383 .type = FIO_OPT_INT,
2384 .off1 = offsetof(struct thread_options, barrier_blocks),
2385 .help = "Make every Nth write a barrier write",
2388 .category = FIO_OPT_C_IO,
2389 .group = FIO_OPT_G_INVALID,
2391 #ifdef CONFIG_SYNC_FILE_RANGE
2393 .name = "sync_file_range",
2394 .lname = "Sync file range",
2396 { .ival = "wait_before",
2397 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
2398 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
2402 .oval = SYNC_FILE_RANGE_WRITE,
2403 .help = "SYNC_FILE_RANGE_WRITE",
2407 .ival = "wait_after",
2408 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
2409 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
2413 .type = FIO_OPT_STR_MULTI,
2415 .off1 = offsetof(struct thread_options, sync_file_range),
2416 .help = "Use sync_file_range()",
2417 .category = FIO_OPT_C_FILE,
2418 .group = FIO_OPT_G_INVALID,
2422 .name = "sync_file_range",
2423 .lname = "Sync file range",
2424 .type = FIO_OPT_UNSUPPORTED,
2425 .help = "Your platform does not support sync_file_range",
2430 .lname = "Direct I/O",
2431 .type = FIO_OPT_BOOL,
2432 .off1 = offsetof(struct thread_options, odirect),
2433 .help = "Use O_DIRECT IO (negates buffered)",
2435 .inverse = "buffered",
2436 .category = FIO_OPT_C_IO,
2437 .group = FIO_OPT_G_IO_TYPE,
2441 .lname = "Atomic I/O",
2442 .type = FIO_OPT_BOOL,
2443 .off1 = offsetof(struct thread_options, oatomic),
2444 .help = "Use Atomic IO with O_DIRECT (implies O_DIRECT)",
2446 .category = FIO_OPT_C_IO,
2447 .group = FIO_OPT_G_IO_TYPE,
2451 .lname = "Buffered I/O",
2452 .type = FIO_OPT_BOOL,
2453 .off1 = offsetof(struct thread_options, odirect),
2455 .help = "Use buffered IO (negates direct)",
2457 .inverse = "direct",
2458 .category = FIO_OPT_C_IO,
2459 .group = FIO_OPT_G_IO_TYPE,
2462 .name = "overwrite",
2463 .lname = "Overwrite",
2464 .type = FIO_OPT_BOOL,
2465 .off1 = offsetof(struct thread_options, overwrite),
2466 .help = "When writing, set whether to overwrite current data",
2468 .category = FIO_OPT_C_FILE,
2469 .group = FIO_OPT_G_INVALID,
2474 .type = FIO_OPT_INT,
2475 .off1 = offsetof(struct thread_options, loops),
2476 .help = "Number of times to run the job",
2479 .category = FIO_OPT_C_GENERAL,
2480 .group = FIO_OPT_G_RUNTIME,
2484 .lname = "Number of jobs",
2485 .type = FIO_OPT_INT,
2486 .off1 = offsetof(struct thread_options, numjobs),
2487 .help = "Duplicate this job this many times",
2490 .category = FIO_OPT_C_GENERAL,
2491 .group = FIO_OPT_G_RUNTIME,
2494 .name = "startdelay",
2495 .lname = "Start delay",
2496 .type = FIO_OPT_STR_VAL_TIME,
2497 .off1 = offsetof(struct thread_options, start_delay),
2498 .off2 = offsetof(struct thread_options, start_delay_high),
2499 .help = "Only start job when this period has passed",
2503 .category = FIO_OPT_C_GENERAL,
2504 .group = FIO_OPT_G_RUNTIME,
2510 .type = FIO_OPT_STR_VAL_TIME,
2511 .off1 = offsetof(struct thread_options, timeout),
2512 .help = "Stop workload when this amount of time has passed",
2516 .category = FIO_OPT_C_GENERAL,
2517 .group = FIO_OPT_G_RUNTIME,
2520 .name = "time_based",
2521 .lname = "Time based",
2522 .type = FIO_OPT_STR_SET,
2523 .off1 = offsetof(struct thread_options, time_based),
2524 .help = "Keep running until runtime/timeout is met",
2525 .category = FIO_OPT_C_GENERAL,
2526 .group = FIO_OPT_G_RUNTIME,
2529 .name = "verify_only",
2530 .lname = "Verify only",
2531 .type = FIO_OPT_STR_SET,
2532 .off1 = offsetof(struct thread_options, verify_only),
2533 .help = "Verifies previously written data is still valid",
2534 .category = FIO_OPT_C_GENERAL,
2535 .group = FIO_OPT_G_RUNTIME,
2538 .name = "ramp_time",
2539 .lname = "Ramp time",
2540 .type = FIO_OPT_STR_VAL_TIME,
2541 .off1 = offsetof(struct thread_options, ramp_time),
2542 .help = "Ramp up time before measuring performance",
2545 .category = FIO_OPT_C_GENERAL,
2546 .group = FIO_OPT_G_RUNTIME,
2549 .name = "clocksource",
2550 .lname = "Clock source",
2551 .type = FIO_OPT_STR,
2552 .cb = fio_clock_source_cb,
2553 .off1 = offsetof(struct thread_options, clocksource),
2554 .help = "What type of timing source to use",
2555 .category = FIO_OPT_C_GENERAL,
2556 .group = FIO_OPT_G_CLOCK,
2558 #ifdef CONFIG_GETTIMEOFDAY
2559 { .ival = "gettimeofday",
2561 .help = "Use gettimeofday(2) for timing",
2564 #ifdef CONFIG_CLOCK_GETTIME
2565 { .ival = "clock_gettime",
2566 .oval = CS_CGETTIME,
2567 .help = "Use clock_gettime(2) for timing",
2570 #ifdef ARCH_HAVE_CPU_CLOCK
2572 .oval = CS_CPUCLOCK,
2573 .help = "Use CPU private clock",
2581 .lname = "I/O Memory",
2582 .type = FIO_OPT_STR,
2584 .off1 = offsetof(struct thread_options, mem_type),
2585 .help = "Backing type for IO buffers",
2587 .category = FIO_OPT_C_IO,
2588 .group = FIO_OPT_G_INVALID,
2592 .help = "Use malloc(3) for IO buffers",
2594 #ifndef CONFIG_NO_SHM
2597 .help = "Use shared memory segments for IO buffers",
2599 #ifdef FIO_HAVE_HUGETLB
2600 { .ival = "shmhuge",
2601 .oval = MEM_SHMHUGE,
2602 .help = "Like shm, but use huge pages",
2608 .help = "Use mmap(2) (file or anon) for IO buffers",
2610 { .ival = "mmapshared",
2611 .oval = MEM_MMAPSHARED,
2612 .help = "Like mmap, but use the shared flag",
2614 #ifdef FIO_HAVE_HUGETLB
2615 { .ival = "mmaphuge",
2616 .oval = MEM_MMAPHUGE,
2617 .help = "Like mmap, but use huge pages",
2621 { .ival = "cudamalloc",
2622 .oval = MEM_CUDA_MALLOC,
2623 .help = "Allocate GPU device memory for GPUDirect RDMA",
2629 .name = "iomem_align",
2630 .alias = "mem_align",
2631 .lname = "I/O memory alignment",
2632 .type = FIO_OPT_INT,
2633 .off1 = offsetof(struct thread_options, mem_align),
2635 .help = "IO memory buffer offset alignment",
2639 .category = FIO_OPT_C_IO,
2640 .group = FIO_OPT_G_INVALID,
2645 .type = FIO_OPT_STR,
2646 .off1 = offsetof(struct thread_options, verify),
2647 .help = "Verify data written",
2649 .category = FIO_OPT_C_IO,
2650 .group = FIO_OPT_G_VERIFY,
2653 .oval = VERIFY_NONE,
2654 .help = "Don't do IO verification",
2658 .help = "Use md5 checksums for verification",
2661 .oval = VERIFY_CRC64,
2662 .help = "Use crc64 checksums for verification",
2665 .oval = VERIFY_CRC32,
2666 .help = "Use crc32 checksums for verification",
2668 { .ival = "crc32c-intel",
2669 .oval = VERIFY_CRC32C,
2670 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2673 .oval = VERIFY_CRC32C,
2674 .help = "Use crc32c checksums for verification (hw assisted, if available)",
2677 .oval = VERIFY_CRC16,
2678 .help = "Use crc16 checksums for verification",
2681 .oval = VERIFY_CRC7,
2682 .help = "Use crc7 checksums for verification",
2685 .oval = VERIFY_SHA1,
2686 .help = "Use sha1 checksums for verification",
2689 .oval = VERIFY_SHA256,
2690 .help = "Use sha256 checksums for verification",
2693 .oval = VERIFY_SHA512,
2694 .help = "Use sha512 checksums for verification",
2696 { .ival = "sha3-224",
2697 .oval = VERIFY_SHA3_224,
2698 .help = "Use sha3-224 checksums for verification",
2700 { .ival = "sha3-256",
2701 .oval = VERIFY_SHA3_256,
2702 .help = "Use sha3-256 checksums for verification",
2704 { .ival = "sha3-384",
2705 .oval = VERIFY_SHA3_384,
2706 .help = "Use sha3-384 checksums for verification",
2708 { .ival = "sha3-512",
2709 .oval = VERIFY_SHA3_512,
2710 .help = "Use sha3-512 checksums for verification",
2713 .oval = VERIFY_XXHASH,
2714 .help = "Use xxhash checksums for verification",
2716 /* Meta information was included into verify_header,
2717 * 'meta' verification is implied by default. */
2719 .oval = VERIFY_HDR_ONLY,
2720 .help = "Use io information for verification. "
2721 "Now is implied by default, thus option is obsolete, "
2724 { .ival = "pattern",
2725 .oval = VERIFY_PATTERN_NO_HDR,
2726 .help = "Verify strict pattern",
2730 .oval = VERIFY_NULL,
2731 .help = "Pretend to verify",
2736 .name = "do_verify",
2737 .lname = "Perform verify step",
2738 .type = FIO_OPT_BOOL,
2739 .off1 = offsetof(struct thread_options, do_verify),
2740 .help = "Run verification stage after write",
2744 .category = FIO_OPT_C_IO,
2745 .group = FIO_OPT_G_VERIFY,
2748 .name = "verifysort",
2749 .lname = "Verify sort",
2750 .type = FIO_OPT_BOOL,
2751 .off1 = offsetof(struct thread_options, verifysort),
2752 .help = "Sort written verify blocks for read back",
2756 .category = FIO_OPT_C_IO,
2757 .group = FIO_OPT_G_VERIFY,
2760 .name = "verifysort_nr",
2761 .lname = "Verify Sort Nr",
2762 .type = FIO_OPT_INT,
2763 .off1 = offsetof(struct thread_options, verifysort_nr),
2764 .help = "Pre-load and sort verify blocks for a read workload",
2769 .category = FIO_OPT_C_IO,
2770 .group = FIO_OPT_G_VERIFY,
2773 .name = "verify_interval",
2774 .lname = "Verify interval",
2775 .type = FIO_OPT_INT,
2776 .off1 = offsetof(struct thread_options, verify_interval),
2777 .minval = 2 * sizeof(struct verify_header),
2778 .help = "Store verify buffer header every N bytes",
2781 .interval = 2 * sizeof(struct verify_header),
2782 .category = FIO_OPT_C_IO,
2783 .group = FIO_OPT_G_VERIFY,
2786 .name = "verify_offset",
2787 .lname = "Verify offset",
2788 .type = FIO_OPT_INT,
2789 .help = "Offset verify header location by N bytes",
2790 .off1 = offsetof(struct thread_options, verify_offset),
2791 .minval = sizeof(struct verify_header),
2794 .category = FIO_OPT_C_IO,
2795 .group = FIO_OPT_G_VERIFY,
2798 .name = "verify_pattern",
2799 .lname = "Verify pattern",
2800 .type = FIO_OPT_STR,
2801 .cb = str_verify_pattern_cb,
2802 .off1 = offsetof(struct thread_options, verify_pattern),
2803 .help = "Fill pattern for IO buffers",
2806 .category = FIO_OPT_C_IO,
2807 .group = FIO_OPT_G_VERIFY,
2810 .name = "verify_fatal",
2811 .lname = "Verify fatal",
2812 .type = FIO_OPT_BOOL,
2813 .off1 = offsetof(struct thread_options, verify_fatal),
2815 .help = "Exit on a single verify failure, don't continue",
2818 .category = FIO_OPT_C_IO,
2819 .group = FIO_OPT_G_VERIFY,
2822 .name = "verify_dump",
2823 .lname = "Verify dump",
2824 .type = FIO_OPT_BOOL,
2825 .off1 = offsetof(struct thread_options, verify_dump),
2827 .help = "Dump contents of good and bad blocks on failure",
2830 .category = FIO_OPT_C_IO,
2831 .group = FIO_OPT_G_VERIFY,
2834 .name = "verify_async",
2835 .lname = "Verify asynchronously",
2836 .type = FIO_OPT_INT,
2837 .off1 = offsetof(struct thread_options, verify_async),
2839 .help = "Number of async verifier threads to use",
2842 .category = FIO_OPT_C_IO,
2843 .group = FIO_OPT_G_VERIFY,
2846 .name = "verify_backlog",
2847 .lname = "Verify backlog",
2848 .type = FIO_OPT_STR_VAL,
2849 .off1 = offsetof(struct thread_options, verify_backlog),
2850 .help = "Verify after this number of blocks are written",
2853 .category = FIO_OPT_C_IO,
2854 .group = FIO_OPT_G_VERIFY,
2857 .name = "verify_backlog_batch",
2858 .lname = "Verify backlog batch",
2859 .type = FIO_OPT_INT,
2860 .off1 = offsetof(struct thread_options, verify_batch),
2861 .help = "Verify this number of IO blocks",
2864 .category = FIO_OPT_C_IO,
2865 .group = FIO_OPT_G_VERIFY,
2867 #ifdef FIO_HAVE_CPU_AFFINITY
2869 .name = "verify_async_cpus",
2870 .lname = "Async verify CPUs",
2871 .type = FIO_OPT_STR,
2872 .cb = str_verify_cpus_allowed_cb,
2873 .off1 = offsetof(struct thread_options, verify_cpumask),
2874 .help = "Set CPUs allowed for async verify threads",
2875 .parent = "verify_async",
2877 .category = FIO_OPT_C_IO,
2878 .group = FIO_OPT_G_VERIFY,
2882 .name = "verify_async_cpus",
2883 .lname = "Async verify CPUs",
2884 .type = FIO_OPT_UNSUPPORTED,
2885 .help = "Your platform does not support CPU affinities",
2889 .name = "experimental_verify",
2890 .lname = "Experimental Verify",
2891 .off1 = offsetof(struct thread_options, experimental_verify),
2892 .type = FIO_OPT_BOOL,
2893 .help = "Enable experimental verification",
2895 .category = FIO_OPT_C_IO,
2896 .group = FIO_OPT_G_VERIFY,
2899 .name = "verify_state_load",
2900 .lname = "Load verify state",
2901 .off1 = offsetof(struct thread_options, verify_state),
2902 .type = FIO_OPT_BOOL,
2903 .help = "Load verify termination state",
2905 .category = FIO_OPT_C_IO,
2906 .group = FIO_OPT_G_VERIFY,
2909 .name = "verify_state_save",
2910 .lname = "Save verify state",
2911 .off1 = offsetof(struct thread_options, verify_state_save),
2912 .type = FIO_OPT_BOOL,
2914 .help = "Save verify state on termination",
2916 .category = FIO_OPT_C_IO,
2917 .group = FIO_OPT_G_VERIFY,
2919 #ifdef FIO_HAVE_TRIM
2921 .name = "trim_percentage",
2922 .lname = "Trim percentage",
2923 .type = FIO_OPT_INT,
2924 .off1 = offsetof(struct thread_options, trim_percentage),
2927 .help = "Number of verify blocks to trim (i.e., discard)",
2932 .category = FIO_OPT_C_IO,
2933 .group = FIO_OPT_G_TRIM,
2936 .name = "trim_verify_zero",
2937 .lname = "Verify trim zero",
2938 .type = FIO_OPT_BOOL,
2939 .help = "Verify that trimmed (i.e., discarded) blocks are returned as zeroes",
2940 .off1 = offsetof(struct thread_options, trim_zero),
2941 .parent = "trim_percentage",
2944 .category = FIO_OPT_C_IO,
2945 .group = FIO_OPT_G_TRIM,
2948 .name = "trim_backlog",
2949 .lname = "Trim backlog",
2950 .type = FIO_OPT_STR_VAL,
2951 .off1 = offsetof(struct thread_options, trim_backlog),
2952 .help = "Trim after this number of blocks are written",
2953 .parent = "trim_percentage",
2956 .category = FIO_OPT_C_IO,
2957 .group = FIO_OPT_G_TRIM,
2960 .name = "trim_backlog_batch",
2961 .lname = "Trim backlog batch",
2962 .type = FIO_OPT_INT,
2963 .off1 = offsetof(struct thread_options, trim_batch),
2964 .help = "Trim this number of IO blocks",
2965 .parent = "trim_percentage",
2968 .category = FIO_OPT_C_IO,
2969 .group = FIO_OPT_G_TRIM,
2973 .name = "trim_percentage",
2974 .lname = "Trim percentage",
2975 .type = FIO_OPT_UNSUPPORTED,
2976 .help = "Fio does not support TRIM on your platform",
2979 .name = "trim_verify_zero",
2980 .lname = "Verify trim zero",
2981 .type = FIO_OPT_UNSUPPORTED,
2982 .help = "Fio does not support TRIM on your platform",
2985 .name = "trim_backlog",
2986 .lname = "Trim backlog",
2987 .type = FIO_OPT_UNSUPPORTED,
2988 .help = "Fio does not support TRIM on your platform",
2991 .name = "trim_backlog_batch",
2992 .lname = "Trim backlog batch",
2993 .type = FIO_OPT_UNSUPPORTED,
2994 .help = "Fio does not support TRIM on your platform",
2998 .name = "write_iolog",
2999 .lname = "Write I/O log",
3000 .type = FIO_OPT_STR_STORE,
3001 .off1 = offsetof(struct thread_options, write_iolog_file),
3002 .help = "Store IO pattern to file",
3003 .category = FIO_OPT_C_IO,
3004 .group = FIO_OPT_G_IOLOG,
3007 .name = "read_iolog",
3008 .lname = "Read I/O log",
3009 .type = FIO_OPT_STR_STORE,
3010 .off1 = offsetof(struct thread_options, read_iolog_file),
3011 .help = "Playback IO pattern from file",
3012 .category = FIO_OPT_C_IO,
3013 .group = FIO_OPT_G_IOLOG,
3016 .name = "replay_no_stall",
3017 .lname = "Don't stall on replay",
3018 .type = FIO_OPT_BOOL,
3019 .off1 = offsetof(struct thread_options, no_stall),
3021 .parent = "read_iolog",
3023 .help = "Playback IO pattern file as fast as possible without stalls",
3024 .category = FIO_OPT_C_IO,
3025 .group = FIO_OPT_G_IOLOG,
3028 .name = "replay_redirect",
3029 .lname = "Redirect device for replay",
3030 .type = FIO_OPT_STR_STORE,
3031 .off1 = offsetof(struct thread_options, replay_redirect),
3032 .parent = "read_iolog",
3034 .help = "Replay all I/O onto this device, regardless of trace device",
3035 .category = FIO_OPT_C_IO,
3036 .group = FIO_OPT_G_IOLOG,
3039 .name = "replay_scale",
3040 .lname = "Replace offset scale factor",
3041 .type = FIO_OPT_INT,
3042 .off1 = offsetof(struct thread_options, replay_scale),
3043 .parent = "read_iolog",
3045 .help = "Align offsets to this blocksize",
3046 .category = FIO_OPT_C_IO,
3047 .group = FIO_OPT_G_IOLOG,
3050 .name = "replay_align",
3051 .lname = "Replace alignment",
3052 .type = FIO_OPT_INT,
3053 .off1 = offsetof(struct thread_options, replay_align),
3054 .parent = "read_iolog",
3055 .help = "Scale offset down by this factor",
3056 .category = FIO_OPT_C_IO,
3057 .group = FIO_OPT_G_IOLOG,
3061 .name = "exec_prerun",
3062 .lname = "Pre-execute runnable",
3063 .type = FIO_OPT_STR_STORE,
3064 .off1 = offsetof(struct thread_options, exec_prerun),
3065 .help = "Execute this file prior to running job",
3066 .category = FIO_OPT_C_GENERAL,
3067 .group = FIO_OPT_G_INVALID,
3070 .name = "exec_postrun",
3071 .lname = "Post-execute runnable",
3072 .type = FIO_OPT_STR_STORE,
3073 .off1 = offsetof(struct thread_options, exec_postrun),
3074 .help = "Execute this file after running job",
3075 .category = FIO_OPT_C_GENERAL,
3076 .group = FIO_OPT_G_INVALID,
3078 #ifdef FIO_HAVE_IOSCHED_SWITCH
3080 .name = "ioscheduler",
3081 .lname = "I/O scheduler",
3082 .type = FIO_OPT_STR_STORE,
3083 .off1 = offsetof(struct thread_options, ioscheduler),
3084 .help = "Use this IO scheduler on the backing device",
3085 .category = FIO_OPT_C_FILE,
3086 .group = FIO_OPT_G_INVALID,
3090 .name = "ioscheduler",
3091 .lname = "I/O scheduler",
3092 .type = FIO_OPT_UNSUPPORTED,
3093 .help = "Your platform does not support IO scheduler switching",
3098 .lname = "Zone size",
3099 .type = FIO_OPT_STR_VAL,
3100 .off1 = offsetof(struct thread_options, zone_size),
3101 .help = "Amount of data to read per zone",
3103 .interval = 1024 * 1024,
3104 .category = FIO_OPT_C_IO,
3105 .group = FIO_OPT_G_ZONE,
3108 .name = "zonerange",
3109 .lname = "Zone range",
3110 .type = FIO_OPT_STR_VAL,
3111 .off1 = offsetof(struct thread_options, zone_range),
3112 .help = "Give size of an IO zone",
3114 .interval = 1024 * 1024,
3115 .category = FIO_OPT_C_IO,
3116 .group = FIO_OPT_G_ZONE,
3120 .lname = "Zone skip",
3121 .type = FIO_OPT_STR_VAL,
3122 .off1 = offsetof(struct thread_options, zone_skip),
3123 .help = "Space between IO zones",
3125 .interval = 1024 * 1024,
3126 .category = FIO_OPT_C_IO,
3127 .group = FIO_OPT_G_ZONE,
3131 .lname = "Lock memory",
3132 .type = FIO_OPT_STR_VAL,
3133 .off1 = offsetof(struct thread_options, lockmem),
3134 .help = "Lock down this amount of memory (per worker)",
3136 .interval = 1024 * 1024,
3137 .category = FIO_OPT_C_GENERAL,
3138 .group = FIO_OPT_G_INVALID,
3141 .name = "rwmixread",
3142 .lname = "Read/write mix read",
3143 .type = FIO_OPT_INT,
3144 .cb = str_rwmix_read_cb,
3145 .off1 = offsetof(struct thread_options, rwmix[DDIR_READ]),
3147 .help = "Percentage of mixed workload that is reads",
3150 .inverse = "rwmixwrite",
3151 .category = FIO_OPT_C_IO,
3152 .group = FIO_OPT_G_RWMIX,
3155 .name = "rwmixwrite",
3156 .lname = "Read/write mix write",
3157 .type = FIO_OPT_INT,
3158 .cb = str_rwmix_write_cb,
3159 .off1 = offsetof(struct thread_options, rwmix[DDIR_WRITE]),
3161 .help = "Percentage of mixed workload that is writes",
3164 .inverse = "rwmixread",
3165 .category = FIO_OPT_C_IO,
3166 .group = FIO_OPT_G_RWMIX,
3169 .name = "rwmixcycle",
3170 .lname = "Read/write mix cycle",
3171 .type = FIO_OPT_DEPRECATED,
3172 .category = FIO_OPT_C_IO,
3173 .group = FIO_OPT_G_RWMIX,
3178 .type = FIO_OPT_INT,
3179 .off1 = offsetof(struct thread_options, nice),
3180 .help = "Set job CPU nice value",
3185 .category = FIO_OPT_C_GENERAL,
3186 .group = FIO_OPT_G_CRED,
3188 #ifdef FIO_HAVE_IOPRIO
3191 .lname = "I/O nice priority",
3192 .type = FIO_OPT_INT,
3193 .off1 = offsetof(struct thread_options, ioprio),
3194 .help = "Set job IO priority value",
3195 .minval = IOPRIO_MIN_PRIO,
3196 .maxval = IOPRIO_MAX_PRIO,
3198 .category = FIO_OPT_C_GENERAL,
3199 .group = FIO_OPT_G_CRED,
3204 .lname = "I/O nice priority",
3205 .type = FIO_OPT_UNSUPPORTED,
3206 .help = "Your platform does not support IO priorities",
3209 #ifdef FIO_HAVE_IOPRIO_CLASS
3210 #ifndef FIO_HAVE_IOPRIO
3211 #error "FIO_HAVE_IOPRIO_CLASS requires FIO_HAVE_IOPRIO"
3214 .name = "prioclass",
3215 .lname = "I/O nice priority class",
3216 .type = FIO_OPT_INT,
3217 .off1 = offsetof(struct thread_options, ioprio_class),
3218 .help = "Set job IO priority class",
3219 .minval = IOPRIO_MIN_PRIO_CLASS,
3220 .maxval = IOPRIO_MAX_PRIO_CLASS,
3222 .category = FIO_OPT_C_GENERAL,
3223 .group = FIO_OPT_G_CRED,
3227 .name = "prioclass",
3228 .lname = "I/O nice priority class",
3229 .type = FIO_OPT_UNSUPPORTED,
3230 .help = "Your platform does not support IO priority classes",
3234 .name = "thinktime",
3235 .lname = "Thinktime",
3236 .type = FIO_OPT_INT,
3237 .off1 = offsetof(struct thread_options, thinktime),
3238 .help = "Idle time between IO buffers (usec)",
3241 .category = FIO_OPT_C_IO,
3242 .group = FIO_OPT_G_THINKTIME,
3245 .name = "thinktime_spin",
3246 .lname = "Thinktime spin",
3247 .type = FIO_OPT_INT,
3248 .off1 = offsetof(struct thread_options, thinktime_spin),
3249 .help = "Start think time by spinning this amount (usec)",
3252 .parent = "thinktime",
3254 .category = FIO_OPT_C_IO,
3255 .group = FIO_OPT_G_THINKTIME,
3258 .name = "thinktime_blocks",
3259 .lname = "Thinktime blocks",
3260 .type = FIO_OPT_INT,
3261 .off1 = offsetof(struct thread_options, thinktime_blocks),
3262 .help = "IO buffer period between 'thinktime'",
3264 .parent = "thinktime",
3266 .category = FIO_OPT_C_IO,
3267 .group = FIO_OPT_G_THINKTIME,
3271 .lname = "I/O rate",
3272 .type = FIO_OPT_INT,
3273 .off1 = offsetof(struct thread_options, rate[DDIR_READ]),
3274 .off2 = offsetof(struct thread_options, rate[DDIR_WRITE]),
3275 .off3 = offsetof(struct thread_options, rate[DDIR_TRIM]),
3276 .help = "Set bandwidth rate",
3277 .category = FIO_OPT_C_IO,
3278 .group = FIO_OPT_G_RATE,
3283 .lname = "I/O min rate",
3284 .type = FIO_OPT_INT,
3285 .off1 = offsetof(struct thread_options, ratemin[DDIR_READ]),
3286 .off2 = offsetof(struct thread_options, ratemin[DDIR_WRITE]),
3287 .off3 = offsetof(struct thread_options, ratemin[DDIR_TRIM]),
3288 .help = "Job must meet this rate or it will be shutdown",
3291 .category = FIO_OPT_C_IO,
3292 .group = FIO_OPT_G_RATE,
3295 .name = "rate_iops",
3296 .lname = "I/O rate IOPS",
3297 .type = FIO_OPT_INT,
3298 .off1 = offsetof(struct thread_options, rate_iops[DDIR_READ]),
3299 .off2 = offsetof(struct thread_options, rate_iops[DDIR_WRITE]),
3300 .off3 = offsetof(struct thread_options, rate_iops[DDIR_TRIM]),
3301 .help = "Limit IO used to this number of IO operations/sec",
3303 .category = FIO_OPT_C_IO,
3304 .group = FIO_OPT_G_RATE,
3307 .name = "rate_iops_min",
3308 .lname = "I/O min rate IOPS",
3309 .type = FIO_OPT_INT,
3310 .off1 = offsetof(struct thread_options, rate_iops_min[DDIR_READ]),
3311 .off2 = offsetof(struct thread_options, rate_iops_min[DDIR_WRITE]),
3312 .off3 = offsetof(struct thread_options, rate_iops_min[DDIR_TRIM]),
3313 .help = "Job must meet this rate or it will be shut down",
3314 .parent = "rate_iops",
3316 .category = FIO_OPT_C_IO,
3317 .group = FIO_OPT_G_RATE,
3320 .name = "rate_process",
3321 .lname = "Rate Process",
3322 .type = FIO_OPT_STR,
3323 .off1 = offsetof(struct thread_options, rate_process),
3324 .help = "What process controls how rated IO is managed",
3326 .category = FIO_OPT_C_IO,
3327 .group = FIO_OPT_G_RATE,
3330 .oval = RATE_PROCESS_LINEAR,
3331 .help = "Linear rate of IO",
3335 .oval = RATE_PROCESS_POISSON,
3336 .help = "Rate follows Poisson process",
3342 .name = "rate_cycle",
3343 .alias = "ratecycle",
3344 .lname = "I/O rate cycle",
3345 .type = FIO_OPT_INT,
3346 .off1 = offsetof(struct thread_options, ratecycle),
3347 .help = "Window average for rate limits (msec)",
3351 .category = FIO_OPT_C_IO,
3352 .group = FIO_OPT_G_RATE,
3355 .name = "max_latency",
3356 .lname = "Max Latency",
3357 .type = FIO_OPT_INT,
3358 .off1 = offsetof(struct thread_options, max_latency),
3359 .help = "Maximum tolerated IO latency (usec)",
3361 .category = FIO_OPT_C_IO,
3362 .group = FIO_OPT_G_LATPROF,
3365 .name = "latency_target",
3366 .lname = "Latency Target (usec)",
3367 .type = FIO_OPT_STR_VAL_TIME,
3368 .off1 = offsetof(struct thread_options, latency_target),
3369 .help = "Ramp to max queue depth supporting this latency",
3371 .category = FIO_OPT_C_IO,
3372 .group = FIO_OPT_G_LATPROF,
3375 .name = "latency_window",
3376 .lname = "Latency Window (usec)",
3377 .type = FIO_OPT_STR_VAL_TIME,
3378 .off1 = offsetof(struct thread_options, latency_window),
3379 .help = "Time to sustain latency_target",
3381 .category = FIO_OPT_C_IO,
3382 .group = FIO_OPT_G_LATPROF,
3385 .name = "latency_percentile",
3386 .lname = "Latency Percentile",
3387 .type = FIO_OPT_FLOAT_LIST,
3388 .off1 = offsetof(struct thread_options, latency_percentile),
3389 .help = "Percentile of IOs must be below latency_target",
3394 .category = FIO_OPT_C_IO,
3395 .group = FIO_OPT_G_LATPROF,
3398 .name = "invalidate",
3399 .lname = "Cache invalidate",
3400 .type = FIO_OPT_BOOL,
3401 .off1 = offsetof(struct thread_options, invalidate_cache),
3402 .help = "Invalidate buffer/page cache prior to running job",
3404 .category = FIO_OPT_C_IO,
3405 .group = FIO_OPT_G_IO_TYPE,
3409 .lname = "Synchronous I/O",
3410 .type = FIO_OPT_BOOL,
3411 .off1 = offsetof(struct thread_options, sync_io),
3412 .help = "Use O_SYNC for buffered writes",
3414 .parent = "buffered",
3416 .category = FIO_OPT_C_IO,
3417 .group = FIO_OPT_G_IO_TYPE,
3419 #ifdef FIO_HAVE_WRITE_HINT
3421 .name = "write_hint",
3422 .lname = "Write hint",
3423 .type = FIO_OPT_STR,
3424 .off1 = offsetof(struct thread_options, write_hint),
3425 .help = "Set expected write life time",
3426 .category = FIO_OPT_C_ENGINE,
3427 .group = FIO_OPT_G_INVALID,
3430 .oval = RWH_WRITE_LIFE_NONE,
3433 .oval = RWH_WRITE_LIFE_SHORT,
3436 .oval = RWH_WRITE_LIFE_MEDIUM,
3439 .oval = RWH_WRITE_LIFE_LONG,
3441 { .ival = "extreme",
3442 .oval = RWH_WRITE_LIFE_EXTREME,
3448 .name = "create_serialize",
3449 .lname = "Create serialize",
3450 .type = FIO_OPT_BOOL,
3451 .off1 = offsetof(struct thread_options, create_serialize),
3452 .help = "Serialize creation of job files",
3454 .category = FIO_OPT_C_FILE,
3455 .group = FIO_OPT_G_INVALID,
3458 .name = "create_fsync",
3459 .lname = "Create fsync",
3460 .type = FIO_OPT_BOOL,
3461 .off1 = offsetof(struct thread_options, create_fsync),
3462 .help = "fsync file after creation",
3464 .category = FIO_OPT_C_FILE,
3465 .group = FIO_OPT_G_INVALID,
3468 .name = "create_on_open",
3469 .lname = "Create on open",
3470 .type = FIO_OPT_BOOL,
3471 .off1 = offsetof(struct thread_options, create_on_open),
3472 .help = "Create files when they are opened for IO",
3474 .category = FIO_OPT_C_FILE,
3475 .group = FIO_OPT_G_INVALID,
3478 .name = "create_only",
3479 .lname = "Create Only",
3480 .type = FIO_OPT_BOOL,
3481 .off1 = offsetof(struct thread_options, create_only),
3482 .help = "Only perform file creation phase",
3483 .category = FIO_OPT_C_FILE,
3487 .name = "allow_file_create",
3488 .lname = "Allow file create",
3489 .type = FIO_OPT_BOOL,
3490 .off1 = offsetof(struct thread_options, allow_create),
3491 .help = "Permit fio to create files, if they don't exist",
3493 .category = FIO_OPT_C_FILE,
3494 .group = FIO_OPT_G_FILENAME,
3497 .name = "allow_mounted_write",
3498 .lname = "Allow mounted write",
3499 .type = FIO_OPT_BOOL,
3500 .off1 = offsetof(struct thread_options, allow_mounted_write),
3501 .help = "Allow writes to a mounted partition",
3503 .category = FIO_OPT_C_FILE,
3504 .group = FIO_OPT_G_FILENAME,
3508 .lname = "Pre-read files",
3509 .type = FIO_OPT_BOOL,
3510 .off1 = offsetof(struct thread_options, pre_read),
3511 .help = "Pre-read files before starting official testing",
3513 .category = FIO_OPT_C_FILE,
3514 .group = FIO_OPT_G_INVALID,
3516 #ifdef FIO_HAVE_CPU_AFFINITY
3519 .lname = "CPU mask",
3520 .type = FIO_OPT_INT,
3521 .cb = str_cpumask_cb,
3522 .off1 = offsetof(struct thread_options, cpumask),
3523 .help = "CPU affinity mask",
3524 .category = FIO_OPT_C_GENERAL,
3525 .group = FIO_OPT_G_CRED,
3528 .name = "cpus_allowed",
3529 .lname = "CPUs allowed",
3530 .type = FIO_OPT_STR,
3531 .cb = str_cpus_allowed_cb,
3532 .off1 = offsetof(struct thread_options, cpumask),
3533 .help = "Set CPUs allowed",
3534 .category = FIO_OPT_C_GENERAL,
3535 .group = FIO_OPT_G_CRED,
3538 .name = "cpus_allowed_policy",
3539 .lname = "CPUs allowed distribution policy",
3540 .type = FIO_OPT_STR,
3541 .off1 = offsetof(struct thread_options, cpus_allowed_policy),
3542 .help = "Distribution policy for cpus_allowed",
3543 .parent = "cpus_allowed",
3547 .oval = FIO_CPUS_SHARED,
3548 .help = "Mask shared between threads",
3551 .oval = FIO_CPUS_SPLIT,
3552 .help = "Mask split between threads",
3555 .category = FIO_OPT_C_GENERAL,
3556 .group = FIO_OPT_G_CRED,
3561 .lname = "CPU mask",
3562 .type = FIO_OPT_UNSUPPORTED,
3563 .help = "Your platform does not support CPU affinities",
3566 .name = "cpus_allowed",
3567 .lname = "CPUs allowed",
3568 .type = FIO_OPT_UNSUPPORTED,
3569 .help = "Your platform does not support CPU affinities",
3572 .name = "cpus_allowed_policy",
3573 .lname = "CPUs allowed distribution policy",
3574 .type = FIO_OPT_UNSUPPORTED,
3575 .help = "Your platform does not support CPU affinities",
3578 #ifdef CONFIG_LIBNUMA
3580 .name = "numa_cpu_nodes",
3581 .lname = "NUMA CPU Nodes",
3582 .type = FIO_OPT_STR,
3583 .cb = str_numa_cpunodes_cb,
3584 .off1 = offsetof(struct thread_options, numa_cpunodes),
3585 .help = "NUMA CPU nodes bind",
3586 .category = FIO_OPT_C_GENERAL,
3587 .group = FIO_OPT_G_INVALID,
3590 .name = "numa_mem_policy",
3591 .lname = "NUMA Memory Policy",
3592 .type = FIO_OPT_STR,
3593 .cb = str_numa_mpol_cb,
3594 .off1 = offsetof(struct thread_options, numa_memnodes),
3595 .help = "NUMA memory policy setup",
3596 .category = FIO_OPT_C_GENERAL,
3597 .group = FIO_OPT_G_INVALID,
3601 .name = "numa_cpu_nodes",
3602 .lname = "NUMA CPU Nodes",
3603 .type = FIO_OPT_UNSUPPORTED,
3604 .help = "Build fio with libnuma-dev(el) to enable this option",
3607 .name = "numa_mem_policy",
3608 .lname = "NUMA Memory Policy",
3609 .type = FIO_OPT_UNSUPPORTED,
3610 .help = "Build fio with libnuma-dev(el) to enable this option",
3615 .name = "gpu_dev_id",
3616 .lname = "GPU device ID",
3617 .type = FIO_OPT_INT,
3618 .off1 = offsetof(struct thread_options, gpu_dev_id),
3619 .help = "Set GPU device ID for GPUDirect RDMA",
3621 .category = FIO_OPT_C_GENERAL,
3622 .group = FIO_OPT_G_INVALID,
3626 .name = "end_fsync",
3627 .lname = "End fsync",
3628 .type = FIO_OPT_BOOL,
3629 .off1 = offsetof(struct thread_options, end_fsync),
3630 .help = "Include fsync at the end of job",
3632 .category = FIO_OPT_C_FILE,
3633 .group = FIO_OPT_G_INVALID,
3636 .name = "fsync_on_close",
3637 .lname = "Fsync on close",
3638 .type = FIO_OPT_BOOL,
3639 .off1 = offsetof(struct thread_options, fsync_on_close),
3640 .help = "fsync files on close",
3642 .category = FIO_OPT_C_FILE,
3643 .group = FIO_OPT_G_INVALID,
3647 .lname = "Unlink file",
3648 .type = FIO_OPT_BOOL,
3649 .off1 = offsetof(struct thread_options, unlink),
3650 .help = "Unlink created files after job has completed",
3652 .category = FIO_OPT_C_FILE,
3653 .group = FIO_OPT_G_INVALID,
3656 .name = "unlink_each_loop",
3657 .lname = "Unlink file after each loop of a job",
3658 .type = FIO_OPT_BOOL,
3659 .off1 = offsetof(struct thread_options, unlink_each_loop),
3660 .help = "Unlink created files after each loop in a job has completed",
3662 .category = FIO_OPT_C_FILE,
3663 .group = FIO_OPT_G_INVALID,
3667 .lname = "Exit-all on terminate",
3668 .type = FIO_OPT_STR_SET,
3669 .cb = str_exitall_cb,
3670 .help = "Terminate all jobs when one exits",
3671 .category = FIO_OPT_C_GENERAL,
3672 .group = FIO_OPT_G_PROCESS,
3675 .name = "exitall_on_error",
3676 .lname = "Exit-all on terminate in error",
3677 .type = FIO_OPT_STR_SET,
3678 .off1 = offsetof(struct thread_options, exitall_error),
3679 .help = "Terminate all jobs when one exits in error",
3680 .category = FIO_OPT_C_GENERAL,
3681 .group = FIO_OPT_G_PROCESS,
3684 .name = "stonewall",
3685 .lname = "Wait for previous",
3686 .alias = "wait_for_previous",
3687 .type = FIO_OPT_STR_SET,
3688 .off1 = offsetof(struct thread_options, stonewall),
3689 .help = "Insert a hard barrier between this job and previous",
3690 .category = FIO_OPT_C_GENERAL,
3691 .group = FIO_OPT_G_PROCESS,
3694 .name = "new_group",
3695 .lname = "New group",
3696 .type = FIO_OPT_STR_SET,
3697 .off1 = offsetof(struct thread_options, new_group),
3698 .help = "Mark the start of a new group (for reporting)",
3699 .category = FIO_OPT_C_GENERAL,
3700 .group = FIO_OPT_G_PROCESS,
3705 .type = FIO_OPT_STR_SET,
3706 .off1 = offsetof(struct thread_options, use_thread),
3707 .help = "Use threads instead of processes",
3708 #ifdef CONFIG_NO_SHM
3712 .category = FIO_OPT_C_GENERAL,
3713 .group = FIO_OPT_G_PROCESS,
3716 .name = "per_job_logs",
3717 .lname = "Per Job Logs",
3718 .type = FIO_OPT_BOOL,
3719 .off1 = offsetof(struct thread_options, per_job_logs),
3720 .help = "Include job number in generated log files or not",
3722 .category = FIO_OPT_C_LOG,
3723 .group = FIO_OPT_G_INVALID,
3726 .name = "write_bw_log",
3727 .lname = "Write bandwidth log",
3728 .type = FIO_OPT_STR,
3729 .off1 = offsetof(struct thread_options, bw_log_file),
3730 .cb = str_write_bw_log_cb,
3731 .help = "Write log of bandwidth during run",
3732 .category = FIO_OPT_C_LOG,
3733 .group = FIO_OPT_G_INVALID,
3736 .name = "write_lat_log",
3737 .lname = "Write latency log",
3738 .type = FIO_OPT_STR,
3739 .off1 = offsetof(struct thread_options, lat_log_file),
3740 .cb = str_write_lat_log_cb,
3741 .help = "Write log of latency during run",
3742 .category = FIO_OPT_C_LOG,
3743 .group = FIO_OPT_G_INVALID,
3746 .name = "write_iops_log",
3747 .lname = "Write IOPS log",
3748 .type = FIO_OPT_STR,
3749 .off1 = offsetof(struct thread_options, iops_log_file),
3750 .cb = str_write_iops_log_cb,
3751 .help = "Write log of IOPS during run",
3752 .category = FIO_OPT_C_LOG,
3753 .group = FIO_OPT_G_INVALID,
3756 .name = "log_avg_msec",
3757 .lname = "Log averaging (msec)",
3758 .type = FIO_OPT_INT,
3759 .off1 = offsetof(struct thread_options, log_avg_msec),
3760 .help = "Average bw/iops/lat logs over this period of time",
3762 .category = FIO_OPT_C_LOG,
3763 .group = FIO_OPT_G_INVALID,
3766 .name = "log_hist_msec",
3767 .lname = "Log histograms (msec)",
3768 .type = FIO_OPT_INT,
3769 .off1 = offsetof(struct thread_options, log_hist_msec),
3770 .help = "Dump completion latency histograms at frequency of this time value",
3772 .category = FIO_OPT_C_LOG,
3773 .group = FIO_OPT_G_INVALID,
3776 .name = "log_hist_coarseness",
3777 .lname = "Histogram logs coarseness",
3778 .type = FIO_OPT_INT,
3779 .off1 = offsetof(struct thread_options, log_hist_coarseness),
3780 .help = "Integer in range [0,6]. Higher coarseness outputs"
3781 " fewer histogram bins per sample. The number of bins for"
3782 " these are [1216, 608, 304, 152, 76, 38, 19] respectively.",
3784 .category = FIO_OPT_C_LOG,
3785 .group = FIO_OPT_G_INVALID,
3788 .name = "write_hist_log",
3789 .lname = "Write latency histogram logs",
3790 .type = FIO_OPT_STR,
3791 .off1 = offsetof(struct thread_options, hist_log_file),
3792 .cb = str_write_hist_log_cb,
3793 .help = "Write log of latency histograms during run",
3794 .category = FIO_OPT_C_LOG,
3795 .group = FIO_OPT_G_INVALID,
3798 .name = "log_max_value",
3799 .lname = "Log maximum instead of average",
3800 .type = FIO_OPT_BOOL,
3801 .off1 = offsetof(struct thread_options, log_max),
3802 .help = "Log max sample in a window instead of average",
3804 .category = FIO_OPT_C_LOG,
3805 .group = FIO_OPT_G_INVALID,
3808 .name = "log_offset",
3809 .lname = "Log offset of IO",
3810 .type = FIO_OPT_BOOL,
3811 .off1 = offsetof(struct thread_options, log_offset),
3812 .help = "Include offset of IO for each log entry",
3814 .category = FIO_OPT_C_LOG,
3815 .group = FIO_OPT_G_INVALID,
3819 .name = "log_compression",
3820 .lname = "Log compression",
3821 .type = FIO_OPT_INT,
3822 .off1 = offsetof(struct thread_options, log_gz),
3823 .help = "Log in compressed chunks of this size",
3825 .maxval = 512 * 1024 * 1024ULL,
3826 .category = FIO_OPT_C_LOG,
3827 .group = FIO_OPT_G_INVALID,
3829 #ifdef FIO_HAVE_CPU_AFFINITY
3831 .name = "log_compression_cpus",
3832 .lname = "Log Compression CPUs",
3833 .type = FIO_OPT_STR,
3834 .cb = str_log_cpus_allowed_cb,
3835 .off1 = offsetof(struct thread_options, log_gz_cpumask),
3836 .parent = "log_compression",
3837 .help = "Limit log compression to these CPUs",
3838 .category = FIO_OPT_C_LOG,
3839 .group = FIO_OPT_G_INVALID,
3843 .name = "log_compression_cpus",
3844 .lname = "Log Compression CPUs",
3845 .type = FIO_OPT_UNSUPPORTED,
3846 .help = "Your platform does not support CPU affinities",
3850 .name = "log_store_compressed",
3851 .lname = "Log store compressed",
3852 .type = FIO_OPT_BOOL,
3853 .off1 = offsetof(struct thread_options, log_gz_store),
3854 .help = "Store logs in a compressed format",
3855 .category = FIO_OPT_C_LOG,
3856 .group = FIO_OPT_G_INVALID,
3860 .name = "log_compression",
3861 .lname = "Log compression",
3862 .type = FIO_OPT_UNSUPPORTED,
3863 .help = "Install libz-dev(el) to get compression support",
3866 .name = "log_store_compressed",
3867 .lname = "Log store compressed",
3868 .type = FIO_OPT_UNSUPPORTED,
3869 .help = "Install libz-dev(el) to get compression support",
3873 .name = "log_unix_epoch",
3874 .lname = "Log epoch unix",
3875 .type = FIO_OPT_BOOL,
3876 .off1 = offsetof(struct thread_options, log_unix_epoch),
3877 .help = "Use Unix time in log files",
3878 .category = FIO_OPT_C_LOG,
3879 .group = FIO_OPT_G_INVALID,
3882 .name = "block_error_percentiles",
3883 .lname = "Block error percentiles",
3884 .type = FIO_OPT_BOOL,
3885 .off1 = offsetof(struct thread_options, block_error_hist),
3886 .help = "Record trim block errors and make a histogram",
3888 .category = FIO_OPT_C_LOG,
3889 .group = FIO_OPT_G_INVALID,
3892 .name = "bwavgtime",
3893 .lname = "Bandwidth average time",
3894 .type = FIO_OPT_INT,
3895 .off1 = offsetof(struct thread_options, bw_avg_time),
3896 .help = "Time window over which to calculate bandwidth"
3899 .parent = "write_bw_log",
3902 .category = FIO_OPT_C_LOG,
3903 .group = FIO_OPT_G_INVALID,
3906 .name = "iopsavgtime",
3907 .lname = "IOPS average time",
3908 .type = FIO_OPT_INT,
3909 .off1 = offsetof(struct thread_options, iops_avg_time),
3910 .help = "Time window over which to calculate IOPS (msec)",
3912 .parent = "write_iops_log",
3915 .category = FIO_OPT_C_LOG,
3916 .group = FIO_OPT_G_INVALID,
3919 .name = "group_reporting",
3920 .lname = "Group reporting",
3921 .type = FIO_OPT_STR_SET,
3922 .off1 = offsetof(struct thread_options, group_reporting),
3923 .help = "Do reporting on a per-group basis",
3924 .category = FIO_OPT_C_STAT,
3925 .group = FIO_OPT_G_INVALID,
3930 .type = FIO_OPT_BOOL,
3931 .off1 = offsetof(struct thread_options, stats),
3932 .help = "Enable collection of stats",
3934 .category = FIO_OPT_C_STAT,
3935 .group = FIO_OPT_G_INVALID,
3938 .name = "zero_buffers",
3939 .lname = "Zero I/O buffers",
3940 .type = FIO_OPT_STR_SET,
3941 .off1 = offsetof(struct thread_options, zero_buffers),
3942 .help = "Init IO buffers to all zeroes",
3943 .category = FIO_OPT_C_IO,
3944 .group = FIO_OPT_G_IO_BUF,
3947 .name = "refill_buffers",
3948 .lname = "Refill I/O buffers",
3949 .type = FIO_OPT_STR_SET,
3950 .off1 = offsetof(struct thread_options, refill_buffers),
3951 .help = "Refill IO buffers on every IO submit",
3952 .category = FIO_OPT_C_IO,
3953 .group = FIO_OPT_G_IO_BUF,
3956 .name = "scramble_buffers",
3957 .lname = "Scramble I/O buffers",
3958 .type = FIO_OPT_BOOL,
3959 .off1 = offsetof(struct thread_options, scramble_buffers),
3960 .help = "Slightly scramble buffers on every IO submit",
3962 .category = FIO_OPT_C_IO,
3963 .group = FIO_OPT_G_IO_BUF,
3966 .name = "buffer_pattern",
3967 .lname = "Buffer pattern",
3968 .type = FIO_OPT_STR,
3969 .cb = str_buffer_pattern_cb,
3970 .off1 = offsetof(struct thread_options, buffer_pattern),
3971 .help = "Fill pattern for IO buffers",
3972 .category = FIO_OPT_C_IO,
3973 .group = FIO_OPT_G_IO_BUF,
3976 .name = "buffer_compress_percentage",
3977 .lname = "Buffer compression percentage",
3978 .type = FIO_OPT_INT,
3979 .cb = str_buffer_compress_cb,
3980 .off1 = offsetof(struct thread_options, compress_percentage),
3983 .help = "How compressible the buffer is (approximately)",
3985 .category = FIO_OPT_C_IO,
3986 .group = FIO_OPT_G_IO_BUF,
3989 .name = "buffer_compress_chunk",
3990 .lname = "Buffer compression chunk size",
3991 .type = FIO_OPT_INT,
3992 .off1 = offsetof(struct thread_options, compress_chunk),
3993 .parent = "buffer_compress_percentage",
3995 .help = "Size of compressible region in buffer",
3997 .category = FIO_OPT_C_IO,
3998 .group = FIO_OPT_G_IO_BUF,
4001 .name = "dedupe_percentage",
4002 .lname = "Dedupe percentage",
4003 .type = FIO_OPT_INT,
4004 .cb = str_dedupe_cb,
4005 .off1 = offsetof(struct thread_options, dedupe_percentage),
4008 .help = "Percentage of buffers that are dedupable",
4010 .category = FIO_OPT_C_IO,
4011 .group = FIO_OPT_G_IO_BUF,
4014 .name = "clat_percentiles",
4015 .lname = "Completion latency percentiles",
4016 .type = FIO_OPT_BOOL,
4017 .off1 = offsetof(struct thread_options, clat_percentiles),
4018 .help = "Enable the reporting of completion latency percentiles",
4020 .category = FIO_OPT_C_STAT,
4021 .group = FIO_OPT_G_INVALID,
4024 .name = "percentile_list",
4025 .lname = "Percentile list",
4026 .type = FIO_OPT_FLOAT_LIST,
4027 .off1 = offsetof(struct thread_options, percentile_list),
4028 .off2 = offsetof(struct thread_options, percentile_precision),
4029 .help = "Specify a custom list of percentiles to report for "
4030 "completion latency and block errors",
4031 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
4032 .maxlen = FIO_IO_U_LIST_MAX_LEN,
4035 .category = FIO_OPT_C_STAT,
4036 .group = FIO_OPT_G_INVALID,
4039 #ifdef FIO_HAVE_DISK_UTIL
4041 .name = "disk_util",
4042 .lname = "Disk utilization",
4043 .type = FIO_OPT_BOOL,
4044 .off1 = offsetof(struct thread_options, do_disk_util),
4045 .help = "Log disk utilization statistics",
4047 .category = FIO_OPT_C_STAT,
4048 .group = FIO_OPT_G_INVALID,
4052 .name = "disk_util",
4053 .lname = "Disk utilization",
4054 .type = FIO_OPT_UNSUPPORTED,
4055 .help = "Your platform does not support disk utilization",
4059 .name = "gtod_reduce",
4060 .lname = "Reduce gettimeofday() calls",
4061 .type = FIO_OPT_BOOL,
4062 .help = "Greatly reduce number of gettimeofday() calls",
4063 .cb = str_gtod_reduce_cb,
4066 .category = FIO_OPT_C_STAT,
4067 .group = FIO_OPT_G_INVALID,
4070 .name = "disable_lat",
4071 .lname = "Disable all latency stats",
4072 .type = FIO_OPT_BOOL,
4073 .off1 = offsetof(struct thread_options, disable_lat),
4074 .help = "Disable latency numbers",
4075 .parent = "gtod_reduce",
4078 .category = FIO_OPT_C_STAT,
4079 .group = FIO_OPT_G_INVALID,
4082 .name = "disable_clat",
4083 .lname = "Disable completion latency stats",
4084 .type = FIO_OPT_BOOL,
4085 .off1 = offsetof(struct thread_options, disable_clat),
4086 .help = "Disable completion latency numbers",
4087 .parent = "gtod_reduce",
4090 .category = FIO_OPT_C_STAT,
4091 .group = FIO_OPT_G_INVALID,
4094 .name = "disable_slat",
4095 .lname = "Disable submission latency stats",
4096 .type = FIO_OPT_BOOL,
4097 .off1 = offsetof(struct thread_options, disable_slat),
4098 .help = "Disable submission latency numbers",
4099 .parent = "gtod_reduce",
4102 .category = FIO_OPT_C_STAT,
4103 .group = FIO_OPT_G_INVALID,
4106 .name = "disable_bw_measurement",
4107 .alias = "disable_bw",
4108 .lname = "Disable bandwidth stats",
4109 .type = FIO_OPT_BOOL,
4110 .off1 = offsetof(struct thread_options, disable_bw),
4111 .help = "Disable bandwidth logging",
4112 .parent = "gtod_reduce",
4115 .category = FIO_OPT_C_STAT,
4116 .group = FIO_OPT_G_INVALID,
4120 .lname = "Dedicated gettimeofday() CPU",
4121 .type = FIO_OPT_INT,
4122 .off1 = offsetof(struct thread_options, gtod_cpu),
4123 .help = "Set up dedicated gettimeofday() thread on this CPU",
4124 .verify = gtod_cpu_verify,
4125 .category = FIO_OPT_C_GENERAL,
4126 .group = FIO_OPT_G_CLOCK,
4129 .name = "unified_rw_reporting",
4130 .lname = "Unified RW Reporting",
4131 .type = FIO_OPT_BOOL,
4132 .off1 = offsetof(struct thread_options, unified_rw_rep),
4133 .help = "Unify reporting across data direction",
4135 .category = FIO_OPT_C_GENERAL,
4136 .group = FIO_OPT_G_INVALID,
4139 .name = "continue_on_error",
4140 .lname = "Continue on error",
4141 .type = FIO_OPT_STR,
4142 .off1 = offsetof(struct thread_options, continue_on_error),
4143 .help = "Continue on non-fatal errors during IO",
4145 .category = FIO_OPT_C_GENERAL,
4146 .group = FIO_OPT_G_ERR,
4149 .oval = ERROR_TYPE_NONE,
4150 .help = "Exit when an error is encountered",
4153 .oval = ERROR_TYPE_READ,
4154 .help = "Continue on read errors only",
4157 .oval = ERROR_TYPE_WRITE,
4158 .help = "Continue on write errors only",
4161 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
4162 .help = "Continue on any IO errors",
4165 .oval = ERROR_TYPE_VERIFY,
4166 .help = "Continue on verify errors only",
4169 .oval = ERROR_TYPE_ANY,
4170 .help = "Continue on all io and verify errors",
4173 .oval = ERROR_TYPE_NONE,
4174 .help = "Alias for 'none'",
4177 .oval = ERROR_TYPE_ANY,
4178 .help = "Alias for 'all'",
4183 .name = "ignore_error",
4184 .lname = "Ignore Error",
4185 .type = FIO_OPT_STR,
4186 .cb = str_ignore_error_cb,
4187 .off1 = offsetof(struct thread_options, ignore_error_nr),
4188 .help = "Set a specific list of errors to ignore",
4190 .category = FIO_OPT_C_GENERAL,
4191 .group = FIO_OPT_G_ERR,
4194 .name = "error_dump",
4195 .lname = "Error Dump",
4196 .type = FIO_OPT_BOOL,
4197 .off1 = offsetof(struct thread_options, error_dump),
4199 .help = "Dump info on each error",
4200 .category = FIO_OPT_C_GENERAL,
4201 .group = FIO_OPT_G_ERR,
4206 .type = FIO_OPT_STR_STORE,
4207 .off1 = offsetof(struct thread_options, profile),
4208 .help = "Select a specific builtin performance test",
4209 .category = FIO_OPT_C_PROFILE,
4210 .group = FIO_OPT_G_INVALID,
4215 .type = FIO_OPT_STR_STORE,
4216 .off1 = offsetof(struct thread_options, cgroup),
4217 .help = "Add job to cgroup of this name",
4218 .category = FIO_OPT_C_GENERAL,
4219 .group = FIO_OPT_G_CGROUP,
4222 .name = "cgroup_nodelete",
4223 .lname = "Cgroup no-delete",
4224 .type = FIO_OPT_BOOL,
4225 .off1 = offsetof(struct thread_options, cgroup_nodelete),
4226 .help = "Do not delete cgroups after job completion",
4229 .category = FIO_OPT_C_GENERAL,
4230 .group = FIO_OPT_G_CGROUP,
4233 .name = "cgroup_weight",
4234 .lname = "Cgroup weight",
4235 .type = FIO_OPT_INT,
4236 .off1 = offsetof(struct thread_options, cgroup_weight),
4237 .help = "Use given weight for cgroup",
4241 .category = FIO_OPT_C_GENERAL,
4242 .group = FIO_OPT_G_CGROUP,
4247 .type = FIO_OPT_INT,
4248 .off1 = offsetof(struct thread_options, uid),
4249 .help = "Run job with this user ID",
4250 .category = FIO_OPT_C_GENERAL,
4251 .group = FIO_OPT_G_CRED,
4255 .lname = "Group ID",
4256 .type = FIO_OPT_INT,
4257 .off1 = offsetof(struct thread_options, gid),
4258 .help = "Run job with this group ID",
4259 .category = FIO_OPT_C_GENERAL,
4260 .group = FIO_OPT_G_CRED,
4265 .type = FIO_OPT_INT,
4266 .off1 = offsetof(struct thread_options, kb_base),
4272 .help = "Inputs invert IEC and SI prefixes (for compatibility); outputs prefer binary",
4276 .help = "Inputs use IEC and SI prefixes; outputs prefer SI",
4279 .help = "Unit prefix interpretation for quantities of data (IEC and SI)",
4280 .category = FIO_OPT_C_GENERAL,
4281 .group = FIO_OPT_G_INVALID,
4284 .name = "unit_base",
4285 .lname = "Unit for quantities of data (Bits or Bytes)",
4286 .type = FIO_OPT_INT,
4287 .off1 = offsetof(struct thread_options, unit_base),
4292 .help = "Auto-detect",
4296 .help = "Normal (byte based)",
4300 .help = "Bit based",
4303 .help = "Bit multiple of result summary data (8 for byte, 1 for bit)",
4304 .category = FIO_OPT_C_GENERAL,
4305 .group = FIO_OPT_G_INVALID,
4308 .name = "hugepage-size",
4309 .lname = "Hugepage size",
4310 .type = FIO_OPT_INT,
4311 .off1 = offsetof(struct thread_options, hugepage_size),
4312 .help = "When using hugepages, specify size of each page",
4313 .def = __fio_stringify(FIO_HUGE_PAGE),
4314 .interval = 1024 * 1024,
4315 .category = FIO_OPT_C_GENERAL,
4316 .group = FIO_OPT_G_INVALID,
4320 .lname = "I/O flow ID",
4321 .type = FIO_OPT_INT,
4322 .off1 = offsetof(struct thread_options, flow_id),
4323 .help = "The flow index ID to use",
4325 .category = FIO_OPT_C_IO,
4326 .group = FIO_OPT_G_IO_FLOW,
4330 .lname = "I/O flow weight",
4331 .type = FIO_OPT_INT,
4332 .off1 = offsetof(struct thread_options, flow),
4333 .help = "Weight for flow control of this job",
4334 .parent = "flow_id",
4337 .category = FIO_OPT_C_IO,
4338 .group = FIO_OPT_G_IO_FLOW,
4341 .name = "flow_watermark",
4342 .lname = "I/O flow watermark",
4343 .type = FIO_OPT_INT,
4344 .off1 = offsetof(struct thread_options, flow_watermark),
4345 .help = "High watermark for flow control. This option"
4346 " should be set to the same value for all threads"
4347 " with non-zero flow.",
4348 .parent = "flow_id",
4351 .category = FIO_OPT_C_IO,
4352 .group = FIO_OPT_G_IO_FLOW,
4355 .name = "flow_sleep",
4356 .lname = "I/O flow sleep",
4357 .type = FIO_OPT_INT,
4358 .off1 = offsetof(struct thread_options, flow_sleep),
4359 .help = "How many microseconds to sleep after being held"
4360 " back by the flow control mechanism",
4361 .parent = "flow_id",
4364 .category = FIO_OPT_C_IO,
4365 .group = FIO_OPT_G_IO_FLOW,
4369 .lname = "Skip operations against bad blocks",
4370 .type = FIO_OPT_BOOL,
4371 .off1 = offsetof(struct thread_options, skip_bad),
4372 .help = "Skip operations against known bad blocks.",
4375 .category = FIO_OPT_C_IO,
4376 .group = FIO_OPT_G_MTD,
4379 .name = "steadystate",
4380 .lname = "Steady state threshold",
4382 .type = FIO_OPT_STR,
4383 .off1 = offsetof(struct thread_options, ss_state),
4384 .cb = str_steadystate_cb,
4385 .help = "Define the criterion and limit to judge when a job has reached steady state",
4386 .def = "iops_slope:0.01%",
4389 .oval = FIO_SS_IOPS,
4390 .help = "maximum mean deviation of IOPS measurements",
4392 { .ival = "iops_slope",
4393 .oval = FIO_SS_IOPS_SLOPE,
4394 .help = "slope calculated from IOPS measurements",
4398 .help = "maximum mean deviation of bandwidth measurements",
4402 .oval = FIO_SS_BW_SLOPE,
4403 .help = "slope calculated from bandwidth measurements",
4406 .category = FIO_OPT_C_GENERAL,
4407 .group = FIO_OPT_G_RUNTIME,
4410 .name = "steadystate_duration",
4411 .lname = "Steady state duration",
4413 .parent = "steadystate",
4414 .type = FIO_OPT_STR_VAL_TIME,
4415 .off1 = offsetof(struct thread_options, ss_dur),
4416 .help = "Stop workload upon attaining steady state for specified duration",
4420 .category = FIO_OPT_C_GENERAL,
4421 .group = FIO_OPT_G_RUNTIME,
4424 .name = "steadystate_ramp_time",
4425 .lname = "Steady state ramp time",
4427 .parent = "steadystate",
4428 .type = FIO_OPT_STR_VAL_TIME,
4429 .off1 = offsetof(struct thread_options, ss_ramp_time),
4430 .help = "Delay before initiation of data collection for steady state job termination testing",
4434 .category = FIO_OPT_C_GENERAL,
4435 .group = FIO_OPT_G_RUNTIME,
4442 static void add_to_lopt(struct option *lopt, struct fio_option *o,
4443 const char *name, int val)
4445 lopt->name = (char *) name;
4447 if (o->type == FIO_OPT_STR_SET)
4448 lopt->has_arg = optional_argument;
4450 lopt->has_arg = required_argument;
4453 static void options_to_lopts(struct fio_option *opts,
4454 struct option *long_options,
4455 int i, int option_type)
4457 struct fio_option *o = &opts[0];
4459 add_to_lopt(&long_options[i], o, o->name, option_type);
4462 add_to_lopt(&long_options[i], o, o->alias, option_type);
4467 assert(i < FIO_NR_OPTIONS);
4471 void fio_options_set_ioengine_opts(struct option *long_options,
4472 struct thread_data *td)
4477 while (long_options[i].name) {
4478 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
4479 memset(&long_options[i], 0, sizeof(*long_options));
4486 * Just clear out the prior ioengine options.
4491 options_to_lopts(td->io_ops->options, long_options, i,
4492 FIO_GETOPT_IOENGINE);
4495 void fio_options_dup_and_init(struct option *long_options)
4499 options_init(fio_options);
4502 while (long_options[i].name)
4505 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
4508 struct fio_keyword {
4514 static struct fio_keyword fio_keywords[] = {
4516 .word = "$pagesize",
4517 .desc = "Page size in the system",
4520 .word = "$mb_memory",
4521 .desc = "Megabytes of memory online",
4525 .desc = "Number of CPUs online in the system",
4532 void fio_keywords_exit(void)
4534 struct fio_keyword *kw;
4536 kw = &fio_keywords[0];
4544 void fio_keywords_init(void)
4546 unsigned long long mb_memory;
4550 sprintf(buf, "%lu", (unsigned long) page_size);
4551 fio_keywords[0].replace = strdup(buf);
4553 mb_memory = os_phys_mem() / (1024 * 1024);
4554 sprintf(buf, "%llu", mb_memory);
4555 fio_keywords[1].replace = strdup(buf);
4558 sprintf(buf, "%lu", l);
4559 fio_keywords[2].replace = strdup(buf);
4564 static char *bc_calc(char *str)
4566 char buf[128], *tmp;
4571 * No math, just return string
4573 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
4574 !strchr(str, '/')) || strchr(str, '\''))
4578 * Split option from value, we only need to calculate the value
4580 tmp = strchr(str, '=');
4587 * Prevent buffer overflows; such a case isn't reasonable anyway
4589 if (strlen(str) >= 128 || strlen(tmp) > 100)
4592 sprintf(buf, "which %s > /dev/null", BC_APP);
4594 log_err("fio: bc is needed for performing math\n");
4598 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
4599 f = popen(buf, "r");
4603 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
4610 buf[(tmp - str) + ret - 1] = '\0';
4611 memcpy(buf, str, tmp - str);
4617 * Return a copy of the input string with substrings of the form ${VARNAME}
4618 * substituted with the value of the environment variable VARNAME. The
4619 * substitution always occurs, even if VARNAME is empty or the corresponding
4620 * environment variable undefined.
4622 static char *option_dup_subs(const char *opt)
4624 char out[OPT_LEN_MAX+1];
4625 char in[OPT_LEN_MAX+1];
4628 char *ch1, *ch2, *env;
4629 ssize_t nchr = OPT_LEN_MAX;
4632 if (strlen(opt) + 1 > OPT_LEN_MAX) {
4633 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
4637 in[OPT_LEN_MAX] = '\0';
4638 strncpy(in, opt, OPT_LEN_MAX);
4640 while (*inptr && nchr > 0) {
4641 if (inptr[0] == '$' && inptr[1] == '{') {
4642 ch2 = strchr(inptr, '}');
4643 if (ch2 && inptr+1 < ch2) {
4650 envlen = strlen(env);
4651 if (envlen <= nchr) {
4652 memcpy(outptr, env, envlen);
4662 *outptr++ = *inptr++;
4671 * Look for reserved variable names and replace them with real values
4673 static char *fio_keyword_replace(char *opt)
4679 for (i = 0; fio_keywords[i].word != NULL; i++) {
4680 struct fio_keyword *kw = &fio_keywords[i];
4682 while ((s = strstr(opt, kw->word)) != NULL) {
4683 char *new = malloc(strlen(opt) + 1);
4689 * Copy part of the string before the keyword and
4690 * sprintf() the replacement after it.
4692 memcpy(new, opt, olen);
4693 len = sprintf(new + olen, "%s", kw->replace);
4696 * If there's more in the original string, copy that
4699 opt += strlen(kw->word) + olen;
4701 memcpy(new + olen + len, opt, opt - o_org - 1);
4704 * replace opt and free the old opt
4714 * Check for potential math and invoke bc, if possible
4722 static char **dup_and_sub_options(char **opts, int num_opts)
4725 char **opts_copy = malloc(num_opts * sizeof(*opts));
4726 for (i = 0; i < num_opts; i++) {
4727 opts_copy[i] = option_dup_subs(opts[i]);
4730 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
4735 static void show_closest_option(const char *opt)
4737 int best_option, best_distance;
4746 while (name[i] != '\0' && name[i] != '=')
4751 best_distance = INT_MAX;
4753 while (fio_options[i].name) {
4754 distance = string_distance(name, fio_options[i].name);
4755 if (distance < best_distance) {
4756 best_distance = distance;
4762 if (best_option != -1 && string_distance_ok(name, best_distance) &&
4763 fio_options[best_option].type != FIO_OPT_UNSUPPORTED)
4764 log_err("Did you mean %s?\n", fio_options[best_option].name);
4769 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
4771 int i, ret, unknown;
4774 sort_options(opts, fio_options, num_opts);
4775 opts_copy = dup_and_sub_options(opts, num_opts);
4777 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
4778 struct fio_option *o;
4779 int newret = parse_option(opts_copy[i], opts[i], fio_options,
4780 &o, &td->o, &td->opt_list);
4783 fio_option_mark_set(&td->o, o);
4791 opts_copy[i] = NULL;
4798 ret |= ioengine_load(td);
4800 sort_options(opts_copy, td->io_ops->options, num_opts);
4803 for (i = 0; i < num_opts; i++) {
4804 struct fio_option *o = NULL;
4811 newret = parse_option(opts_copy[i], opts[i],
4812 td->io_ops->options, &o,
4813 td->eo, &td->opt_list);
4817 log_err("Bad option <%s>\n", opts[i]);
4818 show_closest_option(opts[i]);
4821 opts_copy[i] = NULL;
4829 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
4833 ret = parse_cmd_option(opt, val, fio_options, &td->o, &td->opt_list);
4835 struct fio_option *o;
4837 o = find_option(fio_options, opt);
4839 fio_option_mark_set(&td->o, o);
4845 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
4848 return parse_cmd_option(opt, val, td->io_ops->options, td->eo,
4852 void fio_fill_default_options(struct thread_data *td)
4854 td->o.magic = OPT_MAGIC;
4855 fill_default_options(&td->o, fio_options);
4858 int fio_show_option_help(const char *opt)
4860 return show_cmd_help(fio_options, opt);
4864 * dupe FIO_OPT_STR_STORE options
4866 void fio_options_mem_dupe(struct thread_data *td)
4868 options_mem_dupe(fio_options, &td->o);
4870 if (td->eo && td->io_ops) {
4871 void *oldeo = td->eo;
4873 td->eo = malloc(td->io_ops->option_struct_size);
4874 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
4875 options_mem_dupe(td->io_ops->options, td->eo);
4879 unsigned int fio_get_kb_base(void *data)
4881 struct thread_data *td = cb_data_to_td(data);
4882 struct thread_options *o = &td->o;
4883 unsigned int kb_base = 0;
4886 * This is a hack... For private options, *data is not holding
4887 * a pointer to the thread_options, but to private data. This means
4888 * we can't safely dereference it, but magic is first so mem wise
4889 * it is valid. But this also means that if the job first sets
4890 * kb_base and expects that to be honored by private options,
4891 * it will be disappointed. We will return the global default
4894 if (o && o->magic == OPT_MAGIC)
4895 kb_base = o->kb_base;
4902 int add_option(struct fio_option *o)
4904 struct fio_option *__o;
4913 if (opt_index + 1 == FIO_MAX_OPTS) {
4914 log_err("fio: FIO_MAX_OPTS is too small\n");
4918 memcpy(&fio_options[opt_index], o, sizeof(*o));
4919 fio_options[opt_index + 1].name = NULL;
4923 void invalidate_profile_options(const char *prof_name)
4925 struct fio_option *o;
4929 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
4930 o->type = FIO_OPT_INVALID;
4931 o->prof_name = NULL;
4937 void add_opt_posval(const char *optname, const char *ival, const char *help)
4939 struct fio_option *o;
4942 o = find_option(fio_options, optname);
4946 for (i = 0; i < PARSE_MAX_VP; i++) {
4947 if (o->posval[i].ival)
4950 o->posval[i].ival = ival;
4951 o->posval[i].help = help;
4956 void del_opt_posval(const char *optname, const char *ival)
4958 struct fio_option *o;
4961 o = find_option(fio_options, optname);
4965 for (i = 0; i < PARSE_MAX_VP; i++) {
4966 if (!o->posval[i].ival)
4968 if (strcmp(o->posval[i].ival, ival))
4971 o->posval[i].ival = NULL;
4972 o->posval[i].help = NULL;
4976 void fio_options_free(struct thread_data *td)
4978 options_free(fio_options, &td->o);
4979 if (td->eo && td->io_ops && td->io_ops->options) {
4980 options_free(td->io_ops->options, td->eo);
4986 struct fio_option *fio_option_find(const char *name)
4988 return find_option(fio_options, name);
4991 static struct fio_option *find_next_opt(struct thread_options *o,
4992 struct fio_option *from,
4995 struct fio_option *opt;
4998 from = &fio_options[0];
5004 if (off1 == from->off1) {
5009 } while (from->name);
5014 static int opt_is_set(struct thread_options *o, struct fio_option *opt)
5016 unsigned int opt_off, index, offset;
5018 opt_off = opt - &fio_options[0];
5019 index = opt_off / (8 * sizeof(uint64_t));
5020 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5021 return (o->set_options[index] & ((uint64_t)1 << offset)) != 0;
5024 bool __fio_option_is_set(struct thread_options *o, unsigned int off1)
5026 struct fio_option *opt, *next;
5029 while ((opt = find_next_opt(o, next, off1)) != NULL) {
5030 if (opt_is_set(o, opt))
5039 void fio_option_mark_set(struct thread_options *o, struct fio_option *opt)
5041 unsigned int opt_off, index, offset;
5043 opt_off = opt - &fio_options[0];
5044 index = opt_off / (8 * sizeof(uint64_t));
5045 offset = opt_off & ((8 * sizeof(uint64_t)) - 1);
5046 o->set_options[index] |= (uint64_t)1 << offset;