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_cb(void *data, const char *mem)
222 struct thread_data *td = data;
223 unsigned int nr, msb;
226 if (td->o.verify != VERIFY_PATTERN)
229 pat = get_opt_postfix(mem);
231 log_err("fio: missing pattern\n");
235 if (strstr(pat, "0x") || strstr(pat, "0X"))
236 nr = strtol(pat, NULL, 16);
238 nr = strtol(pat, NULL, 16);
242 td->o.verify_pattern_bytes = 1;
244 td->o.verify_pattern_bytes = 2;
246 td->o.verify_pattern_bytes = 3;
248 td->o.verify_pattern_bytes = 4;
250 td->o.verify_pattern = nr;
254 #define __stringify_1(x) #x
255 #define __stringify(x) __stringify_1(x)
258 * Map of job/command line options
260 static struct fio_option options[] = {
262 .name = "description",
263 .type = FIO_OPT_STR_STORE,
264 .off1 = td_var_offset(description),
265 .help = "Text job description",
269 .type = FIO_OPT_STR_STORE,
270 .off1 = td_var_offset(name),
271 .help = "Name of this job",
275 .type = FIO_OPT_STR_STORE,
276 .off1 = td_var_offset(directory),
277 .cb = str_directory_cb,
278 .help = "Directory to store files in",
282 .type = FIO_OPT_STR_STORE,
283 .off1 = td_var_offset(filename),
284 .cb = str_filename_cb,
285 .help = "File(s) to use for the workload",
289 .type = FIO_OPT_STR_STORE,
290 .off1 = td_var_offset(opendir),
291 .cb = str_opendir_cb,
292 .help = "Recursively add files from this directory and down",
296 .alias = "readwrite",
299 .off1 = td_var_offset(td_ddir),
300 .help = "IO direction",
304 .oval = TD_DDIR_READ,
305 .help = "Sequential read",
308 .oval = TD_DDIR_WRITE,
309 .help = "Sequential write",
311 { .ival = "randread",
312 .oval = TD_DDIR_RANDREAD,
313 .help = "Random read",
315 { .ival = "randwrite",
316 .oval = TD_DDIR_RANDWRITE,
317 .help = "Random write",
321 .help = "Sequential read and write mix",
324 .oval = TD_DDIR_RANDRW,
325 .help = "Random read and write mix"
331 .type = FIO_OPT_STR_STORE,
332 .off1 = td_var_offset(ioengine),
333 .help = "IO engine to use",
337 .help = "Use read/write",
339 #ifdef FIO_HAVE_LIBAIO
341 .help = "Linux native asynchronous IO",
344 #ifdef FIO_HAVE_POSIXAIO
345 { .ival = "posixaio",
346 .help = "POSIX asynchronous IO",
350 .help = "Memory mapped IO",
352 #ifdef FIO_HAVE_SPLICE
354 .help = "splice/vmsplice based IO",
356 { .ival = "netsplice",
357 .help = "splice/vmsplice to/from the network",
362 .help = "SCSI generic v3 IO",
366 .help = "Testing engine (no data transfer)",
369 .help = "Network IO",
371 #ifdef FIO_HAVE_SYSLET
372 { .ival = "syslet-rw",
373 .help = "syslet enabled async pread/pwrite IO",
377 .help = "CPU cycler burner engine",
379 #ifdef FIO_HAVE_GUASI
381 .help = "GUASI IO engine",
384 { .ival = "external",
385 .help = "Load external engine (append name)",
392 .off1 = td_var_offset(iodepth),
393 .help = "Amount of IO buffers to keep in flight",
397 .name = "iodepth_batch",
399 .off1 = td_var_offset(iodepth_batch),
400 .help = "Number of IO to submit in one go",
404 .name = "iodepth_low",
406 .off1 = td_var_offset(iodepth_low),
407 .help = "Low water mark for queuing depth",
412 .type = FIO_OPT_STR_VAL,
413 .off1 = td_var_offset(size),
415 .help = "Total size of device or files",
419 .type = FIO_OPT_STR_VAL,
420 .off1 = td_var_offset(file_size_low),
421 .off2 = td_var_offset(file_size_high),
423 .help = "Size of individual files",
427 .alias = "fileoffset",
428 .type = FIO_OPT_STR_VAL,
429 .off1 = td_var_offset(start_offset),
430 .help = "Start IO from this offset",
435 .alias = "blocksize",
436 .type = FIO_OPT_STR_VAL_INT,
437 .off1 = td_var_offset(bs[DDIR_READ]),
438 .off2 = td_var_offset(bs[DDIR_WRITE]),
440 .help = "Block size unit",
446 .alias = "blocksize_range",
447 .type = FIO_OPT_RANGE,
448 .off1 = td_var_offset(min_bs[DDIR_READ]),
449 .off2 = td_var_offset(max_bs[DDIR_READ]),
450 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
451 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
453 .help = "Set block size range (in more detail than bs)",
457 .name = "bs_unaligned",
458 .alias = "blocksize_unaligned",
459 .type = FIO_OPT_STR_SET,
460 .off1 = td_var_offset(bs_unaligned),
461 .help = "Don't sector align IO buffer sizes",
465 .name = "randrepeat",
466 .type = FIO_OPT_BOOL,
467 .off1 = td_var_offset(rand_repeatable),
468 .help = "Use repeatable random IO pattern",
473 .name = "norandommap",
474 .type = FIO_OPT_STR_SET,
475 .off1 = td_var_offset(norandommap),
476 .help = "Accept potential duplicate random blocks",
482 .off1 = td_var_offset(nr_files),
483 .help = "Split job workload between this number of files",
489 .off1 = td_var_offset(open_files),
490 .help = "Number of files to keep open at the same time",
493 .name = "file_service_type",
496 .off1 = td_var_offset(file_service_type),
497 .help = "How to select which file to service next",
501 .oval = FIO_FSERVICE_RANDOM,
502 .help = "Choose a file at random",
504 { .ival = "roundrobin",
505 .oval = FIO_FSERVICE_RR,
506 .help = "Round robin select files",
512 .name = "fadvise_hint",
513 .type = FIO_OPT_BOOL,
514 .off1 = td_var_offset(fadvise_hint),
515 .help = "Use fadvise() to advise the kernel on IO pattern",
521 .off1 = td_var_offset(fsync_blocks),
522 .help = "Issue fsync for writes every given number of blocks",
527 .type = FIO_OPT_BOOL,
528 .off1 = td_var_offset(odirect),
529 .help = "Use O_DIRECT IO (negates buffered)",
534 .type = FIO_OPT_BOOL,
535 .off1 = td_var_offset(odirect),
537 .help = "Use buffered IO (negates direct)",
542 .type = FIO_OPT_BOOL,
543 .off1 = td_var_offset(overwrite),
544 .help = "When writing, set whether to overwrite current data",
550 .off1 = td_var_offset(loops),
551 .help = "Number of times to run the job",
557 .off1 = td_var_offset(numjobs),
558 .help = "Duplicate this job this many times",
562 .name = "startdelay",
564 .off1 = td_var_offset(start_delay),
565 .help = "Only start job when this period has passed",
571 .type = FIO_OPT_STR_VAL_TIME,
572 .off1 = td_var_offset(timeout),
573 .help = "Stop workload when this amount of time has passed",
577 .name = "time_based",
578 .type = FIO_OPT_STR_SET,
579 .off1 = td_var_offset(time_based),
580 .help = "Keep running until runtime/timeout is met",
587 .off1 = td_var_offset(mem_type),
588 .help = "Backing type for IO buffers",
593 .help = "Use malloc(3) for IO buffers",
597 .help = "Use shared memory segments for IO buffers",
599 #ifdef FIO_HAVE_HUGETLB
602 .help = "Like shm, but use huge pages",
607 .help = "Use mmap(2) (file or anon) for IO buffers",
609 #ifdef FIO_HAVE_HUGETLB
610 { .ival = "mmaphuge",
611 .oval = MEM_MMAPHUGE,
612 .help = "Like mmap, but use huge pages",
620 .off1 = td_var_offset(verify),
622 .help = "Verify data written",
627 .help = "Don't do IO verification",
631 .help = "Use md5 checksums for verification",
634 .oval = VERIFY_CRC64,
635 .help = "Use crc64 checksums for verification",
638 .oval = VERIFY_CRC32,
639 .help = "Use crc32 checksums for verification",
642 .oval = VERIFY_CRC16,
643 .help = "Use crc16 checksums for verification",
647 .help = "Use crc7 checksums for verification",
650 .oval = VERIFY_SHA256,
651 .help = "Use sha256 checksums for verification",
654 .oval = VERIFY_SHA512,
655 .help = "Use sha512 checksums for verification",
659 .help = "Use io information",
662 .oval = VERIFY_PATTERN,
663 .help = "Verify a specific buffer pattern",
668 .help = "Pretend to verify",
674 .type = FIO_OPT_BOOL,
675 .off1 = td_var_offset(do_verify),
676 .help = "Run verification stage after write",
681 .name = "verifysort",
682 .type = FIO_OPT_BOOL,
683 .off1 = td_var_offset(verifysort),
684 .help = "Sort written verify blocks for read back",
689 .name = "verify_interval",
690 .type = FIO_OPT_STR_VAL_INT,
691 .off1 = td_var_offset(verify_interval),
692 .minval = 2 * sizeof(struct verify_header),
693 .help = "Store verify buffer header every N bytes",
697 .name = "verify_offset",
698 .type = FIO_OPT_STR_VAL_INT,
699 .help = "Offset verify header location by N bytes",
701 .cb = str_verify_offset_cb,
705 .name = "verify_fatal",
706 .type = FIO_OPT_BOOL,
707 .off1 = td_var_offset(verify_fatal),
709 .help = "Exit on a single verify failure, don't continue",
713 .name = "write_iolog",
714 .type = FIO_OPT_STR_STORE,
715 .off1 = td_var_offset(write_iolog_file),
716 .help = "Store IO pattern to file",
719 .name = "read_iolog",
720 .type = FIO_OPT_STR_STORE,
721 .off1 = td_var_offset(read_iolog_file),
722 .help = "Playback IO pattern from file",
725 .name = "exec_prerun",
726 .type = FIO_OPT_STR_STORE,
727 .off1 = td_var_offset(exec_prerun),
728 .help = "Execute this file prior to running job",
731 .name = "exec_postrun",
732 .type = FIO_OPT_STR_STORE,
733 .off1 = td_var_offset(exec_postrun),
734 .help = "Execute this file after running job",
736 #ifdef FIO_HAVE_IOSCHED_SWITCH
738 .name = "ioscheduler",
739 .type = FIO_OPT_STR_STORE,
740 .off1 = td_var_offset(ioscheduler),
741 .help = "Use this IO scheduler on the backing device",
746 .type = FIO_OPT_STR_VAL,
747 .off1 = td_var_offset(zone_size),
748 .help = "Give size of an IO zone",
753 .type = FIO_OPT_STR_VAL,
754 .off1 = td_var_offset(zone_skip),
755 .help = "Space between IO zones",
760 .type = FIO_OPT_STR_VAL,
761 .cb = str_lockmem_cb,
762 .help = "Lock down this amount of memory",
768 .off1 = td_var_offset(rwmix[DDIR_READ]),
770 .help = "Percentage of mixed workload that is reads",
774 .name = "rwmixwrite",
776 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
778 .help = "Percentage of mixed workload that is writes",
782 .name = "rwmixcycle",
784 .off1 = td_var_offset(rwmixcycle),
785 .help = "Cycle period for mixed read/write workloads (msec)",
787 .parent = "rwmixread",
792 .off1 = td_var_offset(nice),
793 .help = "Set job CPU nice value",
798 #ifdef FIO_HAVE_IOPRIO
803 .help = "Set job IO priority value",
810 .cb = str_prioclass_cb,
811 .help = "Set job IO priority class",
819 .off1 = td_var_offset(thinktime),
820 .help = "Idle time between IO buffers (usec)",
824 .name = "thinktime_spin",
826 .off1 = td_var_offset(thinktime_spin),
827 .help = "Start think time by spinning this amount (usec)",
829 .parent = "thinktime",
832 .name = "thinktime_blocks",
834 .off1 = td_var_offset(thinktime_blocks),
835 .help = "IO buffer period between 'thinktime'",
837 .parent = "thinktime",
842 .off1 = td_var_offset(rate),
843 .help = "Set bandwidth rate",
848 .off1 = td_var_offset(ratemin),
849 .help = "Job must meet this rate or it will be shutdown",
855 .off1 = td_var_offset(rate_iops),
856 .help = "Limit IO used to this number of IO operations/sec",
859 .name = "rate_iops_min",
861 .off1 = td_var_offset(rate_iops_min),
862 .help = "Job must meet this rate or it will be shutdown",
863 .parent = "rate_iops",
868 .off1 = td_var_offset(ratecycle),
869 .help = "Window average for rate limits (msec)",
874 .name = "invalidate",
875 .type = FIO_OPT_BOOL,
876 .off1 = td_var_offset(invalidate_cache),
877 .help = "Invalidate buffer/page cache prior to running job",
882 .type = FIO_OPT_BOOL,
883 .off1 = td_var_offset(sync_io),
884 .help = "Use O_SYNC for buffered writes",
886 .parent = "buffered",
891 .off1 = td_var_offset(bw_avg_time),
892 .help = "Time window over which to calculate bandwidth (msec)",
896 .name = "create_serialize",
897 .type = FIO_OPT_BOOL,
898 .off1 = td_var_offset(create_serialize),
899 .help = "Serialize creating of job files",
903 .name = "create_fsync",
904 .type = FIO_OPT_BOOL,
905 .off1 = td_var_offset(create_fsync),
906 .help = "Fsync file after creation",
912 .off1 = td_var_offset(cpuload),
913 .help = "Use this percentage of CPU",
918 .off1 = td_var_offset(cpucycle),
919 .help = "Length of the CPU burn cycles (usecs)",
923 #ifdef FIO_HAVE_CPU_AFFINITY
927 .cb = str_cpumask_cb,
928 .help = "CPU affinity mask",
931 .name = "cpus_allowed",
933 .cb = str_cpus_allowed_cb,
934 .help = "Set CPUs allowed",
939 .type = FIO_OPT_BOOL,
940 .off1 = td_var_offset(end_fsync),
941 .help = "Include fsync at the end of job",
945 .name = "fsync_on_close",
946 .type = FIO_OPT_BOOL,
947 .off1 = td_var_offset(fsync_on_close),
948 .help = "fsync files on close",
953 .type = FIO_OPT_BOOL,
954 .off1 = td_var_offset(unlink),
955 .help = "Unlink created files after job has completed",
960 .type = FIO_OPT_STR_SET,
961 .cb = str_exitall_cb,
962 .help = "Terminate all jobs when one exits",
966 .type = FIO_OPT_STR_SET,
967 .off1 = td_var_offset(stonewall),
968 .help = "Insert a hard barrier between this job and previous",
972 .type = FIO_OPT_STR_SET,
973 .off1 = td_var_offset(new_group),
974 .help = "Mark the start of a new group (for reporting)",
978 .type = FIO_OPT_STR_SET,
979 .off1 = td_var_offset(use_thread),
980 .help = "Use threads instead of forks",
983 .name = "write_bw_log",
984 .type = FIO_OPT_STR_SET,
985 .off1 = td_var_offset(write_bw_log),
986 .help = "Write log of bandwidth during run",
989 .name = "write_lat_log",
990 .type = FIO_OPT_STR_SET,
991 .off1 = td_var_offset(write_lat_log),
992 .help = "Write log of latency during run",
995 .name = "hugepage-size",
996 .type = FIO_OPT_STR_VAL,
997 .off1 = td_var_offset(hugepage_size),
998 .help = "When using hugepages, specify size of each page",
999 .def = __stringify(FIO_HUGE_PAGE),
1002 .name = "group_reporting",
1003 .type = FIO_OPT_STR_SET,
1004 .off1 = td_var_offset(group_reporting),
1005 .help = "Do reporting on a per-group basis",
1008 .name = "zero_buffers",
1009 .type = FIO_OPT_STR_SET,
1010 .off1 = td_var_offset(zero_buffers),
1011 .help = "Init IO buffers to all zeroes",
1013 #ifdef FIO_HAVE_DISK_UTIL
1015 .name = "disk_util",
1016 .type = FIO_OPT_BOOL,
1017 .off1 = td_var_offset(do_disk_util),
1018 .help = "Log disk utilization stats",
1027 void fio_options_dup_and_init(struct option *long_options)
1029 struct fio_option *o;
1032 options_init(options);
1035 while (long_options[i].name)
1040 long_options[i].name = o->name;
1041 long_options[i].val = FIO_GETOPT_JOB;
1042 if (o->type == FIO_OPT_STR_SET)
1043 long_options[i].has_arg = no_argument;
1045 long_options[i].has_arg = required_argument;
1049 assert(i < FIO_NR_OPTIONS);
1053 int fio_option_parse(struct thread_data *td, const char *opt)
1055 return parse_option(opt, options, td);
1058 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1060 return parse_cmd_option(opt, val, options, td);
1063 void fio_fill_default_options(struct thread_data *td)
1065 fill_default_options(td, options);
1068 int fio_show_option_help(const char *opt)
1070 return show_cmd_help(options, opt);
1073 static void __options_mem(struct thread_data *td, int alloc)
1075 struct thread_options *o = &td->o;
1076 struct fio_option *opt;
1080 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1081 if (opt->type != FIO_OPT_STR_STORE)
1084 ptr = (void *) o + opt->off1;
1087 *ptr = strdup(*ptr);
1097 * dupe FIO_OPT_STR_STORE options
1099 void options_mem_dupe(struct thread_data *td)
1101 __options_mem(td, 1);
1104 void options_mem_free(struct thread_data fio_unused *td)
1107 __options_mem(td, 0);