18 #include "crc/crc32c.h"
21 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
23 static char *get_opt_postfix(const char *str)
25 char *p = strstr(str, ":");
31 strip_blank_front(&p);
36 static int converthexchartoint(char a)
56 static int bs_cmp(const void *p1, const void *p2)
58 const struct bssplit *bsp1 = p1;
59 const struct bssplit *bsp2 = p2;
61 return bsp1->perc < bsp2->perc;
64 static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
66 struct bssplit *bssplit;
67 unsigned int i, perc, perc_missing;
68 unsigned int max_bs, min_bs;
72 td->o.bssplit_nr[ddir] = 4;
73 bssplit = malloc(4 * sizeof(struct bssplit));
78 while ((fname = strsep(&str, ":")) != NULL) {
85 * grow struct buffer, if needed
87 if (i == td->o.bssplit_nr[ddir]) {
88 td->o.bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
90 * sizeof(struct bssplit));
93 perc_str = strstr(fname, "/");
97 perc = atoi(perc_str);
105 if (str_to_decimal(fname, &val, 1, td)) {
106 log_err("fio: bssplit conversion failed\n");
117 bssplit[i].perc = perc;
121 td->o.bssplit_nr[ddir] = i;
124 * Now check if the percentages add up, and how much is missing
126 perc = perc_missing = 0;
127 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
128 struct bssplit *bsp = &bssplit[i];
130 if (bsp->perc == (unsigned char) -1)
137 log_err("fio: bssplit percentages add to more than 100%%\n");
142 * If values didn't have a percentage set, divide the remains between
146 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
147 struct bssplit *bsp = &bssplit[i];
149 if (bsp->perc == (unsigned char) -1)
150 bsp->perc = (100 - perc) / perc_missing;
154 td->o.min_bs[ddir] = min_bs;
155 td->o.max_bs[ddir] = max_bs;
158 * now sort based on percentages, for ease of lookup
160 qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 td->o.bssplit[ddir] = bssplit;
166 static int str_bssplit_cb(void *data, const char *input)
168 struct thread_data *td = data;
169 char *str, *p, *odir, *ddir;
172 p = str = strdup(input);
174 strip_blank_front(&str);
175 strip_blank_end(str);
177 odir = strchr(str, ',');
179 ddir = strchr(odir + 1, ',');
181 ret = bssplit_ddir(td, DDIR_TRIM, ddir + 1);
187 op = strdup(odir + 1);
188 ret = bssplit_ddir(td, DDIR_TRIM, op);
193 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
196 ret = bssplit_ddir(td, DDIR_READ, str);
202 ret = bssplit_ddir(td, DDIR_WRITE, op);
207 ret = bssplit_ddir(td, DDIR_TRIM, op);
210 ret = bssplit_ddir(td, DDIR_READ, str);
217 static int str2error(char *str)
219 const char * err[] = {"EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
220 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
221 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
222 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
223 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
224 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
225 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
226 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE"};
227 int i = 0, num = sizeof(err) / sizeof(void *);
230 if (!strcmp(err[i], str))
237 static int ignore_error_type(struct thread_data *td, int etype, char *str)
243 if (etype >= ERROR_TYPE_CNT) {
244 log_err("Illegal error type\n");
248 td->o.ignore_error_nr[etype] = 4;
249 error = malloc(4 * sizeof(struct bssplit));
252 while ((fname = strsep(&str, ":")) != NULL) {
258 * grow struct buffer, if needed
260 if (i == td->o.ignore_error_nr[etype]) {
261 td->o.ignore_error_nr[etype] <<= 1;
262 error = realloc(error, td->o.ignore_error_nr[etype]
265 if (fname[0] == 'E') {
266 error[i] = str2error(fname);
268 error[i] = atoi(fname);
273 log_err("Unknown error %s, please use number value \n",
280 td->o.continue_on_error |= 1 << etype;
281 td->o.ignore_error_nr[etype] = i;
282 td->o.ignore_error[etype] = error;
288 static int str_ignore_error_cb(void *data, const char *input)
290 struct thread_data *td = data;
292 int type = 0, ret = 1;
293 p = str = strdup(input);
295 strip_blank_front(&str);
296 strip_blank_end(str);
302 ret = ignore_error_type(td, type, p);
312 static int str_rw_cb(void *data, const char *str)
314 struct thread_data *td = data;
315 char *nr = get_opt_postfix(str);
317 td->o.ddir_seq_nr = 1;
318 td->o.ddir_seq_add = 0;
324 td->o.ddir_seq_nr = atoi(nr);
328 if (str_to_decimal(nr, &val, 1, td)) {
329 log_err("fio: rw postfix parsing failed\n");
334 td->o.ddir_seq_add = val;
341 static int str_mem_cb(void *data, const char *mem)
343 struct thread_data *td = data;
345 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP)
346 td->mmapfile = get_opt_postfix(mem);
351 static int str_verify_cb(void *data, const char *mem)
353 struct thread_data *td = data;
355 if (td->o.verify == VERIFY_CRC32C_INTEL ||
356 td->o.verify == VERIFY_CRC32C) {
357 crc32c_intel_probe();
363 static int fio_clock_source_cb(void *data, const char *str)
365 struct thread_data *td = data;
367 fio_clock_source = td->o.clocksource;
368 fio_clock_source_set = 1;
373 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
379 static int str_rwmix_read_cb(void *data, unsigned long long *val)
381 struct thread_data *td = data;
383 td->o.rwmix[DDIR_READ] = *val;
384 td->o.rwmix[DDIR_WRITE] = 100 - *val;
388 static int str_rwmix_write_cb(void *data, unsigned long long *val)
390 struct thread_data *td = data;
392 td->o.rwmix[DDIR_WRITE] = *val;
393 td->o.rwmix[DDIR_READ] = 100 - *val;
397 #ifdef FIO_HAVE_IOPRIO
398 static int str_prioclass_cb(void *data, unsigned long long *val)
400 struct thread_data *td = data;
404 * mask off old class bits, str_prio_cb() may have set a default class
406 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
409 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
414 static int str_prio_cb(void *data, unsigned long long *val)
416 struct thread_data *td = data;
421 * If no class is set, assume BE
423 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
424 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
431 static int str_exitall_cb(void)
433 exitall_on_terminate = 1;
437 #ifdef FIO_HAVE_CPU_AFFINITY
438 static int str_cpumask_cb(void *data, unsigned long long *val)
440 struct thread_data *td = data;
445 ret = fio_cpuset_init(&td->o.cpumask);
447 log_err("fio: cpuset_init failed\n");
448 td_verror(td, ret, "fio_cpuset_init");
452 max_cpu = cpus_online();
454 for (i = 0; i < sizeof(int) * 8; i++) {
455 if ((1 << i) & *val) {
457 log_err("fio: CPU %d too large (max=%ld)\n", i,
461 dprint(FD_PARSE, "set cpu allowed %d\n", i);
462 fio_cpu_set(&td->o.cpumask, i);
466 td->o.cpumask_set = 1;
470 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
477 ret = fio_cpuset_init(mask);
479 log_err("fio: cpuset_init failed\n");
480 td_verror(td, ret, "fio_cpuset_init");
484 p = str = strdup(input);
486 strip_blank_front(&str);
487 strip_blank_end(str);
489 max_cpu = cpus_online();
491 while ((cpu = strsep(&str, ",")) != NULL) {
500 while ((cpu2 = strsep(&str2, "-")) != NULL) {
510 while (icpu <= icpu2) {
511 if (icpu >= FIO_MAX_CPUS) {
512 log_err("fio: your OS only supports up to"
513 " %d CPUs\n", (int) FIO_MAX_CPUS);
517 if (icpu > max_cpu) {
518 log_err("fio: CPU %d too large (max=%ld)\n",
524 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
525 fio_cpu_set(mask, icpu);
534 td->o.cpumask_set = 1;
538 static int str_cpus_allowed_cb(void *data, const char *input)
540 struct thread_data *td = data;
543 ret = set_cpus_allowed(td, &td->o.cpumask, input);
545 td->o.cpumask_set = 1;
550 static int str_verify_cpus_allowed_cb(void *data, const char *input)
552 struct thread_data *td = data;
555 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
557 td->o.verify_cpumask_set = 1;
563 #ifdef CONFIG_LIBNUMA
564 static int str_numa_cpunodes_cb(void *data, char *input)
566 struct thread_data *td = data;
568 /* numa_parse_nodestring() parses a character string list
569 * of nodes into a bit mask. The bit mask is allocated by
570 * numa_allocate_nodemask(), so it should be freed by
571 * numa_free_nodemask().
573 td->o.numa_cpunodesmask = numa_parse_nodestring(input);
574 if (td->o.numa_cpunodesmask == NULL) {
575 log_err("fio: numa_parse_nodestring failed\n");
576 td_verror(td, 1, "str_numa_cpunodes_cb");
580 td->o.numa_cpumask_set = 1;
584 static int str_numa_mpol_cb(void *data, char *input)
586 struct thread_data *td = data;
587 const char * const policy_types[] =
588 { "default", "prefer", "bind", "interleave", "local" };
591 char *nodelist = strchr(input, ':');
593 /* NUL-terminate mode */
597 for (i = 0; i <= MPOL_LOCAL; i++) {
598 if (!strcmp(input, policy_types[i])) {
599 td->o.numa_mem_mode = i;
603 if (i > MPOL_LOCAL) {
604 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
608 switch (td->o.numa_mem_mode) {
611 * Insist on a nodelist of one node only
614 char *rest = nodelist;
615 while (isdigit(*rest))
618 log_err("fio: one node only for \'prefer\'\n");
622 log_err("fio: one node is needed for \'prefer\'\n");
626 case MPOL_INTERLEAVE:
628 * Default to online nodes with memory if no nodelist
631 nodelist = strdup("all");
636 * Don't allow a nodelist
639 log_err("fio: NO nodelist for \'local\'\n");
645 * Insist on a nodelist
648 log_err("fio: a nodelist is needed for \'bind\'\n");
655 /* numa_parse_nodestring() parses a character string list
656 * of nodes into a bit mask. The bit mask is allocated by
657 * numa_allocate_nodemask(), so it should be freed by
658 * numa_free_nodemask().
660 switch (td->o.numa_mem_mode) {
662 td->o.numa_mem_prefer_node = atoi(nodelist);
664 case MPOL_INTERLEAVE:
666 td->o.numa_memnodesmask = numa_parse_nodestring(nodelist);
667 if (td->o.numa_memnodesmask == NULL) {
668 log_err("fio: numa_parse_nodestring failed\n");
669 td_verror(td, 1, "str_numa_memnodes_cb");
679 td->o.numa_memmask_set = 1;
688 static int str_verify_trim_cb(void *data, unsigned long long *val)
690 struct thread_data *td = data;
692 td->o.trim_percentage = *val;
697 static int str_fst_cb(void *data, const char *str)
699 struct thread_data *td = data;
700 char *nr = get_opt_postfix(str);
702 td->file_service_nr = 1;
704 td->file_service_nr = atoi(nr);
711 #ifdef CONFIG_SYNC_FILE_RANGE
712 static int str_sfr_cb(void *data, const char *str)
714 struct thread_data *td = data;
715 char *nr = get_opt_postfix(str);
717 td->sync_file_range_nr = 1;
719 td->sync_file_range_nr = atoi(nr);
727 static int str_random_distribution_cb(void *data, const char *str)
729 struct thread_data *td = data;
733 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
735 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
740 nr = get_opt_postfix(str);
741 if (nr && !str_to_float(nr, &val)) {
742 log_err("fio: random postfix parsing failed\n");
749 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
751 log_err("fio: zipf theta must different than 1.0\n");
754 td->o.zipf_theta = val;
756 if (val <= 0.00 || val >= 1.00) {
757 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
760 td->o.pareto_h = val;
766 static int check_dir(struct thread_data *td, char *fname)
769 char file[PATH_MAX], *dir;
772 if (td->o.directory) {
773 strcpy(file, td->o.directory);
778 sprintf(file + elen, "%s", fname);
784 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
785 * yet, so we can't do this check right here...
787 if (lstat(dir, &sb) < 0) {
790 log_err("fio: %s is not a directory\n", dir);
791 td_verror(td, ret, "lstat");
795 if (!S_ISDIR(sb.st_mode)) {
796 log_err("fio: %s is not a directory\n", dir);
806 * Return next file in the string. Files are separated with ':'. If the ':'
807 * is escaped with a '\', then that ':' is part of the filename and does not
808 * indicate a new file.
810 static char *get_next_file_name(char **ptr)
815 if (!str || !strlen(str))
821 * No colon, we are done
823 p = strchr(str, ':');
830 * We got a colon, but it's the first character. Skip and
838 if (*(p - 1) != '\\') {
844 memmove(p - 1, p, strlen(p) + 1);
851 static int str_filename_cb(void *data, const char *input)
853 struct thread_data *td = data;
854 char *fname, *str, *p;
856 p = str = strdup(input);
858 strip_blank_front(&str);
859 strip_blank_end(str);
861 if (!td->files_index)
864 while ((fname = get_next_file_name(&str)) != NULL) {
867 if (check_dir(td, fname)) {
879 static int str_directory_cb(void *data, const char fio_unused *str)
881 struct thread_data *td = data;
884 if (lstat(td->o.directory, &sb) < 0) {
887 log_err("fio: %s is not a directory\n", td->o.directory);
888 td_verror(td, ret, "lstat");
891 if (!S_ISDIR(sb.st_mode)) {
892 log_err("fio: %s is not a directory\n", td->o.directory);
899 static int str_opendir_cb(void *data, const char fio_unused *str)
901 struct thread_data *td = data;
903 if (!td->files_index)
906 return add_dir_files(td, td->o.opendir);
909 static int str_verify_offset_cb(void *data, unsigned long long *off)
911 struct thread_data *td = data;
913 if (*off && *off < sizeof(struct verify_header)) {
914 log_err("fio: verify_offset too small\n");
918 td->o.verify_offset = *off;
922 static int str_verify_pattern_cb(void *data, const char *input)
924 struct thread_data *td = data;
926 int i = 0, j = 0, len, k, base = 10;
929 loc1 = strstr(input, "0x");
930 loc2 = strstr(input, "0X");
933 off = strtol(input, NULL, base);
934 if (off != LONG_MAX || errno != ERANGE) {
936 td->o.verify_pattern[i] = off & 0xff;
945 j = loc1 - input + 2;
947 j = loc2 - input + 2;
950 if (len - j < MAX_PATTERN_SIZE * 2) {
952 off = converthexchartoint(input[k--]);
954 off += (converthexchartoint(input[k--])
956 td->o.verify_pattern[i++] = (char) off;
962 * Fill the pattern all the way to the end. This greatly reduces
963 * the number of memcpy's we have to do when verifying the IO.
965 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
966 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
971 * The code in verify_io_u_pattern assumes a single byte pattern
972 * fills the whole verify pattern buffer.
974 memset(td->o.verify_pattern, td->o.verify_pattern[0],
978 td->o.verify_pattern_bytes = i;
981 * VERIFY_META could already be set
983 if (td->o.verify == VERIFY_NONE)
984 td->o.verify = VERIFY_PATTERN;
989 static int str_write_bw_log_cb(void *data, const char *str)
991 struct thread_data *td = data;
994 td->o.bw_log_file = strdup(str);
996 td->o.write_bw_log = 1;
1000 static int str_write_lat_log_cb(void *data, const char *str)
1002 struct thread_data *td = data;
1005 td->o.lat_log_file = strdup(str);
1007 td->o.write_lat_log = 1;
1011 static int str_write_iops_log_cb(void *data, const char *str)
1013 struct thread_data *td = data;
1016 td->o.iops_log_file = strdup(str);
1018 td->o.write_iops_log = 1;
1022 static int str_gtod_reduce_cb(void *data, int *il)
1024 struct thread_data *td = data;
1027 td->o.disable_lat = !!val;
1028 td->o.disable_clat = !!val;
1029 td->o.disable_slat = !!val;
1030 td->o.disable_bw = !!val;
1031 td->o.clat_percentiles = !val;
1033 td->tv_cache_mask = 63;
1038 static int str_gtod_cpu_cb(void *data, long long *il)
1040 struct thread_data *td = data;
1043 td->o.gtod_cpu = val;
1044 td->o.gtod_offload = 1;
1048 static int str_size_cb(void *data, unsigned long long *__val)
1050 struct thread_data *td = data;
1051 unsigned long long v = *__val;
1053 if (parse_is_percent(v)) {
1055 td->o.size_percent = -1ULL - v;
1062 static int rw_verify(struct fio_option *o, void *data)
1064 struct thread_data *td = data;
1066 if (read_only && td_write(td)) {
1067 log_err("fio: job <%s> has write bit set, but fio is in"
1068 " read-only mode\n", td->o.name);
1075 static int gtod_cpu_verify(struct fio_option *o, void *data)
1077 #ifndef FIO_HAVE_CPU_AFFINITY
1078 struct thread_data *td = data;
1080 if (td->o.gtod_cpu) {
1081 log_err("fio: platform must support CPU affinity for"
1082 "gettimeofday() offloading\n");
1090 static int kb_base_verify(struct fio_option *o, void *data)
1092 struct thread_data *td = data;
1094 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
1095 log_err("fio: kb_base set to nonsensical value: %u\n",
1104 * Map of job/command line options
1106 static struct fio_option options[FIO_MAX_OPTS] = {
1108 .name = "description",
1109 .type = FIO_OPT_STR_STORE,
1110 .off1 = td_var_offset(description),
1111 .help = "Text job description",
1115 .type = FIO_OPT_STR_STORE,
1116 .off1 = td_var_offset(name),
1117 .help = "Name of this job",
1120 .name = "directory",
1121 .type = FIO_OPT_STR_STORE,
1122 .off1 = td_var_offset(directory),
1123 .cb = str_directory_cb,
1124 .help = "Directory to store files in",
1128 .type = FIO_OPT_STR_STORE,
1129 .off1 = td_var_offset(filename),
1130 .cb = str_filename_cb,
1131 .prio = -1, /* must come after "directory" */
1132 .help = "File(s) to use for the workload",
1136 .type = FIO_OPT_INT,
1137 .off1 = td_var_offset(kb_base),
1138 .verify = kb_base_verify,
1141 .help = "How many bytes per KB for reporting (1000 or 1024)",
1145 .type = FIO_OPT_STR,
1146 .off1 = td_var_offset(file_lock_mode),
1147 .help = "Lock file when doing IO to it",
1148 .parent = "filename",
1152 .oval = FILE_LOCK_NONE,
1153 .help = "No file locking",
1155 { .ival = "exclusive",
1156 .oval = FILE_LOCK_EXCLUSIVE,
1157 .help = "Exclusive file lock",
1160 .ival = "readwrite",
1161 .oval = FILE_LOCK_READWRITE,
1162 .help = "Read vs write lock",
1168 .type = FIO_OPT_STR_STORE,
1169 .off1 = td_var_offset(opendir),
1170 .cb = str_opendir_cb,
1171 .help = "Recursively add files from this directory and down",
1175 .alias = "readwrite",
1176 .type = FIO_OPT_STR,
1178 .off1 = td_var_offset(td_ddir),
1179 .help = "IO direction",
1181 .verify = rw_verify,
1184 .oval = TD_DDIR_READ,
1185 .help = "Sequential read",
1188 .oval = TD_DDIR_WRITE,
1189 .help = "Sequential write",
1192 .oval = TD_DDIR_TRIM,
1193 .help = "Sequential trim",
1195 { .ival = "randread",
1196 .oval = TD_DDIR_RANDREAD,
1197 .help = "Random read",
1199 { .ival = "randwrite",
1200 .oval = TD_DDIR_RANDWRITE,
1201 .help = "Random write",
1203 { .ival = "randtrim",
1204 .oval = TD_DDIR_RANDTRIM,
1205 .help = "Random trim",
1209 .help = "Sequential read and write mix",
1211 { .ival = "readwrite",
1213 .help = "Sequential read and write mix",
1216 .oval = TD_DDIR_RANDRW,
1217 .help = "Random read and write mix"
1222 .name = "rw_sequencer",
1223 .type = FIO_OPT_STR,
1224 .off1 = td_var_offset(rw_seq),
1225 .help = "IO offset generator modifier",
1226 .def = "sequential",
1228 { .ival = "sequential",
1230 .help = "Generate sequential offsets",
1232 { .ival = "identical",
1233 .oval = RW_SEQ_IDENT,
1234 .help = "Generate identical offsets",
1241 .type = FIO_OPT_STR_STORE,
1242 .off1 = td_var_offset(ioengine),
1243 .help = "IO engine to use",
1244 .def = FIO_PREFERRED_ENGINE,
1247 .help = "Use read/write",
1250 .help = "Use pread/pwrite",
1253 .help = "Use readv/writev",
1255 #ifdef CONFIG_LIBAIO
1257 .help = "Linux native asynchronous IO",
1260 #ifdef CONFIG_POSIXAIO
1261 { .ival = "posixaio",
1262 .help = "POSIX asynchronous IO",
1265 #ifdef CONFIG_SOLARISAIO
1266 { .ival = "solarisaio",
1267 .help = "Solaris native asynchronous IO",
1270 #ifdef CONFIG_WINDOWSAIO
1271 { .ival = "windowsaio",
1272 .help = "Windows native asynchronous IO"
1276 .help = "Memory mapped IO"
1278 #ifdef CONFIG_LINUX_SPLICE
1280 .help = "splice/vmsplice based IO",
1282 { .ival = "netsplice",
1283 .help = "splice/vmsplice to/from the network",
1286 #ifdef FIO_HAVE_SGIO
1288 .help = "SCSI generic v3 IO",
1292 .help = "Testing engine (no data transfer)",
1295 .help = "Network IO",
1298 .help = "CPU cycle burner engine",
1302 .help = "GUASI IO engine",
1305 #ifdef FIO_HAVE_BINJECT
1306 { .ival = "binject",
1307 .help = "binject direct inject block engine",
1312 .help = "RDMA IO engine",
1315 #ifdef CONFIG_FUSION_AW
1316 { .ival = "fusion-aw-sync",
1317 .help = "Fusion-io atomic write engine",
1320 #ifdef CONFIG_LINUX_EXT4_MOVE_EXTENT
1321 { .ival = "e4defrag",
1322 .help = "ext4 defrag engine",
1325 #ifdef CONFIG_LINUX_FALLOCATE
1327 .help = "fallocate() file based engine",
1330 { .ival = "external",
1331 .help = "Load external engine (append name)",
1337 .type = FIO_OPT_INT,
1338 .off1 = td_var_offset(iodepth),
1339 .help = "Number of IO buffers to keep in flight",
1344 .name = "iodepth_batch",
1345 .alias = "iodepth_batch_submit",
1346 .type = FIO_OPT_INT,
1347 .off1 = td_var_offset(iodepth_batch),
1348 .help = "Number of IO buffers to submit in one go",
1349 .parent = "iodepth",
1354 .name = "iodepth_batch_complete",
1355 .type = FIO_OPT_INT,
1356 .off1 = td_var_offset(iodepth_batch_complete),
1357 .help = "Number of IO buffers to retrieve in one go",
1358 .parent = "iodepth",
1363 .name = "iodepth_low",
1364 .type = FIO_OPT_INT,
1365 .off1 = td_var_offset(iodepth_low),
1366 .help = "Low water mark for queuing depth",
1367 .parent = "iodepth",
1371 .type = FIO_OPT_STR_VAL,
1373 .help = "Total size of device or files",
1376 .name = "fill_device",
1378 .type = FIO_OPT_BOOL,
1379 .off1 = td_var_offset(fill_device),
1380 .help = "Write until an ENOSPC error occurs",
1385 .type = FIO_OPT_STR_VAL,
1386 .off1 = td_var_offset(file_size_low),
1387 .off2 = td_var_offset(file_size_high),
1389 .help = "Size of individual files",
1393 .alias = "fileoffset",
1394 .type = FIO_OPT_STR_VAL,
1395 .off1 = td_var_offset(start_offset),
1396 .help = "Start IO from this offset",
1400 .name = "offset_increment",
1401 .type = FIO_OPT_STR_VAL,
1402 .off1 = td_var_offset(offset_increment),
1403 .help = "What is the increment from one offset to the next",
1409 .alias = "blocksize",
1410 .type = FIO_OPT_INT,
1411 .off1 = td_var_offset(bs[DDIR_READ]),
1412 .off2 = td_var_offset(bs[DDIR_WRITE]),
1413 .off3 = td_var_offset(bs[DDIR_TRIM]),
1415 .help = "Block size unit",
1421 .alias = "blockalign",
1422 .type = FIO_OPT_INT,
1423 .off1 = td_var_offset(ba[DDIR_READ]),
1424 .off2 = td_var_offset(ba[DDIR_WRITE]),
1425 .off3 = td_var_offset(ba[DDIR_TRIM]),
1427 .help = "IO block offset alignment",
1432 .alias = "blocksize_range",
1433 .type = FIO_OPT_RANGE,
1434 .off1 = td_var_offset(min_bs[DDIR_READ]),
1435 .off2 = td_var_offset(max_bs[DDIR_READ]),
1436 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1437 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1438 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1439 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1441 .help = "Set block size range (in more detail than bs)",
1446 .type = FIO_OPT_STR,
1447 .cb = str_bssplit_cb,
1448 .help = "Set a specific mix of block sizes",
1452 .name = "bs_unaligned",
1453 .alias = "blocksize_unaligned",
1454 .type = FIO_OPT_STR_SET,
1455 .off1 = td_var_offset(bs_unaligned),
1456 .help = "Don't sector align IO buffer sizes",
1460 .name = "randrepeat",
1461 .type = FIO_OPT_BOOL,
1462 .off1 = td_var_offset(rand_repeatable),
1463 .help = "Use repeatable random IO pattern",
1468 .name = "use_os_rand",
1469 .type = FIO_OPT_BOOL,
1470 .off1 = td_var_offset(use_os_rand),
1471 .help = "Set to use OS random generator",
1476 .name = "norandommap",
1477 .type = FIO_OPT_STR_SET,
1478 .off1 = td_var_offset(norandommap),
1479 .help = "Accept potential duplicate random blocks",
1483 .name = "softrandommap",
1484 .type = FIO_OPT_BOOL,
1485 .off1 = td_var_offset(softrandommap),
1486 .help = "Set norandommap if randommap allocation fails",
1487 .parent = "norandommap",
1491 .name = "random_generator",
1492 .type = FIO_OPT_STR,
1493 .off1 = td_var_offset(random_generator),
1494 .help = "Type of random number generator to use",
1495 .def = "tausworthe",
1497 { .ival = "tausworthe",
1498 .oval = FIO_RAND_GEN_TAUSWORTHE,
1499 .help = "Strong Tausworthe generator",
1502 .oval = FIO_RAND_GEN_LFSR,
1503 .help = "Variable length LFSR",
1508 .name = "random_distribution",
1509 .type = FIO_OPT_STR,
1510 .off1 = td_var_offset(random_distribution),
1511 .cb = str_random_distribution_cb,
1512 .help = "Random offset distribution generator",
1516 .oval = FIO_RAND_DIST_RANDOM,
1517 .help = "Completely random",
1520 .oval = FIO_RAND_DIST_ZIPF,
1521 .help = "Zipf distribution",
1524 .oval = FIO_RAND_DIST_PARETO,
1525 .help = "Pareto distribution",
1531 .alias = "nr_files",
1532 .type = FIO_OPT_INT,
1533 .off1 = td_var_offset(nr_files),
1534 .help = "Split job workload between this number of files",
1538 .name = "openfiles",
1539 .type = FIO_OPT_INT,
1540 .off1 = td_var_offset(open_files),
1541 .help = "Number of files to keep open at the same time",
1544 .name = "file_service_type",
1545 .type = FIO_OPT_STR,
1547 .off1 = td_var_offset(file_service_type),
1548 .help = "How to select which file to service next",
1549 .def = "roundrobin",
1552 .oval = FIO_FSERVICE_RANDOM,
1553 .help = "Choose a file at random",
1555 { .ival = "roundrobin",
1556 .oval = FIO_FSERVICE_RR,
1557 .help = "Round robin select files",
1559 { .ival = "sequential",
1560 .oval = FIO_FSERVICE_SEQ,
1561 .help = "Finish one file before moving to the next",
1564 .parent = "nrfiles",
1566 #ifdef CONFIG_POSIX_FALLOCATE
1568 .name = "fallocate",
1569 .type = FIO_OPT_STR,
1570 .off1 = td_var_offset(fallocate_mode),
1571 .help = "Whether pre-allocation is performed when laying out files",
1575 .oval = FIO_FALLOCATE_NONE,
1576 .help = "Do not pre-allocate space",
1579 .oval = FIO_FALLOCATE_POSIX,
1580 .help = "Use posix_fallocate()",
1582 #ifdef CONFIG_LINUX_FALLOCATE
1584 .oval = FIO_FALLOCATE_KEEP_SIZE,
1585 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1588 /* Compatibility with former boolean values */
1590 .oval = FIO_FALLOCATE_NONE,
1591 .help = "Alias for 'none'",
1594 .oval = FIO_FALLOCATE_POSIX,
1595 .help = "Alias for 'posix'",
1599 #endif /* CONFIG_POSIX_FALLOCATE */
1601 .name = "fadvise_hint",
1602 .type = FIO_OPT_BOOL,
1603 .off1 = td_var_offset(fadvise_hint),
1604 .help = "Use fadvise() to advise the kernel on IO pattern",
1609 .type = FIO_OPT_INT,
1610 .off1 = td_var_offset(fsync_blocks),
1611 .help = "Issue fsync for writes every given number of blocks",
1615 .name = "fdatasync",
1616 .type = FIO_OPT_INT,
1617 .off1 = td_var_offset(fdatasync_blocks),
1618 .help = "Issue fdatasync for writes every given number of blocks",
1622 .name = "write_barrier",
1623 .type = FIO_OPT_INT,
1624 .off1 = td_var_offset(barrier_blocks),
1625 .help = "Make every Nth write a barrier write",
1628 #ifdef CONFIG_SYNC_FILE_RANGE
1630 .name = "sync_file_range",
1632 { .ival = "wait_before",
1633 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1634 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1638 .oval = SYNC_FILE_RANGE_WRITE,
1639 .help = "SYNC_FILE_RANGE_WRITE",
1643 .ival = "wait_after",
1644 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1645 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1649 .type = FIO_OPT_STR_MULTI,
1651 .off1 = td_var_offset(sync_file_range),
1652 .help = "Use sync_file_range()",
1657 .type = FIO_OPT_BOOL,
1658 .off1 = td_var_offset(odirect),
1659 .help = "Use O_DIRECT IO (negates buffered)",
1664 .type = FIO_OPT_BOOL,
1665 .off1 = td_var_offset(odirect),
1667 .help = "Use buffered IO (negates direct)",
1671 .name = "overwrite",
1672 .type = FIO_OPT_BOOL,
1673 .off1 = td_var_offset(overwrite),
1674 .help = "When writing, set whether to overwrite current data",
1679 .type = FIO_OPT_INT,
1680 .off1 = td_var_offset(loops),
1681 .help = "Number of times to run the job",
1686 .type = FIO_OPT_INT,
1687 .off1 = td_var_offset(numjobs),
1688 .help = "Duplicate this job this many times",
1692 .name = "startdelay",
1693 .type = FIO_OPT_STR_VAL_TIME,
1694 .off1 = td_var_offset(start_delay),
1695 .help = "Only start job when this period has passed",
1701 .type = FIO_OPT_STR_VAL_TIME,
1702 .off1 = td_var_offset(timeout),
1703 .help = "Stop workload when this amount of time has passed",
1707 .name = "time_based",
1708 .type = FIO_OPT_STR_SET,
1709 .off1 = td_var_offset(time_based),
1710 .help = "Keep running until runtime/timeout is met",
1713 .name = "ramp_time",
1714 .type = FIO_OPT_STR_VAL_TIME,
1715 .off1 = td_var_offset(ramp_time),
1716 .help = "Ramp up time before measuring performance",
1719 .name = "clocksource",
1720 .type = FIO_OPT_STR,
1721 .cb = fio_clock_source_cb,
1722 .off1 = td_var_offset(clocksource),
1723 .help = "What type of timing source to use",
1725 #ifdef CONFIG_GETTIMEOFDAY
1726 { .ival = "gettimeofday",
1728 .help = "Use gettimeofday(2) for timing",
1731 #ifdef CONFIG_CLOCK_GETTIME
1732 { .ival = "clock_gettime",
1733 .oval = CS_CGETTIME,
1734 .help = "Use clock_gettime(2) for timing",
1737 #ifdef ARCH_HAVE_CPU_CLOCK
1739 .oval = CS_CPUCLOCK,
1740 .help = "Use CPU private clock",
1748 .type = FIO_OPT_STR,
1750 .off1 = td_var_offset(mem_type),
1751 .help = "Backing type for IO buffers",
1756 .help = "Use malloc(3) for IO buffers",
1760 .help = "Use shared memory segments for IO buffers",
1762 #ifdef FIO_HAVE_HUGETLB
1763 { .ival = "shmhuge",
1764 .oval = MEM_SHMHUGE,
1765 .help = "Like shm, but use huge pages",
1770 .help = "Use mmap(2) (file or anon) for IO buffers",
1772 #ifdef FIO_HAVE_HUGETLB
1773 { .ival = "mmaphuge",
1774 .oval = MEM_MMAPHUGE,
1775 .help = "Like mmap, but use huge pages",
1781 .name = "iomem_align",
1782 .alias = "mem_align",
1783 .type = FIO_OPT_INT,
1784 .off1 = td_var_offset(mem_align),
1786 .help = "IO memory buffer offset alignment",
1792 .type = FIO_OPT_STR,
1793 .off1 = td_var_offset(verify),
1794 .help = "Verify data written",
1795 .cb = str_verify_cb,
1799 .oval = VERIFY_NONE,
1800 .help = "Don't do IO verification",
1804 .help = "Use md5 checksums for verification",
1807 .oval = VERIFY_CRC64,
1808 .help = "Use crc64 checksums for verification",
1811 .oval = VERIFY_CRC32,
1812 .help = "Use crc32 checksums for verification",
1814 { .ival = "crc32c-intel",
1815 .oval = VERIFY_CRC32C,
1816 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1819 .oval = VERIFY_CRC32C,
1820 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1823 .oval = VERIFY_CRC16,
1824 .help = "Use crc16 checksums for verification",
1827 .oval = VERIFY_CRC7,
1828 .help = "Use crc7 checksums for verification",
1831 .oval = VERIFY_SHA1,
1832 .help = "Use sha1 checksums for verification",
1835 .oval = VERIFY_SHA256,
1836 .help = "Use sha256 checksums for verification",
1839 .oval = VERIFY_SHA512,
1840 .help = "Use sha512 checksums for verification",
1843 .oval = VERIFY_META,
1844 .help = "Use io information",
1848 .oval = VERIFY_NULL,
1849 .help = "Pretend to verify",
1854 .name = "do_verify",
1855 .type = FIO_OPT_BOOL,
1856 .off1 = td_var_offset(do_verify),
1857 .help = "Run verification stage after write",
1862 .name = "verifysort",
1863 .type = FIO_OPT_BOOL,
1864 .off1 = td_var_offset(verifysort),
1865 .help = "Sort written verify blocks for read back",
1870 .name = "verifysort_nr",
1871 .type = FIO_OPT_INT,
1872 .off1 = td_var_offset(verifysort_nr),
1873 .help = "Pre-load and sort verify blocks for a read workload",
1880 .name = "verify_interval",
1881 .type = FIO_OPT_INT,
1882 .off1 = td_var_offset(verify_interval),
1883 .minval = 2 * sizeof(struct verify_header),
1884 .help = "Store verify buffer header every N bytes",
1888 .name = "verify_offset",
1889 .type = FIO_OPT_INT,
1890 .help = "Offset verify header location by N bytes",
1892 .cb = str_verify_offset_cb,
1896 .name = "verify_pattern",
1897 .type = FIO_OPT_STR,
1898 .cb = str_verify_pattern_cb,
1899 .help = "Fill pattern for IO buffers",
1903 .name = "verify_fatal",
1904 .type = FIO_OPT_BOOL,
1905 .off1 = td_var_offset(verify_fatal),
1907 .help = "Exit on a single verify failure, don't continue",
1911 .name = "verify_dump",
1912 .type = FIO_OPT_BOOL,
1913 .off1 = td_var_offset(verify_dump),
1915 .help = "Dump contents of good and bad blocks on failure",
1919 .name = "verify_async",
1920 .type = FIO_OPT_INT,
1921 .off1 = td_var_offset(verify_async),
1923 .help = "Number of async verifier threads to use",
1927 .name = "verify_backlog",
1928 .type = FIO_OPT_STR_VAL,
1929 .off1 = td_var_offset(verify_backlog),
1930 .help = "Verify after this number of blocks are written",
1934 .name = "verify_backlog_batch",
1935 .type = FIO_OPT_INT,
1936 .off1 = td_var_offset(verify_batch),
1937 .help = "Verify this number of IO blocks",
1940 #ifdef FIO_HAVE_CPU_AFFINITY
1942 .name = "verify_async_cpus",
1943 .type = FIO_OPT_STR,
1944 .cb = str_verify_cpus_allowed_cb,
1945 .help = "Set CPUs allowed for async verify threads",
1946 .parent = "verify_async",
1950 .name = "experimental_verify",
1951 .off1 = td_var_offset(experimental_verify),
1952 .type = FIO_OPT_BOOL,
1953 .help = "Enable experimental verification",
1955 #ifdef FIO_HAVE_TRIM
1957 .name = "trim_percentage",
1958 .type = FIO_OPT_INT,
1959 .cb = str_verify_trim_cb,
1961 .help = "Number of verify blocks to discard/trim",
1966 .name = "trim_verify_zero",
1967 .type = FIO_OPT_INT,
1968 .help = "Verify that trim/discarded blocks are returned as zeroes",
1969 .off1 = td_var_offset(trim_zero),
1970 .parent = "trim_percentage",
1974 .name = "trim_backlog",
1975 .type = FIO_OPT_STR_VAL,
1976 .off1 = td_var_offset(trim_backlog),
1977 .help = "Trim after this number of blocks are written",
1978 .parent = "trim_percentage",
1981 .name = "trim_backlog_batch",
1982 .type = FIO_OPT_INT,
1983 .off1 = td_var_offset(trim_batch),
1984 .help = "Trim this number of IO blocks",
1985 .parent = "trim_percentage",
1989 .name = "write_iolog",
1990 .type = FIO_OPT_STR_STORE,
1991 .off1 = td_var_offset(write_iolog_file),
1992 .help = "Store IO pattern to file",
1995 .name = "read_iolog",
1996 .type = FIO_OPT_STR_STORE,
1997 .off1 = td_var_offset(read_iolog_file),
1998 .help = "Playback IO pattern from file",
2001 .name = "replay_no_stall",
2002 .type = FIO_OPT_INT,
2003 .off1 = td_var_offset(no_stall),
2005 .parent = "read_iolog",
2006 .help = "Playback IO pattern file as fast as possible without stalls",
2009 .name = "replay_redirect",
2010 .type = FIO_OPT_STR_STORE,
2011 .off1 = td_var_offset(replay_redirect),
2012 .parent = "read_iolog",
2013 .help = "Replay all I/O onto this device, regardless of trace device",
2016 .name = "exec_prerun",
2017 .type = FIO_OPT_STR_STORE,
2018 .off1 = td_var_offset(exec_prerun),
2019 .help = "Execute this file prior to running job",
2022 .name = "exec_postrun",
2023 .type = FIO_OPT_STR_STORE,
2024 .off1 = td_var_offset(exec_postrun),
2025 .help = "Execute this file after running job",
2027 #ifdef FIO_HAVE_IOSCHED_SWITCH
2029 .name = "ioscheduler",
2030 .type = FIO_OPT_STR_STORE,
2031 .off1 = td_var_offset(ioscheduler),
2032 .help = "Use this IO scheduler on the backing device",
2037 .type = FIO_OPT_STR_VAL,
2038 .off1 = td_var_offset(zone_size),
2039 .help = "Amount of data to read per zone",
2043 .name = "zonerange",
2044 .type = FIO_OPT_STR_VAL,
2045 .off1 = td_var_offset(zone_range),
2046 .help = "Give size of an IO zone",
2051 .type = FIO_OPT_STR_VAL,
2052 .off1 = td_var_offset(zone_skip),
2053 .help = "Space between IO zones",
2058 .type = FIO_OPT_STR_VAL,
2059 .cb = str_lockmem_cb,
2060 .help = "Lock down this amount of memory",
2064 .name = "rwmixread",
2065 .type = FIO_OPT_INT,
2066 .cb = str_rwmix_read_cb,
2068 .help = "Percentage of mixed workload that is reads",
2072 .name = "rwmixwrite",
2073 .type = FIO_OPT_INT,
2074 .cb = str_rwmix_write_cb,
2076 .help = "Percentage of mixed workload that is writes",
2080 .name = "rwmixcycle",
2081 .type = FIO_OPT_DEPRECATED,
2085 .type = FIO_OPT_INT,
2086 .off1 = td_var_offset(nice),
2087 .help = "Set job CPU nice value",
2092 #ifdef FIO_HAVE_IOPRIO
2095 .type = FIO_OPT_INT,
2097 .help = "Set job IO priority value",
2102 .name = "prioclass",
2103 .type = FIO_OPT_INT,
2104 .cb = str_prioclass_cb,
2105 .help = "Set job IO priority class",
2111 .name = "thinktime",
2112 .type = FIO_OPT_INT,
2113 .off1 = td_var_offset(thinktime),
2114 .help = "Idle time between IO buffers (usec)",
2118 .name = "thinktime_spin",
2119 .type = FIO_OPT_INT,
2120 .off1 = td_var_offset(thinktime_spin),
2121 .help = "Start think time by spinning this amount (usec)",
2123 .parent = "thinktime",
2126 .name = "thinktime_blocks",
2127 .type = FIO_OPT_INT,
2128 .off1 = td_var_offset(thinktime_blocks),
2129 .help = "IO buffer period between 'thinktime'",
2131 .parent = "thinktime",
2135 .type = FIO_OPT_INT,
2136 .off1 = td_var_offset(rate[DDIR_READ]),
2137 .off2 = td_var_offset(rate[DDIR_WRITE]),
2138 .off3 = td_var_offset(rate[DDIR_TRIM]),
2139 .help = "Set bandwidth rate",
2143 .type = FIO_OPT_INT,
2144 .off1 = td_var_offset(ratemin[DDIR_READ]),
2145 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
2146 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
2147 .help = "Job must meet this rate or it will be shutdown",
2151 .name = "rate_iops",
2152 .type = FIO_OPT_INT,
2153 .off1 = td_var_offset(rate_iops[DDIR_READ]),
2154 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
2155 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
2156 .help = "Limit IO used to this number of IO operations/sec",
2159 .name = "rate_iops_min",
2160 .type = FIO_OPT_INT,
2161 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
2162 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
2163 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
2164 .help = "Job must meet this rate or it will be shut down",
2165 .parent = "rate_iops",
2168 .name = "ratecycle",
2169 .type = FIO_OPT_INT,
2170 .off1 = td_var_offset(ratecycle),
2171 .help = "Window average for rate limits (msec)",
2176 .name = "max_latency",
2177 .type = FIO_OPT_INT,
2178 .off1 = td_var_offset(max_latency),
2179 .help = "Maximum tolerated IO latency (usec)",
2182 .name = "invalidate",
2183 .type = FIO_OPT_BOOL,
2184 .off1 = td_var_offset(invalidate_cache),
2185 .help = "Invalidate buffer/page cache prior to running job",
2190 .type = FIO_OPT_BOOL,
2191 .off1 = td_var_offset(sync_io),
2192 .help = "Use O_SYNC for buffered writes",
2194 .parent = "buffered",
2197 .name = "bwavgtime",
2198 .type = FIO_OPT_INT,
2199 .off1 = td_var_offset(bw_avg_time),
2200 .help = "Time window over which to calculate bandwidth"
2203 .parent = "write_bw_log",
2206 .name = "iopsavgtime",
2207 .type = FIO_OPT_INT,
2208 .off1 = td_var_offset(iops_avg_time),
2209 .help = "Time window over which to calculate IOPS (msec)",
2211 .parent = "write_iops_log",
2214 .name = "create_serialize",
2215 .type = FIO_OPT_BOOL,
2216 .off1 = td_var_offset(create_serialize),
2217 .help = "Serialize creating of job files",
2221 .name = "create_fsync",
2222 .type = FIO_OPT_BOOL,
2223 .off1 = td_var_offset(create_fsync),
2224 .help = "fsync file after creation",
2228 .name = "create_on_open",
2229 .type = FIO_OPT_BOOL,
2230 .off1 = td_var_offset(create_on_open),
2231 .help = "Create files when they are opened for IO",
2235 .name = "create_only",
2236 .type = FIO_OPT_BOOL,
2237 .off1 = td_var_offset(create_only),
2238 .help = "Only perform file creation phase",
2243 .type = FIO_OPT_BOOL,
2244 .off1 = td_var_offset(pre_read),
2245 .help = "Pre-read files before starting official testing",
2250 .type = FIO_OPT_INT,
2251 .off1 = td_var_offset(cpuload),
2252 .help = "Use this percentage of CPU",
2255 .name = "cpuchunks",
2256 .type = FIO_OPT_INT,
2257 .off1 = td_var_offset(cpucycle),
2258 .help = "Length of the CPU burn cycles (usecs)",
2260 .parent = "cpuload",
2262 #ifdef FIO_HAVE_CPU_AFFINITY
2265 .type = FIO_OPT_INT,
2266 .cb = str_cpumask_cb,
2267 .help = "CPU affinity mask",
2270 .name = "cpus_allowed",
2271 .type = FIO_OPT_STR,
2272 .cb = str_cpus_allowed_cb,
2273 .help = "Set CPUs allowed",
2276 #ifdef CONFIG_LIBNUMA
2278 .name = "numa_cpu_nodes",
2279 .type = FIO_OPT_STR,
2280 .cb = str_numa_cpunodes_cb,
2281 .help = "NUMA CPU nodes bind",
2284 .name = "numa_mem_policy",
2285 .type = FIO_OPT_STR,
2286 .cb = str_numa_mpol_cb,
2287 .help = "NUMA memory policy setup",
2291 .name = "end_fsync",
2292 .type = FIO_OPT_BOOL,
2293 .off1 = td_var_offset(end_fsync),
2294 .help = "Include fsync at the end of job",
2298 .name = "fsync_on_close",
2299 .type = FIO_OPT_BOOL,
2300 .off1 = td_var_offset(fsync_on_close),
2301 .help = "fsync files on close",
2306 .type = FIO_OPT_BOOL,
2307 .off1 = td_var_offset(unlink),
2308 .help = "Unlink created files after job has completed",
2313 .type = FIO_OPT_STR_SET,
2314 .cb = str_exitall_cb,
2315 .help = "Terminate all jobs when one exits",
2318 .name = "stonewall",
2319 .alias = "wait_for_previous",
2320 .type = FIO_OPT_STR_SET,
2321 .off1 = td_var_offset(stonewall),
2322 .help = "Insert a hard barrier between this job and previous",
2325 .name = "new_group",
2326 .type = FIO_OPT_STR_SET,
2327 .off1 = td_var_offset(new_group),
2328 .help = "Mark the start of a new group (for reporting)",
2332 .type = FIO_OPT_STR_SET,
2333 .off1 = td_var_offset(use_thread),
2334 .help = "Use threads instead of forks",
2337 .name = "write_bw_log",
2338 .type = FIO_OPT_STR,
2339 .off1 = td_var_offset(write_bw_log),
2340 .cb = str_write_bw_log_cb,
2341 .help = "Write log of bandwidth during run",
2344 .name = "write_lat_log",
2345 .type = FIO_OPT_STR,
2346 .off1 = td_var_offset(write_lat_log),
2347 .cb = str_write_lat_log_cb,
2348 .help = "Write log of latency during run",
2351 .name = "write_iops_log",
2352 .type = FIO_OPT_STR,
2353 .off1 = td_var_offset(write_iops_log),
2354 .cb = str_write_iops_log_cb,
2355 .help = "Write log of IOPS during run",
2358 .name = "log_avg_msec",
2359 .type = FIO_OPT_INT,
2360 .off1 = td_var_offset(log_avg_msec),
2361 .help = "Average bw/iops/lat logs over this period of time",
2365 .name = "hugepage-size",
2366 .type = FIO_OPT_INT,
2367 .off1 = td_var_offset(hugepage_size),
2368 .help = "When using hugepages, specify size of each page",
2369 .def = __fio_stringify(FIO_HUGE_PAGE),
2372 .name = "group_reporting",
2373 .type = FIO_OPT_STR_SET,
2374 .off1 = td_var_offset(group_reporting),
2375 .help = "Do reporting on a per-group basis",
2378 .name = "zero_buffers",
2379 .type = FIO_OPT_STR_SET,
2380 .off1 = td_var_offset(zero_buffers),
2381 .help = "Init IO buffers to all zeroes",
2384 .name = "refill_buffers",
2385 .type = FIO_OPT_STR_SET,
2386 .off1 = td_var_offset(refill_buffers),
2387 .help = "Refill IO buffers on every IO submit",
2390 .name = "scramble_buffers",
2391 .type = FIO_OPT_BOOL,
2392 .off1 = td_var_offset(scramble_buffers),
2393 .help = "Slightly scramble buffers on every IO submit",
2397 .name = "buffer_compress_percentage",
2398 .type = FIO_OPT_INT,
2399 .off1 = td_var_offset(compress_percentage),
2402 .help = "How compressible the buffer is (approximately)",
2405 .name = "buffer_compress_chunk",
2406 .type = FIO_OPT_INT,
2407 .off1 = td_var_offset(compress_chunk),
2408 .parent = "buffer_compress_percentage",
2409 .help = "Size of compressible region in buffer",
2412 .name = "clat_percentiles",
2413 .type = FIO_OPT_BOOL,
2414 .off1 = td_var_offset(clat_percentiles),
2415 .help = "Enable the reporting of completion latency percentiles",
2419 .name = "percentile_list",
2420 .type = FIO_OPT_FLOAT_LIST,
2421 .off1 = td_var_offset(percentile_list),
2422 .off2 = td_var_offset(percentile_precision),
2423 .help = "Specify a custom list of percentiles to report",
2424 .def = "1:5:10:20:30:40:50:60:70:80:90:95:99:99.5:99.9:99.95:99.99",
2425 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2430 #ifdef FIO_HAVE_DISK_UTIL
2432 .name = "disk_util",
2433 .type = FIO_OPT_BOOL,
2434 .off1 = td_var_offset(do_disk_util),
2435 .help = "Log disk utilization statistics",
2440 .name = "gtod_reduce",
2441 .type = FIO_OPT_BOOL,
2442 .help = "Greatly reduce number of gettimeofday() calls",
2443 .cb = str_gtod_reduce_cb,
2447 .name = "disable_lat",
2448 .type = FIO_OPT_BOOL,
2449 .off1 = td_var_offset(disable_lat),
2450 .help = "Disable latency numbers",
2451 .parent = "gtod_reduce",
2455 .name = "disable_clat",
2456 .type = FIO_OPT_BOOL,
2457 .off1 = td_var_offset(disable_clat),
2458 .help = "Disable completion latency numbers",
2459 .parent = "gtod_reduce",
2463 .name = "disable_slat",
2464 .type = FIO_OPT_BOOL,
2465 .off1 = td_var_offset(disable_slat),
2466 .help = "Disable submission latency numbers",
2467 .parent = "gtod_reduce",
2471 .name = "disable_bw_measurement",
2472 .type = FIO_OPT_BOOL,
2473 .off1 = td_var_offset(disable_bw),
2474 .help = "Disable bandwidth logging",
2475 .parent = "gtod_reduce",
2480 .type = FIO_OPT_INT,
2481 .cb = str_gtod_cpu_cb,
2482 .help = "Set up dedicated gettimeofday() thread on this CPU",
2483 .verify = gtod_cpu_verify,
2486 .name = "unified_rw_reporting",
2487 .type = FIO_OPT_BOOL,
2488 .off1 = td_var_offset(unified_rw_rep),
2489 .help = "Unify reporting across data direction",
2493 .name = "continue_on_error",
2494 .type = FIO_OPT_STR,
2495 .off1 = td_var_offset(continue_on_error),
2496 .help = "Continue on non-fatal errors during IO",
2500 .oval = ERROR_TYPE_NONE,
2501 .help = "Exit when an error is encountered",
2504 .oval = ERROR_TYPE_READ,
2505 .help = "Continue on read errors only",
2508 .oval = ERROR_TYPE_WRITE,
2509 .help = "Continue on write errors only",
2512 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2513 .help = "Continue on any IO errors",
2516 .oval = ERROR_TYPE_VERIFY,
2517 .help = "Continue on verify errors only",
2520 .oval = ERROR_TYPE_ANY,
2521 .help = "Continue on all io and verify errors",
2524 .oval = ERROR_TYPE_NONE,
2525 .help = "Alias for 'none'",
2528 .oval = ERROR_TYPE_ANY,
2529 .help = "Alias for 'all'",
2534 .name = "ignore_error",
2535 .type = FIO_OPT_STR,
2536 .cb = str_ignore_error_cb,
2537 .help = "Set a specific list of errors to ignore",
2541 .name = "error_dump",
2542 .type = FIO_OPT_BOOL,
2543 .off1 = td_var_offset(error_dump),
2545 .help = "Dump info on each error",
2550 .type = FIO_OPT_STR_STORE,
2551 .off1 = td_var_offset(profile),
2552 .help = "Select a specific builtin performance test",
2556 .type = FIO_OPT_STR_STORE,
2557 .off1 = td_var_offset(cgroup),
2558 .help = "Add job to cgroup of this name",
2561 .name = "cgroup_weight",
2562 .type = FIO_OPT_INT,
2563 .off1 = td_var_offset(cgroup_weight),
2564 .help = "Use given weight for cgroup",
2569 .name = "cgroup_nodelete",
2570 .type = FIO_OPT_BOOL,
2571 .off1 = td_var_offset(cgroup_nodelete),
2572 .help = "Do not delete cgroups after job completion",
2577 .type = FIO_OPT_INT,
2578 .off1 = td_var_offset(uid),
2579 .help = "Run job with this user ID",
2583 .type = FIO_OPT_INT,
2584 .off1 = td_var_offset(gid),
2585 .help = "Run job with this group ID",
2589 .type = FIO_OPT_INT,
2590 .off1 = td_var_offset(flow_id),
2591 .help = "The flow index ID to use",
2596 .type = FIO_OPT_INT,
2597 .off1 = td_var_offset(flow),
2598 .help = "Weight for flow control of this job",
2599 .parent = "flow_id",
2603 .name = "flow_watermark",
2604 .type = FIO_OPT_INT,
2605 .off1 = td_var_offset(flow_watermark),
2606 .help = "High watermark for flow control. This option"
2607 " should be set to the same value for all threads"
2608 " with non-zero flow.",
2609 .parent = "flow_id",
2613 .name = "flow_sleep",
2614 .type = FIO_OPT_INT,
2615 .off1 = td_var_offset(flow_sleep),
2616 .help = "How many microseconds to sleep after being held"
2617 " back by the flow control mechanism",
2618 .parent = "flow_id",
2626 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2627 const char *name, int val)
2629 lopt->name = (char *) name;
2631 if (o->type == FIO_OPT_STR_SET)
2632 lopt->has_arg = no_argument;
2634 lopt->has_arg = required_argument;
2637 static void options_to_lopts(struct fio_option *opts,
2638 struct option *long_options,
2639 int i, int option_type)
2641 struct fio_option *o = &opts[0];
2643 add_to_lopt(&long_options[i], o, o->name, option_type);
2646 add_to_lopt(&long_options[i], o, o->alias, option_type);
2651 assert(i < FIO_NR_OPTIONS);
2655 void fio_options_set_ioengine_opts(struct option *long_options,
2656 struct thread_data *td)
2661 while (long_options[i].name) {
2662 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2663 memset(&long_options[i], 0, sizeof(*long_options));
2670 * Just clear out the prior ioengine options.
2675 options_to_lopts(td->io_ops->options, long_options, i,
2676 FIO_GETOPT_IOENGINE);
2679 void fio_options_dup_and_init(struct option *long_options)
2683 options_init(options);
2686 while (long_options[i].name)
2689 options_to_lopts(options, long_options, i, FIO_GETOPT_JOB);
2692 struct fio_keyword {
2698 static struct fio_keyword fio_keywords[] = {
2700 .word = "$pagesize",
2701 .desc = "Page size in the system",
2704 .word = "$mb_memory",
2705 .desc = "Megabytes of memory online",
2709 .desc = "Number of CPUs online in the system",
2716 void fio_keywords_init(void)
2718 unsigned long long mb_memory;
2722 sprintf(buf, "%lu", (unsigned long) page_size);
2723 fio_keywords[0].replace = strdup(buf);
2725 mb_memory = os_phys_mem() / (1024 * 1024);
2726 sprintf(buf, "%llu", mb_memory);
2727 fio_keywords[1].replace = strdup(buf);
2730 sprintf(buf, "%lu", l);
2731 fio_keywords[2].replace = strdup(buf);
2736 static char *bc_calc(char *str)
2738 char buf[128], *tmp;
2743 * No math, just return string
2745 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2746 !strchr(str, '/')) || strchr(str, '\''))
2750 * Split option from value, we only need to calculate the value
2752 tmp = strchr(str, '=');
2759 * Prevent buffer overflows; such a case isn't reasonable anyway
2761 if (strlen(str) >= 128 || strlen(tmp) > 100)
2764 sprintf(buf, "which %s > /dev/null", BC_APP);
2766 log_err("fio: bc is needed for performing math\n");
2770 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2771 f = popen(buf, "r");
2776 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2782 buf[(tmp - str) + ret - 1] = '\0';
2783 memcpy(buf, str, tmp - str);
2789 * Return a copy of the input string with substrings of the form ${VARNAME}
2790 * substituted with the value of the environment variable VARNAME. The
2791 * substitution always occurs, even if VARNAME is empty or the corresponding
2792 * environment variable undefined.
2794 static char *option_dup_subs(const char *opt)
2796 char out[OPT_LEN_MAX+1];
2797 char in[OPT_LEN_MAX+1];
2800 char *ch1, *ch2, *env;
2801 ssize_t nchr = OPT_LEN_MAX;
2804 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2805 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2809 in[OPT_LEN_MAX] = '\0';
2810 strncpy(in, opt, OPT_LEN_MAX);
2812 while (*inptr && nchr > 0) {
2813 if (inptr[0] == '$' && inptr[1] == '{') {
2814 ch2 = strchr(inptr, '}');
2815 if (ch2 && inptr+1 < ch2) {
2822 envlen = strlen(env);
2823 if (envlen <= nchr) {
2824 memcpy(outptr, env, envlen);
2834 *outptr++ = *inptr++;
2843 * Look for reserved variable names and replace them with real values
2845 static char *fio_keyword_replace(char *opt)
2851 for (i = 0; fio_keywords[i].word != NULL; i++) {
2852 struct fio_keyword *kw = &fio_keywords[i];
2854 while ((s = strstr(opt, kw->word)) != NULL) {
2855 char *new = malloc(strlen(opt) + 1);
2861 * Copy part of the string before the keyword and
2862 * sprintf() the replacement after it.
2864 memcpy(new, opt, olen);
2865 len = sprintf(new + olen, "%s", kw->replace);
2868 * If there's more in the original string, copy that
2871 opt += strlen(kw->word) + olen;
2873 memcpy(new + olen + len, opt, opt - o_org - 1);
2876 * replace opt and free the old opt
2886 * Check for potential math and invoke bc, if possible
2894 static char **dup_and_sub_options(char **opts, int num_opts)
2897 char **opts_copy = malloc(num_opts * sizeof(*opts));
2898 for (i = 0; i < num_opts; i++) {
2899 opts_copy[i] = option_dup_subs(opts[i]);
2902 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2907 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2909 int i, ret, unknown;
2912 sort_options(opts, options, num_opts);
2913 opts_copy = dup_and_sub_options(opts, num_opts);
2915 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2916 struct fio_option *o;
2917 int newret = parse_option(opts_copy[i], opts[i], options, &o,
2926 opts_copy[i] = NULL;
2933 ret |= ioengine_load(td);
2935 sort_options(opts_copy, td->io_ops->options, num_opts);
2938 for (i = 0; i < num_opts; i++) {
2939 struct fio_option *o = NULL;
2945 newret = parse_option(opts_copy[i], opts[i],
2946 td->io_ops->options, &o,
2951 log_err("Bad option <%s>\n", opts[i]);
2954 opts_copy[i] = NULL;
2962 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2964 return parse_cmd_option(opt, val, options, td);
2967 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2970 return parse_cmd_option(opt, val, td->io_ops->options, td);
2973 void fio_fill_default_options(struct thread_data *td)
2975 fill_default_options(td, options);
2978 int fio_show_option_help(const char *opt)
2980 return show_cmd_help(options, opt);
2983 void options_mem_dupe(void *data, struct fio_option *options)
2985 struct fio_option *o;
2988 for (o = &options[0]; o->name; o++) {
2989 if (o->type != FIO_OPT_STR_STORE)
2992 ptr = td_var(data, o->off1);
2994 *ptr = strdup(*ptr);
2999 * dupe FIO_OPT_STR_STORE options
3001 void fio_options_mem_dupe(struct thread_data *td)
3003 options_mem_dupe(&td->o, options);
3005 if (td->eo && td->io_ops) {
3006 void *oldeo = td->eo;
3008 td->eo = malloc(td->io_ops->option_struct_size);
3009 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3010 options_mem_dupe(td->eo, td->io_ops->options);
3014 unsigned int fio_get_kb_base(void *data)
3016 struct thread_data *td = data;
3017 unsigned int kb_base = 0;
3020 kb_base = td->o.kb_base;
3027 int add_option(struct fio_option *o)
3029 struct fio_option *__o;
3038 memcpy(&options[opt_index], o, sizeof(*o));
3042 void invalidate_profile_options(const char *prof_name)
3044 struct fio_option *o;
3048 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3049 o->type = FIO_OPT_INVALID;
3050 o->prof_name = NULL;
3056 void add_opt_posval(const char *optname, const char *ival, const char *help)
3058 struct fio_option *o;
3061 o = find_option(options, optname);
3065 for (i = 0; i < PARSE_MAX_VP; i++) {
3066 if (o->posval[i].ival)
3069 o->posval[i].ival = ival;
3070 o->posval[i].help = help;
3075 void del_opt_posval(const char *optname, const char *ival)
3077 struct fio_option *o;
3080 o = find_option(options, optname);
3084 for (i = 0; i < PARSE_MAX_VP; i++) {
3085 if (!o->posval[i].ival)
3087 if (strcmp(o->posval[i].ival, ival))
3090 o->posval[i].ival = NULL;
3091 o->posval[i].help = NULL;
3095 void fio_options_free(struct thread_data *td)
3097 options_free(options, td);
3098 if (td->eo && td->io_ops && td->io_ops->options) {
3099 options_free(td->io_ops->options, td->eo);