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",
921 .def = FIO_PREFERRED_ENGINE,
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",
1041 .type = FIO_OPT_BOOL,
1042 .off1 = td_var_offset(fill_device),
1043 .help = "Write until an ENOSPC error occurs",
1048 .type = FIO_OPT_STR_VAL,
1049 .off1 = td_var_offset(file_size_low),
1050 .off2 = td_var_offset(file_size_high),
1052 .help = "Size of individual files",
1056 .alias = "fileoffset",
1057 .type = FIO_OPT_STR_VAL,
1058 .off1 = td_var_offset(start_offset),
1059 .help = "Start IO from this offset",
1064 .alias = "blocksize",
1065 .type = FIO_OPT_INT,
1066 .off1 = td_var_offset(bs[DDIR_READ]),
1067 .off2 = td_var_offset(bs[DDIR_WRITE]),
1069 .help = "Block size unit",
1075 .alias = "blockalign",
1076 .type = FIO_OPT_INT,
1077 .off1 = td_var_offset(ba[DDIR_READ]),
1078 .off2 = td_var_offset(ba[DDIR_WRITE]),
1080 .help = "IO block offset alignment",
1085 .alias = "blocksize_range",
1086 .type = FIO_OPT_RANGE,
1087 .off1 = td_var_offset(min_bs[DDIR_READ]),
1088 .off2 = td_var_offset(max_bs[DDIR_READ]),
1089 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1090 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1092 .help = "Set block size range (in more detail than bs)",
1097 .type = FIO_OPT_STR,
1098 .cb = str_bssplit_cb,
1099 .help = "Set a specific mix of block sizes",
1103 .name = "bs_unaligned",
1104 .alias = "blocksize_unaligned",
1105 .type = FIO_OPT_STR_SET,
1106 .off1 = td_var_offset(bs_unaligned),
1107 .help = "Don't sector align IO buffer sizes",
1111 .name = "randrepeat",
1112 .type = FIO_OPT_BOOL,
1113 .off1 = td_var_offset(rand_repeatable),
1114 .help = "Use repeatable random IO pattern",
1119 .name = "norandommap",
1120 .type = FIO_OPT_STR_SET,
1121 .off1 = td_var_offset(norandommap),
1122 .help = "Accept potential duplicate random blocks",
1126 .name = "softrandommap",
1127 .type = FIO_OPT_BOOL,
1128 .off1 = td_var_offset(softrandommap),
1129 .help = "Set norandommap if randommap allocation fails",
1130 .parent = "norandommap",
1135 .alias = "nr_files",
1136 .type = FIO_OPT_INT,
1137 .off1 = td_var_offset(nr_files),
1138 .help = "Split job workload between this number of files",
1142 .name = "openfiles",
1143 .type = FIO_OPT_INT,
1144 .off1 = td_var_offset(open_files),
1145 .help = "Number of files to keep open at the same time",
1148 .name = "file_service_type",
1149 .type = FIO_OPT_STR,
1151 .off1 = td_var_offset(file_service_type),
1152 .help = "How to select which file to service next",
1153 .def = "roundrobin",
1156 .oval = FIO_FSERVICE_RANDOM,
1157 .help = "Choose a file at random",
1159 { .ival = "roundrobin",
1160 .oval = FIO_FSERVICE_RR,
1161 .help = "Round robin select files",
1163 { .ival = "sequential",
1164 .oval = FIO_FSERVICE_SEQ,
1165 .help = "Finish one file before moving to the next",
1168 .parent = "nrfiles",
1170 #ifdef FIO_HAVE_FALLOCATE
1172 .name = "fallocate",
1173 .type = FIO_OPT_BOOL,
1174 .off1 = td_var_offset(fallocate),
1175 .help = "Use fallocate() when laying out files",
1180 .name = "fadvise_hint",
1181 .type = FIO_OPT_BOOL,
1182 .off1 = td_var_offset(fadvise_hint),
1183 .help = "Use fadvise() to advise the kernel on IO pattern",
1188 .type = FIO_OPT_INT,
1189 .off1 = td_var_offset(fsync_blocks),
1190 .help = "Issue fsync for writes every given number of blocks",
1194 .name = "fdatasync",
1195 .type = FIO_OPT_INT,
1196 .off1 = td_var_offset(fdatasync_blocks),
1197 .help = "Issue fdatasync for writes every given number of blocks",
1201 .name = "write_barrier",
1202 .type = FIO_OPT_INT,
1203 .off1 = td_var_offset(barrier_blocks),
1204 .help = "Make every Nth write a barrier write",
1207 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1209 .name = "sync_file_range",
1211 { .ival = "wait_before",
1212 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1213 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1217 .oval = SYNC_FILE_RANGE_WRITE,
1218 .help = "SYNC_FILE_RANGE_WRITE",
1222 .ival = "wait_after",
1223 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1224 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1228 .type = FIO_OPT_STR_MULTI,
1230 .off1 = td_var_offset(sync_file_range),
1231 .help = "Use sync_file_range()",
1236 .type = FIO_OPT_BOOL,
1237 .off1 = td_var_offset(odirect),
1238 .help = "Use O_DIRECT IO (negates buffered)",
1243 .type = FIO_OPT_BOOL,
1244 .off1 = td_var_offset(odirect),
1246 .help = "Use buffered IO (negates direct)",
1250 .name = "overwrite",
1251 .type = FIO_OPT_BOOL,
1252 .off1 = td_var_offset(overwrite),
1253 .help = "When writing, set whether to overwrite current data",
1258 .type = FIO_OPT_INT,
1259 .off1 = td_var_offset(loops),
1260 .help = "Number of times to run the job",
1265 .type = FIO_OPT_INT,
1266 .off1 = td_var_offset(numjobs),
1267 .help = "Duplicate this job this many times",
1271 .name = "startdelay",
1272 .type = FIO_OPT_STR_VAL_TIME,
1273 .off1 = td_var_offset(start_delay),
1274 .help = "Only start job when this period has passed",
1280 .type = FIO_OPT_STR_VAL_TIME,
1281 .off1 = td_var_offset(timeout),
1282 .help = "Stop workload when this amount of time has passed",
1286 .name = "time_based",
1287 .type = FIO_OPT_STR_SET,
1288 .off1 = td_var_offset(time_based),
1289 .help = "Keep running until runtime/timeout is met",
1292 .name = "ramp_time",
1293 .type = FIO_OPT_STR_VAL_TIME,
1294 .off1 = td_var_offset(ramp_time),
1295 .help = "Ramp up time before measuring performance",
1298 .name = "clocksource",
1299 .type = FIO_OPT_STR,
1300 .cb = fio_clock_source_cb,
1301 .off1 = td_var_offset(clocksource),
1302 .help = "What type of timing source to use",
1304 { .ival = "gettimeofday",
1306 .help = "Use gettimeofday(2) for timing",
1308 { .ival = "clock_gettime",
1309 .oval = CS_CGETTIME,
1310 .help = "Use clock_gettime(2) for timing",
1312 #ifdef ARCH_HAVE_CPU_CLOCK
1314 .oval = CS_CPUCLOCK,
1315 .help = "Use CPU private clock",
1323 .type = FIO_OPT_STR,
1325 .off1 = td_var_offset(mem_type),
1326 .help = "Backing type for IO buffers",
1331 .help = "Use malloc(3) for IO buffers",
1335 .help = "Use shared memory segments for IO buffers",
1337 #ifdef FIO_HAVE_HUGETLB
1338 { .ival = "shmhuge",
1339 .oval = MEM_SHMHUGE,
1340 .help = "Like shm, but use huge pages",
1345 .help = "Use mmap(2) (file or anon) for IO buffers",
1347 #ifdef FIO_HAVE_HUGETLB
1348 { .ival = "mmaphuge",
1349 .oval = MEM_MMAPHUGE,
1350 .help = "Like mmap, but use huge pages",
1356 .name = "iomem_align",
1357 .alias = "mem_align",
1358 .type = FIO_OPT_INT,
1359 .off1 = td_var_offset(mem_align),
1361 .help = "IO memory buffer offset alignment",
1367 .type = FIO_OPT_STR,
1368 .off1 = td_var_offset(verify),
1369 .help = "Verify data written",
1370 .cb = str_verify_cb,
1374 .oval = VERIFY_NONE,
1375 .help = "Don't do IO verification",
1379 .help = "Use md5 checksums for verification",
1382 .oval = VERIFY_CRC64,
1383 .help = "Use crc64 checksums for verification",
1386 .oval = VERIFY_CRC32,
1387 .help = "Use crc32 checksums for verification",
1389 { .ival = "crc32c-intel",
1390 .oval = VERIFY_CRC32C_INTEL,
1391 .help = "Use hw crc32c checksums for verification",
1394 .oval = VERIFY_CRC32C,
1395 .help = "Use crc32c checksums for verification",
1398 .oval = VERIFY_CRC16,
1399 .help = "Use crc16 checksums for verification",
1402 .oval = VERIFY_CRC7,
1403 .help = "Use crc7 checksums for verification",
1406 .oval = VERIFY_SHA1,
1407 .help = "Use sha1 checksums for verification",
1410 .oval = VERIFY_SHA256,
1411 .help = "Use sha256 checksums for verification",
1414 .oval = VERIFY_SHA512,
1415 .help = "Use sha512 checksums for verification",
1418 .oval = VERIFY_META,
1419 .help = "Use io information",
1423 .oval = VERIFY_NULL,
1424 .help = "Pretend to verify",
1429 .name = "do_verify",
1430 .type = FIO_OPT_BOOL,
1431 .off1 = td_var_offset(do_verify),
1432 .help = "Run verification stage after write",
1437 .name = "verifysort",
1438 .type = FIO_OPT_BOOL,
1439 .off1 = td_var_offset(verifysort),
1440 .help = "Sort written verify blocks for read back",
1445 .name = "verify_interval",
1446 .type = FIO_OPT_INT,
1447 .off1 = td_var_offset(verify_interval),
1448 .minval = 2 * sizeof(struct verify_header),
1449 .help = "Store verify buffer header every N bytes",
1453 .name = "verify_offset",
1454 .type = FIO_OPT_INT,
1455 .help = "Offset verify header location by N bytes",
1457 .cb = str_verify_offset_cb,
1461 .name = "verify_pattern",
1462 .type = FIO_OPT_STR,
1463 .cb = str_verify_pattern_cb,
1464 .help = "Fill pattern for IO buffers",
1468 .name = "verify_fatal",
1469 .type = FIO_OPT_BOOL,
1470 .off1 = td_var_offset(verify_fatal),
1472 .help = "Exit on a single verify failure, don't continue",
1476 .name = "verify_dump",
1477 .type = FIO_OPT_BOOL,
1478 .off1 = td_var_offset(verify_dump),
1480 .help = "Dump contents of good and bad blocks on failure",
1484 .name = "verify_async",
1485 .type = FIO_OPT_INT,
1486 .off1 = td_var_offset(verify_async),
1488 .help = "Number of async verifier threads to use",
1492 .name = "verify_backlog",
1493 .type = FIO_OPT_STR_VAL,
1494 .off1 = td_var_offset(verify_backlog),
1495 .help = "Verify after this number of blocks are written",
1499 .name = "verify_backlog_batch",
1500 .type = FIO_OPT_INT,
1501 .off1 = td_var_offset(verify_batch),
1502 .help = "Verify this number of IO blocks",
1505 #ifdef FIO_HAVE_CPU_AFFINITY
1507 .name = "verify_async_cpus",
1508 .type = FIO_OPT_STR,
1509 .cb = str_verify_cpus_allowed_cb,
1510 .help = "Set CPUs allowed for async verify threads",
1511 .parent = "verify_async",
1514 #ifdef FIO_HAVE_TRIM
1516 .name = "trim_percentage",
1517 .type = FIO_OPT_INT,
1518 .cb = str_verify_trim_cb,
1520 .help = "Number of verify blocks to discard/trim",
1525 .name = "trim_verify_zero",
1526 .type = FIO_OPT_INT,
1527 .help = "Verify that trim/discarded blocks are returned as zeroes",
1528 .off1 = td_var_offset(trim_zero),
1529 .parent = "trim_percentage",
1533 .name = "trim_backlog",
1534 .type = FIO_OPT_STR_VAL,
1535 .off1 = td_var_offset(trim_backlog),
1536 .help = "Trim after this number of blocks are written",
1537 .parent = "trim_percentage",
1540 .name = "trim_backlog_batch",
1541 .type = FIO_OPT_INT,
1542 .off1 = td_var_offset(trim_batch),
1543 .help = "Trim this number of IO blocks",
1544 .parent = "trim_percentage",
1548 .name = "write_iolog",
1549 .type = FIO_OPT_STR_STORE,
1550 .off1 = td_var_offset(write_iolog_file),
1551 .help = "Store IO pattern to file",
1554 .name = "read_iolog",
1555 .type = FIO_OPT_STR_STORE,
1556 .off1 = td_var_offset(read_iolog_file),
1557 .help = "Playback IO pattern from file",
1560 .name = "replay_no_stall",
1561 .type = FIO_OPT_INT,
1562 .off1 = td_var_offset(no_stall),
1564 .parent = "read_iolog",
1565 .help = "Playback IO pattern file as fast as possible without stalls",
1568 .name = "replay_redirect",
1569 .type = FIO_OPT_STR_STORE,
1570 .off1 = td_var_offset(replay_redirect),
1571 .parent = "read_iolog",
1572 .help = "Replay all I/O onto this device, regardless of trace device",
1575 .name = "exec_prerun",
1576 .type = FIO_OPT_STR_STORE,
1577 .off1 = td_var_offset(exec_prerun),
1578 .help = "Execute this file prior to running job",
1581 .name = "exec_postrun",
1582 .type = FIO_OPT_STR_STORE,
1583 .off1 = td_var_offset(exec_postrun),
1584 .help = "Execute this file after running job",
1586 #ifdef FIO_HAVE_IOSCHED_SWITCH
1588 .name = "ioscheduler",
1589 .type = FIO_OPT_STR_STORE,
1590 .off1 = td_var_offset(ioscheduler),
1591 .help = "Use this IO scheduler on the backing device",
1596 .type = FIO_OPT_STR_VAL,
1597 .off1 = td_var_offset(zone_size),
1598 .help = "Give size of an IO zone",
1603 .type = FIO_OPT_STR_VAL,
1604 .off1 = td_var_offset(zone_skip),
1605 .help = "Space between IO zones",
1610 .type = FIO_OPT_STR_VAL,
1611 .cb = str_lockmem_cb,
1612 .help = "Lock down this amount of memory",
1616 .name = "rwmixread",
1617 .type = FIO_OPT_INT,
1618 .cb = str_rwmix_read_cb,
1620 .help = "Percentage of mixed workload that is reads",
1624 .name = "rwmixwrite",
1625 .type = FIO_OPT_INT,
1626 .cb = str_rwmix_write_cb,
1628 .help = "Percentage of mixed workload that is writes",
1632 .name = "rwmixcycle",
1633 .type = FIO_OPT_DEPRECATED,
1637 .type = FIO_OPT_INT,
1638 .off1 = td_var_offset(nice),
1639 .help = "Set job CPU nice value",
1644 #ifdef FIO_HAVE_IOPRIO
1647 .type = FIO_OPT_INT,
1649 .help = "Set job IO priority value",
1654 .name = "prioclass",
1655 .type = FIO_OPT_INT,
1656 .cb = str_prioclass_cb,
1657 .help = "Set job IO priority class",
1663 .name = "thinktime",
1664 .type = FIO_OPT_INT,
1665 .off1 = td_var_offset(thinktime),
1666 .help = "Idle time between IO buffers (usec)",
1670 .name = "thinktime_spin",
1671 .type = FIO_OPT_INT,
1672 .off1 = td_var_offset(thinktime_spin),
1673 .help = "Start think time by spinning this amount (usec)",
1675 .parent = "thinktime",
1678 .name = "thinktime_blocks",
1679 .type = FIO_OPT_INT,
1680 .off1 = td_var_offset(thinktime_blocks),
1681 .help = "IO buffer period between 'thinktime'",
1683 .parent = "thinktime",
1687 .type = FIO_OPT_INT,
1688 .off1 = td_var_offset(rate[0]),
1689 .off2 = td_var_offset(rate[1]),
1690 .help = "Set bandwidth rate",
1694 .type = FIO_OPT_INT,
1695 .off1 = td_var_offset(ratemin[0]),
1696 .off2 = td_var_offset(ratemin[1]),
1697 .help = "Job must meet this rate or it will be shutdown",
1701 .name = "rate_iops",
1702 .type = FIO_OPT_INT,
1703 .off1 = td_var_offset(rate_iops[0]),
1704 .off2 = td_var_offset(rate_iops[1]),
1705 .help = "Limit IO used to this number of IO operations/sec",
1708 .name = "rate_iops_min",
1709 .type = FIO_OPT_INT,
1710 .off1 = td_var_offset(rate_iops_min[0]),
1711 .off2 = td_var_offset(rate_iops_min[1]),
1712 .help = "Job must meet this rate or it will be shut down",
1713 .parent = "rate_iops",
1716 .name = "ratecycle",
1717 .type = FIO_OPT_INT,
1718 .off1 = td_var_offset(ratecycle),
1719 .help = "Window average for rate limits (msec)",
1724 .name = "invalidate",
1725 .type = FIO_OPT_BOOL,
1726 .off1 = td_var_offset(invalidate_cache),
1727 .help = "Invalidate buffer/page cache prior to running job",
1732 .type = FIO_OPT_BOOL,
1733 .off1 = td_var_offset(sync_io),
1734 .help = "Use O_SYNC for buffered writes",
1736 .parent = "buffered",
1739 .name = "bwavgtime",
1740 .type = FIO_OPT_INT,
1741 .off1 = td_var_offset(bw_avg_time),
1742 .help = "Time window over which to calculate bandwidth"
1747 .name = "create_serialize",
1748 .type = FIO_OPT_BOOL,
1749 .off1 = td_var_offset(create_serialize),
1750 .help = "Serialize creating of job files",
1754 .name = "create_fsync",
1755 .type = FIO_OPT_BOOL,
1756 .off1 = td_var_offset(create_fsync),
1757 .help = "fsync file after creation",
1761 .name = "create_on_open",
1762 .type = FIO_OPT_BOOL,
1763 .off1 = td_var_offset(create_on_open),
1764 .help = "Create files when they are opened for IO",
1769 .type = FIO_OPT_BOOL,
1770 .off1 = td_var_offset(pre_read),
1771 .help = "Pre-read files before starting official testing",
1776 .type = FIO_OPT_INT,
1777 .off1 = td_var_offset(cpuload),
1778 .help = "Use this percentage of CPU",
1781 .name = "cpuchunks",
1782 .type = FIO_OPT_INT,
1783 .off1 = td_var_offset(cpucycle),
1784 .help = "Length of the CPU burn cycles (usecs)",
1786 .parent = "cpuload",
1788 #ifdef FIO_HAVE_CPU_AFFINITY
1791 .type = FIO_OPT_INT,
1792 .cb = str_cpumask_cb,
1793 .help = "CPU affinity mask",
1796 .name = "cpus_allowed",
1797 .type = FIO_OPT_STR,
1798 .cb = str_cpus_allowed_cb,
1799 .help = "Set CPUs allowed",
1803 .name = "end_fsync",
1804 .type = FIO_OPT_BOOL,
1805 .off1 = td_var_offset(end_fsync),
1806 .help = "Include fsync at the end of job",
1810 .name = "fsync_on_close",
1811 .type = FIO_OPT_BOOL,
1812 .off1 = td_var_offset(fsync_on_close),
1813 .help = "fsync files on close",
1818 .type = FIO_OPT_BOOL,
1819 .off1 = td_var_offset(unlink),
1820 .help = "Unlink created files after job has completed",
1825 .type = FIO_OPT_STR_SET,
1826 .cb = str_exitall_cb,
1827 .help = "Terminate all jobs when one exits",
1830 .name = "stonewall",
1831 .type = FIO_OPT_STR_SET,
1832 .off1 = td_var_offset(stonewall),
1833 .help = "Insert a hard barrier between this job and previous",
1836 .name = "new_group",
1837 .type = FIO_OPT_STR_SET,
1838 .off1 = td_var_offset(new_group),
1839 .help = "Mark the start of a new group (for reporting)",
1843 .type = FIO_OPT_STR_SET,
1844 .off1 = td_var_offset(use_thread),
1845 .help = "Use threads instead of forks",
1848 .name = "write_bw_log",
1849 .type = FIO_OPT_STR,
1850 .off1 = td_var_offset(write_bw_log),
1851 .cb = str_write_bw_log_cb,
1852 .help = "Write log of bandwidth during run",
1855 .name = "write_lat_log",
1856 .type = FIO_OPT_STR,
1857 .off1 = td_var_offset(write_lat_log),
1858 .cb = str_write_lat_log_cb,
1859 .help = "Write log of latency during run",
1862 .name = "hugepage-size",
1863 .type = FIO_OPT_INT,
1864 .off1 = td_var_offset(hugepage_size),
1865 .help = "When using hugepages, specify size of each page",
1866 .def = __stringify(FIO_HUGE_PAGE),
1869 .name = "group_reporting",
1870 .type = FIO_OPT_STR_SET,
1871 .off1 = td_var_offset(group_reporting),
1872 .help = "Do reporting on a per-group basis",
1875 .name = "zero_buffers",
1876 .type = FIO_OPT_STR_SET,
1877 .off1 = td_var_offset(zero_buffers),
1878 .help = "Init IO buffers to all zeroes",
1881 .name = "refill_buffers",
1882 .type = FIO_OPT_STR_SET,
1883 .off1 = td_var_offset(refill_buffers),
1884 .help = "Refill IO buffers on every IO submit",
1886 #ifdef FIO_HAVE_DISK_UTIL
1888 .name = "disk_util",
1889 .type = FIO_OPT_BOOL,
1890 .off1 = td_var_offset(do_disk_util),
1891 .help = "Log disk utilization statistics",
1896 .name = "gtod_reduce",
1897 .type = FIO_OPT_BOOL,
1898 .help = "Greatly reduce number of gettimeofday() calls",
1899 .cb = str_gtod_reduce_cb,
1903 .name = "disable_lat",
1904 .type = FIO_OPT_BOOL,
1905 .off1 = td_var_offset(disable_lat),
1906 .help = "Disable latency numbers",
1907 .parent = "gtod_reduce",
1911 .name = "disable_clat",
1912 .type = FIO_OPT_BOOL,
1913 .off1 = td_var_offset(disable_clat),
1914 .help = "Disable completion latency numbers",
1915 .parent = "gtod_reduce",
1919 .name = "disable_slat",
1920 .type = FIO_OPT_BOOL,
1921 .off1 = td_var_offset(disable_slat),
1922 .help = "Disable submission latency numbers",
1923 .parent = "gtod_reduce",
1927 .name = "disable_bw_measurement",
1928 .type = FIO_OPT_BOOL,
1929 .off1 = td_var_offset(disable_bw),
1930 .help = "Disable bandwidth logging",
1931 .parent = "gtod_reduce",
1936 .type = FIO_OPT_INT,
1937 .cb = str_gtod_cpu_cb,
1938 .help = "Set up dedicated gettimeofday() thread on this CPU",
1939 .verify = gtod_cpu_verify,
1942 .name = "continue_on_error",
1943 .type = FIO_OPT_BOOL,
1944 .off1 = td_var_offset(continue_on_error),
1945 .help = "Continue on non-fatal errors during IO",
1950 .type = FIO_OPT_STR_STORE,
1951 .off1 = td_var_offset(profile),
1952 .help = "Select a specific builtin performance test",
1956 .type = FIO_OPT_STR_STORE,
1957 .off1 = td_var_offset(cgroup),
1958 .help = "Add job to cgroup of this name",
1961 .name = "cgroup_weight",
1962 .type = FIO_OPT_INT,
1963 .off1 = td_var_offset(cgroup_weight),
1964 .help = "Use given weight for cgroup",
1969 .name = "cgroup_nodelete",
1970 .type = FIO_OPT_BOOL,
1971 .off1 = td_var_offset(cgroup_nodelete),
1972 .help = "Do not delete cgroups after job completion",
1977 .type = FIO_OPT_INT,
1978 .off1 = td_var_offset(uid),
1979 .help = "Run job with this user ID",
1983 .type = FIO_OPT_INT,
1984 .off1 = td_var_offset(gid),
1985 .help = "Run job with this group ID",
1992 static void add_to_lopt(struct option *lopt, struct fio_option *o,
1995 lopt->name = (char *) name;
1996 lopt->val = FIO_GETOPT_JOB;
1997 if (o->type == FIO_OPT_STR_SET)
1998 lopt->has_arg = no_argument;
2000 lopt->has_arg = required_argument;
2003 void fio_options_dup_and_init(struct option *long_options)
2005 struct fio_option *o;
2008 options_init(options);
2011 while (long_options[i].name)
2016 add_to_lopt(&long_options[i], o, o->name);
2019 add_to_lopt(&long_options[i], o, o->alias);
2024 assert(i < FIO_NR_OPTIONS);
2028 struct fio_keyword {
2034 static struct fio_keyword fio_keywords[] = {
2036 .word = "$pagesize",
2037 .desc = "Page size in the system",
2040 .word = "$mb_memory",
2041 .desc = "Megabytes of memory online",
2045 .desc = "Number of CPUs online in the system",
2052 void fio_keywords_init(void)
2054 unsigned long long mb_memory;
2058 sprintf(buf, "%lu", page_size);
2059 fio_keywords[0].replace = strdup(buf);
2061 mb_memory = os_phys_mem() / page_size;
2062 sprintf(buf, "%llu", mb_memory);
2063 fio_keywords[1].replace = strdup(buf);
2065 l = sysconf(_SC_NPROCESSORS_ONLN);
2066 sprintf(buf, "%lu", l);
2067 fio_keywords[2].replace = strdup(buf);
2072 static char *bc_calc(char *str)
2074 char *buf, *tmp, opt[80];
2079 * No math, just return string
2081 if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2086 * Split option from value, we only need to calculate the value
2088 tmp = strchr(str, '=');
2093 memset(opt, 0, sizeof(opt));
2094 strncpy(opt, str, tmp - str);
2098 sprintf(buf, "which %s > /dev/null", BC_APP);
2100 log_err("fio: bc is needed for performing math\n");
2105 sprintf(buf, "echo %s | %s", tmp, BC_APP);
2106 f = popen(buf, "r");
2112 ret = fread(buf, 1, 128, f);
2118 buf[ret - 1] = '\0';
2127 * Look for reserved variable names and replace them with real values
2129 static char *fio_keyword_replace(char *opt)
2134 for (i = 0; fio_keywords[i].word != NULL; i++) {
2135 struct fio_keyword *kw = &fio_keywords[i];
2137 while ((s = strstr(opt, kw->word)) != NULL) {
2138 char *new = malloc(strlen(opt) + 1);
2144 * Copy part of the string before the keyword and
2145 * sprintf() the replacement after it.
2147 memcpy(new, opt, olen);
2148 len = sprintf(new + olen, "%s", kw->replace);
2151 * If there's more in the original string, copy that
2154 opt += strlen(kw->word) + olen;
2156 memcpy(new + olen + len, opt, opt - o_org - 1);
2159 * replace opt and free the old opt
2165 * Check for potential math and invoke bc, if possible
2174 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2178 sort_options(opts, options, num_opts);
2180 for (ret = 0, i = 0; i < num_opts; i++) {
2181 opts[i] = fio_keyword_replace(opts[i]);
2182 ret |= parse_option(opts[i], options, td);
2188 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2190 return parse_cmd_option(opt, val, options, td);
2193 void fio_fill_default_options(struct thread_data *td)
2195 fill_default_options(td, options);
2198 int fio_show_option_help(const char *opt)
2200 return show_cmd_help(options, opt);
2203 static void __options_mem(struct thread_data *td, int alloc)
2205 struct thread_options *o = &td->o;
2206 struct fio_option *opt;
2210 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
2211 if (opt->type != FIO_OPT_STR_STORE)
2214 ptr = (void *) o + opt->off1;
2217 *ptr = strdup(*ptr);
2227 * dupe FIO_OPT_STR_STORE options
2229 void options_mem_dupe(struct thread_data *td)
2231 __options_mem(td, 1);
2234 void options_mem_free(struct thread_data fio_unused *td)
2237 __options_mem(td, 0);
2241 unsigned int fio_get_kb_base(void *data)
2243 struct thread_data *td = data;
2244 unsigned int kb_base = 0;
2247 kb_base = td->o.kb_base;
2254 int add_option(struct fio_option *o)
2256 struct fio_option *__o;
2265 memcpy(&options[opt_index], o, sizeof(*o));
2269 void invalidate_profile_options(const char *prof_name)
2271 struct fio_option *o;
2275 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2276 o->type = FIO_OPT_INVALID;
2277 o->prof_name = NULL;
2283 void add_opt_posval(const char *optname, const char *ival, const char *help)
2285 struct fio_option *o;
2288 o = find_option(options, optname);
2292 for (i = 0; i < PARSE_MAX_VP; i++) {
2293 if (o->posval[i].ival)
2296 o->posval[i].ival = ival;
2297 o->posval[i].help = help;
2302 void del_opt_posval(const char *optname, const char *ival)
2304 struct fio_option *o;
2307 o = find_option(options, optname);
2311 for (i = 0; i < PARSE_MAX_VP; i++) {
2312 if (!o->posval[i].ival)
2314 if (strcmp(o->posval[i].ival, ival))
2317 o->posval[i].ival = NULL;
2318 o->posval[i].help = NULL;