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