1 #ifndef FIO_THREAD_OPTIONS_H
2 #define FIO_THREAD_OPTIONS_H
9 #include "lib/ieee754.h"
10 #include "lib/pattern.h"
14 ZONE_MODE_NOT_SPECIFIED = 0,
16 ZONE_MODE_STRIDED = 2, /* perform I/O in one zone at a time */
17 /* perform I/O across multiple zones simultaneously */
22 * What type of allocation to use for io buffers
25 MEM_MALLOC = 0, /* ordinary malloc */
26 MEM_SHM, /* use shared memory segments */
27 MEM_SHMHUGE, /* use shared memory segments with huge pages */
28 MEM_MMAP, /* use anonynomous mmap */
29 MEM_MMAPHUGE, /* memory mapped huge file */
30 MEM_MMAPSHARED, /* use mmap with shared flag */
31 MEM_CUDA_MALLOC,/* use GPU memory */
35 * What mode to use for deduped data generation
38 DEDUPE_MODE_REPEAT = 0,
39 DEDUPE_MODE_WORKING_SET = 1,
42 #define ERROR_STR_MAX 128
44 #define BSSPLIT_MAX 64
45 #define ZONESPLIT_MAX 256
49 unsigned long long val1[ZONESPLIT_MAX];
50 unsigned long long val2[ZONESPLIT_MAX];
71 #define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
73 #define OPT_MAGIC 0x4f50544e
75 struct thread_options {
77 uint64_t set_options[NR_OPTS_SZ];
83 char *filename_format;
86 char *ioengine_so_path;
91 unsigned int unit_base;
92 unsigned int ddir_seq_nr;
93 long long ddir_seq_add;
95 unsigned int iodepth_low;
96 unsigned int iodepth_batch;
97 unsigned int iodepth_batch_complete_min;
98 unsigned int iodepth_batch_complete_max;
99 unsigned int serialize_overlap;
101 unsigned int unique_filename;
103 unsigned long long size;
104 unsigned long long io_size;
105 unsigned int size_percent;
106 unsigned int size_nz;
107 unsigned int io_size_percent;
108 unsigned int io_size_nz;
109 unsigned int fill_device;
110 unsigned int file_append;
111 unsigned long long file_size_low;
112 unsigned long long file_size_high;
113 unsigned long long start_offset;
114 unsigned long long start_offset_align;
115 unsigned int start_offset_nz;
117 unsigned long long bs[DDIR_RWDIR_CNT];
118 unsigned long long ba[DDIR_RWDIR_CNT];
119 unsigned long long min_bs[DDIR_RWDIR_CNT];
120 unsigned long long max_bs[DDIR_RWDIR_CNT];
121 struct bssplit *bssplit[DDIR_RWDIR_CNT];
122 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
124 int *ignore_error[ERROR_TYPE_CNT];
125 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
126 unsigned int error_dump;
128 unsigned int nr_files;
129 unsigned int open_files;
130 enum file_lock_mode file_lock_mode;
132 unsigned int odirect;
133 unsigned int oatomic;
134 unsigned int invalidate_cache;
135 unsigned int create_serialize;
136 unsigned int create_fsync;
137 unsigned int create_on_open;
138 unsigned int create_only;
139 unsigned int end_fsync;
140 unsigned int pre_read;
141 unsigned int sync_io;
142 unsigned int write_hint;
144 unsigned int do_verify;
145 unsigned int verify_interval;
146 unsigned int verify_offset;
147 char *verify_pattern;
148 unsigned int verify_pattern_bytes;
149 struct pattern_fmt verify_fmt[8];
150 unsigned int verify_fmt_sz;
151 unsigned int verify_fatal;
152 unsigned int verify_dump;
153 unsigned int verify_async;
154 unsigned long long verify_backlog;
155 unsigned int verify_batch;
156 unsigned int experimental_verify;
157 unsigned int verify_state;
158 unsigned int verify_state_save;
159 unsigned int use_thread;
161 unsigned int unlink_each_loop;
162 unsigned int do_disk_util;
163 unsigned int override_sync;
164 unsigned int rand_repeatable;
165 unsigned long long rand_seed;
166 unsigned int log_avg_msec;
167 unsigned int log_hist_msec;
168 unsigned int log_hist_coarseness;
169 unsigned int log_max;
170 unsigned int log_offset;
172 unsigned int log_gz_store;
173 unsigned int log_unix_epoch;
174 unsigned int log_alternate_epoch;
175 unsigned int log_alternate_epoch_clock_id;
176 unsigned int norandommap;
177 unsigned int softrandommap;
178 unsigned int bs_unaligned;
179 unsigned int fsync_on_close;
180 unsigned int bs_is_seq_rand;
182 unsigned int verify_only;
184 unsigned int random_distribution;
185 unsigned int exitall_error;
187 struct zone_split *zone_split[DDIR_RWDIR_CNT];
188 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
190 fio_fp64_t zipf_theta;
192 fio_fp64_t gauss_dev;
193 fio_fp64_t random_center;
195 unsigned int random_generator;
197 unsigned int perc_rand[DDIR_RWDIR_CNT];
199 unsigned int hugepage_size;
200 unsigned long long rw_min_bs;
201 unsigned int fsync_blocks;
202 unsigned int fdatasync_blocks;
203 unsigned int barrier_blocks;
204 unsigned long long start_delay;
205 unsigned long long start_delay_orig;
206 unsigned long long start_delay_high;
207 unsigned long long timeout;
208 unsigned long long ramp_time;
209 unsigned int ss_state;
211 unsigned long long ss_dur;
212 unsigned long long ss_ramp_time;
213 unsigned long long ss_check_interval;
214 unsigned int overwrite;
215 unsigned int bw_avg_time;
216 unsigned int iops_avg_time;
218 unsigned long long zone_range;
219 unsigned long long zone_size;
220 unsigned long long zone_capacity;
221 unsigned long long zone_skip;
222 uint32_t zone_skip_nz;
223 enum fio_zone_mode zone_mode;
224 unsigned long long lockmem;
225 enum fio_memtype mem_type;
226 unsigned int mem_align;
228 unsigned long long max_latency[DDIR_RWDIR_CNT];
230 unsigned int exit_what;
231 unsigned int stonewall;
232 unsigned int new_group;
233 unsigned int numjobs;
234 os_cpu_mask_t cpumask;
235 os_cpu_mask_t verify_cpumask;
236 os_cpu_mask_t log_gz_cpumask;
237 unsigned int cpus_allowed_policy;
239 unsigned short numa_mem_mode;
240 unsigned int numa_mem_prefer_node;
242 unsigned int gpu_dev_id;
243 unsigned int start_offset_percent;
246 unsigned int rwmixcycle;
247 unsigned int rwmix[DDIR_RWDIR_CNT];
250 unsigned int ioprio_class;
251 unsigned int ioprio_hint;
252 unsigned int file_service_type;
253 unsigned int group_reporting;
255 unsigned int fadvise_hint;
256 enum fio_fallocate_mode fallocate_mode;
257 unsigned int zero_buffers;
258 unsigned int refill_buffers;
259 unsigned int scramble_buffers;
260 char *buffer_pattern;
261 unsigned int buffer_pattern_bytes;
262 unsigned int compress_percentage;
263 unsigned int compress_chunk;
264 unsigned int dedupe_percentage;
265 unsigned int dedupe_mode;
266 unsigned int dedupe_working_set_percentage;
267 unsigned int dedupe_global;
268 unsigned int time_based;
269 unsigned int disable_lat;
270 unsigned int disable_clat;
271 unsigned int disable_slat;
272 unsigned int disable_bw;
273 unsigned int unified_rw_rep;
274 unsigned int gtod_reduce;
275 unsigned int gtod_cpu;
276 enum fio_cs clocksource;
277 unsigned int no_stall;
278 unsigned int trim_percentage;
279 unsigned int trim_batch;
280 unsigned int trim_zero;
281 unsigned long long trim_backlog;
282 unsigned int clat_percentiles;
283 unsigned int slat_percentiles;
284 unsigned int lat_percentiles;
285 unsigned int percentile_precision; /* digits after decimal for percentiles */
286 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
288 char *read_iolog_file;
289 bool read_iolog_chunked;
290 char *write_iolog_file;
291 char *merge_blktrace_file;
292 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
293 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
295 unsigned int write_bw_log;
296 unsigned int write_lat_log;
297 unsigned int write_iops_log;
298 unsigned int write_hist_log;
304 char *replay_redirect;
307 * Pre-run and post-run shell
312 unsigned int thinktime;
313 unsigned int thinktime_spin;
314 unsigned int thinktime_blocks;
315 unsigned int thinktime_blocks_type;
316 unsigned int thinktime_iotime;
318 uint64_t rate[DDIR_RWDIR_CNT];
319 uint64_t ratemin[DDIR_RWDIR_CNT];
320 unsigned int ratecycle;
321 unsigned int io_submit_mode;
322 unsigned int rate_iops[DDIR_RWDIR_CNT];
323 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
324 unsigned int rate_process;
325 unsigned int rate_ign_think;
332 enum error_type continue_on_error;
335 * Benchmark profile type
340 * blkio cgroup support
343 unsigned int cgroup_weight;
344 unsigned int cgroup_nodelete;
349 unsigned int offset_increment_percent;
350 unsigned int offset_increment_nz;
351 unsigned long long offset_increment;
352 unsigned long long number_ios;
354 unsigned int sync_file_range;
356 unsigned long long latency_target;
357 unsigned long long latency_window;
358 fio_fp64_t latency_percentile;
359 uint32_t latency_run;
366 unsigned int flow_sleep;
368 unsigned int sig_figs;
370 unsigned block_error_hist;
372 unsigned int replay_align;
373 unsigned int replay_scale;
374 unsigned int replay_time_scale;
375 unsigned int replay_skip;
377 unsigned int per_job_logs;
379 unsigned int allow_create;
380 unsigned int allow_mounted_write;
382 /* Parameters that affect zonemode=zbd */
383 unsigned int read_beyond_wp;
385 unsigned int job_max_open_zones;
386 unsigned int ignore_zone_limits;
390 #define FIO_MAX_PLIS 16
392 unsigned int fdp_pli_select;
393 unsigned int fdp_plis[FIO_MAX_PLIS];
394 unsigned int fdp_nrpli;
396 unsigned int log_entries;
397 unsigned int log_prio;
400 #define FIO_TOP_STR_MAX 256
402 struct thread_options_pack {
403 uint64_t set_options[NR_OPTS_SZ];
404 uint8_t description[FIO_TOP_STR_MAX];
405 uint8_t name[FIO_TOP_STR_MAX];
406 uint8_t wait_for[FIO_TOP_STR_MAX];
407 uint8_t directory[FIO_TOP_STR_MAX];
408 uint8_t filename[FIO_TOP_STR_MAX];
409 uint8_t filename_format[FIO_TOP_STR_MAX];
410 uint8_t opendir[FIO_TOP_STR_MAX];
411 uint8_t ioengine[FIO_TOP_STR_MAX];
412 uint8_t mmapfile[FIO_TOP_STR_MAX];
417 uint32_t ddir_seq_nr;
418 uint64_t ddir_seq_add;
420 uint32_t iodepth_low;
421 uint32_t iodepth_batch;
422 uint32_t iodepth_batch_complete_min;
423 uint32_t iodepth_batch_complete_max;
424 uint32_t serialize_overlap;
429 uint32_t size_percent;
431 uint32_t io_size_percent;
433 uint32_t fill_device;
434 uint32_t file_append;
435 uint32_t unique_filename;
437 uint64_t file_size_low;
438 uint64_t file_size_high;
439 uint64_t start_offset;
440 uint64_t start_offset_align;
441 uint32_t start_offset_nz;
444 uint64_t bs[DDIR_RWDIR_CNT];
445 uint64_t ba[DDIR_RWDIR_CNT];
446 uint64_t min_bs[DDIR_RWDIR_CNT];
447 uint64_t max_bs[DDIR_RWDIR_CNT];
448 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
449 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
451 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
452 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
457 uint32_t file_lock_mode;
461 uint32_t invalidate_cache;
462 uint32_t create_serialize;
463 uint32_t create_fsync;
464 uint32_t create_on_open;
465 uint32_t create_only;
472 uint32_t verify_interval;
473 uint32_t verify_offset;
474 uint32_t verify_pattern_bytes;
475 uint32_t verify_fatal;
476 uint32_t verify_dump;
477 uint32_t verify_async;
478 uint64_t verify_backlog;
479 uint32_t verify_batch;
480 uint32_t experimental_verify;
481 uint32_t verify_state;
482 uint32_t verify_state_save;
485 uint32_t unlink_each_loop;
486 uint32_t do_disk_util;
487 uint32_t override_sync;
488 uint32_t rand_repeatable;
490 uint32_t log_avg_msec;
491 uint32_t log_hist_msec;
492 uint32_t log_hist_coarseness;
496 uint32_t log_gz_store;
497 uint32_t log_unix_epoch;
498 uint32_t log_alternate_epoch;
499 uint32_t log_alternate_epoch_clock_id;
500 uint32_t norandommap;
501 uint32_t softrandommap;
502 uint32_t bs_unaligned;
503 uint32_t fsync_on_close;
504 uint32_t bs_is_seq_rand;
506 uint32_t random_distribution;
507 uint32_t exitall_error;
509 uint32_t sync_file_range;
511 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
512 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
514 fio_fp64_t zipf_theta;
516 fio_fp64_t gauss_dev;
517 fio_fp64_t random_center;
519 uint32_t random_generator;
521 uint32_t perc_rand[DDIR_RWDIR_CNT];
523 uint32_t hugepage_size;
525 uint32_t fsync_blocks;
526 uint32_t fdatasync_blocks;
527 uint32_t barrier_blocks;
528 uint64_t start_delay;
529 uint64_t start_delay_high;
533 uint64_t ss_ramp_time;
536 uint64_t ss_check_interval;
538 uint32_t bw_avg_time;
539 uint32_t iops_avg_time;
543 uint64_t zone_capacity;
546 uint32_t zone_skip_nz;
556 * We currently can't convert these, so don't enable them
559 uint8_t cpumask[FIO_TOP_STR_MAX];
560 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
561 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
564 uint32_t start_offset_percent;
565 uint32_t cpus_allowed_policy;
568 uint32_t rwmix[DDIR_RWDIR_CNT];
571 uint32_t ioprio_class;
572 uint32_t ioprio_hint;
573 uint32_t file_service_type;
574 uint32_t group_reporting;
576 uint32_t fadvise_hint;
577 uint32_t fallocate_mode;
578 uint32_t zero_buffers;
579 uint32_t refill_buffers;
580 uint32_t scramble_buffers;
581 uint32_t buffer_pattern_bytes;
582 uint32_t compress_percentage;
583 uint32_t compress_chunk;
584 uint32_t dedupe_percentage;
585 uint32_t dedupe_mode;
586 uint32_t dedupe_working_set_percentage;
587 uint32_t dedupe_global;
589 uint32_t disable_lat;
590 uint32_t disable_clat;
591 uint32_t disable_slat;
593 uint32_t unified_rw_rep;
594 uint32_t gtod_reduce;
596 uint32_t clocksource;
598 uint32_t trim_percentage;
601 uint64_t trim_backlog;
602 uint32_t clat_percentiles;
603 uint32_t lat_percentiles;
604 uint32_t slat_percentiles;
605 uint32_t percentile_precision;
606 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
608 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
609 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
610 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
611 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
612 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
614 uint32_t write_bw_log;
615 uint32_t write_lat_log;
616 uint32_t write_iops_log;
617 uint32_t write_hist_log;
619 uint8_t bw_log_file[FIO_TOP_STR_MAX];
620 uint8_t lat_log_file[FIO_TOP_STR_MAX];
621 uint8_t iops_log_file[FIO_TOP_STR_MAX];
622 uint8_t hist_log_file[FIO_TOP_STR_MAX];
623 uint8_t replay_redirect[FIO_TOP_STR_MAX];
626 * Pre-run and post-run shell
628 uint8_t exec_prerun[FIO_TOP_STR_MAX];
629 uint8_t exec_postrun[FIO_TOP_STR_MAX];
632 uint32_t thinktime_spin;
633 uint32_t thinktime_blocks;
634 uint32_t thinktime_blocks_type;
635 uint32_t thinktime_iotime;
637 uint64_t rate[DDIR_RWDIR_CNT];
638 uint64_t ratemin[DDIR_RWDIR_CNT];
640 uint32_t io_submit_mode;
641 uint32_t rate_iops[DDIR_RWDIR_CNT];
642 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
643 uint32_t rate_process;
644 uint32_t rate_ign_think;
646 uint8_t ioscheduler[FIO_TOP_STR_MAX];
651 uint32_t continue_on_error;
654 * Benchmark profile type
656 uint8_t profile[FIO_TOP_STR_MAX];
659 * blkio cgroup support
661 uint8_t cgroup[FIO_TOP_STR_MAX];
662 uint32_t cgroup_weight;
663 uint32_t cgroup_nodelete;
668 uint32_t offset_increment_percent;
669 uint32_t offset_increment_nz;
670 uint64_t offset_increment;
673 uint64_t latency_target;
674 uint64_t latency_window;
675 uint64_t max_latency[DDIR_RWDIR_CNT];
676 fio_fp64_t latency_percentile;
677 uint32_t latency_run;
688 uint32_t block_error_hist;
690 uint32_t replay_align;
691 uint32_t replay_scale;
692 uint32_t replay_time_scale;
693 uint32_t replay_skip;
695 uint32_t per_job_logs;
697 uint32_t allow_create;
698 uint32_t allow_mounted_write;
701 int32_t max_open_zones;
702 uint32_t ignore_zone_limits;
704 uint32_t log_entries;
708 uint32_t fdp_pli_select;
709 uint32_t fdp_plis[FIO_MAX_PLIS];
713 * verify_pattern followed by buffer_pattern from the unpacked struct
716 } __attribute__((packed));
718 extern int convert_thread_options_to_cpu(struct thread_options *o,
719 struct thread_options_pack *top, size_t top_sz);
720 extern size_t thread_options_pack_size(struct thread_options *o);
721 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
722 extern int fio_test_cconv(struct thread_options *);
723 extern void options_default_fill(struct thread_options *o);
725 typedef int (split_parse_fn)(struct thread_options *, void *,
726 enum fio_ddir, char *, bool);
728 extern int str_split_parse(struct thread_data *td, char *str,
729 split_parse_fn *fn, void *eo, bool data);
731 extern int split_parse_ddir(struct thread_options *o, struct split *split,
732 char *str, bool absolute, unsigned int max_splits);
734 extern int split_parse_prio_ddir(struct thread_options *o,
735 struct split_prio **entries, int *nr_entries,