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;
86 unsigned int fill_device;
87 unsigned int file_append;
88 unsigned long long file_size_low;
89 unsigned long long file_size_high;
90 unsigned long long start_offset;
91 unsigned long long start_offset_align;
93 unsigned long long bs[DDIR_RWDIR_CNT];
94 unsigned long long ba[DDIR_RWDIR_CNT];
95 unsigned long long min_bs[DDIR_RWDIR_CNT];
96 unsigned long long max_bs[DDIR_RWDIR_CNT];
97 struct bssplit *bssplit[DDIR_RWDIR_CNT];
98 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
100 int *ignore_error[ERROR_TYPE_CNT];
101 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
102 unsigned int error_dump;
104 unsigned int nr_files;
105 unsigned int open_files;
106 enum file_lock_mode file_lock_mode;
108 unsigned int odirect;
109 unsigned int oatomic;
110 unsigned int invalidate_cache;
111 unsigned int create_serialize;
112 unsigned int create_fsync;
113 unsigned int create_on_open;
114 unsigned int create_only;
115 unsigned int end_fsync;
116 unsigned int pre_read;
117 unsigned int sync_io;
118 unsigned int write_hint;
120 unsigned int do_verify;
121 unsigned int verify_interval;
122 unsigned int verify_offset;
123 char verify_pattern[MAX_PATTERN_SIZE];
124 unsigned int verify_pattern_bytes;
125 struct pattern_fmt verify_fmt[8];
126 unsigned int verify_fmt_sz;
127 unsigned int verify_fatal;
128 unsigned int verify_dump;
129 unsigned int verify_async;
130 unsigned long long verify_backlog;
131 unsigned int verify_batch;
132 unsigned int experimental_verify;
133 unsigned int verify_state;
134 unsigned int verify_state_save;
135 unsigned int use_thread;
137 unsigned int unlink_each_loop;
138 unsigned int do_disk_util;
139 unsigned int override_sync;
140 unsigned int rand_repeatable;
141 unsigned int allrand_repeatable;
142 unsigned long long rand_seed;
143 unsigned int log_avg_msec;
144 unsigned int log_hist_msec;
145 unsigned int log_hist_coarseness;
146 unsigned int log_max;
147 unsigned int log_offset;
149 unsigned int log_gz_store;
150 unsigned int log_unix_epoch;
151 unsigned int norandommap;
152 unsigned int softrandommap;
153 unsigned int bs_unaligned;
154 unsigned int fsync_on_close;
155 unsigned int bs_is_seq_rand;
157 unsigned int verify_only;
159 unsigned int random_distribution;
160 unsigned int exitall_error;
162 struct zone_split *zone_split[DDIR_RWDIR_CNT];
163 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
165 fio_fp64_t zipf_theta;
167 fio_fp64_t gauss_dev;
169 unsigned int random_generator;
171 unsigned int perc_rand[DDIR_RWDIR_CNT];
173 unsigned int hugepage_size;
174 unsigned long long rw_min_bs;
175 unsigned int thinktime;
176 unsigned int thinktime_spin;
177 unsigned int thinktime_blocks;
178 unsigned int fsync_blocks;
179 unsigned int fdatasync_blocks;
180 unsigned int barrier_blocks;
181 unsigned long long start_delay;
182 unsigned long long start_delay_orig;
183 unsigned long long start_delay_high;
184 unsigned long long timeout;
185 unsigned long long ramp_time;
186 unsigned int ss_state;
188 unsigned long long ss_dur;
189 unsigned long long ss_ramp_time;
190 unsigned int overwrite;
191 unsigned int bw_avg_time;
192 unsigned int iops_avg_time;
194 unsigned long long zone_range;
195 unsigned long long zone_size;
196 unsigned long long zone_skip;
197 enum fio_zone_mode zone_mode;
198 unsigned long long lockmem;
199 enum fio_memtype mem_type;
200 unsigned int mem_align;
202 unsigned long long max_latency;
204 unsigned int stonewall;
205 unsigned int new_group;
206 unsigned int numjobs;
207 os_cpu_mask_t cpumask;
208 os_cpu_mask_t verify_cpumask;
209 os_cpu_mask_t log_gz_cpumask;
210 unsigned int cpus_allowed_policy;
212 unsigned short numa_mem_mode;
213 unsigned int numa_mem_prefer_node;
215 unsigned int gpu_dev_id;
216 unsigned int start_offset_percent;
219 unsigned int rwmixcycle;
220 unsigned int rwmix[DDIR_RWDIR_CNT];
223 unsigned int ioprio_class;
224 unsigned int file_service_type;
225 unsigned int group_reporting;
227 unsigned int fadvise_hint;
228 enum fio_fallocate_mode fallocate_mode;
229 unsigned int zero_buffers;
230 unsigned int refill_buffers;
231 unsigned int scramble_buffers;
232 char buffer_pattern[MAX_PATTERN_SIZE];
233 unsigned int buffer_pattern_bytes;
234 unsigned int compress_percentage;
235 unsigned int compress_chunk;
236 unsigned int dedupe_percentage;
237 unsigned int time_based;
238 unsigned int disable_lat;
239 unsigned int disable_clat;
240 unsigned int disable_slat;
241 unsigned int disable_bw;
242 unsigned int unified_rw_rep;
243 unsigned int gtod_reduce;
244 unsigned int gtod_cpu;
245 enum fio_cs clocksource;
246 unsigned int no_stall;
247 unsigned int trim_percentage;
248 unsigned int trim_batch;
249 unsigned int trim_zero;
250 unsigned long long trim_backlog;
251 unsigned int clat_percentiles;
252 unsigned int lat_percentiles;
253 unsigned int percentile_precision; /* digits after decimal for percentiles */
254 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
256 char *read_iolog_file;
257 bool read_iolog_chunked;
258 char *write_iolog_file;
259 char *merge_blktrace_file;
260 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
261 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
263 unsigned int write_bw_log;
264 unsigned int write_lat_log;
265 unsigned int write_iops_log;
266 unsigned int write_hist_log;
272 char *replay_redirect;
275 * Pre-run and post-run shell
280 uint64_t rate[DDIR_RWDIR_CNT];
281 uint64_t ratemin[DDIR_RWDIR_CNT];
282 unsigned int ratecycle;
283 unsigned int io_submit_mode;
284 unsigned int rate_iops[DDIR_RWDIR_CNT];
285 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
286 unsigned int rate_process;
287 unsigned int rate_ign_think;
294 enum error_type continue_on_error;
297 * Benchmark profile type
302 * blkio cgroup support
305 unsigned int cgroup_weight;
306 unsigned int cgroup_nodelete;
314 unsigned int flow_sleep;
316 unsigned long long offset_increment;
317 unsigned long long number_ios;
319 unsigned int sync_file_range;
321 unsigned long long latency_target;
322 unsigned long long latency_window;
323 fio_fp64_t latency_percentile;
325 unsigned int sig_figs;
327 unsigned block_error_hist;
329 unsigned int replay_align;
330 unsigned int replay_scale;
331 unsigned int replay_time_scale;
332 unsigned int replay_skip;
334 unsigned int per_job_logs;
336 unsigned int allow_create;
337 unsigned int allow_mounted_write;
339 /* Parameters that affect zonemode=zbd */
340 unsigned int read_beyond_wp;
346 #define FIO_TOP_STR_MAX 256
348 struct thread_options_pack {
349 uint64_t set_options[NR_OPTS_SZ];
350 uint8_t description[FIO_TOP_STR_MAX];
351 uint8_t name[FIO_TOP_STR_MAX];
352 uint8_t wait_for[FIO_TOP_STR_MAX];
353 uint8_t directory[FIO_TOP_STR_MAX];
354 uint8_t filename[FIO_TOP_STR_MAX];
355 uint8_t filename_format[FIO_TOP_STR_MAX];
356 uint8_t opendir[FIO_TOP_STR_MAX];
357 uint8_t ioengine[FIO_TOP_STR_MAX];
358 uint8_t mmapfile[FIO_TOP_STR_MAX];
363 uint32_t ddir_seq_nr;
364 uint64_t ddir_seq_add;
366 uint32_t iodepth_low;
367 uint32_t iodepth_batch;
368 uint32_t iodepth_batch_complete_min;
369 uint32_t iodepth_batch_complete_max;
370 uint32_t serialize_overlap;
371 uint32_t lat_percentiles;
375 uint32_t size_percent;
376 uint32_t fill_device;
377 uint32_t file_append;
378 uint32_t unique_filename;
379 uint64_t file_size_low;
380 uint64_t file_size_high;
381 uint64_t start_offset;
382 uint64_t start_offset_align;
384 uint64_t bs[DDIR_RWDIR_CNT];
385 uint64_t ba[DDIR_RWDIR_CNT];
386 uint64_t min_bs[DDIR_RWDIR_CNT];
387 uint64_t max_bs[DDIR_RWDIR_CNT];
388 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
389 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
391 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
392 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
397 uint32_t file_lock_mode;
401 uint32_t invalidate_cache;
402 uint32_t create_serialize;
403 uint32_t create_fsync;
404 uint32_t create_on_open;
405 uint32_t create_only;
412 uint32_t verify_interval;
413 uint32_t verify_offset;
414 uint8_t verify_pattern[MAX_PATTERN_SIZE];
415 uint32_t verify_pattern_bytes;
416 uint32_t verify_fatal;
417 uint32_t verify_dump;
418 uint32_t verify_async;
419 uint64_t verify_backlog;
420 uint32_t verify_batch;
421 uint32_t experimental_verify;
422 uint32_t verify_state;
423 uint32_t verify_state_save;
426 uint32_t unlink_each_loop;
427 uint32_t do_disk_util;
428 uint32_t override_sync;
429 uint32_t rand_repeatable;
430 uint32_t allrand_repeatable;
433 uint32_t log_avg_msec;
434 uint32_t log_hist_msec;
435 uint32_t log_hist_coarseness;
439 uint32_t log_gz_store;
440 uint32_t log_unix_epoch;
441 uint32_t norandommap;
442 uint32_t softrandommap;
443 uint32_t bs_unaligned;
444 uint32_t fsync_on_close;
445 uint32_t bs_is_seq_rand;
447 uint32_t random_distribution;
448 uint32_t exitall_error;
450 uint32_t sync_file_range;
452 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
453 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
455 fio_fp64_t zipf_theta;
457 fio_fp64_t gauss_dev;
459 uint32_t random_generator;
461 uint32_t perc_rand[DDIR_RWDIR_CNT];
463 uint32_t hugepage_size;
467 uint32_t thinktime_spin;
468 uint32_t thinktime_blocks;
469 uint32_t fsync_blocks;
470 uint32_t fdatasync_blocks;
471 uint32_t barrier_blocks;
472 uint64_t start_delay;
473 uint64_t start_delay_high;
477 uint64_t ss_ramp_time;
481 uint32_t bw_avg_time;
482 uint32_t iops_avg_time;
495 * We currently can't convert these, so don't enable them
498 uint8_t cpumask[FIO_TOP_STR_MAX];
499 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
500 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
503 uint32_t start_offset_percent;
504 uint32_t cpus_allowed_policy;
507 uint32_t rwmix[DDIR_RWDIR_CNT];
510 uint32_t ioprio_class;
511 uint32_t file_service_type;
512 uint32_t group_reporting;
514 uint32_t fadvise_hint;
515 uint32_t fallocate_mode;
516 uint32_t zero_buffers;
517 uint32_t refill_buffers;
518 uint32_t scramble_buffers;
519 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
520 uint32_t buffer_pattern_bytes;
521 uint32_t compress_percentage;
522 uint32_t compress_chunk;
523 uint32_t dedupe_percentage;
525 uint32_t disable_lat;
526 uint32_t disable_clat;
527 uint32_t disable_slat;
529 uint32_t unified_rw_rep;
530 uint32_t gtod_reduce;
532 uint32_t clocksource;
534 uint32_t trim_percentage;
537 uint64_t trim_backlog;
538 uint32_t clat_percentiles;
539 uint32_t percentile_precision;
540 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
542 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
543 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
544 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
545 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
546 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
548 uint32_t write_bw_log;
549 uint32_t write_lat_log;
550 uint32_t write_iops_log;
551 uint32_t write_hist_log;
553 uint8_t bw_log_file[FIO_TOP_STR_MAX];
554 uint8_t lat_log_file[FIO_TOP_STR_MAX];
555 uint8_t iops_log_file[FIO_TOP_STR_MAX];
556 uint8_t hist_log_file[FIO_TOP_STR_MAX];
557 uint8_t replay_redirect[FIO_TOP_STR_MAX];
560 * Pre-run and post-run shell
562 uint8_t exec_prerun[FIO_TOP_STR_MAX];
563 uint8_t exec_postrun[FIO_TOP_STR_MAX];
565 uint64_t rate[DDIR_RWDIR_CNT];
566 uint64_t ratemin[DDIR_RWDIR_CNT];
568 uint32_t io_submit_mode;
569 uint32_t rate_iops[DDIR_RWDIR_CNT];
570 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
571 uint32_t rate_process;
572 uint32_t rate_ign_think;
575 uint8_t ioscheduler[FIO_TOP_STR_MAX];
580 uint32_t continue_on_error;
583 * Benchmark profile type
585 uint8_t profile[FIO_TOP_STR_MAX];
588 * blkio cgroup support
590 uint8_t cgroup[FIO_TOP_STR_MAX];
591 uint32_t cgroup_weight;
592 uint32_t cgroup_nodelete;
599 int32_t flow_watermark;
602 uint64_t offset_increment;
605 uint64_t latency_target;
606 uint64_t latency_window;
607 uint64_t max_latency;
608 fio_fp64_t latency_percentile;
612 uint32_t block_error_hist;
614 uint32_t replay_align;
615 uint32_t replay_scale;
616 uint32_t replay_time_scale;
617 uint32_t replay_skip;
619 uint32_t per_job_logs;
621 uint32_t allow_create;
622 uint32_t allow_mounted_write;
625 } __attribute__((packed));
627 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
628 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
629 extern int fio_test_cconv(struct thread_options *);
630 extern void options_default_fill(struct thread_options *o);