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",
1242 .category = FIO_OPT_G_IO,
1246 .alias = "blocksize",
1247 .type = FIO_OPT_INT,
1248 .off1 = td_var_offset(bs[DDIR_READ]),
1249 .off2 = td_var_offset(bs[DDIR_WRITE]),
1251 .help = "Block size unit",
1254 .category = FIO_OPT_G_IO,
1258 .alias = "blockalign",
1259 .type = FIO_OPT_INT,
1260 .off1 = td_var_offset(ba[DDIR_READ]),
1261 .off2 = td_var_offset(ba[DDIR_WRITE]),
1263 .help = "IO block offset alignment",
1265 .category = FIO_OPT_G_IO | FIO_OPT_G_IO_BUF,
1269 .alias = "blocksize_range",
1270 .type = FIO_OPT_RANGE,
1271 .off1 = td_var_offset(min_bs[DDIR_READ]),
1272 .off2 = td_var_offset(max_bs[DDIR_READ]),
1273 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1274 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1276 .help = "Set block size range (in more detail than bs)",
1278 .category = FIO_OPT_G_IO,
1282 .type = FIO_OPT_STR,
1283 .cb = str_bssplit_cb,
1284 .help = "Set a specific mix of block sizes",
1286 .category = FIO_OPT_G_IO,
1289 .name = "bs_unaligned",
1290 .alias = "blocksize_unaligned",
1291 .type = FIO_OPT_STR_SET,
1292 .off1 = td_var_offset(bs_unaligned),
1293 .help = "Don't sector align IO buffer sizes",
1295 .category = FIO_OPT_G_IO,
1298 .name = "randrepeat",
1299 .type = FIO_OPT_BOOL,
1300 .off1 = td_var_offset(rand_repeatable),
1301 .help = "Use repeatable random IO pattern",
1304 .category = FIO_OPT_G_IO | FIO_OPT_G_RAND,
1307 .name = "use_os_rand",
1308 .type = FIO_OPT_BOOL,
1309 .off1 = td_var_offset(use_os_rand),
1310 .help = "Set to use OS random generator",
1313 .category = FIO_OPT_G_RAND,
1316 .name = "norandommap",
1317 .type = FIO_OPT_STR_SET,
1318 .off1 = td_var_offset(norandommap),
1319 .help = "Accept potential duplicate random blocks",
1321 .category = FIO_OPT_G_RAND,
1324 .name = "softrandommap",
1325 .type = FIO_OPT_BOOL,
1326 .off1 = td_var_offset(softrandommap),
1327 .help = "Set norandommap if randommap allocation fails",
1328 .parent = "norandommap",
1330 .category = FIO_OPT_G_RAND,
1334 .alias = "nr_files",
1335 .type = FIO_OPT_INT,
1336 .off1 = td_var_offset(nr_files),
1337 .help = "Split job workload between this number of files",
1339 .category = FIO_OPT_G_FILE,
1342 .name = "openfiles",
1343 .type = FIO_OPT_INT,
1344 .off1 = td_var_offset(open_files),
1345 .help = "Number of files to keep open at the same time",
1346 .category = FIO_OPT_G_FILE,
1349 .name = "file_service_type",
1350 .type = FIO_OPT_STR,
1352 .off1 = td_var_offset(file_service_type),
1353 .help = "How to select which file to service next",
1354 .def = "roundrobin",
1355 .category = FIO_OPT_G_FILE,
1358 .oval = FIO_FSERVICE_RANDOM,
1359 .help = "Choose a file at random",
1361 { .ival = "roundrobin",
1362 .oval = FIO_FSERVICE_RR,
1363 .help = "Round robin select files",
1365 { .ival = "sequential",
1366 .oval = FIO_FSERVICE_SEQ,
1367 .help = "Finish one file before moving to the next",
1370 .parent = "nrfiles",
1372 #ifdef FIO_HAVE_FALLOCATE
1374 .name = "fallocate",
1375 .type = FIO_OPT_STR,
1376 .off1 = td_var_offset(fallocate_mode),
1377 .help = "Whether pre-allocation is performed when laying out files",
1379 .category = FIO_OPT_G_FILE,
1382 .oval = FIO_FALLOCATE_NONE,
1383 .help = "Do not pre-allocate space",
1386 .oval = FIO_FALLOCATE_POSIX,
1387 .help = "Use posix_fallocate()",
1389 #ifdef FIO_HAVE_LINUX_FALLOCATE
1391 .oval = FIO_FALLOCATE_KEEP_SIZE,
1392 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1395 /* Compatibility with former boolean values */
1397 .oval = FIO_FALLOCATE_NONE,
1398 .help = "Alias for 'none'",
1401 .oval = FIO_FALLOCATE_POSIX,
1402 .help = "Alias for 'posix'",
1406 #endif /* FIO_HAVE_FALLOCATE */
1408 .name = "fadvise_hint",
1409 .type = FIO_OPT_BOOL,
1410 .off1 = td_var_offset(fadvise_hint),
1411 .help = "Use fadvise() to advise the kernel on IO pattern",
1413 .category = FIO_OPT_G_FILE,
1417 .type = FIO_OPT_INT,
1418 .off1 = td_var_offset(fsync_blocks),
1419 .help = "Issue fsync for writes every given number of blocks",
1421 .category = FIO_OPT_G_FILE,
1424 .name = "fdatasync",
1425 .type = FIO_OPT_INT,
1426 .off1 = td_var_offset(fdatasync_blocks),
1427 .help = "Issue fdatasync for writes every given number of blocks",
1429 .category = FIO_OPT_G_FILE,
1432 .name = "write_barrier",
1433 .type = FIO_OPT_INT,
1434 .off1 = td_var_offset(barrier_blocks),
1435 .help = "Make every Nth write a barrier write",
1437 .category = FIO_OPT_G_IO,
1439 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1441 .name = "sync_file_range",
1443 { .ival = "wait_before",
1444 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1445 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1449 .oval = SYNC_FILE_RANGE_WRITE,
1450 .help = "SYNC_FILE_RANGE_WRITE",
1454 .ival = "wait_after",
1455 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1456 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1460 .type = FIO_OPT_STR_MULTI,
1462 .off1 = td_var_offset(sync_file_range),
1463 .help = "Use sync_file_range()",
1464 .category = FIO_OPT_G_FILE,
1469 .type = FIO_OPT_BOOL,
1470 .off1 = td_var_offset(odirect),
1471 .help = "Use O_DIRECT IO (negates buffered)",
1473 .category = FIO_OPT_G_IO,
1477 .type = FIO_OPT_BOOL,
1478 .off1 = td_var_offset(odirect),
1480 .help = "Use buffered IO (negates direct)",
1482 .category = FIO_OPT_G_IO,
1485 .name = "overwrite",
1486 .type = FIO_OPT_BOOL,
1487 .off1 = td_var_offset(overwrite),
1488 .help = "When writing, set whether to overwrite current data",
1490 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
1494 .type = FIO_OPT_INT,
1495 .off1 = td_var_offset(loops),
1496 .help = "Number of times to run the job",
1498 .category = FIO_OPT_G_MISC,
1502 .type = FIO_OPT_INT,
1503 .off1 = td_var_offset(numjobs),
1504 .help = "Duplicate this job this many times",
1506 .category = FIO_OPT_G_MISC,
1509 .name = "startdelay",
1510 .type = FIO_OPT_STR_VAL_TIME,
1511 .off1 = td_var_offset(start_delay),
1512 .help = "Only start job when this period has passed",
1514 .category = FIO_OPT_G_MISC,
1519 .type = FIO_OPT_STR_VAL_TIME,
1520 .off1 = td_var_offset(timeout),
1521 .help = "Stop workload when this amount of time has passed",
1523 .category = FIO_OPT_G_MISC,
1526 .name = "time_based",
1527 .type = FIO_OPT_STR_SET,
1528 .off1 = td_var_offset(time_based),
1529 .help = "Keep running until runtime/timeout is met",
1530 .category = FIO_OPT_G_MISC,
1533 .name = "ramp_time",
1534 .type = FIO_OPT_STR_VAL_TIME,
1535 .off1 = td_var_offset(ramp_time),
1536 .help = "Ramp up time before measuring performance",
1537 .category = FIO_OPT_G_MISC,
1540 .name = "clocksource",
1541 .type = FIO_OPT_STR,
1542 .cb = fio_clock_source_cb,
1543 .off1 = td_var_offset(clocksource),
1544 .help = "What type of timing source to use",
1545 .category = FIO_OPT_G_OS,
1547 { .ival = "gettimeofday",
1549 .help = "Use gettimeofday(2) for timing",
1551 { .ival = "clock_gettime",
1552 .oval = CS_CGETTIME,
1553 .help = "Use clock_gettime(2) for timing",
1555 #ifdef ARCH_HAVE_CPU_CLOCK
1557 .oval = CS_CPUCLOCK,
1558 .help = "Use CPU private clock",
1566 .type = FIO_OPT_STR,
1568 .off1 = td_var_offset(mem_type),
1569 .help = "Backing type for IO buffers",
1571 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1575 .help = "Use malloc(3) for IO buffers",
1579 .help = "Use shared memory segments for IO buffers",
1581 #ifdef FIO_HAVE_HUGETLB
1582 { .ival = "shmhuge",
1583 .oval = MEM_SHMHUGE,
1584 .help = "Like shm, but use huge pages",
1589 .help = "Use mmap(2) (file or anon) for IO buffers",
1591 #ifdef FIO_HAVE_HUGETLB
1592 { .ival = "mmaphuge",
1593 .oval = MEM_MMAPHUGE,
1594 .help = "Like mmap, but use huge pages",
1600 .name = "iomem_align",
1601 .alias = "mem_align",
1602 .type = FIO_OPT_INT,
1603 .off1 = td_var_offset(mem_align),
1605 .help = "IO memory buffer offset alignment",
1608 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
1612 .type = FIO_OPT_STR,
1613 .off1 = td_var_offset(verify),
1614 .help = "Verify data written",
1615 .cb = str_verify_cb,
1617 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1620 .oval = VERIFY_NONE,
1621 .help = "Don't do IO verification",
1625 .help = "Use md5 checksums for verification",
1628 .oval = VERIFY_CRC64,
1629 .help = "Use crc64 checksums for verification",
1632 .oval = VERIFY_CRC32,
1633 .help = "Use crc32 checksums for verification",
1635 { .ival = "crc32c-intel",
1636 .oval = VERIFY_CRC32C,
1637 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1640 .oval = VERIFY_CRC32C,
1641 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1644 .oval = VERIFY_CRC16,
1645 .help = "Use crc16 checksums for verification",
1648 .oval = VERIFY_CRC7,
1649 .help = "Use crc7 checksums for verification",
1652 .oval = VERIFY_SHA1,
1653 .help = "Use sha1 checksums for verification",
1656 .oval = VERIFY_SHA256,
1657 .help = "Use sha256 checksums for verification",
1660 .oval = VERIFY_SHA512,
1661 .help = "Use sha512 checksums for verification",
1664 .oval = VERIFY_META,
1665 .help = "Use io information",
1669 .oval = VERIFY_NULL,
1670 .help = "Pretend to verify",
1675 .name = "do_verify",
1676 .type = FIO_OPT_BOOL,
1677 .off1 = td_var_offset(do_verify),
1678 .help = "Run verification stage after write",
1681 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1684 .name = "verifysort",
1685 .type = FIO_OPT_BOOL,
1686 .off1 = td_var_offset(verifysort),
1687 .help = "Sort written verify blocks for read back",
1690 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1693 .name = "verify_interval",
1694 .type = FIO_OPT_INT,
1695 .off1 = td_var_offset(verify_interval),
1696 .minval = 2 * sizeof(struct verify_header),
1697 .help = "Store verify buffer header every N bytes",
1699 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1702 .name = "verify_offset",
1703 .type = FIO_OPT_INT,
1704 .help = "Offset verify header location by N bytes",
1706 .cb = str_verify_offset_cb,
1708 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1711 .name = "verify_pattern",
1712 .type = FIO_OPT_STR,
1713 .cb = str_verify_pattern_cb,
1714 .help = "Fill pattern for IO buffers",
1716 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1719 .name = "verify_fatal",
1720 .type = FIO_OPT_BOOL,
1721 .off1 = td_var_offset(verify_fatal),
1723 .help = "Exit on a single verify failure, don't continue",
1725 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1728 .name = "verify_dump",
1729 .type = FIO_OPT_BOOL,
1730 .off1 = td_var_offset(verify_dump),
1732 .help = "Dump contents of good and bad blocks on failure",
1734 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
1737 .name = "verify_async",
1738 .type = FIO_OPT_INT,
1739 .off1 = td_var_offset(verify_async),
1741 .help = "Number of async verifier threads to use",
1743 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1746 .name = "verify_backlog",
1747 .type = FIO_OPT_STR_VAL,
1748 .off1 = td_var_offset(verify_backlog),
1749 .help = "Verify after this number of blocks are written",
1751 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1754 .name = "verify_backlog_batch",
1755 .type = FIO_OPT_INT,
1756 .off1 = td_var_offset(verify_batch),
1757 .help = "Verify this number of IO blocks",
1759 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
1761 #ifdef FIO_HAVE_CPU_AFFINITY
1763 .name = "verify_async_cpus",
1764 .type = FIO_OPT_STR,
1765 .cb = str_verify_cpus_allowed_cb,
1766 .help = "Set CPUs allowed for async verify threads",
1767 .parent = "verify_async",
1768 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU | FIO_OPT_G_VERIFY,
1771 #ifdef FIO_HAVE_TRIM
1773 .name = "trim_percentage",
1774 .type = FIO_OPT_INT,
1775 .cb = str_verify_trim_cb,
1777 .help = "Number of verify blocks to discard/trim",
1780 .category = FIO_OPT_G_IO,
1783 .name = "trim_verify_zero",
1784 .type = FIO_OPT_INT,
1785 .help = "Verify that trim/discarded blocks are returned as zeroes",
1786 .off1 = td_var_offset(trim_zero),
1787 .parent = "trim_percentage",
1789 .category = FIO_OPT_G_IO,
1792 .name = "trim_backlog",
1793 .type = FIO_OPT_STR_VAL,
1794 .off1 = td_var_offset(trim_backlog),
1795 .help = "Trim after this number of blocks are written",
1796 .parent = "trim_percentage",
1797 .category = FIO_OPT_G_IO,
1800 .name = "trim_backlog_batch",
1801 .type = FIO_OPT_INT,
1802 .off1 = td_var_offset(trim_batch),
1803 .help = "Trim this number of IO blocks",
1804 .parent = "trim_percentage",
1805 .category = FIO_OPT_G_IO,
1809 .name = "write_iolog",
1810 .type = FIO_OPT_STR_STORE,
1811 .off1 = td_var_offset(write_iolog_file),
1812 .help = "Store IO pattern to file",
1813 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1816 .name = "read_iolog",
1817 .type = FIO_OPT_STR_STORE,
1818 .off1 = td_var_offset(read_iolog_file),
1819 .help = "Playback IO pattern from file",
1820 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1823 .name = "replay_no_stall",
1824 .type = FIO_OPT_INT,
1825 .off1 = td_var_offset(no_stall),
1827 .parent = "read_iolog",
1828 .help = "Playback IO pattern file as fast as possible without stalls",
1829 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1832 .name = "replay_redirect",
1833 .type = FIO_OPT_STR_STORE,
1834 .off1 = td_var_offset(replay_redirect),
1835 .parent = "read_iolog",
1836 .help = "Replay all I/O onto this device, regardless of trace device",
1837 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
1840 .name = "exec_prerun",
1841 .type = FIO_OPT_STR_STORE,
1842 .off1 = td_var_offset(exec_prerun),
1843 .help = "Execute this file prior to running job",
1844 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1847 .name = "exec_postrun",
1848 .type = FIO_OPT_STR_STORE,
1849 .off1 = td_var_offset(exec_postrun),
1850 .help = "Execute this file after running job",
1851 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
1853 #ifdef FIO_HAVE_IOSCHED_SWITCH
1855 .name = "ioscheduler",
1856 .type = FIO_OPT_STR_STORE,
1857 .off1 = td_var_offset(ioscheduler),
1858 .help = "Use this IO scheduler on the backing device",
1859 .category = FIO_OPT_G_OS | FIO_OPT_G_IO,
1864 .type = FIO_OPT_STR_VAL,
1865 .off1 = td_var_offset(zone_size),
1866 .help = "Amount of data to read per zone",
1868 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1871 .name = "zonerange",
1872 .type = FIO_OPT_STR_VAL,
1873 .off1 = td_var_offset(zone_range),
1874 .help = "Give size of an IO zone",
1876 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1880 .type = FIO_OPT_STR_VAL,
1881 .off1 = td_var_offset(zone_skip),
1882 .help = "Space between IO zones",
1884 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
1888 .type = FIO_OPT_STR_VAL,
1889 .cb = str_lockmem_cb,
1890 .help = "Lock down this amount of memory",
1892 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
1895 .name = "rwmixread",
1896 .type = FIO_OPT_INT,
1897 .cb = str_rwmix_read_cb,
1899 .help = "Percentage of mixed workload that is reads",
1901 .category = FIO_OPT_G_IO,
1904 .name = "rwmixwrite",
1905 .type = FIO_OPT_INT,
1906 .cb = str_rwmix_write_cb,
1908 .help = "Percentage of mixed workload that is writes",
1910 .category = FIO_OPT_G_IO,
1913 .name = "rwmixcycle",
1914 .type = FIO_OPT_DEPRECATED,
1915 .category = FIO_OPT_G_IO,
1919 .type = FIO_OPT_INT,
1920 .off1 = td_var_offset(nice),
1921 .help = "Set job CPU nice value",
1925 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1927 #ifdef FIO_HAVE_IOPRIO
1930 .type = FIO_OPT_INT,
1932 .help = "Set job IO priority value",
1935 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1938 .name = "prioclass",
1939 .type = FIO_OPT_INT,
1940 .cb = str_prioclass_cb,
1941 .help = "Set job IO priority class",
1944 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
1948 .name = "thinktime",
1949 .type = FIO_OPT_INT,
1950 .off1 = td_var_offset(thinktime),
1951 .help = "Idle time between IO buffers (usec)",
1953 .category = FIO_OPT_G_MISC,
1956 .name = "thinktime_spin",
1957 .type = FIO_OPT_INT,
1958 .off1 = td_var_offset(thinktime_spin),
1959 .help = "Start think time by spinning this amount (usec)",
1961 .parent = "thinktime",
1962 .category = FIO_OPT_G_MISC,
1965 .name = "thinktime_blocks",
1966 .type = FIO_OPT_INT,
1967 .off1 = td_var_offset(thinktime_blocks),
1968 .help = "IO buffer period between 'thinktime'",
1970 .parent = "thinktime",
1971 .category = FIO_OPT_G_MISC,
1975 .type = FIO_OPT_INT,
1976 .off1 = td_var_offset(rate[0]),
1977 .off2 = td_var_offset(rate[1]),
1978 .help = "Set bandwidth rate",
1979 .category = FIO_OPT_G_IO,
1983 .type = FIO_OPT_INT,
1984 .off1 = td_var_offset(ratemin[0]),
1985 .off2 = td_var_offset(ratemin[1]),
1986 .help = "Job must meet this rate or it will be shutdown",
1988 .category = FIO_OPT_G_IO,
1991 .name = "rate_iops",
1992 .type = FIO_OPT_INT,
1993 .off1 = td_var_offset(rate_iops[0]),
1994 .off2 = td_var_offset(rate_iops[1]),
1995 .help = "Limit IO used to this number of IO operations/sec",
1996 .category = FIO_OPT_G_IO,
1999 .name = "rate_iops_min",
2000 .type = FIO_OPT_INT,
2001 .off1 = td_var_offset(rate_iops_min[0]),
2002 .off2 = td_var_offset(rate_iops_min[1]),
2003 .help = "Job must meet this rate or it will be shut down",
2004 .parent = "rate_iops",
2005 .category = FIO_OPT_G_IO,
2008 .name = "ratecycle",
2009 .type = FIO_OPT_INT,
2010 .off1 = td_var_offset(ratecycle),
2011 .help = "Window average for rate limits (msec)",
2014 .category = FIO_OPT_G_IO,
2017 .name = "invalidate",
2018 .type = FIO_OPT_BOOL,
2019 .off1 = td_var_offset(invalidate_cache),
2020 .help = "Invalidate buffer/page cache prior to running job",
2022 .category = FIO_OPT_G_IO | FIO_OPT_G_CACHE,
2026 .type = FIO_OPT_BOOL,
2027 .off1 = td_var_offset(sync_io),
2028 .help = "Use O_SYNC for buffered writes",
2030 .parent = "buffered",
2031 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
2034 .name = "bwavgtime",
2035 .type = FIO_OPT_INT,
2036 .off1 = td_var_offset(bw_avg_time),
2037 .help = "Time window over which to calculate bandwidth"
2040 .parent = "write_bw_log",
2041 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2044 .name = "iopsavgtime",
2045 .type = FIO_OPT_INT,
2046 .off1 = td_var_offset(iops_avg_time),
2047 .help = "Time window over which to calculate IOPS (msec)",
2049 .parent = "write_iops_log",
2050 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
2053 .name = "create_serialize",
2054 .type = FIO_OPT_BOOL,
2055 .off1 = td_var_offset(create_serialize),
2056 .help = "Serialize creating of job files",
2058 .category = FIO_OPT_G_FILE,
2061 .name = "create_fsync",
2062 .type = FIO_OPT_BOOL,
2063 .off1 = td_var_offset(create_fsync),
2064 .help = "fsync file after creation",
2066 .category = FIO_OPT_G_FILE,
2069 .name = "create_on_open",
2070 .type = FIO_OPT_BOOL,
2071 .off1 = td_var_offset(create_on_open),
2072 .help = "Create files when they are opened for IO",
2074 .category = FIO_OPT_G_FILE,
2078 .type = FIO_OPT_BOOL,
2079 .off1 = td_var_offset(pre_read),
2080 .help = "Pre-read files before starting official testing",
2082 .category = FIO_OPT_G_FILE | FIO_OPT_G_CACHE,
2086 .type = FIO_OPT_INT,
2087 .off1 = td_var_offset(cpuload),
2088 .help = "Use this percentage of CPU",
2089 .category = FIO_OPT_G_CPU,
2092 .name = "cpuchunks",
2093 .type = FIO_OPT_INT,
2094 .off1 = td_var_offset(cpucycle),
2095 .help = "Length of the CPU burn cycles (usecs)",
2097 .parent = "cpuload",
2098 .category = FIO_OPT_G_CPU,
2100 #ifdef FIO_HAVE_CPU_AFFINITY
2103 .type = FIO_OPT_INT,
2104 .cb = str_cpumask_cb,
2105 .help = "CPU affinity mask",
2106 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2109 .name = "cpus_allowed",
2110 .type = FIO_OPT_STR,
2111 .cb = str_cpus_allowed_cb,
2112 .help = "Set CPUs allowed",
2113 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
2117 .name = "end_fsync",
2118 .type = FIO_OPT_BOOL,
2119 .off1 = td_var_offset(end_fsync),
2120 .help = "Include fsync at the end of job",
2122 .category = FIO_OPT_G_FILE,
2125 .name = "fsync_on_close",
2126 .type = FIO_OPT_BOOL,
2127 .off1 = td_var_offset(fsync_on_close),
2128 .help = "fsync files on close",
2130 .category = FIO_OPT_G_FILE,
2134 .type = FIO_OPT_BOOL,
2135 .off1 = td_var_offset(unlink),
2136 .help = "Unlink created files after job has completed",
2138 .category = FIO_OPT_G_FILE,
2142 .type = FIO_OPT_STR_SET,
2143 .cb = str_exitall_cb,
2144 .help = "Terminate all jobs when one exits",
2145 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2148 .name = "stonewall",
2149 .alias = "wait_for_previous",
2150 .type = FIO_OPT_STR_SET,
2151 .off1 = td_var_offset(stonewall),
2152 .help = "Insert a hard barrier between this job and previous",
2153 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2156 .name = "new_group",
2157 .type = FIO_OPT_STR_SET,
2158 .off1 = td_var_offset(new_group),
2159 .help = "Mark the start of a new group (for reporting)",
2160 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2164 .type = FIO_OPT_STR_SET,
2165 .off1 = td_var_offset(use_thread),
2166 .help = "Use threads instead of forks",
2167 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS | FIO_OPT_G_JOB,
2170 .name = "write_bw_log",
2171 .type = FIO_OPT_STR,
2172 .off1 = td_var_offset(write_bw_log),
2173 .cb = str_write_bw_log_cb,
2174 .help = "Write log of bandwidth during run",
2175 .category = FIO_OPT_G_LOG,
2178 .name = "write_lat_log",
2179 .type = FIO_OPT_STR,
2180 .off1 = td_var_offset(write_lat_log),
2181 .cb = str_write_lat_log_cb,
2182 .help = "Write log of latency during run",
2183 .category = FIO_OPT_G_LOG,
2186 .name = "write_iops_log",
2187 .type = FIO_OPT_STR,
2188 .off1 = td_var_offset(write_iops_log),
2189 .cb = str_write_iops_log_cb,
2190 .help = "Write log of IOPS during run",
2191 .category = FIO_OPT_G_LOG,
2194 .name = "log_avg_msec",
2195 .type = FIO_OPT_INT,
2196 .off1 = td_var_offset(log_avg_msec),
2197 .help = "Average bw/iops/lat logs over this period of time",
2199 .category = FIO_OPT_G_LOG,
2202 .name = "hugepage-size",
2203 .type = FIO_OPT_INT,
2204 .off1 = td_var_offset(hugepage_size),
2205 .help = "When using hugepages, specify size of each page",
2206 .def = __fio_stringify(FIO_HUGE_PAGE),
2207 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
2210 .name = "group_reporting",
2211 .type = FIO_OPT_STR_SET,
2212 .off1 = td_var_offset(group_reporting),
2213 .help = "Do reporting on a per-group basis",
2214 .category = FIO_OPT_G_MISC,
2217 .name = "zero_buffers",
2218 .type = FIO_OPT_STR_SET,
2219 .off1 = td_var_offset(zero_buffers),
2220 .help = "Init IO buffers to all zeroes",
2221 .category = FIO_OPT_G_IO_BUF,
2224 .name = "refill_buffers",
2225 .type = FIO_OPT_STR_SET,
2226 .off1 = td_var_offset(refill_buffers),
2227 .help = "Refill IO buffers on every IO submit",
2228 .category = FIO_OPT_G_IO_BUF,
2231 .name = "scramble_buffers",
2232 .type = FIO_OPT_BOOL,
2233 .off1 = td_var_offset(scramble_buffers),
2234 .help = "Slightly scramble buffers on every IO submit",
2236 .category = FIO_OPT_G_IO_BUF,
2239 .name = "buffer_compress_percentage",
2240 .type = FIO_OPT_INT,
2241 .off1 = td_var_offset(compress_percentage),
2244 .help = "How compressible the buffer is (approximately)",
2245 .category = FIO_OPT_G_IO_BUF,
2248 .name = "buffer_compress_chunk",
2249 .type = FIO_OPT_INT,
2250 .off1 = td_var_offset(compress_chunk),
2251 .parent = "buffer_compress_percentage",
2252 .help = "Size of compressible region in buffer",
2253 .category = FIO_OPT_G_IO_BUF,
2256 .name = "clat_percentiles",
2257 .type = FIO_OPT_BOOL,
2258 .off1 = td_var_offset(clat_percentiles),
2259 .help = "Enable the reporting of completion latency percentiles",
2261 .category = FIO_OPT_G_STAT,
2264 .name = "percentile_list",
2265 .type = FIO_OPT_FLOAT_LIST,
2266 .off1 = td_var_offset(percentile_list),
2267 .off2 = td_var_offset(overwrite_plist),
2268 .help = "Specify a custom list of percentiles to report",
2269 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2272 .category = FIO_OPT_G_STAT,
2275 #ifdef FIO_HAVE_DISK_UTIL
2277 .name = "disk_util",
2278 .type = FIO_OPT_BOOL,
2279 .off1 = td_var_offset(do_disk_util),
2280 .help = "Log disk utilization statistics",
2282 .category = FIO_OPT_G_OS | FIO_OPT_G_STAT,
2286 .name = "gtod_reduce",
2287 .type = FIO_OPT_BOOL,
2288 .help = "Greatly reduce number of gettimeofday() calls",
2289 .cb = str_gtod_reduce_cb,
2291 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2294 .name = "disable_lat",
2295 .type = FIO_OPT_BOOL,
2296 .off1 = td_var_offset(disable_lat),
2297 .help = "Disable latency numbers",
2298 .parent = "gtod_reduce",
2300 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2303 .name = "disable_clat",
2304 .type = FIO_OPT_BOOL,
2305 .off1 = td_var_offset(disable_clat),
2306 .help = "Disable completion latency numbers",
2307 .parent = "gtod_reduce",
2309 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2312 .name = "disable_slat",
2313 .type = FIO_OPT_BOOL,
2314 .off1 = td_var_offset(disable_slat),
2315 .help = "Disable submission latency numbers",
2316 .parent = "gtod_reduce",
2318 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2321 .name = "disable_bw_measurement",
2322 .type = FIO_OPT_BOOL,
2323 .off1 = td_var_offset(disable_bw),
2324 .help = "Disable bandwidth logging",
2325 .parent = "gtod_reduce",
2327 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2331 .type = FIO_OPT_INT,
2332 .cb = str_gtod_cpu_cb,
2333 .help = "Set up dedicated gettimeofday() thread on this CPU",
2334 .verify = gtod_cpu_verify,
2335 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
2338 .name = "continue_on_error",
2339 .type = FIO_OPT_STR,
2340 .off1 = td_var_offset(continue_on_error),
2341 .help = "Continue on non-fatal errors during IO",
2343 .category = FIO_OPT_G_MISC | FIO_OPT_G_ERR,
2346 .oval = ERROR_TYPE_NONE,
2347 .help = "Exit when an error is encountered",
2350 .oval = ERROR_TYPE_READ,
2351 .help = "Continue on read errors only",
2354 .oval = ERROR_TYPE_WRITE,
2355 .help = "Continue on write errors only",
2358 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2359 .help = "Continue on any IO errors",
2362 .oval = ERROR_TYPE_VERIFY,
2363 .help = "Continue on verify errors only",
2366 .oval = ERROR_TYPE_ANY,
2367 .help = "Continue on all io and verify errors",
2370 .oval = ERROR_TYPE_NONE,
2371 .help = "Alias for 'none'",
2374 .oval = ERROR_TYPE_ANY,
2375 .help = "Alias for 'all'",
2381 .type = FIO_OPT_STR_STORE,
2382 .off1 = td_var_offset(profile),
2383 .help = "Select a specific builtin performance test",
2384 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
2388 .type = FIO_OPT_STR_STORE,
2389 .off1 = td_var_offset(cgroup),
2390 .help = "Add job to cgroup of this name",
2391 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2394 .name = "cgroup_weight",
2395 .type = FIO_OPT_INT,
2396 .off1 = td_var_offset(cgroup_weight),
2397 .help = "Use given weight for cgroup",
2400 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2403 .name = "cgroup_nodelete",
2404 .type = FIO_OPT_BOOL,
2405 .off1 = td_var_offset(cgroup_nodelete),
2406 .help = "Do not delete cgroups after job completion",
2408 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
2412 .type = FIO_OPT_INT,
2413 .off1 = td_var_offset(uid),
2414 .help = "Run job with this user ID",
2415 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2419 .type = FIO_OPT_INT,
2420 .off1 = td_var_offset(gid),
2421 .help = "Run job with this group ID",
2422 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
2426 .type = FIO_OPT_INT,
2427 .off1 = td_var_offset(flow_id),
2428 .help = "The flow index ID to use",
2430 .category = FIO_OPT_G_IO,
2434 .type = FIO_OPT_INT,
2435 .off1 = td_var_offset(flow),
2436 .help = "Weight for flow control of this job",
2437 .parent = "flow_id",
2439 .category = FIO_OPT_G_IO,
2442 .name = "flow_watermark",
2443 .type = FIO_OPT_INT,
2444 .off1 = td_var_offset(flow_watermark),
2445 .help = "High watermark for flow control. This option"
2446 " should be set to the same value for all threads"
2447 " with non-zero flow.",
2448 .parent = "flow_id",
2450 .category = FIO_OPT_G_IO,
2453 .name = "flow_sleep",
2454 .type = FIO_OPT_INT,
2455 .off1 = td_var_offset(flow_sleep),
2456 .help = "How many microseconds to sleep after being held"
2457 " back by the flow control mechanism",
2458 .parent = "flow_id",
2460 .category = FIO_OPT_G_IO,
2467 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2468 const char *name, int val)
2470 lopt->name = (char *) name;
2472 if (o->type == FIO_OPT_STR_SET)
2473 lopt->has_arg = no_argument;
2475 lopt->has_arg = required_argument;
2478 static void options_to_lopts(struct fio_option *opts,
2479 struct option *long_options,
2480 int i, int option_type)
2482 struct fio_option *o = &opts[0];
2484 add_to_lopt(&long_options[i], o, o->name, option_type);
2487 add_to_lopt(&long_options[i], o, o->alias, option_type);
2492 assert(i < FIO_NR_OPTIONS);
2496 void fio_options_set_ioengine_opts(struct option *long_options,
2497 struct thread_data *td)
2502 while (long_options[i].name) {
2503 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2504 memset(&long_options[i], 0, sizeof(*long_options));
2511 * Just clear out the prior ioengine options.
2516 options_to_lopts(td->io_ops->options, long_options, i,
2517 FIO_GETOPT_IOENGINE);
2520 void fio_options_dup_and_init(struct option *long_options)
2524 options_init(fio_options);
2527 while (long_options[i].name)
2530 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
2533 struct fio_keyword {
2539 static struct fio_keyword fio_keywords[] = {
2541 .word = "$pagesize",
2542 .desc = "Page size in the system",
2545 .word = "$mb_memory",
2546 .desc = "Megabytes of memory online",
2550 .desc = "Number of CPUs online in the system",
2557 void fio_keywords_init(void)
2559 unsigned long long mb_memory;
2563 sprintf(buf, "%lu", page_size);
2564 fio_keywords[0].replace = strdup(buf);
2566 mb_memory = os_phys_mem() / (1024 * 1024);
2567 sprintf(buf, "%llu", mb_memory);
2568 fio_keywords[1].replace = strdup(buf);
2571 sprintf(buf, "%lu", l);
2572 fio_keywords[2].replace = strdup(buf);
2577 static char *bc_calc(char *str)
2579 char buf[128], *tmp;
2584 * No math, just return string
2586 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2587 !strchr(str, '/')) || strchr(str, '\''))
2591 * Split option from value, we only need to calculate the value
2593 tmp = strchr(str, '=');
2600 * Prevent buffer overflows; such a case isn't reasonable anyway
2602 if (strlen(str) >= 128 || strlen(tmp) > 100)
2605 sprintf(buf, "which %s > /dev/null", BC_APP);
2607 log_err("fio: bc is needed for performing math\n");
2611 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2612 f = popen(buf, "r");
2617 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2623 buf[(tmp - str) + ret - 1] = '\0';
2624 memcpy(buf, str, tmp - str);
2630 * Return a copy of the input string with substrings of the form ${VARNAME}
2631 * substituted with the value of the environment variable VARNAME. The
2632 * substitution always occurs, even if VARNAME is empty or the corresponding
2633 * environment variable undefined.
2635 static char *option_dup_subs(const char *opt)
2637 char out[OPT_LEN_MAX+1];
2638 char in[OPT_LEN_MAX+1];
2641 char *ch1, *ch2, *env;
2642 ssize_t nchr = OPT_LEN_MAX;
2645 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2646 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2650 in[OPT_LEN_MAX] = '\0';
2651 strncpy(in, opt, OPT_LEN_MAX);
2653 while (*inptr && nchr > 0) {
2654 if (inptr[0] == '$' && inptr[1] == '{') {
2655 ch2 = strchr(inptr, '}');
2656 if (ch2 && inptr+1 < ch2) {
2663 envlen = strlen(env);
2664 if (envlen <= nchr) {
2665 memcpy(outptr, env, envlen);
2675 *outptr++ = *inptr++;
2684 * Look for reserved variable names and replace them with real values
2686 static char *fio_keyword_replace(char *opt)
2692 for (i = 0; fio_keywords[i].word != NULL; i++) {
2693 struct fio_keyword *kw = &fio_keywords[i];
2695 while ((s = strstr(opt, kw->word)) != NULL) {
2696 char *new = malloc(strlen(opt) + 1);
2702 * Copy part of the string before the keyword and
2703 * sprintf() the replacement after it.
2705 memcpy(new, opt, olen);
2706 len = sprintf(new + olen, "%s", kw->replace);
2709 * If there's more in the original string, copy that
2712 opt += strlen(kw->word) + olen;
2714 memcpy(new + olen + len, opt, opt - o_org - 1);
2717 * replace opt and free the old opt
2727 * Check for potential math and invoke bc, if possible
2735 static char **dup_and_sub_options(char **opts, int num_opts)
2738 char **opts_copy = malloc(num_opts * sizeof(*opts));
2739 for (i = 0; i < num_opts; i++) {
2740 opts_copy[i] = option_dup_subs(opts[i]);
2743 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2748 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2750 int i, ret, unknown;
2753 sort_options(opts, fio_options, num_opts);
2754 opts_copy = dup_and_sub_options(opts, num_opts);
2756 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2757 struct fio_option *o;
2758 int newret = parse_option(opts_copy[i], opts[i], fio_options,
2767 opts_copy[i] = NULL;
2774 ret |= ioengine_load(td);
2776 sort_options(opts_copy, td->io_ops->options, num_opts);
2779 for (i = 0; i < num_opts; i++) {
2780 struct fio_option *o = NULL;
2786 newret = parse_option(opts_copy[i], opts[i],
2787 td->io_ops->options, &o,
2792 log_err("Bad option <%s>\n", opts[i]);
2795 opts_copy[i] = NULL;
2803 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2805 return parse_cmd_option(opt, val, fio_options, td);
2808 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2811 return parse_cmd_option(opt, val, td->io_ops->options, td);
2814 void fio_fill_default_options(struct thread_data *td)
2816 fill_default_options(td, fio_options);
2819 int fio_show_option_help(const char *opt)
2821 return show_cmd_help(fio_options, opt);
2824 void options_mem_dupe(void *data, struct fio_option *options)
2826 struct fio_option *o;
2829 for (o = &options[0]; o->name; o++) {
2830 if (o->type != FIO_OPT_STR_STORE)
2833 ptr = td_var(data, o->off1);
2835 *ptr = strdup(*ptr);
2840 * dupe FIO_OPT_STR_STORE options
2842 void fio_options_mem_dupe(struct thread_data *td)
2844 options_mem_dupe(&td->o, fio_options);
2846 if (td->eo && td->io_ops) {
2847 void *oldeo = td->eo;
2849 td->eo = malloc(td->io_ops->option_struct_size);
2850 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2851 options_mem_dupe(td->eo, td->io_ops->options);
2855 unsigned int fio_get_kb_base(void *data)
2857 struct thread_data *td = data;
2858 unsigned int kb_base = 0;
2861 kb_base = td->o.kb_base;
2868 int add_option(struct fio_option *o)
2870 struct fio_option *__o;
2879 memcpy(&fio_options[opt_index], o, sizeof(*o));
2883 void invalidate_profile_options(const char *prof_name)
2885 struct fio_option *o;
2889 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2890 o->type = FIO_OPT_INVALID;
2891 o->prof_name = NULL;
2897 void add_opt_posval(const char *optname, const char *ival, const char *help)
2899 struct fio_option *o;
2902 o = find_option(fio_options, optname);
2906 for (i = 0; i < PARSE_MAX_VP; i++) {
2907 if (o->posval[i].ival)
2910 o->posval[i].ival = ival;
2911 o->posval[i].help = help;
2916 void del_opt_posval(const char *optname, const char *ival)
2918 struct fio_option *o;
2921 o = find_option(fio_options, optname);
2925 for (i = 0; i < PARSE_MAX_VP; i++) {
2926 if (!o->posval[i].ival)
2928 if (strcmp(o->posval[i].ival, ival))
2931 o->posval[i].ival = NULL;
2932 o->posval[i].help = NULL;
2936 void fio_options_free(struct thread_data *td)
2938 options_free(fio_options, td);
2939 if (td->eo && td->io_ops && td->io_ops->options) {
2940 options_free(td->io_ops->options, td->eo);