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;
443 static int str_fst_cb(void *data, const char *str)
445 struct thread_data *td = data;
446 char *nr = get_opt_postfix(str);
448 td->file_service_nr = 1;
450 td->file_service_nr = atoi(nr);
457 #ifdef FIO_HAVE_SYNC_FILE_RANGE
458 static int str_sfr_cb(void *data, const char *str)
460 struct thread_data *td = data;
461 char *nr = get_opt_postfix(str);
463 td->sync_file_range_nr = 1;
465 td->sync_file_range_nr = atoi(nr);
473 static int check_dir(struct thread_data *td, char *fname)
475 char file[PATH_MAX], *dir;
478 if (td->o.directory) {
479 strcpy(file, td->o.directory);
484 sprintf(file + elen, "%s", fname);
491 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
492 * yet, so we can't do this check right here...
494 if (lstat(dir, &sb) < 0) {
497 log_err("fio: %s is not a directory\n", dir);
498 td_verror(td, ret, "lstat");
502 if (!S_ISDIR(sb.st_mode)) {
503 log_err("fio: %s is not a directory\n", dir);
513 * Return next file in the string. Files are separated with ':'. If the ':'
514 * is escaped with a '\', then that ':' is part of the filename and does not
515 * indicate a new file.
517 static char *get_next_file_name(char **ptr)
522 if (!str || !strlen(str))
528 * No colon, we are done
530 p = strchr(str, ':');
537 * We got a colon, but it's the first character. Skip and
545 if (*(p - 1) != '\\') {
551 memmove(p - 1, p, strlen(p) + 1);
558 static int str_filename_cb(void *data, const char *input)
560 struct thread_data *td = data;
561 char *fname, *str, *p;
563 p = str = strdup(input);
565 strip_blank_front(&str);
566 strip_blank_end(str);
568 if (!td->files_index)
571 while ((fname = get_next_file_name(&str)) != NULL) {
574 if (check_dir(td, fname)) {
586 static int str_directory_cb(void *data, const char fio_unused *str)
588 struct thread_data *td = data;
591 if (lstat(td->o.directory, &sb) < 0) {
594 log_err("fio: %s is not a directory\n", td->o.directory);
595 td_verror(td, ret, "lstat");
598 if (!S_ISDIR(sb.st_mode)) {
599 log_err("fio: %s is not a directory\n", td->o.directory);
606 static int str_opendir_cb(void *data, const char fio_unused *str)
608 struct thread_data *td = data;
610 if (!td->files_index)
613 return add_dir_files(td, td->o.opendir);
616 static int str_verify_offset_cb(void *data, unsigned long long *off)
618 struct thread_data *td = data;
620 if (*off && *off < sizeof(struct verify_header)) {
621 log_err("fio: verify_offset too small\n");
625 td->o.verify_offset = *off;
629 static int str_verify_pattern_cb(void *data, const char *input)
631 struct thread_data *td = data;
633 int i = 0, j = 0, len, k, base = 10;
636 loc1 = strstr(input, "0x");
637 loc2 = strstr(input, "0X");
640 off = strtol(input, NULL, base);
641 if (off != LONG_MAX || errno != ERANGE) {
643 td->o.verify_pattern[i] = off & 0xff;
652 j = loc1 - input + 2;
654 j = loc2 - input + 2;
657 if (len - j < MAX_PATTERN_SIZE * 2) {
659 off = converthexchartoint(input[k--]);
661 off += (converthexchartoint(input[k--])
663 td->o.verify_pattern[i++] = (char) off;
667 td->o.verify_pattern_bytes = i;
671 static int str_lockfile_cb(void *data, const char *str)
673 struct thread_data *td = data;
674 char *nr = get_opt_postfix(str);
676 td->o.lockfile_batch = 1;
678 td->o.lockfile_batch = atoi(nr);
685 static int str_write_bw_log_cb(void *data, const char *str)
687 struct thread_data *td = data;
690 td->o.bw_log_file = strdup(str);
692 td->o.write_bw_log = 1;
696 static int str_write_lat_log_cb(void *data, const char *str)
698 struct thread_data *td = data;
701 td->o.lat_log_file = strdup(str);
703 td->o.write_lat_log = 1;
707 static int str_gtod_reduce_cb(void *data, int *il)
709 struct thread_data *td = data;
712 td->o.disable_lat = !!val;
713 td->o.disable_clat = !!val;
714 td->o.disable_slat = !!val;
715 td->o.disable_bw = !!val;
717 td->tv_cache_mask = 63;
722 static int str_gtod_cpu_cb(void *data, long long *il)
724 struct thread_data *td = data;
727 td->o.gtod_cpu = val;
728 td->o.gtod_offload = 1;
732 static int rw_verify(struct fio_option *o, void *data)
734 struct thread_data *td = data;
736 if (read_only && td_write(td)) {
737 log_err("fio: job <%s> has write bit set, but fio is in"
738 " read-only mode\n", td->o.name);
745 static int gtod_cpu_verify(struct fio_option *o, void *data)
747 #ifndef FIO_HAVE_CPU_AFFINITY
748 struct thread_data *td = data;
750 if (td->o.gtod_cpu) {
751 log_err("fio: platform must support CPU affinity for"
752 "gettimeofday() offloading\n");
760 static int kb_base_verify(struct fio_option *o, void *data)
762 struct thread_data *td = data;
764 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
765 log_err("fio: kb_base set to nonsensical value: %u\n",
773 #define __stringify_1(x) #x
774 #define __stringify(x) __stringify_1(x)
777 * Map of job/command line options
779 static struct fio_option options[FIO_MAX_OPTS] = {
781 .name = "description",
782 .type = FIO_OPT_STR_STORE,
783 .off1 = td_var_offset(description),
784 .help = "Text job description",
788 .type = FIO_OPT_STR_STORE,
789 .off1 = td_var_offset(name),
790 .help = "Name of this job",
794 .type = FIO_OPT_STR_STORE,
795 .off1 = td_var_offset(directory),
796 .cb = str_directory_cb,
797 .help = "Directory to store files in",
801 .type = FIO_OPT_STR_STORE,
802 .off1 = td_var_offset(filename),
803 .cb = str_filename_cb,
804 .prio = -1, /* must come after "directory" */
805 .help = "File(s) to use for the workload",
810 .off1 = td_var_offset(kb_base),
811 .verify = kb_base_verify,
814 .help = "How many bytes per KB for reporting (1000 or 1024)",
819 .cb = str_lockfile_cb,
820 .off1 = td_var_offset(file_lock_mode),
821 .help = "Lock file when doing IO to it",
822 .parent = "filename",
826 .oval = FILE_LOCK_NONE,
827 .help = "No file locking",
829 { .ival = "exclusive",
830 .oval = FILE_LOCK_EXCLUSIVE,
831 .help = "Exclusive file lock",
835 .oval = FILE_LOCK_READWRITE,
836 .help = "Read vs write lock",
842 .type = FIO_OPT_STR_STORE,
843 .off1 = td_var_offset(opendir),
844 .cb = str_opendir_cb,
845 .help = "Recursively add files from this directory and down",
849 .alias = "readwrite",
852 .off1 = td_var_offset(td_ddir),
853 .help = "IO direction",
858 .oval = TD_DDIR_READ,
859 .help = "Sequential read",
862 .oval = TD_DDIR_WRITE,
863 .help = "Sequential write",
865 { .ival = "randread",
866 .oval = TD_DDIR_RANDREAD,
867 .help = "Random read",
869 { .ival = "randwrite",
870 .oval = TD_DDIR_RANDWRITE,
871 .help = "Random write",
875 .help = "Sequential read and write mix",
878 .oval = TD_DDIR_RANDRW,
879 .help = "Random read and write mix"
884 .name = "rw_sequencer",
886 .off1 = td_var_offset(rw_seq),
887 .help = "IO offset generator modifier",
890 { .ival = "sequential",
892 .help = "Generate sequential offsets",
894 { .ival = "identical",
895 .oval = RW_SEQ_IDENT,
896 .help = "Generate identical offsets",
903 .type = FIO_OPT_STR_STORE,
904 .off1 = td_var_offset(ioengine),
905 .help = "IO engine to use",
909 .help = "Use read/write",
912 .help = "Use pread/pwrite",
915 .help = "Use readv/writev",
917 #ifdef FIO_HAVE_LIBAIO
919 .help = "Linux native asynchronous IO",
922 #ifdef FIO_HAVE_POSIXAIO
923 { .ival = "posixaio",
924 .help = "POSIX asynchronous IO",
927 #ifdef FIO_HAVE_SOLARISAIO
928 { .ival = "solarisaio",
929 .help = "Solaris native asynchronous IO",
933 .help = "Memory mapped IO",
935 #ifdef FIO_HAVE_SPLICE
937 .help = "splice/vmsplice based IO",
939 { .ival = "netsplice",
940 .help = "splice/vmsplice to/from the network",
945 .help = "SCSI generic v3 IO",
949 .help = "Testing engine (no data transfer)",
952 .help = "Network IO",
954 #ifdef FIO_HAVE_SYSLET
955 { .ival = "syslet-rw",
956 .help = "syslet enabled async pread/pwrite IO",
960 .help = "CPU cycler burner engine",
962 #ifdef FIO_HAVE_GUASI
964 .help = "GUASI IO engine",
967 { .ival = "external",
968 .help = "Load external engine (append name)",
975 .off1 = td_var_offset(iodepth),
976 .help = "Amount of IO buffers to keep in flight",
981 .name = "iodepth_batch",
982 .alias = "iodepth_batch_submit",
984 .off1 = td_var_offset(iodepth_batch),
985 .help = "Number of IO buffers to submit in one go",
991 .name = "iodepth_batch_complete",
993 .off1 = td_var_offset(iodepth_batch_complete),
994 .help = "Number of IO buffers to retrieve in one go",
1000 .name = "iodepth_low",
1001 .type = FIO_OPT_INT,
1002 .off1 = td_var_offset(iodepth_low),
1003 .help = "Low water mark for queuing depth",
1004 .parent = "iodepth",
1008 .type = FIO_OPT_STR_VAL,
1009 .off1 = td_var_offset(size),
1011 .help = "Total size of device or files",
1014 .name = "fill_device",
1015 .type = FIO_OPT_BOOL,
1016 .off1 = td_var_offset(fill_device),
1017 .help = "Write until an ENOSPC error occurs",
1022 .type = FIO_OPT_STR_VAL,
1023 .off1 = td_var_offset(file_size_low),
1024 .off2 = td_var_offset(file_size_high),
1026 .help = "Size of individual files",
1030 .alias = "fileoffset",
1031 .type = FIO_OPT_STR_VAL,
1032 .off1 = td_var_offset(start_offset),
1033 .help = "Start IO from this offset",
1038 .alias = "blocksize",
1039 .type = FIO_OPT_INT,
1040 .off1 = td_var_offset(bs[DDIR_READ]),
1041 .off2 = td_var_offset(bs[DDIR_WRITE]),
1043 .help = "Block size unit",
1049 .alias = "blockalign",
1050 .type = FIO_OPT_INT,
1051 .off1 = td_var_offset(ba[DDIR_READ]),
1052 .off2 = td_var_offset(ba[DDIR_WRITE]),
1054 .help = "IO block offset alignment",
1059 .alias = "blocksize_range",
1060 .type = FIO_OPT_RANGE,
1061 .off1 = td_var_offset(min_bs[DDIR_READ]),
1062 .off2 = td_var_offset(max_bs[DDIR_READ]),
1063 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1064 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
1066 .help = "Set block size range (in more detail than bs)",
1071 .type = FIO_OPT_STR,
1072 .cb = str_bssplit_cb,
1073 .help = "Set a specific mix of block sizes",
1077 .name = "bs_unaligned",
1078 .alias = "blocksize_unaligned",
1079 .type = FIO_OPT_STR_SET,
1080 .off1 = td_var_offset(bs_unaligned),
1081 .help = "Don't sector align IO buffer sizes",
1085 .name = "randrepeat",
1086 .type = FIO_OPT_BOOL,
1087 .off1 = td_var_offset(rand_repeatable),
1088 .help = "Use repeatable random IO pattern",
1093 .name = "norandommap",
1094 .type = FIO_OPT_STR_SET,
1095 .off1 = td_var_offset(norandommap),
1096 .help = "Accept potential duplicate random blocks",
1100 .name = "softrandommap",
1101 .type = FIO_OPT_BOOL,
1102 .off1 = td_var_offset(softrandommap),
1103 .help = "Set norandommap if randommap allocation fails",
1104 .parent = "norandommap",
1109 .type = FIO_OPT_INT,
1110 .off1 = td_var_offset(nr_files),
1111 .help = "Split job workload between this number of files",
1115 .name = "openfiles",
1116 .type = FIO_OPT_INT,
1117 .off1 = td_var_offset(open_files),
1118 .help = "Number of files to keep open at the same time",
1121 .name = "file_service_type",
1122 .type = FIO_OPT_STR,
1124 .off1 = td_var_offset(file_service_type),
1125 .help = "How to select which file to service next",
1126 .def = "roundrobin",
1129 .oval = FIO_FSERVICE_RANDOM,
1130 .help = "Choose a file at random",
1132 { .ival = "roundrobin",
1133 .oval = FIO_FSERVICE_RR,
1134 .help = "Round robin select files",
1136 { .ival = "sequential",
1137 .oval = FIO_FSERVICE_SEQ,
1138 .help = "Finish one file before moving to the next",
1141 .parent = "nrfiles",
1143 #ifdef FIO_HAVE_FALLOCATE
1145 .name = "fallocate",
1146 .type = FIO_OPT_BOOL,
1147 .off1 = td_var_offset(fallocate),
1148 .help = "Use fallocate() when laying out files",
1153 .name = "fadvise_hint",
1154 .type = FIO_OPT_BOOL,
1155 .off1 = td_var_offset(fadvise_hint),
1156 .help = "Use fadvise() to advise the kernel on IO pattern",
1161 .type = FIO_OPT_INT,
1162 .off1 = td_var_offset(fsync_blocks),
1163 .help = "Issue fsync for writes every given number of blocks",
1167 .name = "fdatasync",
1168 .type = FIO_OPT_INT,
1169 .off1 = td_var_offset(fdatasync_blocks),
1170 .help = "Issue fdatasync for writes every given number of blocks",
1173 #ifdef FIO_HAVE_SYNC_FILE_RANGE
1175 .name = "sync_file_range",
1177 { .ival = "wait_before",
1178 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1179 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
1183 .oval = SYNC_FILE_RANGE_WRITE,
1184 .help = "SYNC_FILE_RANGE_WRITE",
1188 .ival = "wait_after",
1189 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1190 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
1194 .type = FIO_OPT_STR_MULTI,
1196 .off1 = td_var_offset(sync_file_range),
1197 .help = "Use sync_file_range()",
1202 .type = FIO_OPT_BOOL,
1203 .off1 = td_var_offset(odirect),
1204 .help = "Use O_DIRECT IO (negates buffered)",
1209 .type = FIO_OPT_BOOL,
1210 .off1 = td_var_offset(odirect),
1212 .help = "Use buffered IO (negates direct)",
1216 .name = "overwrite",
1217 .type = FIO_OPT_BOOL,
1218 .off1 = td_var_offset(overwrite),
1219 .help = "When writing, set whether to overwrite current data",
1224 .type = FIO_OPT_INT,
1225 .off1 = td_var_offset(loops),
1226 .help = "Number of times to run the job",
1231 .type = FIO_OPT_INT,
1232 .off1 = td_var_offset(numjobs),
1233 .help = "Duplicate this job this many times",
1237 .name = "startdelay",
1238 .type = FIO_OPT_STR_VAL_TIME,
1239 .off1 = td_var_offset(start_delay),
1240 .help = "Only start job when this period has passed",
1246 .type = FIO_OPT_STR_VAL_TIME,
1247 .off1 = td_var_offset(timeout),
1248 .help = "Stop workload when this amount of time has passed",
1252 .name = "time_based",
1253 .type = FIO_OPT_STR_SET,
1254 .off1 = td_var_offset(time_based),
1255 .help = "Keep running until runtime/timeout is met",
1258 .name = "ramp_time",
1259 .type = FIO_OPT_STR_VAL_TIME,
1260 .off1 = td_var_offset(ramp_time),
1261 .help = "Ramp up time before measuring performance",
1264 .name = "clocksource",
1265 .type = FIO_OPT_STR,
1266 .cb = fio_clock_source_cb,
1267 .off1 = td_var_offset(clocksource),
1268 .help = "What type of timing source to use",
1270 { .ival = "gettimeofday",
1272 .help = "Use gettimeofday(2) for timing",
1274 { .ival = "clock_gettime",
1275 .oval = CS_CGETTIME,
1276 .help = "Use clock_gettime(2) for timing",
1278 #ifdef ARCH_HAVE_CPU_CLOCK
1280 .oval = CS_CPUCLOCK,
1281 .help = "Use CPU private clock",
1289 .type = FIO_OPT_STR,
1291 .off1 = td_var_offset(mem_type),
1292 .help = "Backing type for IO buffers",
1297 .help = "Use malloc(3) for IO buffers",
1301 .help = "Use shared memory segments for IO buffers",
1303 #ifdef FIO_HAVE_HUGETLB
1304 { .ival = "shmhuge",
1305 .oval = MEM_SHMHUGE,
1306 .help = "Like shm, but use huge pages",
1311 .help = "Use mmap(2) (file or anon) for IO buffers",
1313 #ifdef FIO_HAVE_HUGETLB
1314 { .ival = "mmaphuge",
1315 .oval = MEM_MMAPHUGE,
1316 .help = "Like mmap, but use huge pages",
1322 .name = "iomem_align",
1323 .alias = "mem_align",
1324 .type = FIO_OPT_INT,
1325 .off1 = td_var_offset(mem_align),
1327 .help = "IO memory buffer offset alignment",
1333 .type = FIO_OPT_STR,
1334 .off1 = td_var_offset(verify),
1335 .help = "Verify data written",
1336 .cb = str_verify_cb,
1340 .oval = VERIFY_NONE,
1341 .help = "Don't do IO verification",
1345 .help = "Use md5 checksums for verification",
1348 .oval = VERIFY_CRC64,
1349 .help = "Use crc64 checksums for verification",
1352 .oval = VERIFY_CRC32,
1353 .help = "Use crc32 checksums for verification",
1355 { .ival = "crc32c-intel",
1356 .oval = VERIFY_CRC32C_INTEL,
1357 .help = "Use hw crc32c checksums for verification",
1360 .oval = VERIFY_CRC32C,
1361 .help = "Use crc32c checksums for verification",
1364 .oval = VERIFY_CRC16,
1365 .help = "Use crc16 checksums for verification",
1368 .oval = VERIFY_CRC7,
1369 .help = "Use crc7 checksums for verification",
1372 .oval = VERIFY_SHA1,
1373 .help = "Use sha1 checksums for verification",
1376 .oval = VERIFY_SHA256,
1377 .help = "Use sha256 checksums for verification",
1380 .oval = VERIFY_SHA512,
1381 .help = "Use sha512 checksums for verification",
1384 .oval = VERIFY_META,
1385 .help = "Use io information",
1389 .oval = VERIFY_NULL,
1390 .help = "Pretend to verify",
1395 .name = "do_verify",
1396 .type = FIO_OPT_BOOL,
1397 .off1 = td_var_offset(do_verify),
1398 .help = "Run verification stage after write",
1403 .name = "verifysort",
1404 .type = FIO_OPT_BOOL,
1405 .off1 = td_var_offset(verifysort),
1406 .help = "Sort written verify blocks for read back",
1411 .name = "verify_interval",
1412 .type = FIO_OPT_INT,
1413 .off1 = td_var_offset(verify_interval),
1414 .minval = 2 * sizeof(struct verify_header),
1415 .help = "Store verify buffer header every N bytes",
1419 .name = "verify_offset",
1420 .type = FIO_OPT_INT,
1421 .help = "Offset verify header location by N bytes",
1423 .cb = str_verify_offset_cb,
1427 .name = "verify_pattern",
1428 .type = FIO_OPT_STR,
1429 .cb = str_verify_pattern_cb,
1430 .help = "Fill pattern for IO buffers",
1434 .name = "verify_fatal",
1435 .type = FIO_OPT_BOOL,
1436 .off1 = td_var_offset(verify_fatal),
1438 .help = "Exit on a single verify failure, don't continue",
1442 .name = "verify_async",
1443 .type = FIO_OPT_INT,
1444 .off1 = td_var_offset(verify_async),
1446 .help = "Number of async verifier threads to use",
1450 .name = "verify_backlog",
1451 .type = FIO_OPT_STR_VAL,
1452 .off1 = td_var_offset(verify_backlog),
1453 .help = "Verify after this number of blocks are written",
1457 .name = "verify_backlog_batch",
1458 .type = FIO_OPT_INT,
1459 .off1 = td_var_offset(verify_batch),
1460 .help = "Verify this number of IO blocks",
1461 .parent = "verify_backlog",
1463 #ifdef FIO_HAVE_CPU_AFFINITY
1465 .name = "verify_async_cpus",
1466 .type = FIO_OPT_STR,
1467 .cb = str_verify_cpus_allowed_cb,
1468 .help = "Set CPUs allowed for async verify threads",
1469 .parent = "verify_async",
1473 .name = "write_iolog",
1474 .type = FIO_OPT_STR_STORE,
1475 .off1 = td_var_offset(write_iolog_file),
1476 .help = "Store IO pattern to file",
1479 .name = "read_iolog",
1480 .type = FIO_OPT_STR_STORE,
1481 .off1 = td_var_offset(read_iolog_file),
1482 .help = "Playback IO pattern from file",
1485 .name = "exec_prerun",
1486 .type = FIO_OPT_STR_STORE,
1487 .off1 = td_var_offset(exec_prerun),
1488 .help = "Execute this file prior to running job",
1491 .name = "exec_postrun",
1492 .type = FIO_OPT_STR_STORE,
1493 .off1 = td_var_offset(exec_postrun),
1494 .help = "Execute this file after running job",
1496 #ifdef FIO_HAVE_IOSCHED_SWITCH
1498 .name = "ioscheduler",
1499 .type = FIO_OPT_STR_STORE,
1500 .off1 = td_var_offset(ioscheduler),
1501 .help = "Use this IO scheduler on the backing device",
1506 .type = FIO_OPT_STR_VAL,
1507 .off1 = td_var_offset(zone_size),
1508 .help = "Give size of an IO zone",
1513 .type = FIO_OPT_STR_VAL,
1514 .off1 = td_var_offset(zone_skip),
1515 .help = "Space between IO zones",
1520 .type = FIO_OPT_STR_VAL,
1521 .cb = str_lockmem_cb,
1522 .help = "Lock down this amount of memory",
1526 .name = "rwmixread",
1527 .type = FIO_OPT_INT,
1528 .cb = str_rwmix_read_cb,
1530 .help = "Percentage of mixed workload that is reads",
1534 .name = "rwmixwrite",
1535 .type = FIO_OPT_INT,
1536 .cb = str_rwmix_write_cb,
1538 .help = "Percentage of mixed workload that is writes",
1542 .name = "rwmixcycle",
1543 .type = FIO_OPT_DEPRECATED,
1547 .type = FIO_OPT_INT,
1548 .off1 = td_var_offset(nice),
1549 .help = "Set job CPU nice value",
1554 #ifdef FIO_HAVE_IOPRIO
1557 .type = FIO_OPT_INT,
1559 .help = "Set job IO priority value",
1564 .name = "prioclass",
1565 .type = FIO_OPT_INT,
1566 .cb = str_prioclass_cb,
1567 .help = "Set job IO priority class",
1573 .name = "thinktime",
1574 .type = FIO_OPT_INT,
1575 .off1 = td_var_offset(thinktime),
1576 .help = "Idle time between IO buffers (usec)",
1580 .name = "thinktime_spin",
1581 .type = FIO_OPT_INT,
1582 .off1 = td_var_offset(thinktime_spin),
1583 .help = "Start think time by spinning this amount (usec)",
1585 .parent = "thinktime",
1588 .name = "thinktime_blocks",
1589 .type = FIO_OPT_INT,
1590 .off1 = td_var_offset(thinktime_blocks),
1591 .help = "IO buffer period between 'thinktime'",
1593 .parent = "thinktime",
1597 .type = FIO_OPT_INT,
1598 .off1 = td_var_offset(rate[0]),
1599 .off2 = td_var_offset(rate[1]),
1600 .help = "Set bandwidth rate",
1604 .type = FIO_OPT_INT,
1605 .off1 = td_var_offset(ratemin[0]),
1606 .off2 = td_var_offset(ratemin[1]),
1607 .help = "Job must meet this rate or it will be shutdown",
1611 .name = "rate_iops",
1612 .type = FIO_OPT_INT,
1613 .off1 = td_var_offset(rate_iops[0]),
1614 .off2 = td_var_offset(rate_iops[1]),
1615 .help = "Limit IO used to this number of IO operations/sec",
1618 .name = "rate_iops_min",
1619 .type = FIO_OPT_INT,
1620 .off1 = td_var_offset(rate_iops_min[0]),
1621 .off2 = td_var_offset(rate_iops_min[1]),
1622 .help = "Job must meet this rate or it will be shutdown",
1623 .parent = "rate_iops",
1626 .name = "ratecycle",
1627 .type = FIO_OPT_INT,
1628 .off1 = td_var_offset(ratecycle),
1629 .help = "Window average for rate limits (msec)",
1634 .name = "invalidate",
1635 .type = FIO_OPT_BOOL,
1636 .off1 = td_var_offset(invalidate_cache),
1637 .help = "Invalidate buffer/page cache prior to running job",
1642 .type = FIO_OPT_BOOL,
1643 .off1 = td_var_offset(sync_io),
1644 .help = "Use O_SYNC for buffered writes",
1646 .parent = "buffered",
1649 .name = "bwavgtime",
1650 .type = FIO_OPT_INT,
1651 .off1 = td_var_offset(bw_avg_time),
1652 .help = "Time window over which to calculate bandwidth"
1657 .name = "create_serialize",
1658 .type = FIO_OPT_BOOL,
1659 .off1 = td_var_offset(create_serialize),
1660 .help = "Serialize creating of job files",
1664 .name = "create_fsync",
1665 .type = FIO_OPT_BOOL,
1666 .off1 = td_var_offset(create_fsync),
1667 .help = "Fsync file after creation",
1671 .name = "create_on_open",
1672 .type = FIO_OPT_BOOL,
1673 .off1 = td_var_offset(create_on_open),
1674 .help = "Create files when they are opened for IO",
1679 .type = FIO_OPT_BOOL,
1680 .off1 = td_var_offset(pre_read),
1681 .help = "Preread files before starting official testing",
1686 .type = FIO_OPT_INT,
1687 .off1 = td_var_offset(cpuload),
1688 .help = "Use this percentage of CPU",
1691 .name = "cpuchunks",
1692 .type = FIO_OPT_INT,
1693 .off1 = td_var_offset(cpucycle),
1694 .help = "Length of the CPU burn cycles (usecs)",
1696 .parent = "cpuload",
1698 #ifdef FIO_HAVE_CPU_AFFINITY
1701 .type = FIO_OPT_INT,
1702 .cb = str_cpumask_cb,
1703 .help = "CPU affinity mask",
1706 .name = "cpus_allowed",
1707 .type = FIO_OPT_STR,
1708 .cb = str_cpus_allowed_cb,
1709 .help = "Set CPUs allowed",
1713 .name = "end_fsync",
1714 .type = FIO_OPT_BOOL,
1715 .off1 = td_var_offset(end_fsync),
1716 .help = "Include fsync at the end of job",
1720 .name = "fsync_on_close",
1721 .type = FIO_OPT_BOOL,
1722 .off1 = td_var_offset(fsync_on_close),
1723 .help = "fsync files on close",
1728 .type = FIO_OPT_BOOL,
1729 .off1 = td_var_offset(unlink),
1730 .help = "Unlink created files after job has completed",
1735 .type = FIO_OPT_STR_SET,
1736 .cb = str_exitall_cb,
1737 .help = "Terminate all jobs when one exits",
1740 .name = "stonewall",
1741 .type = FIO_OPT_STR_SET,
1742 .off1 = td_var_offset(stonewall),
1743 .help = "Insert a hard barrier between this job and previous",
1746 .name = "new_group",
1747 .type = FIO_OPT_STR_SET,
1748 .off1 = td_var_offset(new_group),
1749 .help = "Mark the start of a new group (for reporting)",
1753 .type = FIO_OPT_STR_SET,
1754 .off1 = td_var_offset(use_thread),
1755 .help = "Use threads instead of forks",
1758 .name = "write_bw_log",
1759 .type = FIO_OPT_STR,
1760 .off1 = td_var_offset(write_bw_log),
1761 .cb = str_write_bw_log_cb,
1762 .help = "Write log of bandwidth during run",
1765 .name = "write_lat_log",
1766 .type = FIO_OPT_STR,
1767 .off1 = td_var_offset(write_lat_log),
1768 .cb = str_write_lat_log_cb,
1769 .help = "Write log of latency during run",
1772 .name = "hugepage-size",
1773 .type = FIO_OPT_INT,
1774 .off1 = td_var_offset(hugepage_size),
1775 .help = "When using hugepages, specify size of each page",
1776 .def = __stringify(FIO_HUGE_PAGE),
1779 .name = "group_reporting",
1780 .type = FIO_OPT_STR_SET,
1781 .off1 = td_var_offset(group_reporting),
1782 .help = "Do reporting on a per-group basis",
1785 .name = "zero_buffers",
1786 .type = FIO_OPT_STR_SET,
1787 .off1 = td_var_offset(zero_buffers),
1788 .help = "Init IO buffers to all zeroes",
1791 .name = "refill_buffers",
1792 .type = FIO_OPT_STR_SET,
1793 .off1 = td_var_offset(refill_buffers),
1794 .help = "Refill IO buffers on every IO submit",
1796 #ifdef FIO_HAVE_DISK_UTIL
1798 .name = "disk_util",
1799 .type = FIO_OPT_BOOL,
1800 .off1 = td_var_offset(do_disk_util),
1801 .help = "Log disk utilization statistics",
1806 .name = "gtod_reduce",
1807 .type = FIO_OPT_BOOL,
1808 .help = "Greatly reduce number of gettimeofday() calls",
1809 .cb = str_gtod_reduce_cb,
1813 .name = "disable_lat",
1814 .type = FIO_OPT_BOOL,
1815 .off1 = td_var_offset(disable_lat),
1816 .help = "Disable latency numbers",
1817 .parent = "gtod_reduce",
1821 .name = "disable_clat",
1822 .type = FIO_OPT_BOOL,
1823 .off1 = td_var_offset(disable_clat),
1824 .help = "Disable completion latency numbers",
1825 .parent = "gtod_reduce",
1829 .name = "disable_slat",
1830 .type = FIO_OPT_BOOL,
1831 .off1 = td_var_offset(disable_slat),
1832 .help = "Disable submissionn latency numbers",
1833 .parent = "gtod_reduce",
1837 .name = "disable_bw_measurement",
1838 .type = FIO_OPT_BOOL,
1839 .off1 = td_var_offset(disable_bw),
1840 .help = "Disable bandwidth logging",
1841 .parent = "gtod_reduce",
1846 .type = FIO_OPT_INT,
1847 .cb = str_gtod_cpu_cb,
1848 .help = "Setup dedicated gettimeofday() thread on this CPU",
1849 .verify = gtod_cpu_verify,
1852 .name = "continue_on_error",
1853 .type = FIO_OPT_BOOL,
1854 .off1 = td_var_offset(continue_on_error),
1855 .help = "Continue on non-fatal errors during I/O",
1860 .type = FIO_OPT_STR_STORE,
1861 .off1 = td_var_offset(profile),
1862 .help = "Select a specific builtin performance test",
1866 .type = FIO_OPT_STR_STORE,
1867 .off1 = td_var_offset(cgroup),
1868 .help = "Add job to cgroup of this name",
1871 .name = "cgroup_weight",
1872 .type = FIO_OPT_INT,
1873 .off1 = td_var_offset(cgroup_weight),
1874 .help = "Use given weight for cgroup",
1879 .name = "cgroup_nodelete",
1880 .type = FIO_OPT_BOOL,
1881 .off1 = td_var_offset(cgroup_nodelete),
1882 .help = "Do not delete cgroups after job completion",
1887 .type = FIO_OPT_INT,
1888 .off1 = td_var_offset(uid),
1889 .help = "Run job with this user ID",
1893 .type = FIO_OPT_INT,
1894 .off1 = td_var_offset(gid),
1895 .help = "Run job with this group ID",
1902 static void add_to_lopt(struct option *lopt, struct fio_option *o,
1905 lopt->name = (char *) name;
1906 lopt->val = FIO_GETOPT_JOB;
1907 if (o->type == FIO_OPT_STR_SET)
1908 lopt->has_arg = no_argument;
1910 lopt->has_arg = required_argument;
1913 void fio_options_dup_and_init(struct option *long_options)
1915 struct fio_option *o;
1918 options_init(options);
1921 while (long_options[i].name)
1926 add_to_lopt(&long_options[i], o, o->name);
1929 add_to_lopt(&long_options[i], o, o->alias);
1934 assert(i < FIO_NR_OPTIONS);
1938 struct fio_keyword {
1944 static struct fio_keyword fio_keywords[] = {
1946 .word = "$pagesize",
1947 .desc = "Page size in the system",
1950 .word = "$mb_memory",
1951 .desc = "Megabytes of memory online",
1955 .desc = "Number of CPUs online in the system",
1962 void fio_keywords_init(void)
1964 unsigned long long mb_memory;
1968 sprintf(buf, "%lu", page_size);
1969 fio_keywords[0].replace = strdup(buf);
1971 mb_memory = os_phys_mem() / page_size;
1972 sprintf(buf, "%llu", mb_memory);
1973 fio_keywords[1].replace = strdup(buf);
1975 l = sysconf(_SC_NPROCESSORS_ONLN);
1976 sprintf(buf, "%lu", l);
1977 fio_keywords[2].replace = strdup(buf);
1982 static char *bc_calc(char *str)
1984 char *buf, *tmp, opt[80];
1989 * No math, just return string
1991 if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
1996 * Split option from value, we only need to calculate the value
1998 tmp = strchr(str, '=');
2003 memset(opt, 0, sizeof(opt));
2004 strncpy(opt, str, tmp - str);
2008 sprintf(buf, "which %s > /dev/null", BC_APP);
2010 log_err("fio: bc is needed for performing math\n");
2015 sprintf(buf, "echo %s | %s", tmp, BC_APP);
2016 f = popen(buf, "r");
2022 ret = fread(buf, 1, 128, f);
2028 buf[ret - 1] = '\0';
2037 * Look for reserved variable names and replace them with real values
2039 static char *fio_keyword_replace(char *opt)
2044 for (i = 0; fio_keywords[i].word != NULL; i++) {
2045 struct fio_keyword *kw = &fio_keywords[i];
2047 while ((s = strstr(opt, kw->word)) != NULL) {
2048 char *new = malloc(strlen(opt) + 1);
2054 * Copy part of the string before the keyword and
2055 * sprintf() the replacement after it.
2057 memcpy(new, opt, olen);
2058 len = sprintf(new + olen, "%s", kw->replace);
2061 * If there's more in the original string, copy that
2064 opt += strlen(kw->word) + olen;
2066 memcpy(new + olen + len, opt, opt - o_org - 1);
2069 * replace opt and free the old opt
2075 * Check for potential math and invoke bc, if possible
2084 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
2088 sort_options(opts, options, num_opts);
2090 for (ret = 0, i = 0; i < num_opts; i++) {
2091 opts[i] = fio_keyword_replace(opts[i]);
2092 ret |= parse_option(opts[i], options, td);
2098 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2100 return parse_cmd_option(opt, val, options, td);
2103 void fio_fill_default_options(struct thread_data *td)
2105 fill_default_options(td, options);
2108 int fio_show_option_help(const char *opt)
2110 return show_cmd_help(options, opt);
2113 static void __options_mem(struct thread_data *td, int alloc)
2115 struct thread_options *o = &td->o;
2116 struct fio_option *opt;
2120 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
2121 if (opt->type != FIO_OPT_STR_STORE)
2124 ptr = (void *) o + opt->off1;
2127 *ptr = strdup(*ptr);
2137 * dupe FIO_OPT_STR_STORE options
2139 void options_mem_dupe(struct thread_data *td)
2141 __options_mem(td, 1);
2144 void options_mem_free(struct thread_data fio_unused *td)
2147 __options_mem(td, 0);
2151 unsigned int fio_get_kb_base(void *data)
2153 struct thread_data *td = data;
2154 unsigned int kb_base = 0;
2157 kb_base = td->o.kb_base;
2164 int add_option(struct fio_option *o)
2166 struct fio_option *__o;
2175 memcpy(&options[opt_index], o, sizeof(*o));
2179 void invalidate_profile_options(const char *prof_name)
2181 struct fio_option *o;
2185 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2186 o->type = FIO_OPT_INVALID;
2187 o->prof_name = NULL;
2193 void add_opt_posval(const char *optname, const char *ival, const char *help)
2195 struct fio_option *o;
2198 o = find_option(options, optname);
2202 for (i = 0; i < PARSE_MAX_VP; i++) {
2203 if (o->posval[i].ival)
2206 o->posval[i].ival = ival;
2207 o->posval[i].help = help;
2212 void del_opt_posval(const char *optname, const char *ival)
2214 struct fio_option *o;
2217 o = find_option(options, optname);
2221 for (i = 0; i < PARSE_MAX_VP; i++) {
2222 if (!o->posval[i].ival)
2224 if (strcmp(o->posval[i].ival, ival))
2227 o->posval[i].ival = NULL;
2228 o->posval[i].help = NULL;