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 */
34 #define ERROR_STR_MAX 128
36 #define BSSPLIT_MAX 64
37 #define ZONESPLIT_MAX 256
51 #define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
53 #define OPT_MAGIC 0x4f50544e
55 struct thread_options {
57 uint64_t set_options[NR_OPTS_SZ];
63 char *filename_format;
66 char *ioengine_so_path;
71 unsigned int unit_base;
72 unsigned int ddir_seq_nr;
73 long long ddir_seq_add;
75 unsigned int iodepth_low;
76 unsigned int iodepth_batch;
77 unsigned int iodepth_batch_complete_min;
78 unsigned int iodepth_batch_complete_max;
79 unsigned int serialize_overlap;
81 unsigned int unique_filename;
83 unsigned long long size;
84 unsigned long long io_size;
85 unsigned int size_percent;
87 unsigned int io_size_percent;
88 unsigned int io_size_nz;
89 unsigned int fill_device;
90 unsigned int file_append;
91 unsigned long long file_size_low;
92 unsigned long long file_size_high;
93 unsigned long long start_offset;
94 unsigned long long start_offset_align;
95 unsigned int start_offset_nz;
97 unsigned long long bs[DDIR_RWDIR_CNT];
98 unsigned long long ba[DDIR_RWDIR_CNT];
99 unsigned long long min_bs[DDIR_RWDIR_CNT];
100 unsigned long long max_bs[DDIR_RWDIR_CNT];
101 struct bssplit *bssplit[DDIR_RWDIR_CNT];
102 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
104 int *ignore_error[ERROR_TYPE_CNT];
105 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
106 unsigned int error_dump;
108 unsigned int nr_files;
109 unsigned int open_files;
110 enum file_lock_mode file_lock_mode;
112 unsigned int odirect;
113 unsigned int oatomic;
114 unsigned int invalidate_cache;
115 unsigned int create_serialize;
116 unsigned int create_fsync;
117 unsigned int create_on_open;
118 unsigned int create_only;
119 unsigned int end_fsync;
120 unsigned int pre_read;
121 unsigned int sync_io;
122 unsigned int write_hint;
124 unsigned int do_verify;
125 unsigned int verify_interval;
126 unsigned int verify_offset;
127 char verify_pattern[MAX_PATTERN_SIZE];
128 unsigned int verify_pattern_bytes;
129 struct pattern_fmt verify_fmt[8];
130 unsigned int verify_fmt_sz;
131 unsigned int verify_fatal;
132 unsigned int verify_dump;
133 unsigned int verify_async;
134 unsigned long long verify_backlog;
135 unsigned int verify_batch;
136 unsigned int experimental_verify;
137 unsigned int verify_state;
138 unsigned int verify_state_save;
139 unsigned int use_thread;
141 unsigned int unlink_each_loop;
142 unsigned int do_disk_util;
143 unsigned int override_sync;
144 unsigned int rand_repeatable;
145 unsigned int allrand_repeatable;
146 unsigned long long rand_seed;
147 unsigned int log_avg_msec;
148 unsigned int log_hist_msec;
149 unsigned int log_hist_coarseness;
150 unsigned int log_max;
151 unsigned int log_offset;
153 unsigned int log_gz_store;
154 unsigned int log_unix_epoch;
155 unsigned int norandommap;
156 unsigned int softrandommap;
157 unsigned int bs_unaligned;
158 unsigned int fsync_on_close;
159 unsigned int bs_is_seq_rand;
161 unsigned int verify_only;
163 unsigned int random_distribution;
164 unsigned int exitall_error;
166 struct zone_split *zone_split[DDIR_RWDIR_CNT];
167 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
169 fio_fp64_t zipf_theta;
171 fio_fp64_t gauss_dev;
172 fio_fp64_t random_center;
174 unsigned int random_generator;
176 unsigned int perc_rand[DDIR_RWDIR_CNT];
178 unsigned int hugepage_size;
179 unsigned long long rw_min_bs;
180 unsigned int thinktime;
181 unsigned int thinktime_spin;
182 unsigned int thinktime_blocks;
183 unsigned int thinktime_blocks_type;
184 unsigned int fsync_blocks;
185 unsigned int fdatasync_blocks;
186 unsigned int barrier_blocks;
187 unsigned long long start_delay;
188 unsigned long long start_delay_orig;
189 unsigned long long start_delay_high;
190 unsigned long long timeout;
191 unsigned long long ramp_time;
192 unsigned int ss_state;
194 unsigned long long ss_dur;
195 unsigned long long ss_ramp_time;
196 unsigned int overwrite;
197 unsigned int bw_avg_time;
198 unsigned int iops_avg_time;
200 unsigned long long zone_range;
201 unsigned long long zone_size;
202 unsigned long long zone_capacity;
203 unsigned long long zone_skip;
204 uint32_t zone_skip_nz;
205 enum fio_zone_mode zone_mode;
206 unsigned long long lockmem;
207 enum fio_memtype mem_type;
208 unsigned int mem_align;
210 unsigned long long max_latency[DDIR_RWDIR_CNT];
212 unsigned int exit_what;
213 unsigned int stonewall;
214 unsigned int new_group;
215 unsigned int numjobs;
216 os_cpu_mask_t cpumask;
217 os_cpu_mask_t verify_cpumask;
218 os_cpu_mask_t log_gz_cpumask;
219 unsigned int cpus_allowed_policy;
221 unsigned short numa_mem_mode;
222 unsigned int numa_mem_prefer_node;
224 unsigned int gpu_dev_id;
225 unsigned int start_offset_percent;
228 unsigned int rwmixcycle;
229 unsigned int rwmix[DDIR_RWDIR_CNT];
232 unsigned int ioprio_class;
233 unsigned int file_service_type;
234 unsigned int group_reporting;
236 unsigned int fadvise_hint;
237 enum fio_fallocate_mode fallocate_mode;
238 unsigned int zero_buffers;
239 unsigned int refill_buffers;
240 unsigned int scramble_buffers;
241 char buffer_pattern[MAX_PATTERN_SIZE];
242 unsigned int buffer_pattern_bytes;
243 unsigned int compress_percentage;
244 unsigned int compress_chunk;
245 unsigned int dedupe_percentage;
246 unsigned int time_based;
247 unsigned int disable_lat;
248 unsigned int disable_clat;
249 unsigned int disable_slat;
250 unsigned int disable_bw;
251 unsigned int unified_rw_rep;
252 unsigned int gtod_reduce;
253 unsigned int gtod_cpu;
254 enum fio_cs clocksource;
255 unsigned int no_stall;
256 unsigned int trim_percentage;
257 unsigned int trim_batch;
258 unsigned int trim_zero;
259 unsigned long long trim_backlog;
260 unsigned int clat_percentiles;
261 unsigned int slat_percentiles;
262 unsigned int lat_percentiles;
263 unsigned int percentile_precision; /* digits after decimal for percentiles */
264 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
266 char *read_iolog_file;
267 bool read_iolog_chunked;
268 char *write_iolog_file;
269 char *merge_blktrace_file;
270 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
271 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
273 unsigned int write_bw_log;
274 unsigned int write_lat_log;
275 unsigned int write_iops_log;
276 unsigned int write_hist_log;
282 char *replay_redirect;
285 * Pre-run and post-run shell
290 uint64_t rate[DDIR_RWDIR_CNT];
291 uint64_t ratemin[DDIR_RWDIR_CNT];
292 unsigned int ratecycle;
293 unsigned int io_submit_mode;
294 unsigned int rate_iops[DDIR_RWDIR_CNT];
295 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
296 unsigned int rate_process;
297 unsigned int rate_ign_think;
304 enum error_type continue_on_error;
307 * Benchmark profile type
312 * blkio cgroup support
315 unsigned int cgroup_weight;
316 unsigned int cgroup_nodelete;
321 unsigned int offset_increment_percent;
322 unsigned int offset_increment_nz;
323 unsigned long long offset_increment;
324 unsigned long long number_ios;
326 unsigned int sync_file_range;
328 unsigned long long latency_target;
329 unsigned long long latency_window;
330 fio_fp64_t latency_percentile;
331 uint32_t latency_run;
338 unsigned int flow_sleep;
340 unsigned int sig_figs;
342 unsigned block_error_hist;
344 unsigned int replay_align;
345 unsigned int replay_scale;
346 unsigned int replay_time_scale;
347 unsigned int replay_skip;
349 unsigned int per_job_logs;
351 unsigned int allow_create;
352 unsigned int allow_mounted_write;
354 /* Parameters that affect zonemode=zbd */
355 unsigned int read_beyond_wp;
357 unsigned int job_max_open_zones;
362 #define FIO_TOP_STR_MAX 256
364 struct thread_options_pack {
365 uint64_t set_options[NR_OPTS_SZ];
366 uint8_t description[FIO_TOP_STR_MAX];
367 uint8_t name[FIO_TOP_STR_MAX];
368 uint8_t wait_for[FIO_TOP_STR_MAX];
369 uint8_t directory[FIO_TOP_STR_MAX];
370 uint8_t filename[FIO_TOP_STR_MAX];
371 uint8_t filename_format[FIO_TOP_STR_MAX];
372 uint8_t opendir[FIO_TOP_STR_MAX];
373 uint8_t ioengine[FIO_TOP_STR_MAX];
374 uint8_t mmapfile[FIO_TOP_STR_MAX];
379 uint32_t ddir_seq_nr;
380 uint64_t ddir_seq_add;
382 uint32_t iodepth_low;
383 uint32_t iodepth_batch;
384 uint32_t iodepth_batch_complete_min;
385 uint32_t iodepth_batch_complete_max;
386 uint32_t serialize_overlap;
391 uint32_t size_percent;
393 uint32_t io_size_percent;
395 uint32_t fill_device;
396 uint32_t file_append;
397 uint32_t unique_filename;
399 uint64_t file_size_low;
400 uint64_t file_size_high;
401 uint64_t start_offset;
402 uint64_t start_offset_align;
403 uint32_t start_offset_nz;
406 uint64_t bs[DDIR_RWDIR_CNT];
407 uint64_t ba[DDIR_RWDIR_CNT];
408 uint64_t min_bs[DDIR_RWDIR_CNT];
409 uint64_t max_bs[DDIR_RWDIR_CNT];
410 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
411 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
413 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
414 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
419 uint32_t file_lock_mode;
423 uint32_t invalidate_cache;
424 uint32_t create_serialize;
425 uint32_t create_fsync;
426 uint32_t create_on_open;
427 uint32_t create_only;
434 uint32_t verify_interval;
435 uint32_t verify_offset;
436 uint8_t verify_pattern[MAX_PATTERN_SIZE];
437 uint32_t verify_pattern_bytes;
438 uint32_t verify_fatal;
439 uint32_t verify_dump;
440 uint32_t verify_async;
441 uint64_t verify_backlog;
442 uint32_t verify_batch;
443 uint32_t experimental_verify;
444 uint32_t verify_state;
445 uint32_t verify_state_save;
448 uint32_t unlink_each_loop;
449 uint32_t do_disk_util;
450 uint32_t override_sync;
451 uint32_t rand_repeatable;
452 uint32_t allrand_repeatable;
455 uint32_t log_avg_msec;
456 uint32_t log_hist_msec;
457 uint32_t log_hist_coarseness;
461 uint32_t log_gz_store;
462 uint32_t log_unix_epoch;
463 uint32_t norandommap;
464 uint32_t softrandommap;
465 uint32_t bs_unaligned;
466 uint32_t fsync_on_close;
467 uint32_t bs_is_seq_rand;
469 uint32_t random_distribution;
470 uint32_t exitall_error;
472 uint32_t sync_file_range;
474 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
475 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
477 fio_fp64_t zipf_theta;
479 fio_fp64_t gauss_dev;
480 fio_fp64_t random_center;
482 uint32_t random_generator;
484 uint32_t perc_rand[DDIR_RWDIR_CNT];
486 uint32_t hugepage_size;
489 uint32_t thinktime_spin;
490 uint32_t thinktime_blocks;
491 uint32_t thinktime_blocks_type;
492 uint32_t fsync_blocks;
493 uint32_t fdatasync_blocks;
494 uint32_t barrier_blocks;
495 uint64_t start_delay;
496 uint64_t start_delay_high;
500 uint64_t ss_ramp_time;
504 uint32_t bw_avg_time;
505 uint32_t iops_avg_time;
509 uint64_t zone_capacity;
512 uint32_t zone_skip_nz;
522 * We currently can't convert these, so don't enable them
525 uint8_t cpumask[FIO_TOP_STR_MAX];
526 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
527 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
530 uint32_t start_offset_percent;
531 uint32_t cpus_allowed_policy;
534 uint32_t rwmix[DDIR_RWDIR_CNT];
537 uint32_t ioprio_class;
538 uint32_t file_service_type;
539 uint32_t group_reporting;
541 uint32_t fadvise_hint;
542 uint32_t fallocate_mode;
543 uint32_t zero_buffers;
544 uint32_t refill_buffers;
545 uint32_t scramble_buffers;
546 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
547 uint32_t buffer_pattern_bytes;
548 uint32_t compress_percentage;
549 uint32_t compress_chunk;
550 uint32_t dedupe_percentage;
552 uint32_t disable_lat;
553 uint32_t disable_clat;
554 uint32_t disable_slat;
556 uint32_t unified_rw_rep;
557 uint32_t gtod_reduce;
559 uint32_t clocksource;
561 uint32_t trim_percentage;
564 uint64_t trim_backlog;
565 uint32_t clat_percentiles;
566 uint32_t lat_percentiles;
567 uint32_t slat_percentiles;
568 uint32_t percentile_precision;
569 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
571 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
572 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
573 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
574 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
575 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
577 uint32_t write_bw_log;
578 uint32_t write_lat_log;
579 uint32_t write_iops_log;
580 uint32_t write_hist_log;
582 uint8_t bw_log_file[FIO_TOP_STR_MAX];
583 uint8_t lat_log_file[FIO_TOP_STR_MAX];
584 uint8_t iops_log_file[FIO_TOP_STR_MAX];
585 uint8_t hist_log_file[FIO_TOP_STR_MAX];
586 uint8_t replay_redirect[FIO_TOP_STR_MAX];
589 * Pre-run and post-run shell
591 uint8_t exec_prerun[FIO_TOP_STR_MAX];
592 uint8_t exec_postrun[FIO_TOP_STR_MAX];
594 uint64_t rate[DDIR_RWDIR_CNT];
595 uint64_t ratemin[DDIR_RWDIR_CNT];
597 uint32_t io_submit_mode;
598 uint32_t rate_iops[DDIR_RWDIR_CNT];
599 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
600 uint32_t rate_process;
601 uint32_t rate_ign_think;
603 uint8_t ioscheduler[FIO_TOP_STR_MAX];
608 uint32_t continue_on_error;
611 * Benchmark profile type
613 uint8_t profile[FIO_TOP_STR_MAX];
616 * blkio cgroup support
618 uint8_t cgroup[FIO_TOP_STR_MAX];
619 uint32_t cgroup_weight;
620 uint32_t cgroup_nodelete;
625 uint32_t offset_increment_percent;
626 uint32_t offset_increment_nz;
627 uint64_t offset_increment;
630 uint64_t latency_target;
631 uint64_t latency_window;
632 uint64_t max_latency[DDIR_RWDIR_CNT];
634 fio_fp64_t latency_percentile;
635 uint32_t latency_run;
646 uint32_t block_error_hist;
648 uint32_t replay_align;
649 uint32_t replay_scale;
650 uint32_t replay_time_scale;
651 uint32_t replay_skip;
653 uint32_t per_job_logs;
655 uint32_t allow_create;
656 uint32_t allow_mounted_write;
659 } __attribute__((packed));
661 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
662 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
663 extern int fio_test_cconv(struct thread_options *);
664 extern void options_default_fill(struct thread_options *o);