12 #define td_var_offset(var) ((size_t) &((struct thread_options *)0)->var)
15 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
17 static char *get_opt_postfix(const char *str)
19 char *p = strstr(str, ":");
25 strip_blank_front(&p);
30 static int str_rw_cb(void *data, const char *str)
32 struct thread_data *td = data;
33 char *nr = get_opt_postfix(str);
37 td->o.ddir_nr = atoi(nr);
42 static int str_mem_cb(void *data, const char *mem)
44 struct thread_data *td = data;
46 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
47 td->mmapfile = get_opt_postfix(mem);
48 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
49 log_err("fio: mmaphuge:/path/to/file\n");
57 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
63 #ifdef FIO_HAVE_IOPRIO
64 static int str_prioclass_cb(void *data, unsigned int *val)
66 struct thread_data *td = data;
70 * mask off old class bits, str_prio_cb() may have set a default class
72 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
75 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
79 static int str_prio_cb(void *data, unsigned int *val)
81 struct thread_data *td = data;
86 * If no class is set, assume BE
88 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
89 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
95 static int str_exitall_cb(void)
97 exitall_on_terminate = 1;
101 #ifdef FIO_HAVE_CPU_AFFINITY
102 static int str_cpumask_cb(void *data, unsigned int *val)
104 struct thread_data *td = data;
107 CPU_ZERO(&td->o.cpumask);
109 for (i = 0; i < sizeof(int) * 8; i++)
111 CPU_SET(*val, &td->o.cpumask);
113 td->o.cpumask_set = 1;
117 static int str_cpus_allowed_cb(void *data, const char *input)
119 struct thread_data *td = data;
122 CPU_ZERO(&td->o.cpumask);
124 p = str = strdup(input);
126 strip_blank_front(&str);
127 strip_blank_end(str);
129 while ((cpu = strsep(&str, ",")) != NULL) {
132 CPU_SET(atoi(cpu), &td->o.cpumask);
136 td->o.cpumask_set = 1;
142 static int str_fst_cb(void *data, const char *str)
144 struct thread_data *td = data;
145 char *nr = get_opt_postfix(str);
147 td->file_service_nr = 1;
149 td->file_service_nr = atoi(nr);
154 static int str_filename_cb(void *data, const char *input)
156 struct thread_data *td = data;
157 char *fname, *str, *p;
159 p = str = strdup(input);
161 strip_blank_front(&str);
162 strip_blank_end(str);
164 if (!td->files_index)
167 while ((fname = strsep(&str, ":")) != NULL) {
178 static int str_directory_cb(void *data, const char fio_unused *str)
180 struct thread_data *td = data;
183 if (lstat(td->o.directory, &sb) < 0) {
184 log_err("fio: %s is not a directory\n", td->o.directory);
185 td_verror(td, errno, "lstat");
188 if (!S_ISDIR(sb.st_mode)) {
189 log_err("fio: %s is not a directory\n", td->o.directory);
196 static int str_opendir_cb(void *data, const char fio_unused *str)
198 struct thread_data *td = data;
200 if (!td->files_index)
203 return add_dir_files(td, td->o.opendir);
207 #define __stringify_1(x) #x
208 #define __stringify(x) __stringify_1(x)
211 * Map of job/command line options
213 static struct fio_option options[] = {
215 .name = "description",
216 .type = FIO_OPT_STR_STORE,
217 .off1 = td_var_offset(description),
218 .help = "Text job description",
222 .type = FIO_OPT_STR_STORE,
223 .off1 = td_var_offset(name),
224 .help = "Name of this job",
228 .type = FIO_OPT_STR_STORE,
229 .off1 = td_var_offset(directory),
230 .cb = str_directory_cb,
231 .help = "Directory to store files in",
235 .type = FIO_OPT_STR_STORE,
236 .off1 = td_var_offset(filename),
237 .cb = str_filename_cb,
238 .help = "File(s) to use for the workload",
242 .type = FIO_OPT_STR_STORE,
243 .off1 = td_var_offset(opendir),
244 .cb = str_opendir_cb,
245 .help = "Recursively add files from this directory and down",
249 .alias = "readwrite",
252 .off1 = td_var_offset(td_ddir),
253 .help = "IO direction",
257 .oval = TD_DDIR_READ,
258 .help = "Sequential read",
261 .oval = TD_DDIR_WRITE,
262 .help = "Sequential write",
264 { .ival = "randread",
265 .oval = TD_DDIR_RANDREAD,
266 .help = "Random read",
268 { .ival = "randwrite",
269 .oval = TD_DDIR_RANDWRITE,
270 .help = "Random write",
274 .help = "Sequential read and write mix",
277 .oval = TD_DDIR_RANDRW,
278 .help = "Random read and write mix"
283 .name = "fadvise_hint",
284 .type = FIO_OPT_BOOL,
285 .off1 = td_var_offset(fadvise_hint),
286 .help = "Use fadvise() to advise the kernel on IO pattern",
291 .type = FIO_OPT_STR_STORE,
292 .off1 = td_var_offset(ioengine),
293 .help = "IO engine to use",
297 .help = "Use read/write",
299 #ifdef FIO_HAVE_LIBAIO
301 .help = "Linux native asynchronous IO",
304 #ifdef FIO_HAVE_POSIXAIO
305 { .ival = "posixaio",
306 .help = "POSIX asynchronous IO",
310 .help = "Memory mapped IO",
312 #ifdef FIO_HAVE_SPLICE
314 .help = "splice/vmsplice based IO",
316 { .ival = "netsplice",
317 .help = "splice/vmsplice to/from the network",
322 .help = "SCSI generic v3 IO",
326 .help = "Testing engine (no data transfer)",
329 .help = "Network IO",
331 #ifdef FIO_HAVE_SYSLET
332 { .ival = "syslet-rw",
333 .help = "syslet enabled async pread/pwrite IO",
337 .help = "CPU cycler burner engine",
339 #ifdef FIO_HAVE_GUASI
341 .help = "GUASI IO engine",
344 { .ival = "external",
345 .help = "Load external engine (append name)",
352 .off1 = td_var_offset(iodepth),
353 .help = "Amount of IO buffers to keep in flight",
357 .name = "iodepth_batch",
359 .off1 = td_var_offset(iodepth_batch),
360 .help = "Number of IO to submit in one go",
363 .name = "iodepth_low",
365 .off1 = td_var_offset(iodepth_low),
366 .help = "Low water mark for queuing depth",
370 .type = FIO_OPT_STR_VAL,
371 .off1 = td_var_offset(size),
373 .help = "Total size of device or files",
377 .type = FIO_OPT_STR_VAL,
378 .off1 = td_var_offset(file_size_low),
379 .off2 = td_var_offset(file_size_high),
381 .help = "Size of individual files",
385 .alias = "blocksize",
386 .type = FIO_OPT_STR_VAL_INT,
387 .off1 = td_var_offset(bs[DDIR_READ]),
388 .off2 = td_var_offset(bs[DDIR_WRITE]),
390 .help = "Block size unit",
395 .alias = "blocksize_range",
396 .type = FIO_OPT_RANGE,
397 .off1 = td_var_offset(min_bs[DDIR_READ]),
398 .off2 = td_var_offset(max_bs[DDIR_READ]),
399 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
400 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
402 .help = "Set block size range (in more detail than bs)",
405 .name = "bs_unaligned",
406 .alias = "blocksize_unaligned",
407 .type = FIO_OPT_STR_SET,
408 .off1 = td_var_offset(bs_unaligned),
409 .help = "Don't sector align IO buffer sizes",
413 .type = FIO_OPT_STR_VAL,
414 .off1 = td_var_offset(start_offset),
415 .help = "Start IO from this offset",
419 .name = "randrepeat",
420 .type = FIO_OPT_BOOL,
421 .off1 = td_var_offset(rand_repeatable),
422 .help = "Use repeatable random IO pattern",
426 .name = "norandommap",
427 .type = FIO_OPT_STR_SET,
428 .off1 = td_var_offset(norandommap),
429 .help = "Accept potential duplicate random blocks",
434 .off1 = td_var_offset(nr_files),
435 .help = "Split job workload between this number of files",
441 .off1 = td_var_offset(open_files),
442 .help = "Number of files to keep open at the same time",
445 .name = "file_service_type",
448 .off1 = td_var_offset(file_service_type),
449 .help = "How to select which file to service next",
453 .oval = FIO_FSERVICE_RANDOM,
454 .help = "Choose a file at random",
456 { .ival = "roundrobin",
457 .oval = FIO_FSERVICE_RR,
458 .help = "Round robin select files",
465 .off1 = td_var_offset(fsync_blocks),
466 .help = "Issue fsync for writes every given number of blocks",
471 .type = FIO_OPT_BOOL,
472 .off1 = td_var_offset(odirect),
473 .help = "Use O_DIRECT IO (negates buffered)",
478 .type = FIO_OPT_BOOL,
479 .off1 = td_var_offset(odirect),
481 .help = "Use buffered IO (negates direct)",
486 .type = FIO_OPT_BOOL,
487 .off1 = td_var_offset(overwrite),
488 .help = "When writing, set whether to overwrite current data",
494 .off1 = td_var_offset(loops),
495 .help = "Number of times to run the job",
501 .off1 = td_var_offset(numjobs),
502 .help = "Duplicate this job this many times",
506 .name = "startdelay",
508 .off1 = td_var_offset(start_delay),
509 .help = "Only start job when this period has passed",
515 .type = FIO_OPT_STR_VAL_TIME,
516 .off1 = td_var_offset(timeout),
517 .help = "Stop workload when this amount of time has passed",
521 .name = "time_based",
522 .type = FIO_OPT_STR_SET,
523 .off1 = td_var_offset(time_based),
524 .help = "Keep running until runtime/timeout is met",
531 .off1 = td_var_offset(mem_type),
532 .help = "Backing type for IO buffers",
537 .help = "Use malloc(3) for IO buffers",
541 .help = "Use shared memory segments for IO buffers",
543 #ifdef FIO_HAVE_HUGETLB
546 .help = "Like shm, but use huge pages",
551 .help = "Use mmap(2) (file or anon) for IO buffers",
553 #ifdef FIO_HAVE_HUGETLB
554 { .ival = "mmaphuge",
555 .oval = MEM_MMAPHUGE,
556 .help = "Like mmap, but use huge pages",
564 .off1 = td_var_offset(verify),
565 .help = "Verify data written",
570 .help = "Don't do IO verification",
573 .oval = VERIFY_CRC32,
574 .help = "Use crc32 checksums for verification",
577 .oval = VERIFY_CRC16,
578 .help = "Use crc16 checksums for verification",
582 .help = "Use md5 checksums for verification",
587 .help = "Pretend to verify",
592 .name = "verifysort",
593 .type = FIO_OPT_BOOL,
594 .off1 = td_var_offset(verifysort),
595 .help = "Sort written verify blocks for read back",
599 .name = "write_iolog",
600 .type = FIO_OPT_STR_STORE,
601 .off1 = td_var_offset(write_iolog_file),
602 .help = "Store IO pattern to file",
605 .name = "read_iolog",
606 .type = FIO_OPT_STR_STORE,
607 .off1 = td_var_offset(read_iolog_file),
608 .help = "Playback IO pattern from file",
611 .name = "exec_prerun",
612 .type = FIO_OPT_STR_STORE,
613 .off1 = td_var_offset(exec_prerun),
614 .help = "Execute this file prior to running job",
617 .name = "exec_postrun",
618 .type = FIO_OPT_STR_STORE,
619 .off1 = td_var_offset(exec_postrun),
620 .help = "Execute this file after running job",
622 #ifdef FIO_HAVE_IOSCHED_SWITCH
624 .name = "ioscheduler",
625 .type = FIO_OPT_STR_STORE,
626 .off1 = td_var_offset(ioscheduler),
627 .help = "Use this IO scheduler on the backing device",
632 .type = FIO_OPT_STR_VAL,
633 .off1 = td_var_offset(zone_size),
634 .help = "Give size of an IO zone",
639 .type = FIO_OPT_STR_VAL,
640 .off1 = td_var_offset(zone_skip),
641 .help = "Space between IO zones",
646 .type = FIO_OPT_STR_VAL,
647 .cb = str_lockmem_cb,
648 .help = "Lock down this amount of memory",
652 .name = "rwmixcycle",
654 .off1 = td_var_offset(rwmixcycle),
655 .help = "Cycle period for mixed read/write workloads (msec)",
661 .off1 = td_var_offset(rwmix[DDIR_READ]),
663 .help = "Percentage of mixed workload that is reads",
667 .name = "rwmixwrite",
669 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
671 .help = "Percentage of mixed workload that is writes",
677 .off1 = td_var_offset(nice),
678 .help = "Set job CPU nice value",
683 #ifdef FIO_HAVE_IOPRIO
688 .help = "Set job IO priority value",
695 .cb = str_prioclass_cb,
696 .help = "Set job IO priority class",
704 .off1 = td_var_offset(thinktime),
705 .help = "Idle time between IO buffers (usec)",
709 .name = "thinktime_spin",
711 .off1 = td_var_offset(thinktime_spin),
712 .help = "Start think time by spinning this amount (usec)",
716 .name = "thinktime_blocks",
718 .off1 = td_var_offset(thinktime_blocks),
719 .help = "IO buffer period between 'thinktime'",
725 .off1 = td_var_offset(rate),
726 .help = "Set bandwidth rate",
731 .off1 = td_var_offset(ratemin),
732 .help = "Job must meet this rate or it will be shutdown",
737 .off1 = td_var_offset(rate_iops),
738 .help = "Limit IO used to this number of IO operations/sec",
741 .name = "rate_iops_min",
743 .off1 = td_var_offset(rate_iops_min),
744 .help = "Job must meet this rate or it will be shutdown",
749 .off1 = td_var_offset(ratecycle),
750 .help = "Window average for rate limits (msec)",
754 .name = "invalidate",
755 .type = FIO_OPT_BOOL,
756 .off1 = td_var_offset(invalidate_cache),
757 .help = "Invalidate buffer/page cache prior to running job",
762 .type = FIO_OPT_BOOL,
763 .off1 = td_var_offset(sync_io),
764 .help = "Use O_SYNC for buffered writes",
770 .off1 = td_var_offset(bw_avg_time),
771 .help = "Time window over which to calculate bandwidth (msec)",
775 .name = "create_serialize",
776 .type = FIO_OPT_BOOL,
777 .off1 = td_var_offset(create_serialize),
778 .help = "Serialize creating of job files",
782 .name = "create_fsync",
783 .type = FIO_OPT_BOOL,
784 .off1 = td_var_offset(create_fsync),
785 .help = "Fsync file after creation",
791 .off1 = td_var_offset(cpuload),
792 .help = "Use this percentage of CPU",
797 .off1 = td_var_offset(cpucycle),
798 .help = "Length of the CPU burn cycles (usecs)",
801 #ifdef FIO_HAVE_CPU_AFFINITY
805 .cb = str_cpumask_cb,
806 .help = "CPU affinity mask",
809 .name = "cpus_allowed",
811 .cb = str_cpus_allowed_cb,
812 .help = "Set CPUs allowed",
817 .type = FIO_OPT_BOOL,
818 .off1 = td_var_offset(end_fsync),
819 .help = "Include fsync at the end of job",
823 .name = "fsync_on_close",
824 .type = FIO_OPT_BOOL,
825 .off1 = td_var_offset(fsync_on_close),
826 .help = "fsync files on close",
831 .type = FIO_OPT_BOOL,
832 .off1 = td_var_offset(unlink),
833 .help = "Unlink created files after job has completed",
838 .type = FIO_OPT_STR_SET,
839 .cb = str_exitall_cb,
840 .help = "Terminate all jobs when one exits",
844 .type = FIO_OPT_STR_SET,
845 .off1 = td_var_offset(stonewall),
846 .help = "Insert a hard barrier between this job and previous",
850 .type = FIO_OPT_STR_SET,
851 .off1 = td_var_offset(new_group),
852 .help = "Mark the start of a new group (for reporting)",
856 .type = FIO_OPT_STR_SET,
857 .off1 = td_var_offset(use_thread),
858 .help = "Use threads instead of forks",
861 .name = "write_bw_log",
862 .type = FIO_OPT_STR_SET,
863 .off1 = td_var_offset(write_bw_log),
864 .help = "Write log of bandwidth during run",
867 .name = "write_lat_log",
868 .type = FIO_OPT_STR_SET,
869 .off1 = td_var_offset(write_lat_log),
870 .help = "Write log of latency during run",
873 .name = "hugepage-size",
874 .type = FIO_OPT_STR_VAL,
875 .off1 = td_var_offset(hugepage_size),
876 .help = "When using hugepages, specify size of each page",
877 .def = __stringify(FIO_HUGE_PAGE),
880 .name = "group_reporting",
881 .type = FIO_OPT_STR_SET,
882 .off1 = td_var_offset(group_reporting),
883 .help = "Do reporting on a per-group basis",
886 .name = "zero_buffers",
887 .type = FIO_OPT_STR_SET,
888 .off1 = td_var_offset(zero_buffers),
889 .help = "Init IO buffers to all zeroes",
891 #ifdef FIO_HAVE_DISK_UTIL
894 .type = FIO_OPT_BOOL,
895 .off1 = td_var_offset(do_disk_util),
896 .help = "Log disk utilization stats",
905 void fio_options_dup_and_init(struct option *long_options)
907 struct fio_option *o;
910 options_init(options);
913 while (long_options[i].name)
918 long_options[i].name = o->name;
919 long_options[i].val = FIO_GETOPT_JOB;
920 if (o->type == FIO_OPT_STR_SET)
921 long_options[i].has_arg = no_argument;
923 long_options[i].has_arg = required_argument;
927 assert(i < FIO_NR_OPTIONS);
931 int fio_option_parse(struct thread_data *td, const char *opt)
933 return parse_option(opt, options, td);
936 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
938 return parse_cmd_option(opt, val, options, td);
941 void fio_fill_default_options(struct thread_data *td)
943 fill_default_options(td, options);
946 int fio_show_option_help(const char *opt)
948 return show_cmd_help(options, opt);
951 static void __options_mem(struct thread_data *td, int alloc)
953 struct thread_options *o = &td->o;
954 struct fio_option *opt;
958 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
959 if (opt->type != FIO_OPT_STR_STORE)
962 ptr = (void *) o + opt->off1;
975 * dupe FIO_OPT_STR_STORE options
977 void options_mem_dupe(struct thread_data *td)
979 __options_mem(td, 1);
982 void options_mem_free(struct thread_data fio_unused *td)
985 __options_mem(td, 0);