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",
319 .help = "SCSI generic v3 IO",
323 .help = "Testing engine (no data transfer)",
326 .help = "Network IO",
328 #ifdef FIO_HAVE_SYSLET
329 { .ival = "syslet-rw",
330 .help = "syslet enabled async pread/pwrite IO",
334 .help = "CPU cycler burner engine",
336 #ifdef FIO_HAVE_GUASI
338 .help = "GUASI IO engine",
341 { .ival = "external",
342 .help = "Load external engine (append name)",
349 .off1 = td_var_offset(iodepth),
350 .help = "Amount of IO buffers to keep in flight",
354 .name = "iodepth_batch",
356 .off1 = td_var_offset(iodepth_batch),
357 .help = "Number of IO to submit in one go",
360 .name = "iodepth_low",
362 .off1 = td_var_offset(iodepth_low),
363 .help = "Low water mark for queuing depth",
367 .type = FIO_OPT_STR_VAL,
368 .off1 = td_var_offset(size),
369 .help = "Total size of device or files",
373 .type = FIO_OPT_STR_VAL,
374 .off1 = td_var_offset(file_size_low),
375 .off2 = td_var_offset(file_size_high),
376 .help = "Size of individual files",
380 .alias = "blocksize",
381 .type = FIO_OPT_STR_VAL_INT,
382 .off1 = td_var_offset(bs[DDIR_READ]),
383 .off2 = td_var_offset(bs[DDIR_WRITE]),
384 .help = "Block size unit",
389 .alias = "blocksize_range",
390 .type = FIO_OPT_RANGE,
391 .off1 = td_var_offset(min_bs[DDIR_READ]),
392 .off2 = td_var_offset(max_bs[DDIR_READ]),
393 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
394 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
395 .help = "Set block size range (in more detail than bs)",
398 .name = "bs_unaligned",
399 .alias = "blocksize_unaligned",
400 .type = FIO_OPT_STR_SET,
401 .off1 = td_var_offset(bs_unaligned),
402 .help = "Don't sector align IO buffer sizes",
406 .type = FIO_OPT_STR_VAL,
407 .off1 = td_var_offset(start_offset),
408 .help = "Start IO from this offset",
412 .name = "randrepeat",
413 .type = FIO_OPT_BOOL,
414 .off1 = td_var_offset(rand_repeatable),
415 .help = "Use repeatable random IO pattern",
419 .name = "norandommap",
420 .type = FIO_OPT_STR_SET,
421 .off1 = td_var_offset(norandommap),
422 .help = "Accept potential duplicate random blocks",
427 .off1 = td_var_offset(nr_files),
428 .help = "Split job workload between this number of files",
434 .off1 = td_var_offset(open_files),
435 .help = "Number of files to keep open at the same time",
438 .name = "file_service_type",
441 .off1 = td_var_offset(file_service_type),
442 .help = "How to select which file to service next",
446 .oval = FIO_FSERVICE_RANDOM,
447 .help = "Choose a file at random",
449 { .ival = "roundrobin",
450 .oval = FIO_FSERVICE_RR,
451 .help = "Round robin select files",
458 .off1 = td_var_offset(fsync_blocks),
459 .help = "Issue fsync for writes every given number of blocks",
464 .type = FIO_OPT_BOOL,
465 .off1 = td_var_offset(odirect),
466 .help = "Use O_DIRECT IO (negates buffered)",
471 .type = FIO_OPT_BOOL,
472 .off1 = td_var_offset(odirect),
474 .help = "Use buffered IO (negates direct)",
479 .type = FIO_OPT_BOOL,
480 .off1 = td_var_offset(overwrite),
481 .help = "When writing, set whether to overwrite current data",
487 .off1 = td_var_offset(loops),
488 .help = "Number of times to run the job",
494 .off1 = td_var_offset(numjobs),
495 .help = "Duplicate this job this many times",
499 .name = "startdelay",
501 .off1 = td_var_offset(start_delay),
502 .help = "Only start job when this period has passed",
508 .type = FIO_OPT_STR_VAL_TIME,
509 .off1 = td_var_offset(timeout),
510 .help = "Stop workload when this amount of time has passed",
514 .name = "time_based",
515 .type = FIO_OPT_STR_SET,
516 .off1 = td_var_offset(time_based),
517 .help = "Keep running until runtime/timeout is met",
524 .off1 = td_var_offset(mem_type),
525 .help = "Backing type for IO buffers",
530 .help = "Use malloc(3) for IO buffers",
534 .help = "Use shared memory segments for IO buffers",
536 #ifdef FIO_HAVE_HUGETLB
539 .help = "Like shm, but use huge pages",
544 .help = "Use mmap(2) (file or anon) for IO buffers",
546 #ifdef FIO_HAVE_HUGETLB
547 { .ival = "mmaphuge",
548 .oval = MEM_MMAPHUGE,
549 .help = "Like mmap, but use huge pages",
557 .off1 = td_var_offset(verify),
558 .help = "Verify data written",
563 .help = "Don't do IO verification",
566 .oval = VERIFY_CRC32,
567 .help = "Use crc32 checksums for verification",
571 .help = "Use md5 checksums for verification",
576 .help = "Pretend to verify",
581 .name = "verifysort",
582 .type = FIO_OPT_BOOL,
583 .off1 = td_var_offset(verifysort),
584 .help = "Sort written verify blocks for read back",
588 .name = "write_iolog",
589 .type = FIO_OPT_STR_STORE,
590 .off1 = td_var_offset(write_iolog_file),
591 .help = "Store IO pattern to file",
594 .name = "read_iolog",
595 .type = FIO_OPT_STR_STORE,
596 .off1 = td_var_offset(read_iolog_file),
597 .help = "Playback IO pattern from file",
600 .name = "exec_prerun",
601 .type = FIO_OPT_STR_STORE,
602 .off1 = td_var_offset(exec_prerun),
603 .help = "Execute this file prior to running job",
606 .name = "exec_postrun",
607 .type = FIO_OPT_STR_STORE,
608 .off1 = td_var_offset(exec_postrun),
609 .help = "Execute this file after running job",
611 #ifdef FIO_HAVE_IOSCHED_SWITCH
613 .name = "ioscheduler",
614 .type = FIO_OPT_STR_STORE,
615 .off1 = td_var_offset(ioscheduler),
616 .help = "Use this IO scheduler on the backing device",
621 .type = FIO_OPT_STR_VAL,
622 .off1 = td_var_offset(zone_size),
623 .help = "Give size of an IO zone",
628 .type = FIO_OPT_STR_VAL,
629 .off1 = td_var_offset(zone_skip),
630 .help = "Space between IO zones",
635 .type = FIO_OPT_STR_VAL,
636 .cb = str_lockmem_cb,
637 .help = "Lock down this amount of memory",
641 .name = "rwmixcycle",
643 .off1 = td_var_offset(rwmixcycle),
644 .help = "Cycle period for mixed read/write workloads (msec)",
650 .off1 = td_var_offset(rwmix[DDIR_READ]),
652 .help = "Percentage of mixed workload that is reads",
656 .name = "rwmixwrite",
658 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
660 .help = "Percentage of mixed workload that is writes",
666 .off1 = td_var_offset(nice),
667 .help = "Set job CPU nice value",
672 #ifdef FIO_HAVE_IOPRIO
677 .help = "Set job IO priority value",
684 .cb = str_prioclass_cb,
685 .help = "Set job IO priority class",
693 .off1 = td_var_offset(thinktime),
694 .help = "Idle time between IO buffers (usec)",
698 .name = "thinktime_spin",
700 .off1 = td_var_offset(thinktime_spin),
701 .help = "Start think time by spinning this amount (usec)",
705 .name = "thinktime_blocks",
707 .off1 = td_var_offset(thinktime_blocks),
708 .help = "IO buffer period between 'thinktime'",
714 .off1 = td_var_offset(rate),
715 .help = "Set bandwidth rate",
720 .off1 = td_var_offset(ratemin),
721 .help = "Job must meet this rate or it will be shutdown",
726 .off1 = td_var_offset(rate_iops),
727 .help = "Limit IO used to this number of IO operations/sec",
730 .name = "rate_iops_min",
732 .off1 = td_var_offset(rate_iops_min),
733 .help = "Job must meet this rate or it will be shutdown",
738 .off1 = td_var_offset(ratecycle),
739 .help = "Window average for rate limits (msec)",
743 .name = "invalidate",
744 .type = FIO_OPT_BOOL,
745 .off1 = td_var_offset(invalidate_cache),
746 .help = "Invalidate buffer/page cache prior to running job",
751 .type = FIO_OPT_BOOL,
752 .off1 = td_var_offset(sync_io),
753 .help = "Use O_SYNC for buffered writes",
759 .off1 = td_var_offset(bw_avg_time),
760 .help = "Time window over which to calculate bandwidth (msec)",
764 .name = "create_serialize",
765 .type = FIO_OPT_BOOL,
766 .off1 = td_var_offset(create_serialize),
767 .help = "Serialize creating of job files",
771 .name = "create_fsync",
772 .type = FIO_OPT_BOOL,
773 .off1 = td_var_offset(create_fsync),
774 .help = "Fsync file after creation",
780 .off1 = td_var_offset(cpuload),
781 .help = "Use this percentage of CPU",
786 .off1 = td_var_offset(cpucycle),
787 .help = "Length of the CPU burn cycles (usecs)",
790 #ifdef FIO_HAVE_CPU_AFFINITY
794 .cb = str_cpumask_cb,
795 .help = "CPU affinity mask",
798 .name = "cpus_allowed",
800 .cb = str_cpus_allowed_cb,
801 .help = "Set CPUs allowed",
806 .type = FIO_OPT_BOOL,
807 .off1 = td_var_offset(end_fsync),
808 .help = "Include fsync at the end of job",
812 .name = "fsync_on_close",
813 .type = FIO_OPT_BOOL,
814 .off1 = td_var_offset(fsync_on_close),
815 .help = "fsync files on close",
820 .type = FIO_OPT_BOOL,
821 .off1 = td_var_offset(unlink),
822 .help = "Unlink created files after job has completed",
827 .type = FIO_OPT_STR_SET,
828 .cb = str_exitall_cb,
829 .help = "Terminate all jobs when one exits",
833 .type = FIO_OPT_STR_SET,
834 .off1 = td_var_offset(stonewall),
835 .help = "Insert a hard barrier between this job and previous",
839 .type = FIO_OPT_STR_SET,
840 .off1 = td_var_offset(new_group),
841 .help = "Mark the start of a new group (for reporting)",
845 .type = FIO_OPT_STR_SET,
846 .off1 = td_var_offset(use_thread),
847 .help = "Use threads instead of forks",
850 .name = "write_bw_log",
851 .type = FIO_OPT_STR_SET,
852 .off1 = td_var_offset(write_bw_log),
853 .help = "Write log of bandwidth during run",
856 .name = "write_lat_log",
857 .type = FIO_OPT_STR_SET,
858 .off1 = td_var_offset(write_lat_log),
859 .help = "Write log of latency during run",
862 .name = "hugepage-size",
863 .type = FIO_OPT_STR_VAL,
864 .off1 = td_var_offset(hugepage_size),
865 .help = "When using hugepages, specify size of each page",
866 .def = __stringify(FIO_HUGE_PAGE),
869 .name = "group_reporting",
870 .type = FIO_OPT_STR_SET,
871 .off1 = td_var_offset(group_reporting),
872 .help = "Do reporting on a per-group basis",
875 .name = "zero_buffers",
876 .type = FIO_OPT_STR_SET,
877 .off1 = td_var_offset(zero_buffers),
878 .help = "Init IO buffers to all zeroes",
880 #ifdef FIO_HAVE_DISK_UTIL
883 .type = FIO_OPT_BOOL,
884 .off1 = td_var_offset(do_disk_util),
885 .help = "Log disk utilization stats",
894 void fio_options_dup_and_init(struct option *long_options)
896 struct fio_option *o;
899 options_init(options);
902 while (long_options[i].name)
907 long_options[i].name = o->name;
908 long_options[i].val = FIO_GETOPT_JOB;
909 if (o->type == FIO_OPT_STR_SET)
910 long_options[i].has_arg = no_argument;
912 long_options[i].has_arg = required_argument;
916 assert(i < FIO_NR_OPTIONS);
920 int fio_option_parse(struct thread_data *td, const char *opt)
922 return parse_option(opt, options, td);
925 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
927 return parse_cmd_option(opt, val, options, td);
930 void fio_fill_default_options(struct thread_data *td)
932 fill_default_options(td, options);
935 int fio_show_option_help(const char *opt)
937 return show_cmd_help(options, opt);
940 static void __options_mem(struct thread_data *td, int alloc)
942 struct thread_options *o = &td->o;
943 struct fio_option *opt;
947 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
948 if (opt->type != FIO_OPT_STR_STORE)
951 ptr = (void *) o + opt->off1;
964 * dupe FIO_OPT_STR_STORE options
966 void options_mem_dupe(struct thread_data *td)
968 __options_mem(td, 1);
971 void options_mem_free(struct thread_data fio_unused *td)
974 __options_mem(td, 0);