13 #define td_var_offset(var) ((size_t) &((struct thread_options *)0)->var)
16 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
18 static char *get_opt_postfix(const char *str)
20 char *p = strstr(str, ":");
26 strip_blank_front(&p);
31 static int str_rw_cb(void *data, const char *str)
33 struct thread_data *td = data;
34 char *nr = get_opt_postfix(str);
38 td->o.ddir_nr = atoi(nr);
43 static int str_mem_cb(void *data, const char *mem)
45 struct thread_data *td = data;
47 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
48 td->mmapfile = get_opt_postfix(mem);
49 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
50 log_err("fio: mmaphuge:/path/to/file\n");
58 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
64 #ifdef FIO_HAVE_IOPRIO
65 static int str_prioclass_cb(void *data, unsigned int *val)
67 struct thread_data *td = data;
71 * mask off old class bits, str_prio_cb() may have set a default class
73 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
76 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
81 static int str_prio_cb(void *data, unsigned int *val)
83 struct thread_data *td = data;
88 * If no class is set, assume BE
90 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
91 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
98 static int str_exitall_cb(void)
100 exitall_on_terminate = 1;
104 #ifdef FIO_HAVE_CPU_AFFINITY
105 static int str_cpumask_cb(void *data, unsigned int *val)
107 struct thread_data *td = data;
110 CPU_ZERO(&td->o.cpumask);
112 for (i = 0; i < sizeof(int) * 8; i++)
114 CPU_SET(*val, &td->o.cpumask);
116 td->o.cpumask_set = 1;
120 static int str_cpus_allowed_cb(void *data, const char *input)
122 struct thread_data *td = data;
125 CPU_ZERO(&td->o.cpumask);
127 p = str = strdup(input);
129 strip_blank_front(&str);
130 strip_blank_end(str);
132 while ((cpu = strsep(&str, ",")) != NULL) {
135 CPU_SET(atoi(cpu), &td->o.cpumask);
139 td->o.cpumask_set = 1;
145 static int str_fst_cb(void *data, const char *str)
147 struct thread_data *td = data;
148 char *nr = get_opt_postfix(str);
150 td->file_service_nr = 1;
152 td->file_service_nr = atoi(nr);
157 static int str_filename_cb(void *data, const char *input)
159 struct thread_data *td = data;
160 char *fname, *str, *p;
162 p = str = strdup(input);
164 strip_blank_front(&str);
165 strip_blank_end(str);
167 if (!td->files_index)
170 while ((fname = strsep(&str, ":")) != NULL) {
181 static int str_directory_cb(void *data, const char fio_unused *str)
183 struct thread_data *td = data;
186 if (lstat(td->o.directory, &sb) < 0) {
187 log_err("fio: %s is not a directory\n", td->o.directory);
188 td_verror(td, errno, "lstat");
191 if (!S_ISDIR(sb.st_mode)) {
192 log_err("fio: %s is not a directory\n", td->o.directory);
199 static int str_opendir_cb(void *data, const char fio_unused *str)
201 struct thread_data *td = data;
203 if (!td->files_index)
206 return add_dir_files(td, td->o.opendir);
209 static int str_verify_offset_cb(void *data, unsigned int *off)
211 struct thread_data *td = data;
213 if (*off && *off < sizeof(struct verify_header)) {
214 log_err("fio: verify_offset too small\n");
218 td->o.verify_offset = *off;
222 static int str_verify_cb(void *data, const char *mem)
224 struct thread_data *td = data;
225 unsigned int nr, msb;
228 if (td->o.verify != VERIFY_PATTERN)
231 pat = get_opt_postfix(mem);
233 log_err("fio: missing pattern\n");
237 if (strstr(pat, "0x") || strstr(pat, "0X"))
238 nr = strtol(pat, NULL, 16);
240 nr = strtol(pat, NULL, 16);
244 td->o.verify_pattern_bytes = 1;
246 td->o.verify_pattern_bytes = 2;
248 td->o.verify_pattern_bytes = 3;
250 td->o.verify_pattern_bytes = 4;
252 td->o.verify_pattern = nr;
256 #define __stringify_1(x) #x
257 #define __stringify(x) __stringify_1(x)
260 * Map of job/command line options
262 static struct fio_option options[] = {
264 .name = "description",
265 .type = FIO_OPT_STR_STORE,
266 .off1 = td_var_offset(description),
267 .help = "Text job description",
271 .type = FIO_OPT_STR_STORE,
272 .off1 = td_var_offset(name),
273 .help = "Name of this job",
277 .type = FIO_OPT_STR_STORE,
278 .off1 = td_var_offset(directory),
279 .cb = str_directory_cb,
280 .help = "Directory to store files in",
284 .type = FIO_OPT_STR_STORE,
285 .off1 = td_var_offset(filename),
286 .cb = str_filename_cb,
287 .help = "File(s) to use for the workload",
291 .type = FIO_OPT_STR_STORE,
292 .off1 = td_var_offset(opendir),
293 .cb = str_opendir_cb,
294 .help = "Recursively add files from this directory and down",
298 .alias = "readwrite",
301 .off1 = td_var_offset(td_ddir),
302 .help = "IO direction",
306 .oval = TD_DDIR_READ,
307 .help = "Sequential read",
310 .oval = TD_DDIR_WRITE,
311 .help = "Sequential write",
313 { .ival = "randread",
314 .oval = TD_DDIR_RANDREAD,
315 .help = "Random read",
317 { .ival = "randwrite",
318 .oval = TD_DDIR_RANDWRITE,
319 .help = "Random write",
323 .help = "Sequential read and write mix",
326 .oval = TD_DDIR_RANDRW,
327 .help = "Random read and write mix"
333 .type = FIO_OPT_STR_STORE,
334 .off1 = td_var_offset(ioengine),
335 .help = "IO engine to use",
339 .help = "Use read/write",
342 .help = "Use pread/pwrite",
344 #ifdef FIO_HAVE_LIBAIO
346 .help = "Linux native asynchronous IO",
349 #ifdef FIO_HAVE_POSIXAIO
350 { .ival = "posixaio",
351 .help = "POSIX asynchronous IO",
355 .help = "Memory mapped IO",
357 #ifdef FIO_HAVE_SPLICE
359 .help = "splice/vmsplice based IO",
361 { .ival = "netsplice",
362 .help = "splice/vmsplice to/from the network",
367 .help = "SCSI generic v3 IO",
371 .help = "Testing engine (no data transfer)",
374 .help = "Network IO",
376 #ifdef FIO_HAVE_SYSLET
377 { .ival = "syslet-rw",
378 .help = "syslet enabled async pread/pwrite IO",
382 .help = "CPU cycler burner engine",
384 #ifdef FIO_HAVE_GUASI
386 .help = "GUASI IO engine",
389 { .ival = "external",
390 .help = "Load external engine (append name)",
397 .off1 = td_var_offset(iodepth),
398 .help = "Amount of IO buffers to keep in flight",
403 .name = "iodepth_batch",
405 .off1 = td_var_offset(iodepth_batch),
406 .help = "Number of IO to submit in one go",
410 .name = "iodepth_low",
412 .off1 = td_var_offset(iodepth_low),
413 .help = "Low water mark for queuing depth",
418 .type = FIO_OPT_STR_VAL,
419 .off1 = td_var_offset(size),
421 .help = "Total size of device or files",
425 .type = FIO_OPT_STR_VAL,
426 .off1 = td_var_offset(file_size_low),
427 .off2 = td_var_offset(file_size_high),
429 .help = "Size of individual files",
433 .alias = "fileoffset",
434 .type = FIO_OPT_STR_VAL,
435 .off1 = td_var_offset(start_offset),
436 .help = "Start IO from this offset",
441 .alias = "blocksize",
442 .type = FIO_OPT_STR_VAL_INT,
443 .off1 = td_var_offset(bs[DDIR_READ]),
444 .off2 = td_var_offset(bs[DDIR_WRITE]),
446 .help = "Block size unit",
452 .alias = "blocksize_range",
453 .type = FIO_OPT_RANGE,
454 .off1 = td_var_offset(min_bs[DDIR_READ]),
455 .off2 = td_var_offset(max_bs[DDIR_READ]),
456 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
457 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
459 .help = "Set block size range (in more detail than bs)",
463 .name = "bs_unaligned",
464 .alias = "blocksize_unaligned",
465 .type = FIO_OPT_STR_SET,
466 .off1 = td_var_offset(bs_unaligned),
467 .help = "Don't sector align IO buffer sizes",
471 .name = "randrepeat",
472 .type = FIO_OPT_BOOL,
473 .off1 = td_var_offset(rand_repeatable),
474 .help = "Use repeatable random IO pattern",
479 .name = "norandommap",
480 .type = FIO_OPT_STR_SET,
481 .off1 = td_var_offset(norandommap),
482 .help = "Accept potential duplicate random blocks",
488 .off1 = td_var_offset(nr_files),
489 .help = "Split job workload between this number of files",
495 .off1 = td_var_offset(open_files),
496 .help = "Number of files to keep open at the same time",
499 .name = "file_service_type",
502 .off1 = td_var_offset(file_service_type),
503 .help = "How to select which file to service next",
507 .oval = FIO_FSERVICE_RANDOM,
508 .help = "Choose a file at random",
510 { .ival = "roundrobin",
511 .oval = FIO_FSERVICE_RR,
512 .help = "Round robin select files",
518 .name = "fadvise_hint",
519 .type = FIO_OPT_BOOL,
520 .off1 = td_var_offset(fadvise_hint),
521 .help = "Use fadvise() to advise the kernel on IO pattern",
527 .off1 = td_var_offset(fsync_blocks),
528 .help = "Issue fsync for writes every given number of blocks",
533 .type = FIO_OPT_BOOL,
534 .off1 = td_var_offset(odirect),
535 .help = "Use O_DIRECT IO (negates buffered)",
540 .type = FIO_OPT_BOOL,
541 .off1 = td_var_offset(odirect),
543 .help = "Use buffered IO (negates direct)",
548 .type = FIO_OPT_BOOL,
549 .off1 = td_var_offset(overwrite),
550 .help = "When writing, set whether to overwrite current data",
556 .off1 = td_var_offset(loops),
557 .help = "Number of times to run the job",
563 .off1 = td_var_offset(numjobs),
564 .help = "Duplicate this job this many times",
568 .name = "startdelay",
570 .off1 = td_var_offset(start_delay),
571 .help = "Only start job when this period has passed",
577 .type = FIO_OPT_STR_VAL_TIME,
578 .off1 = td_var_offset(timeout),
579 .help = "Stop workload when this amount of time has passed",
583 .name = "time_based",
584 .type = FIO_OPT_STR_SET,
585 .off1 = td_var_offset(time_based),
586 .help = "Keep running until runtime/timeout is met",
593 .off1 = td_var_offset(mem_type),
594 .help = "Backing type for IO buffers",
599 .help = "Use malloc(3) for IO buffers",
603 .help = "Use shared memory segments for IO buffers",
605 #ifdef FIO_HAVE_HUGETLB
608 .help = "Like shm, but use huge pages",
613 .help = "Use mmap(2) (file or anon) for IO buffers",
615 #ifdef FIO_HAVE_HUGETLB
616 { .ival = "mmaphuge",
617 .oval = MEM_MMAPHUGE,
618 .help = "Like mmap, but use huge pages",
626 .off1 = td_var_offset(verify),
628 .help = "Verify data written",
633 .help = "Don't do IO verification",
637 .help = "Use md5 checksums for verification",
640 .oval = VERIFY_CRC64,
641 .help = "Use crc64 checksums for verification",
644 .oval = VERIFY_CRC32,
645 .help = "Use crc32 checksums for verification",
648 .oval = VERIFY_CRC16,
649 .help = "Use crc16 checksums for verification",
653 .help = "Use crc7 checksums for verification",
656 .oval = VERIFY_SHA256,
657 .help = "Use sha256 checksums for verification",
660 .oval = VERIFY_SHA512,
661 .help = "Use sha512 checksums for verification",
665 .help = "Use io information",
668 .oval = VERIFY_PATTERN,
669 .help = "Verify a specific buffer pattern",
674 .help = "Pretend to verify",
680 .type = FIO_OPT_BOOL,
681 .off1 = td_var_offset(do_verify),
682 .help = "Run verification stage after write",
687 .name = "verifysort",
688 .type = FIO_OPT_BOOL,
689 .off1 = td_var_offset(verifysort),
690 .help = "Sort written verify blocks for read back",
695 .name = "verify_interval",
696 .type = FIO_OPT_STR_VAL_INT,
697 .off1 = td_var_offset(verify_interval),
698 .minval = 2 * sizeof(struct verify_header),
699 .help = "Store verify buffer header every N bytes",
703 .name = "verify_offset",
704 .type = FIO_OPT_STR_VAL_INT,
705 .help = "Offset verify header location by N bytes",
707 .cb = str_verify_offset_cb,
711 .name = "verify_fatal",
712 .type = FIO_OPT_BOOL,
713 .off1 = td_var_offset(verify_fatal),
715 .help = "Exit on a single verify failure, don't continue",
719 .name = "write_iolog",
720 .type = FIO_OPT_STR_STORE,
721 .off1 = td_var_offset(write_iolog_file),
722 .help = "Store IO pattern to file",
725 .name = "read_iolog",
726 .type = FIO_OPT_STR_STORE,
727 .off1 = td_var_offset(read_iolog_file),
728 .help = "Playback IO pattern from file",
731 .name = "exec_prerun",
732 .type = FIO_OPT_STR_STORE,
733 .off1 = td_var_offset(exec_prerun),
734 .help = "Execute this file prior to running job",
737 .name = "exec_postrun",
738 .type = FIO_OPT_STR_STORE,
739 .off1 = td_var_offset(exec_postrun),
740 .help = "Execute this file after running job",
742 #ifdef FIO_HAVE_IOSCHED_SWITCH
744 .name = "ioscheduler",
745 .type = FIO_OPT_STR_STORE,
746 .off1 = td_var_offset(ioscheduler),
747 .help = "Use this IO scheduler on the backing device",
752 .type = FIO_OPT_STR_VAL,
753 .off1 = td_var_offset(zone_size),
754 .help = "Give size of an IO zone",
759 .type = FIO_OPT_STR_VAL,
760 .off1 = td_var_offset(zone_skip),
761 .help = "Space between IO zones",
766 .type = FIO_OPT_STR_VAL,
767 .cb = str_lockmem_cb,
768 .help = "Lock down this amount of memory",
774 .off1 = td_var_offset(rwmix[DDIR_READ]),
776 .help = "Percentage of mixed workload that is reads",
780 .name = "rwmixwrite",
782 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
784 .help = "Percentage of mixed workload that is writes",
788 .name = "rwmixcycle",
790 .off1 = td_var_offset(rwmixcycle),
791 .help = "Cycle period for mixed read/write workloads (msec)",
793 .parent = "rwmixread",
798 .off1 = td_var_offset(nice),
799 .help = "Set job CPU nice value",
804 #ifdef FIO_HAVE_IOPRIO
809 .help = "Set job IO priority value",
816 .cb = str_prioclass_cb,
817 .help = "Set job IO priority class",
825 .off1 = td_var_offset(thinktime),
826 .help = "Idle time between IO buffers (usec)",
830 .name = "thinktime_spin",
832 .off1 = td_var_offset(thinktime_spin),
833 .help = "Start think time by spinning this amount (usec)",
835 .parent = "thinktime",
838 .name = "thinktime_blocks",
840 .off1 = td_var_offset(thinktime_blocks),
841 .help = "IO buffer period between 'thinktime'",
843 .parent = "thinktime",
848 .off1 = td_var_offset(rate),
849 .help = "Set bandwidth rate",
854 .off1 = td_var_offset(ratemin),
855 .help = "Job must meet this rate or it will be shutdown",
861 .off1 = td_var_offset(rate_iops),
862 .help = "Limit IO used to this number of IO operations/sec",
865 .name = "rate_iops_min",
867 .off1 = td_var_offset(rate_iops_min),
868 .help = "Job must meet this rate or it will be shutdown",
869 .parent = "rate_iops",
874 .off1 = td_var_offset(ratecycle),
875 .help = "Window average for rate limits (msec)",
880 .name = "invalidate",
881 .type = FIO_OPT_BOOL,
882 .off1 = td_var_offset(invalidate_cache),
883 .help = "Invalidate buffer/page cache prior to running job",
888 .type = FIO_OPT_BOOL,
889 .off1 = td_var_offset(sync_io),
890 .help = "Use O_SYNC for buffered writes",
892 .parent = "buffered",
897 .off1 = td_var_offset(bw_avg_time),
898 .help = "Time window over which to calculate bandwidth (msec)",
902 .name = "create_serialize",
903 .type = FIO_OPT_BOOL,
904 .off1 = td_var_offset(create_serialize),
905 .help = "Serialize creating of job files",
909 .name = "create_fsync",
910 .type = FIO_OPT_BOOL,
911 .off1 = td_var_offset(create_fsync),
912 .help = "Fsync file after creation",
918 .off1 = td_var_offset(cpuload),
919 .help = "Use this percentage of CPU",
924 .off1 = td_var_offset(cpucycle),
925 .help = "Length of the CPU burn cycles (usecs)",
929 #ifdef FIO_HAVE_CPU_AFFINITY
933 .cb = str_cpumask_cb,
934 .help = "CPU affinity mask",
937 .name = "cpus_allowed",
939 .cb = str_cpus_allowed_cb,
940 .help = "Set CPUs allowed",
945 .type = FIO_OPT_BOOL,
946 .off1 = td_var_offset(end_fsync),
947 .help = "Include fsync at the end of job",
951 .name = "fsync_on_close",
952 .type = FIO_OPT_BOOL,
953 .off1 = td_var_offset(fsync_on_close),
954 .help = "fsync files on close",
959 .type = FIO_OPT_BOOL,
960 .off1 = td_var_offset(unlink),
961 .help = "Unlink created files after job has completed",
966 .type = FIO_OPT_STR_SET,
967 .cb = str_exitall_cb,
968 .help = "Terminate all jobs when one exits",
972 .type = FIO_OPT_STR_SET,
973 .off1 = td_var_offset(stonewall),
974 .help = "Insert a hard barrier between this job and previous",
978 .type = FIO_OPT_STR_SET,
979 .off1 = td_var_offset(new_group),
980 .help = "Mark the start of a new group (for reporting)",
984 .type = FIO_OPT_STR_SET,
985 .off1 = td_var_offset(use_thread),
986 .help = "Use threads instead of forks",
989 .name = "write_bw_log",
990 .type = FIO_OPT_STR_SET,
991 .off1 = td_var_offset(write_bw_log),
992 .help = "Write log of bandwidth during run",
995 .name = "write_lat_log",
996 .type = FIO_OPT_STR_SET,
997 .off1 = td_var_offset(write_lat_log),
998 .help = "Write log of latency during run",
1001 .name = "hugepage-size",
1002 .type = FIO_OPT_STR_VAL,
1003 .off1 = td_var_offset(hugepage_size),
1004 .help = "When using hugepages, specify size of each page",
1005 .def = __stringify(FIO_HUGE_PAGE),
1008 .name = "group_reporting",
1009 .type = FIO_OPT_STR_SET,
1010 .off1 = td_var_offset(group_reporting),
1011 .help = "Do reporting on a per-group basis",
1014 .name = "zero_buffers",
1015 .type = FIO_OPT_STR_SET,
1016 .off1 = td_var_offset(zero_buffers),
1017 .help = "Init IO buffers to all zeroes",
1019 #ifdef FIO_HAVE_DISK_UTIL
1021 .name = "disk_util",
1022 .type = FIO_OPT_BOOL,
1023 .off1 = td_var_offset(do_disk_util),
1024 .help = "Log disk utilization stats",
1033 void fio_options_dup_and_init(struct option *long_options)
1035 struct fio_option *o;
1038 options_init(options);
1041 while (long_options[i].name)
1046 long_options[i].name = o->name;
1047 long_options[i].val = FIO_GETOPT_JOB;
1048 if (o->type == FIO_OPT_STR_SET)
1049 long_options[i].has_arg = no_argument;
1051 long_options[i].has_arg = required_argument;
1055 assert(i < FIO_NR_OPTIONS);
1059 int fio_option_parse(struct thread_data *td, const char *opt)
1061 return parse_option(opt, options, td);
1064 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1066 return parse_cmd_option(opt, val, options, td);
1069 void fio_fill_default_options(struct thread_data *td)
1071 fill_default_options(td, options);
1074 int fio_show_option_help(const char *opt)
1076 return show_cmd_help(options, opt);
1079 static void __options_mem(struct thread_data *td, int alloc)
1081 struct thread_options *o = &td->o;
1082 struct fio_option *opt;
1086 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1087 if (opt->type != FIO_OPT_STR_STORE)
1090 ptr = (void *) o + opt->off1;
1093 *ptr = strdup(*ptr);
1103 * dupe FIO_OPT_STR_STORE options
1105 void options_mem_dupe(struct thread_data *td)
1107 __options_mem(td, 1);
1110 void options_mem_free(struct thread_data fio_unused *td)
1113 __options_mem(td, 0);