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;
172 p = str = strdup(input);
174 strip_blank_front(&str);
175 strip_blank_end(str);
177 odir = strchr(str, ',');
179 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
182 ret = bssplit_ddir(td, DDIR_READ, str);
189 ret = bssplit_ddir(td, DDIR_READ, str);
191 ret = bssplit_ddir(td, DDIR_WRITE, op);
200 static int str_rw_cb(void *data, const char *str)
202 struct thread_data *td = data;
203 char *nr = get_opt_postfix(str);
205 td->o.ddir_seq_nr = 1;
207 td->o.ddir_seq_nr = atoi(nr);
214 static int str_mem_cb(void *data, const char *mem)
216 struct thread_data *td = data;
218 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
219 td->mmapfile = get_opt_postfix(mem);
220 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
221 log_err("fio: mmaphuge:/path/to/file\n");
229 static int str_verify_cb(void *data, const char *mem)
231 struct thread_data *td = data;
233 if (td->o.verify != VERIFY_CRC32C_INTEL)
236 if (!crc32c_intel_works()) {
237 log_info("fio: System does not support hw accelerated crc32c. Falling back to sw crc32c.\n");
238 td->o.verify = VERIFY_CRC32C;
244 static int fio_clock_source_cb(void *data, const char *str)
246 struct thread_data *td = data;
248 fio_clock_source = td->o.clocksource;
253 static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
259 static int str_rwmix_read_cb(void *data, unsigned long long *val)
261 struct thread_data *td = data;
263 td->o.rwmix[DDIR_READ] = *val;
264 td->o.rwmix[DDIR_WRITE] = 100 - *val;
268 static int str_rwmix_write_cb(void *data, unsigned long long *val)
270 struct thread_data *td = data;
272 td->o.rwmix[DDIR_WRITE] = *val;
273 td->o.rwmix[DDIR_READ] = 100 - *val;
277 #ifdef FIO_HAVE_IOPRIO
278 static int str_prioclass_cb(void *data, unsigned long long *val)
280 struct thread_data *td = data;
284 * mask off old class bits, str_prio_cb() may have set a default class
286 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
289 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
294 static int str_prio_cb(void *data, unsigned long long *val)
296 struct thread_data *td = data;
301 * If no class is set, assume BE
303 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
304 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
311 static int str_exitall_cb(void)
313 exitall_on_terminate = 1;
317 #ifdef FIO_HAVE_CPU_AFFINITY
318 static int str_cpumask_cb(void *data, unsigned long long *val)
320 struct thread_data *td = data;
325 ret = fio_cpuset_init(&td->o.cpumask);
327 log_err("fio: cpuset_init failed\n");
328 td_verror(td, ret, "fio_cpuset_init");
332 max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
334 for (i = 0; i < sizeof(int) * 8; i++) {
335 if ((1 << i) & *val) {
337 log_err("fio: CPU %d too large (max=%ld)\n", i,
341 dprint(FD_PARSE, "set cpu allowed %d\n", i);
342 fio_cpu_set(&td->o.cpumask, i);
346 td->o.cpumask_set = 1;
350 static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
357 ret = fio_cpuset_init(mask);
359 log_err("fio: cpuset_init failed\n");
360 td_verror(td, ret, "fio_cpuset_init");
364 p = str = strdup(input);
366 strip_blank_front(&str);
367 strip_blank_end(str);
369 max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
371 while ((cpu = strsep(&str, ",")) != NULL) {
380 while ((cpu2 = strsep(&str2, "-")) != NULL) {
390 while (icpu <= icpu2) {
391 if (icpu >= FIO_MAX_CPUS) {
392 log_err("fio: your OS only supports up to"
393 " %d CPUs\n", (int) FIO_MAX_CPUS);
397 if (icpu > max_cpu) {
398 log_err("fio: CPU %d too large (max=%ld)\n",
404 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
405 fio_cpu_set(mask, icpu);
414 td->o.cpumask_set = 1;
418 static int str_cpus_allowed_cb(void *data, const char *input)
420 struct thread_data *td = data;
423 ret = set_cpus_allowed(td, &td->o.cpumask, input);
425 td->o.cpumask_set = 1;
430 static int str_verify_cpus_allowed_cb(void *data, const char *input)
432 struct thread_data *td = data;
435 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
437 td->o.verify_cpumask_set = 1;
444 static int str_verify_trim_cb(void *data, unsigned long long *val)
446 struct thread_data *td = data;
448 td->o.trim_percentage = *val;
453 static int str_fst_cb(void *data, const char *str)
455 struct thread_data *td = data;
456 char *nr = get_opt_postfix(str);
458 td->file_service_nr = 1;
460 td->file_service_nr = atoi(nr);
467 #ifdef FIO_HAVE_SYNC_FILE_RANGE
468 static int str_sfr_cb(void *data, const char *str)
470 struct thread_data *td = data;
471 char *nr = get_opt_postfix(str);
473 td->sync_file_range_nr = 1;
475 td->sync_file_range_nr = atoi(nr);
483 static int check_dir(struct thread_data *td, char *fname)
485 char file[PATH_MAX], *dir;
488 if (td->o.directory) {
489 strcpy(file, td->o.directory);
494 sprintf(file + elen, "%s", fname);
501 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
502 * yet, so we can't do this check right here...
504 if (lstat(dir, &sb) < 0) {
507 log_err("fio: %s is not a directory\n", dir);
508 td_verror(td, ret, "lstat");
512 if (!S_ISDIR(sb.st_mode)) {
513 log_err("fio: %s is not a directory\n", dir);
523 * Return next file in the string. Files are separated with ':'. If the ':'
524 * is escaped with a '\', then that ':' is part of the filename and does not
525 * indicate a new file.
527 static char *get_next_file_name(char **ptr)
532 if (!str || !strlen(str))
538 * No colon, we are done
540 p = strchr(str, ':');
547 * We got a colon, but it's the first character. Skip and
555 if (*(p - 1) != '\\') {
561 memmove(p - 1, p, strlen(p) + 1);
568 static int str_filename_cb(void *data, const char *input)
570 struct thread_data *td = data;
571 char *fname, *str, *p;
573 p = str = strdup(input);
575 strip_blank_front(&str);
576 strip_blank_end(str);
578 if (!td->files_index)
581 while ((fname = get_next_file_name(&str)) != NULL) {
584 if (check_dir(td, fname)) {
596 static int str_directory_cb(void *data, const char fio_unused *str)
598 struct thread_data *td = data;
601 if (lstat(td->o.directory, &sb) < 0) {
604 log_err("fio: %s is not a directory\n", td->o.directory);
605 td_verror(td, ret, "lstat");
608 if (!S_ISDIR(sb.st_mode)) {
609 log_err("fio: %s is not a directory\n", td->o.directory);
616 static int str_opendir_cb(void *data, const char fio_unused *str)
618 struct thread_data *td = data;
620 if (!td->files_index)
623 return add_dir_files(td, td->o.opendir);
626 static int str_verify_offset_cb(void *data, unsigned long long *off)
628 struct thread_data *td = data;
630 if (*off && *off < sizeof(struct verify_header)) {
631 log_err("fio: verify_offset too small\n");
635 td->o.verify_offset = *off;
639 static int str_verify_pattern_cb(void *data, const char *input)
641 struct thread_data *td = data;
643 int i = 0, j = 0, len, k, base = 10;
646 loc1 = strstr(input, "0x");
647 loc2 = strstr(input, "0X");
650 off = strtol(input, NULL, base);
651 if (off != LONG_MAX || errno != ERANGE) {
653 td->o.verify_pattern[i] = off & 0xff;
662 j = loc1 - input + 2;
664 j = loc2 - input + 2;
667 if (len - j < MAX_PATTERN_SIZE * 2) {
669 off = converthexchartoint(input[k--]);
671 off += (converthexchartoint(input[k--])
673 td->o.verify_pattern[i++] = (char) off;
677 td->o.verify_pattern_bytes = i;
679 * VERIFY_META could already be set
681 if (td->o.verify == VERIFY_NONE)
682 td->o.verify = VERIFY_PATTERN;
686 static int str_lockfile_cb(void *data, const char *str)
688 struct thread_data *td = data;
689 char *nr = get_opt_postfix(str);
691 td->o.lockfile_batch = 1;
693 td->o.lockfile_batch = atoi(nr);
700 static int str_write_bw_log_cb(void *data, const char *str)
702 struct thread_data *td = data;
705 td->o.bw_log_file = strdup(str);
707 td->o.write_bw_log = 1;
711 static int str_write_lat_log_cb(void *data, const char *str)
713 struct thread_data *td = data;
716 td->o.lat_log_file = strdup(str);
718 td->o.write_lat_log = 1;
722 static int str_gtod_reduce_cb(void *data, int *il)
724 struct thread_data *td = data;
727 td->o.disable_lat = !!val;
728 td->o.disable_clat = !!val;
729 td->o.disable_slat = !!val;
730 td->o.disable_bw = !!val;
732 td->tv_cache_mask = 63;
737 static int str_gtod_cpu_cb(void *data, long long *il)
739 struct thread_data *td = data;
742 td->o.gtod_cpu = val;
743 td->o.gtod_offload = 1;
747 static int rw_verify(struct fio_option *o, void *data)
749 struct thread_data *td = data;
751 if (read_only && td_write(td)) {
752 log_err("fio: job <%s> has write bit set, but fio is in"
753 " read-only mode\n", td->o.name);
760 static int gtod_cpu_verify(struct fio_option *o, void *data)
762 #ifndef FIO_HAVE_CPU_AFFINITY
763 struct thread_data *td = data;
765 if (td->o.gtod_cpu) {
766 log_err("fio: platform must support CPU affinity for"
767 "gettimeofday() offloading\n");
775 static int kb_base_verify(struct fio_option *o, void *data)
777 struct thread_data *td = data;
779 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
780 log_err("fio: kb_base set to nonsensical value: %u\n",
788 #define __stringify_1(x) #x
789 #define __stringify(x) __stringify_1(x)
792 * Map of job/command line options
794 static struct fio_option options[FIO_MAX_OPTS] = {
796 .name = "description",
797 .type = FIO_OPT_STR_STORE,
798 .off1 = td_var_offset(description),
799 .help = "Text job description",
803 .type = FIO_OPT_STR_STORE,
804 .off1 = td_var_offset(name),
805 .help = "Name of this job",
809 .type = FIO_OPT_STR_STORE,
810 .off1 = td_var_offset(directory),
811 .cb = str_directory_cb,
812 .help = "Directory to store files in",
816 .type = FIO_OPT_STR_STORE,
817 .off1 = td_var_offset(filename),
818 .cb = str_filename_cb,
819 .prio = -1, /* must come after "directory" */
820 .help = "File(s) to use for the workload",
825 .off1 = td_var_offset(kb_base),
826 .verify = kb_base_verify,
829 .help = "How many bytes per KB for reporting (1000 or 1024)",
834 .cb = str_lockfile_cb,
835 .off1 = td_var_offset(file_lock_mode),
836 .help = "Lock file when doing IO to it",
837 .parent = "filename",
841 .oval = FILE_LOCK_NONE,
842 .help = "No file locking",
844 { .ival = "exclusive",
845 .oval = FILE_LOCK_EXCLUSIVE,
846 .help = "Exclusive file lock",
850 .oval = FILE_LOCK_READWRITE,
851 .help = "Read vs write lock",
857 .type = FIO_OPT_STR_STORE,
858 .off1 = td_var_offset(opendir),
859 .cb = str_opendir_cb,
860 .help = "Recursively add files from this directory and down",
864 .alias = "readwrite",
867 .off1 = td_var_offset(td_ddir),
868 .help = "IO direction",
873 .oval = TD_DDIR_READ,
874 .help = "Sequential read",
877 .oval = TD_DDIR_WRITE,
878 .help = "Sequential write",
880 { .ival = "randread",
881 .oval = TD_DDIR_RANDREAD,
882 .help = "Random read",
884 { .ival = "randwrite",
885 .oval = TD_DDIR_RANDWRITE,
886 .help = "Random write",
890 .help = "Sequential read and write mix",
893 .oval = TD_DDIR_RANDRW,
894 .help = "Random read and write mix"
899 .name = "rw_sequencer",
901 .off1 = td_var_offset(rw_seq),
902 .help = "IO offset generator modifier",
905 { .ival = "sequential",
907 .help = "Generate sequential offsets",
909 { .ival = "identical",
910 .oval = RW_SEQ_IDENT,
911 .help = "Generate identical offsets",
918 .type = FIO_OPT_STR_STORE,
919 .off1 = td_var_offset(ioengine),
920 .help = "IO engine to use",
924 .help = "Use read/write",
927 .help = "Use pread/pwrite",
930 .help = "Use readv/writev",
932 #ifdef FIO_HAVE_LIBAIO
934 .help = "Linux native asynchronous IO",
937 #ifdef FIO_HAVE_POSIXAIO
938 { .ival = "posixaio",
939 .help = "POSIX asynchronous IO",
942 #ifdef FIO_HAVE_SOLARISAIO
943 { .ival = "solarisaio",
944 .help = "Solaris native asynchronous IO",
947 #ifdef FIO_HAVE_WINDOWSAIO
948 { .ival = "windowsaio",
949 .help = "Windows native asynchronous IO"
953 .help = "Memory mapped IO"
955 #ifdef FIO_HAVE_SPLICE
957 .help = "splice/vmsplice based IO",
959 { .ival = "netsplice",
960 .help = "splice/vmsplice to/from the network",
965 .help = "SCSI generic v3 IO",
969 .help = "Testing engine (no data transfer)",
972 .help = "Network IO",
974 #ifdef FIO_HAVE_SYSLET
975 { .ival = "syslet-rw",
976 .help = "syslet enabled async pread/pwrite IO",
980 .help = "CPU cycle burner engine",
982 #ifdef FIO_HAVE_GUASI
984 .help = "GUASI IO engine",
987 #ifdef FIO_HAVE_BINJECT
989 .help = "binject direct inject block engine",
992 { .ival = "external",
993 .help = "Load external engine (append name)",
1000 .off1 = td_var_offset(iodepth),
1001 .help = "Number of IO buffers to keep in flight",
1006 .name = "iodepth_batch",
1007 .alias = "iodepth_batch_submit",
1008 .type = FIO_OPT_INT,
1009 .off1 = td_var_offset(iodepth_batch),
1010 .help = "Number of IO buffers to submit in one go",
1011 .parent = "iodepth",
1016 .name = "iodepth_batch_complete",
1017 .type = FIO_OPT_INT,
1018 .off1 = td_var_offset(iodepth_batch_complete),
1019 .help = "Number of IO buffers to retrieve in one go",
1020 .parent = "iodepth",
1025 .name = "iodepth_low",
1026 .type = FIO_OPT_INT,
1027 .off1 = td_var_offset(iodepth_low),
1028 .help = "Low water mark for queuing depth",
1029 .parent = "iodepth",
1033 .type = FIO_OPT_STR_VAL,
1034 .off1 = td_var_offset(size),
1036 .help = "Total size of device or files",
1039 .name = "fill_device",
1040 .type = FIO_OPT_BOOL,
1041 .off1 = td_var_offset(fill_device),
1042 .help = "Write until an ENOSPC error occurs",
1047 .type = FIO_OPT_STR_VAL,
1048 .off1 = td_var_offset(file_size_low),
1049 .off2 = td_var_offset(file_size_high),
1051 .help = "Size of individual files",
1055 .alias = "fileoffset",
1056 .type = FIO_OPT_STR_VAL,
1057 .off1 = td_var_offset(start_offset),
1058 .help = "Start IO from this offset",
1063 .alias = "blocksize",
1064 .type = FIO_OPT_INT,
1065 .off1 = td_var_offset(bs[DDIR_READ]),
1066 .off2 = td_var_offset(bs[DDIR_WRITE]),
1068 .help = "Block size unit",
1074 .alias = "blockalign",
1075 .type = FIO_OPT_INT,
1076 .off1 = td_var_offset(ba[DDIR_READ]),
1077 .off2 = td_var_offset(ba[DDIR_WRITE]),
1079 .help = "IO block offset alignment",
1084 .alias = "blocksize_range",
1085 .type = FIO_OPT_RANGE,
1086 .off1 = td_var_offset(min_bs[DDIR_READ]),
1087 .off2 = td_var_offset(max_bs[DDIR_READ]),
1088 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1089 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1091 .help = "Set block size range (in more detail than bs)",
1096 .type = FIO_OPT_STR,
1097 .cb = str_bssplit_cb,
1098 .help = "Set a specific mix of block sizes",
1102 .name = "bs_unaligned",
1103 .alias = "blocksize_unaligned",
1104 .type = FIO_OPT_STR_SET,
1105 .off1 = td_var_offset(bs_unaligned),
1106 .help = "Don't sector align IO buffer sizes",
1110 .name = "randrepeat",
1111 .type = FIO_OPT_BOOL,
1112 .off1 = td_var_offset(rand_repeatable),
1113 .help = "Use repeatable random IO pattern",
1118 .name = "norandommap",
1119 .type = FIO_OPT_STR_SET,
1120 .off1 = td_var_offset(norandommap),
1121 .help = "Accept potential duplicate random blocks",
1125 .name = "softrandommap",
1126 .type = FIO_OPT_BOOL,
1127 .off1 = td_var_offset(softrandommap),
1128 .help = "Set norandommap if randommap allocation fails",
1129 .parent = "norandommap",
1134 .alias = "nr_files",
1135 .type = FIO_OPT_INT,
1136 .off1 = td_var_offset(nr_files),
1137 .help = "Split job workload between this number of files",
1141 .name = "openfiles",
1142 .type = FIO_OPT_INT,
1143 .off1 = td_var_offset(open_files),
1144 .help = "Number of files to keep open at the same time",
1147 .name = "file_service_type",
1148 .type = FIO_OPT_STR,
1150 .off1 = td_var_offset(file_service_type),
1151 .help = "How to select which file to service next",
1152 .def = "roundrobin",
1155 .oval = FIO_FSERVICE_RANDOM,
1156 .help = "Choose a file at random",
1158 { .ival = "roundrobin",
1159 .oval = FIO_FSERVICE_RR,
1160 .help = "Round robin select files",
1162 { .ival = "sequential",
1163 .oval = FIO_FSERVICE_SEQ,
1164 .help = "Finish one file before moving to the next",
1167 .parent = "nrfiles",
1169 #ifdef FIO_HAVE_FALLOCATE
1171 .name = "fallocate",
1172 .type = FIO_OPT_BOOL,
1173 .off1 = td_var_offset(fallocate),
1174 .help = "Use fallocate() when laying out files",
1179 .name = "fadvise_hint",
1180 .type = FIO_OPT_BOOL,
1181 .off1 = td_var_offset(fadvise_hint),
1182 .help = "Use fadvise() to advise the kernel on IO pattern",
1187 .type = FIO_OPT_INT,
1188 .off1 = td_var_offset(fsync_blocks),
1189 .help = "Issue fsync for writes every given number of blocks",
1193 .name = "fdatasync",
1194 .type = FIO_OPT_INT,
1195 .off1 = td_var_offset(fdatasync_blocks),
1196 .help = "Issue fdatasync for writes every given number of blocks",
1200 .name = "write_barrier",
1201 .type = FIO_OPT_INT,
1202 .off1 = td_var_offset(barrier_blocks),
1203 .help = "Make every Nth write a barrier write",
1206 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1208 .name = "sync_file_range",
1210 { .ival = "wait_before",
1211 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1212 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1216 .oval = SYNC_FILE_RANGE_WRITE,
1217 .help = "SYNC_FILE_RANGE_WRITE",
1221 .ival = "wait_after",
1222 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1223 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1227 .type = FIO_OPT_STR_MULTI,
1229 .off1 = td_var_offset(sync_file_range),
1230 .help = "Use sync_file_range()",
1235 .type = FIO_OPT_BOOL,
1236 .off1 = td_var_offset(odirect),
1237 .help = "Use O_DIRECT IO (negates buffered)",
1242 .type = FIO_OPT_BOOL,
1243 .off1 = td_var_offset(odirect),
1245 .help = "Use buffered IO (negates direct)",
1249 .name = "overwrite",
1250 .type = FIO_OPT_BOOL,
1251 .off1 = td_var_offset(overwrite),
1252 .help = "When writing, set whether to overwrite current data",
1257 .type = FIO_OPT_INT,
1258 .off1 = td_var_offset(loops),
1259 .help = "Number of times to run the job",
1264 .type = FIO_OPT_INT,
1265 .off1 = td_var_offset(numjobs),
1266 .help = "Duplicate this job this many times",
1270 .name = "startdelay",
1271 .type = FIO_OPT_STR_VAL_TIME,
1272 .off1 = td_var_offset(start_delay),
1273 .help = "Only start job when this period has passed",
1279 .type = FIO_OPT_STR_VAL_TIME,
1280 .off1 = td_var_offset(timeout),
1281 .help = "Stop workload when this amount of time has passed",
1285 .name = "time_based",
1286 .type = FIO_OPT_STR_SET,
1287 .off1 = td_var_offset(time_based),
1288 .help = "Keep running until runtime/timeout is met",
1291 .name = "ramp_time",
1292 .type = FIO_OPT_STR_VAL_TIME,
1293 .off1 = td_var_offset(ramp_time),
1294 .help = "Ramp up time before measuring performance",
1297 .name = "clocksource",
1298 .type = FIO_OPT_STR,
1299 .cb = fio_clock_source_cb,
1300 .off1 = td_var_offset(clocksource),
1301 .help = "What type of timing source to use",
1303 { .ival = "gettimeofday",
1305 .help = "Use gettimeofday(2) for timing",
1307 { .ival = "clock_gettime",
1308 .oval = CS_CGETTIME,
1309 .help = "Use clock_gettime(2) for timing",
1311 #ifdef ARCH_HAVE_CPU_CLOCK
1313 .oval = CS_CPUCLOCK,
1314 .help = "Use CPU private clock",
1322 .type = FIO_OPT_STR,
1324 .off1 = td_var_offset(mem_type),
1325 .help = "Backing type for IO buffers",
1330 .help = "Use malloc(3) for IO buffers",
1334 .help = "Use shared memory segments for IO buffers",
1336 #ifdef FIO_HAVE_HUGETLB
1337 { .ival = "shmhuge",
1338 .oval = MEM_SHMHUGE,
1339 .help = "Like shm, but use huge pages",
1344 .help = "Use mmap(2) (file or anon) for IO buffers",
1346 #ifdef FIO_HAVE_HUGETLB
1347 { .ival = "mmaphuge",
1348 .oval = MEM_MMAPHUGE,
1349 .help = "Like mmap, but use huge pages",
1355 .name = "iomem_align",
1356 .alias = "mem_align",
1357 .type = FIO_OPT_INT,
1358 .off1 = td_var_offset(mem_align),
1360 .help = "IO memory buffer offset alignment",
1366 .type = FIO_OPT_STR,
1367 .off1 = td_var_offset(verify),
1368 .help = "Verify data written",
1369 .cb = str_verify_cb,
1373 .oval = VERIFY_NONE,
1374 .help = "Don't do IO verification",
1378 .help = "Use md5 checksums for verification",
1381 .oval = VERIFY_CRC64,
1382 .help = "Use crc64 checksums for verification",
1385 .oval = VERIFY_CRC32,
1386 .help = "Use crc32 checksums for verification",
1388 { .ival = "crc32c-intel",
1389 .oval = VERIFY_CRC32C_INTEL,
1390 .help = "Use hw crc32c checksums for verification",
1393 .oval = VERIFY_CRC32C,
1394 .help = "Use crc32c checksums for verification",
1397 .oval = VERIFY_CRC16,
1398 .help = "Use crc16 checksums for verification",
1401 .oval = VERIFY_CRC7,
1402 .help = "Use crc7 checksums for verification",
1405 .oval = VERIFY_SHA1,
1406 .help = "Use sha1 checksums for verification",
1409 .oval = VERIFY_SHA256,
1410 .help = "Use sha256 checksums for verification",
1413 .oval = VERIFY_SHA512,
1414 .help = "Use sha512 checksums for verification",
1417 .oval = VERIFY_META,
1418 .help = "Use io information",
1422 .oval = VERIFY_NULL,
1423 .help = "Pretend to verify",
1428 .name = "do_verify",
1429 .type = FIO_OPT_BOOL,
1430 .off1 = td_var_offset(do_verify),
1431 .help = "Run verification stage after write",
1436 .name = "verifysort",
1437 .type = FIO_OPT_BOOL,
1438 .off1 = td_var_offset(verifysort),
1439 .help = "Sort written verify blocks for read back",
1444 .name = "verify_interval",
1445 .type = FIO_OPT_INT,
1446 .off1 = td_var_offset(verify_interval),
1447 .minval = 2 * sizeof(struct verify_header),
1448 .help = "Store verify buffer header every N bytes",
1452 .name = "verify_offset",
1453 .type = FIO_OPT_INT,
1454 .help = "Offset verify header location by N bytes",
1456 .cb = str_verify_offset_cb,
1460 .name = "verify_pattern",
1461 .type = FIO_OPT_STR,
1462 .cb = str_verify_pattern_cb,
1463 .help = "Fill pattern for IO buffers",
1467 .name = "verify_fatal",
1468 .type = FIO_OPT_BOOL,
1469 .off1 = td_var_offset(verify_fatal),
1471 .help = "Exit on a single verify failure, don't continue",
1475 .name = "verify_dump",
1476 .type = FIO_OPT_BOOL,
1477 .off1 = td_var_offset(verify_dump),
1479 .help = "Dump contents of good and bad blocks on failure",
1483 .name = "verify_async",
1484 .type = FIO_OPT_INT,
1485 .off1 = td_var_offset(verify_async),
1487 .help = "Number of async verifier threads to use",
1491 .name = "verify_backlog",
1492 .type = FIO_OPT_STR_VAL,
1493 .off1 = td_var_offset(verify_backlog),
1494 .help = "Verify after this number of blocks are written",
1498 .name = "verify_backlog_batch",
1499 .type = FIO_OPT_INT,
1500 .off1 = td_var_offset(verify_batch),
1501 .help = "Verify this number of IO blocks",
1504 #ifdef FIO_HAVE_CPU_AFFINITY
1506 .name = "verify_async_cpus",
1507 .type = FIO_OPT_STR,
1508 .cb = str_verify_cpus_allowed_cb,
1509 .help = "Set CPUs allowed for async verify threads",
1510 .parent = "verify_async",
1513 #ifdef FIO_HAVE_TRIM
1515 .name = "trim_percentage",
1516 .type = FIO_OPT_INT,
1517 .cb = str_verify_trim_cb,
1519 .help = "Number of verify blocks to discard/trim",
1524 .name = "trim_verify_zero",
1525 .type = FIO_OPT_INT,
1526 .help = "Verify that trim/discarded blocks are returned as zeroes",
1527 .off1 = td_var_offset(trim_zero),
1528 .parent = "trim_percentage",
1532 .name = "trim_backlog",
1533 .type = FIO_OPT_STR_VAL,
1534 .off1 = td_var_offset(trim_backlog),
1535 .help = "Trim after this number of blocks are written",
1536 .parent = "trim_percentage",
1539 .name = "trim_backlog_batch",
1540 .type = FIO_OPT_INT,
1541 .off1 = td_var_offset(trim_batch),
1542 .help = "Trim this number of IO blocks",
1543 .parent = "trim_percentage",
1547 .name = "write_iolog",
1548 .type = FIO_OPT_STR_STORE,
1549 .off1 = td_var_offset(write_iolog_file),
1550 .help = "Store IO pattern to file",
1553 .name = "read_iolog",
1554 .type = FIO_OPT_STR_STORE,
1555 .off1 = td_var_offset(read_iolog_file),
1556 .help = "Playback IO pattern from file",
1559 .name = "replay_no_stall",
1560 .type = FIO_OPT_INT,
1561 .off1 = td_var_offset(no_stall),
1563 .parent = "read_iolog",
1564 .help = "Playback IO pattern file as fast as possible without stalls",
1567 .name = "replay_redirect",
1568 .type = FIO_OPT_STR_STORE,
1569 .off1 = td_var_offset(replay_redirect),
1570 .parent = "read_iolog",
1571 .help = "Replay all I/O onto this device, regardless of trace device",
1574 .name = "exec_prerun",
1575 .type = FIO_OPT_STR_STORE,
1576 .off1 = td_var_offset(exec_prerun),
1577 .help = "Execute this file prior to running job",
1580 .name = "exec_postrun",
1581 .type = FIO_OPT_STR_STORE,
1582 .off1 = td_var_offset(exec_postrun),
1583 .help = "Execute this file after running job",
1585 #ifdef FIO_HAVE_IOSCHED_SWITCH
1587 .name = "ioscheduler",
1588 .type = FIO_OPT_STR_STORE,
1589 .off1 = td_var_offset(ioscheduler),
1590 .help = "Use this IO scheduler on the backing device",
1595 .type = FIO_OPT_STR_VAL,
1596 .off1 = td_var_offset(zone_size),
1597 .help = "Give size of an IO zone",
1602 .type = FIO_OPT_STR_VAL,
1603 .off1 = td_var_offset(zone_skip),
1604 .help = "Space between IO zones",
1609 .type = FIO_OPT_STR_VAL,
1610 .cb = str_lockmem_cb,
1611 .help = "Lock down this amount of memory",
1615 .name = "rwmixread",
1616 .type = FIO_OPT_INT,
1617 .cb = str_rwmix_read_cb,
1619 .help = "Percentage of mixed workload that is reads",
1623 .name = "rwmixwrite",
1624 .type = FIO_OPT_INT,
1625 .cb = str_rwmix_write_cb,
1627 .help = "Percentage of mixed workload that is writes",
1631 .name = "rwmixcycle",
1632 .type = FIO_OPT_DEPRECATED,
1636 .type = FIO_OPT_INT,
1637 .off1 = td_var_offset(nice),
1638 .help = "Set job CPU nice value",
1643 #ifdef FIO_HAVE_IOPRIO
1646 .type = FIO_OPT_INT,
1648 .help = "Set job IO priority value",
1653 .name = "prioclass",
1654 .type = FIO_OPT_INT,
1655 .cb = str_prioclass_cb,
1656 .help = "Set job IO priority class",
1662 .name = "thinktime",
1663 .type = FIO_OPT_INT,
1664 .off1 = td_var_offset(thinktime),
1665 .help = "Idle time between IO buffers (usec)",
1669 .name = "thinktime_spin",
1670 .type = FIO_OPT_INT,
1671 .off1 = td_var_offset(thinktime_spin),
1672 .help = "Start think time by spinning this amount (usec)",
1674 .parent = "thinktime",
1677 .name = "thinktime_blocks",
1678 .type = FIO_OPT_INT,
1679 .off1 = td_var_offset(thinktime_blocks),
1680 .help = "IO buffer period between 'thinktime'",
1682 .parent = "thinktime",
1686 .type = FIO_OPT_INT,
1687 .off1 = td_var_offset(rate[0]),
1688 .off2 = td_var_offset(rate[1]),
1689 .help = "Set bandwidth rate",
1693 .type = FIO_OPT_INT,
1694 .off1 = td_var_offset(ratemin[0]),
1695 .off2 = td_var_offset(ratemin[1]),
1696 .help = "Job must meet this rate or it will be shutdown",
1700 .name = "rate_iops",
1701 .type = FIO_OPT_INT,
1702 .off1 = td_var_offset(rate_iops[0]),
1703 .off2 = td_var_offset(rate_iops[1]),
1704 .help = "Limit IO used to this number of IO operations/sec",
1707 .name = "rate_iops_min",
1708 .type = FIO_OPT_INT,
1709 .off1 = td_var_offset(rate_iops_min[0]),
1710 .off2 = td_var_offset(rate_iops_min[1]),
1711 .help = "Job must meet this rate or it will be shut down",
1712 .parent = "rate_iops",
1715 .name = "ratecycle",
1716 .type = FIO_OPT_INT,
1717 .off1 = td_var_offset(ratecycle),
1718 .help = "Window average for rate limits (msec)",
1723 .name = "invalidate",
1724 .type = FIO_OPT_BOOL,
1725 .off1 = td_var_offset(invalidate_cache),
1726 .help = "Invalidate buffer/page cache prior to running job",
1731 .type = FIO_OPT_BOOL,
1732 .off1 = td_var_offset(sync_io),
1733 .help = "Use O_SYNC for buffered writes",
1735 .parent = "buffered",
1738 .name = "bwavgtime",
1739 .type = FIO_OPT_INT,
1740 .off1 = td_var_offset(bw_avg_time),
1741 .help = "Time window over which to calculate bandwidth"
1746 .name = "create_serialize",
1747 .type = FIO_OPT_BOOL,
1748 .off1 = td_var_offset(create_serialize),
1749 .help = "Serialize creating of job files",
1753 .name = "create_fsync",
1754 .type = FIO_OPT_BOOL,
1755 .off1 = td_var_offset(create_fsync),
1756 .help = "fsync file after creation",
1760 .name = "create_on_open",
1761 .type = FIO_OPT_BOOL,
1762 .off1 = td_var_offset(create_on_open),
1763 .help = "Create files when they are opened for IO",
1768 .type = FIO_OPT_BOOL,
1769 .off1 = td_var_offset(pre_read),
1770 .help = "Pre-read files before starting official testing",
1775 .type = FIO_OPT_INT,
1776 .off1 = td_var_offset(cpuload),
1777 .help = "Use this percentage of CPU",
1780 .name = "cpuchunks",
1781 .type = FIO_OPT_INT,
1782 .off1 = td_var_offset(cpucycle),
1783 .help = "Length of the CPU burn cycles (usecs)",
1785 .parent = "cpuload",
1787 #ifdef FIO_HAVE_CPU_AFFINITY
1790 .type = FIO_OPT_INT,
1791 .cb = str_cpumask_cb,
1792 .help = "CPU affinity mask",
1795 .name = "cpus_allowed",
1796 .type = FIO_OPT_STR,
1797 .cb = str_cpus_allowed_cb,
1798 .help = "Set CPUs allowed",
1802 .name = "end_fsync",
1803 .type = FIO_OPT_BOOL,
1804 .off1 = td_var_offset(end_fsync),
1805 .help = "Include fsync at the end of job",
1809 .name = "fsync_on_close",
1810 .type = FIO_OPT_BOOL,
1811 .off1 = td_var_offset(fsync_on_close),
1812 .help = "fsync files on close",
1817 .type = FIO_OPT_BOOL,
1818 .off1 = td_var_offset(unlink),
1819 .help = "Unlink created files after job has completed",
1824 .type = FIO_OPT_STR_SET,
1825 .cb = str_exitall_cb,
1826 .help = "Terminate all jobs when one exits",
1829 .name = "stonewall",
1830 .type = FIO_OPT_STR_SET,
1831 .off1 = td_var_offset(stonewall),
1832 .help = "Insert a hard barrier between this job and previous",
1835 .name = "new_group",
1836 .type = FIO_OPT_STR_SET,
1837 .off1 = td_var_offset(new_group),
1838 .help = "Mark the start of a new group (for reporting)",
1842 .type = FIO_OPT_STR_SET,
1843 .off1 = td_var_offset(use_thread),
1844 .help = "Use threads instead of forks",
1847 .name = "write_bw_log",
1848 .type = FIO_OPT_STR,
1849 .off1 = td_var_offset(write_bw_log),
1850 .cb = str_write_bw_log_cb,
1851 .help = "Write log of bandwidth during run",
1854 .name = "write_lat_log",
1855 .type = FIO_OPT_STR,
1856 .off1 = td_var_offset(write_lat_log),
1857 .cb = str_write_lat_log_cb,
1858 .help = "Write log of latency during run",
1861 .name = "hugepage-size",
1862 .type = FIO_OPT_INT,
1863 .off1 = td_var_offset(hugepage_size),
1864 .help = "When using hugepages, specify size of each page",
1865 .def = __stringify(FIO_HUGE_PAGE),
1868 .name = "group_reporting",
1869 .type = FIO_OPT_STR_SET,
1870 .off1 = td_var_offset(group_reporting),
1871 .help = "Do reporting on a per-group basis",
1874 .name = "zero_buffers",
1875 .type = FIO_OPT_STR_SET,
1876 .off1 = td_var_offset(zero_buffers),
1877 .help = "Init IO buffers to all zeroes",
1880 .name = "refill_buffers",
1881 .type = FIO_OPT_STR_SET,
1882 .off1 = td_var_offset(refill_buffers),
1883 .help = "Refill IO buffers on every IO submit",
1885 #ifdef FIO_HAVE_DISK_UTIL
1887 .name = "disk_util",
1888 .type = FIO_OPT_BOOL,
1889 .off1 = td_var_offset(do_disk_util),
1890 .help = "Log disk utilization statistics",
1895 .name = "gtod_reduce",
1896 .type = FIO_OPT_BOOL,
1897 .help = "Greatly reduce number of gettimeofday() calls",
1898 .cb = str_gtod_reduce_cb,
1902 .name = "disable_lat",
1903 .type = FIO_OPT_BOOL,
1904 .off1 = td_var_offset(disable_lat),
1905 .help = "Disable latency numbers",
1906 .parent = "gtod_reduce",
1910 .name = "disable_clat",
1911 .type = FIO_OPT_BOOL,
1912 .off1 = td_var_offset(disable_clat),
1913 .help = "Disable completion latency numbers",
1914 .parent = "gtod_reduce",
1918 .name = "disable_slat",
1919 .type = FIO_OPT_BOOL,
1920 .off1 = td_var_offset(disable_slat),
1921 .help = "Disable submission latency numbers",
1922 .parent = "gtod_reduce",
1926 .name = "disable_bw_measurement",
1927 .type = FIO_OPT_BOOL,
1928 .off1 = td_var_offset(disable_bw),
1929 .help = "Disable bandwidth logging",
1930 .parent = "gtod_reduce",
1935 .type = FIO_OPT_INT,
1936 .cb = str_gtod_cpu_cb,
1937 .help = "Set up dedicated gettimeofday() thread on this CPU",
1938 .verify = gtod_cpu_verify,
1941 .name = "continue_on_error",
1942 .type = FIO_OPT_BOOL,
1943 .off1 = td_var_offset(continue_on_error),
1944 .help = "Continue on non-fatal errors during IO",
1949 .type = FIO_OPT_STR_STORE,
1950 .off1 = td_var_offset(profile),
1951 .help = "Select a specific builtin performance test",
1955 .type = FIO_OPT_STR_STORE,
1956 .off1 = td_var_offset(cgroup),
1957 .help = "Add job to cgroup of this name",
1960 .name = "cgroup_weight",
1961 .type = FIO_OPT_INT,
1962 .off1 = td_var_offset(cgroup_weight),
1963 .help = "Use given weight for cgroup",
1968 .name = "cgroup_nodelete",
1969 .type = FIO_OPT_BOOL,
1970 .off1 = td_var_offset(cgroup_nodelete),
1971 .help = "Do not delete cgroups after job completion",
1976 .type = FIO_OPT_INT,
1977 .off1 = td_var_offset(uid),
1978 .help = "Run job with this user ID",
1982 .type = FIO_OPT_INT,
1983 .off1 = td_var_offset(gid),
1984 .help = "Run job with this group ID",
1991 static void add_to_lopt(struct option *lopt, struct fio_option *o,
1994 lopt->name = (char *) name;
1995 lopt->val = FIO_GETOPT_JOB;
1996 if (o->type == FIO_OPT_STR_SET)
1997 lopt->has_arg = no_argument;
1999 lopt->has_arg = required_argument;
2002 void fio_options_dup_and_init(struct option *long_options)
2004 struct fio_option *o;
2007 options_init(options);
2010 while (long_options[i].name)
2015 add_to_lopt(&long_options[i], o, o->name);
2018 add_to_lopt(&long_options[i], o, o->alias);
2023 assert(i < FIO_NR_OPTIONS);
2027 struct fio_keyword {
2033 static struct fio_keyword fio_keywords[] = {
2035 .word = "$pagesize",
2036 .desc = "Page size in the system",
2039 .word = "$mb_memory",
2040 .desc = "Megabytes of memory online",
2044 .desc = "Number of CPUs online in the system",
2051 void fio_keywords_init(void)
2053 unsigned long long mb_memory;
2057 sprintf(buf, "%lu", page_size);
2058 fio_keywords[0].replace = strdup(buf);
2060 mb_memory = os_phys_mem() / page_size;
2061 sprintf(buf, "%llu", mb_memory);
2062 fio_keywords[1].replace = strdup(buf);
2064 l = sysconf(_SC_NPROCESSORS_ONLN);
2065 sprintf(buf, "%lu", l);
2066 fio_keywords[2].replace = strdup(buf);
2071 static char *bc_calc(char *str)
2073 char *buf, *tmp, opt[80];
2078 * No math, just return string
2080 if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2085 * Split option from value, we only need to calculate the value
2087 tmp = strchr(str, '=');
2092 memset(opt, 0, sizeof(opt));
2093 strncpy(opt, str, tmp - str);
2097 sprintf(buf, "which %s > /dev/null", BC_APP);
2099 log_err("fio: bc is needed for performing math\n");
2104 sprintf(buf, "echo %s | %s", tmp, BC_APP);
2105 f = popen(buf, "r");
2111 ret = fread(buf, 1, 128, f);
2117 buf[ret - 1] = '\0';
2126 * Look for reserved variable names and replace them with real values
2128 static char *fio_keyword_replace(char *opt)
2133 for (i = 0; fio_keywords[i].word != NULL; i++) {
2134 struct fio_keyword *kw = &fio_keywords[i];
2136 while ((s = strstr(opt, kw->word)) != NULL) {
2137 char *new = malloc(strlen(opt) + 1);
2143 * Copy part of the string before the keyword and
2144 * sprintf() the replacement after it.
2146 memcpy(new, opt, olen);
2147 len = sprintf(new + olen, "%s", kw->replace);
2150 * If there's more in the original string, copy that
2153 opt += strlen(kw->word) + olen;
2155 memcpy(new + olen + len, opt, opt - o_org - 1);
2158 * replace opt and free the old opt
2164 * Check for potential math and invoke bc, if possible
2173 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2177 sort_options(opts, options, num_opts);
2179 for (ret = 0, i = 0; i < num_opts; i++) {
2180 opts[i] = fio_keyword_replace(opts[i]);
2181 ret |= parse_option(opts[i], options, td);
2187 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2189 return parse_cmd_option(opt, val, options, td);
2192 void fio_fill_default_options(struct thread_data *td)
2194 fill_default_options(td, options);
2197 int fio_show_option_help(const char *opt)
2199 return show_cmd_help(options, opt);
2202 static void __options_mem(struct thread_data *td, int alloc)
2204 struct thread_options *o = &td->o;
2205 struct fio_option *opt;
2209 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
2210 if (opt->type != FIO_OPT_STR_STORE)
2213 ptr = (void *) o + opt->off1;
2216 *ptr = strdup(*ptr);
2226 * dupe FIO_OPT_STR_STORE options
2228 void options_mem_dupe(struct thread_data *td)
2230 __options_mem(td, 1);
2233 void options_mem_free(struct thread_data fio_unused *td)
2236 __options_mem(td, 0);
2240 unsigned int fio_get_kb_base(void *data)
2242 struct thread_data *td = data;
2243 unsigned int kb_base = 0;
2246 kb_base = td->o.kb_base;
2253 int add_option(struct fio_option *o)
2255 struct fio_option *__o;
2264 memcpy(&options[opt_index], o, sizeof(*o));
2268 void invalidate_profile_options(const char *prof_name)
2270 struct fio_option *o;
2274 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2275 o->type = FIO_OPT_INVALID;
2276 o->prof_name = NULL;
2282 void add_opt_posval(const char *optname, const char *ival, const char *help)
2284 struct fio_option *o;
2287 o = find_option(options, optname);
2291 for (i = 0; i < PARSE_MAX_VP; i++) {
2292 if (o->posval[i].ival)
2295 o->posval[i].ival = ival;
2296 o->posval[i].help = help;
2301 void del_opt_posval(const char *optname, const char *ival)
2303 struct fio_option *o;
2306 o = find_option(options, optname);
2310 for (i = 0; i < PARSE_MAX_VP; i++) {
2311 if (!o->posval[i].ival)
2313 if (strcmp(o->posval[i].ival, ival))
2316 o->posval[i].ival = NULL;
2317 o->posval[i].help = NULL;