18 #include "crc/crc32c.h"
21 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
23 static char *get_opt_postfix(const char *str)
25 char *p = strstr(str, ":");
31 strip_blank_front(&p);
36 static int converthexchartoint(char a)
56 static int bs_cmp(const void *p1, const void *p2)
58 const struct bssplit *bsp1 = p1;
59 const struct bssplit *bsp2 = p2;
61 return bsp1->perc < bsp2->perc;
64 static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
66 struct bssplit *bssplit;
67 unsigned int i, perc, perc_missing;
68 unsigned int max_bs, min_bs;
72 td->o.bssplit_nr[ddir] = 4;
73 bssplit = malloc(4 * sizeof(struct bssplit));
78 while ((fname = strsep(&str, ":")) != NULL) {
85 * grow struct buffer, if needed
87 if (i == td->o.bssplit_nr[ddir]) {
88 td->o.bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
90 * sizeof(struct bssplit));
93 perc_str = strstr(fname, "/");
97 perc = atoi(perc_str);
105 if (str_to_decimal(fname, &val, 1, td)) {
106 log_err("fio: bssplit conversion failed\n");
117 bssplit[i].perc = perc;
121 td->o.bssplit_nr[ddir] = i;
124 * Now check if the percentages add up, and how much is missing
126 perc = perc_missing = 0;
127 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
128 struct bssplit *bsp = &bssplit[i];
130 if (bsp->perc == (unsigned char) -1)
137 log_err("fio: bssplit percentages add to more than 100%%\n");
142 * If values didn't have a percentage set, divide the remains between
146 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
147 struct bssplit *bsp = &bssplit[i];
149 if (bsp->perc == (unsigned char) -1)
150 bsp->perc = (100 - perc) / perc_missing;
154 td->o.min_bs[ddir] = min_bs;
155 td->o.max_bs[ddir] = max_bs;
158 * now sort based on percentages, for ease of lookup
160 qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 td->o.bssplit[ddir] = bssplit;
166 static int str_bssplit_cb(void *data, const char *input)
168 struct thread_data *td = data;
169 char *str, *p, *odir, *ddir;
172 p = str = strdup(input);
174 strip_blank_front(&str);
175 strip_blank_end(str);
177 odir = strchr(str, ',');
179 ddir = strchr(odir + 1, ',');
181 ret = bssplit_ddir(td, DDIR_TRIM, ddir + 1);
187 op = strdup(odir + 1);
188 ret = bssplit_ddir(td, DDIR_TRIM, op);
193 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
196 ret = bssplit_ddir(td, DDIR_READ, str);
202 ret = bssplit_ddir(td, DDIR_WRITE, op);
207 ret = bssplit_ddir(td, DDIR_TRIM, op);
210 ret = bssplit_ddir(td, DDIR_READ, str);
217 static int str_rw_cb(void *data, const char *str)
219 struct thread_data *td = data;
220 char *nr = get_opt_postfix(str);
222 td->o.ddir_seq_nr = 1;
223 td->o.ddir_seq_add = 0;
229 td->o.ddir_seq_nr = atoi(nr);
233 if (str_to_decimal(nr, &val, 1, td)) {
234 log_err("fio: rw postfix parsing failed\n");
239 td->o.ddir_seq_add = val;
246 static int str_mem_cb(void *data, const char *mem)
248 struct thread_data *td = data;
250 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
251 td->mmapfile = get_opt_postfix(mem);
252 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
253 log_err("fio: mmaphuge:/path/to/file\n");
261 static int str_verify_cb(void *data, const char *mem)
263 struct thread_data *td = data;
265 if (td->o.verify == VERIFY_CRC32C_INTEL ||
266 td->o.verify == VERIFY_CRC32C) {
267 crc32c_intel_probe();
273 static int fio_clock_source_cb(void *data, const char *str)
275 struct thread_data *td = data;
277 fio_clock_source = td->o.clocksource;
282 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
288 static int str_rwmix_read_cb(void *data, unsigned long long *val)
290 struct thread_data *td = data;
292 td->o.rwmix[DDIR_READ] = *val;
293 td->o.rwmix[DDIR_WRITE] = 100 - *val;
297 static int str_rwmix_write_cb(void *data, unsigned long long *val)
299 struct thread_data *td = data;
301 td->o.rwmix[DDIR_WRITE] = *val;
302 td->o.rwmix[DDIR_READ] = 100 - *val;
306 #ifdef FIO_HAVE_IOPRIO
307 static int str_prioclass_cb(void *data, unsigned long long *val)
309 struct thread_data *td = data;
313 * mask off old class bits, str_prio_cb() may have set a default class
315 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
318 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
323 static int str_prio_cb(void *data, unsigned long long *val)
325 struct thread_data *td = data;
330 * If no class is set, assume BE
332 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
333 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
340 static int str_exitall_cb(void)
342 exitall_on_terminate = 1;
346 #ifdef FIO_HAVE_CPU_AFFINITY
347 static int str_cpumask_cb(void *data, unsigned long long *val)
349 struct thread_data *td = data;
354 ret = fio_cpuset_init(&td->o.cpumask);
356 log_err("fio: cpuset_init failed\n");
357 td_verror(td, ret, "fio_cpuset_init");
361 max_cpu = cpus_online();
363 for (i = 0; i < sizeof(int) * 8; i++) {
364 if ((1 << i) & *val) {
366 log_err("fio: CPU %d too large (max=%ld)\n", i,
370 dprint(FD_PARSE, "set cpu allowed %d\n", i);
371 fio_cpu_set(&td->o.cpumask, i);
375 td->o.cpumask_set = 1;
379 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
386 ret = fio_cpuset_init(mask);
388 log_err("fio: cpuset_init failed\n");
389 td_verror(td, ret, "fio_cpuset_init");
393 p = str = strdup(input);
395 strip_blank_front(&str);
396 strip_blank_end(str);
398 max_cpu = cpus_online();
400 while ((cpu = strsep(&str, ",")) != NULL) {
409 while ((cpu2 = strsep(&str2, "-")) != NULL) {
419 while (icpu <= icpu2) {
420 if (icpu >= FIO_MAX_CPUS) {
421 log_err("fio: your OS only supports up to"
422 " %d CPUs\n", (int) FIO_MAX_CPUS);
426 if (icpu > max_cpu) {
427 log_err("fio: CPU %d too large (max=%ld)\n",
433 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
434 fio_cpu_set(mask, icpu);
443 td->o.cpumask_set = 1;
447 static int str_cpus_allowed_cb(void *data, const char *input)
449 struct thread_data *td = data;
452 ret = set_cpus_allowed(td, &td->o.cpumask, input);
454 td->o.cpumask_set = 1;
459 static int str_verify_cpus_allowed_cb(void *data, const char *input)
461 struct thread_data *td = data;
464 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
466 td->o.verify_cpumask_set = 1;
473 static int str_verify_trim_cb(void *data, unsigned long long *val)
475 struct thread_data *td = data;
477 td->o.trim_percentage = *val;
482 static int str_fst_cb(void *data, const char *str)
484 struct thread_data *td = data;
485 char *nr = get_opt_postfix(str);
487 td->file_service_nr = 1;
489 td->file_service_nr = atoi(nr);
496 #ifdef FIO_HAVE_SYNC_FILE_RANGE
497 static int str_sfr_cb(void *data, const char *str)
499 struct thread_data *td = data;
500 char *nr = get_opt_postfix(str);
502 td->sync_file_range_nr = 1;
504 td->sync_file_range_nr = atoi(nr);
512 static int check_dir(struct thread_data *td, char *fname)
515 char file[PATH_MAX], *dir;
518 if (td->o.directory) {
519 strcpy(file, td->o.directory);
524 sprintf(file + elen, "%s", fname);
530 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
531 * yet, so we can't do this check right here...
533 if (lstat(dir, &sb) < 0) {
536 log_err("fio: %s is not a directory\n", dir);
537 td_verror(td, ret, "lstat");
541 if (!S_ISDIR(sb.st_mode)) {
542 log_err("fio: %s is not a directory\n", dir);
552 * Return next file in the string. Files are separated with ':'. If the ':'
553 * is escaped with a '\', then that ':' is part of the filename and does not
554 * indicate a new file.
556 static char *get_next_file_name(char **ptr)
561 if (!str || !strlen(str))
567 * No colon, we are done
569 p = strchr(str, ':');
576 * We got a colon, but it's the first character. Skip and
584 if (*(p - 1) != '\\') {
590 memmove(p - 1, p, strlen(p) + 1);
597 static int str_filename_cb(void *data, const char *input)
599 struct thread_data *td = data;
600 char *fname, *str, *p;
602 p = str = strdup(input);
604 strip_blank_front(&str);
605 strip_blank_end(str);
607 if (!td->files_index)
610 while ((fname = get_next_file_name(&str)) != NULL) {
613 if (check_dir(td, fname)) {
625 static int str_directory_cb(void *data, const char fio_unused *str)
627 struct thread_data *td = data;
630 if (lstat(td->o.directory, &sb) < 0) {
633 log_err("fio: %s is not a directory\n", td->o.directory);
634 td_verror(td, ret, "lstat");
637 if (!S_ISDIR(sb.st_mode)) {
638 log_err("fio: %s is not a directory\n", td->o.directory);
645 static int str_opendir_cb(void *data, const char fio_unused *str)
647 struct thread_data *td = data;
649 if (!td->files_index)
652 return add_dir_files(td, td->o.opendir);
655 static int str_verify_offset_cb(void *data, unsigned long long *off)
657 struct thread_data *td = data;
659 if (*off && *off < sizeof(struct verify_header)) {
660 log_err("fio: verify_offset too small\n");
664 td->o.verify_offset = *off;
668 static int str_verify_pattern_cb(void *data, const char *input)
670 struct thread_data *td = data;
672 int i = 0, j = 0, len, k, base = 10;
675 loc1 = strstr(input, "0x");
676 loc2 = strstr(input, "0X");
679 off = strtol(input, NULL, base);
680 if (off != LONG_MAX || errno != ERANGE) {
682 td->o.verify_pattern[i] = off & 0xff;
691 j = loc1 - input + 2;
693 j = loc2 - input + 2;
696 if (len - j < MAX_PATTERN_SIZE * 2) {
698 off = converthexchartoint(input[k--]);
700 off += (converthexchartoint(input[k--])
702 td->o.verify_pattern[i++] = (char) off;
708 * Fill the pattern all the way to the end. This greatly reduces
709 * the number of memcpy's we have to do when verifying the IO.
711 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
712 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
717 * The code in verify_io_u_pattern assumes a single byte pattern
718 * fills the whole verify pattern buffer.
720 memset(td->o.verify_pattern, td->o.verify_pattern[0],
724 td->o.verify_pattern_bytes = i;
727 * VERIFY_META could already be set
729 if (td->o.verify == VERIFY_NONE)
730 td->o.verify = VERIFY_PATTERN;
735 static int str_lockfile_cb(void *data, const char *str)
737 struct thread_data *td = data;
738 char *nr = get_opt_postfix(str);
740 td->o.lockfile_batch = 1;
742 td->o.lockfile_batch = atoi(nr);
749 static int str_write_bw_log_cb(void *data, const char *str)
751 struct thread_data *td = data;
754 td->o.bw_log_file = strdup(str);
756 td->o.write_bw_log = 1;
760 static int str_write_lat_log_cb(void *data, const char *str)
762 struct thread_data *td = data;
765 td->o.lat_log_file = strdup(str);
767 td->o.write_lat_log = 1;
771 static int str_write_iops_log_cb(void *data, const char *str)
773 struct thread_data *td = data;
776 td->o.iops_log_file = strdup(str);
778 td->o.write_iops_log = 1;
782 static int str_gtod_reduce_cb(void *data, int *il)
784 struct thread_data *td = data;
787 td->o.disable_lat = !!val;
788 td->o.disable_clat = !!val;
789 td->o.disable_slat = !!val;
790 td->o.disable_bw = !!val;
791 td->o.clat_percentiles = !val;
793 td->tv_cache_mask = 63;
798 static int str_gtod_cpu_cb(void *data, long long *il)
800 struct thread_data *td = data;
803 td->o.gtod_cpu = val;
804 td->o.gtod_offload = 1;
808 static int str_size_cb(void *data, unsigned long long *__val)
810 struct thread_data *td = data;
811 unsigned long long v = *__val;
813 if (parse_is_percent(v)) {
815 td->o.size_percent = -1ULL - v;
822 static int rw_verify(struct fio_option *o, void *data)
824 struct thread_data *td = data;
826 if (read_only && td_write(td)) {
827 log_err("fio: job <%s> has write bit set, but fio is in"
828 " read-only mode\n", td->o.name);
835 static int gtod_cpu_verify(struct fio_option *o, void *data)
837 #ifndef FIO_HAVE_CPU_AFFINITY
838 struct thread_data *td = data;
840 if (td->o.gtod_cpu) {
841 log_err("fio: platform must support CPU affinity for"
842 "gettimeofday() offloading\n");
850 static int kb_base_verify(struct fio_option *o, void *data)
852 struct thread_data *td = data;
854 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
855 log_err("fio: kb_base set to nonsensical value: %u\n",
864 * Map of job/command line options
866 static struct fio_option options[FIO_MAX_OPTS] = {
868 .name = "description",
869 .type = FIO_OPT_STR_STORE,
870 .off1 = td_var_offset(description),
871 .help = "Text job description",
875 .type = FIO_OPT_STR_STORE,
876 .off1 = td_var_offset(name),
877 .help = "Name of this job",
881 .type = FIO_OPT_STR_STORE,
882 .off1 = td_var_offset(directory),
883 .cb = str_directory_cb,
884 .help = "Directory to store files in",
888 .type = FIO_OPT_STR_STORE,
889 .off1 = td_var_offset(filename),
890 .cb = str_filename_cb,
891 .prio = -1, /* must come after "directory" */
892 .help = "File(s) to use for the workload",
897 .off1 = td_var_offset(kb_base),
898 .verify = kb_base_verify,
901 .help = "How many bytes per KB for reporting (1000 or 1024)",
906 .cb = str_lockfile_cb,
907 .off1 = td_var_offset(file_lock_mode),
908 .help = "Lock file when doing IO to it",
909 .parent = "filename",
913 .oval = FILE_LOCK_NONE,
914 .help = "No file locking",
916 { .ival = "exclusive",
917 .oval = FILE_LOCK_EXCLUSIVE,
918 .help = "Exclusive file lock",
922 .oval = FILE_LOCK_READWRITE,
923 .help = "Read vs write lock",
929 .type = FIO_OPT_STR_STORE,
930 .off1 = td_var_offset(opendir),
931 .cb = str_opendir_cb,
932 .help = "Recursively add files from this directory and down",
936 .alias = "readwrite",
939 .off1 = td_var_offset(td_ddir),
940 .help = "IO direction",
945 .oval = TD_DDIR_READ,
946 .help = "Sequential read",
949 .oval = TD_DDIR_WRITE,
950 .help = "Sequential write",
953 .oval = TD_DDIR_TRIM,
954 .help = "Sequential trim",
956 { .ival = "randread",
957 .oval = TD_DDIR_RANDREAD,
958 .help = "Random read",
960 { .ival = "randwrite",
961 .oval = TD_DDIR_RANDWRITE,
962 .help = "Random write",
964 { .ival = "randtrim",
965 .oval = TD_DDIR_RANDTRIM,
966 .help = "Random trim",
970 .help = "Sequential read and write mix",
972 { .ival = "readwrite",
974 .help = "Sequential read and write mix",
977 .oval = TD_DDIR_RANDRW,
978 .help = "Random read and write mix"
983 .name = "rw_sequencer",
985 .off1 = td_var_offset(rw_seq),
986 .help = "IO offset generator modifier",
989 { .ival = "sequential",
991 .help = "Generate sequential offsets",
993 { .ival = "identical",
994 .oval = RW_SEQ_IDENT,
995 .help = "Generate identical offsets",
1002 .type = FIO_OPT_STR_STORE,
1003 .off1 = td_var_offset(ioengine),
1004 .help = "IO engine to use",
1005 .def = FIO_PREFERRED_ENGINE,
1008 .help = "Use read/write",
1011 .help = "Use pread/pwrite",
1014 .help = "Use readv/writev",
1016 #ifdef FIO_HAVE_LIBAIO
1018 .help = "Linux native asynchronous IO",
1021 #ifdef FIO_HAVE_POSIXAIO
1022 { .ival = "posixaio",
1023 .help = "POSIX asynchronous IO",
1026 #ifdef FIO_HAVE_SOLARISAIO
1027 { .ival = "solarisaio",
1028 .help = "Solaris native asynchronous IO",
1031 #ifdef FIO_HAVE_WINDOWSAIO
1032 { .ival = "windowsaio",
1033 .help = "Windows native asynchronous IO"
1037 .help = "Memory mapped IO"
1039 #ifdef FIO_HAVE_SPLICE
1041 .help = "splice/vmsplice based IO",
1043 { .ival = "netsplice",
1044 .help = "splice/vmsplice to/from the network",
1047 #ifdef FIO_HAVE_SGIO
1049 .help = "SCSI generic v3 IO",
1053 .help = "Testing engine (no data transfer)",
1056 .help = "Network IO",
1058 #ifdef FIO_HAVE_SYSLET
1059 { .ival = "syslet-rw",
1060 .help = "syslet enabled async pread/pwrite IO",
1064 .help = "CPU cycle burner engine",
1066 #ifdef FIO_HAVE_GUASI
1068 .help = "GUASI IO engine",
1071 #ifdef FIO_HAVE_BINJECT
1072 { .ival = "binject",
1073 .help = "binject direct inject block engine",
1076 #ifdef FIO_HAVE_RDMA
1078 .help = "RDMA IO engine",
1081 #ifdef FIO_HAVE_FUSION_AW
1082 { .ival = "fusion-aw-sync",
1083 .help = "Fusion-io atomic write engine",
1086 { .ival = "external",
1087 .help = "Load external engine (append name)",
1093 .type = FIO_OPT_INT,
1094 .off1 = td_var_offset(iodepth),
1095 .help = "Number of IO buffers to keep in flight",
1100 .name = "iodepth_batch",
1101 .alias = "iodepth_batch_submit",
1102 .type = FIO_OPT_INT,
1103 .off1 = td_var_offset(iodepth_batch),
1104 .help = "Number of IO buffers to submit in one go",
1105 .parent = "iodepth",
1110 .name = "iodepth_batch_complete",
1111 .type = FIO_OPT_INT,
1112 .off1 = td_var_offset(iodepth_batch_complete),
1113 .help = "Number of IO buffers to retrieve in one go",
1114 .parent = "iodepth",
1119 .name = "iodepth_low",
1120 .type = FIO_OPT_INT,
1121 .off1 = td_var_offset(iodepth_low),
1122 .help = "Low water mark for queuing depth",
1123 .parent = "iodepth",
1127 .type = FIO_OPT_STR_VAL,
1129 .help = "Total size of device or files",
1132 .name = "fill_device",
1134 .type = FIO_OPT_BOOL,
1135 .off1 = td_var_offset(fill_device),
1136 .help = "Write until an ENOSPC error occurs",
1141 .type = FIO_OPT_STR_VAL,
1142 .off1 = td_var_offset(file_size_low),
1143 .off2 = td_var_offset(file_size_high),
1145 .help = "Size of individual files",
1149 .alias = "fileoffset",
1150 .type = FIO_OPT_STR_VAL,
1151 .off1 = td_var_offset(start_offset),
1152 .help = "Start IO from this offset",
1156 .name = "offset_increment",
1157 .type = FIO_OPT_STR_VAL,
1158 .off1 = td_var_offset(offset_increment),
1159 .help = "What is the increment from one offset to the next",
1165 .alias = "blocksize",
1166 .type = FIO_OPT_INT,
1167 .off1 = td_var_offset(bs[DDIR_READ]),
1168 .off2 = td_var_offset(bs[DDIR_WRITE]),
1169 .off3 = td_var_offset(bs[DDIR_TRIM]),
1171 .help = "Block size unit",
1177 .alias = "blockalign",
1178 .type = FIO_OPT_INT,
1179 .off1 = td_var_offset(ba[DDIR_READ]),
1180 .off2 = td_var_offset(ba[DDIR_WRITE]),
1181 .off3 = td_var_offset(ba[DDIR_TRIM]),
1183 .help = "IO block offset alignment",
1188 .alias = "blocksize_range",
1189 .type = FIO_OPT_RANGE,
1190 .off1 = td_var_offset(min_bs[DDIR_READ]),
1191 .off2 = td_var_offset(max_bs[DDIR_READ]),
1192 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1193 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1194 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1195 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
1197 .help = "Set block size range (in more detail than bs)",
1202 .type = FIO_OPT_STR,
1203 .cb = str_bssplit_cb,
1204 .help = "Set a specific mix of block sizes",
1208 .name = "bs_unaligned",
1209 .alias = "blocksize_unaligned",
1210 .type = FIO_OPT_STR_SET,
1211 .off1 = td_var_offset(bs_unaligned),
1212 .help = "Don't sector align IO buffer sizes",
1216 .name = "randrepeat",
1217 .type = FIO_OPT_BOOL,
1218 .off1 = td_var_offset(rand_repeatable),
1219 .help = "Use repeatable random IO pattern",
1224 .name = "use_os_rand",
1225 .type = FIO_OPT_BOOL,
1226 .off1 = td_var_offset(use_os_rand),
1227 .help = "Set to use OS random generator",
1232 .name = "norandommap",
1233 .type = FIO_OPT_STR_SET,
1234 .off1 = td_var_offset(norandommap),
1235 .help = "Accept potential duplicate random blocks",
1239 .name = "softrandommap",
1240 .type = FIO_OPT_BOOL,
1241 .off1 = td_var_offset(softrandommap),
1242 .help = "Set norandommap if randommap allocation fails",
1243 .parent = "norandommap",
1248 .alias = "nr_files",
1249 .type = FIO_OPT_INT,
1250 .off1 = td_var_offset(nr_files),
1251 .help = "Split job workload between this number of files",
1255 .name = "openfiles",
1256 .type = FIO_OPT_INT,
1257 .off1 = td_var_offset(open_files),
1258 .help = "Number of files to keep open at the same time",
1261 .name = "file_service_type",
1262 .type = FIO_OPT_STR,
1264 .off1 = td_var_offset(file_service_type),
1265 .help = "How to select which file to service next",
1266 .def = "roundrobin",
1269 .oval = FIO_FSERVICE_RANDOM,
1270 .help = "Choose a file at random",
1272 { .ival = "roundrobin",
1273 .oval = FIO_FSERVICE_RR,
1274 .help = "Round robin select files",
1276 { .ival = "sequential",
1277 .oval = FIO_FSERVICE_SEQ,
1278 .help = "Finish one file before moving to the next",
1281 .parent = "nrfiles",
1283 #ifdef FIO_HAVE_FALLOCATE
1285 .name = "fallocate",
1286 .type = FIO_OPT_STR,
1287 .off1 = td_var_offset(fallocate_mode),
1288 .help = "Whether pre-allocation is performed when laying out files",
1292 .oval = FIO_FALLOCATE_NONE,
1293 .help = "Do not pre-allocate space",
1296 .oval = FIO_FALLOCATE_POSIX,
1297 .help = "Use posix_fallocate()",
1299 #ifdef FIO_HAVE_LINUX_FALLOCATE
1301 .oval = FIO_FALLOCATE_KEEP_SIZE,
1302 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1305 /* Compatibility with former boolean values */
1307 .oval = FIO_FALLOCATE_NONE,
1308 .help = "Alias for 'none'",
1311 .oval = FIO_FALLOCATE_POSIX,
1312 .help = "Alias for 'posix'",
1316 #endif /* FIO_HAVE_FALLOCATE */
1318 .name = "fadvise_hint",
1319 .type = FIO_OPT_BOOL,
1320 .off1 = td_var_offset(fadvise_hint),
1321 .help = "Use fadvise() to advise the kernel on IO pattern",
1326 .type = FIO_OPT_INT,
1327 .off1 = td_var_offset(fsync_blocks),
1328 .help = "Issue fsync for writes every given number of blocks",
1332 .name = "fdatasync",
1333 .type = FIO_OPT_INT,
1334 .off1 = td_var_offset(fdatasync_blocks),
1335 .help = "Issue fdatasync for writes every given number of blocks",
1339 .name = "write_barrier",
1340 .type = FIO_OPT_INT,
1341 .off1 = td_var_offset(barrier_blocks),
1342 .help = "Make every Nth write a barrier write",
1345 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1347 .name = "sync_file_range",
1349 { .ival = "wait_before",
1350 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1351 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1355 .oval = SYNC_FILE_RANGE_WRITE,
1356 .help = "SYNC_FILE_RANGE_WRITE",
1360 .ival = "wait_after",
1361 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1362 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1366 .type = FIO_OPT_STR_MULTI,
1368 .off1 = td_var_offset(sync_file_range),
1369 .help = "Use sync_file_range()",
1374 .type = FIO_OPT_BOOL,
1375 .off1 = td_var_offset(odirect),
1376 .help = "Use O_DIRECT IO (negates buffered)",
1381 .type = FIO_OPT_BOOL,
1382 .off1 = td_var_offset(odirect),
1384 .help = "Use buffered IO (negates direct)",
1388 .name = "overwrite",
1389 .type = FIO_OPT_BOOL,
1390 .off1 = td_var_offset(overwrite),
1391 .help = "When writing, set whether to overwrite current data",
1396 .type = FIO_OPT_INT,
1397 .off1 = td_var_offset(loops),
1398 .help = "Number of times to run the job",
1403 .type = FIO_OPT_INT,
1404 .off1 = td_var_offset(numjobs),
1405 .help = "Duplicate this job this many times",
1409 .name = "startdelay",
1410 .type = FIO_OPT_STR_VAL_TIME,
1411 .off1 = td_var_offset(start_delay),
1412 .help = "Only start job when this period has passed",
1418 .type = FIO_OPT_STR_VAL_TIME,
1419 .off1 = td_var_offset(timeout),
1420 .help = "Stop workload when this amount of time has passed",
1424 .name = "time_based",
1425 .type = FIO_OPT_STR_SET,
1426 .off1 = td_var_offset(time_based),
1427 .help = "Keep running until runtime/timeout is met",
1430 .name = "ramp_time",
1431 .type = FIO_OPT_STR_VAL_TIME,
1432 .off1 = td_var_offset(ramp_time),
1433 .help = "Ramp up time before measuring performance",
1436 .name = "clocksource",
1437 .type = FIO_OPT_STR,
1438 .cb = fio_clock_source_cb,
1439 .off1 = td_var_offset(clocksource),
1440 .help = "What type of timing source to use",
1442 { .ival = "gettimeofday",
1444 .help = "Use gettimeofday(2) for timing",
1446 { .ival = "clock_gettime",
1447 .oval = CS_CGETTIME,
1448 .help = "Use clock_gettime(2) for timing",
1450 #ifdef ARCH_HAVE_CPU_CLOCK
1452 .oval = CS_CPUCLOCK,
1453 .help = "Use CPU private clock",
1461 .type = FIO_OPT_STR,
1463 .off1 = td_var_offset(mem_type),
1464 .help = "Backing type for IO buffers",
1469 .help = "Use malloc(3) for IO buffers",
1473 .help = "Use shared memory segments for IO buffers",
1475 #ifdef FIO_HAVE_HUGETLB
1476 { .ival = "shmhuge",
1477 .oval = MEM_SHMHUGE,
1478 .help = "Like shm, but use huge pages",
1483 .help = "Use mmap(2) (file or anon) for IO buffers",
1485 #ifdef FIO_HAVE_HUGETLB
1486 { .ival = "mmaphuge",
1487 .oval = MEM_MMAPHUGE,
1488 .help = "Like mmap, but use huge pages",
1494 .name = "iomem_align",
1495 .alias = "mem_align",
1496 .type = FIO_OPT_INT,
1497 .off1 = td_var_offset(mem_align),
1499 .help = "IO memory buffer offset alignment",
1505 .type = FIO_OPT_STR,
1506 .off1 = td_var_offset(verify),
1507 .help = "Verify data written",
1508 .cb = str_verify_cb,
1512 .oval = VERIFY_NONE,
1513 .help = "Don't do IO verification",
1517 .help = "Use md5 checksums for verification",
1520 .oval = VERIFY_CRC64,
1521 .help = "Use crc64 checksums for verification",
1524 .oval = VERIFY_CRC32,
1525 .help = "Use crc32 checksums for verification",
1527 { .ival = "crc32c-intel",
1528 .oval = VERIFY_CRC32C,
1529 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1532 .oval = VERIFY_CRC32C,
1533 .help = "Use crc32c checksums for verification (hw assisted, if available)",
1536 .oval = VERIFY_CRC16,
1537 .help = "Use crc16 checksums for verification",
1540 .oval = VERIFY_CRC7,
1541 .help = "Use crc7 checksums for verification",
1544 .oval = VERIFY_SHA1,
1545 .help = "Use sha1 checksums for verification",
1548 .oval = VERIFY_SHA256,
1549 .help = "Use sha256 checksums for verification",
1552 .oval = VERIFY_SHA512,
1553 .help = "Use sha512 checksums for verification",
1556 .oval = VERIFY_META,
1557 .help = "Use io information",
1561 .oval = VERIFY_NULL,
1562 .help = "Pretend to verify",
1567 .name = "do_verify",
1568 .type = FIO_OPT_BOOL,
1569 .off1 = td_var_offset(do_verify),
1570 .help = "Run verification stage after write",
1575 .name = "verifysort",
1576 .type = FIO_OPT_BOOL,
1577 .off1 = td_var_offset(verifysort),
1578 .help = "Sort written verify blocks for read back",
1583 .name = "verify_interval",
1584 .type = FIO_OPT_INT,
1585 .off1 = td_var_offset(verify_interval),
1586 .minval = 2 * sizeof(struct verify_header),
1587 .help = "Store verify buffer header every N bytes",
1591 .name = "verify_offset",
1592 .type = FIO_OPT_INT,
1593 .help = "Offset verify header location by N bytes",
1595 .cb = str_verify_offset_cb,
1599 .name = "verify_pattern",
1600 .type = FIO_OPT_STR,
1601 .cb = str_verify_pattern_cb,
1602 .help = "Fill pattern for IO buffers",
1606 .name = "verify_fatal",
1607 .type = FIO_OPT_BOOL,
1608 .off1 = td_var_offset(verify_fatal),
1610 .help = "Exit on a single verify failure, don't continue",
1614 .name = "verify_dump",
1615 .type = FIO_OPT_BOOL,
1616 .off1 = td_var_offset(verify_dump),
1618 .help = "Dump contents of good and bad blocks on failure",
1622 .name = "verify_async",
1623 .type = FIO_OPT_INT,
1624 .off1 = td_var_offset(verify_async),
1626 .help = "Number of async verifier threads to use",
1630 .name = "verify_backlog",
1631 .type = FIO_OPT_STR_VAL,
1632 .off1 = td_var_offset(verify_backlog),
1633 .help = "Verify after this number of blocks are written",
1637 .name = "verify_backlog_batch",
1638 .type = FIO_OPT_INT,
1639 .off1 = td_var_offset(verify_batch),
1640 .help = "Verify this number of IO blocks",
1643 #ifdef FIO_HAVE_CPU_AFFINITY
1645 .name = "verify_async_cpus",
1646 .type = FIO_OPT_STR,
1647 .cb = str_verify_cpus_allowed_cb,
1648 .help = "Set CPUs allowed for async verify threads",
1649 .parent = "verify_async",
1652 #ifdef FIO_HAVE_TRIM
1654 .name = "trim_percentage",
1655 .type = FIO_OPT_INT,
1656 .cb = str_verify_trim_cb,
1658 .help = "Number of verify blocks to discard/trim",
1663 .name = "trim_verify_zero",
1664 .type = FIO_OPT_INT,
1665 .help = "Verify that trim/discarded blocks are returned as zeroes",
1666 .off1 = td_var_offset(trim_zero),
1667 .parent = "trim_percentage",
1671 .name = "trim_backlog",
1672 .type = FIO_OPT_STR_VAL,
1673 .off1 = td_var_offset(trim_backlog),
1674 .help = "Trim after this number of blocks are written",
1675 .parent = "trim_percentage",
1678 .name = "trim_backlog_batch",
1679 .type = FIO_OPT_INT,
1680 .off1 = td_var_offset(trim_batch),
1681 .help = "Trim this number of IO blocks",
1682 .parent = "trim_percentage",
1686 .name = "write_iolog",
1687 .type = FIO_OPT_STR_STORE,
1688 .off1 = td_var_offset(write_iolog_file),
1689 .help = "Store IO pattern to file",
1692 .name = "read_iolog",
1693 .type = FIO_OPT_STR_STORE,
1694 .off1 = td_var_offset(read_iolog_file),
1695 .help = "Playback IO pattern from file",
1698 .name = "replay_no_stall",
1699 .type = FIO_OPT_INT,
1700 .off1 = td_var_offset(no_stall),
1702 .parent = "read_iolog",
1703 .help = "Playback IO pattern file as fast as possible without stalls",
1706 .name = "replay_redirect",
1707 .type = FIO_OPT_STR_STORE,
1708 .off1 = td_var_offset(replay_redirect),
1709 .parent = "read_iolog",
1710 .help = "Replay all I/O onto this device, regardless of trace device",
1713 .name = "exec_prerun",
1714 .type = FIO_OPT_STR_STORE,
1715 .off1 = td_var_offset(exec_prerun),
1716 .help = "Execute this file prior to running job",
1719 .name = "exec_postrun",
1720 .type = FIO_OPT_STR_STORE,
1721 .off1 = td_var_offset(exec_postrun),
1722 .help = "Execute this file after running job",
1724 #ifdef FIO_HAVE_IOSCHED_SWITCH
1726 .name = "ioscheduler",
1727 .type = FIO_OPT_STR_STORE,
1728 .off1 = td_var_offset(ioscheduler),
1729 .help = "Use this IO scheduler on the backing device",
1734 .type = FIO_OPT_STR_VAL,
1735 .off1 = td_var_offset(zone_size),
1736 .help = "Amount of data to read per zone",
1740 .name = "zonerange",
1741 .type = FIO_OPT_STR_VAL,
1742 .off1 = td_var_offset(zone_range),
1743 .help = "Give size of an IO zone",
1748 .type = FIO_OPT_STR_VAL,
1749 .off1 = td_var_offset(zone_skip),
1750 .help = "Space between IO zones",
1755 .type = FIO_OPT_STR_VAL,
1756 .cb = str_lockmem_cb,
1757 .help = "Lock down this amount of memory",
1761 .name = "rwmixread",
1762 .type = FIO_OPT_INT,
1763 .cb = str_rwmix_read_cb,
1765 .help = "Percentage of mixed workload that is reads",
1769 .name = "rwmixwrite",
1770 .type = FIO_OPT_INT,
1771 .cb = str_rwmix_write_cb,
1773 .help = "Percentage of mixed workload that is writes",
1777 .name = "rwmixcycle",
1778 .type = FIO_OPT_DEPRECATED,
1782 .type = FIO_OPT_INT,
1783 .off1 = td_var_offset(nice),
1784 .help = "Set job CPU nice value",
1789 #ifdef FIO_HAVE_IOPRIO
1792 .type = FIO_OPT_INT,
1794 .help = "Set job IO priority value",
1799 .name = "prioclass",
1800 .type = FIO_OPT_INT,
1801 .cb = str_prioclass_cb,
1802 .help = "Set job IO priority class",
1808 .name = "thinktime",
1809 .type = FIO_OPT_INT,
1810 .off1 = td_var_offset(thinktime),
1811 .help = "Idle time between IO buffers (usec)",
1815 .name = "thinktime_spin",
1816 .type = FIO_OPT_INT,
1817 .off1 = td_var_offset(thinktime_spin),
1818 .help = "Start think time by spinning this amount (usec)",
1820 .parent = "thinktime",
1823 .name = "thinktime_blocks",
1824 .type = FIO_OPT_INT,
1825 .off1 = td_var_offset(thinktime_blocks),
1826 .help = "IO buffer period between 'thinktime'",
1828 .parent = "thinktime",
1832 .type = FIO_OPT_INT,
1833 .off1 = td_var_offset(rate[DDIR_READ]),
1834 .off2 = td_var_offset(rate[DDIR_WRITE]),
1835 .off3 = td_var_offset(rate[DDIR_TRIM]),
1836 .help = "Set bandwidth rate",
1840 .type = FIO_OPT_INT,
1841 .off1 = td_var_offset(ratemin[DDIR_READ]),
1842 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
1843 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
1844 .help = "Job must meet this rate or it will be shutdown",
1848 .name = "rate_iops",
1849 .type = FIO_OPT_INT,
1850 .off1 = td_var_offset(rate_iops[DDIR_READ]),
1851 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
1852 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
1853 .help = "Limit IO used to this number of IO operations/sec",
1856 .name = "rate_iops_min",
1857 .type = FIO_OPT_INT,
1858 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
1859 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
1860 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
1861 .help = "Job must meet this rate or it will be shut down",
1862 .parent = "rate_iops",
1865 .name = "ratecycle",
1866 .type = FIO_OPT_INT,
1867 .off1 = td_var_offset(ratecycle),
1868 .help = "Window average for rate limits (msec)",
1873 .name = "invalidate",
1874 .type = FIO_OPT_BOOL,
1875 .off1 = td_var_offset(invalidate_cache),
1876 .help = "Invalidate buffer/page cache prior to running job",
1881 .type = FIO_OPT_BOOL,
1882 .off1 = td_var_offset(sync_io),
1883 .help = "Use O_SYNC for buffered writes",
1885 .parent = "buffered",
1888 .name = "bwavgtime",
1889 .type = FIO_OPT_INT,
1890 .off1 = td_var_offset(bw_avg_time),
1891 .help = "Time window over which to calculate bandwidth"
1894 .parent = "write_bw_log",
1897 .name = "iopsavgtime",
1898 .type = FIO_OPT_INT,
1899 .off1 = td_var_offset(iops_avg_time),
1900 .help = "Time window over which to calculate IOPS (msec)",
1902 .parent = "write_iops_log",
1905 .name = "create_serialize",
1906 .type = FIO_OPT_BOOL,
1907 .off1 = td_var_offset(create_serialize),
1908 .help = "Serialize creating of job files",
1912 .name = "create_fsync",
1913 .type = FIO_OPT_BOOL,
1914 .off1 = td_var_offset(create_fsync),
1915 .help = "fsync file after creation",
1919 .name = "create_on_open",
1920 .type = FIO_OPT_BOOL,
1921 .off1 = td_var_offset(create_on_open),
1922 .help = "Create files when they are opened for IO",
1926 .name = "create_only",
1927 .type = FIO_OPT_BOOL,
1928 .off1 = td_var_offset(create_only),
1929 .help = "Only perform file creation phase",
1934 .type = FIO_OPT_BOOL,
1935 .off1 = td_var_offset(pre_read),
1936 .help = "Pre-read files before starting official testing",
1941 .type = FIO_OPT_INT,
1942 .off1 = td_var_offset(cpuload),
1943 .help = "Use this percentage of CPU",
1946 .name = "cpuchunks",
1947 .type = FIO_OPT_INT,
1948 .off1 = td_var_offset(cpucycle),
1949 .help = "Length of the CPU burn cycles (usecs)",
1951 .parent = "cpuload",
1953 #ifdef FIO_HAVE_CPU_AFFINITY
1956 .type = FIO_OPT_INT,
1957 .cb = str_cpumask_cb,
1958 .help = "CPU affinity mask",
1961 .name = "cpus_allowed",
1962 .type = FIO_OPT_STR,
1963 .cb = str_cpus_allowed_cb,
1964 .help = "Set CPUs allowed",
1968 .name = "end_fsync",
1969 .type = FIO_OPT_BOOL,
1970 .off1 = td_var_offset(end_fsync),
1971 .help = "Include fsync at the end of job",
1975 .name = "fsync_on_close",
1976 .type = FIO_OPT_BOOL,
1977 .off1 = td_var_offset(fsync_on_close),
1978 .help = "fsync files on close",
1983 .type = FIO_OPT_BOOL,
1984 .off1 = td_var_offset(unlink),
1985 .help = "Unlink created files after job has completed",
1990 .type = FIO_OPT_STR_SET,
1991 .cb = str_exitall_cb,
1992 .help = "Terminate all jobs when one exits",
1995 .name = "stonewall",
1996 .alias = "wait_for_previous",
1997 .type = FIO_OPT_STR_SET,
1998 .off1 = td_var_offset(stonewall),
1999 .help = "Insert a hard barrier between this job and previous",
2002 .name = "new_group",
2003 .type = FIO_OPT_STR_SET,
2004 .off1 = td_var_offset(new_group),
2005 .help = "Mark the start of a new group (for reporting)",
2009 .type = FIO_OPT_STR_SET,
2010 .off1 = td_var_offset(use_thread),
2011 .help = "Use threads instead of forks",
2014 .name = "write_bw_log",
2015 .type = FIO_OPT_STR,
2016 .off1 = td_var_offset(write_bw_log),
2017 .cb = str_write_bw_log_cb,
2018 .help = "Write log of bandwidth during run",
2021 .name = "write_lat_log",
2022 .type = FIO_OPT_STR,
2023 .off1 = td_var_offset(write_lat_log),
2024 .cb = str_write_lat_log_cb,
2025 .help = "Write log of latency during run",
2028 .name = "write_iops_log",
2029 .type = FIO_OPT_STR,
2030 .off1 = td_var_offset(write_iops_log),
2031 .cb = str_write_iops_log_cb,
2032 .help = "Write log of IOPS during run",
2035 .name = "log_avg_msec",
2036 .type = FIO_OPT_INT,
2037 .off1 = td_var_offset(log_avg_msec),
2038 .help = "Average bw/iops/lat logs over this period of time",
2042 .name = "hugepage-size",
2043 .type = FIO_OPT_INT,
2044 .off1 = td_var_offset(hugepage_size),
2045 .help = "When using hugepages, specify size of each page",
2046 .def = __fio_stringify(FIO_HUGE_PAGE),
2049 .name = "group_reporting",
2050 .type = FIO_OPT_STR_SET,
2051 .off1 = td_var_offset(group_reporting),
2052 .help = "Do reporting on a per-group basis",
2055 .name = "zero_buffers",
2056 .type = FIO_OPT_STR_SET,
2057 .off1 = td_var_offset(zero_buffers),
2058 .help = "Init IO buffers to all zeroes",
2061 .name = "refill_buffers",
2062 .type = FIO_OPT_STR_SET,
2063 .off1 = td_var_offset(refill_buffers),
2064 .help = "Refill IO buffers on every IO submit",
2067 .name = "scramble_buffers",
2068 .type = FIO_OPT_BOOL,
2069 .off1 = td_var_offset(scramble_buffers),
2070 .help = "Slightly scramble buffers on every IO submit",
2074 .name = "buffer_compress_percentage",
2075 .type = FIO_OPT_INT,
2076 .off1 = td_var_offset(compress_percentage),
2079 .help = "How compressible the buffer is (approximately)",
2082 .name = "buffer_compress_chunk",
2083 .type = FIO_OPT_INT,
2084 .off1 = td_var_offset(compress_chunk),
2085 .parent = "buffer_compress_percentage",
2086 .help = "Size of compressible region in buffer",
2089 .name = "clat_percentiles",
2090 .type = FIO_OPT_BOOL,
2091 .off1 = td_var_offset(clat_percentiles),
2092 .help = "Enable the reporting of completion latency percentiles",
2096 .name = "percentile_list",
2097 .type = FIO_OPT_FLOAT_LIST,
2098 .off1 = td_var_offset(percentile_list),
2099 .off2 = td_var_offset(overwrite_plist),
2100 .help = "Specify a custom list of percentiles to report",
2101 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2106 #ifdef FIO_HAVE_DISK_UTIL
2108 .name = "disk_util",
2109 .type = FIO_OPT_BOOL,
2110 .off1 = td_var_offset(do_disk_util),
2111 .help = "Log disk utilization statistics",
2116 .name = "gtod_reduce",
2117 .type = FIO_OPT_BOOL,
2118 .help = "Greatly reduce number of gettimeofday() calls",
2119 .cb = str_gtod_reduce_cb,
2123 .name = "disable_lat",
2124 .type = FIO_OPT_BOOL,
2125 .off1 = td_var_offset(disable_lat),
2126 .help = "Disable latency numbers",
2127 .parent = "gtod_reduce",
2131 .name = "disable_clat",
2132 .type = FIO_OPT_BOOL,
2133 .off1 = td_var_offset(disable_clat),
2134 .help = "Disable completion latency numbers",
2135 .parent = "gtod_reduce",
2139 .name = "disable_slat",
2140 .type = FIO_OPT_BOOL,
2141 .off1 = td_var_offset(disable_slat),
2142 .help = "Disable submission latency numbers",
2143 .parent = "gtod_reduce",
2147 .name = "disable_bw_measurement",
2148 .type = FIO_OPT_BOOL,
2149 .off1 = td_var_offset(disable_bw),
2150 .help = "Disable bandwidth logging",
2151 .parent = "gtod_reduce",
2156 .type = FIO_OPT_INT,
2157 .cb = str_gtod_cpu_cb,
2158 .help = "Set up dedicated gettimeofday() thread on this CPU",
2159 .verify = gtod_cpu_verify,
2162 .name = "continue_on_error",
2163 .type = FIO_OPT_STR,
2164 .off1 = td_var_offset(continue_on_error),
2165 .help = "Continue on non-fatal errors during IO",
2169 .oval = ERROR_TYPE_NONE,
2170 .help = "Exit when an error is encountered",
2173 .oval = ERROR_TYPE_READ,
2174 .help = "Continue on read errors only",
2177 .oval = ERROR_TYPE_WRITE,
2178 .help = "Continue on write errors only",
2181 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2182 .help = "Continue on any IO errors",
2185 .oval = ERROR_TYPE_VERIFY,
2186 .help = "Continue on verify errors only",
2189 .oval = ERROR_TYPE_ANY,
2190 .help = "Continue on all io and verify errors",
2193 .oval = ERROR_TYPE_NONE,
2194 .help = "Alias for 'none'",
2197 .oval = ERROR_TYPE_ANY,
2198 .help = "Alias for 'all'",
2204 .type = FIO_OPT_STR_STORE,
2205 .off1 = td_var_offset(profile),
2206 .help = "Select a specific builtin performance test",
2210 .type = FIO_OPT_STR_STORE,
2211 .off1 = td_var_offset(cgroup),
2212 .help = "Add job to cgroup of this name",
2215 .name = "cgroup_weight",
2216 .type = FIO_OPT_INT,
2217 .off1 = td_var_offset(cgroup_weight),
2218 .help = "Use given weight for cgroup",
2223 .name = "cgroup_nodelete",
2224 .type = FIO_OPT_BOOL,
2225 .off1 = td_var_offset(cgroup_nodelete),
2226 .help = "Do not delete cgroups after job completion",
2231 .type = FIO_OPT_INT,
2232 .off1 = td_var_offset(uid),
2233 .help = "Run job with this user ID",
2237 .type = FIO_OPT_INT,
2238 .off1 = td_var_offset(gid),
2239 .help = "Run job with this group ID",
2243 .type = FIO_OPT_INT,
2244 .off1 = td_var_offset(flow_id),
2245 .help = "The flow index ID to use",
2250 .type = FIO_OPT_INT,
2251 .off1 = td_var_offset(flow),
2252 .help = "Weight for flow control of this job",
2253 .parent = "flow_id",
2257 .name = "flow_watermark",
2258 .type = FIO_OPT_INT,
2259 .off1 = td_var_offset(flow_watermark),
2260 .help = "High watermark for flow control. This option"
2261 " should be set to the same value for all threads"
2262 " with non-zero flow.",
2263 .parent = "flow_id",
2267 .name = "flow_sleep",
2268 .type = FIO_OPT_INT,
2269 .off1 = td_var_offset(flow_sleep),
2270 .help = "How many microseconds to sleep after being held"
2271 " back by the flow control mechanism",
2272 .parent = "flow_id",
2280 static void add_to_lopt(struct option *lopt, struct fio_option *o,
2281 const char *name, int val)
2283 lopt->name = (char *) name;
2285 if (o->type == FIO_OPT_STR_SET)
2286 lopt->has_arg = no_argument;
2288 lopt->has_arg = required_argument;
2291 static void options_to_lopts(struct fio_option *opts,
2292 struct option *long_options,
2293 int i, int option_type)
2295 struct fio_option *o = &opts[0];
2297 add_to_lopt(&long_options[i], o, o->name, option_type);
2300 add_to_lopt(&long_options[i], o, o->alias, option_type);
2305 assert(i < FIO_NR_OPTIONS);
2309 void fio_options_set_ioengine_opts(struct option *long_options,
2310 struct thread_data *td)
2315 while (long_options[i].name) {
2316 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2317 memset(&long_options[i], 0, sizeof(*long_options));
2324 * Just clear out the prior ioengine options.
2329 options_to_lopts(td->io_ops->options, long_options, i,
2330 FIO_GETOPT_IOENGINE);
2333 void fio_options_dup_and_init(struct option *long_options)
2337 options_init(options);
2340 while (long_options[i].name)
2343 options_to_lopts(options, long_options, i, FIO_GETOPT_JOB);
2346 struct fio_keyword {
2352 static struct fio_keyword fio_keywords[] = {
2354 .word = "$pagesize",
2355 .desc = "Page size in the system",
2358 .word = "$mb_memory",
2359 .desc = "Megabytes of memory online",
2363 .desc = "Number of CPUs online in the system",
2370 void fio_keywords_init(void)
2372 unsigned long long mb_memory;
2376 sprintf(buf, "%lu", page_size);
2377 fio_keywords[0].replace = strdup(buf);
2379 mb_memory = os_phys_mem() / (1024 * 1024);
2380 sprintf(buf, "%llu", mb_memory);
2381 fio_keywords[1].replace = strdup(buf);
2384 sprintf(buf, "%lu", l);
2385 fio_keywords[2].replace = strdup(buf);
2390 static char *bc_calc(char *str)
2392 char buf[128], *tmp;
2397 * No math, just return string
2399 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2400 !strchr(str, '/')) || strchr(str, '\''))
2404 * Split option from value, we only need to calculate the value
2406 tmp = strchr(str, '=');
2413 * Prevent buffer overflows; such a case isn't reasonable anyway
2415 if (strlen(str) >= 128 || strlen(tmp) > 100)
2418 sprintf(buf, "which %s > /dev/null", BC_APP);
2420 log_err("fio: bc is needed for performing math\n");
2424 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
2425 f = popen(buf, "r");
2430 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
2436 buf[(tmp - str) + ret - 1] = '\0';
2437 memcpy(buf, str, tmp - str);
2443 * Return a copy of the input string with substrings of the form ${VARNAME}
2444 * substituted with the value of the environment variable VARNAME. The
2445 * substitution always occurs, even if VARNAME is empty or the corresponding
2446 * environment variable undefined.
2448 static char *option_dup_subs(const char *opt)
2450 char out[OPT_LEN_MAX+1];
2451 char in[OPT_LEN_MAX+1];
2454 char *ch1, *ch2, *env;
2455 ssize_t nchr = OPT_LEN_MAX;
2458 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2459 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2463 in[OPT_LEN_MAX] = '\0';
2464 strncpy(in, opt, OPT_LEN_MAX);
2466 while (*inptr && nchr > 0) {
2467 if (inptr[0] == '$' && inptr[1] == '{') {
2468 ch2 = strchr(inptr, '}');
2469 if (ch2 && inptr+1 < ch2) {
2476 envlen = strlen(env);
2477 if (envlen <= nchr) {
2478 memcpy(outptr, env, envlen);
2488 *outptr++ = *inptr++;
2497 * Look for reserved variable names and replace them with real values
2499 static char *fio_keyword_replace(char *opt)
2505 for (i = 0; fio_keywords[i].word != NULL; i++) {
2506 struct fio_keyword *kw = &fio_keywords[i];
2508 while ((s = strstr(opt, kw->word)) != NULL) {
2509 char *new = malloc(strlen(opt) + 1);
2515 * Copy part of the string before the keyword and
2516 * sprintf() the replacement after it.
2518 memcpy(new, opt, olen);
2519 len = sprintf(new + olen, "%s", kw->replace);
2522 * If there's more in the original string, copy that
2525 opt += strlen(kw->word) + olen;
2527 memcpy(new + olen + len, opt, opt - o_org - 1);
2530 * replace opt and free the old opt
2540 * Check for potential math and invoke bc, if possible
2548 static char **dup_and_sub_options(char **opts, int num_opts)
2551 char **opts_copy = malloc(num_opts * sizeof(*opts));
2552 for (i = 0; i < num_opts; i++) {
2553 opts_copy[i] = option_dup_subs(opts[i]);
2556 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2561 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2563 int i, ret, unknown;
2566 sort_options(opts, options, num_opts);
2567 opts_copy = dup_and_sub_options(opts, num_opts);
2569 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2570 struct fio_option *o;
2571 int newret = parse_option(opts_copy[i], opts[i], options, &o,
2580 opts_copy[i] = NULL;
2587 ret |= ioengine_load(td);
2589 sort_options(opts_copy, td->io_ops->options, num_opts);
2592 for (i = 0; i < num_opts; i++) {
2593 struct fio_option *o = NULL;
2599 newret = parse_option(opts_copy[i], opts[i],
2600 td->io_ops->options, &o,
2605 log_err("Bad option <%s>\n", opts[i]);
2608 opts_copy[i] = NULL;
2616 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2618 return parse_cmd_option(opt, val, options, td);
2621 int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2624 return parse_cmd_option(opt, val, td->io_ops->options, td);
2627 void fio_fill_default_options(struct thread_data *td)
2629 fill_default_options(td, options);
2632 int fio_show_option_help(const char *opt)
2634 return show_cmd_help(options, opt);
2637 void options_mem_dupe(void *data, struct fio_option *options)
2639 struct fio_option *o;
2642 for (o = &options[0]; o->name; o++) {
2643 if (o->type != FIO_OPT_STR_STORE)
2646 ptr = td_var(data, o->off1);
2648 *ptr = strdup(*ptr);
2653 * dupe FIO_OPT_STR_STORE options
2655 void fio_options_mem_dupe(struct thread_data *td)
2657 options_mem_dupe(&td->o, options);
2659 if (td->eo && td->io_ops) {
2660 void *oldeo = td->eo;
2662 td->eo = malloc(td->io_ops->option_struct_size);
2663 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2664 options_mem_dupe(td->eo, td->io_ops->options);
2668 unsigned int fio_get_kb_base(void *data)
2670 struct thread_data *td = data;
2671 unsigned int kb_base = 0;
2674 kb_base = td->o.kb_base;
2681 int add_option(struct fio_option *o)
2683 struct fio_option *__o;
2692 memcpy(&options[opt_index], o, sizeof(*o));
2696 void invalidate_profile_options(const char *prof_name)
2698 struct fio_option *o;
2702 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2703 o->type = FIO_OPT_INVALID;
2704 o->prof_name = NULL;
2710 void add_opt_posval(const char *optname, const char *ival, const char *help)
2712 struct fio_option *o;
2715 o = find_option(options, optname);
2719 for (i = 0; i < PARSE_MAX_VP; i++) {
2720 if (o->posval[i].ival)
2723 o->posval[i].ival = ival;
2724 o->posval[i].help = help;
2729 void del_opt_posval(const char *optname, const char *ival)
2731 struct fio_option *o;
2734 o = find_option(options, optname);
2738 for (i = 0; i < PARSE_MAX_VP; i++) {
2739 if (!o->posval[i].ival)
2741 if (strcmp(o->posval[i].ival, ival))
2744 o->posval[i].ival = NULL;
2745 o->posval[i].help = NULL;
2749 void fio_options_free(struct thread_data *td)
2751 options_free(options, td);
2752 if (td->eo && td->io_ops && td->io_ops->options) {
2753 options_free(td->io_ops->options, td->eo);