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_alternate_epoch;
174 unsigned int log_alternate_epoch_clock_id;
175 unsigned int norandommap;
176 unsigned int softrandommap;
177 unsigned int bs_unaligned;
178 unsigned int fsync_on_close;
179 unsigned int bs_is_seq_rand;
181 unsigned int verify_only;
183 unsigned int random_distribution;
184 unsigned int exitall_error;
186 struct zone_split *zone_split[DDIR_RWDIR_CNT];
187 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
189 fio_fp64_t zipf_theta;
191 fio_fp64_t gauss_dev;
192 fio_fp64_t random_center;
194 unsigned int random_generator;
196 unsigned int perc_rand[DDIR_RWDIR_CNT];
198 unsigned int hugepage_size;
199 unsigned long long rw_min_bs;
200 unsigned int fsync_blocks;
201 unsigned int fdatasync_blocks;
202 unsigned int barrier_blocks;
203 unsigned long long start_delay;
204 unsigned long long start_delay_orig;
205 unsigned long long start_delay_high;
206 unsigned long long timeout;
207 unsigned long long ramp_time;
208 unsigned int ss_state;
210 unsigned long long ss_dur;
211 unsigned long long ss_ramp_time;
212 unsigned long long ss_check_interval;
213 unsigned int overwrite;
214 unsigned int bw_avg_time;
215 unsigned int iops_avg_time;
217 unsigned long long zone_range;
218 unsigned long long zone_size;
219 unsigned long long zone_capacity;
220 unsigned long long zone_skip;
221 uint32_t zone_skip_nz;
222 enum fio_zone_mode zone_mode;
223 unsigned long long lockmem;
224 enum fio_memtype mem_type;
225 unsigned int mem_align;
227 unsigned long long max_latency[DDIR_RWDIR_CNT];
229 unsigned int exit_what;
230 unsigned int stonewall;
231 unsigned int new_group;
232 unsigned int numjobs;
233 os_cpu_mask_t cpumask;
234 os_cpu_mask_t verify_cpumask;
235 os_cpu_mask_t log_gz_cpumask;
236 unsigned int cpus_allowed_policy;
238 unsigned short numa_mem_mode;
239 unsigned int numa_mem_prefer_node;
241 unsigned int gpu_dev_id;
242 unsigned int start_offset_percent;
245 unsigned int rwmixcycle;
246 unsigned int rwmix[DDIR_RWDIR_CNT];
249 unsigned int ioprio_class;
250 unsigned int ioprio_hint;
251 unsigned int file_service_type;
252 unsigned int group_reporting;
254 unsigned int fadvise_hint;
255 enum fio_fallocate_mode fallocate_mode;
256 unsigned int zero_buffers;
257 unsigned int refill_buffers;
258 unsigned int scramble_buffers;
259 char *buffer_pattern;
260 unsigned int buffer_pattern_bytes;
261 unsigned int compress_percentage;
262 unsigned int compress_chunk;
263 unsigned int dedupe_percentage;
264 unsigned int dedupe_mode;
265 unsigned int dedupe_working_set_percentage;
266 unsigned int dedupe_global;
267 unsigned int time_based;
268 unsigned int disable_lat;
269 unsigned int disable_clat;
270 unsigned int disable_slat;
271 unsigned int disable_bw;
272 unsigned int unified_rw_rep;
273 unsigned int gtod_reduce;
274 unsigned int gtod_cpu;
275 unsigned int job_start_clock_id;
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 thinkcycles;
314 unsigned int thinktime;
315 unsigned int thinktime_spin;
316 unsigned int thinktime_blocks;
317 unsigned int thinktime_blocks_type;
318 unsigned int thinktime_iotime;
320 uint64_t rate[DDIR_RWDIR_CNT];
321 uint64_t ratemin[DDIR_RWDIR_CNT];
322 unsigned int ratecycle;
323 unsigned int io_submit_mode;
324 unsigned int rate_iops[DDIR_RWDIR_CNT];
325 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
326 unsigned int rate_process;
327 unsigned int rate_ign_think;
334 enum error_type continue_on_error;
337 * Benchmark profile type
342 * blkio cgroup support
345 unsigned int cgroup_weight;
346 unsigned int cgroup_nodelete;
351 unsigned int offset_increment_percent;
352 unsigned int offset_increment_nz;
353 unsigned long long offset_increment;
354 unsigned long long number_ios;
356 unsigned int num_range;
358 unsigned int sync_file_range;
360 unsigned long long latency_target;
361 unsigned long long latency_window;
362 uint32_t latency_run;
363 fio_fp64_t latency_percentile;
370 unsigned int flow_sleep;
372 unsigned int sig_figs;
374 unsigned block_error_hist;
376 unsigned int replay_align;
377 unsigned int replay_scale;
378 unsigned int replay_time_scale;
379 unsigned int replay_skip;
381 unsigned int per_job_logs;
383 unsigned int allow_create;
384 unsigned int allow_mounted_write;
386 /* Parameters that affect zonemode=zbd */
387 unsigned int read_beyond_wp;
389 unsigned int job_max_open_zones;
390 unsigned int ignore_zone_limits;
395 unsigned int dp_type;
396 unsigned int dp_id_select;
397 uint16_t dp_ids[FIO_MAX_DP_IDS];
398 unsigned int dp_nr_ids;
399 char *dp_scheme_file;
401 unsigned int log_entries;
402 unsigned int log_prio;
405 #define FIO_TOP_STR_MAX 256
407 struct thread_options_pack {
408 uint64_t set_options[NR_OPTS_SZ];
409 uint8_t description[FIO_TOP_STR_MAX];
410 uint8_t name[FIO_TOP_STR_MAX];
411 uint8_t wait_for[FIO_TOP_STR_MAX];
412 uint8_t directory[FIO_TOP_STR_MAX];
413 uint8_t filename[FIO_TOP_STR_MAX];
414 uint8_t filename_format[FIO_TOP_STR_MAX];
415 uint8_t opendir[FIO_TOP_STR_MAX];
416 uint8_t ioengine[FIO_TOP_STR_MAX];
417 uint8_t mmapfile[FIO_TOP_STR_MAX];
422 uint32_t ddir_seq_nr;
423 uint64_t ddir_seq_add;
425 uint32_t iodepth_low;
426 uint32_t iodepth_batch;
427 uint32_t iodepth_batch_complete_min;
428 uint32_t iodepth_batch_complete_max;
429 uint32_t serialize_overlap;
433 uint32_t size_percent;
435 uint32_t io_size_percent;
437 uint32_t fill_device;
438 uint32_t file_append;
439 uint32_t unique_filename;
440 uint64_t file_size_low;
441 uint64_t file_size_high;
442 uint64_t start_offset;
443 uint64_t start_offset_align;
444 uint32_t start_offset_nz;
446 uint64_t bs[DDIR_RWDIR_CNT];
447 uint64_t ba[DDIR_RWDIR_CNT];
448 uint64_t min_bs[DDIR_RWDIR_CNT];
449 uint64_t max_bs[DDIR_RWDIR_CNT];
450 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
451 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
453 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
454 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
459 uint32_t file_lock_mode;
463 uint32_t invalidate_cache;
464 uint32_t create_serialize;
465 uint32_t create_fsync;
466 uint32_t create_on_open;
467 uint32_t create_only;
474 uint32_t verify_interval;
475 uint32_t verify_offset;
476 uint32_t verify_pattern_bytes;
477 uint32_t verify_fatal;
478 uint32_t verify_dump;
479 uint32_t verify_async;
480 uint64_t verify_backlog;
481 uint32_t verify_batch;
482 uint32_t experimental_verify;
483 uint32_t verify_state;
484 uint32_t verify_state_save;
487 uint32_t unlink_each_loop;
488 uint32_t do_disk_util;
489 uint32_t override_sync;
490 uint32_t rand_repeatable;
492 uint32_t log_avg_msec;
493 uint32_t log_hist_msec;
494 uint32_t log_hist_coarseness;
498 uint32_t log_gz_store;
499 uint32_t log_alternate_epoch;
500 uint32_t log_alternate_epoch_clock_id;
501 uint32_t norandommap;
502 uint32_t softrandommap;
503 uint32_t bs_unaligned;
504 uint32_t fsync_on_close;
505 uint32_t bs_is_seq_rand;
507 uint32_t random_distribution;
508 uint32_t exitall_error;
510 uint32_t sync_file_range;
512 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
513 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
515 fio_fp64_t zipf_theta;
517 fio_fp64_t gauss_dev;
518 fio_fp64_t random_center;
520 uint32_t random_generator;
522 uint32_t perc_rand[DDIR_RWDIR_CNT];
524 uint32_t hugepage_size;
526 uint32_t fsync_blocks;
527 uint32_t fdatasync_blocks;
528 uint32_t barrier_blocks;
529 uint64_t start_delay;
530 uint64_t start_delay_high;
534 uint64_t ss_ramp_time;
537 uint64_t ss_check_interval;
539 uint32_t bw_avg_time;
540 uint32_t iops_avg_time;
544 uint64_t zone_capacity;
547 uint32_t zone_skip_nz;
557 * We currently can't convert these, so don't enable them
560 uint8_t cpumask[FIO_TOP_STR_MAX];
561 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
562 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
565 uint32_t start_offset_percent;
566 uint32_t cpus_allowed_policy;
569 uint32_t rwmix[DDIR_RWDIR_CNT];
572 uint32_t ioprio_class;
573 uint32_t ioprio_hint;
574 uint32_t file_service_type;
575 uint32_t group_reporting;
577 uint32_t fadvise_hint;
578 uint32_t fallocate_mode;
579 uint32_t zero_buffers;
580 uint32_t refill_buffers;
581 uint32_t scramble_buffers;
582 uint32_t buffer_pattern_bytes;
583 uint32_t compress_percentage;
584 uint32_t compress_chunk;
585 uint32_t dedupe_percentage;
586 uint32_t dedupe_mode;
587 uint32_t dedupe_working_set_percentage;
588 uint32_t dedupe_global;
590 uint32_t disable_lat;
591 uint32_t disable_clat;
592 uint32_t disable_slat;
594 uint32_t unified_rw_rep;
595 uint32_t gtod_reduce;
597 uint32_t job_start_clock_id;
598 uint32_t clocksource;
600 uint32_t trim_percentage;
603 uint64_t trim_backlog;
604 uint32_t clat_percentiles;
605 uint32_t lat_percentiles;
606 uint32_t slat_percentiles;
607 uint32_t percentile_precision;
609 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
611 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
612 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
613 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
614 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
615 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
617 uint32_t write_bw_log;
618 uint32_t write_lat_log;
619 uint32_t write_iops_log;
620 uint32_t write_hist_log;
622 uint8_t bw_log_file[FIO_TOP_STR_MAX];
623 uint8_t lat_log_file[FIO_TOP_STR_MAX];
624 uint8_t iops_log_file[FIO_TOP_STR_MAX];
625 uint8_t hist_log_file[FIO_TOP_STR_MAX];
626 uint8_t replay_redirect[FIO_TOP_STR_MAX];
629 * Pre-run and post-run shell
631 uint8_t exec_prerun[FIO_TOP_STR_MAX];
632 uint8_t exec_postrun[FIO_TOP_STR_MAX];
634 uint32_t thinkcycles;
637 uint32_t thinktime_spin;
638 uint32_t thinktime_blocks;
639 uint32_t thinktime_blocks_type;
640 uint32_t thinktime_iotime;
642 uint64_t rate[DDIR_RWDIR_CNT];
643 uint64_t ratemin[DDIR_RWDIR_CNT];
645 uint32_t io_submit_mode;
646 uint32_t rate_iops[DDIR_RWDIR_CNT];
647 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
648 uint32_t rate_process;
649 uint32_t rate_ign_think;
651 uint8_t ioscheduler[FIO_TOP_STR_MAX];
656 uint32_t continue_on_error;
659 * Benchmark profile type
661 uint8_t profile[FIO_TOP_STR_MAX];
664 * blkio cgroup support
666 uint8_t cgroup[FIO_TOP_STR_MAX];
667 uint32_t cgroup_weight;
668 uint32_t cgroup_nodelete;
673 uint32_t offset_increment_percent;
674 uint32_t offset_increment_nz;
675 uint64_t offset_increment;
678 uint64_t latency_target;
679 uint64_t latency_window;
680 uint64_t max_latency[DDIR_RWDIR_CNT];
681 uint32_t latency_run;
682 fio_fp64_t latency_percentile;
693 uint32_t block_error_hist;
695 uint32_t replay_align;
696 uint32_t replay_scale;
697 uint32_t replay_time_scale;
698 uint32_t replay_skip;
700 uint32_t per_job_logs;
702 uint32_t allow_create;
703 uint32_t allow_mounted_write;
706 int32_t max_open_zones;
707 uint32_t ignore_zone_limits;
709 uint32_t log_entries;
714 uint32_t dp_id_select;
715 uint16_t dp_ids[FIO_MAX_DP_IDS];
717 uint8_t dp_scheme_file[FIO_TOP_STR_MAX];
721 * verify_pattern followed by buffer_pattern from the unpacked struct
724 } __attribute__((packed));
726 extern int convert_thread_options_to_cpu(struct thread_options *o,
727 struct thread_options_pack *top, size_t top_sz);
728 extern size_t thread_options_pack_size(struct thread_options *o);
729 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
730 extern int fio_test_cconv(struct thread_options *);
731 extern void options_default_fill(struct thread_options *o);
733 typedef int (split_parse_fn)(struct thread_options *, void *,
734 enum fio_ddir, char *, bool);
736 extern int str_split_parse(struct thread_data *td, char *str,
737 split_parse_fn *fn, void *eo, bool data);
739 extern int split_parse_ddir(struct thread_options *o, struct split *split,
740 char *str, bool absolute, unsigned int max_splits);
742 extern int split_parse_prio_ddir(struct thread_options *o,
743 struct split_prio **entries, int *nr_entries,