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_RAND,
879 .mask = FIO_OPT_G_OS,
883 .mask = FIO_OPT_G_MEM,
887 .mask = FIO_OPT_G_VERIFY,
891 .mask = FIO_OPT_G_CPU,
895 .mask = FIO_OPT_G_LOG,
899 .mask = FIO_OPT_G_ZONE,
903 .mask = FIO_OPT_G_CACHE,
907 .mask = FIO_OPT_G_STAT,
911 .mask = FIO_OPT_G_ERR,
915 .mask = FIO_OPT_G_JOB,
922 struct opt_group *opt_group_from_mask(unsigned int *mask)
924 struct opt_group *og;
927 if (*mask == FIO_OPT_G_INVALID)
930 for (i = 0; fio_opt_groups[i].name; i++) {
931 og = &fio_opt_groups[i];
933 if (*mask & og->mask) {
934 *mask &= ~(og->mask);
943 * Map of job/command line options
945 struct fio_option fio_options[FIO_MAX_OPTS] = {
947 .name = "description",
948 .type = FIO_OPT_STR_STORE,
949 .off1 = td_var_offset(description),
950 .help = "Text job description",
951 .category = FIO_OPT_G_DESC,
955 .type = FIO_OPT_STR_STORE,
956 .off1 = td_var_offset(name),
957 .help = "Name of this job",
958 .category = FIO_OPT_G_DESC,
962 .type = FIO_OPT_STR_STORE,
963 .off1 = td_var_offset(directory),
964 .cb = str_directory_cb,
965 .help = "Directory to store files in",
966 .category = FIO_OPT_G_FILE,
970 .type = FIO_OPT_STR_STORE,
971 .off1 = td_var_offset(filename),
972 .cb = str_filename_cb,
973 .prio = -1, /* must come after "directory" */
974 .help = "File(s) to use for the workload",
975 .category = FIO_OPT_G_FILE,
980 .off1 = td_var_offset(kb_base),
981 .verify = kb_base_verify,
984 .help = "How many bytes per KB for reporting (1000 or 1024)",
985 .category = FIO_OPT_G_MISC,
990 .cb = str_lockfile_cb,
991 .off1 = td_var_offset(file_lock_mode),
992 .help = "Lock file when doing IO to it",
993 .parent = "filename",
995 .category = FIO_OPT_G_FILE,
998 .oval = FILE_LOCK_NONE,
999 .help = "No file locking",
1001 { .ival = "exclusive",
1002 .oval = FILE_LOCK_EXCLUSIVE,
1003 .help = "Exclusive file lock",
1006 .ival = "readwrite",
1007 .oval = FILE_LOCK_READWRITE,
1008 .help = "Read vs write lock",
1014 .type = FIO_OPT_STR_STORE,
1015 .off1 = td_var_offset(opendir),
1016 .cb = str_opendir_cb,
1017 .help = "Recursively add files from this directory and down",
1018 .category = FIO_OPT_G_FILE,
1022 .alias = "readwrite",
1023 .type = FIO_OPT_STR,
1025 .off1 = td_var_offset(td_ddir),
1026 .help = "IO direction",
1028 .verify = rw_verify,
1029 .category = FIO_OPT_G_IO_DDIR,
1032 .oval = TD_DDIR_READ,
1033 .help = "Sequential read",
1036 .oval = TD_DDIR_WRITE,
1037 .help = "Sequential write",
1039 { .ival = "randread",
1040 .oval = TD_DDIR_RANDREAD,
1041 .help = "Random read",
1043 { .ival = "randwrite",
1044 .oval = TD_DDIR_RANDWRITE,
1045 .help = "Random write",
1049 .help = "Sequential read and write mix",
1052 .oval = TD_DDIR_RANDRW,
1053 .help = "Random read and write mix"
1058 .name = "rw_sequencer",
1059 .type = FIO_OPT_STR,
1060 .off1 = td_var_offset(rw_seq),
1061 .help = "IO offset generator modifier",
1062 .def = "sequential",
1063 .category = FIO_OPT_G_IO_DDIR,
1065 { .ival = "sequential",
1067 .help = "Generate sequential offsets",
1069 { .ival = "identical",
1070 .oval = RW_SEQ_IDENT,
1071 .help = "Generate identical offsets",
1078 .type = FIO_OPT_STR_STORE,
1079 .off1 = td_var_offset(ioengine),
1080 .help = "IO engine to use",
1081 .def = FIO_PREFERRED_ENGINE,
1082 .category = FIO_OPT_G_IO,
1085 .help = "Use read/write",
1088 .help = "Use pread/pwrite",
1091 .help = "Use readv/writev",
1093 #ifdef FIO_HAVE_LIBAIO
1095 .help = "Linux native asynchronous IO",
1098 #ifdef FIO_HAVE_POSIXAIO
1099 { .ival = "posixaio",
1100 .help = "POSIX asynchronous IO",
1103 #ifdef FIO_HAVE_SOLARISAIO
1104 { .ival = "solarisaio",
1105 .help = "Solaris native asynchronous IO",
1108 #ifdef FIO_HAVE_WINDOWSAIO
1109 { .ival = "windowsaio",
1110 .help = "Windows native asynchronous IO"
1114 .help = "Memory mapped IO"
1116 #ifdef FIO_HAVE_SPLICE
1118 .help = "splice/vmsplice based IO",
1120 { .ival = "netsplice",
1121 .help = "splice/vmsplice to/from the network",
1124 #ifdef FIO_HAVE_SGIO
1126 .help = "SCSI generic v3 IO",
1130 .help = "Testing engine (no data transfer)",
1133 .help = "Network IO",
1135 #ifdef FIO_HAVE_SYSLET
1136 { .ival = "syslet-rw",
1137 .help = "syslet enabled async pread/pwrite IO",
1141 .help = "CPU cycle burner engine",
1143 #ifdef FIO_HAVE_GUASI
1145 .help = "GUASI IO engine",
1148 #ifdef FIO_HAVE_BINJECT
1149 { .ival = "binject",
1150 .help = "binject direct inject block engine",
1153 #ifdef FIO_HAVE_RDMA
1155 .help = "RDMA IO engine",
1158 { .ival = "external",
1159 .help = "Load external engine (append name)",
1165 .type = FIO_OPT_INT,
1166 .off1 = td_var_offset(iodepth),
1167 .help = "Number of IO buffers to keep in flight",
1170 .category = FIO_OPT_G_IO,
1173 .name = "iodepth_batch",
1174 .alias = "iodepth_batch_submit",
1175 .type = FIO_OPT_INT,
1176 .off1 = td_var_offset(iodepth_batch),
1177 .help = "Number of IO buffers to submit in one go",
1178 .parent = "iodepth",
1181 .category = FIO_OPT_G_IO,
1184 .name = "iodepth_batch_complete",
1185 .type = FIO_OPT_INT,
1186 .off1 = td_var_offset(iodepth_batch_complete),
1187 .help = "Number of IO buffers to retrieve in one go",
1188 .parent = "iodepth",
1191 .category = FIO_OPT_G_IO,
1194 .name = "iodepth_low",
1195 .type = FIO_OPT_INT,
1196 .off1 = td_var_offset(iodepth_low),
1197 .help = "Low water mark for queuing depth",
1198 .parent = "iodepth",
1199 .category = FIO_OPT_G_IO,
1203 .type = FIO_OPT_STR_VAL,
1205 .help = "Total size of device or files",
1206 .category = FIO_OPT_G_IO,
1209 .name = "fill_device",
1211 .type = FIO_OPT_BOOL,
1212 .off1 = td_var_offset(fill_device),
1213 .help = "Write until an ENOSPC error occurs",
1215 .category = FIO_OPT_G_IO,
1219 .type = FIO_OPT_STR_VAL,
1220 .off1 = td_var_offset(file_size_low),
1221 .off2 = td_var_offset(file_size_high),
1223 .help = "Size of individual files",
1224 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
1228 .alias = "fileoffset",
1229 .type = FIO_OPT_STR_VAL,
1230 .off1 = td_var_offset(start_offset),
1231 .help = "Start IO from this offset",
1233 .category = FIO_OPT_G_IO,
1236 .name = "offset_increment",
1237 .type = FIO_OPT_STR_VAL,
1238 .off1 = td_var_offset(offset_increment),
1239 .help = "What is the increment from one offset to the next",
1245 .alias = "blocksize",
1246 .type = FIO_OPT_INT,
1247 .off1 = td_var_offset(bs[DDIR_READ]),
1248 .off2 = td_var_offset(bs[DDIR_WRITE]),
1250 .help = "Block size unit",
1253 .category = FIO_OPT_G_IO,
1257 .alias = "blockalign",
1258 .type = FIO_OPT_INT,
1259 .off1 = td_var_offset(ba[DDIR_READ]),
1260 .off2 = td_var_offset(ba[DDIR_WRITE]),
1262 .help = "IO block offset alignment",
1264 .category = FIO_OPT_G_IO | FIO_OPT_G_IO_BUF,
1268 .alias = "blocksize_range",
1269 .type = FIO_OPT_RANGE,
1270 .off1 = td_var_offset(min_bs[DDIR_READ]),
1271 .off2 = td_var_offset(max_bs[DDIR_READ]),
1272 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1273 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1275 .help = "Set block size range (in more detail than bs)",
1277 .category = FIO_OPT_G_IO,
1281 .type = FIO_OPT_STR,
1282 .cb = str_bssplit_cb,
1283 .help = "Set a specific mix of block sizes",
1285 .category = FIO_OPT_G_IO,
1288 .name = "bs_unaligned",
1289 .alias = "blocksize_unaligned",
1290 .type = FIO_OPT_STR_SET,
1291 .off1 = td_var_offset(bs_unaligned),
1292 .help = "Don't sector align IO buffer sizes",
1294 .category = FIO_OPT_G_IO,
1297 .name = "randrepeat",
1298 .type = FIO_OPT_BOOL,
1299 .off1 = td_var_offset(rand_repeatable),
1300 .help = "Use repeatable random IO pattern",
1303 .category = FIO_OPT_G_IO | FIO_OPT_G_RAND,
1306 .name = "use_os_rand",
1307 .type = FIO_OPT_BOOL,
1308 .off1 = td_var_offset(use_os_rand),
1309 .help = "Set to use OS random generator",
1312 .category = FIO_OPT_G_RAND,
1315 .name = "norandommap",
1316 .type = FIO_OPT_STR_SET,
1317 .off1 = td_var_offset(norandommap),
1318 .help = "Accept potential duplicate random blocks",
1320 .category = FIO_OPT_G_RAND,
1323 .name = "softrandommap",
1324 .type = FIO_OPT_BOOL,
1325 .off1 = td_var_offset(softrandommap),
1326 .help = "Set norandommap if randommap allocation fails",
1327 .parent = "norandommap",
1329 .category = FIO_OPT_G_RAND,
1333 .alias = "nr_files",
1334 .type = FIO_OPT_INT,
1335 .off1 = td_var_offset(nr_files),
1336 .help = "Split job workload between this number of files",
1338 .category = FIO_OPT_G_FILE,
1341 .name = "openfiles",
1342 .type = FIO_OPT_INT,
1343 .off1 = td_var_offset(open_files),
1344 .help = "Number of files to keep open at the same time",
1345 .category = FIO_OPT_G_FILE,
1348 .name = "file_service_type",
1349 .type = FIO_OPT_STR,
1351 .off1 = td_var_offset(file_service_type),
1352 .help = "How to select which file to service next",
1353 .def = "roundrobin",
1354 .category = FIO_OPT_G_FILE,
1357 .oval = FIO_FSERVICE_RANDOM,
1358 .help = "Choose a file at random",
1360 { .ival = "roundrobin",
1361 .oval = FIO_FSERVICE_RR,
1362 .help = "Round robin select files",
1364 { .ival = "sequential",
1365 .oval = FIO_FSERVICE_SEQ,
1366 .help = "Finish one file before moving to the next",
1369 .parent = "nrfiles",
1371 #ifdef FIO_HAVE_FALLOCATE
1373 .name = "fallocate",
1374 .type = FIO_OPT_STR,
1375 .off1 = td_var_offset(fallocate_mode),
1376 .help = "Whether pre-allocation is performed when laying out files",
1378 .category = FIO_OPT_G_FILE,
1381 .oval = FIO_FALLOCATE_NONE,
1382 .help = "Do not pre-allocate space",
1385 .oval = FIO_FALLOCATE_POSIX,
1386 .help = "Use posix_fallocate()",
1388 #ifdef FIO_HAVE_LINUX_FALLOCATE
1390 .oval = FIO_FALLOCATE_KEEP_SIZE,
1391 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1394 /* Compatibility with former boolean values */
1396 .oval = FIO_FALLOCATE_NONE,
1397 .help = "Alias for 'none'",
1400 .oval = FIO_FALLOCATE_POSIX,
1401 .help = "Alias for 'posix'",
1405 #endif /* FIO_HAVE_FALLOCATE */
1407 .name = "fadvise_hint",
1408 .type = FIO_OPT_BOOL,
1409 .off1 = td_var_offset(fadvise_hint),
1410 .help = "Use fadvise() to advise the kernel on IO pattern",
1412 .category = FIO_OPT_G_FILE,
1416 .type = FIO_OPT_INT,
1417 .off1 = td_var_offset(fsync_blocks),
1418 .help = "Issue fsync for writes every given number of blocks",
1420 .category = FIO_OPT_G_FILE,
1423 .name = "fdatasync",
1424 .type = FIO_OPT_INT,
1425 .off1 = td_var_offset(fdatasync_blocks),
1426 .help = "Issue fdatasync for writes every given number of blocks",
1428 .category = FIO_OPT_G_FILE,
1431 .name = "write_barrier",
1432 .type = FIO_OPT_INT,
1433 .off1 = td_var_offset(barrier_blocks),
1434 .help = "Make every Nth write a barrier write",
1436 .category = FIO_OPT_G_IO,
1438 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1440 .name = "sync_file_range",
1442 { .ival = "wait_before",
1443 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1444 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1448 .oval = SYNC_FILE_RANGE_WRITE,
1449 .help = "SYNC_FILE_RANGE_WRITE",
1453 .ival = "wait_after",
1454 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1455 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1459 .type = FIO_OPT_STR_MULTI,
1461 .off1 = td_var_offset(sync_file_range),
1462 .help = "Use sync_file_range()",
1463 .category = FIO_OPT_G_FILE,
1468 .type = FIO_OPT_BOOL,
1469 .off1 = td_var_offset(odirect),
1470 .help = "Use O_DIRECT IO (negates buffered)",
1472 .category = FIO_OPT_G_IO,
1476 .type = FIO_OPT_BOOL,
1477 .off1 = td_var_offset(odirect),
1479 .help = "Use buffered IO (negates direct)",
1481 .category = FIO_OPT_G_IO,
1484 .name = "overwrite",
1485 .type = FIO_OPT_BOOL,
1486 .off1 = td_var_offset(overwrite),
1487 .help = "When writing, set whether to overwrite current data",
1489 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
1493 .type = FIO_OPT_INT,
1494 .off1 = td_var_offset(loops),
1495 .help = "Number of times to run the job",
1497 .category = FIO_OPT_G_MISC,
1501 .type = FIO_OPT_INT,
1502 .off1 = td_var_offset(numjobs),
1503 .help = "Duplicate this job this many times",
1505 .category = FIO_OPT_G_MISC,
1508 .name = "startdelay",
1509 .type = FIO_OPT_STR_VAL_TIME,
1510 .off1 = td_var_offset(start_delay),
1511 .help = "Only start job when this period has passed",
1513 .category = FIO_OPT_G_MISC,
1518 .type = FIO_OPT_STR_VAL_TIME,
1519 .off1 = td_var_offset(timeout),
1520 .help = "Stop workload when this amount of time has passed",
1522 .category = FIO_OPT_G_MISC,
1525 .name = "time_based",
1526 .type = FIO_OPT_STR_SET,
1527 .off1 = td_var_offset(time_based),
1528 .help = "Keep running until runtime/timeout is met",
1529 .category = FIO_OPT_G_MISC,
1532 .name = "ramp_time",
1533 .type = FIO_OPT_STR_VAL_TIME,
1534 .off1 = td_var_offset(ramp_time),
1535 .help = "Ramp up time before measuring performance",
1536 .category = FIO_OPT_G_MISC,
1539 .name = "clocksource",
1540 .type = FIO_OPT_STR,
1541 .cb = fio_clock_source_cb,
1542 .off1 = td_var_offset(clocksource),
1543 .help = "What type of timing source to use",
1544 .category = FIO_OPT_G_OS,
1546 { .ival = "gettimeofday",
1548 .help = "Use gettimeofday(2) for timing",
1550 { .ival = "clock_gettime",
1551 .oval = CS_CGETTIME,
1552 .help = "Use clock_gettime(2) for timing",
1554 #ifdef ARCH_HAVE_CPU_CLOCK
1556 .oval = CS_CPUCLOCK,
1557 .help = "Use CPU private clock",
1565 .type = FIO_OPT_STR,
1567 .off1 = td_var_offset(mem_type),
1568 .help = "Backing type for IO buffers",
1570 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1574 .help = "Use malloc(3) for IO buffers",
1578 .help = "Use shared memory segments for IO buffers",
1580 #ifdef FIO_HAVE_HUGETLB
1581 { .ival = "shmhuge",
1582 .oval = MEM_SHMHUGE,
1583 .help = "Like shm, but use huge pages",
1588 .help = "Use mmap(2) (file or anon) for IO buffers",
1590 #ifdef FIO_HAVE_HUGETLB
1591 { .ival = "mmaphuge",
1592 .oval = MEM_MMAPHUGE,
1593 .help = "Like mmap, but use huge pages",
1599 .name = "iomem_align",
1600 .alias = "mem_align",
1601 .type = FIO_OPT_INT,
1602 .off1 = td_var_offset(mem_align),
1604 .help = "IO memory buffer offset alignment",
1607 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1611 .type = FIO_OPT_STR,
1612 .off1 = td_var_offset(verify),
1613 .help = "Verify data written",
1614 .cb = str_verify_cb,
1616 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1619 .oval = VERIFY_NONE,
1620 .help = "Don't do IO verification",
1624 .help = "Use md5 checksums for verification",
1627 .oval = VERIFY_CRC64,
1628 .help = "Use crc64 checksums for verification",
1631 .oval = VERIFY_CRC32,
1632 .help = "Use crc32 checksums for verification",
1634 { .ival = "crc32c-intel",
1635 .oval = VERIFY_CRC32C,
1636 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1639 .oval = VERIFY_CRC32C,
1640 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1643 .oval = VERIFY_CRC16,
1644 .help = "Use crc16 checksums for verification",
1647 .oval = VERIFY_CRC7,
1648 .help = "Use crc7 checksums for verification",
1651 .oval = VERIFY_SHA1,
1652 .help = "Use sha1 checksums for verification",
1655 .oval = VERIFY_SHA256,
1656 .help = "Use sha256 checksums for verification",
1659 .oval = VERIFY_SHA512,
1660 .help = "Use sha512 checksums for verification",
1663 .oval = VERIFY_META,
1664 .help = "Use io information",
1668 .oval = VERIFY_NULL,
1669 .help = "Pretend to verify",
1674 .name = "do_verify",
1675 .type = FIO_OPT_BOOL,
1676 .off1 = td_var_offset(do_verify),
1677 .help = "Run verification stage after write",
1680 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1683 .name = "verifysort",
1684 .type = FIO_OPT_BOOL,
1685 .off1 = td_var_offset(verifysort),
1686 .help = "Sort written verify blocks for read back",
1689 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1692 .name = "verify_interval",
1693 .type = FIO_OPT_INT,
1694 .off1 = td_var_offset(verify_interval),
1695 .minval = 2 * sizeof(struct verify_header),
1696 .help = "Store verify buffer header every N bytes",
1698 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1701 .name = "verify_offset",
1702 .type = FIO_OPT_INT,
1703 .help = "Offset verify header location by N bytes",
1705 .cb = str_verify_offset_cb,
1707 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1710 .name = "verify_pattern",
1711 .type = FIO_OPT_STR,
1712 .cb = str_verify_pattern_cb,
1713 .help = "Fill pattern for IO buffers",
1715 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1718 .name = "verify_fatal",
1719 .type = FIO_OPT_BOOL,
1720 .off1 = td_var_offset(verify_fatal),
1722 .help = "Exit on a single verify failure, don't continue",
1724 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1727 .name = "verify_dump",
1728 .type = FIO_OPT_BOOL,
1729 .off1 = td_var_offset(verify_dump),
1731 .help = "Dump contents of good and bad blocks on failure",
1733 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1736 .name = "verify_async",
1737 .type = FIO_OPT_INT,
1738 .off1 = td_var_offset(verify_async),
1740 .help = "Number of async verifier threads to use",
1742 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1745 .name = "verify_backlog",
1746 .type = FIO_OPT_STR_VAL,
1747 .off1 = td_var_offset(verify_backlog),
1748 .help = "Verify after this number of blocks are written",
1750 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1753 .name = "verify_backlog_batch",
1754 .type = FIO_OPT_INT,
1755 .off1 = td_var_offset(verify_batch),
1756 .help = "Verify this number of IO blocks",
1758 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1760 #ifdef FIO_HAVE_CPU_AFFINITY
1762 .name = "verify_async_cpus",
1763 .type = FIO_OPT_STR,
1764 .cb = str_verify_cpus_allowed_cb,
1765 .help = "Set CPUs allowed for async verify threads",
1766 .parent = "verify_async",
1767 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU | FIO_OPT_G_VERIFY,
1770 #ifdef FIO_HAVE_TRIM
1772 .name = "trim_percentage",
1773 .type = FIO_OPT_INT,
1774 .cb = str_verify_trim_cb,
1776 .help = "Number of verify blocks to discard/trim",
1779 .category = FIO_OPT_G_IO,
1782 .name = "trim_verify_zero",
1783 .type = FIO_OPT_INT,
1784 .help = "Verify that trim/discarded blocks are returned as zeroes",
1785 .off1 = td_var_offset(trim_zero),
1786 .parent = "trim_percentage",
1788 .category = FIO_OPT_G_IO,
1791 .name = "trim_backlog",
1792 .type = FIO_OPT_STR_VAL,
1793 .off1 = td_var_offset(trim_backlog),
1794 .help = "Trim after this number of blocks are written",
1795 .parent = "trim_percentage",
1796 .category = FIO_OPT_G_IO,
1799 .name = "trim_backlog_batch",
1800 .type = FIO_OPT_INT,
1801 .off1 = td_var_offset(trim_batch),
1802 .help = "Trim this number of IO blocks",
1803 .parent = "trim_percentage",
1804 .category = FIO_OPT_G_IO,
1808 .name = "write_iolog",
1809 .type = FIO_OPT_STR_STORE,
1810 .off1 = td_var_offset(write_iolog_file),
1811 .help = "Store IO pattern to file",
1812 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1815 .name = "read_iolog",
1816 .type = FIO_OPT_STR_STORE,
1817 .off1 = td_var_offset(read_iolog_file),
1818 .help = "Playback IO pattern from file",
1819 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1822 .name = "replay_no_stall",
1823 .type = FIO_OPT_INT,
1824 .off1 = td_var_offset(no_stall),
1826 .parent = "read_iolog",
1827 .help = "Playback IO pattern file as fast as possible without stalls",
1828 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1831 .name = "replay_redirect",
1832 .type = FIO_OPT_STR_STORE,
1833 .off1 = td_var_offset(replay_redirect),
1834 .parent = "read_iolog",
1835 .help = "Replay all I/O onto this device, regardless of trace device",
1836 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1839 .name = "exec_prerun",
1840 .type = FIO_OPT_STR_STORE,
1841 .off1 = td_var_offset(exec_prerun),
1842 .help = "Execute this file prior to running job",
1843 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1846 .name = "exec_postrun",
1847 .type = FIO_OPT_STR_STORE,
1848 .off1 = td_var_offset(exec_postrun),
1849 .help = "Execute this file after running job",
1850 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1852 #ifdef FIO_HAVE_IOSCHED_SWITCH
1854 .name = "ioscheduler",
1855 .type = FIO_OPT_STR_STORE,
1856 .off1 = td_var_offset(ioscheduler),
1857 .help = "Use this IO scheduler on the backing device",
1858 .category = FIO_OPT_G_OS | FIO_OPT_G_IO,
1863 .type = FIO_OPT_STR_VAL,
1864 .off1 = td_var_offset(zone_size),
1865 .help = "Amount of data to read per zone",
1867 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1870 .name = "zonerange",
1871 .type = FIO_OPT_STR_VAL,
1872 .off1 = td_var_offset(zone_range),
1873 .help = "Give size of an IO zone",
1875 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1879 .type = FIO_OPT_STR_VAL,
1880 .off1 = td_var_offset(zone_skip),
1881 .help = "Space between IO zones",
1883 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1887 .type = FIO_OPT_STR_VAL,
1888 .cb = str_lockmem_cb,
1889 .help = "Lock down this amount of memory",
1891 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
1894 .name = "rwmixread",
1895 .type = FIO_OPT_INT,
1896 .cb = str_rwmix_read_cb,
1898 .help = "Percentage of mixed workload that is reads",
1900 .category = FIO_OPT_G_IO,
1903 .name = "rwmixwrite",
1904 .type = FIO_OPT_INT,
1905 .cb = str_rwmix_write_cb,
1907 .help = "Percentage of mixed workload that is writes",
1909 .category = FIO_OPT_G_IO,
1912 .name = "rwmixcycle",
1913 .type = FIO_OPT_DEPRECATED,
1914 .category = FIO_OPT_G_IO,
1918 .type = FIO_OPT_INT,
1919 .off1 = td_var_offset(nice),
1920 .help = "Set job CPU nice value",
1924 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1926 #ifdef FIO_HAVE_IOPRIO
1929 .type = FIO_OPT_INT,
1931 .help = "Set job IO priority value",
1934 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1937 .name = "prioclass",
1938 .type = FIO_OPT_INT,
1939 .cb = str_prioclass_cb,
1940 .help = "Set job IO priority class",
1943 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1947 .name = "thinktime",
1948 .type = FIO_OPT_INT,
1949 .off1 = td_var_offset(thinktime),
1950 .help = "Idle time between IO buffers (usec)",
1952 .category = FIO_OPT_G_MISC,
1955 .name = "thinktime_spin",
1956 .type = FIO_OPT_INT,
1957 .off1 = td_var_offset(thinktime_spin),
1958 .help = "Start think time by spinning this amount (usec)",
1960 .parent = "thinktime",
1961 .category = FIO_OPT_G_MISC,
1964 .name = "thinktime_blocks",
1965 .type = FIO_OPT_INT,
1966 .off1 = td_var_offset(thinktime_blocks),
1967 .help = "IO buffer period between 'thinktime'",
1969 .parent = "thinktime",
1970 .category = FIO_OPT_G_MISC,
1974 .type = FIO_OPT_INT,
1975 .off1 = td_var_offset(rate[0]),
1976 .off2 = td_var_offset(rate[1]),
1977 .help = "Set bandwidth rate",
1978 .category = FIO_OPT_G_IO,
1982 .type = FIO_OPT_INT,
1983 .off1 = td_var_offset(ratemin[0]),
1984 .off2 = td_var_offset(ratemin[1]),
1985 .help = "Job must meet this rate or it will be shutdown",
1987 .category = FIO_OPT_G_IO,
1990 .name = "rate_iops",
1991 .type = FIO_OPT_INT,
1992 .off1 = td_var_offset(rate_iops[0]),
1993 .off2 = td_var_offset(rate_iops[1]),
1994 .help = "Limit IO used to this number of IO operations/sec",
1995 .category = FIO_OPT_G_IO,
1998 .name = "rate_iops_min",
1999 .type = FIO_OPT_INT,
2000 .off1 = td_var_offset(rate_iops_min[0]),
2001 .off2 = td_var_offset(rate_iops_min[1]),
2002 .help = "Job must meet this rate or it will be shut down",
2003 .parent = "rate_iops",
2004 .category = FIO_OPT_G_IO,
2007 .name = "ratecycle",
2008 .type = FIO_OPT_INT,
2009 .off1 = td_var_offset(ratecycle),
2010 .help = "Window average for rate limits (msec)",
2013 .category = FIO_OPT_G_IO,
2016 .name = "invalidate",
2017 .type = FIO_OPT_BOOL,
2018 .off1 = td_var_offset(invalidate_cache),
2019 .help = "Invalidate buffer/page cache prior to running job",
2021 .category = FIO_OPT_G_IO | FIO_OPT_G_CACHE,
2025 .type = FIO_OPT_BOOL,
2026 .off1 = td_var_offset(sync_io),
2027 .help = "Use O_SYNC for buffered writes",
2029 .parent = "buffered",
2030 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
2033 .name = "bwavgtime",
2034 .type = FIO_OPT_INT,
2035 .off1 = td_var_offset(bw_avg_time),
2036 .help = "Time window over which to calculate bandwidth"
2039 .parent = "write_bw_log",
2040 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2043 .name = "iopsavgtime",
2044 .type = FIO_OPT_INT,
2045 .off1 = td_var_offset(iops_avg_time),
2046 .help = "Time window over which to calculate IOPS (msec)",
2048 .parent = "write_iops_log",
2049 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2052 .name = "create_serialize",
2053 .type = FIO_OPT_BOOL,
2054 .off1 = td_var_offset(create_serialize),
2055 .help = "Serialize creating of job files",
2057 .category = FIO_OPT_G_FILE,
2060 .name = "create_fsync",
2061 .type = FIO_OPT_BOOL,
2062 .off1 = td_var_offset(create_fsync),
2063 .help = "fsync file after creation",
2065 .category = FIO_OPT_G_FILE,
2068 .name = "create_on_open",
2069 .type = FIO_OPT_BOOL,
2070 .off1 = td_var_offset(create_on_open),
2071 .help = "Create files when they are opened for IO",
2073 .category = FIO_OPT_G_FILE,
2077 .type = FIO_OPT_BOOL,
2078 .off1 = td_var_offset(pre_read),
2079 .help = "Pre-read files before starting official testing",
2081 .category = FIO_OPT_G_FILE | FIO_OPT_G_CACHE,
2085 .type = FIO_OPT_INT,
2086 .off1 = td_var_offset(cpuload),
2087 .help = "Use this percentage of CPU",
2088 .category = FIO_OPT_G_CPU,
2091 .name = "cpuchunks",
2092 .type = FIO_OPT_INT,
2093 .off1 = td_var_offset(cpucycle),
2094 .help = "Length of the CPU burn cycles (usecs)",
2096 .parent = "cpuload",
2097 .category = FIO_OPT_G_CPU,
2099 #ifdef FIO_HAVE_CPU_AFFINITY
2102 .type = FIO_OPT_INT,
2103 .cb = str_cpumask_cb,
2104 .help = "CPU affinity mask",
2105 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2108 .name = "cpus_allowed",
2109 .type = FIO_OPT_STR,
2110 .cb = str_cpus_allowed_cb,
2111 .help = "Set CPUs allowed",
2112 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2116 .name = "end_fsync",
2117 .type = FIO_OPT_BOOL,
2118 .off1 = td_var_offset(end_fsync),
2119 .help = "Include fsync at the end of job",
2121 .category = FIO_OPT_G_FILE,
2124 .name = "fsync_on_close",
2125 .type = FIO_OPT_BOOL,
2126 .off1 = td_var_offset(fsync_on_close),
2127 .help = "fsync files on close",
2129 .category = FIO_OPT_G_FILE,
2133 .type = FIO_OPT_BOOL,
2134 .off1 = td_var_offset(unlink),
2135 .help = "Unlink created files after job has completed",
2137 .category = FIO_OPT_G_FILE,
2141 .type = FIO_OPT_STR_SET,
2142 .cb = str_exitall_cb,
2143 .help = "Terminate all jobs when one exits",
2144 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2147 .name = "stonewall",
2148 .alias = "wait_for_previous",
2149 .type = FIO_OPT_STR_SET,
2150 .off1 = td_var_offset(stonewall),
2151 .help = "Insert a hard barrier between this job and previous",
2152 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2155 .name = "new_group",
2156 .type = FIO_OPT_STR_SET,
2157 .off1 = td_var_offset(new_group),
2158 .help = "Mark the start of a new group (for reporting)",
2159 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2163 .type = FIO_OPT_STR_SET,
2164 .off1 = td_var_offset(use_thread),
2165 .help = "Use threads instead of forks",
2166 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS | FIO_OPT_G_JOB,
2169 .name = "write_bw_log",
2170 .type = FIO_OPT_STR,
2171 .off1 = td_var_offset(write_bw_log),
2172 .cb = str_write_bw_log_cb,
2173 .help = "Write log of bandwidth during run",
2174 .category = FIO_OPT_G_LOG,
2177 .name = "write_lat_log",
2178 .type = FIO_OPT_STR,
2179 .off1 = td_var_offset(write_lat_log),
2180 .cb = str_write_lat_log_cb,
2181 .help = "Write log of latency during run",
2182 .category = FIO_OPT_G_LOG,
2185 .name = "write_iops_log",
2186 .type = FIO_OPT_STR,
2187 .off1 = td_var_offset(write_iops_log),
2188 .cb = str_write_iops_log_cb,
2189 .help = "Write log of IOPS during run",
2190 .category = FIO_OPT_G_LOG,
2193 .name = "log_avg_msec",
2194 .type = FIO_OPT_INT,
2195 .off1 = td_var_offset(log_avg_msec),
2196 .help = "Average bw/iops/lat logs over this period of time",
2198 .category = FIO_OPT_G_LOG,
2201 .name = "hugepage-size",
2202 .type = FIO_OPT_INT,
2203 .off1 = td_var_offset(hugepage_size),
2204 .help = "When using hugepages, specify size of each page",
2205 .def = __fio_stringify(FIO_HUGE_PAGE),
2206 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
2209 .name = "group_reporting",
2210 .type = FIO_OPT_STR_SET,
2211 .off1 = td_var_offset(group_reporting),
2212 .help = "Do reporting on a per-group basis",
2213 .category = FIO_OPT_G_MISC,
2216 .name = "zero_buffers",
2217 .type = FIO_OPT_STR_SET,
2218 .off1 = td_var_offset(zero_buffers),
2219 .help = "Init IO buffers to all zeroes",
2220 .category = FIO_OPT_G_IO_BUF,
2223 .name = "refill_buffers",
2224 .type = FIO_OPT_STR_SET,
2225 .off1 = td_var_offset(refill_buffers),
2226 .help = "Refill IO buffers on every IO submit",
2227 .category = FIO_OPT_G_IO_BUF,
2230 .name = "scramble_buffers",
2231 .type = FIO_OPT_BOOL,
2232 .off1 = td_var_offset(scramble_buffers),
2233 .help = "Slightly scramble buffers on every IO submit",
2235 .category = FIO_OPT_G_IO_BUF,
2238 .name = "buffer_compress_percentage",
2239 .type = FIO_OPT_INT,
2240 .off1 = td_var_offset(compress_percentage),
2243 .help = "How compressible the buffer is (approximately)",
2246 .name = "buffer_compress_chunk",
2247 .type = FIO_OPT_INT,
2248 .off1 = td_var_offset(compress_chunk),
2249 .parent = "buffer_compress_percentage",
2250 .help = "Size of compressible region in buffer",
2253 .name = "clat_percentiles",
2254 .type = FIO_OPT_BOOL,
2255 .off1 = td_var_offset(clat_percentiles),
2256 .help = "Enable the reporting of completion latency percentiles",
2258 .category = FIO_OPT_G_STAT,
2261 .name = "percentile_list",
2262 .type = FIO_OPT_FLOAT_LIST,
2263 .off1 = td_var_offset(percentile_list),
2264 .off2 = td_var_offset(overwrite_plist),
2265 .help = "Specify a custom list of percentiles to report",
2266 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2269 .category = FIO_OPT_G_STAT,
2272 #ifdef FIO_HAVE_DISK_UTIL
2274 .name = "disk_util",
2275 .type = FIO_OPT_BOOL,
2276 .off1 = td_var_offset(do_disk_util),
2277 .help = "Log disk utilization statistics",
2279 .category = FIO_OPT_G_OS | FIO_OPT_G_STAT,
2283 .name = "gtod_reduce",
2284 .type = FIO_OPT_BOOL,
2285 .help = "Greatly reduce number of gettimeofday() calls",
2286 .cb = str_gtod_reduce_cb,
2288 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2291 .name = "disable_lat",
2292 .type = FIO_OPT_BOOL,
2293 .off1 = td_var_offset(disable_lat),
2294 .help = "Disable latency numbers",
2295 .parent = "gtod_reduce",
2297 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2300 .name = "disable_clat",
2301 .type = FIO_OPT_BOOL,
2302 .off1 = td_var_offset(disable_clat),
2303 .help = "Disable completion latency numbers",
2304 .parent = "gtod_reduce",
2306 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2309 .name = "disable_slat",
2310 .type = FIO_OPT_BOOL,
2311 .off1 = td_var_offset(disable_slat),
2312 .help = "Disable submission latency numbers",
2313 .parent = "gtod_reduce",
2315 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2318 .name = "disable_bw_measurement",
2319 .type = FIO_OPT_BOOL,
2320 .off1 = td_var_offset(disable_bw),
2321 .help = "Disable bandwidth logging",
2322 .parent = "gtod_reduce",
2324 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2328 .type = FIO_OPT_INT,
2329 .cb = str_gtod_cpu_cb,
2330 .help = "Set up dedicated gettimeofday() thread on this CPU",
2331 .verify = gtod_cpu_verify,
2332 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2335 .name = "continue_on_error",
2336 .type = FIO_OPT_STR,
2337 .off1 = td_var_offset(continue_on_error),
2338 .help = "Continue on non-fatal errors during IO",
2340 .category = FIO_OPT_G_MISC | FIO_OPT_G_ERR,
2343 .oval = ERROR_TYPE_NONE,
2344 .help = "Exit when an error is encountered",
2347 .oval = ERROR_TYPE_READ,
2348 .help = "Continue on read errors only",
2351 .oval = ERROR_TYPE_WRITE,
2352 .help = "Continue on write errors only",
2355 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2356 .help = "Continue on any IO errors",
2359 .oval = ERROR_TYPE_VERIFY,
2360 .help = "Continue on verify errors only",
2363 .oval = ERROR_TYPE_ANY,
2364 .help = "Continue on all io and verify errors",
2367 .oval = ERROR_TYPE_NONE,
2368 .help = "Alias for 'none'",
2371 .oval = ERROR_TYPE_ANY,
2372 .help = "Alias for 'all'",
2378 .type = FIO_OPT_STR_STORE,
2379 .off1 = td_var_offset(profile),
2380 .help = "Select a specific builtin performance test",
2381 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2385 .type = FIO_OPT_STR_STORE,
2386 .off1 = td_var_offset(cgroup),
2387 .help = "Add job to cgroup of this name",
2388 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2391 .name = "cgroup_weight",
2392 .type = FIO_OPT_INT,
2393 .off1 = td_var_offset(cgroup_weight),
2394 .help = "Use given weight for cgroup",
2397 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2400 .name = "cgroup_nodelete",
2401 .type = FIO_OPT_BOOL,
2402 .off1 = td_var_offset(cgroup_nodelete),
2403 .help = "Do not delete cgroups after job completion",
2405 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2409 .type = FIO_OPT_INT,
2410 .off1 = td_var_offset(uid),
2411 .help = "Run job with this user ID",
2412 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2416 .type = FIO_OPT_INT,
2417 .off1 = td_var_offset(gid),
2418 .help = "Run job with this group ID",
2419 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2423 .type = FIO_OPT_INT,
2424 .off1 = td_var_offset(flow_id),
2425 .help = "The flow index ID to use",
2427 .category = FIO_OPT_G_IO,
2431 .type = FIO_OPT_INT,
2432 .off1 = td_var_offset(flow),
2433 .help = "Weight for flow control of this job",
2434 .parent = "flow_id",
2436 .category = FIO_OPT_G_IO,
2439 .name = "flow_watermark",
2440 .type = FIO_OPT_INT,
2441 .off1 = td_var_offset(flow_watermark),
2442 .help = "High watermark for flow control. This option"
2443 " should be set to the same value for all threads"
2444 " with non-zero flow.",
2445 .parent = "flow_id",
2447 .category = FIO_OPT_G_IO,
2450 .name = "flow_sleep",
2451 .type = FIO_OPT_INT,
2452 .off1 = td_var_offset(flow_sleep),
2453 .help = "How many microseconds to sleep after being held"
2454 " back by the flow control mechanism",
2455 .parent = "flow_id",
2457 .category = FIO_OPT_G_IO,
2464 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2465 const char *name, int val)
2467 lopt->name = (char *) name;
2469 if (o->type == FIO_OPT_STR_SET)
2470 lopt->has_arg = no_argument;
2472 lopt->has_arg = required_argument;
2475 static void options_to_lopts(struct fio_option *opts,
2476 struct option *long_options,
2477 int i, int option_type)
2479 struct fio_option *o = &opts[0];
2481 add_to_lopt(&long_options[i], o, o->name, option_type);
2484 add_to_lopt(&long_options[i], o, o->alias, option_type);
2489 assert(i < FIO_NR_OPTIONS);
2493 void fio_options_set_ioengine_opts(struct option *long_options,
2494 struct thread_data *td)
2499 while (long_options[i].name) {
2500 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2501 memset(&long_options[i], 0, sizeof(*long_options));
2508 * Just clear out the prior ioengine options.
2513 options_to_lopts(td->io_ops->options, long_options, i,
2514 FIO_GETOPT_IOENGINE);
2517 void fio_options_dup_and_init(struct option *long_options)
2521 options_init(fio_options);
2524 while (long_options[i].name)
2527 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
2530 struct fio_keyword {
2536 static struct fio_keyword fio_keywords[] = {
2538 .word = "$pagesize",
2539 .desc = "Page size in the system",
2542 .word = "$mb_memory",
2543 .desc = "Megabytes of memory online",
2547 .desc = "Number of CPUs online in the system",
2554 void fio_keywords_init(void)
2556 unsigned long long mb_memory;
2560 sprintf(buf, "%lu", page_size);
2561 fio_keywords[0].replace = strdup(buf);
2563 mb_memory = os_phys_mem() / (1024 * 1024);
2564 sprintf(buf, "%llu", mb_memory);
2565 fio_keywords[1].replace = strdup(buf);
2568 sprintf(buf, "%lu", l);
2569 fio_keywords[2].replace = strdup(buf);
2574 static char *bc_calc(char *str)
2576 char buf[128], *tmp;
2581 * No math, just return string
2583 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2584 !strchr(str, '/')) || strchr(str, '\''))
2588 * Split option from value, we only need to calculate the value
2590 tmp = strchr(str, '=');
2597 * Prevent buffer overflows; such a case isn't reasonable anyway
2599 if (strlen(str) >= 128 || strlen(tmp) > 100)
2602 sprintf(buf, "which %s > /dev/null", BC_APP);
2604 log_err("fio: bc is needed for performing math\n");
2608 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2609 f = popen(buf, "r");
2614 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2620 buf[(tmp - str) + ret - 1] = '\0';
2621 memcpy(buf, str, tmp - str);
2627 * Return a copy of the input string with substrings of the form ${VARNAME}
2628 * substituted with the value of the environment variable VARNAME. The
2629 * substitution always occurs, even if VARNAME is empty or the corresponding
2630 * environment variable undefined.
2632 static char *option_dup_subs(const char *opt)
2634 char out[OPT_LEN_MAX+1];
2635 char in[OPT_LEN_MAX+1];
2638 char *ch1, *ch2, *env;
2639 ssize_t nchr = OPT_LEN_MAX;
2642 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2643 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2647 in[OPT_LEN_MAX] = '\0';
2648 strncpy(in, opt, OPT_LEN_MAX);
2650 while (*inptr && nchr > 0) {
2651 if (inptr[0] == '$' && inptr[1] == '{') {
2652 ch2 = strchr(inptr, '}');
2653 if (ch2 && inptr+1 < ch2) {
2660 envlen = strlen(env);
2661 if (envlen <= nchr) {
2662 memcpy(outptr, env, envlen);
2672 *outptr++ = *inptr++;
2681 * Look for reserved variable names and replace them with real values
2683 static char *fio_keyword_replace(char *opt)
2689 for (i = 0; fio_keywords[i].word != NULL; i++) {
2690 struct fio_keyword *kw = &fio_keywords[i];
2692 while ((s = strstr(opt, kw->word)) != NULL) {
2693 char *new = malloc(strlen(opt) + 1);
2699 * Copy part of the string before the keyword and
2700 * sprintf() the replacement after it.
2702 memcpy(new, opt, olen);
2703 len = sprintf(new + olen, "%s", kw->replace);
2706 * If there's more in the original string, copy that
2709 opt += strlen(kw->word) + olen;
2711 memcpy(new + olen + len, opt, opt - o_org - 1);
2714 * replace opt and free the old opt
2724 * Check for potential math and invoke bc, if possible
2732 static char **dup_and_sub_options(char **opts, int num_opts)
2735 char **opts_copy = malloc(num_opts * sizeof(*opts));
2736 for (i = 0; i < num_opts; i++) {
2737 opts_copy[i] = option_dup_subs(opts[i]);
2740 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2745 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2747 int i, ret, unknown;
2750 sort_options(opts, fio_options, num_opts);
2751 opts_copy = dup_and_sub_options(opts, num_opts);
2753 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2754 struct fio_option *o;
2755 int newret = parse_option(opts_copy[i], opts[i], fio_options,
2764 opts_copy[i] = NULL;
2771 ret |= ioengine_load(td);
2773 sort_options(opts_copy, td->io_ops->options, num_opts);
2776 for (i = 0; i < num_opts; i++) {
2777 struct fio_option *o = NULL;
2783 newret = parse_option(opts_copy[i], opts[i],
2784 td->io_ops->options, &o,
2789 log_err("Bad option <%s>\n", opts[i]);
2792 opts_copy[i] = NULL;
2800 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2802 return parse_cmd_option(opt, val, fio_options, td);
2805 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2808 return parse_cmd_option(opt, val, td->io_ops->options, td);
2811 void fio_fill_default_options(struct thread_data *td)
2813 fill_default_options(td, fio_options);
2816 int fio_show_option_help(const char *opt)
2818 return show_cmd_help(fio_options, opt);
2821 void options_mem_dupe(void *data, struct fio_option *options)
2823 struct fio_option *o;
2826 for (o = &options[0]; o->name; o++) {
2827 if (o->type != FIO_OPT_STR_STORE)
2830 ptr = td_var(data, o->off1);
2832 *ptr = strdup(*ptr);
2837 * dupe FIO_OPT_STR_STORE options
2839 void fio_options_mem_dupe(struct thread_data *td)
2841 options_mem_dupe(&td->o, fio_options);
2843 if (td->eo && td->io_ops) {
2844 void *oldeo = td->eo;
2846 td->eo = malloc(td->io_ops->option_struct_size);
2847 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2848 options_mem_dupe(td->eo, td->io_ops->options);
2852 unsigned int fio_get_kb_base(void *data)
2854 struct thread_data *td = data;
2855 unsigned int kb_base = 0;
2858 kb_base = td->o.kb_base;
2865 int add_option(struct fio_option *o)
2867 struct fio_option *__o;
2876 memcpy(&fio_options[opt_index], o, sizeof(*o));
2880 void invalidate_profile_options(const char *prof_name)
2882 struct fio_option *o;
2886 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2887 o->type = FIO_OPT_INVALID;
2888 o->prof_name = NULL;
2894 void add_opt_posval(const char *optname, const char *ival, const char *help)
2896 struct fio_option *o;
2899 o = find_option(fio_options, optname);
2903 for (i = 0; i < PARSE_MAX_VP; i++) {
2904 if (o->posval[i].ival)
2907 o->posval[i].ival = ival;
2908 o->posval[i].help = help;
2913 void del_opt_posval(const char *optname, const char *ival)
2915 struct fio_option *o;
2918 o = find_option(fio_options, optname);
2922 for (i = 0; i < PARSE_MAX_VP; i++) {
2923 if (!o->posval[i].ival)
2925 if (strcmp(o->posval[i].ival, ival))
2928 o->posval[i].ival = NULL;
2929 o->posval[i].help = NULL;
2933 void fio_options_free(struct thread_data *td)
2935 options_free(fio_options, td);
2936 if (td->eo && td->io_ops && td->io_ops->options) {
2937 options_free(td->io_ops->options, td->eo);