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;
80 static int str_prio_cb(void *data, unsigned int *val)
82 struct thread_data *td = data;
87 * If no class is set, assume BE
89 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
90 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
96 static int str_exitall_cb(void)
98 exitall_on_terminate = 1;
102 #ifdef FIO_HAVE_CPU_AFFINITY
103 static int str_cpumask_cb(void *data, unsigned int *val)
105 struct thread_data *td = data;
108 CPU_ZERO(&td->o.cpumask);
110 for (i = 0; i < sizeof(int) * 8; i++)
112 CPU_SET(*val, &td->o.cpumask);
114 td->o.cpumask_set = 1;
118 static int str_cpus_allowed_cb(void *data, const char *input)
120 struct thread_data *td = data;
123 CPU_ZERO(&td->o.cpumask);
125 p = str = strdup(input);
127 strip_blank_front(&str);
128 strip_blank_end(str);
130 while ((cpu = strsep(&str, ",")) != NULL) {
133 CPU_SET(atoi(cpu), &td->o.cpumask);
137 td->o.cpumask_set = 1;
143 static int str_fst_cb(void *data, const char *str)
145 struct thread_data *td = data;
146 char *nr = get_opt_postfix(str);
148 td->file_service_nr = 1;
150 td->file_service_nr = atoi(nr);
155 static int str_filename_cb(void *data, const char *input)
157 struct thread_data *td = data;
158 char *fname, *str, *p;
160 p = str = strdup(input);
162 strip_blank_front(&str);
163 strip_blank_end(str);
165 if (!td->files_index)
168 while ((fname = strsep(&str, ":")) != NULL) {
179 static int str_directory_cb(void *data, const char fio_unused *str)
181 struct thread_data *td = data;
184 if (lstat(td->o.directory, &sb) < 0) {
185 log_err("fio: %s is not a directory\n", td->o.directory);
186 td_verror(td, errno, "lstat");
189 if (!S_ISDIR(sb.st_mode)) {
190 log_err("fio: %s is not a directory\n", td->o.directory);
197 static int str_opendir_cb(void *data, const char fio_unused *str)
199 struct thread_data *td = data;
201 if (!td->files_index)
204 return add_dir_files(td, td->o.opendir);
207 static int str_verify_offset_cb(void *data, unsigned int *off)
209 struct thread_data *td = data;
211 if (*off && *off < sizeof(struct verify_header)) {
212 log_err("fio: verify_offset too small\n");
216 td->o.verify_offset = *off;
220 static int str_verify_pattern_cb(void *data, unsigned int *off)
222 struct thread_data *td = data;
227 td->o.verify_pattern_bytes = 1;
229 td->o.verify_pattern_bytes = 2;
231 td->o.verify_pattern_bytes = 3;
233 td->o.verify_pattern_bytes = 4;
235 td->o.verify_pattern = *off;
239 #define __stringify_1(x) #x
240 #define __stringify(x) __stringify_1(x)
243 * Map of job/command line options
245 static struct fio_option options[] = {
247 .name = "description",
248 .type = FIO_OPT_STR_STORE,
249 .off1 = td_var_offset(description),
250 .help = "Text job description",
254 .type = FIO_OPT_STR_STORE,
255 .off1 = td_var_offset(name),
256 .help = "Name of this job",
260 .type = FIO_OPT_STR_STORE,
261 .off1 = td_var_offset(directory),
262 .cb = str_directory_cb,
263 .help = "Directory to store files in",
267 .type = FIO_OPT_STR_STORE,
268 .off1 = td_var_offset(filename),
269 .cb = str_filename_cb,
270 .help = "File(s) to use for the workload",
274 .type = FIO_OPT_STR_STORE,
275 .off1 = td_var_offset(opendir),
276 .cb = str_opendir_cb,
277 .help = "Recursively add files from this directory and down",
281 .alias = "readwrite",
284 .off1 = td_var_offset(td_ddir),
285 .help = "IO direction",
289 .oval = TD_DDIR_READ,
290 .help = "Sequential read",
293 .oval = TD_DDIR_WRITE,
294 .help = "Sequential write",
296 { .ival = "randread",
297 .oval = TD_DDIR_RANDREAD,
298 .help = "Random read",
300 { .ival = "randwrite",
301 .oval = TD_DDIR_RANDWRITE,
302 .help = "Random write",
306 .help = "Sequential read and write mix",
309 .oval = TD_DDIR_RANDRW,
310 .help = "Random read and write mix"
316 .type = FIO_OPT_STR_STORE,
317 .off1 = td_var_offset(ioengine),
318 .help = "IO engine to use",
322 .help = "Use read/write",
324 #ifdef FIO_HAVE_LIBAIO
326 .help = "Linux native asynchronous IO",
329 #ifdef FIO_HAVE_POSIXAIO
330 { .ival = "posixaio",
331 .help = "POSIX asynchronous IO",
335 .help = "Memory mapped IO",
337 #ifdef FIO_HAVE_SPLICE
339 .help = "splice/vmsplice based IO",
341 { .ival = "netsplice",
342 .help = "splice/vmsplice to/from the network",
347 .help = "SCSI generic v3 IO",
351 .help = "Testing engine (no data transfer)",
354 .help = "Network IO",
356 #ifdef FIO_HAVE_SYSLET
357 { .ival = "syslet-rw",
358 .help = "syslet enabled async pread/pwrite IO",
362 .help = "CPU cycler burner engine",
364 #ifdef FIO_HAVE_GUASI
366 .help = "GUASI IO engine",
369 { .ival = "external",
370 .help = "Load external engine (append name)",
377 .off1 = td_var_offset(iodepth),
378 .help = "Amount of IO buffers to keep in flight",
382 .name = "iodepth_batch",
384 .off1 = td_var_offset(iodepth_batch),
385 .help = "Number of IO to submit in one go",
389 .name = "iodepth_low",
391 .off1 = td_var_offset(iodepth_low),
392 .help = "Low water mark for queuing depth",
397 .type = FIO_OPT_STR_VAL,
398 .off1 = td_var_offset(size),
400 .help = "Total size of device or files",
404 .type = FIO_OPT_STR_VAL,
405 .off1 = td_var_offset(file_size_low),
406 .off2 = td_var_offset(file_size_high),
408 .help = "Size of individual files",
412 .alias = "fileoffset",
413 .type = FIO_OPT_STR_VAL,
414 .off1 = td_var_offset(start_offset),
415 .help = "Start IO from this offset",
420 .alias = "blocksize",
421 .type = FIO_OPT_STR_VAL_INT,
422 .off1 = td_var_offset(bs[DDIR_READ]),
423 .off2 = td_var_offset(bs[DDIR_WRITE]),
425 .help = "Block size unit",
431 .alias = "blocksize_range",
432 .type = FIO_OPT_RANGE,
433 .off1 = td_var_offset(min_bs[DDIR_READ]),
434 .off2 = td_var_offset(max_bs[DDIR_READ]),
435 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
436 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
438 .help = "Set block size range (in more detail than bs)",
442 .name = "bs_unaligned",
443 .alias = "blocksize_unaligned",
444 .type = FIO_OPT_STR_SET,
445 .off1 = td_var_offset(bs_unaligned),
446 .help = "Don't sector align IO buffer sizes",
450 .name = "randrepeat",
451 .type = FIO_OPT_BOOL,
452 .off1 = td_var_offset(rand_repeatable),
453 .help = "Use repeatable random IO pattern",
458 .name = "norandommap",
459 .type = FIO_OPT_STR_SET,
460 .off1 = td_var_offset(norandommap),
461 .help = "Accept potential duplicate random blocks",
467 .off1 = td_var_offset(nr_files),
468 .help = "Split job workload between this number of files",
474 .off1 = td_var_offset(open_files),
475 .help = "Number of files to keep open at the same time",
478 .name = "file_service_type",
481 .off1 = td_var_offset(file_service_type),
482 .help = "How to select which file to service next",
486 .oval = FIO_FSERVICE_RANDOM,
487 .help = "Choose a file at random",
489 { .ival = "roundrobin",
490 .oval = FIO_FSERVICE_RR,
491 .help = "Round robin select files",
497 .name = "fadvise_hint",
498 .type = FIO_OPT_BOOL,
499 .off1 = td_var_offset(fadvise_hint),
500 .help = "Use fadvise() to advise the kernel on IO pattern",
506 .off1 = td_var_offset(fsync_blocks),
507 .help = "Issue fsync for writes every given number of blocks",
512 .type = FIO_OPT_BOOL,
513 .off1 = td_var_offset(odirect),
514 .help = "Use O_DIRECT IO (negates buffered)",
519 .type = FIO_OPT_BOOL,
520 .off1 = td_var_offset(odirect),
522 .help = "Use buffered IO (negates direct)",
527 .type = FIO_OPT_BOOL,
528 .off1 = td_var_offset(overwrite),
529 .help = "When writing, set whether to overwrite current data",
535 .off1 = td_var_offset(loops),
536 .help = "Number of times to run the job",
542 .off1 = td_var_offset(numjobs),
543 .help = "Duplicate this job this many times",
547 .name = "startdelay",
549 .off1 = td_var_offset(start_delay),
550 .help = "Only start job when this period has passed",
556 .type = FIO_OPT_STR_VAL_TIME,
557 .off1 = td_var_offset(timeout),
558 .help = "Stop workload when this amount of time has passed",
562 .name = "time_based",
563 .type = FIO_OPT_STR_SET,
564 .off1 = td_var_offset(time_based),
565 .help = "Keep running until runtime/timeout is met",
572 .off1 = td_var_offset(mem_type),
573 .help = "Backing type for IO buffers",
578 .help = "Use malloc(3) for IO buffers",
582 .help = "Use shared memory segments for IO buffers",
584 #ifdef FIO_HAVE_HUGETLB
587 .help = "Like shm, but use huge pages",
592 .help = "Use mmap(2) (file or anon) for IO buffers",
594 #ifdef FIO_HAVE_HUGETLB
595 { .ival = "mmaphuge",
596 .oval = MEM_MMAPHUGE,
597 .help = "Like mmap, but use huge pages",
605 .off1 = td_var_offset(verify),
606 .help = "Verify data written",
611 .help = "Don't do IO verification",
615 .help = "Use md5 checksums for verification",
618 .oval = VERIFY_CRC64,
619 .help = "Use crc64 checksums for verification",
622 .oval = VERIFY_CRC32,
623 .help = "Use crc32 checksums for verification",
626 .oval = VERIFY_CRC16,
627 .help = "Use crc16 checksums for verification",
631 .help = "Use crc7 checksums for verification",
634 .oval = VERIFY_SHA256,
635 .help = "Use sha256 checksums for verification",
638 .oval = VERIFY_SHA512,
639 .help = "Use sha512 checksums for verification",
643 .help = "Use io information",
648 .help = "Pretend to verify",
654 .type = FIO_OPT_BOOL,
655 .off1 = td_var_offset(do_verify),
656 .help = "Run verification stage after write",
661 .name = "verifysort",
662 .type = FIO_OPT_BOOL,
663 .off1 = td_var_offset(verifysort),
664 .help = "Sort written verify blocks for read back",
669 .name = "verify_interval",
670 .type = FIO_OPT_STR_VAL_INT,
671 .off1 = td_var_offset(verify_interval),
672 .minval = 2 * sizeof(struct verify_header),
673 .help = "Store verify buffer header every N bytes",
677 .name = "verify_offset",
678 .type = FIO_OPT_STR_VAL_INT,
679 .help = "Offset verify header location by N bytes",
681 .cb = str_verify_offset_cb,
685 .name = "verify_pattern",
687 .cb = str_verify_pattern_cb,
688 .help = "Fill pattern for IO buffers",
692 .name = "verify_fatal",
693 .type = FIO_OPT_BOOL,
694 .off1 = td_var_offset(verify_fatal),
696 .help = "Exit on a single verify failure, don't continue",
700 .name = "write_iolog",
701 .type = FIO_OPT_STR_STORE,
702 .off1 = td_var_offset(write_iolog_file),
703 .help = "Store IO pattern to file",
706 .name = "read_iolog",
707 .type = FIO_OPT_STR_STORE,
708 .off1 = td_var_offset(read_iolog_file),
709 .help = "Playback IO pattern from file",
712 .name = "exec_prerun",
713 .type = FIO_OPT_STR_STORE,
714 .off1 = td_var_offset(exec_prerun),
715 .help = "Execute this file prior to running job",
718 .name = "exec_postrun",
719 .type = FIO_OPT_STR_STORE,
720 .off1 = td_var_offset(exec_postrun),
721 .help = "Execute this file after running job",
723 #ifdef FIO_HAVE_IOSCHED_SWITCH
725 .name = "ioscheduler",
726 .type = FIO_OPT_STR_STORE,
727 .off1 = td_var_offset(ioscheduler),
728 .help = "Use this IO scheduler on the backing device",
733 .type = FIO_OPT_STR_VAL,
734 .off1 = td_var_offset(zone_size),
735 .help = "Give size of an IO zone",
740 .type = FIO_OPT_STR_VAL,
741 .off1 = td_var_offset(zone_skip),
742 .help = "Space between IO zones",
747 .type = FIO_OPT_STR_VAL,
748 .cb = str_lockmem_cb,
749 .help = "Lock down this amount of memory",
755 .off1 = td_var_offset(rwmix[DDIR_READ]),
757 .help = "Percentage of mixed workload that is reads",
761 .name = "rwmixwrite",
763 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
765 .help = "Percentage of mixed workload that is writes",
769 .name = "rwmixcycle",
771 .off1 = td_var_offset(rwmixcycle),
772 .help = "Cycle period for mixed read/write workloads (msec)",
774 .parent = "rwmixread",
779 .off1 = td_var_offset(nice),
780 .help = "Set job CPU nice value",
785 #ifdef FIO_HAVE_IOPRIO
790 .help = "Set job IO priority value",
797 .cb = str_prioclass_cb,
798 .help = "Set job IO priority class",
806 .off1 = td_var_offset(thinktime),
807 .help = "Idle time between IO buffers (usec)",
811 .name = "thinktime_spin",
813 .off1 = td_var_offset(thinktime_spin),
814 .help = "Start think time by spinning this amount (usec)",
816 .parent = "thinktime",
819 .name = "thinktime_blocks",
821 .off1 = td_var_offset(thinktime_blocks),
822 .help = "IO buffer period between 'thinktime'",
824 .parent = "thinktime",
829 .off1 = td_var_offset(rate),
830 .help = "Set bandwidth rate",
835 .off1 = td_var_offset(ratemin),
836 .help = "Job must meet this rate or it will be shutdown",
842 .off1 = td_var_offset(rate_iops),
843 .help = "Limit IO used to this number of IO operations/sec",
846 .name = "rate_iops_min",
848 .off1 = td_var_offset(rate_iops_min),
849 .help = "Job must meet this rate or it will be shutdown",
850 .parent = "rate_iops",
855 .off1 = td_var_offset(ratecycle),
856 .help = "Window average for rate limits (msec)",
861 .name = "invalidate",
862 .type = FIO_OPT_BOOL,
863 .off1 = td_var_offset(invalidate_cache),
864 .help = "Invalidate buffer/page cache prior to running job",
869 .type = FIO_OPT_BOOL,
870 .off1 = td_var_offset(sync_io),
871 .help = "Use O_SYNC for buffered writes",
873 .parent = "buffered",
878 .off1 = td_var_offset(bw_avg_time),
879 .help = "Time window over which to calculate bandwidth (msec)",
883 .name = "create_serialize",
884 .type = FIO_OPT_BOOL,
885 .off1 = td_var_offset(create_serialize),
886 .help = "Serialize creating of job files",
890 .name = "create_fsync",
891 .type = FIO_OPT_BOOL,
892 .off1 = td_var_offset(create_fsync),
893 .help = "Fsync file after creation",
899 .off1 = td_var_offset(cpuload),
900 .help = "Use this percentage of CPU",
905 .off1 = td_var_offset(cpucycle),
906 .help = "Length of the CPU burn cycles (usecs)",
910 #ifdef FIO_HAVE_CPU_AFFINITY
914 .cb = str_cpumask_cb,
915 .help = "CPU affinity mask",
918 .name = "cpus_allowed",
920 .cb = str_cpus_allowed_cb,
921 .help = "Set CPUs allowed",
926 .type = FIO_OPT_BOOL,
927 .off1 = td_var_offset(end_fsync),
928 .help = "Include fsync at the end of job",
932 .name = "fsync_on_close",
933 .type = FIO_OPT_BOOL,
934 .off1 = td_var_offset(fsync_on_close),
935 .help = "fsync files on close",
940 .type = FIO_OPT_BOOL,
941 .off1 = td_var_offset(unlink),
942 .help = "Unlink created files after job has completed",
947 .type = FIO_OPT_STR_SET,
948 .cb = str_exitall_cb,
949 .help = "Terminate all jobs when one exits",
953 .type = FIO_OPT_STR_SET,
954 .off1 = td_var_offset(stonewall),
955 .help = "Insert a hard barrier between this job and previous",
959 .type = FIO_OPT_STR_SET,
960 .off1 = td_var_offset(new_group),
961 .help = "Mark the start of a new group (for reporting)",
965 .type = FIO_OPT_STR_SET,
966 .off1 = td_var_offset(use_thread),
967 .help = "Use threads instead of forks",
970 .name = "write_bw_log",
971 .type = FIO_OPT_STR_SET,
972 .off1 = td_var_offset(write_bw_log),
973 .help = "Write log of bandwidth during run",
976 .name = "write_lat_log",
977 .type = FIO_OPT_STR_SET,
978 .off1 = td_var_offset(write_lat_log),
979 .help = "Write log of latency during run",
982 .name = "hugepage-size",
983 .type = FIO_OPT_STR_VAL,
984 .off1 = td_var_offset(hugepage_size),
985 .help = "When using hugepages, specify size of each page",
986 .def = __stringify(FIO_HUGE_PAGE),
989 .name = "group_reporting",
990 .type = FIO_OPT_STR_SET,
991 .off1 = td_var_offset(group_reporting),
992 .help = "Do reporting on a per-group basis",
995 .name = "zero_buffers",
996 .type = FIO_OPT_STR_SET,
997 .off1 = td_var_offset(zero_buffers),
998 .help = "Init IO buffers to all zeroes",
1000 #ifdef FIO_HAVE_DISK_UTIL
1002 .name = "disk_util",
1003 .type = FIO_OPT_BOOL,
1004 .off1 = td_var_offset(do_disk_util),
1005 .help = "Log disk utilization stats",
1014 void fio_options_dup_and_init(struct option *long_options)
1016 struct fio_option *o;
1019 options_init(options);
1022 while (long_options[i].name)
1027 long_options[i].name = o->name;
1028 long_options[i].val = FIO_GETOPT_JOB;
1029 if (o->type == FIO_OPT_STR_SET)
1030 long_options[i].has_arg = no_argument;
1032 long_options[i].has_arg = required_argument;
1036 assert(i < FIO_NR_OPTIONS);
1040 int fio_option_parse(struct thread_data *td, const char *opt)
1042 return parse_option(opt, options, td);
1045 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1047 return parse_cmd_option(opt, val, options, td);
1050 void fio_fill_default_options(struct thread_data *td)
1052 fill_default_options(td, options);
1055 int fio_show_option_help(const char *opt)
1057 return show_cmd_help(options, opt);
1060 static void __options_mem(struct thread_data *td, int alloc)
1062 struct thread_options *o = &td->o;
1063 struct fio_option *opt;
1067 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1068 if (opt->type != FIO_OPT_STR_STORE)
1071 ptr = (void *) o + opt->off1;
1074 *ptr = strdup(*ptr);
1084 * dupe FIO_OPT_STR_STORE options
1086 void options_mem_dupe(struct thread_data *td)
1088 __options_mem(td, 1);
1091 void options_mem_free(struct thread_data fio_unused *td)
1094 __options_mem(td, 0);