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),
372 .help = "Total size of device or files",
376 .type = FIO_OPT_STR_VAL,
377 .off1 = td_var_offset(file_size_low),
378 .off2 = td_var_offset(file_size_high),
379 .help = "Size of individual files",
383 .alias = "blocksize",
384 .type = FIO_OPT_STR_VAL_INT,
385 .off1 = td_var_offset(bs[DDIR_READ]),
386 .off2 = td_var_offset(bs[DDIR_WRITE]),
387 .help = "Block size unit",
392 .alias = "blocksize_range",
393 .type = FIO_OPT_RANGE,
394 .off1 = td_var_offset(min_bs[DDIR_READ]),
395 .off2 = td_var_offset(max_bs[DDIR_READ]),
396 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
397 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
398 .help = "Set block size range (in more detail than bs)",
401 .name = "bs_unaligned",
402 .alias = "blocksize_unaligned",
403 .type = FIO_OPT_STR_SET,
404 .off1 = td_var_offset(bs_unaligned),
405 .help = "Don't sector align IO buffer sizes",
409 .type = FIO_OPT_STR_VAL,
410 .off1 = td_var_offset(start_offset),
411 .help = "Start IO from this offset",
415 .name = "randrepeat",
416 .type = FIO_OPT_BOOL,
417 .off1 = td_var_offset(rand_repeatable),
418 .help = "Use repeatable random IO pattern",
422 .name = "norandommap",
423 .type = FIO_OPT_STR_SET,
424 .off1 = td_var_offset(norandommap),
425 .help = "Accept potential duplicate random blocks",
430 .off1 = td_var_offset(nr_files),
431 .help = "Split job workload between this number of files",
437 .off1 = td_var_offset(open_files),
438 .help = "Number of files to keep open at the same time",
441 .name = "file_service_type",
444 .off1 = td_var_offset(file_service_type),
445 .help = "How to select which file to service next",
449 .oval = FIO_FSERVICE_RANDOM,
450 .help = "Choose a file at random",
452 { .ival = "roundrobin",
453 .oval = FIO_FSERVICE_RR,
454 .help = "Round robin select files",
461 .off1 = td_var_offset(fsync_blocks),
462 .help = "Issue fsync for writes every given number of blocks",
467 .type = FIO_OPT_BOOL,
468 .off1 = td_var_offset(odirect),
469 .help = "Use O_DIRECT IO (negates buffered)",
474 .type = FIO_OPT_BOOL,
475 .off1 = td_var_offset(odirect),
477 .help = "Use buffered IO (negates direct)",
482 .type = FIO_OPT_BOOL,
483 .off1 = td_var_offset(overwrite),
484 .help = "When writing, set whether to overwrite current data",
490 .off1 = td_var_offset(loops),
491 .help = "Number of times to run the job",
497 .off1 = td_var_offset(numjobs),
498 .help = "Duplicate this job this many times",
502 .name = "startdelay",
504 .off1 = td_var_offset(start_delay),
505 .help = "Only start job when this period has passed",
511 .type = FIO_OPT_STR_VAL_TIME,
512 .off1 = td_var_offset(timeout),
513 .help = "Stop workload when this amount of time has passed",
517 .name = "time_based",
518 .type = FIO_OPT_STR_SET,
519 .off1 = td_var_offset(time_based),
520 .help = "Keep running until runtime/timeout is met",
527 .off1 = td_var_offset(mem_type),
528 .help = "Backing type for IO buffers",
533 .help = "Use malloc(3) for IO buffers",
537 .help = "Use shared memory segments for IO buffers",
539 #ifdef FIO_HAVE_HUGETLB
542 .help = "Like shm, but use huge pages",
547 .help = "Use mmap(2) (file or anon) for IO buffers",
549 #ifdef FIO_HAVE_HUGETLB
550 { .ival = "mmaphuge",
551 .oval = MEM_MMAPHUGE,
552 .help = "Like mmap, but use huge pages",
560 .off1 = td_var_offset(verify),
561 .help = "Verify data written",
566 .help = "Don't do IO verification",
569 .oval = VERIFY_CRC32,
570 .help = "Use crc32 checksums for verification",
574 .help = "Use md5 checksums for verification",
579 .help = "Pretend to verify",
584 .name = "verifysort",
585 .type = FIO_OPT_BOOL,
586 .off1 = td_var_offset(verifysort),
587 .help = "Sort written verify blocks for read back",
591 .name = "write_iolog",
592 .type = FIO_OPT_STR_STORE,
593 .off1 = td_var_offset(write_iolog_file),
594 .help = "Store IO pattern to file",
597 .name = "read_iolog",
598 .type = FIO_OPT_STR_STORE,
599 .off1 = td_var_offset(read_iolog_file),
600 .help = "Playback IO pattern from file",
603 .name = "exec_prerun",
604 .type = FIO_OPT_STR_STORE,
605 .off1 = td_var_offset(exec_prerun),
606 .help = "Execute this file prior to running job",
609 .name = "exec_postrun",
610 .type = FIO_OPT_STR_STORE,
611 .off1 = td_var_offset(exec_postrun),
612 .help = "Execute this file after running job",
614 #ifdef FIO_HAVE_IOSCHED_SWITCH
616 .name = "ioscheduler",
617 .type = FIO_OPT_STR_STORE,
618 .off1 = td_var_offset(ioscheduler),
619 .help = "Use this IO scheduler on the backing device",
624 .type = FIO_OPT_STR_VAL,
625 .off1 = td_var_offset(zone_size),
626 .help = "Give size of an IO zone",
631 .type = FIO_OPT_STR_VAL,
632 .off1 = td_var_offset(zone_skip),
633 .help = "Space between IO zones",
638 .type = FIO_OPT_STR_VAL,
639 .cb = str_lockmem_cb,
640 .help = "Lock down this amount of memory",
644 .name = "rwmixcycle",
646 .off1 = td_var_offset(rwmixcycle),
647 .help = "Cycle period for mixed read/write workloads (msec)",
653 .off1 = td_var_offset(rwmix[DDIR_READ]),
655 .help = "Percentage of mixed workload that is reads",
659 .name = "rwmixwrite",
661 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
663 .help = "Percentage of mixed workload that is writes",
669 .off1 = td_var_offset(nice),
670 .help = "Set job CPU nice value",
675 #ifdef FIO_HAVE_IOPRIO
680 .help = "Set job IO priority value",
687 .cb = str_prioclass_cb,
688 .help = "Set job IO priority class",
696 .off1 = td_var_offset(thinktime),
697 .help = "Idle time between IO buffers (usec)",
701 .name = "thinktime_spin",
703 .off1 = td_var_offset(thinktime_spin),
704 .help = "Start think time by spinning this amount (usec)",
708 .name = "thinktime_blocks",
710 .off1 = td_var_offset(thinktime_blocks),
711 .help = "IO buffer period between 'thinktime'",
717 .off1 = td_var_offset(rate),
718 .help = "Set bandwidth rate",
723 .off1 = td_var_offset(ratemin),
724 .help = "Job must meet this rate or it will be shutdown",
729 .off1 = td_var_offset(rate_iops),
730 .help = "Limit IO used to this number of IO operations/sec",
733 .name = "rate_iops_min",
735 .off1 = td_var_offset(rate_iops_min),
736 .help = "Job must meet this rate or it will be shutdown",
741 .off1 = td_var_offset(ratecycle),
742 .help = "Window average for rate limits (msec)",
746 .name = "invalidate",
747 .type = FIO_OPT_BOOL,
748 .off1 = td_var_offset(invalidate_cache),
749 .help = "Invalidate buffer/page cache prior to running job",
754 .type = FIO_OPT_BOOL,
755 .off1 = td_var_offset(sync_io),
756 .help = "Use O_SYNC for buffered writes",
762 .off1 = td_var_offset(bw_avg_time),
763 .help = "Time window over which to calculate bandwidth (msec)",
767 .name = "create_serialize",
768 .type = FIO_OPT_BOOL,
769 .off1 = td_var_offset(create_serialize),
770 .help = "Serialize creating of job files",
774 .name = "create_fsync",
775 .type = FIO_OPT_BOOL,
776 .off1 = td_var_offset(create_fsync),
777 .help = "Fsync file after creation",
783 .off1 = td_var_offset(cpuload),
784 .help = "Use this percentage of CPU",
789 .off1 = td_var_offset(cpucycle),
790 .help = "Length of the CPU burn cycles (usecs)",
793 #ifdef FIO_HAVE_CPU_AFFINITY
797 .cb = str_cpumask_cb,
798 .help = "CPU affinity mask",
801 .name = "cpus_allowed",
803 .cb = str_cpus_allowed_cb,
804 .help = "Set CPUs allowed",
809 .type = FIO_OPT_BOOL,
810 .off1 = td_var_offset(end_fsync),
811 .help = "Include fsync at the end of job",
815 .name = "fsync_on_close",
816 .type = FIO_OPT_BOOL,
817 .off1 = td_var_offset(fsync_on_close),
818 .help = "fsync files on close",
823 .type = FIO_OPT_BOOL,
824 .off1 = td_var_offset(unlink),
825 .help = "Unlink created files after job has completed",
830 .type = FIO_OPT_STR_SET,
831 .cb = str_exitall_cb,
832 .help = "Terminate all jobs when one exits",
836 .type = FIO_OPT_STR_SET,
837 .off1 = td_var_offset(stonewall),
838 .help = "Insert a hard barrier between this job and previous",
842 .type = FIO_OPT_STR_SET,
843 .off1 = td_var_offset(new_group),
844 .help = "Mark the start of a new group (for reporting)",
848 .type = FIO_OPT_STR_SET,
849 .off1 = td_var_offset(use_thread),
850 .help = "Use threads instead of forks",
853 .name = "write_bw_log",
854 .type = FIO_OPT_STR_SET,
855 .off1 = td_var_offset(write_bw_log),
856 .help = "Write log of bandwidth during run",
859 .name = "write_lat_log",
860 .type = FIO_OPT_STR_SET,
861 .off1 = td_var_offset(write_lat_log),
862 .help = "Write log of latency during run",
865 .name = "hugepage-size",
866 .type = FIO_OPT_STR_VAL,
867 .off1 = td_var_offset(hugepage_size),
868 .help = "When using hugepages, specify size of each page",
869 .def = __stringify(FIO_HUGE_PAGE),
872 .name = "group_reporting",
873 .type = FIO_OPT_STR_SET,
874 .off1 = td_var_offset(group_reporting),
875 .help = "Do reporting on a per-group basis",
878 .name = "zero_buffers",
879 .type = FIO_OPT_STR_SET,
880 .off1 = td_var_offset(zero_buffers),
881 .help = "Init IO buffers to all zeroes",
883 #ifdef FIO_HAVE_DISK_UTIL
886 .type = FIO_OPT_BOOL,
887 .off1 = td_var_offset(do_disk_util),
888 .help = "Log disk utilization stats",
897 void fio_options_dup_and_init(struct option *long_options)
899 struct fio_option *o;
902 options_init(options);
905 while (long_options[i].name)
910 long_options[i].name = o->name;
911 long_options[i].val = FIO_GETOPT_JOB;
912 if (o->type == FIO_OPT_STR_SET)
913 long_options[i].has_arg = no_argument;
915 long_options[i].has_arg = required_argument;
919 assert(i < FIO_NR_OPTIONS);
923 int fio_option_parse(struct thread_data *td, const char *opt)
925 return parse_option(opt, options, td);
928 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
930 return parse_cmd_option(opt, val, options, td);
933 void fio_fill_default_options(struct thread_data *td)
935 fill_default_options(td, options);
938 int fio_show_option_help(const char *opt)
940 return show_cmd_help(options, opt);
943 static void __options_mem(struct thread_data *td, int alloc)
945 struct thread_options *o = &td->o;
946 struct fio_option *opt;
950 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
951 if (opt->type != FIO_OPT_STR_STORE)
954 ptr = (void *) o + opt->off1;
967 * dupe FIO_OPT_STR_STORE options
969 void options_mem_dupe(struct thread_data *td)
971 __options_mem(td, 1);
974 void options_mem_free(struct thread_data fio_unused *td)
977 __options_mem(td, 0);