projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Merge branch 'patch-1' of https://github.com/antroseco/fio
[fio.git] / thread_options.h
... / ...
CommitLineData
1#ifndef FIO_THREAD_OPTIONS_H
2#define FIO_THREAD_OPTIONS_H
3
4#include "arch/arch.h"
5#include "os/os.h"
6#include "options.h"
7#include "stat.h"
8#include "gettime.h"
9#include "lib/ieee754.h"
10#include "lib/pattern.h"
11#include "td_error.h"
12
13enum fio_zone_mode {
14 ZONE_MODE_NOT_SPECIFIED = 0,
15 ZONE_MODE_NONE = 1,
16 ZONE_MODE_STRIDED = 2, /* perform I/O in one zone at a time */
17 /* perform I/O across multiple zones simultaneously */
18 ZONE_MODE_ZBD = 3,
19};
20
21/*
22 * What type of allocation to use for io buffers
23 */
24enum fio_memtype {
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 */
32};
33
34/*
35 * What mode to use for deduped data generation
36 */
37enum dedupe_mode {
38 DEDUPE_MODE_REPEAT = 0,
39 DEDUPE_MODE_WORKING_SET = 1,
40};
41
42#define ERROR_STR_MAX 128
43
44#define BSSPLIT_MAX 64
45#define ZONESPLIT_MAX 256
46
47struct bssplit {
48 uint64_t bs;
49 uint32_t perc;
50};
51
52struct zone_split {
53 uint8_t access_perc;
54 uint8_t size_perc;
55 uint8_t pad[6];
56 uint64_t size;
57};
58
59#define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
60
61#define OPT_MAGIC 0x4f50544e
62
63struct thread_options {
64 int magic;
65 uint64_t set_options[NR_OPTS_SZ];
66 char *description;
67 char *name;
68 char *wait_for;
69 char *directory;
70 char *filename;
71 char *filename_format;
72 char *opendir;
73 char *ioengine;
74 char *ioengine_so_path;
75 char *mmapfile;
76 enum td_ddir td_ddir;
77 unsigned int rw_seq;
78 unsigned int kb_base;
79 unsigned int unit_base;
80 unsigned int ddir_seq_nr;
81 long long ddir_seq_add;
82 unsigned int iodepth;
83 unsigned int iodepth_low;
84 unsigned int iodepth_batch;
85 unsigned int iodepth_batch_complete_min;
86 unsigned int iodepth_batch_complete_max;
87 unsigned int serialize_overlap;
88
89 unsigned int unique_filename;
90
91 unsigned long long size;
92 unsigned long long io_size;
93 unsigned int size_percent;
94 unsigned int size_nz;
95 unsigned int io_size_percent;
96 unsigned int io_size_nz;
97 unsigned int fill_device;
98 unsigned int file_append;
99 unsigned long long file_size_low;
100 unsigned long long file_size_high;
101 unsigned long long start_offset;
102 unsigned long long start_offset_align;
103 unsigned int start_offset_nz;
104
105 unsigned long long bs[DDIR_RWDIR_CNT];
106 unsigned long long ba[DDIR_RWDIR_CNT];
107 unsigned long long min_bs[DDIR_RWDIR_CNT];
108 unsigned long long max_bs[DDIR_RWDIR_CNT];
109 struct bssplit *bssplit[DDIR_RWDIR_CNT];
110 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
111
112 int *ignore_error[ERROR_TYPE_CNT];
113 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
114 unsigned int error_dump;
115
116 unsigned int nr_files;
117 unsigned int open_files;
118 enum file_lock_mode file_lock_mode;
119
120 unsigned int odirect;
121 unsigned int oatomic;
122 unsigned int invalidate_cache;
123 unsigned int create_serialize;
124 unsigned int create_fsync;
125 unsigned int create_on_open;
126 unsigned int create_only;
127 unsigned int end_fsync;
128 unsigned int pre_read;
129 unsigned int sync_io;
130 unsigned int write_hint;
131 unsigned int verify;
132 unsigned int do_verify;
133 unsigned int verify_interval;
134 unsigned int verify_offset;
135 char verify_pattern[MAX_PATTERN_SIZE];
136 unsigned int verify_pattern_bytes;
137 struct pattern_fmt verify_fmt[8];
138 unsigned int verify_fmt_sz;
139 unsigned int verify_fatal;
140 unsigned int verify_dump;
141 unsigned int verify_async;
142 unsigned long long verify_backlog;
143 unsigned int verify_batch;
144 unsigned int experimental_verify;
145 unsigned int verify_state;
146 unsigned int verify_state_save;
147 unsigned int use_thread;
148 unsigned int unlink;
149 unsigned int unlink_each_loop;
150 unsigned int do_disk_util;
151 unsigned int override_sync;
152 unsigned int rand_repeatable;
153 unsigned int allrand_repeatable;
154 unsigned long long rand_seed;
155 unsigned int log_avg_msec;
156 unsigned int log_hist_msec;
157 unsigned int log_hist_coarseness;
158 unsigned int log_max;
159 unsigned int log_offset;
160 unsigned int log_gz;
161 unsigned int log_gz_store;
162 unsigned int log_unix_epoch;
163 unsigned int norandommap;
164 unsigned int softrandommap;
165 unsigned int bs_unaligned;
166 unsigned int fsync_on_close;
167 unsigned int bs_is_seq_rand;
168
169 unsigned int verify_only;
170
171 unsigned int random_distribution;
172 unsigned int exitall_error;
173
174 struct zone_split *zone_split[DDIR_RWDIR_CNT];
175 unsigned int zone_split_nr[DDIR_RWDIR_CNT];
176
177 fio_fp64_t zipf_theta;
178 fio_fp64_t pareto_h;
179 fio_fp64_t gauss_dev;
180 fio_fp64_t random_center;
181
182 unsigned int random_generator;
183
184 unsigned int perc_rand[DDIR_RWDIR_CNT];
185
186 unsigned int hugepage_size;
187 unsigned long long rw_min_bs;
188 unsigned int thinktime;
189 unsigned int thinktime_spin;
190 unsigned int thinktime_blocks;
191 unsigned int thinktime_blocks_type;
192 unsigned int fsync_blocks;
193 unsigned int fdatasync_blocks;
194 unsigned int barrier_blocks;
195 unsigned long long start_delay;
196 unsigned long long start_delay_orig;
197 unsigned long long start_delay_high;
198 unsigned long long timeout;
199 unsigned long long ramp_time;
200 unsigned int ss_state;
201 fio_fp64_t ss_limit;
202 unsigned long long ss_dur;
203 unsigned long long ss_ramp_time;
204 unsigned int overwrite;
205 unsigned int bw_avg_time;
206 unsigned int iops_avg_time;
207 unsigned int loops;
208 unsigned long long zone_range;
209 unsigned long long zone_size;
210 unsigned long long zone_capacity;
211 unsigned long long zone_skip;
212 uint32_t zone_skip_nz;
213 enum fio_zone_mode zone_mode;
214 unsigned long long lockmem;
215 enum fio_memtype mem_type;
216 unsigned int mem_align;
217
218 unsigned long long max_latency[DDIR_RWDIR_CNT];
219
220 unsigned int exit_what;
221 unsigned int stonewall;
222 unsigned int new_group;
223 unsigned int numjobs;
224 os_cpu_mask_t cpumask;
225 os_cpu_mask_t verify_cpumask;
226 os_cpu_mask_t log_gz_cpumask;
227 unsigned int cpus_allowed_policy;
228 char *numa_cpunodes;
229 unsigned short numa_mem_mode;
230 unsigned int numa_mem_prefer_node;
231 char *numa_memnodes;
232 unsigned int gpu_dev_id;
233 unsigned int start_offset_percent;
234
235 unsigned int iolog;
236 unsigned int rwmixcycle;
237 unsigned int rwmix[DDIR_RWDIR_CNT];
238 unsigned int nice;
239 unsigned int ioprio;
240 unsigned int ioprio_class;
241 unsigned int file_service_type;
242 unsigned int group_reporting;
243 unsigned int stats;
244 unsigned int fadvise_hint;
245 enum fio_fallocate_mode fallocate_mode;
246 unsigned int zero_buffers;
247 unsigned int refill_buffers;
248 unsigned int scramble_buffers;
249 char buffer_pattern[MAX_PATTERN_SIZE];
250 unsigned int buffer_pattern_bytes;
251 unsigned int compress_percentage;
252 unsigned int compress_chunk;
253 unsigned int dedupe_percentage;
254 unsigned int dedupe_mode;
255 unsigned int dedupe_working_set_percentage;
256 unsigned int time_based;
257 unsigned int disable_lat;
258 unsigned int disable_clat;
259 unsigned int disable_slat;
260 unsigned int disable_bw;
261 unsigned int unified_rw_rep;
262 unsigned int gtod_reduce;
263 unsigned int gtod_cpu;
264 enum fio_cs clocksource;
265 unsigned int no_stall;
266 unsigned int trim_percentage;
267 unsigned int trim_batch;
268 unsigned int trim_zero;
269 unsigned long long trim_backlog;
270 unsigned int clat_percentiles;
271 unsigned int slat_percentiles;
272 unsigned int lat_percentiles;
273 unsigned int percentile_precision; /* digits after decimal for percentiles */
274 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
275
276 char *read_iolog_file;
277 bool read_iolog_chunked;
278 char *write_iolog_file;
279 char *merge_blktrace_file;
280 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
281 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
282
283 unsigned int write_bw_log;
284 unsigned int write_lat_log;
285 unsigned int write_iops_log;
286 unsigned int write_hist_log;
287
288 char *bw_log_file;
289 char *lat_log_file;
290 char *iops_log_file;
291 char *hist_log_file;
292 char *replay_redirect;
293
294 /*
295 * Pre-run and post-run shell
296 */
297 char *exec_prerun;
298 char *exec_postrun;
299
300 uint64_t rate[DDIR_RWDIR_CNT];
301 uint64_t ratemin[DDIR_RWDIR_CNT];
302 unsigned int ratecycle;
303 unsigned int io_submit_mode;
304 unsigned int rate_iops[DDIR_RWDIR_CNT];
305 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
306 unsigned int rate_process;
307 unsigned int rate_ign_think;
308
309 char *ioscheduler;
310
311 /*
312 * I/O Error handling
313 */
314 enum error_type continue_on_error;
315
316 /*
317 * Benchmark profile type
318 */
319 char *profile;
320
321 /*
322 * blkio cgroup support
323 */
324 char *cgroup;
325 unsigned int cgroup_weight;
326 unsigned int cgroup_nodelete;
327
328 unsigned int uid;
329 unsigned int gid;
330
331 unsigned int offset_increment_percent;
332 unsigned int offset_increment_nz;
333 unsigned long long offset_increment;
334 unsigned long long number_ios;
335
336 unsigned int sync_file_range;
337
338 unsigned long long latency_target;
339 unsigned long long latency_window;
340 fio_fp64_t latency_percentile;
341 uint32_t latency_run;
342
343 /*
344 * flow support
345 */
346 int flow_id;
347 unsigned int flow;
348 unsigned int flow_sleep;
349
350 unsigned int sig_figs;
351
352 unsigned block_error_hist;
353
354 unsigned int replay_align;
355 unsigned int replay_scale;
356 unsigned int replay_time_scale;
357 unsigned int replay_skip;
358
359 unsigned int per_job_logs;
360
361 unsigned int allow_create;
362 unsigned int allow_mounted_write;
363
364 /* Parameters that affect zonemode=zbd */
365 unsigned int read_beyond_wp;
366 int max_open_zones;
367 unsigned int job_max_open_zones;
368 unsigned int ignore_zone_limits;
369 fio_fp64_t zrt;
370 fio_fp64_t zrf;
371};
372
373#define FIO_TOP_STR_MAX 256
374
375struct thread_options_pack {
376 uint64_t set_options[NR_OPTS_SZ];
377 uint8_t description[FIO_TOP_STR_MAX];
378 uint8_t name[FIO_TOP_STR_MAX];
379 uint8_t wait_for[FIO_TOP_STR_MAX];
380 uint8_t directory[FIO_TOP_STR_MAX];
381 uint8_t filename[FIO_TOP_STR_MAX];
382 uint8_t filename_format[FIO_TOP_STR_MAX];
383 uint8_t opendir[FIO_TOP_STR_MAX];
384 uint8_t ioengine[FIO_TOP_STR_MAX];
385 uint8_t mmapfile[FIO_TOP_STR_MAX];
386 uint32_t td_ddir;
387 uint32_t rw_seq;
388 uint32_t kb_base;
389 uint32_t unit_base;
390 uint32_t ddir_seq_nr;
391 uint64_t ddir_seq_add;
392 uint32_t iodepth;
393 uint32_t iodepth_low;
394 uint32_t iodepth_batch;
395 uint32_t iodepth_batch_complete_min;
396 uint32_t iodepth_batch_complete_max;
397 uint32_t serialize_overlap;
398 uint32_t pad;
399
400 uint64_t size;
401 uint64_t io_size;
402 uint32_t size_percent;
403 uint32_t size_nz;
404 uint32_t io_size_percent;
405 uint32_t io_size_nz;
406 uint32_t fill_device;
407 uint32_t file_append;
408 uint32_t unique_filename;
409 uint32_t pad3;
410 uint64_t file_size_low;
411 uint64_t file_size_high;
412 uint64_t start_offset;
413 uint64_t start_offset_align;
414 uint32_t start_offset_nz;
415 uint32_t pad4;
416
417 uint64_t bs[DDIR_RWDIR_CNT];
418 uint64_t ba[DDIR_RWDIR_CNT];
419 uint64_t min_bs[DDIR_RWDIR_CNT];
420 uint64_t max_bs[DDIR_RWDIR_CNT];
421 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
422 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
423
424 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
425 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
426 uint32_t error_dump;
427
428 uint32_t nr_files;
429 uint32_t open_files;
430 uint32_t file_lock_mode;
431
432 uint32_t odirect;
433 uint32_t oatomic;
434 uint32_t invalidate_cache;
435 uint32_t create_serialize;
436 uint32_t create_fsync;
437 uint32_t create_on_open;
438 uint32_t create_only;
439 uint32_t end_fsync;
440 uint32_t pre_read;
441 uint32_t sync_io;
442 uint32_t write_hint;
443 uint32_t verify;
444 uint32_t do_verify;
445 uint32_t verify_interval;
446 uint32_t verify_offset;
447 uint8_t verify_pattern[MAX_PATTERN_SIZE];
448 uint32_t verify_pattern_bytes;
449 uint32_t verify_fatal;
450 uint32_t verify_dump;
451 uint32_t verify_async;
452 uint64_t verify_backlog;
453 uint32_t verify_batch;
454 uint32_t experimental_verify;
455 uint32_t verify_state;
456 uint32_t verify_state_save;
457 uint32_t use_thread;
458 uint32_t unlink;
459 uint32_t unlink_each_loop;
460 uint32_t do_disk_util;
461 uint32_t override_sync;
462 uint32_t rand_repeatable;
463 uint32_t allrand_repeatable;
464 uint32_t pad2;
465 uint64_t rand_seed;
466 uint32_t log_avg_msec;
467 uint32_t log_hist_msec;
468 uint32_t log_hist_coarseness;
469 uint32_t log_max;
470 uint32_t log_offset;
471 uint32_t log_gz;
472 uint32_t log_gz_store;
473 uint32_t log_unix_epoch;
474 uint32_t norandommap;
475 uint32_t softrandommap;
476 uint32_t bs_unaligned;
477 uint32_t fsync_on_close;
478 uint32_t bs_is_seq_rand;
479
480 uint32_t random_distribution;
481 uint32_t exitall_error;
482
483 uint32_t sync_file_range;
484
485 struct zone_split zone_split[DDIR_RWDIR_CNT][ZONESPLIT_MAX];
486 uint32_t zone_split_nr[DDIR_RWDIR_CNT];
487
488 fio_fp64_t zipf_theta;
489 fio_fp64_t pareto_h;
490 fio_fp64_t gauss_dev;
491 fio_fp64_t random_center;
492
493 uint32_t random_generator;
494
495 uint32_t perc_rand[DDIR_RWDIR_CNT];
496
497 uint32_t hugepage_size;
498 uint64_t rw_min_bs;
499 uint32_t thinktime;
500 uint32_t thinktime_spin;
501 uint32_t thinktime_blocks;
502 uint32_t thinktime_blocks_type;
503 uint32_t fsync_blocks;
504 uint32_t fdatasync_blocks;
505 uint32_t barrier_blocks;
506 uint64_t start_delay;
507 uint64_t start_delay_high;
508 uint64_t timeout;
509 uint64_t ramp_time;
510 uint64_t ss_dur;
511 uint64_t ss_ramp_time;
512 uint32_t ss_state;
513 fio_fp64_t ss_limit;
514 uint32_t overwrite;
515 uint32_t bw_avg_time;
516 uint32_t iops_avg_time;
517 uint32_t loops;
518 uint64_t zone_range;
519 uint64_t zone_size;
520 uint64_t zone_capacity;
521 uint64_t zone_skip;
522 uint64_t lockmem;
523 uint32_t zone_skip_nz;
524 uint32_t mem_type;
525 uint32_t mem_align;
526
527 uint32_t exit_what;
528 uint32_t stonewall;
529 uint32_t new_group;
530 uint32_t numjobs;
531
532 /*
533 * We currently can't convert these, so don't enable them
534 */
535#if 0
536 uint8_t cpumask[FIO_TOP_STR_MAX];
537 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
538 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
539#endif
540 uint32_t gpu_dev_id;
541 uint32_t start_offset_percent;
542 uint32_t cpus_allowed_policy;
543 uint32_t iolog;
544 uint32_t rwmixcycle;
545 uint32_t rwmix[DDIR_RWDIR_CNT];
546 uint32_t nice;
547 uint32_t ioprio;
548 uint32_t ioprio_class;
549 uint32_t file_service_type;
550 uint32_t group_reporting;
551 uint32_t stats;
552 uint32_t fadvise_hint;
553 uint32_t fallocate_mode;
554 uint32_t zero_buffers;
555 uint32_t refill_buffers;
556 uint32_t scramble_buffers;
557 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
558 uint32_t buffer_pattern_bytes;
559 uint32_t compress_percentage;
560 uint32_t compress_chunk;
561 uint32_t dedupe_percentage;
562 uint32_t dedupe_mode;
563 uint32_t dedupe_working_set_percentage;
564 uint32_t time_based;
565 uint32_t disable_lat;
566 uint32_t disable_clat;
567 uint32_t disable_slat;
568 uint32_t disable_bw;
569 uint32_t unified_rw_rep;
570 uint32_t gtod_reduce;
571 uint32_t gtod_cpu;
572 uint32_t clocksource;
573 uint32_t no_stall;
574 uint32_t trim_percentage;
575 uint32_t trim_batch;
576 uint32_t trim_zero;
577 uint64_t trim_backlog;
578 uint32_t clat_percentiles;
579 uint32_t lat_percentiles;
580 uint32_t slat_percentiles;
581 uint32_t percentile_precision;
582 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
583
584 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
585 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
586 uint8_t merge_blktrace_file[FIO_TOP_STR_MAX];
587 fio_fp64_t merge_blktrace_scalars[FIO_IO_U_LIST_MAX_LEN];
588 fio_fp64_t merge_blktrace_iters[FIO_IO_U_LIST_MAX_LEN];
589
590 uint32_t write_bw_log;
591 uint32_t write_lat_log;
592 uint32_t write_iops_log;
593 uint32_t write_hist_log;
594
595 uint8_t bw_log_file[FIO_TOP_STR_MAX];
596 uint8_t lat_log_file[FIO_TOP_STR_MAX];
597 uint8_t iops_log_file[FIO_TOP_STR_MAX];
598 uint8_t hist_log_file[FIO_TOP_STR_MAX];
599 uint8_t replay_redirect[FIO_TOP_STR_MAX];
600
601 /*
602 * Pre-run and post-run shell
603 */
604 uint8_t exec_prerun[FIO_TOP_STR_MAX];
605 uint8_t exec_postrun[FIO_TOP_STR_MAX];
606
607 uint64_t rate[DDIR_RWDIR_CNT];
608 uint64_t ratemin[DDIR_RWDIR_CNT];
609 uint32_t ratecycle;
610 uint32_t io_submit_mode;
611 uint32_t rate_iops[DDIR_RWDIR_CNT];
612 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
613 uint32_t rate_process;
614 uint32_t rate_ign_think;
615
616 uint8_t ioscheduler[FIO_TOP_STR_MAX];
617
618 /*
619 * I/O Error handling
620 */
621 uint32_t continue_on_error;
622
623 /*
624 * Benchmark profile type
625 */
626 uint8_t profile[FIO_TOP_STR_MAX];
627
628 /*
629 * blkio cgroup support
630 */
631 uint8_t cgroup[FIO_TOP_STR_MAX];
632 uint32_t cgroup_weight;
633 uint32_t cgroup_nodelete;
634
635 uint32_t uid;
636 uint32_t gid;
637
638 uint32_t offset_increment_percent;
639 uint32_t offset_increment_nz;
640 uint64_t offset_increment;
641 uint64_t number_ios;
642
643 uint64_t latency_target;
644 uint64_t latency_window;
645 uint64_t max_latency[DDIR_RWDIR_CNT];
646 uint32_t pad5;
647 fio_fp64_t latency_percentile;
648 uint32_t latency_run;
649
650 /*
651 * flow support
652 */
653 int32_t flow_id;
654 uint32_t flow;
655 uint32_t flow_sleep;
656
657 uint32_t sig_figs;
658
659 uint32_t block_error_hist;
660
661 uint32_t replay_align;
662 uint32_t replay_scale;
663 uint32_t replay_time_scale;
664 uint32_t replay_skip;
665
666 uint32_t per_job_logs;
667
668 uint32_t allow_create;
669 uint32_t allow_mounted_write;
670
671 uint32_t zone_mode;
672 int32_t max_open_zones;
673 uint32_t ignore_zone_limits;
674} __attribute__((packed));
675
676extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
677extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
678extern int fio_test_cconv(struct thread_options *);
679extern void options_default_fill(struct thread_options *o);
680
681#endif
fio - Flexible IO Tester