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[] = {
851 .mask = FIO_OPT_C_GENERAL,
855 .mask = FIO_OPT_C_IO,
859 .mask = FIO_OPT_C_FILE,
862 .name = "Statistics",
863 .mask = FIO_OPT_C_STAT,
867 .mask = FIO_OPT_C_LOG,
874 static struct opt_group *__opt_group_from_mask(struct opt_group *ogs, unsigned int *mask,
875 unsigned int inv_mask)
877 struct opt_group *og;
880 if (*mask == inv_mask || !*mask)
883 for (i = 0; ogs[i].name; i++) {
886 if (*mask & og->mask) {
887 *mask &= ~(og->mask);
895 struct opt_group *opt_group_from_mask(unsigned int *mask)
897 return __opt_group_from_mask(fio_opt_groups, mask, FIO_OPT_C_INVALID);
900 static struct opt_group fio_opt_cat_groups[] = {
903 .mask = FIO_OPT_G_RATE,
907 .mask = FIO_OPT_G_ZONE,
910 .name = "Read/write mix",
911 .mask = FIO_OPT_G_RWMIX,
915 .mask = FIO_OPT_G_VERIFY,
919 .mask = FIO_OPT_G_TRIM,
922 .name = "I/O Logging",
923 .mask = FIO_OPT_G_IOLOG,
927 .mask = FIO_OPT_G_IO_DEPTH,
931 .mask = FIO_OPT_G_IO_FLOW,
938 struct opt_group *opt_group_cat_from_mask(unsigned int *mask)
940 return __opt_group_from_mask(fio_opt_cat_groups, mask, FIO_OPT_G_INVALID);
944 * Map of job/command line options
946 struct fio_option fio_options[FIO_MAX_OPTS] = {
948 .name = "description",
949 .lname = "Description of job",
950 .type = FIO_OPT_STR_STORE,
951 .off1 = td_var_offset(description),
952 .help = "Text job description",
953 .category = FIO_OPT_C_GENERAL,
954 .group = FIO_OPT_G_INVALID,
959 .type = FIO_OPT_STR_STORE,
960 .off1 = td_var_offset(name),
961 .help = "Name of this job",
962 .category = FIO_OPT_C_GENERAL,
963 .group = FIO_OPT_G_INVALID,
969 .off1 = td_var_offset(kb_base),
970 .verify = kb_base_verify,
973 .help = "How many bytes per KB for reporting (1000 or 1024)",
974 .category = FIO_OPT_C_GENERAL,
975 .group = FIO_OPT_G_INVALID,
979 .lname = "Filename(s)",
980 .type = FIO_OPT_STR_STORE,
981 .off1 = td_var_offset(filename),
982 .cb = str_filename_cb,
983 .prio = -1, /* must come after "directory" */
984 .help = "File(s) to use for the workload",
985 .category = FIO_OPT_C_FILE,
986 .group = FIO_OPT_G_INVALID,
990 .lname = "Directory",
991 .type = FIO_OPT_STR_STORE,
992 .off1 = td_var_offset(directory),
993 .cb = str_directory_cb,
994 .help = "Directory to store files in",
995 .category = FIO_OPT_C_FILE,
996 .group = FIO_OPT_G_INVALID,
1000 .lname = "Lockfile",
1001 .type = FIO_OPT_STR,
1002 .cb = str_lockfile_cb,
1003 .off1 = td_var_offset(file_lock_mode),
1004 .help = "Lock file when doing IO to it",
1005 .parent = "filename",
1008 .category = FIO_OPT_C_FILE,
1009 .group = FIO_OPT_G_INVALID,
1012 .oval = FILE_LOCK_NONE,
1013 .help = "No file locking",
1015 { .ival = "exclusive",
1016 .oval = FILE_LOCK_EXCLUSIVE,
1017 .help = "Exclusive file lock",
1020 .ival = "readwrite",
1021 .oval = FILE_LOCK_READWRITE,
1022 .help = "Read vs write lock",
1028 .lname = "Open directory",
1029 .type = FIO_OPT_STR_STORE,
1030 .off1 = td_var_offset(opendir),
1031 .cb = str_opendir_cb,
1032 .help = "Recursively add files from this directory and down",
1033 .category = FIO_OPT_C_FILE,
1034 .group = FIO_OPT_G_INVALID,
1038 .lname = "Read/write",
1039 .alias = "readwrite",
1040 .type = FIO_OPT_STR,
1042 .off1 = td_var_offset(td_ddir),
1043 .help = "IO direction",
1045 .verify = rw_verify,
1046 .category = FIO_OPT_C_IO,
1047 .group = FIO_OPT_G_INVALID,
1050 .oval = TD_DDIR_READ,
1051 .help = "Sequential read",
1054 .oval = TD_DDIR_WRITE,
1055 .help = "Sequential write",
1057 { .ival = "randread",
1058 .oval = TD_DDIR_RANDREAD,
1059 .help = "Random read",
1061 { .ival = "randwrite",
1062 .oval = TD_DDIR_RANDWRITE,
1063 .help = "Random write",
1067 .help = "Sequential read and write mix",
1070 .oval = TD_DDIR_RANDRW,
1071 .help = "Random read and write mix"
1076 .name = "rw_sequencer",
1077 .lname = "RW Sequencer",
1078 .type = FIO_OPT_STR,
1079 .off1 = td_var_offset(rw_seq),
1080 .help = "IO offset generator modifier",
1081 .def = "sequential",
1082 .category = FIO_OPT_C_IO,
1083 .group = FIO_OPT_G_INVALID,
1085 { .ival = "sequential",
1087 .help = "Generate sequential offsets",
1089 { .ival = "identical",
1090 .oval = RW_SEQ_IDENT,
1091 .help = "Generate identical offsets",
1098 .lname = "IO Engine",
1099 .type = FIO_OPT_STR_STORE,
1100 .off1 = td_var_offset(ioengine),
1101 .help = "IO engine to use",
1102 .def = FIO_PREFERRED_ENGINE,
1103 .category = FIO_OPT_C_IO,
1104 .group = FIO_OPT_G_INVALID,
1107 .help = "Use read/write",
1110 .help = "Use pread/pwrite",
1113 .help = "Use readv/writev",
1115 #ifdef FIO_HAVE_LIBAIO
1117 .help = "Linux native asynchronous IO",
1120 #ifdef FIO_HAVE_POSIXAIO
1121 { .ival = "posixaio",
1122 .help = "POSIX asynchronous IO",
1125 #ifdef FIO_HAVE_SOLARISAIO
1126 { .ival = "solarisaio",
1127 .help = "Solaris native asynchronous IO",
1130 #ifdef FIO_HAVE_WINDOWSAIO
1131 { .ival = "windowsaio",
1132 .help = "Windows native asynchronous IO"
1136 .help = "Memory mapped IO"
1138 #ifdef FIO_HAVE_SPLICE
1140 .help = "splice/vmsplice based IO",
1142 { .ival = "netsplice",
1143 .help = "splice/vmsplice to/from the network",
1146 #ifdef FIO_HAVE_SGIO
1148 .help = "SCSI generic v3 IO",
1152 .help = "Testing engine (no data transfer)",
1155 .help = "Network IO",
1157 #ifdef FIO_HAVE_SYSLET
1158 { .ival = "syslet-rw",
1159 .help = "syslet enabled async pread/pwrite IO",
1163 .help = "CPU cycle burner engine",
1165 #ifdef FIO_HAVE_GUASI
1167 .help = "GUASI IO engine",
1170 #ifdef FIO_HAVE_BINJECT
1171 { .ival = "binject",
1172 .help = "binject direct inject block engine",
1175 #ifdef FIO_HAVE_RDMA
1177 .help = "RDMA IO engine",
1180 { .ival = "external",
1181 .help = "Load external engine (append name)",
1187 .lname = "IO Depth",
1188 .type = FIO_OPT_INT,
1189 .off1 = td_var_offset(iodepth),
1190 .help = "Number of IO buffers to keep in flight",
1194 .category = FIO_OPT_C_IO,
1195 .group = FIO_OPT_G_IO_DEPTH,
1198 .name = "iodepth_batch",
1199 .lname = "IO Depth batch",
1200 .alias = "iodepth_batch_submit",
1201 .type = FIO_OPT_INT,
1202 .off1 = td_var_offset(iodepth_batch),
1203 .help = "Number of IO buffers to submit in one go",
1204 .parent = "iodepth",
1209 .category = FIO_OPT_C_IO,
1210 .group = FIO_OPT_G_IO_DEPTH,
1213 .name = "iodepth_batch_complete",
1214 .lname = "IO Depth batch complete",
1215 .type = FIO_OPT_INT,
1216 .off1 = td_var_offset(iodepth_batch_complete),
1217 .help = "Number of IO buffers to retrieve in one go",
1218 .parent = "iodepth",
1223 .category = FIO_OPT_C_IO,
1224 .group = FIO_OPT_G_IO_DEPTH,
1227 .name = "iodepth_low",
1228 .lname = "IO Depth batch low",
1229 .type = FIO_OPT_INT,
1230 .off1 = td_var_offset(iodepth_low),
1231 .help = "Low water mark for queuing depth",
1232 .parent = "iodepth",
1235 .category = FIO_OPT_C_IO,
1236 .group = FIO_OPT_G_IO_DEPTH,
1241 .type = FIO_OPT_STR_VAL,
1243 .help = "Total size of device or files",
1244 .interval = 1024 * 1024,
1245 .category = FIO_OPT_C_IO,
1246 .group = FIO_OPT_G_INVALID,
1249 .name = "fill_device",
1250 .lname = "Fill device",
1252 .type = FIO_OPT_BOOL,
1253 .off1 = td_var_offset(fill_device),
1254 .help = "Write until an ENOSPC error occurs",
1256 .category = FIO_OPT_C_FILE,
1257 .group = FIO_OPT_G_INVALID,
1261 .lname = "File size",
1262 .type = FIO_OPT_STR_VAL,
1263 .off1 = td_var_offset(file_size_low),
1264 .off2 = td_var_offset(file_size_high),
1266 .help = "Size of individual files",
1267 .interval = 1024 * 1024,
1268 .category = FIO_OPT_C_FILE,
1269 .group = FIO_OPT_G_INVALID,
1273 .lname = "IO offset",
1274 .alias = "fileoffset",
1275 .type = FIO_OPT_STR_VAL,
1276 .off1 = td_var_offset(start_offset),
1277 .help = "Start IO from this offset",
1279 .interval = 1024 * 1024,
1280 .category = FIO_OPT_C_IO,
1281 .group = FIO_OPT_G_INVALID,
1284 .name = "offset_increment",
1285 .lname = "IO offset increment",
1286 .type = FIO_OPT_STR_VAL,
1287 .off1 = td_var_offset(offset_increment),
1288 .help = "What is the increment from one offset to the next",
1292 .interval = 1024 * 1024,
1293 .category = FIO_OPT_C_IO,
1294 .group = FIO_OPT_G_INVALID,
1298 .lname = "Block size",
1299 .alias = "blocksize",
1300 .type = FIO_OPT_INT,
1301 .off1 = td_var_offset(bs[DDIR_READ]),
1302 .off2 = td_var_offset(bs[DDIR_WRITE]),
1304 .help = "Block size unit",
1309 .category = FIO_OPT_C_IO,
1310 .group = FIO_OPT_G_INVALID,
1314 .lname = "Block size align",
1315 .alias = "blockalign",
1316 .type = FIO_OPT_INT,
1317 .off1 = td_var_offset(ba[DDIR_READ]),
1318 .off2 = td_var_offset(ba[DDIR_WRITE]),
1320 .help = "IO block offset alignment",
1324 .category = FIO_OPT_C_IO,
1325 .group = FIO_OPT_G_INVALID,
1329 .lname = "Block size range",
1330 .alias = "blocksize_range",
1331 .type = FIO_OPT_RANGE,
1332 .off1 = td_var_offset(min_bs[DDIR_READ]),
1333 .off2 = td_var_offset(max_bs[DDIR_READ]),
1334 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1335 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1337 .help = "Set block size range (in more detail than bs)",
1341 .category = FIO_OPT_C_IO,
1342 .group = FIO_OPT_G_INVALID,
1346 .lname = "Block size split",
1347 .type = FIO_OPT_STR,
1348 .cb = str_bssplit_cb,
1349 .help = "Set a specific mix of block sizes",
1352 .category = FIO_OPT_C_IO,
1353 .group = FIO_OPT_G_INVALID,
1356 .name = "bs_unaligned",
1357 .lname = "Block size unaligned",
1358 .alias = "blocksize_unaligned",
1359 .type = FIO_OPT_STR_SET,
1360 .off1 = td_var_offset(bs_unaligned),
1361 .help = "Don't sector align IO buffer sizes",
1364 .category = FIO_OPT_C_IO,
1365 .group = FIO_OPT_G_INVALID,
1368 .name = "randrepeat",
1369 .lname = "Random repeatable",
1370 .type = FIO_OPT_BOOL,
1371 .off1 = td_var_offset(rand_repeatable),
1372 .help = "Use repeatable random IO pattern",
1376 .category = FIO_OPT_C_IO,
1377 .group = FIO_OPT_G_INVALID,
1380 .name = "use_os_rand",
1381 .lname = "Use OS random",
1382 .type = FIO_OPT_BOOL,
1383 .off1 = td_var_offset(use_os_rand),
1384 .help = "Set to use OS random generator",
1388 .category = FIO_OPT_C_IO,
1389 .group = FIO_OPT_G_INVALID,
1392 .name = "norandommap",
1393 .lname = "No randommap",
1394 .type = FIO_OPT_STR_SET,
1395 .off1 = td_var_offset(norandommap),
1396 .help = "Accept potential duplicate random blocks",
1399 .category = FIO_OPT_C_IO,
1400 .group = FIO_OPT_G_INVALID,
1403 .name = "softrandommap",
1404 .lname = "Soft randommap",
1405 .type = FIO_OPT_BOOL,
1406 .off1 = td_var_offset(softrandommap),
1407 .help = "Set norandommap if randommap allocation fails",
1408 .parent = "norandommap",
1411 .category = FIO_OPT_C_IO,
1412 .group = FIO_OPT_G_INVALID,
1416 .lname = "Number of files",
1417 .alias = "nr_files",
1418 .type = FIO_OPT_INT,
1419 .off1 = td_var_offset(nr_files),
1420 .help = "Split job workload between this number of files",
1423 .category = FIO_OPT_C_FILE,
1424 .group = FIO_OPT_G_INVALID,
1427 .name = "openfiles",
1428 .lname = "Number of open files",
1429 .type = FIO_OPT_INT,
1430 .off1 = td_var_offset(open_files),
1431 .help = "Number of files to keep open at the same time",
1432 .category = FIO_OPT_C_FILE,
1433 .group = FIO_OPT_G_INVALID,
1436 .name = "file_service_type",
1437 .lname = "File service type",
1438 .type = FIO_OPT_STR,
1440 .off1 = td_var_offset(file_service_type),
1441 .help = "How to select which file to service next",
1442 .def = "roundrobin",
1443 .category = FIO_OPT_C_FILE,
1444 .group = FIO_OPT_G_INVALID,
1447 .oval = FIO_FSERVICE_RANDOM,
1448 .help = "Choose a file at random",
1450 { .ival = "roundrobin",
1451 .oval = FIO_FSERVICE_RR,
1452 .help = "Round robin select files",
1454 { .ival = "sequential",
1455 .oval = FIO_FSERVICE_SEQ,
1456 .help = "Finish one file before moving to the next",
1459 .parent = "nrfiles",
1462 #ifdef FIO_HAVE_FALLOCATE
1464 .name = "fallocate",
1465 .lname = "Fallocate",
1466 .type = FIO_OPT_STR,
1467 .off1 = td_var_offset(fallocate_mode),
1468 .help = "Whether pre-allocation is performed when laying out files",
1470 .category = FIO_OPT_C_FILE,
1471 .group = FIO_OPT_G_INVALID,
1474 .oval = FIO_FALLOCATE_NONE,
1475 .help = "Do not pre-allocate space",
1478 .oval = FIO_FALLOCATE_POSIX,
1479 .help = "Use posix_fallocate()",
1481 #ifdef FIO_HAVE_LINUX_FALLOCATE
1483 .oval = FIO_FALLOCATE_KEEP_SIZE,
1484 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1487 /* Compatibility with former boolean values */
1489 .oval = FIO_FALLOCATE_NONE,
1490 .help = "Alias for 'none'",
1493 .oval = FIO_FALLOCATE_POSIX,
1494 .help = "Alias for 'posix'",
1498 #endif /* FIO_HAVE_FALLOCATE */
1500 .name = "fadvise_hint",
1501 .lname = "Fadvise hint",
1502 .type = FIO_OPT_BOOL,
1503 .off1 = td_var_offset(fadvise_hint),
1504 .help = "Use fadvise() to advise the kernel on IO pattern",
1506 .category = FIO_OPT_C_FILE,
1507 .group = FIO_OPT_G_INVALID,
1512 .type = FIO_OPT_INT,
1513 .off1 = td_var_offset(fsync_blocks),
1514 .help = "Issue fsync for writes every given number of blocks",
1517 .category = FIO_OPT_C_FILE,
1518 .group = FIO_OPT_G_INVALID,
1521 .name = "fdatasync",
1522 .lname = "Fdatasync",
1523 .type = FIO_OPT_INT,
1524 .off1 = td_var_offset(fdatasync_blocks),
1525 .help = "Issue fdatasync for writes every given number of blocks",
1528 .category = FIO_OPT_C_FILE,
1529 .group = FIO_OPT_G_INVALID,
1532 .name = "write_barrier",
1533 .lname = "Write barrier",
1534 .type = FIO_OPT_INT,
1535 .off1 = td_var_offset(barrier_blocks),
1536 .help = "Make every Nth write a barrier write",
1539 .category = FIO_OPT_C_IO,
1540 .group = FIO_OPT_G_INVALID,
1542 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1544 .name = "sync_file_range",
1545 .lname = "Sync file range",
1547 { .ival = "wait_before",
1548 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1549 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1553 .oval = SYNC_FILE_RANGE_WRITE,
1554 .help = "SYNC_FILE_RANGE_WRITE",
1558 .ival = "wait_after",
1559 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1560 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1564 .type = FIO_OPT_STR_MULTI,
1566 .off1 = td_var_offset(sync_file_range),
1567 .help = "Use sync_file_range()",
1568 .category = FIO_OPT_C_FILE,
1569 .group = FIO_OPT_G_INVALID,
1574 .lname = "Direct I/O",
1575 .type = FIO_OPT_BOOL,
1576 .off1 = td_var_offset(odirect),
1577 .help = "Use O_DIRECT IO (negates buffered)",
1579 .category = FIO_OPT_C_IO,
1580 .group = FIO_OPT_G_INVALID,
1584 .lname = "Buffered I/O",
1585 .type = FIO_OPT_BOOL,
1586 .off1 = td_var_offset(odirect),
1588 .help = "Use buffered IO (negates direct)",
1590 .category = FIO_OPT_C_IO,
1591 .group = FIO_OPT_G_INVALID,
1594 .name = "overwrite",
1595 .lname = "Overwrite",
1596 .type = FIO_OPT_BOOL,
1597 .off1 = td_var_offset(overwrite),
1598 .help = "When writing, set whether to overwrite current data",
1600 .category = FIO_OPT_C_FILE,
1601 .group = FIO_OPT_G_INVALID,
1606 .type = FIO_OPT_INT,
1607 .off1 = td_var_offset(loops),
1608 .help = "Number of times to run the job",
1611 .category = FIO_OPT_C_GENERAL,
1612 .group = FIO_OPT_G_INVALID,
1616 .lname = "Number of jobs",
1617 .type = FIO_OPT_INT,
1618 .off1 = td_var_offset(numjobs),
1619 .help = "Duplicate this job this many times",
1622 .category = FIO_OPT_C_GENERAL,
1623 .group = FIO_OPT_G_INVALID,
1626 .name = "startdelay",
1627 .lname = "Start delay",
1628 .type = FIO_OPT_STR_VAL_TIME,
1629 .off1 = td_var_offset(start_delay),
1630 .help = "Only start job when this period has passed",
1632 .category = FIO_OPT_C_GENERAL,
1633 .group = FIO_OPT_G_INVALID,
1639 .type = FIO_OPT_STR_VAL_TIME,
1640 .off1 = td_var_offset(timeout),
1641 .help = "Stop workload when this amount of time has passed",
1643 .category = FIO_OPT_C_GENERAL,
1644 .group = FIO_OPT_G_INVALID,
1647 .name = "time_based",
1648 .lname = "Time based",
1649 .type = FIO_OPT_STR_SET,
1650 .off1 = td_var_offset(time_based),
1651 .help = "Keep running until runtime/timeout is met",
1652 .category = FIO_OPT_C_GENERAL,
1653 .group = FIO_OPT_G_INVALID,
1656 .name = "ramp_time",
1657 .lname = "Ramp time",
1658 .type = FIO_OPT_STR_VAL_TIME,
1659 .off1 = td_var_offset(ramp_time),
1660 .help = "Ramp up time before measuring performance",
1661 .category = FIO_OPT_C_GENERAL,
1662 .group = FIO_OPT_G_INVALID,
1665 .name = "clocksource",
1666 .lname = "Clock source",
1667 .type = FIO_OPT_STR,
1668 .cb = fio_clock_source_cb,
1669 .off1 = td_var_offset(clocksource),
1670 .help = "What type of timing source to use",
1671 .category = FIO_OPT_C_GENERAL,
1672 .group = FIO_OPT_G_INVALID,
1674 { .ival = "gettimeofday",
1676 .help = "Use gettimeofday(2) for timing",
1678 { .ival = "clock_gettime",
1679 .oval = CS_CGETTIME,
1680 .help = "Use clock_gettime(2) for timing",
1682 #ifdef ARCH_HAVE_CPU_CLOCK
1684 .oval = CS_CPUCLOCK,
1685 .help = "Use CPU private clock",
1693 .lname = "I/O Memory",
1694 .type = FIO_OPT_STR,
1696 .off1 = td_var_offset(mem_type),
1697 .help = "Backing type for IO buffers",
1699 .category = FIO_OPT_C_IO,
1700 .group = FIO_OPT_G_INVALID,
1704 .help = "Use malloc(3) for IO buffers",
1708 .help = "Use shared memory segments for IO buffers",
1710 #ifdef FIO_HAVE_HUGETLB
1711 { .ival = "shmhuge",
1712 .oval = MEM_SHMHUGE,
1713 .help = "Like shm, but use huge pages",
1718 .help = "Use mmap(2) (file or anon) for IO buffers",
1720 #ifdef FIO_HAVE_HUGETLB
1721 { .ival = "mmaphuge",
1722 .oval = MEM_MMAPHUGE,
1723 .help = "Like mmap, but use huge pages",
1729 .name = "iomem_align",
1730 .alias = "mem_align",
1731 .lname = "I/O memory alignment",
1732 .type = FIO_OPT_INT,
1733 .off1 = td_var_offset(mem_align),
1735 .help = "IO memory buffer offset alignment",
1739 .category = FIO_OPT_C_IO,
1740 .group = FIO_OPT_G_INVALID,
1745 .type = FIO_OPT_STR,
1746 .off1 = td_var_offset(verify),
1747 .help = "Verify data written",
1748 .cb = str_verify_cb,
1750 .category = FIO_OPT_C_IO,
1751 .group = FIO_OPT_G_INVALID,
1754 .oval = VERIFY_NONE,
1755 .help = "Don't do IO verification",
1759 .help = "Use md5 checksums for verification",
1762 .oval = VERIFY_CRC64,
1763 .help = "Use crc64 checksums for verification",
1766 .oval = VERIFY_CRC32,
1767 .help = "Use crc32 checksums for verification",
1769 { .ival = "crc32c-intel",
1770 .oval = VERIFY_CRC32C,
1771 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1774 .oval = VERIFY_CRC32C,
1775 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1778 .oval = VERIFY_CRC16,
1779 .help = "Use crc16 checksums for verification",
1782 .oval = VERIFY_CRC7,
1783 .help = "Use crc7 checksums for verification",
1786 .oval = VERIFY_SHA1,
1787 .help = "Use sha1 checksums for verification",
1790 .oval = VERIFY_SHA256,
1791 .help = "Use sha256 checksums for verification",
1794 .oval = VERIFY_SHA512,
1795 .help = "Use sha512 checksums for verification",
1798 .oval = VERIFY_META,
1799 .help = "Use io information",
1803 .oval = VERIFY_NULL,
1804 .help = "Pretend to verify",
1809 .name = "do_verify",
1810 .lname = "Perform verify step",
1811 .type = FIO_OPT_BOOL,
1812 .off1 = td_var_offset(do_verify),
1813 .help = "Run verification stage after write",
1817 .category = FIO_OPT_C_IO,
1818 .group = FIO_OPT_G_VERIFY,
1821 .name = "verifysort",
1822 .lname = "Verify sort",
1823 .type = FIO_OPT_BOOL,
1824 .off1 = td_var_offset(verifysort),
1825 .help = "Sort written verify blocks for read back",
1829 .category = FIO_OPT_C_IO,
1830 .group = FIO_OPT_G_VERIFY,
1833 .name = "verify_interval",
1834 .lname = "Verify interval",
1835 .type = FIO_OPT_INT,
1836 .off1 = td_var_offset(verify_interval),
1837 .minval = 2 * sizeof(struct verify_header),
1838 .help = "Store verify buffer header every N bytes",
1841 .interval = 2 * sizeof(struct verify_header),
1842 .category = FIO_OPT_C_IO,
1843 .group = FIO_OPT_G_VERIFY,
1846 .name = "verify_offset",
1847 .lname = "Verify offset",
1848 .type = FIO_OPT_INT,
1849 .help = "Offset verify header location by N bytes",
1851 .cb = str_verify_offset_cb,
1854 .category = FIO_OPT_C_IO,
1855 .group = FIO_OPT_G_VERIFY,
1858 .name = "verify_pattern",
1859 .lname = "Verify pattern",
1860 .type = FIO_OPT_STR,
1861 .cb = str_verify_pattern_cb,
1862 .help = "Fill pattern for IO buffers",
1865 .category = FIO_OPT_C_IO,
1866 .group = FIO_OPT_G_VERIFY,
1869 .name = "verify_fatal",
1870 .lname = "Verify fatal",
1871 .type = FIO_OPT_BOOL,
1872 .off1 = td_var_offset(verify_fatal),
1874 .help = "Exit on a single verify failure, don't continue",
1877 .category = FIO_OPT_C_IO,
1878 .group = FIO_OPT_G_VERIFY,
1881 .name = "verify_dump",
1882 .lname = "Verify dump",
1883 .type = FIO_OPT_BOOL,
1884 .off1 = td_var_offset(verify_dump),
1886 .help = "Dump contents of good and bad blocks on failure",
1889 .category = FIO_OPT_C_IO,
1890 .group = FIO_OPT_G_VERIFY,
1893 .name = "verify_async",
1894 .lname = "Verify asynchronously",
1895 .type = FIO_OPT_INT,
1896 .off1 = td_var_offset(verify_async),
1898 .help = "Number of async verifier threads to use",
1901 .category = FIO_OPT_C_IO,
1902 .group = FIO_OPT_G_VERIFY,
1905 .name = "verify_backlog",
1906 .lname = "Verify backlog",
1907 .type = FIO_OPT_STR_VAL,
1908 .off1 = td_var_offset(verify_backlog),
1909 .help = "Verify after this number of blocks are written",
1912 .category = FIO_OPT_C_IO,
1913 .group = FIO_OPT_G_VERIFY,
1916 .name = "verify_backlog_batch",
1917 .lname = "Verify backlog batch",
1918 .type = FIO_OPT_INT,
1919 .off1 = td_var_offset(verify_batch),
1920 .help = "Verify this number of IO blocks",
1923 .category = FIO_OPT_C_IO,
1924 .group = FIO_OPT_G_VERIFY,
1926 #ifdef FIO_HAVE_CPU_AFFINITY
1928 .name = "verify_async_cpus",
1929 .lname = "Async verify CPUs",
1930 .type = FIO_OPT_STR,
1931 .cb = str_verify_cpus_allowed_cb,
1932 .help = "Set CPUs allowed for async verify threads",
1933 .parent = "verify_async",
1935 .category = FIO_OPT_C_IO,
1936 .group = FIO_OPT_G_VERIFY,
1939 #ifdef FIO_HAVE_TRIM
1941 .name = "trim_percentage",
1942 .lname = "Trim percentage",
1943 .type = FIO_OPT_INT,
1944 .cb = str_verify_trim_cb,
1947 .help = "Number of verify blocks to discard/trim",
1952 .category = FIO_OPT_C_IO,
1953 .group = FIO_OPT_G_TRIM,
1956 .name = "trim_verify_zero",
1957 .lname = "Verify trim zero",
1958 .type = FIO_OPT_BOOL,
1959 .help = "Verify that trim/discarded blocks are returned as zeroes",
1960 .off1 = td_var_offset(trim_zero),
1961 .parent = "trim_percentage",
1964 .category = FIO_OPT_C_IO,
1965 .group = FIO_OPT_G_TRIM,
1968 .name = "trim_backlog",
1969 .lname = "Trim backlog",
1970 .type = FIO_OPT_STR_VAL,
1971 .off1 = td_var_offset(trim_backlog),
1972 .help = "Trim after this number of blocks are written",
1973 .parent = "trim_percentage",
1976 .category = FIO_OPT_C_IO,
1977 .group = FIO_OPT_G_TRIM,
1980 .name = "trim_backlog_batch",
1981 .lname = "Trim backlog batch",
1982 .type = FIO_OPT_INT,
1983 .off1 = td_var_offset(trim_batch),
1984 .help = "Trim this number of IO blocks",
1985 .parent = "trim_percentage",
1988 .category = FIO_OPT_C_IO,
1989 .group = FIO_OPT_G_TRIM,
1993 .name = "write_iolog",
1994 .lname = "Write I/O log",
1995 .type = FIO_OPT_STR_STORE,
1996 .off1 = td_var_offset(write_iolog_file),
1997 .help = "Store IO pattern to file",
1998 .category = FIO_OPT_C_IO,
1999 .group = FIO_OPT_G_IOLOG,
2002 .name = "read_iolog",
2003 .lname = "Read I/O log",
2004 .type = FIO_OPT_STR_STORE,
2005 .off1 = td_var_offset(read_iolog_file),
2006 .help = "Playback IO pattern from file",
2007 .category = FIO_OPT_C_IO,
2008 .group = FIO_OPT_G_IOLOG,
2011 .name = "replay_no_stall",
2012 .lname = "Don't stall on replay",
2013 .type = FIO_OPT_BOOL,
2014 .off1 = td_var_offset(no_stall),
2016 .parent = "read_iolog",
2018 .help = "Playback IO pattern file as fast as possible without stalls",
2019 .category = FIO_OPT_C_IO,
2020 .group = FIO_OPT_G_IOLOG,
2023 .name = "replay_redirect",
2024 .lname = "Redirect device for replay",
2025 .type = FIO_OPT_STR_STORE,
2026 .off1 = td_var_offset(replay_redirect),
2027 .parent = "read_iolog",
2029 .help = "Replay all I/O onto this device, regardless of trace device",
2030 .category = FIO_OPT_C_IO,
2031 .group = FIO_OPT_G_IOLOG,
2034 .name = "exec_prerun",
2035 .lname = "Pre-execute runnable",
2036 .type = FIO_OPT_STR_STORE,
2037 .off1 = td_var_offset(exec_prerun),
2038 .help = "Execute this file prior to running job",
2039 .category = FIO_OPT_C_GENERAL,
2040 .group = FIO_OPT_G_INVALID,
2043 .name = "exec_postrun",
2044 .lname = "Post-execute runnable",
2045 .type = FIO_OPT_STR_STORE,
2046 .off1 = td_var_offset(exec_postrun),
2047 .help = "Execute this file after running job",
2048 .category = FIO_OPT_C_GENERAL,
2049 .group = FIO_OPT_G_INVALID,
2051 #ifdef FIO_HAVE_IOSCHED_SWITCH
2053 .name = "ioscheduler",
2054 .lname = "I/O scheduler",
2055 .type = FIO_OPT_STR_STORE,
2056 .off1 = td_var_offset(ioscheduler),
2057 .help = "Use this IO scheduler on the backing device",
2058 .category = FIO_OPT_C_FILE,
2059 .group = FIO_OPT_G_INVALID,
2064 .lname = "Zone size",
2065 .type = FIO_OPT_STR_VAL,
2066 .off1 = td_var_offset(zone_size),
2067 .help = "Amount of data to read per zone",
2069 .interval = 1024 * 1024,
2070 .category = FIO_OPT_C_IO,
2071 .group = FIO_OPT_G_ZONE,
2074 .name = "zonerange",
2075 .lname = "Zone range",
2076 .type = FIO_OPT_STR_VAL,
2077 .off1 = td_var_offset(zone_range),
2078 .help = "Give size of an IO zone",
2080 .interval = 1024 * 1024,
2081 .category = FIO_OPT_C_IO,
2082 .group = FIO_OPT_G_ZONE,
2086 .lname = "Zone skip",
2087 .type = FIO_OPT_STR_VAL,
2088 .off1 = td_var_offset(zone_skip),
2089 .help = "Space between IO zones",
2091 .interval = 1024 * 1024,
2092 .category = FIO_OPT_C_IO,
2093 .group = FIO_OPT_G_ZONE,
2097 .lname = "Lock memory",
2098 .type = FIO_OPT_STR_VAL,
2099 .cb = str_lockmem_cb,
2100 .help = "Lock down this amount of memory",
2102 .interval = 1024 * 1024,
2103 .category = FIO_OPT_C_GENERAL,
2104 .group = FIO_OPT_G_INVALID,
2107 .name = "rwmixread",
2108 .lname = "Read/write mix read",
2109 .type = FIO_OPT_INT,
2110 .cb = str_rwmix_read_cb,
2112 .help = "Percentage of mixed workload that is reads",
2115 .category = FIO_OPT_C_IO,
2116 .group = FIO_OPT_G_RWMIX,
2119 .name = "rwmixwrite",
2120 .lname = "Read/write mix write",
2121 .type = FIO_OPT_INT,
2122 .cb = str_rwmix_write_cb,
2124 .help = "Percentage of mixed workload that is writes",
2127 .category = FIO_OPT_C_IO,
2128 .group = FIO_OPT_G_RWMIX,
2131 .name = "rwmixcycle",
2132 .lname = "Read/write mix cycle",
2133 .type = FIO_OPT_DEPRECATED,
2134 .category = FIO_OPT_C_IO,
2135 .group = FIO_OPT_G_RWMIX,
2140 .type = FIO_OPT_INT,
2141 .off1 = td_var_offset(nice),
2142 .help = "Set job CPU nice value",
2147 .category = FIO_OPT_C_GENERAL,
2148 .group = FIO_OPT_G_INVALID,
2150 #ifdef FIO_HAVE_IOPRIO
2153 .lname = "I/O nice priority",
2154 .type = FIO_OPT_INT,
2156 .help = "Set job IO priority value",
2160 .category = FIO_OPT_C_GENERAL,
2161 .group = FIO_OPT_G_INVALID,
2164 .name = "prioclass",
2165 .lname = "I/O nice priority class",
2166 .type = FIO_OPT_INT,
2167 .cb = str_prioclass_cb,
2168 .help = "Set job IO priority class",
2172 .category = FIO_OPT_C_GENERAL,
2173 .group = FIO_OPT_G_INVALID,
2177 .name = "thinktime",
2178 .lname = "Thinktime",
2179 .type = FIO_OPT_INT,
2180 .off1 = td_var_offset(thinktime),
2181 .help = "Idle time between IO buffers (usec)",
2183 .category = FIO_OPT_C_IO,
2184 .group = FIO_OPT_G_INVALID,
2187 .name = "thinktime_spin",
2188 .lname = "Thinktime spin",
2189 .type = FIO_OPT_INT,
2190 .off1 = td_var_offset(thinktime_spin),
2191 .help = "Start think time by spinning this amount (usec)",
2193 .parent = "thinktime",
2195 .category = FIO_OPT_C_IO,
2196 .group = FIO_OPT_G_INVALID,
2199 .name = "thinktime_blocks",
2200 .lname = "Thinktime blocks",
2201 .type = FIO_OPT_INT,
2202 .off1 = td_var_offset(thinktime_blocks),
2203 .help = "IO buffer period between 'thinktime'",
2205 .parent = "thinktime",
2207 .category = FIO_OPT_C_IO,
2208 .group = FIO_OPT_G_INVALID,
2212 .lname = "I/O rate",
2213 .type = FIO_OPT_INT,
2214 .off1 = td_var_offset(rate[0]),
2215 .off2 = td_var_offset(rate[1]),
2216 .help = "Set bandwidth rate",
2217 .category = FIO_OPT_C_IO,
2218 .group = FIO_OPT_G_RATE,
2222 .lname = "I/O min rate",
2223 .type = FIO_OPT_INT,
2224 .off1 = td_var_offset(ratemin[0]),
2225 .off2 = td_var_offset(ratemin[1]),
2226 .help = "Job must meet this rate or it will be shutdown",
2229 .category = FIO_OPT_C_IO,
2230 .group = FIO_OPT_G_RATE,
2233 .name = "rate_iops",
2234 .lname = "I/O rate IOPS",
2235 .type = FIO_OPT_INT,
2236 .off1 = td_var_offset(rate_iops[0]),
2237 .off2 = td_var_offset(rate_iops[1]),
2238 .help = "Limit IO used to this number of IO operations/sec",
2240 .category = FIO_OPT_C_IO,
2241 .group = FIO_OPT_G_RATE,
2244 .name = "rate_iops_min",
2245 .lname = "I/O min rate IOPS",
2246 .type = FIO_OPT_INT,
2247 .off1 = td_var_offset(rate_iops_min[0]),
2248 .off2 = td_var_offset(rate_iops_min[1]),
2249 .help = "Job must meet this rate or it will be shut down",
2250 .parent = "rate_iops",
2252 .category = FIO_OPT_C_IO,
2253 .group = FIO_OPT_G_RATE,
2256 .name = "ratecycle",
2257 .lname = "I/O rate cycle",
2258 .type = FIO_OPT_INT,
2259 .off1 = td_var_offset(ratecycle),
2260 .help = "Window average for rate limits (msec)",
2264 .category = FIO_OPT_C_IO,
2265 .group = FIO_OPT_G_RATE,
2268 .name = "invalidate",
2269 .lname = "Cache invalidate",
2270 .type = FIO_OPT_BOOL,
2271 .off1 = td_var_offset(invalidate_cache),
2272 .help = "Invalidate buffer/page cache prior to running job",
2274 .category = FIO_OPT_C_IO,
2275 .group = FIO_OPT_G_INVALID,
2279 .lname = "Synchronous I/O",
2280 .type = FIO_OPT_BOOL,
2281 .off1 = td_var_offset(sync_io),
2282 .help = "Use O_SYNC for buffered writes",
2284 .parent = "buffered",
2286 .category = FIO_OPT_C_IO,
2287 .group = FIO_OPT_G_INVALID,
2290 .name = "bwavgtime",
2291 .lname = "Bandwidth average time",
2292 .type = FIO_OPT_INT,
2293 .off1 = td_var_offset(bw_avg_time),
2294 .help = "Time window over which to calculate bandwidth"
2297 .parent = "write_bw_log",
2300 .category = FIO_OPT_C_LOG,
2301 .group = FIO_OPT_G_INVALID,
2304 .name = "iopsavgtime",
2305 .lname = "IOPS average time",
2306 .type = FIO_OPT_INT,
2307 .off1 = td_var_offset(iops_avg_time),
2308 .help = "Time window over which to calculate IOPS (msec)",
2310 .parent = "write_iops_log",
2313 .category = FIO_OPT_C_LOG,
2314 .group = FIO_OPT_G_INVALID,
2317 .name = "create_serialize",
2318 .lname = "Create serialize",
2319 .type = FIO_OPT_BOOL,
2320 .off1 = td_var_offset(create_serialize),
2321 .help = "Serialize creating of job files",
2323 .category = FIO_OPT_C_FILE,
2324 .group = FIO_OPT_G_INVALID,
2327 .name = "create_fsync",
2328 .lname = "Create fsync",
2329 .type = FIO_OPT_BOOL,
2330 .off1 = td_var_offset(create_fsync),
2331 .help = "fsync file after creation",
2333 .category = FIO_OPT_C_FILE,
2334 .group = FIO_OPT_G_INVALID,
2337 .name = "create_on_open",
2338 .lname = "Create on open",
2339 .type = FIO_OPT_BOOL,
2340 .off1 = td_var_offset(create_on_open),
2341 .help = "Create files when they are opened for IO",
2343 .category = FIO_OPT_C_FILE,
2344 .group = FIO_OPT_G_INVALID,
2348 .lname = "Pre-read files",
2349 .type = FIO_OPT_BOOL,
2350 .off1 = td_var_offset(pre_read),
2351 .help = "Pre-read files before starting official testing",
2353 .category = FIO_OPT_C_FILE,
2354 .group = FIO_OPT_G_INVALID,
2358 .lname = "CPU load",
2359 .type = FIO_OPT_INT,
2360 .off1 = td_var_offset(cpuload),
2361 .help = "Use this percentage of CPU",
2362 .category = FIO_OPT_C_GENERAL,
2363 .group = FIO_OPT_G_INVALID,
2366 .name = "cpuchunks",
2367 .lname = "CPU chunk",
2368 .type = FIO_OPT_INT,
2369 .off1 = td_var_offset(cpucycle),
2370 .help = "Length of the CPU burn cycles (usecs)",
2372 .parent = "cpuload",
2374 .category = FIO_OPT_C_GENERAL,
2375 .group = FIO_OPT_G_INVALID,
2377 #ifdef FIO_HAVE_CPU_AFFINITY
2380 .lname = "CPU mask",
2381 .type = FIO_OPT_INT,
2382 .cb = str_cpumask_cb,
2383 .help = "CPU affinity mask",
2384 .category = FIO_OPT_C_GENERAL,
2385 .group = FIO_OPT_G_INVALID,
2388 .name = "cpus_allowed",
2389 .lname = "CPUs allowed",
2390 .type = FIO_OPT_STR,
2391 .cb = str_cpus_allowed_cb,
2392 .help = "Set CPUs allowed",
2393 .category = FIO_OPT_C_GENERAL,
2394 .group = FIO_OPT_G_INVALID,
2398 .name = "end_fsync",
2399 .lname = "End fsync",
2400 .type = FIO_OPT_BOOL,
2401 .off1 = td_var_offset(end_fsync),
2402 .help = "Include fsync at the end of job",
2404 .category = FIO_OPT_C_FILE,
2405 .group = FIO_OPT_G_INVALID,
2408 .name = "fsync_on_close",
2409 .lname = "Fsync on close",
2410 .type = FIO_OPT_BOOL,
2411 .off1 = td_var_offset(fsync_on_close),
2412 .help = "fsync files on close",
2414 .category = FIO_OPT_C_FILE,
2415 .group = FIO_OPT_G_INVALID,
2419 .lname = "Unlink file",
2420 .type = FIO_OPT_BOOL,
2421 .off1 = td_var_offset(unlink),
2422 .help = "Unlink created files after job has completed",
2424 .category = FIO_OPT_C_FILE,
2425 .group = FIO_OPT_G_INVALID,
2429 .lname = "Exit-all on terminate",
2430 .type = FIO_OPT_STR_SET,
2431 .cb = str_exitall_cb,
2432 .help = "Terminate all jobs when one exits",
2433 .category = FIO_OPT_C_GENERAL,
2434 .group = FIO_OPT_G_INVALID,
2437 .name = "stonewall",
2438 .lname = "Wait for previous",
2439 .alias = "wait_for_previous",
2440 .type = FIO_OPT_STR_SET,
2441 .off1 = td_var_offset(stonewall),
2442 .help = "Insert a hard barrier between this job and previous",
2443 .category = FIO_OPT_C_GENERAL,
2444 .group = FIO_OPT_G_INVALID,
2447 .name = "new_group",
2448 .lname = "New group",
2449 .type = FIO_OPT_STR_SET,
2450 .off1 = td_var_offset(new_group),
2451 .help = "Mark the start of a new group (for reporting)",
2452 .category = FIO_OPT_C_GENERAL,
2453 .group = FIO_OPT_G_INVALID,
2458 .type = FIO_OPT_STR_SET,
2459 .off1 = td_var_offset(use_thread),
2460 .help = "Use threads instead of processes",
2461 .category = FIO_OPT_C_GENERAL,
2462 .group = FIO_OPT_G_INVALID,
2465 .name = "write_bw_log",
2466 .lname = "Write bandwidth log",
2467 .type = FIO_OPT_STR,
2468 .off1 = td_var_offset(write_bw_log),
2469 .cb = str_write_bw_log_cb,
2470 .help = "Write log of bandwidth during run",
2471 .category = FIO_OPT_C_LOG,
2472 .group = FIO_OPT_G_INVALID,
2475 .name = "write_lat_log",
2476 .lname = "Write latency log",
2477 .type = FIO_OPT_STR,
2478 .off1 = td_var_offset(write_lat_log),
2479 .cb = str_write_lat_log_cb,
2480 .help = "Write log of latency during run",
2481 .category = FIO_OPT_C_LOG,
2482 .group = FIO_OPT_G_INVALID,
2485 .name = "write_iops_log",
2486 .lname = "Write IOPS log",
2487 .type = FIO_OPT_STR,
2488 .off1 = td_var_offset(write_iops_log),
2489 .cb = str_write_iops_log_cb,
2490 .help = "Write log of IOPS during run",
2491 .category = FIO_OPT_C_LOG,
2492 .group = FIO_OPT_G_INVALID,
2495 .name = "log_avg_msec",
2496 .lname = "Log averaging (msec)",
2497 .type = FIO_OPT_INT,
2498 .off1 = td_var_offset(log_avg_msec),
2499 .help = "Average bw/iops/lat logs over this period of time",
2501 .category = FIO_OPT_C_LOG,
2502 .group = FIO_OPT_G_INVALID,
2505 .name = "hugepage-size",
2506 .lname = "Hugepage size",
2507 .type = FIO_OPT_INT,
2508 .off1 = td_var_offset(hugepage_size),
2509 .help = "When using hugepages, specify size of each page",
2510 .def = __fio_stringify(FIO_HUGE_PAGE),
2511 .interval = 1024 * 1024,
2512 .category = FIO_OPT_C_GENERAL,
2513 .group = FIO_OPT_G_INVALID,
2516 .name = "group_reporting",
2517 .lname = "Group reporting",
2518 .type = FIO_OPT_BOOL,
2519 .off1 = td_var_offset(group_reporting),
2520 .help = "Do reporting on a per-group basis",
2522 .category = FIO_OPT_C_GENERAL,
2523 .group = FIO_OPT_G_INVALID,
2526 .name = "zero_buffers",
2527 .lname = "Zero I/O buffers",
2528 .type = FIO_OPT_STR_SET,
2529 .off1 = td_var_offset(zero_buffers),
2530 .help = "Init IO buffers to all zeroes",
2531 .category = FIO_OPT_C_IO,
2532 .group = FIO_OPT_G_INVALID,
2535 .name = "refill_buffers",
2536 .lname = "Refill I/O buffers",
2537 .type = FIO_OPT_STR_SET,
2538 .off1 = td_var_offset(refill_buffers),
2539 .help = "Refill IO buffers on every IO submit",
2540 .category = FIO_OPT_C_IO,
2541 .group = FIO_OPT_G_INVALID,
2544 .name = "scramble_buffers",
2545 .lname = "Scramble I/O buffers",
2546 .type = FIO_OPT_BOOL,
2547 .off1 = td_var_offset(scramble_buffers),
2548 .help = "Slightly scramble buffers on every IO submit",
2550 .category = FIO_OPT_C_IO,
2551 .group = FIO_OPT_G_INVALID,
2554 .name = "buffer_compress_percentage",
2555 .lname = "Buffer compression percentage",
2556 .type = FIO_OPT_INT,
2557 .off1 = td_var_offset(compress_percentage),
2560 .help = "How compressible the buffer is (approximately)",
2562 .category = FIO_OPT_C_IO,
2563 .group = FIO_OPT_G_INVALID,
2566 .name = "buffer_compress_chunk",
2567 .lname = "Buffer compression chunk size",
2568 .type = FIO_OPT_INT,
2569 .off1 = td_var_offset(compress_chunk),
2570 .parent = "buffer_compress_percentage",
2572 .help = "Size of compressible region in buffer",
2574 .category = FIO_OPT_C_IO,
2575 .group = FIO_OPT_G_INVALID,
2578 .name = "clat_percentiles",
2579 .lname = "Completion latency percentiles",
2580 .type = FIO_OPT_BOOL,
2581 .off1 = td_var_offset(clat_percentiles),
2582 .help = "Enable the reporting of completion latency percentiles",
2584 .category = FIO_OPT_C_STAT,
2585 .group = FIO_OPT_G_INVALID,
2588 .name = "percentile_list",
2589 .lname = "Completion latency percentile list",
2590 .type = FIO_OPT_FLOAT_LIST,
2591 .off1 = td_var_offset(percentile_list),
2592 .off2 = td_var_offset(overwrite_plist),
2593 .help = "Specify a custom list of percentiles to report",
2594 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2597 .category = FIO_OPT_C_STAT,
2598 .group = FIO_OPT_G_INVALID,
2601 #ifdef FIO_HAVE_DISK_UTIL
2603 .name = "disk_util",
2604 .lname = "Disk utilization",
2605 .type = FIO_OPT_BOOL,
2606 .off1 = td_var_offset(do_disk_util),
2607 .help = "Log disk utilization statistics",
2609 .category = FIO_OPT_C_STAT,
2610 .group = FIO_OPT_G_INVALID,
2614 .name = "gtod_reduce",
2615 .lname = "Reduce gettimeofday() calls",
2616 .type = FIO_OPT_BOOL,
2617 .help = "Greatly reduce number of gettimeofday() calls",
2618 .cb = str_gtod_reduce_cb,
2620 .category = FIO_OPT_C_STAT,
2621 .group = FIO_OPT_G_INVALID,
2624 .name = "disable_lat",
2625 .lname = "Disable all latency stats",
2626 .type = FIO_OPT_BOOL,
2627 .off1 = td_var_offset(disable_lat),
2628 .help = "Disable latency numbers",
2629 .parent = "gtod_reduce",
2632 .category = FIO_OPT_C_STAT,
2633 .group = FIO_OPT_G_INVALID,
2636 .name = "disable_clat",
2637 .lname = "Disable completion latency stats",
2638 .type = FIO_OPT_BOOL,
2639 .off1 = td_var_offset(disable_clat),
2640 .help = "Disable completion latency numbers",
2641 .parent = "gtod_reduce",
2644 .category = FIO_OPT_C_STAT,
2645 .group = FIO_OPT_G_INVALID,
2648 .name = "disable_slat",
2649 .lname = "Disable submission latency stats",
2650 .type = FIO_OPT_BOOL,
2651 .off1 = td_var_offset(disable_slat),
2652 .help = "Disable submission latency numbers",
2653 .parent = "gtod_reduce",
2656 .category = FIO_OPT_C_STAT,
2657 .group = FIO_OPT_G_INVALID,
2660 .name = "disable_bw_measurement",
2661 .lname = "Disable bandwidth stats",
2662 .type = FIO_OPT_BOOL,
2663 .off1 = td_var_offset(disable_bw),
2664 .help = "Disable bandwidth logging",
2665 .parent = "gtod_reduce",
2668 .category = FIO_OPT_C_STAT,
2669 .group = FIO_OPT_G_INVALID,
2673 .lname = "Dedicated gettimeofday() CPU",
2674 .type = FIO_OPT_INT,
2675 .cb = str_gtod_cpu_cb,
2676 .help = "Set up dedicated gettimeofday() thread on this CPU",
2677 .verify = gtod_cpu_verify,
2678 .category = FIO_OPT_C_GENERAL,
2679 .group = FIO_OPT_G_INVALID,
2682 .name = "continue_on_error",
2683 .lname = "Continue on error",
2684 .type = FIO_OPT_STR,
2685 .off1 = td_var_offset(continue_on_error),
2686 .help = "Continue on non-fatal errors during IO",
2688 .category = FIO_OPT_C_GENERAL,
2689 .group = FIO_OPT_G_INVALID,
2692 .oval = ERROR_TYPE_NONE,
2693 .help = "Exit when an error is encountered",
2696 .oval = ERROR_TYPE_READ,
2697 .help = "Continue on read errors only",
2700 .oval = ERROR_TYPE_WRITE,
2701 .help = "Continue on write errors only",
2704 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2705 .help = "Continue on any IO errors",
2708 .oval = ERROR_TYPE_VERIFY,
2709 .help = "Continue on verify errors only",
2712 .oval = ERROR_TYPE_ANY,
2713 .help = "Continue on all io and verify errors",
2716 .oval = ERROR_TYPE_NONE,
2717 .help = "Alias for 'none'",
2720 .oval = ERROR_TYPE_ANY,
2721 .help = "Alias for 'all'",
2728 .type = FIO_OPT_STR_STORE,
2729 .off1 = td_var_offset(profile),
2730 .help = "Select a specific builtin performance test",
2731 .category = FIO_OPT_C_GENERAL,
2732 .group = FIO_OPT_G_INVALID,
2737 .type = FIO_OPT_STR_STORE,
2738 .off1 = td_var_offset(cgroup),
2739 .help = "Add job to cgroup of this name",
2740 .category = FIO_OPT_C_GENERAL,
2741 .group = FIO_OPT_G_INVALID,
2744 .name = "cgroup_weight",
2745 .lname = "Cgroup weight",
2746 .type = FIO_OPT_INT,
2747 .off1 = td_var_offset(cgroup_weight),
2748 .help = "Use given weight for cgroup",
2751 .category = FIO_OPT_C_GENERAL,
2752 .group = FIO_OPT_G_INVALID,
2755 .name = "cgroup_nodelete",
2756 .lname = "Cgroup no-delete",
2757 .type = FIO_OPT_BOOL,
2758 .off1 = td_var_offset(cgroup_nodelete),
2759 .help = "Do not delete cgroups after job completion",
2761 .category = FIO_OPT_C_GENERAL,
2762 .group = FIO_OPT_G_INVALID,
2767 .type = FIO_OPT_INT,
2768 .off1 = td_var_offset(uid),
2769 .help = "Run job with this user ID",
2770 .category = FIO_OPT_C_GENERAL,
2771 .group = FIO_OPT_G_INVALID,
2775 .lname = "Group ID",
2776 .type = FIO_OPT_INT,
2777 .off1 = td_var_offset(gid),
2778 .help = "Run job with this group ID",
2779 .category = FIO_OPT_C_GENERAL,
2780 .group = FIO_OPT_G_INVALID,
2784 .lname = "I/O flow ID",
2785 .type = FIO_OPT_INT,
2786 .off1 = td_var_offset(flow_id),
2787 .help = "The flow index ID to use",
2789 .category = FIO_OPT_C_IO,
2790 .group = FIO_OPT_G_IO_FLOW,
2794 .lname = "I/O flow weight",
2795 .type = FIO_OPT_INT,
2796 .off1 = td_var_offset(flow),
2797 .help = "Weight for flow control of this job",
2798 .parent = "flow_id",
2801 .category = FIO_OPT_C_IO,
2802 .group = FIO_OPT_G_IO_FLOW,
2805 .name = "flow_watermark",
2806 .lname = "I/O flow watermark",
2807 .type = FIO_OPT_INT,
2808 .off1 = td_var_offset(flow_watermark),
2809 .help = "High watermark for flow control. This option"
2810 " should be set to the same value for all threads"
2811 " with non-zero flow.",
2812 .parent = "flow_id",
2815 .category = FIO_OPT_C_IO,
2816 .group = FIO_OPT_G_IO_FLOW,
2819 .name = "flow_sleep",
2820 .lname = "I/O flow sleep",
2821 .type = FIO_OPT_INT,
2822 .off1 = td_var_offset(flow_sleep),
2823 .help = "How many microseconds to sleep after being held"
2824 " back by the flow control mechanism",
2825 .parent = "flow_id",
2828 .category = FIO_OPT_C_IO,
2829 .group = FIO_OPT_G_IO_FLOW,
2836 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2837 const char *name, int val)
2839 lopt->name = (char *) name;
2841 if (o->type == FIO_OPT_STR_SET)
2842 lopt->has_arg = no_argument;
2844 lopt->has_arg = required_argument;
2847 static void options_to_lopts(struct fio_option *opts,
2848 struct option *long_options,
2849 int i, int option_type)
2851 struct fio_option *o = &opts[0];
2853 add_to_lopt(&long_options[i], o, o->name, option_type);
2856 add_to_lopt(&long_options[i], o, o->alias, option_type);
2861 assert(i < FIO_NR_OPTIONS);
2865 void fio_options_set_ioengine_opts(struct option *long_options,
2866 struct thread_data *td)
2871 while (long_options[i].name) {
2872 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2873 memset(&long_options[i], 0, sizeof(*long_options));
2880 * Just clear out the prior ioengine options.
2885 options_to_lopts(td->io_ops->options, long_options, i,
2886 FIO_GETOPT_IOENGINE);
2889 void fio_options_dup_and_init(struct option *long_options)
2893 options_init(fio_options);
2896 while (long_options[i].name)
2899 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
2902 struct fio_keyword {
2908 static struct fio_keyword fio_keywords[] = {
2910 .word = "$pagesize",
2911 .desc = "Page size in the system",
2914 .word = "$mb_memory",
2915 .desc = "Megabytes of memory online",
2919 .desc = "Number of CPUs online in the system",
2926 void fio_keywords_init(void)
2928 unsigned long long mb_memory;
2932 sprintf(buf, "%lu", page_size);
2933 fio_keywords[0].replace = strdup(buf);
2935 mb_memory = os_phys_mem() / (1024 * 1024);
2936 sprintf(buf, "%llu", mb_memory);
2937 fio_keywords[1].replace = strdup(buf);
2940 sprintf(buf, "%lu", l);
2941 fio_keywords[2].replace = strdup(buf);
2946 static char *bc_calc(char *str)
2948 char buf[128], *tmp;
2953 * No math, just return string
2955 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2956 !strchr(str, '/')) || strchr(str, '\''))
2960 * Split option from value, we only need to calculate the value
2962 tmp = strchr(str, '=');
2969 * Prevent buffer overflows; such a case isn't reasonable anyway
2971 if (strlen(str) >= 128 || strlen(tmp) > 100)
2974 sprintf(buf, "which %s > /dev/null", BC_APP);
2976 log_err("fio: bc is needed for performing math\n");
2980 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2981 f = popen(buf, "r");
2986 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2992 buf[(tmp - str) + ret - 1] = '\0';
2993 memcpy(buf, str, tmp - str);
2999 * Return a copy of the input string with substrings of the form ${VARNAME}
3000 * substituted with the value of the environment variable VARNAME. The
3001 * substitution always occurs, even if VARNAME is empty or the corresponding
3002 * environment variable undefined.
3004 static char *option_dup_subs(const char *opt)
3006 char out[OPT_LEN_MAX+1];
3007 char in[OPT_LEN_MAX+1];
3010 char *ch1, *ch2, *env;
3011 ssize_t nchr = OPT_LEN_MAX;
3014 if (strlen(opt) + 1 > OPT_LEN_MAX) {
3015 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
3019 in[OPT_LEN_MAX] = '\0';
3020 strncpy(in, opt, OPT_LEN_MAX);
3022 while (*inptr && nchr > 0) {
3023 if (inptr[0] == '$' && inptr[1] == '{') {
3024 ch2 = strchr(inptr, '}');
3025 if (ch2 && inptr+1 < ch2) {
3032 envlen = strlen(env);
3033 if (envlen <= nchr) {
3034 memcpy(outptr, env, envlen);
3044 *outptr++ = *inptr++;
3053 * Look for reserved variable names and replace them with real values
3055 static char *fio_keyword_replace(char *opt)
3061 for (i = 0; fio_keywords[i].word != NULL; i++) {
3062 struct fio_keyword *kw = &fio_keywords[i];
3064 while ((s = strstr(opt, kw->word)) != NULL) {
3065 char *new = malloc(strlen(opt) + 1);
3071 * Copy part of the string before the keyword and
3072 * sprintf() the replacement after it.
3074 memcpy(new, opt, olen);
3075 len = sprintf(new + olen, "%s", kw->replace);
3078 * If there's more in the original string, copy that
3081 opt += strlen(kw->word) + olen;
3083 memcpy(new + olen + len, opt, opt - o_org - 1);
3086 * replace opt and free the old opt
3096 * Check for potential math and invoke bc, if possible
3104 static char **dup_and_sub_options(char **opts, int num_opts)
3107 char **opts_copy = malloc(num_opts * sizeof(*opts));
3108 for (i = 0; i < num_opts; i++) {
3109 opts_copy[i] = option_dup_subs(opts[i]);
3112 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
3117 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
3119 int i, ret, unknown;
3122 sort_options(opts, fio_options, num_opts);
3123 opts_copy = dup_and_sub_options(opts, num_opts);
3125 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
3126 struct fio_option *o;
3127 int newret = parse_option(opts_copy[i], opts[i], fio_options,
3136 opts_copy[i] = NULL;
3143 ret |= ioengine_load(td);
3145 sort_options(opts_copy, td->io_ops->options, num_opts);
3148 for (i = 0; i < num_opts; i++) {
3149 struct fio_option *o = NULL;
3155 newret = parse_option(opts_copy[i], opts[i],
3156 td->io_ops->options, &o,
3161 log_err("Bad option <%s>\n", opts[i]);
3164 opts_copy[i] = NULL;
3172 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
3174 return parse_cmd_option(opt, val, fio_options, td);
3177 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
3180 return parse_cmd_option(opt, val, td->io_ops->options, td);
3183 void fio_fill_default_options(struct thread_data *td)
3185 fill_default_options(td, fio_options);
3188 int fio_show_option_help(const char *opt)
3190 return show_cmd_help(fio_options, opt);
3193 void options_mem_dupe(void *data, struct fio_option *options)
3195 struct fio_option *o;
3198 for (o = &options[0]; o->name; o++) {
3199 if (o->type != FIO_OPT_STR_STORE)
3202 ptr = td_var(data, o->off1);
3204 *ptr = strdup(*ptr);
3209 * dupe FIO_OPT_STR_STORE options
3211 void fio_options_mem_dupe(struct thread_data *td)
3213 options_mem_dupe(&td->o, fio_options);
3215 if (td->eo && td->io_ops) {
3216 void *oldeo = td->eo;
3218 td->eo = malloc(td->io_ops->option_struct_size);
3219 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3220 options_mem_dupe(td->eo, td->io_ops->options);
3224 unsigned int fio_get_kb_base(void *data)
3226 struct thread_data *td = data;
3227 unsigned int kb_base = 0;
3230 kb_base = td->o.kb_base;
3237 int add_option(struct fio_option *o)
3239 struct fio_option *__o;
3248 memcpy(&fio_options[opt_index], o, sizeof(*o));
3252 void invalidate_profile_options(const char *prof_name)
3254 struct fio_option *o;
3258 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3259 o->type = FIO_OPT_INVALID;
3260 o->prof_name = NULL;
3266 void add_opt_posval(const char *optname, const char *ival, const char *help)
3268 struct fio_option *o;
3271 o = find_option(fio_options, optname);
3275 for (i = 0; i < PARSE_MAX_VP; i++) {
3276 if (o->posval[i].ival)
3279 o->posval[i].ival = ival;
3280 o->posval[i].help = help;
3285 void del_opt_posval(const char *optname, const char *ival)
3287 struct fio_option *o;
3290 o = find_option(fio_options, optname);
3294 for (i = 0; i < PARSE_MAX_VP; i++) {
3295 if (!o->posval[i].ival)
3297 if (strcmp(o->posval[i].ival, ival))
3300 o->posval[i].ival = NULL;
3301 o->posval[i].help = NULL;
3305 void fio_options_free(struct thread_data *td)
3307 options_free(fio_options, td);
3308 if (td->eo && td->io_ops && td->io_ops->options) {
3309 options_free(td->io_ops->options, td->eo);