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 log_alternate_epoch;
170 unsigned int log_alternate_epoch_clock_id;
171 unsigned int norandommap;
172 unsigned int softrandommap;
173 unsigned int bs_unaligned;
174 unsigned int fsync_on_close;
175 unsigned int bs_is_seq_rand;
177 unsigned int verify_only;
179 unsigned int random_distribution;
180 unsigned int exitall_error;
182 struct zone_split *zone_split[DDIR_RWDIR_CNT];
183 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
185 fio_fp64_t zipf_theta;
187 fio_fp64_t gauss_dev;
188 fio_fp64_t random_center;
190 unsigned int random_generator;
192 unsigned int perc_rand[DDIR_RWDIR_CNT];
194 unsigned int hugepage_size;
195 unsigned long long rw_min_bs;
196 unsigned int fsync_blocks;
197 unsigned int fdatasync_blocks;
198 unsigned int barrier_blocks;
199 unsigned long long start_delay;
200 unsigned long long start_delay_orig;
201 unsigned long long start_delay_high;
202 unsigned long long timeout;
203 unsigned long long ramp_time;
204 unsigned int ss_state;
206 unsigned long long ss_dur;
207 unsigned long long ss_ramp_time;
208 unsigned int overwrite;
209 unsigned int bw_avg_time;
210 unsigned int iops_avg_time;
212 unsigned long long zone_range;
213 unsigned long long zone_size;
214 unsigned long long zone_capacity;
215 unsigned long long zone_skip;
216 uint32_t zone_skip_nz;
217 enum fio_zone_mode zone_mode;
218 unsigned long long lockmem;
219 enum fio_memtype mem_type;
220 unsigned int mem_align;
222 unsigned long long max_latency[DDIR_RWDIR_CNT];
224 unsigned int exit_what;
225 unsigned int stonewall;
226 unsigned int new_group;
227 unsigned int numjobs;
228 os_cpu_mask_t cpumask;
229 os_cpu_mask_t verify_cpumask;
230 os_cpu_mask_t log_gz_cpumask;
231 unsigned int cpus_allowed_policy;
233 unsigned short numa_mem_mode;
234 unsigned int numa_mem_prefer_node;
236 unsigned int gpu_dev_id;
237 unsigned int start_offset_percent;
240 unsigned int rwmixcycle;
241 unsigned int rwmix[DDIR_RWDIR_CNT];
244 unsigned int ioprio_class;
245 unsigned int file_service_type;
246 unsigned int group_reporting;
248 unsigned int fadvise_hint;
249 enum fio_fallocate_mode fallocate_mode;
250 unsigned int zero_buffers;
251 unsigned int refill_buffers;
252 unsigned int scramble_buffers;
253 char buffer_pattern[MAX_PATTERN_SIZE];
254 unsigned int buffer_pattern_bytes;
255 unsigned int compress_percentage;
256 unsigned int compress_chunk;
257 unsigned int dedupe_percentage;
258 unsigned int dedupe_mode;
259 unsigned int dedupe_working_set_percentage;
260 unsigned int time_based;
261 unsigned int disable_lat;
262 unsigned int disable_clat;
263 unsigned int disable_slat;
264 unsigned int disable_bw;
265 unsigned int unified_rw_rep;
266 unsigned int gtod_reduce;
267 unsigned int gtod_cpu;
268 enum fio_cs clocksource;
269 unsigned int no_stall;
270 unsigned int trim_percentage;
271 unsigned int trim_batch;
272 unsigned int trim_zero;
273 unsigned long long trim_backlog;
274 unsigned int clat_percentiles;
275 unsigned int slat_percentiles;
276 unsigned int lat_percentiles;
277 unsigned int percentile_precision; /* digits after decimal for percentiles */
278 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
280 char *read_iolog_file;
281 bool read_iolog_chunked;
282 char *write_iolog_file;
283 char *merge_blktrace_file;
284 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
285 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
287 unsigned int write_bw_log;
288 unsigned int write_lat_log;
289 unsigned int write_iops_log;
290 unsigned int write_hist_log;
296 char *replay_redirect;
299 * Pre-run and post-run shell
304 unsigned int thinktime;
305 unsigned int thinktime_spin;
306 unsigned int thinktime_blocks;
307 unsigned int thinktime_blocks_type;
308 unsigned int thinktime_iotime;
310 uint64_t rate[DDIR_RWDIR_CNT];
311 uint64_t ratemin[DDIR_RWDIR_CNT];
312 unsigned int ratecycle;
313 unsigned int io_submit_mode;
314 unsigned int rate_iops[DDIR_RWDIR_CNT];
315 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
316 unsigned int rate_process;
317 unsigned int rate_ign_think;
324 enum error_type continue_on_error;
327 * Benchmark profile type
332 * blkio cgroup support
335 unsigned int cgroup_weight;
336 unsigned int cgroup_nodelete;
341 unsigned int offset_increment_percent;
342 unsigned int offset_increment_nz;
343 unsigned long long offset_increment;
344 unsigned long long number_ios;
346 unsigned int sync_file_range;
348 unsigned long long latency_target;
349 unsigned long long latency_window;
350 fio_fp64_t latency_percentile;
351 uint32_t latency_run;
358 unsigned int flow_sleep;
360 unsigned int sig_figs;
362 unsigned block_error_hist;
364 unsigned int replay_align;
365 unsigned int replay_scale;
366 unsigned int replay_time_scale;
367 unsigned int replay_skip;
369 unsigned int per_job_logs;
371 unsigned int allow_create;
372 unsigned int allow_mounted_write;
374 /* Parameters that affect zonemode=zbd */
375 unsigned int read_beyond_wp;
377 unsigned int job_max_open_zones;
378 unsigned int ignore_zone_limits;
382 unsigned int log_entries;
383 unsigned int log_prio;
386 #define FIO_TOP_STR_MAX 256
388 struct thread_options_pack {
389 uint64_t set_options[NR_OPTS_SZ];
390 uint8_t description[FIO_TOP_STR_MAX];
391 uint8_t name[FIO_TOP_STR_MAX];
392 uint8_t wait_for[FIO_TOP_STR_MAX];
393 uint8_t directory[FIO_TOP_STR_MAX];
394 uint8_t filename[FIO_TOP_STR_MAX];
395 uint8_t filename_format[FIO_TOP_STR_MAX];
396 uint8_t opendir[FIO_TOP_STR_MAX];
397 uint8_t ioengine[FIO_TOP_STR_MAX];
398 uint8_t mmapfile[FIO_TOP_STR_MAX];
403 uint32_t ddir_seq_nr;
404 uint64_t ddir_seq_add;
406 uint32_t iodepth_low;
407 uint32_t iodepth_batch;
408 uint32_t iodepth_batch_complete_min;
409 uint32_t iodepth_batch_complete_max;
410 uint32_t serialize_overlap;
415 uint32_t size_percent;
417 uint32_t io_size_percent;
419 uint32_t fill_device;
420 uint32_t file_append;
421 uint32_t unique_filename;
423 uint64_t file_size_low;
424 uint64_t file_size_high;
425 uint64_t start_offset;
426 uint64_t start_offset_align;
427 uint32_t start_offset_nz;
430 uint64_t bs[DDIR_RWDIR_CNT];
431 uint64_t ba[DDIR_RWDIR_CNT];
432 uint64_t min_bs[DDIR_RWDIR_CNT];
433 uint64_t max_bs[DDIR_RWDIR_CNT];
434 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
435 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
437 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
438 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
443 uint32_t file_lock_mode;
447 uint32_t invalidate_cache;
448 uint32_t create_serialize;
449 uint32_t create_fsync;
450 uint32_t create_on_open;
451 uint32_t create_only;
458 uint32_t verify_interval;
459 uint32_t verify_offset;
460 uint8_t verify_pattern[MAX_PATTERN_SIZE];
461 uint32_t verify_pattern_bytes;
462 uint32_t verify_fatal;
463 uint32_t verify_dump;
464 uint32_t verify_async;
465 uint64_t verify_backlog;
466 uint32_t verify_batch;
467 uint32_t experimental_verify;
468 uint32_t verify_state;
469 uint32_t verify_state_save;
472 uint32_t unlink_each_loop;
473 uint32_t do_disk_util;
474 uint32_t override_sync;
475 uint32_t rand_repeatable;
476 uint32_t allrand_repeatable;
479 uint32_t log_avg_msec;
480 uint32_t log_hist_msec;
481 uint32_t log_hist_coarseness;
485 uint32_t log_gz_store;
486 uint32_t log_unix_epoch;
487 uint32_t log_alternate_epoch;
488 uint32_t log_alternate_epoch_clock_id;
489 uint32_t norandommap;
490 uint32_t softrandommap;
491 uint32_t bs_unaligned;
492 uint32_t fsync_on_close;
493 uint32_t bs_is_seq_rand;
495 uint32_t random_distribution;
496 uint32_t exitall_error;
498 uint32_t sync_file_range;
500 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
501 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
503 fio_fp64_t zipf_theta;
505 fio_fp64_t gauss_dev;
506 fio_fp64_t random_center;
508 uint32_t random_generator;
510 uint32_t perc_rand[DDIR_RWDIR_CNT];
512 uint32_t hugepage_size;
514 uint32_t fsync_blocks;
515 uint32_t fdatasync_blocks;
516 uint32_t barrier_blocks;
517 uint64_t start_delay;
518 uint64_t start_delay_high;
522 uint64_t ss_ramp_time;
526 uint32_t bw_avg_time;
527 uint32_t iops_avg_time;
531 uint64_t zone_capacity;
534 uint32_t zone_skip_nz;
544 * We currently can't convert these, so don't enable them
547 uint8_t cpumask[FIO_TOP_STR_MAX];
548 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
549 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
552 uint32_t start_offset_percent;
553 uint32_t cpus_allowed_policy;
556 uint32_t rwmix[DDIR_RWDIR_CNT];
559 uint32_t ioprio_class;
560 uint32_t file_service_type;
561 uint32_t group_reporting;
563 uint32_t fadvise_hint;
564 uint32_t fallocate_mode;
565 uint32_t zero_buffers;
566 uint32_t refill_buffers;
567 uint32_t scramble_buffers;
568 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
569 uint32_t buffer_pattern_bytes;
570 uint32_t compress_percentage;
571 uint32_t compress_chunk;
572 uint32_t dedupe_percentage;
573 uint32_t dedupe_mode;
574 uint32_t dedupe_working_set_percentage;
576 uint32_t disable_lat;
577 uint32_t disable_clat;
578 uint32_t disable_slat;
580 uint32_t unified_rw_rep;
581 uint32_t gtod_reduce;
583 uint32_t clocksource;
585 uint32_t trim_percentage;
588 uint64_t trim_backlog;
589 uint32_t clat_percentiles;
590 uint32_t lat_percentiles;
591 uint32_t slat_percentiles;
592 uint32_t percentile_precision;
593 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
595 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
596 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
597 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
598 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
599 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
601 uint32_t write_bw_log;
602 uint32_t write_lat_log;
603 uint32_t write_iops_log;
604 uint32_t write_hist_log;
606 uint8_t bw_log_file[FIO_TOP_STR_MAX];
607 uint8_t lat_log_file[FIO_TOP_STR_MAX];
608 uint8_t iops_log_file[FIO_TOP_STR_MAX];
609 uint8_t hist_log_file[FIO_TOP_STR_MAX];
610 uint8_t replay_redirect[FIO_TOP_STR_MAX];
613 * Pre-run and post-run shell
615 uint8_t exec_prerun[FIO_TOP_STR_MAX];
616 uint8_t exec_postrun[FIO_TOP_STR_MAX];
619 uint32_t thinktime_spin;
620 uint32_t thinktime_blocks;
621 uint32_t thinktime_blocks_type;
622 uint32_t thinktime_iotime;
624 uint64_t rate[DDIR_RWDIR_CNT];
625 uint64_t ratemin[DDIR_RWDIR_CNT];
627 uint32_t io_submit_mode;
628 uint32_t rate_iops[DDIR_RWDIR_CNT];
629 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
630 uint32_t rate_process;
631 uint32_t rate_ign_think;
633 uint8_t ioscheduler[FIO_TOP_STR_MAX];
638 uint32_t continue_on_error;
641 * Benchmark profile type
643 uint8_t profile[FIO_TOP_STR_MAX];
646 * blkio cgroup support
648 uint8_t cgroup[FIO_TOP_STR_MAX];
649 uint32_t cgroup_weight;
650 uint32_t cgroup_nodelete;
655 uint32_t offset_increment_percent;
656 uint32_t offset_increment_nz;
657 uint64_t offset_increment;
660 uint64_t latency_target;
661 uint64_t latency_window;
662 uint64_t max_latency[DDIR_RWDIR_CNT];
663 fio_fp64_t latency_percentile;
664 uint32_t latency_run;
675 uint32_t block_error_hist;
677 uint32_t replay_align;
678 uint32_t replay_scale;
679 uint32_t replay_time_scale;
680 uint32_t replay_skip;
682 uint32_t per_job_logs;
684 uint32_t allow_create;
685 uint32_t allow_mounted_write;
688 int32_t max_open_zones;
689 uint32_t ignore_zone_limits;
691 uint32_t log_entries;
693 } __attribute__((packed));
695 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
696 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
697 extern int fio_test_cconv(struct thread_options *);
698 extern void options_default_fill(struct thread_options *o);
700 typedef int (split_parse_fn)(struct thread_options *, void *,
701 enum fio_ddir, char *, bool);
703 extern int str_split_parse(struct thread_data *td, char *str,
704 split_parse_fn *fn, void *eo, bool data);
706 extern int split_parse_ddir(struct thread_options *o, struct split *split,
707 char *str, bool absolute, unsigned int max_splits);