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;
165 static int str_bssplit_cb(void *data, const char *input)
167 struct thread_data *td = data;
168 char *str, *p, *odir;
171 p = str = strdup(input);
173 strip_blank_front(&str);
174 strip_blank_end(str);
176 odir = strchr(str, ',');
178 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
181 ret = bssplit_ddir(td, DDIR_READ, str);
188 ret = bssplit_ddir(td, DDIR_READ, str);
190 ret = bssplit_ddir(td, DDIR_WRITE, op);
199 static int str_rw_cb(void *data, const char *str)
201 struct thread_data *td = data;
202 char *nr = get_opt_postfix(str);
204 td->o.ddir_seq_nr = 1;
205 td->o.ddir_seq_add = 0;
211 td->o.ddir_seq_nr = atoi(nr);
215 if (str_to_decimal(nr, &val, 1, td)) {
216 log_err("fio: rw postfix parsing failed\n");
221 td->o.ddir_seq_add = val;
228 static int str_mem_cb(void *data, const char *mem)
230 struct thread_data *td = data;
232 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
233 td->mmapfile = get_opt_postfix(mem);
234 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
235 log_err("fio: mmaphuge:/path/to/file\n");
243 static int str_verify_cb(void *data, const char *mem)
245 struct thread_data *td = data;
247 if (td->o.verify == VERIFY_CRC32C_INTEL ||
248 td->o.verify == VERIFY_CRC32C) {
249 crc32c_intel_probe();
255 static int fio_clock_source_cb(void *data, const char *str)
257 struct thread_data *td = data;
259 fio_clock_source = td->o.clocksource;
264 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
270 static int str_rwmix_read_cb(void *data, unsigned long long *val)
272 struct thread_data *td = data;
274 td->o.rwmix[DDIR_READ] = *val;
275 td->o.rwmix[DDIR_WRITE] = 100 - *val;
279 static int str_rwmix_write_cb(void *data, unsigned long long *val)
281 struct thread_data *td = data;
283 td->o.rwmix[DDIR_WRITE] = *val;
284 td->o.rwmix[DDIR_READ] = 100 - *val;
288 #ifdef FIO_HAVE_IOPRIO
289 static int str_prioclass_cb(void *data, unsigned long long *val)
291 struct thread_data *td = data;
295 * mask off old class bits, str_prio_cb() may have set a default class
297 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
300 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
305 static int str_prio_cb(void *data, unsigned long long *val)
307 struct thread_data *td = data;
312 * If no class is set, assume BE
314 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
315 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
322 static int str_exitall_cb(void)
324 exitall_on_terminate = 1;
328 #ifdef FIO_HAVE_CPU_AFFINITY
329 static int str_cpumask_cb(void *data, unsigned long long *val)
331 struct thread_data *td = data;
336 ret = fio_cpuset_init(&td->o.cpumask);
338 log_err("fio: cpuset_init failed\n");
339 td_verror(td, ret, "fio_cpuset_init");
343 max_cpu = cpus_online();
345 for (i = 0; i < sizeof(int) * 8; i++) {
346 if ((1 << i) & *val) {
348 log_err("fio: CPU %d too large (max=%ld)\n", i,
352 dprint(FD_PARSE, "set cpu allowed %d\n", i);
353 fio_cpu_set(&td->o.cpumask, i);
357 td->o.cpumask_set = 1;
361 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
368 ret = fio_cpuset_init(mask);
370 log_err("fio: cpuset_init failed\n");
371 td_verror(td, ret, "fio_cpuset_init");
375 p = str = strdup(input);
377 strip_blank_front(&str);
378 strip_blank_end(str);
380 max_cpu = cpus_online();
382 while ((cpu = strsep(&str, ",")) != NULL) {
391 while ((cpu2 = strsep(&str2, "-")) != NULL) {
401 while (icpu <= icpu2) {
402 if (icpu >= FIO_MAX_CPUS) {
403 log_err("fio: your OS only supports up to"
404 " %d CPUs\n", (int) FIO_MAX_CPUS);
408 if (icpu > max_cpu) {
409 log_err("fio: CPU %d too large (max=%ld)\n",
415 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
416 fio_cpu_set(mask, icpu);
425 td->o.cpumask_set = 1;
429 static int str_cpus_allowed_cb(void *data, const char *input)
431 struct thread_data *td = data;
434 ret = set_cpus_allowed(td, &td->o.cpumask, input);
436 td->o.cpumask_set = 1;
441 static int str_verify_cpus_allowed_cb(void *data, const char *input)
443 struct thread_data *td = data;
446 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
448 td->o.verify_cpumask_set = 1;
455 static int str_verify_trim_cb(void *data, unsigned long long *val)
457 struct thread_data *td = data;
459 td->o.trim_percentage = *val;
464 static int str_fst_cb(void *data, const char *str)
466 struct thread_data *td = data;
467 char *nr = get_opt_postfix(str);
469 td->file_service_nr = 1;
471 td->file_service_nr = atoi(nr);
478 #ifdef FIO_HAVE_SYNC_FILE_RANGE
479 static int str_sfr_cb(void *data, const char *str)
481 struct thread_data *td = data;
482 char *nr = get_opt_postfix(str);
484 td->sync_file_range_nr = 1;
486 td->sync_file_range_nr = atoi(nr);
494 static int check_dir(struct thread_data *td, char *fname)
497 char file[PATH_MAX], *dir;
500 if (td->o.directory) {
501 strcpy(file, td->o.directory);
506 sprintf(file + elen, "%s", fname);
512 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
513 * yet, so we can't do this check right here...
515 if (lstat(dir, &sb) < 0) {
518 log_err("fio: %s is not a directory\n", dir);
519 td_verror(td, ret, "lstat");
523 if (!S_ISDIR(sb.st_mode)) {
524 log_err("fio: %s is not a directory\n", dir);
534 * Return next file in the string. Files are separated with ':'. If the ':'
535 * is escaped with a '\', then that ':' is part of the filename and does not
536 * indicate a new file.
538 static char *get_next_file_name(char **ptr)
543 if (!str || !strlen(str))
549 * No colon, we are done
551 p = strchr(str, ':');
558 * We got a colon, but it's the first character. Skip and
566 if (*(p - 1) != '\\') {
572 memmove(p - 1, p, strlen(p) + 1);
579 static int str_filename_cb(void *data, const char *input)
581 struct thread_data *td = data;
582 char *fname, *str, *p;
584 p = str = strdup(input);
586 strip_blank_front(&str);
587 strip_blank_end(str);
589 if (!td->files_index)
592 while ((fname = get_next_file_name(&str)) != NULL) {
595 if (check_dir(td, fname)) {
607 static int str_directory_cb(void *data, const char fio_unused *str)
609 struct thread_data *td = data;
612 if (lstat(td->o.directory, &sb) < 0) {
615 log_err("fio: %s is not a directory\n", td->o.directory);
616 td_verror(td, ret, "lstat");
619 if (!S_ISDIR(sb.st_mode)) {
620 log_err("fio: %s is not a directory\n", td->o.directory);
627 static int str_opendir_cb(void *data, const char fio_unused *str)
629 struct thread_data *td = data;
631 if (!td->files_index)
634 return add_dir_files(td, td->o.opendir);
637 static int str_verify_offset_cb(void *data, unsigned long long *off)
639 struct thread_data *td = data;
641 if (*off && *off < sizeof(struct verify_header)) {
642 log_err("fio: verify_offset too small\n");
646 td->o.verify_offset = *off;
650 static int str_verify_pattern_cb(void *data, const char *input)
652 struct thread_data *td = data;
654 int i = 0, j = 0, len, k, base = 10;
657 loc1 = strstr(input, "0x");
658 loc2 = strstr(input, "0X");
661 off = strtol(input, NULL, base);
662 if (off != LONG_MAX || errno != ERANGE) {
664 td->o.verify_pattern[i] = off & 0xff;
673 j = loc1 - input + 2;
675 j = loc2 - input + 2;
678 if (len - j < MAX_PATTERN_SIZE * 2) {
680 off = converthexchartoint(input[k--]);
682 off += (converthexchartoint(input[k--])
684 td->o.verify_pattern[i++] = (char) off;
690 * Fill the pattern all the way to the end. This greatly reduces
691 * the number of memcpy's we have to do when verifying the IO.
693 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
694 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
699 * The code in verify_io_u_pattern assumes a single byte pattern
700 * fills the whole verify pattern buffer.
702 memset(td->o.verify_pattern, td->o.verify_pattern[0],
706 td->o.verify_pattern_bytes = i;
709 * VERIFY_META could already be set
711 if (td->o.verify == VERIFY_NONE)
712 td->o.verify = VERIFY_PATTERN;
717 static int str_lockfile_cb(void *data, const char *str)
719 struct thread_data *td = data;
720 char *nr = get_opt_postfix(str);
722 td->o.lockfile_batch = 1;
724 td->o.lockfile_batch = atoi(nr);
731 static int str_write_bw_log_cb(void *data, const char *str)
733 struct thread_data *td = data;
736 td->o.bw_log_file = strdup(str);
738 td->o.write_bw_log = 1;
742 static int str_write_lat_log_cb(void *data, const char *str)
744 struct thread_data *td = data;
747 td->o.lat_log_file = strdup(str);
749 td->o.write_lat_log = 1;
753 static int str_write_iops_log_cb(void *data, const char *str)
755 struct thread_data *td = data;
758 td->o.iops_log_file = strdup(str);
760 td->o.write_iops_log = 1;
764 static int str_gtod_reduce_cb(void *data, int *il)
766 struct thread_data *td = data;
769 td->o.disable_lat = !!val;
770 td->o.disable_clat = !!val;
771 td->o.disable_slat = !!val;
772 td->o.disable_bw = !!val;
773 td->o.clat_percentiles = !val;
775 td->tv_cache_mask = 63;
780 static int str_gtod_cpu_cb(void *data, long long *il)
782 struct thread_data *td = data;
785 td->o.gtod_cpu = val;
786 td->o.gtod_offload = 1;
790 static int str_size_cb(void *data, unsigned long long *__val)
792 struct thread_data *td = data;
793 unsigned long long v = *__val;
795 if (parse_is_percent(v)) {
797 td->o.size_percent = -1ULL - v;
804 static int rw_verify(struct fio_option *o, void *data)
806 struct thread_data *td = data;
808 if (read_only && td_write(td)) {
809 log_err("fio: job <%s> has write bit set, but fio is in"
810 " read-only mode\n", td->o.name);
817 static int gtod_cpu_verify(struct fio_option *o, void *data)
819 #ifndef FIO_HAVE_CPU_AFFINITY
820 struct thread_data *td = data;
822 if (td->o.gtod_cpu) {
823 log_err("fio: platform must support CPU affinity for"
824 "gettimeofday() offloading\n");
832 static int kb_base_verify(struct fio_option *o, void *data)
834 struct thread_data *td = data;
836 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
837 log_err("fio: kb_base set to nonsensical value: %u\n",
848 static struct opt_group fio_opt_groups[] = {
850 .name = "Description",
851 .mask = FIO_OPT_G_DESC,
855 .mask = FIO_OPT_G_FILE,
859 .mask = FIO_OPT_G_MISC,
863 .mask = FIO_OPT_G_IO,
866 .name = "IO direction",
867 .mask = FIO_OPT_G_IO_DDIR,
871 .mask = FIO_OPT_G_IO_BUF,
875 .mask = FIO_OPT_G_IO_ENG,
879 .mask = FIO_OPT_G_RAND,
883 .mask = FIO_OPT_G_OS,
887 .mask = FIO_OPT_G_MEM,
891 .mask = FIO_OPT_G_VERIFY,
895 .mask = FIO_OPT_G_CPU,
899 .mask = FIO_OPT_G_LOG,
903 .mask = FIO_OPT_G_ZONE,
907 .mask = FIO_OPT_G_CACHE,
911 .mask = FIO_OPT_G_STAT,
915 .mask = FIO_OPT_G_ERR,
919 .mask = FIO_OPT_G_JOB,
926 struct opt_group *opt_group_from_mask(unsigned int *mask)
928 struct opt_group *og;
931 if (*mask == FIO_OPT_G_INVALID)
934 for (i = 0; fio_opt_groups[i].name; i++) {
935 og = &fio_opt_groups[i];
937 if (*mask & og->mask) {
938 *mask &= ~(og->mask);
947 * Map of job/command line options
949 struct fio_option fio_options[FIO_MAX_OPTS] = {
951 .name = "description",
952 .type = FIO_OPT_STR_STORE,
953 .off1 = td_var_offset(description),
954 .help = "Text job description",
955 .category = FIO_OPT_G_DESC,
959 .type = FIO_OPT_STR_STORE,
960 .off1 = td_var_offset(name),
961 .help = "Name of this job",
962 .category = FIO_OPT_G_DESC,
966 .type = FIO_OPT_STR_STORE,
967 .off1 = td_var_offset(directory),
968 .cb = str_directory_cb,
969 .help = "Directory to store files in",
970 .category = FIO_OPT_G_FILE,
974 .type = FIO_OPT_STR_STORE,
975 .off1 = td_var_offset(filename),
976 .cb = str_filename_cb,
977 .prio = -1, /* must come after "directory" */
978 .help = "File(s) to use for the workload",
979 .category = FIO_OPT_G_FILE,
984 .off1 = td_var_offset(kb_base),
985 .verify = kb_base_verify,
988 .help = "How many bytes per KB for reporting (1000 or 1024)",
989 .category = FIO_OPT_G_MISC,
994 .cb = str_lockfile_cb,
995 .off1 = td_var_offset(file_lock_mode),
996 .help = "Lock file when doing IO to it",
997 .parent = "filename",
999 .category = FIO_OPT_G_FILE,
1002 .oval = FILE_LOCK_NONE,
1003 .help = "No file locking",
1005 { .ival = "exclusive",
1006 .oval = FILE_LOCK_EXCLUSIVE,
1007 .help = "Exclusive file lock",
1010 .ival = "readwrite",
1011 .oval = FILE_LOCK_READWRITE,
1012 .help = "Read vs write lock",
1018 .type = FIO_OPT_STR_STORE,
1019 .off1 = td_var_offset(opendir),
1020 .cb = str_opendir_cb,
1021 .help = "Recursively add files from this directory and down",
1022 .category = FIO_OPT_G_FILE,
1026 .alias = "readwrite",
1027 .type = FIO_OPT_STR,
1029 .off1 = td_var_offset(td_ddir),
1030 .help = "IO direction",
1032 .verify = rw_verify,
1033 .category = FIO_OPT_G_IO_DDIR,
1036 .oval = TD_DDIR_READ,
1037 .help = "Sequential read",
1040 .oval = TD_DDIR_WRITE,
1041 .help = "Sequential write",
1043 { .ival = "randread",
1044 .oval = TD_DDIR_RANDREAD,
1045 .help = "Random read",
1047 { .ival = "randwrite",
1048 .oval = TD_DDIR_RANDWRITE,
1049 .help = "Random write",
1053 .help = "Sequential read and write mix",
1056 .oval = TD_DDIR_RANDRW,
1057 .help = "Random read and write mix"
1062 .name = "rw_sequencer",
1063 .type = FIO_OPT_STR,
1064 .off1 = td_var_offset(rw_seq),
1065 .help = "IO offset generator modifier",
1066 .def = "sequential",
1067 .category = FIO_OPT_G_IO_DDIR,
1069 { .ival = "sequential",
1071 .help = "Generate sequential offsets",
1073 { .ival = "identical",
1074 .oval = RW_SEQ_IDENT,
1075 .help = "Generate identical offsets",
1082 .type = FIO_OPT_STR_STORE,
1083 .off1 = td_var_offset(ioengine),
1084 .help = "IO engine to use",
1085 .def = FIO_PREFERRED_ENGINE,
1086 .category = FIO_OPT_G_IO,
1089 .help = "Use read/write",
1092 .help = "Use pread/pwrite",
1095 .help = "Use readv/writev",
1097 #ifdef FIO_HAVE_LIBAIO
1099 .help = "Linux native asynchronous IO",
1102 #ifdef FIO_HAVE_POSIXAIO
1103 { .ival = "posixaio",
1104 .help = "POSIX asynchronous IO",
1107 #ifdef FIO_HAVE_SOLARISAIO
1108 { .ival = "solarisaio",
1109 .help = "Solaris native asynchronous IO",
1112 #ifdef FIO_HAVE_WINDOWSAIO
1113 { .ival = "windowsaio",
1114 .help = "Windows native asynchronous IO"
1118 .help = "Memory mapped IO"
1120 #ifdef FIO_HAVE_SPLICE
1122 .help = "splice/vmsplice based IO",
1124 { .ival = "netsplice",
1125 .help = "splice/vmsplice to/from the network",
1128 #ifdef FIO_HAVE_SGIO
1130 .help = "SCSI generic v3 IO",
1134 .help = "Testing engine (no data transfer)",
1137 .help = "Network IO",
1139 #ifdef FIO_HAVE_SYSLET
1140 { .ival = "syslet-rw",
1141 .help = "syslet enabled async pread/pwrite IO",
1145 .help = "CPU cycle burner engine",
1147 #ifdef FIO_HAVE_GUASI
1149 .help = "GUASI IO engine",
1152 #ifdef FIO_HAVE_BINJECT
1153 { .ival = "binject",
1154 .help = "binject direct inject block engine",
1157 #ifdef FIO_HAVE_RDMA
1159 .help = "RDMA IO engine",
1162 { .ival = "external",
1163 .help = "Load external engine (append name)",
1169 .type = FIO_OPT_INT,
1170 .off1 = td_var_offset(iodepth),
1171 .help = "Number of IO buffers to keep in flight",
1174 .category = FIO_OPT_G_IO,
1177 .name = "iodepth_batch",
1178 .alias = "iodepth_batch_submit",
1179 .type = FIO_OPT_INT,
1180 .off1 = td_var_offset(iodepth_batch),
1181 .help = "Number of IO buffers to submit in one go",
1182 .parent = "iodepth",
1185 .category = FIO_OPT_G_IO,
1188 .name = "iodepth_batch_complete",
1189 .type = FIO_OPT_INT,
1190 .off1 = td_var_offset(iodepth_batch_complete),
1191 .help = "Number of IO buffers to retrieve in one go",
1192 .parent = "iodepth",
1195 .category = FIO_OPT_G_IO,
1198 .name = "iodepth_low",
1199 .type = FIO_OPT_INT,
1200 .off1 = td_var_offset(iodepth_low),
1201 .help = "Low water mark for queuing depth",
1202 .parent = "iodepth",
1203 .category = FIO_OPT_G_IO,
1207 .type = FIO_OPT_STR_VAL,
1209 .help = "Total size of device or files",
1210 .category = FIO_OPT_G_IO,
1213 .name = "fill_device",
1215 .type = FIO_OPT_BOOL,
1216 .off1 = td_var_offset(fill_device),
1217 .help = "Write until an ENOSPC error occurs",
1219 .category = FIO_OPT_G_IO,
1223 .type = FIO_OPT_STR_VAL,
1224 .off1 = td_var_offset(file_size_low),
1225 .off2 = td_var_offset(file_size_high),
1227 .help = "Size of individual files",
1228 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
1232 .alias = "fileoffset",
1233 .type = FIO_OPT_STR_VAL,
1234 .off1 = td_var_offset(start_offset),
1235 .help = "Start IO from this offset",
1237 .category = FIO_OPT_G_IO,
1240 .name = "offset_increment",
1241 .type = FIO_OPT_STR_VAL,
1242 .off1 = td_var_offset(offset_increment),
1243 .help = "What is the increment from one offset to the next",
1246 .category = FIO_OPT_G_IO,
1250 .alias = "blocksize",
1251 .type = FIO_OPT_INT,
1252 .off1 = td_var_offset(bs[DDIR_READ]),
1253 .off2 = td_var_offset(bs[DDIR_WRITE]),
1255 .help = "Block size unit",
1258 .category = FIO_OPT_G_IO,
1262 .alias = "blockalign",
1263 .type = FIO_OPT_INT,
1264 .off1 = td_var_offset(ba[DDIR_READ]),
1265 .off2 = td_var_offset(ba[DDIR_WRITE]),
1267 .help = "IO block offset alignment",
1269 .category = FIO_OPT_G_IO | FIO_OPT_G_IO_BUF,
1273 .alias = "blocksize_range",
1274 .type = FIO_OPT_RANGE,
1275 .off1 = td_var_offset(min_bs[DDIR_READ]),
1276 .off2 = td_var_offset(max_bs[DDIR_READ]),
1277 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1278 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1280 .help = "Set block size range (in more detail than bs)",
1282 .category = FIO_OPT_G_IO,
1286 .type = FIO_OPT_STR,
1287 .cb = str_bssplit_cb,
1288 .help = "Set a specific mix of block sizes",
1290 .category = FIO_OPT_G_IO,
1293 .name = "bs_unaligned",
1294 .alias = "blocksize_unaligned",
1295 .type = FIO_OPT_STR_SET,
1296 .off1 = td_var_offset(bs_unaligned),
1297 .help = "Don't sector align IO buffer sizes",
1299 .category = FIO_OPT_G_IO,
1302 .name = "randrepeat",
1303 .type = FIO_OPT_BOOL,
1304 .off1 = td_var_offset(rand_repeatable),
1305 .help = "Use repeatable random IO pattern",
1308 .category = FIO_OPT_G_IO | FIO_OPT_G_RAND,
1311 .name = "use_os_rand",
1312 .type = FIO_OPT_BOOL,
1313 .off1 = td_var_offset(use_os_rand),
1314 .help = "Set to use OS random generator",
1317 .category = FIO_OPT_G_RAND,
1320 .name = "norandommap",
1321 .type = FIO_OPT_STR_SET,
1322 .off1 = td_var_offset(norandommap),
1323 .help = "Accept potential duplicate random blocks",
1325 .category = FIO_OPT_G_RAND,
1328 .name = "softrandommap",
1329 .type = FIO_OPT_BOOL,
1330 .off1 = td_var_offset(softrandommap),
1331 .help = "Set norandommap if randommap allocation fails",
1332 .parent = "norandommap",
1334 .category = FIO_OPT_G_RAND,
1338 .alias = "nr_files",
1339 .type = FIO_OPT_INT,
1340 .off1 = td_var_offset(nr_files),
1341 .help = "Split job workload between this number of files",
1343 .category = FIO_OPT_G_FILE,
1346 .name = "openfiles",
1347 .type = FIO_OPT_INT,
1348 .off1 = td_var_offset(open_files),
1349 .help = "Number of files to keep open at the same time",
1350 .category = FIO_OPT_G_FILE,
1353 .name = "file_service_type",
1354 .type = FIO_OPT_STR,
1356 .off1 = td_var_offset(file_service_type),
1357 .help = "How to select which file to service next",
1358 .def = "roundrobin",
1359 .category = FIO_OPT_G_FILE,
1362 .oval = FIO_FSERVICE_RANDOM,
1363 .help = "Choose a file at random",
1365 { .ival = "roundrobin",
1366 .oval = FIO_FSERVICE_RR,
1367 .help = "Round robin select files",
1369 { .ival = "sequential",
1370 .oval = FIO_FSERVICE_SEQ,
1371 .help = "Finish one file before moving to the next",
1374 .parent = "nrfiles",
1376 #ifdef FIO_HAVE_FALLOCATE
1378 .name = "fallocate",
1379 .type = FIO_OPT_STR,
1380 .off1 = td_var_offset(fallocate_mode),
1381 .help = "Whether pre-allocation is performed when laying out files",
1383 .category = FIO_OPT_G_FILE,
1386 .oval = FIO_FALLOCATE_NONE,
1387 .help = "Do not pre-allocate space",
1390 .oval = FIO_FALLOCATE_POSIX,
1391 .help = "Use posix_fallocate()",
1393 #ifdef FIO_HAVE_LINUX_FALLOCATE
1395 .oval = FIO_FALLOCATE_KEEP_SIZE,
1396 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1399 /* Compatibility with former boolean values */
1401 .oval = FIO_FALLOCATE_NONE,
1402 .help = "Alias for 'none'",
1405 .oval = FIO_FALLOCATE_POSIX,
1406 .help = "Alias for 'posix'",
1410 #endif /* FIO_HAVE_FALLOCATE */
1412 .name = "fadvise_hint",
1413 .type = FIO_OPT_BOOL,
1414 .off1 = td_var_offset(fadvise_hint),
1415 .help = "Use fadvise() to advise the kernel on IO pattern",
1417 .category = FIO_OPT_G_FILE,
1421 .type = FIO_OPT_INT,
1422 .off1 = td_var_offset(fsync_blocks),
1423 .help = "Issue fsync for writes every given number of blocks",
1425 .category = FIO_OPT_G_FILE,
1428 .name = "fdatasync",
1429 .type = FIO_OPT_INT,
1430 .off1 = td_var_offset(fdatasync_blocks),
1431 .help = "Issue fdatasync for writes every given number of blocks",
1433 .category = FIO_OPT_G_FILE,
1436 .name = "write_barrier",
1437 .type = FIO_OPT_INT,
1438 .off1 = td_var_offset(barrier_blocks),
1439 .help = "Make every Nth write a barrier write",
1441 .category = FIO_OPT_G_IO,
1443 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1445 .name = "sync_file_range",
1447 { .ival = "wait_before",
1448 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1449 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1453 .oval = SYNC_FILE_RANGE_WRITE,
1454 .help = "SYNC_FILE_RANGE_WRITE",
1458 .ival = "wait_after",
1459 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1460 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1464 .type = FIO_OPT_STR_MULTI,
1466 .off1 = td_var_offset(sync_file_range),
1467 .help = "Use sync_file_range()",
1468 .category = FIO_OPT_G_FILE,
1473 .type = FIO_OPT_BOOL,
1474 .off1 = td_var_offset(odirect),
1475 .help = "Use O_DIRECT IO (negates buffered)",
1477 .category = FIO_OPT_G_IO,
1481 .type = FIO_OPT_BOOL,
1482 .off1 = td_var_offset(odirect),
1484 .help = "Use buffered IO (negates direct)",
1486 .category = FIO_OPT_G_IO,
1489 .name = "overwrite",
1490 .type = FIO_OPT_BOOL,
1491 .off1 = td_var_offset(overwrite),
1492 .help = "When writing, set whether to overwrite current data",
1494 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
1498 .type = FIO_OPT_INT,
1499 .off1 = td_var_offset(loops),
1500 .help = "Number of times to run the job",
1502 .category = FIO_OPT_G_MISC,
1506 .type = FIO_OPT_INT,
1507 .off1 = td_var_offset(numjobs),
1508 .help = "Duplicate this job this many times",
1510 .category = FIO_OPT_G_MISC,
1513 .name = "startdelay",
1514 .type = FIO_OPT_STR_VAL_TIME,
1515 .off1 = td_var_offset(start_delay),
1516 .help = "Only start job when this period has passed",
1518 .category = FIO_OPT_G_MISC,
1523 .type = FIO_OPT_STR_VAL_TIME,
1524 .off1 = td_var_offset(timeout),
1525 .help = "Stop workload when this amount of time has passed",
1527 .category = FIO_OPT_G_MISC,
1530 .name = "time_based",
1531 .type = FIO_OPT_STR_SET,
1532 .off1 = td_var_offset(time_based),
1533 .help = "Keep running until runtime/timeout is met",
1534 .category = FIO_OPT_G_MISC,
1537 .name = "ramp_time",
1538 .type = FIO_OPT_STR_VAL_TIME,
1539 .off1 = td_var_offset(ramp_time),
1540 .help = "Ramp up time before measuring performance",
1541 .category = FIO_OPT_G_MISC,
1544 .name = "clocksource",
1545 .type = FIO_OPT_STR,
1546 .cb = fio_clock_source_cb,
1547 .off1 = td_var_offset(clocksource),
1548 .help = "What type of timing source to use",
1549 .category = FIO_OPT_G_OS,
1551 { .ival = "gettimeofday",
1553 .help = "Use gettimeofday(2) for timing",
1555 { .ival = "clock_gettime",
1556 .oval = CS_CGETTIME,
1557 .help = "Use clock_gettime(2) for timing",
1559 #ifdef ARCH_HAVE_CPU_CLOCK
1561 .oval = CS_CPUCLOCK,
1562 .help = "Use CPU private clock",
1570 .type = FIO_OPT_STR,
1572 .off1 = td_var_offset(mem_type),
1573 .help = "Backing type for IO buffers",
1575 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1579 .help = "Use malloc(3) for IO buffers",
1583 .help = "Use shared memory segments for IO buffers",
1585 #ifdef FIO_HAVE_HUGETLB
1586 { .ival = "shmhuge",
1587 .oval = MEM_SHMHUGE,
1588 .help = "Like shm, but use huge pages",
1593 .help = "Use mmap(2) (file or anon) for IO buffers",
1595 #ifdef FIO_HAVE_HUGETLB
1596 { .ival = "mmaphuge",
1597 .oval = MEM_MMAPHUGE,
1598 .help = "Like mmap, but use huge pages",
1604 .name = "iomem_align",
1605 .alias = "mem_align",
1606 .type = FIO_OPT_INT,
1607 .off1 = td_var_offset(mem_align),
1609 .help = "IO memory buffer offset alignment",
1612 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1616 .type = FIO_OPT_STR,
1617 .off1 = td_var_offset(verify),
1618 .help = "Verify data written",
1619 .cb = str_verify_cb,
1621 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1624 .oval = VERIFY_NONE,
1625 .help = "Don't do IO verification",
1629 .help = "Use md5 checksums for verification",
1632 .oval = VERIFY_CRC64,
1633 .help = "Use crc64 checksums for verification",
1636 .oval = VERIFY_CRC32,
1637 .help = "Use crc32 checksums for verification",
1639 { .ival = "crc32c-intel",
1640 .oval = VERIFY_CRC32C,
1641 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1644 .oval = VERIFY_CRC32C,
1645 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1648 .oval = VERIFY_CRC16,
1649 .help = "Use crc16 checksums for verification",
1652 .oval = VERIFY_CRC7,
1653 .help = "Use crc7 checksums for verification",
1656 .oval = VERIFY_SHA1,
1657 .help = "Use sha1 checksums for verification",
1660 .oval = VERIFY_SHA256,
1661 .help = "Use sha256 checksums for verification",
1664 .oval = VERIFY_SHA512,
1665 .help = "Use sha512 checksums for verification",
1668 .oval = VERIFY_META,
1669 .help = "Use io information",
1673 .oval = VERIFY_NULL,
1674 .help = "Pretend to verify",
1679 .name = "do_verify",
1680 .type = FIO_OPT_BOOL,
1681 .off1 = td_var_offset(do_verify),
1682 .help = "Run verification stage after write",
1685 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1688 .name = "verifysort",
1689 .type = FIO_OPT_BOOL,
1690 .off1 = td_var_offset(verifysort),
1691 .help = "Sort written verify blocks for read back",
1694 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1697 .name = "verify_interval",
1698 .type = FIO_OPT_INT,
1699 .off1 = td_var_offset(verify_interval),
1700 .minval = 2 * sizeof(struct verify_header),
1701 .help = "Store verify buffer header every N bytes",
1703 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1706 .name = "verify_offset",
1707 .type = FIO_OPT_INT,
1708 .help = "Offset verify header location by N bytes",
1710 .cb = str_verify_offset_cb,
1712 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1715 .name = "verify_pattern",
1716 .type = FIO_OPT_STR,
1717 .cb = str_verify_pattern_cb,
1718 .help = "Fill pattern for IO buffers",
1720 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1723 .name = "verify_fatal",
1724 .type = FIO_OPT_BOOL,
1725 .off1 = td_var_offset(verify_fatal),
1727 .help = "Exit on a single verify failure, don't continue",
1729 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1732 .name = "verify_dump",
1733 .type = FIO_OPT_BOOL,
1734 .off1 = td_var_offset(verify_dump),
1736 .help = "Dump contents of good and bad blocks on failure",
1738 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1741 .name = "verify_async",
1742 .type = FIO_OPT_INT,
1743 .off1 = td_var_offset(verify_async),
1745 .help = "Number of async verifier threads to use",
1747 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1750 .name = "verify_backlog",
1751 .type = FIO_OPT_STR_VAL,
1752 .off1 = td_var_offset(verify_backlog),
1753 .help = "Verify after this number of blocks are written",
1755 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1758 .name = "verify_backlog_batch",
1759 .type = FIO_OPT_INT,
1760 .off1 = td_var_offset(verify_batch),
1761 .help = "Verify this number of IO blocks",
1763 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1765 #ifdef FIO_HAVE_CPU_AFFINITY
1767 .name = "verify_async_cpus",
1768 .type = FIO_OPT_STR,
1769 .cb = str_verify_cpus_allowed_cb,
1770 .help = "Set CPUs allowed for async verify threads",
1771 .parent = "verify_async",
1772 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU | FIO_OPT_G_VERIFY,
1775 #ifdef FIO_HAVE_TRIM
1777 .name = "trim_percentage",
1778 .type = FIO_OPT_INT,
1779 .cb = str_verify_trim_cb,
1781 .help = "Number of verify blocks to discard/trim",
1784 .category = FIO_OPT_G_IO,
1787 .name = "trim_verify_zero",
1788 .type = FIO_OPT_INT,
1789 .help = "Verify that trim/discarded blocks are returned as zeroes",
1790 .off1 = td_var_offset(trim_zero),
1791 .parent = "trim_percentage",
1793 .category = FIO_OPT_G_IO,
1796 .name = "trim_backlog",
1797 .type = FIO_OPT_STR_VAL,
1798 .off1 = td_var_offset(trim_backlog),
1799 .help = "Trim after this number of blocks are written",
1800 .parent = "trim_percentage",
1801 .category = FIO_OPT_G_IO,
1804 .name = "trim_backlog_batch",
1805 .type = FIO_OPT_INT,
1806 .off1 = td_var_offset(trim_batch),
1807 .help = "Trim this number of IO blocks",
1808 .parent = "trim_percentage",
1809 .category = FIO_OPT_G_IO,
1813 .name = "write_iolog",
1814 .type = FIO_OPT_STR_STORE,
1815 .off1 = td_var_offset(write_iolog_file),
1816 .help = "Store IO pattern to file",
1817 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1820 .name = "read_iolog",
1821 .type = FIO_OPT_STR_STORE,
1822 .off1 = td_var_offset(read_iolog_file),
1823 .help = "Playback IO pattern from file",
1824 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1827 .name = "replay_no_stall",
1828 .type = FIO_OPT_INT,
1829 .off1 = td_var_offset(no_stall),
1831 .parent = "read_iolog",
1832 .help = "Playback IO pattern file as fast as possible without stalls",
1833 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1836 .name = "replay_redirect",
1837 .type = FIO_OPT_STR_STORE,
1838 .off1 = td_var_offset(replay_redirect),
1839 .parent = "read_iolog",
1840 .help = "Replay all I/O onto this device, regardless of trace device",
1841 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1844 .name = "exec_prerun",
1845 .type = FIO_OPT_STR_STORE,
1846 .off1 = td_var_offset(exec_prerun),
1847 .help = "Execute this file prior to running job",
1848 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1851 .name = "exec_postrun",
1852 .type = FIO_OPT_STR_STORE,
1853 .off1 = td_var_offset(exec_postrun),
1854 .help = "Execute this file after running job",
1855 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1857 #ifdef FIO_HAVE_IOSCHED_SWITCH
1859 .name = "ioscheduler",
1860 .type = FIO_OPT_STR_STORE,
1861 .off1 = td_var_offset(ioscheduler),
1862 .help = "Use this IO scheduler on the backing device",
1863 .category = FIO_OPT_G_OS | FIO_OPT_G_IO,
1868 .type = FIO_OPT_STR_VAL,
1869 .off1 = td_var_offset(zone_size),
1870 .help = "Amount of data to read per zone",
1872 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1875 .name = "zonerange",
1876 .type = FIO_OPT_STR_VAL,
1877 .off1 = td_var_offset(zone_range),
1878 .help = "Give size of an IO zone",
1880 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1884 .type = FIO_OPT_STR_VAL,
1885 .off1 = td_var_offset(zone_skip),
1886 .help = "Space between IO zones",
1888 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1892 .type = FIO_OPT_STR_VAL,
1893 .cb = str_lockmem_cb,
1894 .help = "Lock down this amount of memory",
1896 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
1899 .name = "rwmixread",
1900 .type = FIO_OPT_INT,
1901 .cb = str_rwmix_read_cb,
1903 .help = "Percentage of mixed workload that is reads",
1905 .category = FIO_OPT_G_IO,
1908 .name = "rwmixwrite",
1909 .type = FIO_OPT_INT,
1910 .cb = str_rwmix_write_cb,
1912 .help = "Percentage of mixed workload that is writes",
1914 .category = FIO_OPT_G_IO,
1917 .name = "rwmixcycle",
1918 .type = FIO_OPT_DEPRECATED,
1919 .category = FIO_OPT_G_IO,
1923 .type = FIO_OPT_INT,
1924 .off1 = td_var_offset(nice),
1925 .help = "Set job CPU nice value",
1929 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1931 #ifdef FIO_HAVE_IOPRIO
1934 .type = FIO_OPT_INT,
1936 .help = "Set job IO priority value",
1939 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1942 .name = "prioclass",
1943 .type = FIO_OPT_INT,
1944 .cb = str_prioclass_cb,
1945 .help = "Set job IO priority class",
1948 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1952 .name = "thinktime",
1953 .type = FIO_OPT_INT,
1954 .off1 = td_var_offset(thinktime),
1955 .help = "Idle time between IO buffers (usec)",
1957 .category = FIO_OPT_G_MISC,
1960 .name = "thinktime_spin",
1961 .type = FIO_OPT_INT,
1962 .off1 = td_var_offset(thinktime_spin),
1963 .help = "Start think time by spinning this amount (usec)",
1965 .parent = "thinktime",
1966 .category = FIO_OPT_G_MISC,
1969 .name = "thinktime_blocks",
1970 .type = FIO_OPT_INT,
1971 .off1 = td_var_offset(thinktime_blocks),
1972 .help = "IO buffer period between 'thinktime'",
1974 .parent = "thinktime",
1975 .category = FIO_OPT_G_MISC,
1979 .type = FIO_OPT_INT,
1980 .off1 = td_var_offset(rate[0]),
1981 .off2 = td_var_offset(rate[1]),
1982 .help = "Set bandwidth rate",
1983 .category = FIO_OPT_G_IO,
1987 .type = FIO_OPT_INT,
1988 .off1 = td_var_offset(ratemin[0]),
1989 .off2 = td_var_offset(ratemin[1]),
1990 .help = "Job must meet this rate or it will be shutdown",
1992 .category = FIO_OPT_G_IO,
1995 .name = "rate_iops",
1996 .type = FIO_OPT_INT,
1997 .off1 = td_var_offset(rate_iops[0]),
1998 .off2 = td_var_offset(rate_iops[1]),
1999 .help = "Limit IO used to this number of IO operations/sec",
2000 .category = FIO_OPT_G_IO,
2003 .name = "rate_iops_min",
2004 .type = FIO_OPT_INT,
2005 .off1 = td_var_offset(rate_iops_min[0]),
2006 .off2 = td_var_offset(rate_iops_min[1]),
2007 .help = "Job must meet this rate or it will be shut down",
2008 .parent = "rate_iops",
2009 .category = FIO_OPT_G_IO,
2012 .name = "ratecycle",
2013 .type = FIO_OPT_INT,
2014 .off1 = td_var_offset(ratecycle),
2015 .help = "Window average for rate limits (msec)",
2018 .category = FIO_OPT_G_IO,
2021 .name = "invalidate",
2022 .type = FIO_OPT_BOOL,
2023 .off1 = td_var_offset(invalidate_cache),
2024 .help = "Invalidate buffer/page cache prior to running job",
2026 .category = FIO_OPT_G_IO | FIO_OPT_G_CACHE,
2030 .type = FIO_OPT_BOOL,
2031 .off1 = td_var_offset(sync_io),
2032 .help = "Use O_SYNC for buffered writes",
2034 .parent = "buffered",
2035 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
2038 .name = "bwavgtime",
2039 .type = FIO_OPT_INT,
2040 .off1 = td_var_offset(bw_avg_time),
2041 .help = "Time window over which to calculate bandwidth"
2044 .parent = "write_bw_log",
2045 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2048 .name = "iopsavgtime",
2049 .type = FIO_OPT_INT,
2050 .off1 = td_var_offset(iops_avg_time),
2051 .help = "Time window over which to calculate IOPS (msec)",
2053 .parent = "write_iops_log",
2054 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2057 .name = "create_serialize",
2058 .type = FIO_OPT_BOOL,
2059 .off1 = td_var_offset(create_serialize),
2060 .help = "Serialize creating of job files",
2062 .category = FIO_OPT_G_FILE,
2065 .name = "create_fsync",
2066 .type = FIO_OPT_BOOL,
2067 .off1 = td_var_offset(create_fsync),
2068 .help = "fsync file after creation",
2070 .category = FIO_OPT_G_FILE,
2073 .name = "create_on_open",
2074 .type = FIO_OPT_BOOL,
2075 .off1 = td_var_offset(create_on_open),
2076 .help = "Create files when they are opened for IO",
2078 .category = FIO_OPT_G_FILE,
2082 .type = FIO_OPT_BOOL,
2083 .off1 = td_var_offset(pre_read),
2084 .help = "Pre-read files before starting official testing",
2086 .category = FIO_OPT_G_FILE | FIO_OPT_G_CACHE,
2090 .type = FIO_OPT_INT,
2091 .off1 = td_var_offset(cpuload),
2092 .help = "Use this percentage of CPU",
2093 .category = FIO_OPT_G_CPU,
2096 .name = "cpuchunks",
2097 .type = FIO_OPT_INT,
2098 .off1 = td_var_offset(cpucycle),
2099 .help = "Length of the CPU burn cycles (usecs)",
2101 .parent = "cpuload",
2102 .category = FIO_OPT_G_CPU,
2104 #ifdef FIO_HAVE_CPU_AFFINITY
2107 .type = FIO_OPT_INT,
2108 .cb = str_cpumask_cb,
2109 .help = "CPU affinity mask",
2110 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2113 .name = "cpus_allowed",
2114 .type = FIO_OPT_STR,
2115 .cb = str_cpus_allowed_cb,
2116 .help = "Set CPUs allowed",
2117 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2121 .name = "end_fsync",
2122 .type = FIO_OPT_BOOL,
2123 .off1 = td_var_offset(end_fsync),
2124 .help = "Include fsync at the end of job",
2126 .category = FIO_OPT_G_FILE,
2129 .name = "fsync_on_close",
2130 .type = FIO_OPT_BOOL,
2131 .off1 = td_var_offset(fsync_on_close),
2132 .help = "fsync files on close",
2134 .category = FIO_OPT_G_FILE,
2138 .type = FIO_OPT_BOOL,
2139 .off1 = td_var_offset(unlink),
2140 .help = "Unlink created files after job has completed",
2142 .category = FIO_OPT_G_FILE,
2146 .type = FIO_OPT_STR_SET,
2147 .cb = str_exitall_cb,
2148 .help = "Terminate all jobs when one exits",
2149 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2152 .name = "stonewall",
2153 .alias = "wait_for_previous",
2154 .type = FIO_OPT_STR_SET,
2155 .off1 = td_var_offset(stonewall),
2156 .help = "Insert a hard barrier between this job and previous",
2157 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2160 .name = "new_group",
2161 .type = FIO_OPT_STR_SET,
2162 .off1 = td_var_offset(new_group),
2163 .help = "Mark the start of a new group (for reporting)",
2164 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2168 .type = FIO_OPT_STR_SET,
2169 .off1 = td_var_offset(use_thread),
2170 .help = "Use threads instead of forks",
2171 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS | FIO_OPT_G_JOB,
2174 .name = "write_bw_log",
2175 .type = FIO_OPT_STR,
2176 .off1 = td_var_offset(write_bw_log),
2177 .cb = str_write_bw_log_cb,
2178 .help = "Write log of bandwidth during run",
2179 .category = FIO_OPT_G_LOG,
2182 .name = "write_lat_log",
2183 .type = FIO_OPT_STR,
2184 .off1 = td_var_offset(write_lat_log),
2185 .cb = str_write_lat_log_cb,
2186 .help = "Write log of latency during run",
2187 .category = FIO_OPT_G_LOG,
2190 .name = "write_iops_log",
2191 .type = FIO_OPT_STR,
2192 .off1 = td_var_offset(write_iops_log),
2193 .cb = str_write_iops_log_cb,
2194 .help = "Write log of IOPS during run",
2195 .category = FIO_OPT_G_LOG,
2198 .name = "log_avg_msec",
2199 .type = FIO_OPT_INT,
2200 .off1 = td_var_offset(log_avg_msec),
2201 .help = "Average bw/iops/lat logs over this period of time",
2203 .category = FIO_OPT_G_LOG,
2206 .name = "hugepage-size",
2207 .type = FIO_OPT_INT,
2208 .off1 = td_var_offset(hugepage_size),
2209 .help = "When using hugepages, specify size of each page",
2210 .def = __fio_stringify(FIO_HUGE_PAGE),
2211 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
2214 .name = "group_reporting",
2215 .type = FIO_OPT_STR_SET,
2216 .off1 = td_var_offset(group_reporting),
2217 .help = "Do reporting on a per-group basis",
2218 .category = FIO_OPT_G_MISC,
2221 .name = "zero_buffers",
2222 .type = FIO_OPT_STR_SET,
2223 .off1 = td_var_offset(zero_buffers),
2224 .help = "Init IO buffers to all zeroes",
2225 .category = FIO_OPT_G_IO_BUF,
2228 .name = "refill_buffers",
2229 .type = FIO_OPT_STR_SET,
2230 .off1 = td_var_offset(refill_buffers),
2231 .help = "Refill IO buffers on every IO submit",
2232 .category = FIO_OPT_G_IO_BUF,
2235 .name = "scramble_buffers",
2236 .type = FIO_OPT_BOOL,
2237 .off1 = td_var_offset(scramble_buffers),
2238 .help = "Slightly scramble buffers on every IO submit",
2240 .category = FIO_OPT_G_IO_BUF,
2243 .name = "buffer_compress_percentage",
2244 .type = FIO_OPT_INT,
2245 .off1 = td_var_offset(compress_percentage),
2248 .help = "How compressible the buffer is (approximately)",
2249 .category = FIO_OPT_G_IO_BUF,
2252 .name = "buffer_compress_chunk",
2253 .type = FIO_OPT_INT,
2254 .off1 = td_var_offset(compress_chunk),
2255 .parent = "buffer_compress_percentage",
2256 .help = "Size of compressible region in buffer",
2257 .category = FIO_OPT_G_IO_BUF,
2260 .name = "clat_percentiles",
2261 .type = FIO_OPT_BOOL,
2262 .off1 = td_var_offset(clat_percentiles),
2263 .help = "Enable the reporting of completion latency percentiles",
2265 .category = FIO_OPT_G_STAT,
2268 .name = "percentile_list",
2269 .type = FIO_OPT_FLOAT_LIST,
2270 .off1 = td_var_offset(percentile_list),
2271 .off2 = td_var_offset(overwrite_plist),
2272 .help = "Specify a custom list of percentiles to report",
2273 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2276 .category = FIO_OPT_G_STAT,
2279 #ifdef FIO_HAVE_DISK_UTIL
2281 .name = "disk_util",
2282 .type = FIO_OPT_BOOL,
2283 .off1 = td_var_offset(do_disk_util),
2284 .help = "Log disk utilization statistics",
2286 .category = FIO_OPT_G_OS | FIO_OPT_G_STAT,
2290 .name = "gtod_reduce",
2291 .type = FIO_OPT_BOOL,
2292 .help = "Greatly reduce number of gettimeofday() calls",
2293 .cb = str_gtod_reduce_cb,
2295 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2298 .name = "disable_lat",
2299 .type = FIO_OPT_BOOL,
2300 .off1 = td_var_offset(disable_lat),
2301 .help = "Disable latency numbers",
2302 .parent = "gtod_reduce",
2304 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2307 .name = "disable_clat",
2308 .type = FIO_OPT_BOOL,
2309 .off1 = td_var_offset(disable_clat),
2310 .help = "Disable completion latency numbers",
2311 .parent = "gtod_reduce",
2313 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2316 .name = "disable_slat",
2317 .type = FIO_OPT_BOOL,
2318 .off1 = td_var_offset(disable_slat),
2319 .help = "Disable submission latency numbers",
2320 .parent = "gtod_reduce",
2322 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2325 .name = "disable_bw_measurement",
2326 .type = FIO_OPT_BOOL,
2327 .off1 = td_var_offset(disable_bw),
2328 .help = "Disable bandwidth logging",
2329 .parent = "gtod_reduce",
2331 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2335 .type = FIO_OPT_INT,
2336 .cb = str_gtod_cpu_cb,
2337 .help = "Set up dedicated gettimeofday() thread on this CPU",
2338 .verify = gtod_cpu_verify,
2339 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2342 .name = "continue_on_error",
2343 .type = FIO_OPT_STR,
2344 .off1 = td_var_offset(continue_on_error),
2345 .help = "Continue on non-fatal errors during IO",
2347 .category = FIO_OPT_G_MISC | FIO_OPT_G_ERR,
2350 .oval = ERROR_TYPE_NONE,
2351 .help = "Exit when an error is encountered",
2354 .oval = ERROR_TYPE_READ,
2355 .help = "Continue on read errors only",
2358 .oval = ERROR_TYPE_WRITE,
2359 .help = "Continue on write errors only",
2362 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2363 .help = "Continue on any IO errors",
2366 .oval = ERROR_TYPE_VERIFY,
2367 .help = "Continue on verify errors only",
2370 .oval = ERROR_TYPE_ANY,
2371 .help = "Continue on all io and verify errors",
2374 .oval = ERROR_TYPE_NONE,
2375 .help = "Alias for 'none'",
2378 .oval = ERROR_TYPE_ANY,
2379 .help = "Alias for 'all'",
2385 .type = FIO_OPT_STR_STORE,
2386 .off1 = td_var_offset(profile),
2387 .help = "Select a specific builtin performance test",
2388 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2392 .type = FIO_OPT_STR_STORE,
2393 .off1 = td_var_offset(cgroup),
2394 .help = "Add job to cgroup of this name",
2395 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2398 .name = "cgroup_weight",
2399 .type = FIO_OPT_INT,
2400 .off1 = td_var_offset(cgroup_weight),
2401 .help = "Use given weight for cgroup",
2404 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2407 .name = "cgroup_nodelete",
2408 .type = FIO_OPT_BOOL,
2409 .off1 = td_var_offset(cgroup_nodelete),
2410 .help = "Do not delete cgroups after job completion",
2412 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2416 .type = FIO_OPT_INT,
2417 .off1 = td_var_offset(uid),
2418 .help = "Run job with this user ID",
2419 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2423 .type = FIO_OPT_INT,
2424 .off1 = td_var_offset(gid),
2425 .help = "Run job with this group ID",
2426 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2430 .type = FIO_OPT_INT,
2431 .off1 = td_var_offset(flow_id),
2432 .help = "The flow index ID to use",
2434 .category = FIO_OPT_G_IO,
2438 .type = FIO_OPT_INT,
2439 .off1 = td_var_offset(flow),
2440 .help = "Weight for flow control of this job",
2441 .parent = "flow_id",
2443 .category = FIO_OPT_G_IO,
2446 .name = "flow_watermark",
2447 .type = FIO_OPT_INT,
2448 .off1 = td_var_offset(flow_watermark),
2449 .help = "High watermark for flow control. This option"
2450 " should be set to the same value for all threads"
2451 " with non-zero flow.",
2452 .parent = "flow_id",
2454 .category = FIO_OPT_G_IO,
2457 .name = "flow_sleep",
2458 .type = FIO_OPT_INT,
2459 .off1 = td_var_offset(flow_sleep),
2460 .help = "How many microseconds to sleep after being held"
2461 " back by the flow control mechanism",
2462 .parent = "flow_id",
2464 .category = FIO_OPT_G_IO,
2471 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2472 const char *name, int val)
2474 lopt->name = (char *) name;
2476 if (o->type == FIO_OPT_STR_SET)
2477 lopt->has_arg = no_argument;
2479 lopt->has_arg = required_argument;
2482 static void options_to_lopts(struct fio_option *opts,
2483 struct option *long_options,
2484 int i, int option_type)
2486 struct fio_option *o = &opts[0];
2488 add_to_lopt(&long_options[i], o, o->name, option_type);
2491 add_to_lopt(&long_options[i], o, o->alias, option_type);
2496 assert(i < FIO_NR_OPTIONS);
2500 void fio_options_set_ioengine_opts(struct option *long_options,
2501 struct thread_data *td)
2506 while (long_options[i].name) {
2507 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2508 memset(&long_options[i], 0, sizeof(*long_options));
2515 * Just clear out the prior ioengine options.
2520 options_to_lopts(td->io_ops->options, long_options, i,
2521 FIO_GETOPT_IOENGINE);
2524 void fio_options_dup_and_init(struct option *long_options)
2528 options_init(fio_options);
2531 while (long_options[i].name)
2534 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
2537 struct fio_keyword {
2543 static struct fio_keyword fio_keywords[] = {
2545 .word = "$pagesize",
2546 .desc = "Page size in the system",
2549 .word = "$mb_memory",
2550 .desc = "Megabytes of memory online",
2554 .desc = "Number of CPUs online in the system",
2561 void fio_keywords_init(void)
2563 unsigned long long mb_memory;
2567 sprintf(buf, "%lu", page_size);
2568 fio_keywords[0].replace = strdup(buf);
2570 mb_memory = os_phys_mem() / (1024 * 1024);
2571 sprintf(buf, "%llu", mb_memory);
2572 fio_keywords[1].replace = strdup(buf);
2575 sprintf(buf, "%lu", l);
2576 fio_keywords[2].replace = strdup(buf);
2581 static char *bc_calc(char *str)
2583 char buf[128], *tmp;
2588 * No math, just return string
2590 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2591 !strchr(str, '/')) || strchr(str, '\''))
2595 * Split option from value, we only need to calculate the value
2597 tmp = strchr(str, '=');
2604 * Prevent buffer overflows; such a case isn't reasonable anyway
2606 if (strlen(str) >= 128 || strlen(tmp) > 100)
2609 sprintf(buf, "which %s > /dev/null", BC_APP);
2611 log_err("fio: bc is needed for performing math\n");
2615 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2616 f = popen(buf, "r");
2621 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2627 buf[(tmp - str) + ret - 1] = '\0';
2628 memcpy(buf, str, tmp - str);
2634 * Return a copy of the input string with substrings of the form ${VARNAME}
2635 * substituted with the value of the environment variable VARNAME. The
2636 * substitution always occurs, even if VARNAME is empty or the corresponding
2637 * environment variable undefined.
2639 static char *option_dup_subs(const char *opt)
2641 char out[OPT_LEN_MAX+1];
2642 char in[OPT_LEN_MAX+1];
2645 char *ch1, *ch2, *env;
2646 ssize_t nchr = OPT_LEN_MAX;
2649 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2650 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2654 in[OPT_LEN_MAX] = '\0';
2655 strncpy(in, opt, OPT_LEN_MAX);
2657 while (*inptr && nchr > 0) {
2658 if (inptr[0] == '$' && inptr[1] == '{') {
2659 ch2 = strchr(inptr, '}');
2660 if (ch2 && inptr+1 < ch2) {
2667 envlen = strlen(env);
2668 if (envlen <= nchr) {
2669 memcpy(outptr, env, envlen);
2679 *outptr++ = *inptr++;
2688 * Look for reserved variable names and replace them with real values
2690 static char *fio_keyword_replace(char *opt)
2696 for (i = 0; fio_keywords[i].word != NULL; i++) {
2697 struct fio_keyword *kw = &fio_keywords[i];
2699 while ((s = strstr(opt, kw->word)) != NULL) {
2700 char *new = malloc(strlen(opt) + 1);
2706 * Copy part of the string before the keyword and
2707 * sprintf() the replacement after it.
2709 memcpy(new, opt, olen);
2710 len = sprintf(new + olen, "%s", kw->replace);
2713 * If there's more in the original string, copy that
2716 opt += strlen(kw->word) + olen;
2718 memcpy(new + olen + len, opt, opt - o_org - 1);
2721 * replace opt and free the old opt
2731 * Check for potential math and invoke bc, if possible
2739 static char **dup_and_sub_options(char **opts, int num_opts)
2742 char **opts_copy = malloc(num_opts * sizeof(*opts));
2743 for (i = 0; i < num_opts; i++) {
2744 opts_copy[i] = option_dup_subs(opts[i]);
2747 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2752 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2754 int i, ret, unknown;
2757 sort_options(opts, fio_options, num_opts);
2758 opts_copy = dup_and_sub_options(opts, num_opts);
2760 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2761 struct fio_option *o;
2762 int newret = parse_option(opts_copy[i], opts[i], fio_options,
2771 opts_copy[i] = NULL;
2778 ret |= ioengine_load(td);
2780 sort_options(opts_copy, td->io_ops->options, num_opts);
2783 for (i = 0; i < num_opts; i++) {
2784 struct fio_option *o = NULL;
2790 newret = parse_option(opts_copy[i], opts[i],
2791 td->io_ops->options, &o,
2796 log_err("Bad option <%s>\n", opts[i]);
2799 opts_copy[i] = NULL;
2807 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2809 return parse_cmd_option(opt, val, fio_options, td);
2812 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2815 return parse_cmd_option(opt, val, td->io_ops->options, td);
2818 void fio_fill_default_options(struct thread_data *td)
2820 fill_default_options(td, fio_options);
2823 int fio_show_option_help(const char *opt)
2825 return show_cmd_help(fio_options, opt);
2828 void options_mem_dupe(void *data, struct fio_option *options)
2830 struct fio_option *o;
2833 for (o = &options[0]; o->name; o++) {
2834 if (o->type != FIO_OPT_STR_STORE)
2837 ptr = td_var(data, o->off1);
2839 *ptr = strdup(*ptr);
2844 * dupe FIO_OPT_STR_STORE options
2846 void fio_options_mem_dupe(struct thread_data *td)
2848 options_mem_dupe(&td->o, fio_options);
2850 if (td->eo && td->io_ops) {
2851 void *oldeo = td->eo;
2853 td->eo = malloc(td->io_ops->option_struct_size);
2854 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2855 options_mem_dupe(td->eo, td->io_ops->options);
2859 unsigned int fio_get_kb_base(void *data)
2861 struct thread_data *td = data;
2862 unsigned int kb_base = 0;
2865 kb_base = td->o.kb_base;
2872 int add_option(struct fio_option *o)
2874 struct fio_option *__o;
2883 memcpy(&fio_options[opt_index], o, sizeof(*o));
2887 void invalidate_profile_options(const char *prof_name)
2889 struct fio_option *o;
2893 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2894 o->type = FIO_OPT_INVALID;
2895 o->prof_name = NULL;
2901 void add_opt_posval(const char *optname, const char *ival, const char *help)
2903 struct fio_option *o;
2906 o = find_option(fio_options, optname);
2910 for (i = 0; i < PARSE_MAX_VP; i++) {
2911 if (o->posval[i].ival)
2914 o->posval[i].ival = ival;
2915 o->posval[i].help = help;
2920 void del_opt_posval(const char *optname, const char *ival)
2922 struct fio_option *o;
2925 o = find_option(fio_options, optname);
2929 for (i = 0; i < PARSE_MAX_VP; i++) {
2930 if (!o->posval[i].ival)
2932 if (strcmp(o->posval[i].ival, ival))
2935 o->posval[i].ival = NULL;
2936 o->posval[i].help = NULL;
2940 void fio_options_free(struct thread_data *td)
2942 options_free(fio_options, td);
2943 if (td->eo && td->io_ops && td->io_ops->options) {
2944 options_free(td->io_ops->options, td->eo);