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;
68 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
72 static int str_prio_cb(void *data, unsigned int *val)
74 struct thread_data *td = data;
81 static int str_exitall_cb(void)
83 exitall_on_terminate = 1;
87 static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
89 #ifdef FIO_HAVE_CPU_AFFINITY
94 for (i = 0; i < sizeof(int) * 8; i++) {
101 static int str_cpumask_cb(void *data, unsigned int *val)
103 struct thread_data *td = data;
105 fill_cpu_mask(td->o.cpumask, *val);
109 static int str_fst_cb(void *data, const char *str)
111 struct thread_data *td = data;
112 char *nr = get_opt_postfix(str);
114 td->file_service_nr = 1;
116 td->file_service_nr = atoi(nr);
121 static int str_filename_cb(void *data, const char *input)
123 struct thread_data *td = data;
124 char *fname, *str, *p;
126 p = str = strdup(input);
128 strip_blank_front(&str);
129 strip_blank_end(str);
131 if (!td->files_index)
134 while ((fname = strsep(&str, ":")) != NULL) {
145 static int str_directory_cb(void *data, const char fio_unused *str)
147 struct thread_data *td = data;
150 if (lstat(td->o.directory, &sb) < 0) {
151 log_err("fio: %s is not a directory\n", td->o.directory);
152 td_verror(td, errno, "lstat");
155 if (!S_ISDIR(sb.st_mode)) {
156 log_err("fio: %s is not a directory\n", td->o.directory);
163 static int str_opendir_cb(void *data, const char fio_unused *str)
165 struct thread_data *td = data;
167 if (!td->files_index)
170 return add_dir_files(td, td->o.opendir);
174 #define __stringify_1(x) #x
175 #define __stringify(x) __stringify_1(x)
178 * Map of job/command line options
180 static struct fio_option options[] = {
182 .name = "description",
183 .type = FIO_OPT_STR_STORE,
184 .off1 = td_var_offset(description),
185 .help = "Text job description",
189 .type = FIO_OPT_STR_STORE,
190 .off1 = td_var_offset(name),
191 .help = "Name of this job",
195 .type = FIO_OPT_STR_STORE,
196 .off1 = td_var_offset(directory),
197 .cb = str_directory_cb,
198 .help = "Directory to store files in",
202 .type = FIO_OPT_STR_STORE,
203 .off1 = td_var_offset(filename),
204 .cb = str_filename_cb,
205 .help = "File(s) to use for the workload",
209 .type = FIO_OPT_STR_STORE,
210 .off1 = td_var_offset(opendir),
211 .cb = str_opendir_cb,
212 .help = "Recursively add files from this directory and down",
216 .alias = "readwrite",
219 .off1 = td_var_offset(td_ddir),
220 .help = "IO direction",
224 .oval = TD_DDIR_READ,
225 .help = "Sequential read",
228 .oval = TD_DDIR_WRITE,
229 .help = "Sequential write",
231 { .ival = "randread",
232 .oval = TD_DDIR_RANDREAD,
233 .help = "Random read",
235 { .ival = "randwrite",
236 .oval = TD_DDIR_RANDWRITE,
237 .help = "Random write",
241 .help = "Sequential read and write mix",
244 .oval = TD_DDIR_RANDRW,
245 .help = "Random read and write mix"
250 .name = "fadvise_hint",
251 .type = FIO_OPT_BOOL,
252 .off1 = td_var_offset(fadvise_hint),
253 .help = "Use fadvise() to advise the kernel on IO pattern",
258 .type = FIO_OPT_STR_STORE,
259 .off1 = td_var_offset(ioengine),
260 .help = "IO engine to use",
264 .help = "Use read/write",
266 #ifdef FIO_HAVE_LIBAIO
268 .help = "Linux native asynchronous IO",
271 #ifdef FIO_HAVE_POSIXAIO
272 { .ival = "posixaio",
273 .help = "POSIX asynchronous IO",
277 .help = "Memory mapped IO",
279 #ifdef FIO_HAVE_SPLICE
281 .help = "splice/vmsplice based IO",
286 .help = "SCSI generic v3 IO",
290 .help = "Testing engine (no data transfer)",
293 .help = "Network IO",
295 #ifdef FIO_HAVE_SYSLET
296 { .ival = "syslet-rw",
297 .help = "syslet enabled async pread/pwrite IO",
301 .help = "CPU cycler burner engine",
303 #ifdef FIO_HAVE_GUASI
305 .help = "GUASI IO engine",
308 { .ival = "external",
309 .help = "Load external engine (append name)",
316 .off1 = td_var_offset(iodepth),
317 .help = "Amount of IO buffers to keep in flight",
321 .name = "iodepth_batch",
323 .off1 = td_var_offset(iodepth_batch),
324 .help = "Number of IO to submit in one go",
327 .name = "iodepth_low",
329 .off1 = td_var_offset(iodepth_low),
330 .help = "Low water mark for queuing depth",
334 .type = FIO_OPT_STR_VAL,
335 .off1 = td_var_offset(size),
336 .help = "Total size of device or files",
340 .type = FIO_OPT_STR_VAL,
341 .off1 = td_var_offset(file_size_low),
342 .off2 = td_var_offset(file_size_high),
343 .help = "Size of individual files",
347 .alias = "blocksize",
348 .type = FIO_OPT_STR_VAL_INT,
349 .off1 = td_var_offset(bs[DDIR_READ]),
350 .off2 = td_var_offset(bs[DDIR_WRITE]),
351 .help = "Block size unit",
356 .alias = "blocksize_range",
357 .type = FIO_OPT_RANGE,
358 .off1 = td_var_offset(min_bs[DDIR_READ]),
359 .off2 = td_var_offset(max_bs[DDIR_READ]),
360 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
361 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
362 .help = "Set block size range (in more detail than bs)",
365 .name = "bs_unaligned",
366 .alias = "blocksize_unaligned",
367 .type = FIO_OPT_STR_SET,
368 .off1 = td_var_offset(bs_unaligned),
369 .help = "Don't sector align IO buffer sizes",
373 .type = FIO_OPT_STR_VAL,
374 .off1 = td_var_offset(start_offset),
375 .help = "Start IO from this offset",
379 .name = "randrepeat",
380 .type = FIO_OPT_BOOL,
381 .off1 = td_var_offset(rand_repeatable),
382 .help = "Use repeatable random IO pattern",
386 .name = "norandommap",
387 .type = FIO_OPT_STR_SET,
388 .off1 = td_var_offset(norandommap),
389 .help = "Accept potential duplicate random blocks",
394 .off1 = td_var_offset(nr_files),
395 .help = "Split job workload between this number of files",
401 .off1 = td_var_offset(open_files),
402 .help = "Number of files to keep open at the same time",
405 .name = "file_service_type",
408 .off1 = td_var_offset(file_service_type),
409 .help = "How to select which file to service next",
413 .oval = FIO_FSERVICE_RANDOM,
414 .help = "Choose a file at random",
416 { .ival = "roundrobin",
417 .oval = FIO_FSERVICE_RR,
418 .help = "Round robin select files",
425 .off1 = td_var_offset(fsync_blocks),
426 .help = "Issue fsync for writes every given number of blocks",
431 .type = FIO_OPT_BOOL,
432 .off1 = td_var_offset(odirect),
433 .help = "Use O_DIRECT IO (negates buffered)",
438 .type = FIO_OPT_BOOL,
439 .off1 = td_var_offset(odirect),
441 .help = "Use buffered IO (negates direct)",
446 .type = FIO_OPT_BOOL,
447 .off1 = td_var_offset(overwrite),
448 .help = "When writing, set whether to overwrite current data",
454 .off1 = td_var_offset(loops),
455 .help = "Number of times to run the job",
461 .off1 = td_var_offset(numjobs),
462 .help = "Duplicate this job this many times",
466 .name = "startdelay",
468 .off1 = td_var_offset(start_delay),
469 .help = "Only start job when this period has passed",
475 .type = FIO_OPT_STR_VAL_TIME,
476 .off1 = td_var_offset(timeout),
477 .help = "Stop workload when this amount of time has passed",
485 .off1 = td_var_offset(mem_type),
486 .help = "Backing type for IO buffers",
491 .help = "Use malloc(3) for IO buffers",
495 .help = "Use shared memory segments for IO buffers",
497 #ifdef FIO_HAVE_HUGETLB
500 .help = "Like shm, but use huge pages",
505 .help = "Use mmap(2) (file or anon) for IO buffers",
507 #ifdef FIO_HAVE_HUGETLB
508 { .ival = "mmaphuge",
509 .oval = MEM_MMAPHUGE,
510 .help = "Like mmap, but use huge pages",
518 .off1 = td_var_offset(verify),
519 .help = "Verify data written",
524 .help = "Don't do IO verification",
527 .oval = VERIFY_CRC32,
528 .help = "Use crc32 checksums for verification",
532 .help = "Use md5 checksums for verification",
537 .help = "Pretend to verify",
542 .name = "verifysort",
543 .type = FIO_OPT_BOOL,
544 .off1 = td_var_offset(verifysort),
545 .help = "Sort written verify blocks for read back",
549 .name = "write_iolog",
550 .type = FIO_OPT_STR_STORE,
551 .off1 = td_var_offset(write_iolog_file),
552 .help = "Store IO pattern to file",
555 .name = "read_iolog",
556 .type = FIO_OPT_STR_STORE,
557 .off1 = td_var_offset(read_iolog_file),
558 .help = "Playback IO pattern from file",
561 .name = "exec_prerun",
562 .type = FIO_OPT_STR_STORE,
563 .off1 = td_var_offset(exec_prerun),
564 .help = "Execute this file prior to running job",
567 .name = "exec_postrun",
568 .type = FIO_OPT_STR_STORE,
569 .off1 = td_var_offset(exec_postrun),
570 .help = "Execute this file after running job",
572 #ifdef FIO_HAVE_IOSCHED_SWITCH
574 .name = "ioscheduler",
575 .type = FIO_OPT_STR_STORE,
576 .off1 = td_var_offset(ioscheduler),
577 .help = "Use this IO scheduler on the backing device",
582 .type = FIO_OPT_STR_VAL,
583 .off1 = td_var_offset(zone_size),
584 .help = "Give size of an IO zone",
589 .type = FIO_OPT_STR_VAL,
590 .off1 = td_var_offset(zone_skip),
591 .help = "Space between IO zones",
596 .type = FIO_OPT_STR_VAL,
597 .cb = str_lockmem_cb,
598 .help = "Lock down this amount of memory",
602 .name = "rwmixcycle",
604 .off1 = td_var_offset(rwmixcycle),
605 .help = "Cycle period for mixed read/write workloads (msec)",
611 .off1 = td_var_offset(rwmix[DDIR_READ]),
613 .help = "Percentage of mixed workload that is reads",
617 .name = "rwmixwrite",
619 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
621 .help = "Percentage of mixed workload that is writes",
627 .off1 = td_var_offset(nice),
628 .help = "Set job CPU nice value",
633 #ifdef FIO_HAVE_IOPRIO
638 .help = "Set job IO priority value",
645 .cb = str_prioclass_cb,
646 .help = "Set job IO priority class",
654 .off1 = td_var_offset(thinktime),
655 .help = "Idle time between IO buffers (usec)",
659 .name = "thinktime_spin",
661 .off1 = td_var_offset(thinktime_spin),
662 .help = "Start think time by spinning this amount (usec)",
666 .name = "thinktime_blocks",
668 .off1 = td_var_offset(thinktime_blocks),
669 .help = "IO buffer period between 'thinktime'",
675 .off1 = td_var_offset(rate),
676 .help = "Set bandwidth rate",
681 .off1 = td_var_offset(ratemin),
682 .help = "Job must meet this rate or it will be shutdown",
687 .off1 = td_var_offset(rate_iops),
688 .help = "Limit IO used to this number of IO operations/sec",
691 .name = "rate_iops_min",
693 .off1 = td_var_offset(rate_iops_min),
694 .help = "Job must meet this rate or it will be shutdown",
699 .off1 = td_var_offset(ratecycle),
700 .help = "Window average for rate limits (msec)",
704 .name = "invalidate",
705 .type = FIO_OPT_BOOL,
706 .off1 = td_var_offset(invalidate_cache),
707 .help = "Invalidate buffer/page cache prior to running job",
712 .type = FIO_OPT_BOOL,
713 .off1 = td_var_offset(sync_io),
714 .help = "Use O_SYNC for buffered writes",
720 .off1 = td_var_offset(bw_avg_time),
721 .help = "Time window over which to calculate bandwidth (msec)",
725 .name = "create_serialize",
726 .type = FIO_OPT_BOOL,
727 .off1 = td_var_offset(create_serialize),
728 .help = "Serialize creating of job files",
732 .name = "create_fsync",
733 .type = FIO_OPT_BOOL,
734 .off1 = td_var_offset(create_fsync),
735 .help = "Fsync file after creation",
741 .off1 = td_var_offset(cpuload),
742 .help = "Use this percentage of CPU",
747 .off1 = td_var_offset(cpucycle),
748 .help = "Length of the CPU burn cycles (usecs)",
751 #ifdef FIO_HAVE_CPU_AFFINITY
755 .cb = str_cpumask_cb,
756 .help = "CPU affinity mask",
761 .type = FIO_OPT_BOOL,
762 .off1 = td_var_offset(end_fsync),
763 .help = "Include fsync at the end of job",
767 .name = "fsync_on_close",
768 .type = FIO_OPT_BOOL,
769 .off1 = td_var_offset(fsync_on_close),
770 .help = "fsync files on close",
775 .type = FIO_OPT_BOOL,
776 .off1 = td_var_offset(unlink),
777 .help = "Unlink created files after job has completed",
782 .type = FIO_OPT_STR_SET,
783 .cb = str_exitall_cb,
784 .help = "Terminate all jobs when one exits",
788 .type = FIO_OPT_STR_SET,
789 .off1 = td_var_offset(stonewall),
790 .help = "Insert a hard barrier between this job and previous",
794 .type = FIO_OPT_STR_SET,
795 .off1 = td_var_offset(new_group),
796 .help = "Mark the start of a new group (for reporting)",
800 .type = FIO_OPT_STR_SET,
801 .off1 = td_var_offset(use_thread),
802 .help = "Use threads instead of forks",
805 .name = "write_bw_log",
806 .type = FIO_OPT_STR_SET,
807 .off1 = td_var_offset(write_bw_log),
808 .help = "Write log of bandwidth during run",
811 .name = "write_lat_log",
812 .type = FIO_OPT_STR_SET,
813 .off1 = td_var_offset(write_lat_log),
814 .help = "Write log of latency during run",
817 .name = "hugepage-size",
818 .type = FIO_OPT_STR_VAL,
819 .off1 = td_var_offset(hugepage_size),
820 .help = "When using hugepages, specify size of each page",
821 .def = __stringify(FIO_HUGE_PAGE),
824 .name = "group_reporting",
825 .type = FIO_OPT_STR_SET,
826 .off1 = td_var_offset(group_reporting),
827 .help = "Do reporting on a per-group basis",
834 void fio_options_dup_and_init(struct option *long_options)
836 struct fio_option *o;
839 options_init(options);
842 while (long_options[i].name)
847 long_options[i].name = o->name;
848 long_options[i].val = FIO_GETOPT_JOB;
849 if (o->type == FIO_OPT_STR_SET)
850 long_options[i].has_arg = no_argument;
852 long_options[i].has_arg = required_argument;
856 assert(i < FIO_NR_OPTIONS);
860 int fio_option_parse(struct thread_data *td, const char *opt)
862 return parse_option(opt, options, td);
865 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
867 return parse_cmd_option(opt, val, options, td);
870 void fio_fill_default_options(struct thread_data *td)
872 fill_default_options(td, options);
875 int fio_show_option_help(const char *opt)
877 return show_cmd_help(options, opt);
880 static void __options_mem(struct thread_data *td, int alloc)
882 struct thread_options *o = &td->o;
883 struct fio_option *opt;
887 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
888 if (opt->type != FIO_OPT_STR_STORE)
891 ptr = (void *) o + opt->off1;
904 * dupe FIO_OPT_STR_STORE options
906 void options_mem_dupe(struct thread_data *td)
908 __options_mem(td, 1);
911 void options_mem_free(struct thread_data fio_unused *td)
914 __options_mem(td, 0);