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);
347 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
348 log_err("fio: mmaphuge:/path/to/file\n");
356 static int str_verify_cb(void *data, const char *mem)
358 struct thread_data *td = data;
360 if (td->o.verify == VERIFY_CRC32C_INTEL ||
361 td->o.verify == VERIFY_CRC32C) {
362 crc32c_intel_probe();
368 static int fio_clock_source_cb(void *data, const char *str)
370 struct thread_data *td = data;
372 fio_clock_source = td->o.clocksource;
377 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
383 static int str_rwmix_read_cb(void *data, unsigned long long *val)
385 struct thread_data *td = data;
387 td->o.rwmix[DDIR_READ] = *val;
388 td->o.rwmix[DDIR_WRITE] = 100 - *val;
392 static int str_rwmix_write_cb(void *data, unsigned long long *val)
394 struct thread_data *td = data;
396 td->o.rwmix[DDIR_WRITE] = *val;
397 td->o.rwmix[DDIR_READ] = 100 - *val;
401 #ifdef FIO_HAVE_IOPRIO
402 static int str_prioclass_cb(void *data, unsigned long long *val)
404 struct thread_data *td = data;
408 * mask off old class bits, str_prio_cb() may have set a default class
410 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
413 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
418 static int str_prio_cb(void *data, unsigned long long *val)
420 struct thread_data *td = data;
425 * If no class is set, assume BE
427 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
428 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
435 static int str_exitall_cb(void)
437 exitall_on_terminate = 1;
441 #ifdef FIO_HAVE_CPU_AFFINITY
442 static int str_cpumask_cb(void *data, unsigned long long *val)
444 struct thread_data *td = data;
449 ret = fio_cpuset_init(&td->o.cpumask);
451 log_err("fio: cpuset_init failed\n");
452 td_verror(td, ret, "fio_cpuset_init");
456 max_cpu = cpus_online();
458 for (i = 0; i < sizeof(int) * 8; i++) {
459 if ((1 << i) & *val) {
461 log_err("fio: CPU %d too large (max=%ld)\n", i,
465 dprint(FD_PARSE, "set cpu allowed %d\n", i);
466 fio_cpu_set(&td->o.cpumask, i);
470 td->o.cpumask_set = 1;
474 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
481 ret = fio_cpuset_init(mask);
483 log_err("fio: cpuset_init failed\n");
484 td_verror(td, ret, "fio_cpuset_init");
488 p = str = strdup(input);
490 strip_blank_front(&str);
491 strip_blank_end(str);
493 max_cpu = cpus_online();
495 while ((cpu = strsep(&str, ",")) != NULL) {
504 while ((cpu2 = strsep(&str2, "-")) != NULL) {
514 while (icpu <= icpu2) {
515 if (icpu >= FIO_MAX_CPUS) {
516 log_err("fio: your OS only supports up to"
517 " %d CPUs\n", (int) FIO_MAX_CPUS);
521 if (icpu > max_cpu) {
522 log_err("fio: CPU %d too large (max=%ld)\n",
528 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
529 fio_cpu_set(mask, icpu);
538 td->o.cpumask_set = 1;
542 static int str_cpus_allowed_cb(void *data, const char *input)
544 struct thread_data *td = data;
547 ret = set_cpus_allowed(td, &td->o.cpumask, input);
549 td->o.cpumask_set = 1;
554 static int str_verify_cpus_allowed_cb(void *data, const char *input)
556 struct thread_data *td = data;
559 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
561 td->o.verify_cpumask_set = 1;
567 #ifdef FIO_HAVE_LIBNUMA
568 static int str_numa_cpunodes_cb(void *data, char *input)
570 struct thread_data *td = data;
572 /* numa_parse_nodestring() parses a character string list
573 * of nodes into a bit mask. The bit mask is allocated by
574 * numa_allocate_nodemask(), so it should be freed by
575 * numa_free_nodemask().
577 td->o.numa_cpunodesmask = numa_parse_nodestring(input);
578 if (td->o.numa_cpunodesmask == NULL) {
579 log_err("fio: numa_parse_nodestring failed\n");
580 td_verror(td, 1, "str_numa_cpunodes_cb");
584 td->o.numa_cpumask_set = 1;
588 static int str_numa_mpol_cb(void *data, char *input)
590 struct thread_data *td = data;
591 const char * const policy_types[] =
592 { "default", "prefer", "bind", "interleave", "local" };
595 char *nodelist = strchr(input, ':');
597 /* NUL-terminate mode */
601 for (i = 0; i <= MPOL_LOCAL; i++) {
602 if (!strcmp(input, policy_types[i])) {
603 td->o.numa_mem_mode = i;
607 if (i > MPOL_LOCAL) {
608 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
612 switch (td->o.numa_mem_mode) {
615 * Insist on a nodelist of one node only
618 char *rest = nodelist;
619 while (isdigit(*rest))
622 log_err("fio: one node only for \'prefer\'\n");
626 log_err("fio: one node is needed for \'prefer\'\n");
630 case MPOL_INTERLEAVE:
632 * Default to online nodes with memory if no nodelist
635 nodelist = strdup("all");
640 * Don't allow a nodelist
643 log_err("fio: NO nodelist for \'local\'\n");
649 * Insist on a nodelist
652 log_err("fio: a nodelist is needed for \'bind\'\n");
659 /* numa_parse_nodestring() parses a character string list
660 * of nodes into a bit mask. The bit mask is allocated by
661 * numa_allocate_nodemask(), so it should be freed by
662 * numa_free_nodemask().
664 switch (td->o.numa_mem_mode) {
666 td->o.numa_mem_prefer_node = atoi(nodelist);
668 case MPOL_INTERLEAVE:
670 td->o.numa_memnodesmask = numa_parse_nodestring(nodelist);
671 if (td->o.numa_memnodesmask == NULL) {
672 log_err("fio: numa_parse_nodestring failed\n");
673 td_verror(td, 1, "str_numa_memnodes_cb");
683 td->o.numa_memmask_set = 1;
692 static int str_verify_trim_cb(void *data, unsigned long long *val)
694 struct thread_data *td = data;
696 td->o.trim_percentage = *val;
701 static int str_fst_cb(void *data, const char *str)
703 struct thread_data *td = data;
704 char *nr = get_opt_postfix(str);
706 td->file_service_nr = 1;
708 td->file_service_nr = atoi(nr);
715 #ifdef FIO_HAVE_SYNC_FILE_RANGE
716 static int str_sfr_cb(void *data, const char *str)
718 struct thread_data *td = data;
719 char *nr = get_opt_postfix(str);
721 td->sync_file_range_nr = 1;
723 td->sync_file_range_nr = atoi(nr);
731 static int str_random_distribution_cb(void *data, const char *str)
733 struct thread_data *td = data;
737 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
739 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
744 nr = get_opt_postfix(str);
745 if (nr && !str_to_float(nr, &val)) {
746 log_err("fio: random postfix parsing failed\n");
753 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
755 log_err("fio: zipf theta must different than 1.0\n");
758 td->o.zipf_theta = val;
760 if (val <= 0.00 || val >= 1.00) {
761 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
764 td->o.pareto_h = val;
770 static int check_dir(struct thread_data *td, char *fname)
773 char file[PATH_MAX], *dir;
776 if (td->o.directory) {
777 strcpy(file, td->o.directory);
782 sprintf(file + elen, "%s", fname);
788 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
789 * yet, so we can't do this check right here...
791 if (lstat(dir, &sb) < 0) {
794 log_err("fio: %s is not a directory\n", dir);
795 td_verror(td, ret, "lstat");
799 if (!S_ISDIR(sb.st_mode)) {
800 log_err("fio: %s is not a directory\n", dir);
810 * Return next file in the string. Files are separated with ':'. If the ':'
811 * is escaped with a '\', then that ':' is part of the filename and does not
812 * indicate a new file.
814 static char *get_next_file_name(char **ptr)
819 if (!str || !strlen(str))
825 * No colon, we are done
827 p = strchr(str, ':');
834 * We got a colon, but it's the first character. Skip and
842 if (*(p - 1) != '\\') {
848 memmove(p - 1, p, strlen(p) + 1);
855 static int str_filename_cb(void *data, const char *input)
857 struct thread_data *td = data;
858 char *fname, *str, *p;
860 p = str = strdup(input);
862 strip_blank_front(&str);
863 strip_blank_end(str);
865 if (!td->files_index)
868 while ((fname = get_next_file_name(&str)) != NULL) {
871 if (check_dir(td, fname)) {
883 static int str_directory_cb(void *data, const char fio_unused *str)
885 struct thread_data *td = data;
888 if (lstat(td->o.directory, &sb) < 0) {
891 log_err("fio: %s is not a directory\n", td->o.directory);
892 td_verror(td, ret, "lstat");
895 if (!S_ISDIR(sb.st_mode)) {
896 log_err("fio: %s is not a directory\n", td->o.directory);
903 static int str_opendir_cb(void *data, const char fio_unused *str)
905 struct thread_data *td = data;
907 if (!td->files_index)
910 return add_dir_files(td, td->o.opendir);
913 static int str_verify_offset_cb(void *data, unsigned long long *off)
915 struct thread_data *td = data;
917 if (*off && *off < sizeof(struct verify_header)) {
918 log_err("fio: verify_offset too small\n");
922 td->o.verify_offset = *off;
926 static int str_verify_pattern_cb(void *data, const char *input)
928 struct thread_data *td = data;
930 int i = 0, j = 0, len, k, base = 10;
933 loc1 = strstr(input, "0x");
934 loc2 = strstr(input, "0X");
937 off = strtol(input, NULL, base);
938 if (off != LONG_MAX || errno != ERANGE) {
940 td->o.verify_pattern[i] = off & 0xff;
949 j = loc1 - input + 2;
951 j = loc2 - input + 2;
954 if (len - j < MAX_PATTERN_SIZE * 2) {
956 off = converthexchartoint(input[k--]);
958 off += (converthexchartoint(input[k--])
960 td->o.verify_pattern[i++] = (char) off;
966 * Fill the pattern all the way to the end. This greatly reduces
967 * the number of memcpy's we have to do when verifying the IO.
969 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
970 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
975 * The code in verify_io_u_pattern assumes a single byte pattern
976 * fills the whole verify pattern buffer.
978 memset(td->o.verify_pattern, td->o.verify_pattern[0],
982 td->o.verify_pattern_bytes = i;
985 * VERIFY_META could already be set
987 if (td->o.verify == VERIFY_NONE)
988 td->o.verify = VERIFY_PATTERN;
993 static int str_lockfile_cb(void *data, const char *str)
995 struct thread_data *td = data;
996 char *nr = get_opt_postfix(str);
998 td->o.lockfile_batch = 1;
1000 td->o.lockfile_batch = atoi(nr);
1007 static int str_write_bw_log_cb(void *data, const char *str)
1009 struct thread_data *td = data;
1012 td->o.bw_log_file = strdup(str);
1014 td->o.write_bw_log = 1;
1018 static int str_write_lat_log_cb(void *data, const char *str)
1020 struct thread_data *td = data;
1023 td->o.lat_log_file = strdup(str);
1025 td->o.write_lat_log = 1;
1029 static int str_write_iops_log_cb(void *data, const char *str)
1031 struct thread_data *td = data;
1034 td->o.iops_log_file = strdup(str);
1036 td->o.write_iops_log = 1;
1040 static int str_gtod_reduce_cb(void *data, int *il)
1042 struct thread_data *td = data;
1045 td->o.disable_lat = !!val;
1046 td->o.disable_clat = !!val;
1047 td->o.disable_slat = !!val;
1048 td->o.disable_bw = !!val;
1049 td->o.clat_percentiles = !val;
1051 td->tv_cache_mask = 63;
1056 static int str_gtod_cpu_cb(void *data, long long *il)
1058 struct thread_data *td = data;
1061 td->o.gtod_cpu = val;
1062 td->o.gtod_offload = 1;
1066 static int str_size_cb(void *data, unsigned long long *__val)
1068 struct thread_data *td = data;
1069 unsigned long long v = *__val;
1071 if (parse_is_percent(v)) {
1073 td->o.size_percent = -1ULL - v;
1080 static int rw_verify(struct fio_option *o, void *data)
1082 struct thread_data *td = data;
1084 if (read_only && td_write(td)) {
1085 log_err("fio: job <%s> has write bit set, but fio is in"
1086 " read-only mode\n", td->o.name);
1093 static int gtod_cpu_verify(struct fio_option *o, void *data)
1095 #ifndef FIO_HAVE_CPU_AFFINITY
1096 struct thread_data *td = data;
1098 if (td->o.gtod_cpu) {
1099 log_err("fio: platform must support CPU affinity for"
1100 "gettimeofday() offloading\n");
1108 static int kb_base_verify(struct fio_option *o, void *data)
1110 struct thread_data *td = data;
1112 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
1113 log_err("fio: kb_base set to nonsensical value: %u\n",
1122 * Map of job/command line options
1124 static struct fio_option options[FIO_MAX_OPTS] = {
1126 .name = "description",
1127 .type = FIO_OPT_STR_STORE,
1128 .off1 = td_var_offset(description),
1129 .help = "Text job description",
1133 .type = FIO_OPT_STR_STORE,
1134 .off1 = td_var_offset(name),
1135 .help = "Name of this job",
1138 .name = "directory",
1139 .type = FIO_OPT_STR_STORE,
1140 .off1 = td_var_offset(directory),
1141 .cb = str_directory_cb,
1142 .help = "Directory to store files in",
1146 .type = FIO_OPT_STR_STORE,
1147 .off1 = td_var_offset(filename),
1148 .cb = str_filename_cb,
1149 .prio = -1, /* must come after "directory" */
1150 .help = "File(s) to use for the workload",
1154 .type = FIO_OPT_INT,
1155 .off1 = td_var_offset(kb_base),
1156 .verify = kb_base_verify,
1159 .help = "How many bytes per KB for reporting (1000 or 1024)",
1163 .type = FIO_OPT_STR,
1164 .cb = str_lockfile_cb,
1165 .off1 = td_var_offset(file_lock_mode),
1166 .help = "Lock file when doing IO to it",
1167 .parent = "filename",
1171 .oval = FILE_LOCK_NONE,
1172 .help = "No file locking",
1174 { .ival = "exclusive",
1175 .oval = FILE_LOCK_EXCLUSIVE,
1176 .help = "Exclusive file lock",
1179 .ival = "readwrite",
1180 .oval = FILE_LOCK_READWRITE,
1181 .help = "Read vs write lock",
1187 .type = FIO_OPT_STR_STORE,
1188 .off1 = td_var_offset(opendir),
1189 .cb = str_opendir_cb,
1190 .help = "Recursively add files from this directory and down",
1194 .alias = "readwrite",
1195 .type = FIO_OPT_STR,
1197 .off1 = td_var_offset(td_ddir),
1198 .help = "IO direction",
1200 .verify = rw_verify,
1203 .oval = TD_DDIR_READ,
1204 .help = "Sequential read",
1207 .oval = TD_DDIR_WRITE,
1208 .help = "Sequential write",
1211 .oval = TD_DDIR_TRIM,
1212 .help = "Sequential trim",
1214 { .ival = "randread",
1215 .oval = TD_DDIR_RANDREAD,
1216 .help = "Random read",
1218 { .ival = "randwrite",
1219 .oval = TD_DDIR_RANDWRITE,
1220 .help = "Random write",
1222 { .ival = "randtrim",
1223 .oval = TD_DDIR_RANDTRIM,
1224 .help = "Random trim",
1228 .help = "Sequential read and write mix",
1230 { .ival = "readwrite",
1232 .help = "Sequential read and write mix",
1235 .oval = TD_DDIR_RANDRW,
1236 .help = "Random read and write mix"
1241 .name = "rw_sequencer",
1242 .type = FIO_OPT_STR,
1243 .off1 = td_var_offset(rw_seq),
1244 .help = "IO offset generator modifier",
1245 .def = "sequential",
1247 { .ival = "sequential",
1249 .help = "Generate sequential offsets",
1251 { .ival = "identical",
1252 .oval = RW_SEQ_IDENT,
1253 .help = "Generate identical offsets",
1260 .type = FIO_OPT_STR_STORE,
1261 .off1 = td_var_offset(ioengine),
1262 .help = "IO engine to use",
1263 .def = FIO_PREFERRED_ENGINE,
1266 .help = "Use read/write",
1269 .help = "Use pread/pwrite",
1272 .help = "Use readv/writev",
1274 #ifdef FIO_HAVE_LIBAIO
1276 .help = "Linux native asynchronous IO",
1279 #ifdef FIO_HAVE_POSIXAIO
1280 { .ival = "posixaio",
1281 .help = "POSIX asynchronous IO",
1284 #ifdef FIO_HAVE_SOLARISAIO
1285 { .ival = "solarisaio",
1286 .help = "Solaris native asynchronous IO",
1289 #ifdef FIO_HAVE_WINDOWSAIO
1290 { .ival = "windowsaio",
1291 .help = "Windows native asynchronous IO"
1295 .help = "Memory mapped IO"
1297 #ifdef FIO_HAVE_SPLICE
1299 .help = "splice/vmsplice based IO",
1301 { .ival = "netsplice",
1302 .help = "splice/vmsplice to/from the network",
1305 #ifdef FIO_HAVE_SGIO
1307 .help = "SCSI generic v3 IO",
1311 .help = "Testing engine (no data transfer)",
1314 .help = "Network IO",
1316 #ifdef FIO_HAVE_SYSLET
1317 { .ival = "syslet-rw",
1318 .help = "syslet enabled async pread/pwrite IO",
1322 .help = "CPU cycle burner engine",
1324 #ifdef FIO_HAVE_GUASI
1326 .help = "GUASI IO engine",
1329 #ifdef FIO_HAVE_BINJECT
1330 { .ival = "binject",
1331 .help = "binject direct inject block engine",
1334 #ifdef FIO_HAVE_RDMA
1336 .help = "RDMA IO engine",
1339 #ifdef FIO_HAVE_FUSION_AW
1340 { .ival = "fusion-aw-sync",
1341 .help = "Fusion-io atomic write engine",
1344 #ifdef FIO_HAVE_E4_ENG
1345 { .ival = "e4defrag",
1346 .help = "ext4 defrag engine",
1349 #ifdef FIO_HAVE_FALLOC_ENG
1351 .help = "fallocate() file based engine",
1354 { .ival = "external",
1355 .help = "Load external engine (append name)",
1361 .type = FIO_OPT_INT,
1362 .off1 = td_var_offset(iodepth),
1363 .help = "Number of IO buffers to keep in flight",
1368 .name = "iodepth_batch",
1369 .alias = "iodepth_batch_submit",
1370 .type = FIO_OPT_INT,
1371 .off1 = td_var_offset(iodepth_batch),
1372 .help = "Number of IO buffers to submit in one go",
1373 .parent = "iodepth",
1378 .name = "iodepth_batch_complete",
1379 .type = FIO_OPT_INT,
1380 .off1 = td_var_offset(iodepth_batch_complete),
1381 .help = "Number of IO buffers to retrieve in one go",
1382 .parent = "iodepth",
1387 .name = "iodepth_low",
1388 .type = FIO_OPT_INT,
1389 .off1 = td_var_offset(iodepth_low),
1390 .help = "Low water mark for queuing depth",
1391 .parent = "iodepth",
1395 .type = FIO_OPT_STR_VAL,
1397 .help = "Total size of device or files",
1400 .name = "fill_device",
1402 .type = FIO_OPT_BOOL,
1403 .off1 = td_var_offset(fill_device),
1404 .help = "Write until an ENOSPC error occurs",
1409 .type = FIO_OPT_STR_VAL,
1410 .off1 = td_var_offset(file_size_low),
1411 .off2 = td_var_offset(file_size_high),
1413 .help = "Size of individual files",
1417 .alias = "fileoffset",
1418 .type = FIO_OPT_STR_VAL,
1419 .off1 = td_var_offset(start_offset),
1420 .help = "Start IO from this offset",
1424 .name = "offset_increment",
1425 .type = FIO_OPT_STR_VAL,
1426 .off1 = td_var_offset(offset_increment),
1427 .help = "What is the increment from one offset to the next",
1433 .alias = "blocksize",
1434 .type = FIO_OPT_INT,
1435 .off1 = td_var_offset(bs[DDIR_READ]),
1436 .off2 = td_var_offset(bs[DDIR_WRITE]),
1437 .off3 = td_var_offset(bs[DDIR_TRIM]),
1439 .help = "Block size unit",
1445 .alias = "blockalign",
1446 .type = FIO_OPT_INT,
1447 .off1 = td_var_offset(ba[DDIR_READ]),
1448 .off2 = td_var_offset(ba[DDIR_WRITE]),
1449 .off3 = td_var_offset(ba[DDIR_TRIM]),
1451 .help = "IO block offset alignment",
1456 .alias = "blocksize_range",
1457 .type = FIO_OPT_RANGE,
1458 .off1 = td_var_offset(min_bs[DDIR_READ]),
1459 .off2 = td_var_offset(max_bs[DDIR_READ]),
1460 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1461 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1462 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1463 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1465 .help = "Set block size range (in more detail than bs)",
1470 .type = FIO_OPT_STR,
1471 .cb = str_bssplit_cb,
1472 .help = "Set a specific mix of block sizes",
1476 .name = "bs_unaligned",
1477 .alias = "blocksize_unaligned",
1478 .type = FIO_OPT_STR_SET,
1479 .off1 = td_var_offset(bs_unaligned),
1480 .help = "Don't sector align IO buffer sizes",
1484 .name = "randrepeat",
1485 .type = FIO_OPT_BOOL,
1486 .off1 = td_var_offset(rand_repeatable),
1487 .help = "Use repeatable random IO pattern",
1492 .name = "use_os_rand",
1493 .type = FIO_OPT_BOOL,
1494 .off1 = td_var_offset(use_os_rand),
1495 .help = "Set to use OS random generator",
1500 .name = "norandommap",
1501 .type = FIO_OPT_STR_SET,
1502 .off1 = td_var_offset(norandommap),
1503 .help = "Accept potential duplicate random blocks",
1507 .name = "softrandommap",
1508 .type = FIO_OPT_BOOL,
1509 .off1 = td_var_offset(softrandommap),
1510 .help = "Set norandommap if randommap allocation fails",
1511 .parent = "norandommap",
1515 .name = "random_distribution",
1516 .type = FIO_OPT_STR,
1517 .off1 = td_var_offset(random_distribution),
1518 .cb = str_random_distribution_cb,
1519 .help = "Random offset distribution generator",
1523 .oval = FIO_RAND_DIST_RANDOM,
1524 .help = "Completely random",
1527 .oval = FIO_RAND_DIST_ZIPF,
1528 .help = "Zipf distribution",
1531 .oval = FIO_RAND_DIST_PARETO,
1532 .help = "Pareto distribution",
1538 .alias = "nr_files",
1539 .type = FIO_OPT_INT,
1540 .off1 = td_var_offset(nr_files),
1541 .help = "Split job workload between this number of files",
1545 .name = "openfiles",
1546 .type = FIO_OPT_INT,
1547 .off1 = td_var_offset(open_files),
1548 .help = "Number of files to keep open at the same time",
1551 .name = "file_service_type",
1552 .type = FIO_OPT_STR,
1554 .off1 = td_var_offset(file_service_type),
1555 .help = "How to select which file to service next",
1556 .def = "roundrobin",
1559 .oval = FIO_FSERVICE_RANDOM,
1560 .help = "Choose a file at random",
1562 { .ival = "roundrobin",
1563 .oval = FIO_FSERVICE_RR,
1564 .help = "Round robin select files",
1566 { .ival = "sequential",
1567 .oval = FIO_FSERVICE_SEQ,
1568 .help = "Finish one file before moving to the next",
1571 .parent = "nrfiles",
1573 #ifdef FIO_HAVE_FALLOCATE
1575 .name = "fallocate",
1576 .type = FIO_OPT_STR,
1577 .off1 = td_var_offset(fallocate_mode),
1578 .help = "Whether pre-allocation is performed when laying out files",
1582 .oval = FIO_FALLOCATE_NONE,
1583 .help = "Do not pre-allocate space",
1586 .oval = FIO_FALLOCATE_POSIX,
1587 .help = "Use posix_fallocate()",
1589 #ifdef FIO_HAVE_LINUX_FALLOCATE
1591 .oval = FIO_FALLOCATE_KEEP_SIZE,
1592 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1595 /* Compatibility with former boolean values */
1597 .oval = FIO_FALLOCATE_NONE,
1598 .help = "Alias for 'none'",
1601 .oval = FIO_FALLOCATE_POSIX,
1602 .help = "Alias for 'posix'",
1606 #endif /* FIO_HAVE_FALLOCATE */
1608 .name = "fadvise_hint",
1609 .type = FIO_OPT_BOOL,
1610 .off1 = td_var_offset(fadvise_hint),
1611 .help = "Use fadvise() to advise the kernel on IO pattern",
1616 .type = FIO_OPT_INT,
1617 .off1 = td_var_offset(fsync_blocks),
1618 .help = "Issue fsync for writes every given number of blocks",
1622 .name = "fdatasync",
1623 .type = FIO_OPT_INT,
1624 .off1 = td_var_offset(fdatasync_blocks),
1625 .help = "Issue fdatasync for writes every given number of blocks",
1629 .name = "write_barrier",
1630 .type = FIO_OPT_INT,
1631 .off1 = td_var_offset(barrier_blocks),
1632 .help = "Make every Nth write a barrier write",
1635 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1637 .name = "sync_file_range",
1639 { .ival = "wait_before",
1640 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1641 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1645 .oval = SYNC_FILE_RANGE_WRITE,
1646 .help = "SYNC_FILE_RANGE_WRITE",
1650 .ival = "wait_after",
1651 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1652 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1656 .type = FIO_OPT_STR_MULTI,
1658 .off1 = td_var_offset(sync_file_range),
1659 .help = "Use sync_file_range()",
1664 .type = FIO_OPT_BOOL,
1665 .off1 = td_var_offset(odirect),
1666 .help = "Use O_DIRECT IO (negates buffered)",
1671 .type = FIO_OPT_BOOL,
1672 .off1 = td_var_offset(odirect),
1674 .help = "Use buffered IO (negates direct)",
1678 .name = "overwrite",
1679 .type = FIO_OPT_BOOL,
1680 .off1 = td_var_offset(overwrite),
1681 .help = "When writing, set whether to overwrite current data",
1686 .type = FIO_OPT_INT,
1687 .off1 = td_var_offset(loops),
1688 .help = "Number of times to run the job",
1693 .type = FIO_OPT_INT,
1694 .off1 = td_var_offset(numjobs),
1695 .help = "Duplicate this job this many times",
1699 .name = "startdelay",
1700 .type = FIO_OPT_STR_VAL_TIME,
1701 .off1 = td_var_offset(start_delay),
1702 .help = "Only start job when this period has passed",
1708 .type = FIO_OPT_STR_VAL_TIME,
1709 .off1 = td_var_offset(timeout),
1710 .help = "Stop workload when this amount of time has passed",
1714 .name = "time_based",
1715 .type = FIO_OPT_STR_SET,
1716 .off1 = td_var_offset(time_based),
1717 .help = "Keep running until runtime/timeout is met",
1720 .name = "ramp_time",
1721 .type = FIO_OPT_STR_VAL_TIME,
1722 .off1 = td_var_offset(ramp_time),
1723 .help = "Ramp up time before measuring performance",
1726 .name = "clocksource",
1727 .type = FIO_OPT_STR,
1728 .cb = fio_clock_source_cb,
1729 .off1 = td_var_offset(clocksource),
1730 .help = "What type of timing source to use",
1732 { .ival = "gettimeofday",
1734 .help = "Use gettimeofday(2) for timing",
1736 { .ival = "clock_gettime",
1737 .oval = CS_CGETTIME,
1738 .help = "Use clock_gettime(2) for timing",
1740 #ifdef ARCH_HAVE_CPU_CLOCK
1742 .oval = CS_CPUCLOCK,
1743 .help = "Use CPU private clock",
1751 .type = FIO_OPT_STR,
1753 .off1 = td_var_offset(mem_type),
1754 .help = "Backing type for IO buffers",
1759 .help = "Use malloc(3) for IO buffers",
1763 .help = "Use shared memory segments for IO buffers",
1765 #ifdef FIO_HAVE_HUGETLB
1766 { .ival = "shmhuge",
1767 .oval = MEM_SHMHUGE,
1768 .help = "Like shm, but use huge pages",
1773 .help = "Use mmap(2) (file or anon) for IO buffers",
1775 #ifdef FIO_HAVE_HUGETLB
1776 { .ival = "mmaphuge",
1777 .oval = MEM_MMAPHUGE,
1778 .help = "Like mmap, but use huge pages",
1784 .name = "iomem_align",
1785 .alias = "mem_align",
1786 .type = FIO_OPT_INT,
1787 .off1 = td_var_offset(mem_align),
1789 .help = "IO memory buffer offset alignment",
1795 .type = FIO_OPT_STR,
1796 .off1 = td_var_offset(verify),
1797 .help = "Verify data written",
1798 .cb = str_verify_cb,
1802 .oval = VERIFY_NONE,
1803 .help = "Don't do IO verification",
1807 .help = "Use md5 checksums for verification",
1810 .oval = VERIFY_CRC64,
1811 .help = "Use crc64 checksums for verification",
1814 .oval = VERIFY_CRC32,
1815 .help = "Use crc32 checksums for verification",
1817 { .ival = "crc32c-intel",
1818 .oval = VERIFY_CRC32C,
1819 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1822 .oval = VERIFY_CRC32C,
1823 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1826 .oval = VERIFY_CRC16,
1827 .help = "Use crc16 checksums for verification",
1830 .oval = VERIFY_CRC7,
1831 .help = "Use crc7 checksums for verification",
1834 .oval = VERIFY_SHA1,
1835 .help = "Use sha1 checksums for verification",
1838 .oval = VERIFY_SHA256,
1839 .help = "Use sha256 checksums for verification",
1842 .oval = VERIFY_SHA512,
1843 .help = "Use sha512 checksums for verification",
1846 .oval = VERIFY_META,
1847 .help = "Use io information",
1851 .oval = VERIFY_NULL,
1852 .help = "Pretend to verify",
1857 .name = "do_verify",
1858 .type = FIO_OPT_BOOL,
1859 .off1 = td_var_offset(do_verify),
1860 .help = "Run verification stage after write",
1865 .name = "verifysort",
1866 .type = FIO_OPT_BOOL,
1867 .off1 = td_var_offset(verifysort),
1868 .help = "Sort written verify blocks for read back",
1873 .name = "verify_interval",
1874 .type = FIO_OPT_INT,
1875 .off1 = td_var_offset(verify_interval),
1876 .minval = 2 * sizeof(struct verify_header),
1877 .help = "Store verify buffer header every N bytes",
1881 .name = "verify_offset",
1882 .type = FIO_OPT_INT,
1883 .help = "Offset verify header location by N bytes",
1885 .cb = str_verify_offset_cb,
1889 .name = "verify_pattern",
1890 .type = FIO_OPT_STR,
1891 .cb = str_verify_pattern_cb,
1892 .help = "Fill pattern for IO buffers",
1896 .name = "verify_fatal",
1897 .type = FIO_OPT_BOOL,
1898 .off1 = td_var_offset(verify_fatal),
1900 .help = "Exit on a single verify failure, don't continue",
1904 .name = "verify_dump",
1905 .type = FIO_OPT_BOOL,
1906 .off1 = td_var_offset(verify_dump),
1908 .help = "Dump contents of good and bad blocks on failure",
1912 .name = "verify_async",
1913 .type = FIO_OPT_INT,
1914 .off1 = td_var_offset(verify_async),
1916 .help = "Number of async verifier threads to use",
1920 .name = "verify_backlog",
1921 .type = FIO_OPT_STR_VAL,
1922 .off1 = td_var_offset(verify_backlog),
1923 .help = "Verify after this number of blocks are written",
1927 .name = "verify_backlog_batch",
1928 .type = FIO_OPT_INT,
1929 .off1 = td_var_offset(verify_batch),
1930 .help = "Verify this number of IO blocks",
1933 #ifdef FIO_HAVE_CPU_AFFINITY
1935 .name = "verify_async_cpus",
1936 .type = FIO_OPT_STR,
1937 .cb = str_verify_cpus_allowed_cb,
1938 .help = "Set CPUs allowed for async verify threads",
1939 .parent = "verify_async",
1942 #ifdef FIO_HAVE_TRIM
1944 .name = "trim_percentage",
1945 .type = FIO_OPT_INT,
1946 .cb = str_verify_trim_cb,
1948 .help = "Number of verify blocks to discard/trim",
1953 .name = "trim_verify_zero",
1954 .type = FIO_OPT_INT,
1955 .help = "Verify that trim/discarded blocks are returned as zeroes",
1956 .off1 = td_var_offset(trim_zero),
1957 .parent = "trim_percentage",
1961 .name = "trim_backlog",
1962 .type = FIO_OPT_STR_VAL,
1963 .off1 = td_var_offset(trim_backlog),
1964 .help = "Trim after this number of blocks are written",
1965 .parent = "trim_percentage",
1968 .name = "trim_backlog_batch",
1969 .type = FIO_OPT_INT,
1970 .off1 = td_var_offset(trim_batch),
1971 .help = "Trim this number of IO blocks",
1972 .parent = "trim_percentage",
1976 .name = "write_iolog",
1977 .type = FIO_OPT_STR_STORE,
1978 .off1 = td_var_offset(write_iolog_file),
1979 .help = "Store IO pattern to file",
1982 .name = "read_iolog",
1983 .type = FIO_OPT_STR_STORE,
1984 .off1 = td_var_offset(read_iolog_file),
1985 .help = "Playback IO pattern from file",
1988 .name = "replay_no_stall",
1989 .type = FIO_OPT_INT,
1990 .off1 = td_var_offset(no_stall),
1992 .parent = "read_iolog",
1993 .help = "Playback IO pattern file as fast as possible without stalls",
1996 .name = "replay_redirect",
1997 .type = FIO_OPT_STR_STORE,
1998 .off1 = td_var_offset(replay_redirect),
1999 .parent = "read_iolog",
2000 .help = "Replay all I/O onto this device, regardless of trace device",
2003 .name = "exec_prerun",
2004 .type = FIO_OPT_STR_STORE,
2005 .off1 = td_var_offset(exec_prerun),
2006 .help = "Execute this file prior to running job",
2009 .name = "exec_postrun",
2010 .type = FIO_OPT_STR_STORE,
2011 .off1 = td_var_offset(exec_postrun),
2012 .help = "Execute this file after running job",
2014 #ifdef FIO_HAVE_IOSCHED_SWITCH
2016 .name = "ioscheduler",
2017 .type = FIO_OPT_STR_STORE,
2018 .off1 = td_var_offset(ioscheduler),
2019 .help = "Use this IO scheduler on the backing device",
2024 .type = FIO_OPT_STR_VAL,
2025 .off1 = td_var_offset(zone_size),
2026 .help = "Amount of data to read per zone",
2030 .name = "zonerange",
2031 .type = FIO_OPT_STR_VAL,
2032 .off1 = td_var_offset(zone_range),
2033 .help = "Give size of an IO zone",
2038 .type = FIO_OPT_STR_VAL,
2039 .off1 = td_var_offset(zone_skip),
2040 .help = "Space between IO zones",
2045 .type = FIO_OPT_STR_VAL,
2046 .cb = str_lockmem_cb,
2047 .help = "Lock down this amount of memory",
2051 .name = "rwmixread",
2052 .type = FIO_OPT_INT,
2053 .cb = str_rwmix_read_cb,
2055 .help = "Percentage of mixed workload that is reads",
2059 .name = "rwmixwrite",
2060 .type = FIO_OPT_INT,
2061 .cb = str_rwmix_write_cb,
2063 .help = "Percentage of mixed workload that is writes",
2067 .name = "rwmixcycle",
2068 .type = FIO_OPT_DEPRECATED,
2072 .type = FIO_OPT_INT,
2073 .off1 = td_var_offset(nice),
2074 .help = "Set job CPU nice value",
2079 #ifdef FIO_HAVE_IOPRIO
2082 .type = FIO_OPT_INT,
2084 .help = "Set job IO priority value",
2089 .name = "prioclass",
2090 .type = FIO_OPT_INT,
2091 .cb = str_prioclass_cb,
2092 .help = "Set job IO priority class",
2098 .name = "thinktime",
2099 .type = FIO_OPT_INT,
2100 .off1 = td_var_offset(thinktime),
2101 .help = "Idle time between IO buffers (usec)",
2105 .name = "thinktime_spin",
2106 .type = FIO_OPT_INT,
2107 .off1 = td_var_offset(thinktime_spin),
2108 .help = "Start think time by spinning this amount (usec)",
2110 .parent = "thinktime",
2113 .name = "thinktime_blocks",
2114 .type = FIO_OPT_INT,
2115 .off1 = td_var_offset(thinktime_blocks),
2116 .help = "IO buffer period between 'thinktime'",
2118 .parent = "thinktime",
2122 .type = FIO_OPT_INT,
2123 .off1 = td_var_offset(rate[DDIR_READ]),
2124 .off2 = td_var_offset(rate[DDIR_WRITE]),
2125 .off3 = td_var_offset(rate[DDIR_TRIM]),
2126 .help = "Set bandwidth rate",
2130 .type = FIO_OPT_INT,
2131 .off1 = td_var_offset(ratemin[DDIR_READ]),
2132 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
2133 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
2134 .help = "Job must meet this rate or it will be shutdown",
2138 .name = "rate_iops",
2139 .type = FIO_OPT_INT,
2140 .off1 = td_var_offset(rate_iops[DDIR_READ]),
2141 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
2142 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
2143 .help = "Limit IO used to this number of IO operations/sec",
2146 .name = "rate_iops_min",
2147 .type = FIO_OPT_INT,
2148 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
2149 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
2150 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
2151 .help = "Job must meet this rate or it will be shut down",
2152 .parent = "rate_iops",
2155 .name = "ratecycle",
2156 .type = FIO_OPT_INT,
2157 .off1 = td_var_offset(ratecycle),
2158 .help = "Window average for rate limits (msec)",
2163 .name = "max_latency",
2164 .type = FIO_OPT_INT,
2165 .off1 = td_var_offset(max_latency),
2166 .help = "Maximum tolerated IO latency (usec)",
2169 .name = "invalidate",
2170 .type = FIO_OPT_BOOL,
2171 .off1 = td_var_offset(invalidate_cache),
2172 .help = "Invalidate buffer/page cache prior to running job",
2177 .type = FIO_OPT_BOOL,
2178 .off1 = td_var_offset(sync_io),
2179 .help = "Use O_SYNC for buffered writes",
2181 .parent = "buffered",
2184 .name = "bwavgtime",
2185 .type = FIO_OPT_INT,
2186 .off1 = td_var_offset(bw_avg_time),
2187 .help = "Time window over which to calculate bandwidth"
2190 .parent = "write_bw_log",
2193 .name = "iopsavgtime",
2194 .type = FIO_OPT_INT,
2195 .off1 = td_var_offset(iops_avg_time),
2196 .help = "Time window over which to calculate IOPS (msec)",
2198 .parent = "write_iops_log",
2201 .name = "create_serialize",
2202 .type = FIO_OPT_BOOL,
2203 .off1 = td_var_offset(create_serialize),
2204 .help = "Serialize creating of job files",
2208 .name = "create_fsync",
2209 .type = FIO_OPT_BOOL,
2210 .off1 = td_var_offset(create_fsync),
2211 .help = "fsync file after creation",
2215 .name = "create_on_open",
2216 .type = FIO_OPT_BOOL,
2217 .off1 = td_var_offset(create_on_open),
2218 .help = "Create files when they are opened for IO",
2222 .name = "create_only",
2223 .type = FIO_OPT_BOOL,
2224 .off1 = td_var_offset(create_only),
2225 .help = "Only perform file creation phase",
2230 .type = FIO_OPT_BOOL,
2231 .off1 = td_var_offset(pre_read),
2232 .help = "Pre-read files before starting official testing",
2237 .type = FIO_OPT_INT,
2238 .off1 = td_var_offset(cpuload),
2239 .help = "Use this percentage of CPU",
2242 .name = "cpuchunks",
2243 .type = FIO_OPT_INT,
2244 .off1 = td_var_offset(cpucycle),
2245 .help = "Length of the CPU burn cycles (usecs)",
2247 .parent = "cpuload",
2249 #ifdef FIO_HAVE_CPU_AFFINITY
2252 .type = FIO_OPT_INT,
2253 .cb = str_cpumask_cb,
2254 .help = "CPU affinity mask",
2257 .name = "cpus_allowed",
2258 .type = FIO_OPT_STR,
2259 .cb = str_cpus_allowed_cb,
2260 .help = "Set CPUs allowed",
2263 #ifdef FIO_HAVE_LIBNUMA
2265 .name = "numa_cpu_nodes",
2266 .type = FIO_OPT_STR,
2267 .cb = str_numa_cpunodes_cb,
2268 .help = "NUMA CPU nodes bind",
2271 .name = "numa_mem_policy",
2272 .type = FIO_OPT_STR,
2273 .cb = str_numa_mpol_cb,
2274 .help = "NUMA memory policy setup",
2278 .name = "end_fsync",
2279 .type = FIO_OPT_BOOL,
2280 .off1 = td_var_offset(end_fsync),
2281 .help = "Include fsync at the end of job",
2285 .name = "fsync_on_close",
2286 .type = FIO_OPT_BOOL,
2287 .off1 = td_var_offset(fsync_on_close),
2288 .help = "fsync files on close",
2293 .type = FIO_OPT_BOOL,
2294 .off1 = td_var_offset(unlink),
2295 .help = "Unlink created files after job has completed",
2300 .type = FIO_OPT_STR_SET,
2301 .cb = str_exitall_cb,
2302 .help = "Terminate all jobs when one exits",
2305 .name = "stonewall",
2306 .alias = "wait_for_previous",
2307 .type = FIO_OPT_STR_SET,
2308 .off1 = td_var_offset(stonewall),
2309 .help = "Insert a hard barrier between this job and previous",
2312 .name = "new_group",
2313 .type = FIO_OPT_STR_SET,
2314 .off1 = td_var_offset(new_group),
2315 .help = "Mark the start of a new group (for reporting)",
2319 .type = FIO_OPT_STR_SET,
2320 .off1 = td_var_offset(use_thread),
2321 .help = "Use threads instead of forks",
2324 .name = "write_bw_log",
2325 .type = FIO_OPT_STR,
2326 .off1 = td_var_offset(write_bw_log),
2327 .cb = str_write_bw_log_cb,
2328 .help = "Write log of bandwidth during run",
2331 .name = "write_lat_log",
2332 .type = FIO_OPT_STR,
2333 .off1 = td_var_offset(write_lat_log),
2334 .cb = str_write_lat_log_cb,
2335 .help = "Write log of latency during run",
2338 .name = "write_iops_log",
2339 .type = FIO_OPT_STR,
2340 .off1 = td_var_offset(write_iops_log),
2341 .cb = str_write_iops_log_cb,
2342 .help = "Write log of IOPS during run",
2345 .name = "log_avg_msec",
2346 .type = FIO_OPT_INT,
2347 .off1 = td_var_offset(log_avg_msec),
2348 .help = "Average bw/iops/lat logs over this period of time",
2352 .name = "hugepage-size",
2353 .type = FIO_OPT_INT,
2354 .off1 = td_var_offset(hugepage_size),
2355 .help = "When using hugepages, specify size of each page",
2356 .def = __fio_stringify(FIO_HUGE_PAGE),
2359 .name = "group_reporting",
2360 .type = FIO_OPT_STR_SET,
2361 .off1 = td_var_offset(group_reporting),
2362 .help = "Do reporting on a per-group basis",
2365 .name = "zero_buffers",
2366 .type = FIO_OPT_STR_SET,
2367 .off1 = td_var_offset(zero_buffers),
2368 .help = "Init IO buffers to all zeroes",
2371 .name = "refill_buffers",
2372 .type = FIO_OPT_STR_SET,
2373 .off1 = td_var_offset(refill_buffers),
2374 .help = "Refill IO buffers on every IO submit",
2377 .name = "scramble_buffers",
2378 .type = FIO_OPT_BOOL,
2379 .off1 = td_var_offset(scramble_buffers),
2380 .help = "Slightly scramble buffers on every IO submit",
2384 .name = "buffer_compress_percentage",
2385 .type = FIO_OPT_INT,
2386 .off1 = td_var_offset(compress_percentage),
2389 .help = "How compressible the buffer is (approximately)",
2392 .name = "buffer_compress_chunk",
2393 .type = FIO_OPT_INT,
2394 .off1 = td_var_offset(compress_chunk),
2395 .parent = "buffer_compress_percentage",
2396 .help = "Size of compressible region in buffer",
2399 .name = "clat_percentiles",
2400 .type = FIO_OPT_BOOL,
2401 .off1 = td_var_offset(clat_percentiles),
2402 .help = "Enable the reporting of completion latency percentiles",
2406 .name = "percentile_list",
2407 .type = FIO_OPT_FLOAT_LIST,
2408 .off1 = td_var_offset(percentile_list),
2409 .off2 = td_var_offset(overwrite_plist),
2410 .help = "Specify a custom list of percentiles to report",
2411 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2416 #ifdef FIO_HAVE_DISK_UTIL
2418 .name = "disk_util",
2419 .type = FIO_OPT_BOOL,
2420 .off1 = td_var_offset(do_disk_util),
2421 .help = "Log disk utilization statistics",
2426 .name = "gtod_reduce",
2427 .type = FIO_OPT_BOOL,
2428 .help = "Greatly reduce number of gettimeofday() calls",
2429 .cb = str_gtod_reduce_cb,
2433 .name = "disable_lat",
2434 .type = FIO_OPT_BOOL,
2435 .off1 = td_var_offset(disable_lat),
2436 .help = "Disable latency numbers",
2437 .parent = "gtod_reduce",
2441 .name = "disable_clat",
2442 .type = FIO_OPT_BOOL,
2443 .off1 = td_var_offset(disable_clat),
2444 .help = "Disable completion latency numbers",
2445 .parent = "gtod_reduce",
2449 .name = "disable_slat",
2450 .type = FIO_OPT_BOOL,
2451 .off1 = td_var_offset(disable_slat),
2452 .help = "Disable submission latency numbers",
2453 .parent = "gtod_reduce",
2457 .name = "disable_bw_measurement",
2458 .type = FIO_OPT_BOOL,
2459 .off1 = td_var_offset(disable_bw),
2460 .help = "Disable bandwidth logging",
2461 .parent = "gtod_reduce",
2466 .type = FIO_OPT_INT,
2467 .cb = str_gtod_cpu_cb,
2468 .help = "Set up dedicated gettimeofday() thread on this CPU",
2469 .verify = gtod_cpu_verify,
2472 .name = "continue_on_error",
2473 .type = FIO_OPT_STR,
2474 .off1 = td_var_offset(continue_on_error),
2475 .help = "Continue on non-fatal errors during IO",
2479 .oval = ERROR_TYPE_NONE,
2480 .help = "Exit when an error is encountered",
2483 .oval = ERROR_TYPE_READ,
2484 .help = "Continue on read errors only",
2487 .oval = ERROR_TYPE_WRITE,
2488 .help = "Continue on write errors only",
2491 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2492 .help = "Continue on any IO errors",
2495 .oval = ERROR_TYPE_VERIFY,
2496 .help = "Continue on verify errors only",
2499 .oval = ERROR_TYPE_ANY,
2500 .help = "Continue on all io and verify errors",
2503 .oval = ERROR_TYPE_NONE,
2504 .help = "Alias for 'none'",
2507 .oval = ERROR_TYPE_ANY,
2508 .help = "Alias for 'all'",
2513 .name = "ignore_error",
2514 .type = FIO_OPT_STR,
2515 .cb = str_ignore_error_cb,
2516 .help = "Set a specific list of errors to ignore",
2520 .name = "error_dump",
2521 .type = FIO_OPT_BOOL,
2522 .off1 = td_var_offset(error_dump),
2524 .help = "Dump info on each error",
2529 .type = FIO_OPT_STR_STORE,
2530 .off1 = td_var_offset(profile),
2531 .help = "Select a specific builtin performance test",
2535 .type = FIO_OPT_STR_STORE,
2536 .off1 = td_var_offset(cgroup),
2537 .help = "Add job to cgroup of this name",
2540 .name = "cgroup_weight",
2541 .type = FIO_OPT_INT,
2542 .off1 = td_var_offset(cgroup_weight),
2543 .help = "Use given weight for cgroup",
2548 .name = "cgroup_nodelete",
2549 .type = FIO_OPT_BOOL,
2550 .off1 = td_var_offset(cgroup_nodelete),
2551 .help = "Do not delete cgroups after job completion",
2556 .type = FIO_OPT_INT,
2557 .off1 = td_var_offset(uid),
2558 .help = "Run job with this user ID",
2562 .type = FIO_OPT_INT,
2563 .off1 = td_var_offset(gid),
2564 .help = "Run job with this group ID",
2568 .type = FIO_OPT_INT,
2569 .off1 = td_var_offset(flow_id),
2570 .help = "The flow index ID to use",
2575 .type = FIO_OPT_INT,
2576 .off1 = td_var_offset(flow),
2577 .help = "Weight for flow control of this job",
2578 .parent = "flow_id",
2582 .name = "flow_watermark",
2583 .type = FIO_OPT_INT,
2584 .off1 = td_var_offset(flow_watermark),
2585 .help = "High watermark for flow control. This option"
2586 " should be set to the same value for all threads"
2587 " with non-zero flow.",
2588 .parent = "flow_id",
2592 .name = "flow_sleep",
2593 .type = FIO_OPT_INT,
2594 .off1 = td_var_offset(flow_sleep),
2595 .help = "How many microseconds to sleep after being held"
2596 " back by the flow control mechanism",
2597 .parent = "flow_id",
2605 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2606 const char *name, int val)
2608 lopt->name = (char *) name;
2610 if (o->type == FIO_OPT_STR_SET)
2611 lopt->has_arg = no_argument;
2613 lopt->has_arg = required_argument;
2616 static void options_to_lopts(struct fio_option *opts,
2617 struct option *long_options,
2618 int i, int option_type)
2620 struct fio_option *o = &opts[0];
2622 add_to_lopt(&long_options[i], o, o->name, option_type);
2625 add_to_lopt(&long_options[i], o, o->alias, option_type);
2630 assert(i < FIO_NR_OPTIONS);
2634 void fio_options_set_ioengine_opts(struct option *long_options,
2635 struct thread_data *td)
2640 while (long_options[i].name) {
2641 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2642 memset(&long_options[i], 0, sizeof(*long_options));
2649 * Just clear out the prior ioengine options.
2654 options_to_lopts(td->io_ops->options, long_options, i,
2655 FIO_GETOPT_IOENGINE);
2658 void fio_options_dup_and_init(struct option *long_options)
2662 options_init(options);
2665 while (long_options[i].name)
2668 options_to_lopts(options, long_options, i, FIO_GETOPT_JOB);
2671 struct fio_keyword {
2677 static struct fio_keyword fio_keywords[] = {
2679 .word = "$pagesize",
2680 .desc = "Page size in the system",
2683 .word = "$mb_memory",
2684 .desc = "Megabytes of memory online",
2688 .desc = "Number of CPUs online in the system",
2695 void fio_keywords_init(void)
2697 unsigned long long mb_memory;
2701 sprintf(buf, "%lu", (unsigned long) page_size);
2702 fio_keywords[0].replace = strdup(buf);
2704 mb_memory = os_phys_mem() / (1024 * 1024);
2705 sprintf(buf, "%llu", mb_memory);
2706 fio_keywords[1].replace = strdup(buf);
2709 sprintf(buf, "%lu", l);
2710 fio_keywords[2].replace = strdup(buf);
2715 static char *bc_calc(char *str)
2717 char buf[128], *tmp;
2722 * No math, just return string
2724 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2725 !strchr(str, '/')) || strchr(str, '\''))
2729 * Split option from value, we only need to calculate the value
2731 tmp = strchr(str, '=');
2738 * Prevent buffer overflows; such a case isn't reasonable anyway
2740 if (strlen(str) >= 128 || strlen(tmp) > 100)
2743 sprintf(buf, "which %s > /dev/null", BC_APP);
2745 log_err("fio: bc is needed for performing math\n");
2749 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2750 f = popen(buf, "r");
2755 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2761 buf[(tmp - str) + ret - 1] = '\0';
2762 memcpy(buf, str, tmp - str);
2768 * Return a copy of the input string with substrings of the form ${VARNAME}
2769 * substituted with the value of the environment variable VARNAME. The
2770 * substitution always occurs, even if VARNAME is empty or the corresponding
2771 * environment variable undefined.
2773 static char *option_dup_subs(const char *opt)
2775 char out[OPT_LEN_MAX+1];
2776 char in[OPT_LEN_MAX+1];
2779 char *ch1, *ch2, *env;
2780 ssize_t nchr = OPT_LEN_MAX;
2783 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2784 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2788 in[OPT_LEN_MAX] = '\0';
2789 strncpy(in, opt, OPT_LEN_MAX);
2791 while (*inptr && nchr > 0) {
2792 if (inptr[0] == '$' && inptr[1] == '{') {
2793 ch2 = strchr(inptr, '}');
2794 if (ch2 && inptr+1 < ch2) {
2801 envlen = strlen(env);
2802 if (envlen <= nchr) {
2803 memcpy(outptr, env, envlen);
2813 *outptr++ = *inptr++;
2822 * Look for reserved variable names and replace them with real values
2824 static char *fio_keyword_replace(char *opt)
2830 for (i = 0; fio_keywords[i].word != NULL; i++) {
2831 struct fio_keyword *kw = &fio_keywords[i];
2833 while ((s = strstr(opt, kw->word)) != NULL) {
2834 char *new = malloc(strlen(opt) + 1);
2840 * Copy part of the string before the keyword and
2841 * sprintf() the replacement after it.
2843 memcpy(new, opt, olen);
2844 len = sprintf(new + olen, "%s", kw->replace);
2847 * If there's more in the original string, copy that
2850 opt += strlen(kw->word) + olen;
2852 memcpy(new + olen + len, opt, opt - o_org - 1);
2855 * replace opt and free the old opt
2865 * Check for potential math and invoke bc, if possible
2873 static char **dup_and_sub_options(char **opts, int num_opts)
2876 char **opts_copy = malloc(num_opts * sizeof(*opts));
2877 for (i = 0; i < num_opts; i++) {
2878 opts_copy[i] = option_dup_subs(opts[i]);
2881 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2886 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2888 int i, ret, unknown;
2891 sort_options(opts, options, num_opts);
2892 opts_copy = dup_and_sub_options(opts, num_opts);
2894 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2895 struct fio_option *o;
2896 int newret = parse_option(opts_copy[i], opts[i], options, &o,
2905 opts_copy[i] = NULL;
2912 ret |= ioengine_load(td);
2914 sort_options(opts_copy, td->io_ops->options, num_opts);
2917 for (i = 0; i < num_opts; i++) {
2918 struct fio_option *o = NULL;
2924 newret = parse_option(opts_copy[i], opts[i],
2925 td->io_ops->options, &o,
2930 log_err("Bad option <%s>\n", opts[i]);
2933 opts_copy[i] = NULL;
2941 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2943 return parse_cmd_option(opt, val, options, td);
2946 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2949 return parse_cmd_option(opt, val, td->io_ops->options, td);
2952 void fio_fill_default_options(struct thread_data *td)
2954 fill_default_options(td, options);
2957 int fio_show_option_help(const char *opt)
2959 return show_cmd_help(options, opt);
2962 void options_mem_dupe(void *data, struct fio_option *options)
2964 struct fio_option *o;
2967 for (o = &options[0]; o->name; o++) {
2968 if (o->type != FIO_OPT_STR_STORE)
2971 ptr = td_var(data, o->off1);
2973 *ptr = strdup(*ptr);
2978 * dupe FIO_OPT_STR_STORE options
2980 void fio_options_mem_dupe(struct thread_data *td)
2982 options_mem_dupe(&td->o, options);
2984 if (td->eo && td->io_ops) {
2985 void *oldeo = td->eo;
2987 td->eo = malloc(td->io_ops->option_struct_size);
2988 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2989 options_mem_dupe(td->eo, td->io_ops->options);
2993 unsigned int fio_get_kb_base(void *data)
2995 struct thread_data *td = data;
2996 unsigned int kb_base = 0;
2999 kb_base = td->o.kb_base;
3006 int add_option(struct fio_option *o)
3008 struct fio_option *__o;
3017 memcpy(&options[opt_index], o, sizeof(*o));
3021 void invalidate_profile_options(const char *prof_name)
3023 struct fio_option *o;
3027 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3028 o->type = FIO_OPT_INVALID;
3029 o->prof_name = NULL;
3035 void add_opt_posval(const char *optname, const char *ival, const char *help)
3037 struct fio_option *o;
3040 o = find_option(options, optname);
3044 for (i = 0; i < PARSE_MAX_VP; i++) {
3045 if (o->posval[i].ival)
3048 o->posval[i].ival = ival;
3049 o->posval[i].help = help;
3054 void del_opt_posval(const char *optname, const char *ival)
3056 struct fio_option *o;
3059 o = find_option(options, optname);
3063 for (i = 0; i < PARSE_MAX_VP; i++) {
3064 if (!o->posval[i].ival)
3066 if (strcmp(o->posval[i].ival, ival))
3069 o->posval[i].ival = NULL;
3070 o->posval[i].help = NULL;
3074 void fio_options_free(struct thread_data *td)
3076 options_free(options, td);
3077 if (td->eo && td->io_ops && td->io_ops->options) {
3078 options_free(td->io_ops->options, td->eo);