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];
65 #define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
67 #define OPT_MAGIC 0x4f50544e
69 struct thread_options {
71 uint64_t set_options[NR_OPTS_SZ];
77 char *filename_format;
80 char *ioengine_so_path;
85 unsigned int unit_base;
86 unsigned int ddir_seq_nr;
87 long long ddir_seq_add;
89 unsigned int iodepth_low;
90 unsigned int iodepth_batch;
91 unsigned int iodepth_batch_complete_min;
92 unsigned int iodepth_batch_complete_max;
93 unsigned int serialize_overlap;
95 unsigned int unique_filename;
97 unsigned long long size;
98 unsigned long long io_size;
99 unsigned int size_percent;
100 unsigned int size_nz;
101 unsigned int io_size_percent;
102 unsigned int io_size_nz;
103 unsigned int fill_device;
104 unsigned int file_append;
105 unsigned long long file_size_low;
106 unsigned long long file_size_high;
107 unsigned long long start_offset;
108 unsigned long long start_offset_align;
109 unsigned int start_offset_nz;
111 unsigned long long bs[DDIR_RWDIR_CNT];
112 unsigned long long ba[DDIR_RWDIR_CNT];
113 unsigned long long min_bs[DDIR_RWDIR_CNT];
114 unsigned long long max_bs[DDIR_RWDIR_CNT];
115 struct bssplit *bssplit[DDIR_RWDIR_CNT];
116 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
118 int *ignore_error[ERROR_TYPE_CNT];
119 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
120 unsigned int error_dump;
122 unsigned int nr_files;
123 unsigned int open_files;
124 enum file_lock_mode file_lock_mode;
126 unsigned int odirect;
127 unsigned int oatomic;
128 unsigned int invalidate_cache;
129 unsigned int create_serialize;
130 unsigned int create_fsync;
131 unsigned int create_on_open;
132 unsigned int create_only;
133 unsigned int end_fsync;
134 unsigned int pre_read;
135 unsigned int sync_io;
136 unsigned int write_hint;
138 unsigned int do_verify;
139 unsigned int verify_interval;
140 unsigned int verify_offset;
141 char verify_pattern[MAX_PATTERN_SIZE];
142 unsigned int verify_pattern_bytes;
143 struct pattern_fmt verify_fmt[8];
144 unsigned int verify_fmt_sz;
145 unsigned int verify_fatal;
146 unsigned int verify_dump;
147 unsigned int verify_async;
148 unsigned long long verify_backlog;
149 unsigned int verify_batch;
150 unsigned int experimental_verify;
151 unsigned int verify_state;
152 unsigned int verify_state_save;
153 unsigned int use_thread;
155 unsigned int unlink_each_loop;
156 unsigned int do_disk_util;
157 unsigned int override_sync;
158 unsigned int rand_repeatable;
159 unsigned int allrand_repeatable;
160 unsigned long long rand_seed;
161 unsigned int log_avg_msec;
162 unsigned int log_hist_msec;
163 unsigned int log_hist_coarseness;
164 unsigned int log_max;
165 unsigned int log_offset;
167 unsigned int log_gz_store;
168 unsigned int log_unix_epoch;
169 unsigned int norandommap;
170 unsigned int softrandommap;
171 unsigned int bs_unaligned;
172 unsigned int fsync_on_close;
173 unsigned int bs_is_seq_rand;
175 unsigned int verify_only;
177 unsigned int random_distribution;
178 unsigned int exitall_error;
180 struct zone_split *zone_split[DDIR_RWDIR_CNT];
181 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
183 fio_fp64_t zipf_theta;
185 fio_fp64_t gauss_dev;
186 fio_fp64_t random_center;
188 unsigned int random_generator;
190 unsigned int perc_rand[DDIR_RWDIR_CNT];
192 unsigned int hugepage_size;
193 unsigned long long rw_min_bs;
194 unsigned int fsync_blocks;
195 unsigned int fdatasync_blocks;
196 unsigned int barrier_blocks;
197 unsigned long long start_delay;
198 unsigned long long start_delay_orig;
199 unsigned long long start_delay_high;
200 unsigned long long timeout;
201 unsigned long long ramp_time;
202 unsigned int ss_state;
204 unsigned long long ss_dur;
205 unsigned long long ss_ramp_time;
206 unsigned int overwrite;
207 unsigned int bw_avg_time;
208 unsigned int iops_avg_time;
210 unsigned long long zone_range;
211 unsigned long long zone_size;
212 unsigned long long zone_capacity;
213 unsigned long long zone_skip;
214 uint32_t zone_skip_nz;
215 enum fio_zone_mode zone_mode;
216 unsigned long long lockmem;
217 enum fio_memtype mem_type;
218 unsigned int mem_align;
220 unsigned long long max_latency[DDIR_RWDIR_CNT];
222 unsigned int exit_what;
223 unsigned int stonewall;
224 unsigned int new_group;
225 unsigned int numjobs;
226 os_cpu_mask_t cpumask;
227 os_cpu_mask_t verify_cpumask;
228 os_cpu_mask_t log_gz_cpumask;
229 unsigned int cpus_allowed_policy;
231 unsigned short numa_mem_mode;
232 unsigned int numa_mem_prefer_node;
234 unsigned int gpu_dev_id;
235 unsigned int start_offset_percent;
238 unsigned int rwmixcycle;
239 unsigned int rwmix[DDIR_RWDIR_CNT];
242 unsigned int ioprio_class;
243 unsigned int file_service_type;
244 unsigned int group_reporting;
246 unsigned int fadvise_hint;
247 enum fio_fallocate_mode fallocate_mode;
248 unsigned int zero_buffers;
249 unsigned int refill_buffers;
250 unsigned int scramble_buffers;
251 char buffer_pattern[MAX_PATTERN_SIZE];
252 unsigned int buffer_pattern_bytes;
253 unsigned int compress_percentage;
254 unsigned int compress_chunk;
255 unsigned int dedupe_percentage;
256 unsigned int dedupe_mode;
257 unsigned int dedupe_working_set_percentage;
258 unsigned int time_based;
259 unsigned int disable_lat;
260 unsigned int disable_clat;
261 unsigned int disable_slat;
262 unsigned int disable_bw;
263 unsigned int unified_rw_rep;
264 unsigned int gtod_reduce;
265 unsigned int gtod_cpu;
266 enum fio_cs clocksource;
267 unsigned int no_stall;
268 unsigned int trim_percentage;
269 unsigned int trim_batch;
270 unsigned int trim_zero;
271 unsigned long long trim_backlog;
272 unsigned int clat_percentiles;
273 unsigned int slat_percentiles;
274 unsigned int lat_percentiles;
275 unsigned int percentile_precision; /* digits after decimal for percentiles */
276 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
278 char *read_iolog_file;
279 bool read_iolog_chunked;
280 char *write_iolog_file;
281 char *merge_blktrace_file;
282 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
283 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
285 unsigned int write_bw_log;
286 unsigned int write_lat_log;
287 unsigned int write_iops_log;
288 unsigned int write_hist_log;
294 char *replay_redirect;
297 * Pre-run and post-run shell
302 unsigned int thinktime;
303 unsigned int thinktime_spin;
304 unsigned int thinktime_blocks;
305 unsigned int thinktime_blocks_type;
306 unsigned int thinktime_iotime;
308 uint64_t rate[DDIR_RWDIR_CNT];
309 uint64_t ratemin[DDIR_RWDIR_CNT];
310 unsigned int ratecycle;
311 unsigned int io_submit_mode;
312 unsigned int rate_iops[DDIR_RWDIR_CNT];
313 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
314 unsigned int rate_process;
315 unsigned int rate_ign_think;
322 enum error_type continue_on_error;
325 * Benchmark profile type
330 * blkio cgroup support
333 unsigned int cgroup_weight;
334 unsigned int cgroup_nodelete;
339 unsigned int offset_increment_percent;
340 unsigned int offset_increment_nz;
341 unsigned long long offset_increment;
342 unsigned long long number_ios;
344 unsigned int sync_file_range;
346 unsigned long long latency_target;
347 unsigned long long latency_window;
348 fio_fp64_t latency_percentile;
349 uint32_t latency_run;
356 unsigned int flow_sleep;
358 unsigned int sig_figs;
360 unsigned block_error_hist;
362 unsigned int replay_align;
363 unsigned int replay_scale;
364 unsigned int replay_time_scale;
365 unsigned int replay_skip;
367 unsigned int per_job_logs;
369 unsigned int allow_create;
370 unsigned int allow_mounted_write;
372 /* Parameters that affect zonemode=zbd */
373 unsigned int read_beyond_wp;
375 unsigned int job_max_open_zones;
376 unsigned int ignore_zone_limits;
380 unsigned int log_prio;
383 #define FIO_TOP_STR_MAX 256
385 struct thread_options_pack {
386 uint64_t set_options[NR_OPTS_SZ];
387 uint8_t description[FIO_TOP_STR_MAX];
388 uint8_t name[FIO_TOP_STR_MAX];
389 uint8_t wait_for[FIO_TOP_STR_MAX];
390 uint8_t directory[FIO_TOP_STR_MAX];
391 uint8_t filename[FIO_TOP_STR_MAX];
392 uint8_t filename_format[FIO_TOP_STR_MAX];
393 uint8_t opendir[FIO_TOP_STR_MAX];
394 uint8_t ioengine[FIO_TOP_STR_MAX];
395 uint8_t mmapfile[FIO_TOP_STR_MAX];
400 uint32_t ddir_seq_nr;
401 uint64_t ddir_seq_add;
403 uint32_t iodepth_low;
404 uint32_t iodepth_batch;
405 uint32_t iodepth_batch_complete_min;
406 uint32_t iodepth_batch_complete_max;
407 uint32_t serialize_overlap;
412 uint32_t size_percent;
414 uint32_t io_size_percent;
416 uint32_t fill_device;
417 uint32_t file_append;
418 uint32_t unique_filename;
420 uint64_t file_size_low;
421 uint64_t file_size_high;
422 uint64_t start_offset;
423 uint64_t start_offset_align;
424 uint32_t start_offset_nz;
427 uint64_t bs[DDIR_RWDIR_CNT];
428 uint64_t ba[DDIR_RWDIR_CNT];
429 uint64_t min_bs[DDIR_RWDIR_CNT];
430 uint64_t max_bs[DDIR_RWDIR_CNT];
431 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
432 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
434 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
435 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
440 uint32_t file_lock_mode;
444 uint32_t invalidate_cache;
445 uint32_t create_serialize;
446 uint32_t create_fsync;
447 uint32_t create_on_open;
448 uint32_t create_only;
455 uint32_t verify_interval;
456 uint32_t verify_offset;
457 uint8_t verify_pattern[MAX_PATTERN_SIZE];
458 uint32_t verify_pattern_bytes;
459 uint32_t verify_fatal;
460 uint32_t verify_dump;
461 uint32_t verify_async;
462 uint64_t verify_backlog;
463 uint32_t verify_batch;
464 uint32_t experimental_verify;
465 uint32_t verify_state;
466 uint32_t verify_state_save;
469 uint32_t unlink_each_loop;
470 uint32_t do_disk_util;
471 uint32_t override_sync;
472 uint32_t rand_repeatable;
473 uint32_t allrand_repeatable;
476 uint32_t log_avg_msec;
477 uint32_t log_hist_msec;
478 uint32_t log_hist_coarseness;
482 uint32_t log_gz_store;
483 uint32_t log_unix_epoch;
484 uint32_t norandommap;
485 uint32_t softrandommap;
486 uint32_t bs_unaligned;
487 uint32_t fsync_on_close;
488 uint32_t bs_is_seq_rand;
490 uint32_t random_distribution;
491 uint32_t exitall_error;
493 uint32_t sync_file_range;
495 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
496 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
498 fio_fp64_t zipf_theta;
500 fio_fp64_t gauss_dev;
501 fio_fp64_t random_center;
503 uint32_t random_generator;
505 uint32_t perc_rand[DDIR_RWDIR_CNT];
507 uint32_t hugepage_size;
509 uint32_t fsync_blocks;
510 uint32_t fdatasync_blocks;
511 uint32_t barrier_blocks;
512 uint64_t start_delay;
513 uint64_t start_delay_high;
517 uint64_t ss_ramp_time;
521 uint32_t bw_avg_time;
522 uint32_t iops_avg_time;
526 uint64_t zone_capacity;
529 uint32_t zone_skip_nz;
539 * We currently can't convert these, so don't enable them
542 uint8_t cpumask[FIO_TOP_STR_MAX];
543 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
544 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
547 uint32_t start_offset_percent;
548 uint32_t cpus_allowed_policy;
551 uint32_t rwmix[DDIR_RWDIR_CNT];
554 uint32_t ioprio_class;
555 uint32_t file_service_type;
556 uint32_t group_reporting;
558 uint32_t fadvise_hint;
559 uint32_t fallocate_mode;
560 uint32_t zero_buffers;
561 uint32_t refill_buffers;
562 uint32_t scramble_buffers;
563 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
564 uint32_t buffer_pattern_bytes;
565 uint32_t compress_percentage;
566 uint32_t compress_chunk;
567 uint32_t dedupe_percentage;
568 uint32_t dedupe_mode;
569 uint32_t dedupe_working_set_percentage;
571 uint32_t disable_lat;
572 uint32_t disable_clat;
573 uint32_t disable_slat;
575 uint32_t unified_rw_rep;
576 uint32_t gtod_reduce;
578 uint32_t clocksource;
580 uint32_t trim_percentage;
583 uint64_t trim_backlog;
584 uint32_t clat_percentiles;
585 uint32_t lat_percentiles;
586 uint32_t slat_percentiles;
587 uint32_t percentile_precision;
588 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
590 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
591 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
592 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
593 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
594 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
596 uint32_t write_bw_log;
597 uint32_t write_lat_log;
598 uint32_t write_iops_log;
599 uint32_t write_hist_log;
601 uint8_t bw_log_file[FIO_TOP_STR_MAX];
602 uint8_t lat_log_file[FIO_TOP_STR_MAX];
603 uint8_t iops_log_file[FIO_TOP_STR_MAX];
604 uint8_t hist_log_file[FIO_TOP_STR_MAX];
605 uint8_t replay_redirect[FIO_TOP_STR_MAX];
608 * Pre-run and post-run shell
610 uint8_t exec_prerun[FIO_TOP_STR_MAX];
611 uint8_t exec_postrun[FIO_TOP_STR_MAX];
614 uint32_t thinktime_spin;
615 uint32_t thinktime_blocks;
616 uint32_t thinktime_blocks_type;
617 uint32_t thinktime_iotime;
619 uint64_t rate[DDIR_RWDIR_CNT];
620 uint64_t ratemin[DDIR_RWDIR_CNT];
622 uint32_t io_submit_mode;
623 uint32_t rate_iops[DDIR_RWDIR_CNT];
624 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
625 uint32_t rate_process;
626 uint32_t rate_ign_think;
628 uint8_t ioscheduler[FIO_TOP_STR_MAX];
633 uint32_t continue_on_error;
636 * Benchmark profile type
638 uint8_t profile[FIO_TOP_STR_MAX];
641 * blkio cgroup support
643 uint8_t cgroup[FIO_TOP_STR_MAX];
644 uint32_t cgroup_weight;
645 uint32_t cgroup_nodelete;
650 uint32_t offset_increment_percent;
651 uint32_t offset_increment_nz;
652 uint64_t offset_increment;
655 uint64_t latency_target;
656 uint64_t latency_window;
657 uint64_t max_latency[DDIR_RWDIR_CNT];
658 fio_fp64_t latency_percentile;
659 uint32_t latency_run;
670 uint32_t block_error_hist;
672 uint32_t replay_align;
673 uint32_t replay_scale;
674 uint32_t replay_time_scale;
675 uint32_t replay_skip;
677 uint32_t per_job_logs;
679 uint32_t allow_create;
680 uint32_t allow_mounted_write;
683 int32_t max_open_zones;
684 uint32_t ignore_zone_limits;
687 } __attribute__((packed));
689 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
690 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
691 extern int fio_test_cconv(struct thread_options *);
692 extern void options_default_fill(struct thread_options *o);
694 typedef int (split_parse_fn)(struct thread_options *, void *,
695 enum fio_ddir, char *, bool);
697 extern int str_split_parse(struct thread_data *td, char *str,
698 split_parse_fn *fn, void *eo, bool data);
700 extern int split_parse_ddir(struct thread_options *o, struct split *split,
701 char *str, bool absolute, unsigned int max_splits);