workqueue/rate-submit: update comments
[fio.git] / thread_options.h
CommitLineData
8062f527
JA
1#ifndef FIO_THREAD_OPTIONS_H
2#define FIO_THREAD_OPTIONS_H
3
4#include "arch/arch.h"
5#include "os/os.h"
a8523a6a 6#include "options.h"
8062f527
JA
7#include "stat.h"
8#include "gettime.h"
888677a4 9#include "lib/ieee754.h"
61b9861d 10#include "lib/pattern.h"
3c978125 11#include "td_error.h"
8062f527
JA
12
13/*
14 * What type of allocation to use for io buffers
15 */
16enum fio_memtype {
17 MEM_MALLOC = 0, /* ordinary malloc */
18 MEM_SHM, /* use shared memory segments */
19 MEM_SHMHUGE, /* use shared memory segments with huge pages */
20 MEM_MMAP, /* use anonynomous mmap */
21 MEM_MMAPHUGE, /* memory mapped huge file */
217b0f1d 22 MEM_MMAPSHARED, /* use mmap with shared flag */
8062f527
JA
23};
24
8062f527
JA
25#define ERROR_STR_MAX 128
26
8062f527
JA
27#define BSSPLIT_MAX 64
28
29struct bssplit {
30 uint32_t bs;
31 uint32_t perc;
32};
33
a8523a6a
JA
34#define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
35
cb1402d6
JA
36#define OPT_MAGIC 0x4f50544e
37
8062f527 38struct thread_options {
cb1402d6 39 int magic;
a8523a6a 40 uint64_t set_options[NR_OPTS_SZ];
8062f527
JA
41 char *description;
42 char *name;
43 char *directory;
44 char *filename;
45 char *filename_format;
46 char *opendir;
47 char *ioengine;
83ea422a 48 char *mmapfile;
8062f527
JA
49 enum td_ddir td_ddir;
50 unsigned int rw_seq;
51 unsigned int kb_base;
52 unsigned int unit_base;
53 unsigned int ddir_seq_nr;
c46fda90 54 long long ddir_seq_add;
8062f527
JA
55 unsigned int iodepth;
56 unsigned int iodepth_low;
57 unsigned int iodepth_batch;
82407585
RP
58 unsigned int iodepth_batch_complete_min;
59 unsigned int iodepth_batch_complete_max;
8062f527
JA
60
61 unsigned long long size;
77731b29 62 unsigned long long io_limit;
8062f527
JA
63 unsigned int size_percent;
64 unsigned int fill_device;
bedc9dc2 65 unsigned int file_append;
8062f527
JA
66 unsigned long long file_size_low;
67 unsigned long long file_size_high;
68 unsigned long long start_offset;
69
70 unsigned int bs[DDIR_RWDIR_CNT];
71 unsigned int ba[DDIR_RWDIR_CNT];
72 unsigned int min_bs[DDIR_RWDIR_CNT];
73 unsigned int max_bs[DDIR_RWDIR_CNT];
74 struct bssplit *bssplit[DDIR_RWDIR_CNT];
75 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
76
77 int *ignore_error[ERROR_TYPE_CNT];
78 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
79 unsigned int error_dump;
80
81 unsigned int nr_files;
82 unsigned int open_files;
83 enum file_lock_mode file_lock_mode;
84
85 unsigned int odirect;
d01612f3 86 unsigned int oatomic;
8062f527
JA
87 unsigned int invalidate_cache;
88 unsigned int create_serialize;
89 unsigned int create_fsync;
90 unsigned int create_on_open;
91 unsigned int create_only;
92 unsigned int end_fsync;
93 unsigned int pre_read;
94 unsigned int sync_io;
95 unsigned int verify;
96 unsigned int do_verify;
97 unsigned int verifysort;
98 unsigned int verifysort_nr;
99 unsigned int verify_interval;
100 unsigned int verify_offset;
101 char verify_pattern[MAX_PATTERN_SIZE];
102 unsigned int verify_pattern_bytes;
61b9861d
RP
103 struct pattern_fmt verify_fmt[8];
104 unsigned int verify_fmt_sz;
8062f527
JA
105 unsigned int verify_fatal;
106 unsigned int verify_dump;
107 unsigned int verify_async;
108 unsigned long long verify_backlog;
109 unsigned int verify_batch;
110 unsigned int experimental_verify;
ca09be4b
JA
111 unsigned int verify_state;
112 unsigned int verify_state_save;
8062f527
JA
113 unsigned int use_thread;
114 unsigned int unlink;
115 unsigned int do_disk_util;
116 unsigned int override_sync;
117 unsigned int rand_repeatable;
56e2a5fc 118 unsigned int allrand_repeatable;
363cffa7 119 unsigned long long rand_seed;
54a21917 120 unsigned int dep_use_os_rand;
8062f527 121 unsigned int log_avg_msec;
ae588852 122 unsigned int log_offset;
aee2ab67 123 unsigned int log_gz;
b26317c9 124 unsigned int log_gz_store;
8062f527
JA
125 unsigned int norandommap;
126 unsigned int softrandommap;
127 unsigned int bs_unaligned;
128 unsigned int fsync_on_close;
6aca9b3d 129 unsigned int bs_is_seq_rand;
8062f527 130
62167762
JC
131 unsigned int verify_only;
132
8062f527 133 unsigned int random_distribution;
b7f487cf 134
888677a4
JA
135 fio_fp64_t zipf_theta;
136 fio_fp64_t pareto_h;
f88cd222 137 fio_fp64_t gauss_dev;
8062f527
JA
138
139 unsigned int random_generator;
140
d9472271 141 unsigned int perc_rand[DDIR_RWDIR_CNT];
211c9b89 142
8062f527
JA
143 unsigned int hugepage_size;
144 unsigned int rw_min_bs;
145 unsigned int thinktime;
146 unsigned int thinktime_spin;
147 unsigned int thinktime_blocks;
148 unsigned int fsync_blocks;
149 unsigned int fdatasync_blocks;
150 unsigned int barrier_blocks;
151 unsigned long long start_delay;
23ed19b0 152 unsigned long long start_delay_high;
8062f527
JA
153 unsigned long long timeout;
154 unsigned long long ramp_time;
155 unsigned int overwrite;
156 unsigned int bw_avg_time;
157 unsigned int iops_avg_time;
158 unsigned int loops;
159 unsigned long long zone_range;
160 unsigned long long zone_size;
161 unsigned long long zone_skip;
81c6b6cd 162 unsigned long long lockmem;
8062f527
JA
163 enum fio_memtype mem_type;
164 unsigned int mem_align;
165
166 unsigned int max_latency;
167
168 unsigned int stonewall;
169 unsigned int new_group;
170 unsigned int numjobs;
171 os_cpu_mask_t cpumask;
8062f527 172 os_cpu_mask_t verify_cpumask;
c2acfbac 173 unsigned int cpus_allowed_policy;
43522848 174 char *numa_cpunodes;
8062f527
JA
175 unsigned short numa_mem_mode;
176 unsigned int numa_mem_prefer_node;
43522848 177 char *numa_memnodes;
8062f527
JA
178 unsigned int iolog;
179 unsigned int rwmixcycle;
5054e67c 180 unsigned int rwmix[DDIR_RWDIR_CNT];
8062f527 181 unsigned int nice;
81c6b6cd
JA
182 unsigned int ioprio;
183 unsigned int ioprio_class;
8062f527
JA
184 unsigned int file_service_type;
185 unsigned int group_reporting;
186 unsigned int fadvise_hint;
37659335 187 unsigned int fadvise_stream;
8062f527
JA
188 enum fio_fallocate_mode fallocate_mode;
189 unsigned int zero_buffers;
190 unsigned int refill_buffers;
191 unsigned int scramble_buffers;
ce35b1ec
JA
192 char buffer_pattern[MAX_PATTERN_SIZE];
193 unsigned int buffer_pattern_bytes;
8062f527
JA
194 unsigned int compress_percentage;
195 unsigned int compress_chunk;
5c94b008 196 unsigned int dedupe_percentage;
8062f527
JA
197 unsigned int time_based;
198 unsigned int disable_lat;
199 unsigned int disable_clat;
200 unsigned int disable_slat;
201 unsigned int disable_bw;
202 unsigned int unified_rw_rep;
203 unsigned int gtod_reduce;
204 unsigned int gtod_cpu;
8062f527
JA
205 enum fio_cs clocksource;
206 unsigned int no_stall;
207 unsigned int trim_percentage;
208 unsigned int trim_batch;
209 unsigned int trim_zero;
210 unsigned long long trim_backlog;
211 unsigned int clat_percentiles;
212 unsigned int percentile_precision; /* digits after decimal for percentiles */
213 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
214
215 char *read_iolog_file;
216 char *write_iolog_file;
217 char *bw_log_file;
218 char *lat_log_file;
219 char *iops_log_file;
220 char *replay_redirect;
221
222 /*
223 * Pre-run and post-run shell
224 */
225 char *exec_prerun;
226 char *exec_postrun;
227
228 unsigned int rate[DDIR_RWDIR_CNT];
229 unsigned int ratemin[DDIR_RWDIR_CNT];
230 unsigned int ratecycle;
a9da8ab2 231 unsigned int io_submit_mode;
8062f527
JA
232 unsigned int rate_iops[DDIR_RWDIR_CNT];
233 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
6de65959 234 unsigned int rate_process;
8062f527
JA
235
236 char *ioscheduler;
237
8062f527
JA
238 /*
239 * I/O Error handling
240 */
241 enum error_type continue_on_error;
242
243 /*
244 * Benchmark profile type
245 */
246 char *profile;
247
248 /*
249 * blkio cgroup support
250 */
251 char *cgroup;
252 unsigned int cgroup_weight;
253 unsigned int cgroup_nodelete;
254
255 unsigned int uid;
256 unsigned int gid;
257
258 int flow_id;
259 int flow;
260 int flow_watermark;
261 unsigned int flow_sleep;
262
263 unsigned long long offset_increment;
ddf24e42 264 unsigned long long number_ios;
8062f527
JA
265
266 unsigned int sync_file_range;
3e260a46
JA
267
268 unsigned long long latency_target;
269 unsigned long long latency_window;
270 fio_fp64_t latency_percentile;
66347cfa
DE
271
272 unsigned block_error_hist;
65fa28ca 273 unsigned int skip_bad;
0c63576e
JA
274
275 unsigned int replay_align;
276 unsigned int replay_scale;
3a5db920
JA
277
278 unsigned int per_job_logs;
2378826d
JA
279
280 unsigned int allow_create;
e81ecca3 281 unsigned int allow_mounted_write;
8062f527
JA
282};
283
2dc1cbb5
JA
284#define FIO_TOP_STR_MAX 256
285
286struct thread_options_pack {
a8523a6a 287 uint64_t set_options[NR_OPTS_SZ];
2dc1cbb5
JA
288 uint8_t description[FIO_TOP_STR_MAX];
289 uint8_t name[FIO_TOP_STR_MAX];
290 uint8_t directory[FIO_TOP_STR_MAX];
291 uint8_t filename[FIO_TOP_STR_MAX];
22f80458 292 uint8_t filename_format[FIO_TOP_STR_MAX];
2dc1cbb5
JA
293 uint8_t opendir[FIO_TOP_STR_MAX];
294 uint8_t ioengine[FIO_TOP_STR_MAX];
83ea422a 295 uint8_t mmapfile[FIO_TOP_STR_MAX];
2dc1cbb5
JA
296 uint32_t td_ddir;
297 uint32_t rw_seq;
298 uint32_t kb_base;
22f80458 299 uint32_t unit_base;
2dc1cbb5
JA
300 uint32_t ddir_seq_nr;
301 uint64_t ddir_seq_add;
302 uint32_t iodepth;
303 uint32_t iodepth_low;
304 uint32_t iodepth_batch;
82407585
RP
305 uint32_t iodepth_batch_complete_min;
306 uint32_t iodepth_batch_complete_max;
307 uint32_t __proper_alignment_for_64b;
2dc1cbb5
JA
308
309 uint64_t size;
77731b29 310 uint64_t io_limit;
2dc1cbb5
JA
311 uint32_t size_percent;
312 uint32_t fill_device;
bedc9dc2 313 uint32_t file_append;
2dc1cbb5
JA
314 uint64_t file_size_low;
315 uint64_t file_size_high;
316 uint64_t start_offset;
317
b999b3c7
JA
318 uint32_t bs[DDIR_RWDIR_CNT];
319 uint32_t ba[DDIR_RWDIR_CNT];
320 uint32_t min_bs[DDIR_RWDIR_CNT];
321 uint32_t max_bs[DDIR_RWDIR_CNT];
322 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
323 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
2dc1cbb5 324
e65a950a
JA
325 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
326 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
327 uint32_t error_dump;
328
2dc1cbb5
JA
329 uint32_t nr_files;
330 uint32_t open_files;
331 uint32_t file_lock_mode;
2dc1cbb5
JA
332
333 uint32_t odirect;
d01612f3 334 uint32_t oatomic;
2dc1cbb5
JA
335 uint32_t invalidate_cache;
336 uint32_t create_serialize;
337 uint32_t create_fsync;
338 uint32_t create_on_open;
fb390e24 339 uint32_t create_only;
2dc1cbb5
JA
340 uint32_t end_fsync;
341 uint32_t pre_read;
342 uint32_t sync_io;
343 uint32_t verify;
344 uint32_t do_verify;
345 uint32_t verifysort;
836fcc0f 346 uint32_t verifysort_nr;
2dc1cbb5
JA
347 uint32_t verify_interval;
348 uint32_t verify_offset;
349 uint8_t verify_pattern[MAX_PATTERN_SIZE];
350 uint32_t verify_pattern_bytes;
351 uint32_t verify_fatal;
352 uint32_t verify_dump;
353 uint32_t verify_async;
354 uint64_t verify_backlog;
355 uint32_t verify_batch;
836fcc0f 356 uint32_t experimental_verify;
ca09be4b
JA
357 uint32_t verify_state;
358 uint32_t verify_state_save;
2dc1cbb5
JA
359 uint32_t use_thread;
360 uint32_t unlink;
361 uint32_t do_disk_util;
362 uint32_t override_sync;
363 uint32_t rand_repeatable;
56e2a5fc 364 uint32_t allrand_repeatable;
363cffa7 365 uint64_t rand_seed;
54a21917 366 uint32_t dep_use_os_rand;
2dc1cbb5 367 uint32_t log_avg_msec;
ae588852 368 uint32_t log_offset;
aee2ab67 369 uint32_t log_gz;
b26317c9 370 uint32_t log_gz_store;
2dc1cbb5
JA
371 uint32_t norandommap;
372 uint32_t softrandommap;
373 uint32_t bs_unaligned;
374 uint32_t fsync_on_close;
6aca9b3d 375 uint32_t bs_is_seq_rand;
2dc1cbb5 376
1e5324e7 377 uint32_t random_distribution;
f88cd222
JA
378 uint32_t pad;
379
1e5324e7
JA
380 fio_fp64_t zipf_theta;
381 fio_fp64_t pareto_h;
f88cd222 382 fio_fp64_t gauss_dev;
1e5324e7 383
49758e11
JA
384 uint32_t random_generator;
385
d9472271 386 uint32_t perc_rand[DDIR_RWDIR_CNT];
211c9b89 387
2dc1cbb5
JA
388 uint32_t hugepage_size;
389 uint32_t rw_min_bs;
390 uint32_t thinktime;
391 uint32_t thinktime_spin;
392 uint32_t thinktime_blocks;
393 uint32_t fsync_blocks;
394 uint32_t fdatasync_blocks;
395 uint32_t barrier_blocks;
396 uint64_t start_delay;
23ed19b0 397 uint64_t start_delay_high;
2dc1cbb5
JA
398 uint64_t timeout;
399 uint64_t ramp_time;
400 uint32_t overwrite;
401 uint32_t bw_avg_time;
402 uint32_t iops_avg_time;
403 uint32_t loops;
404 uint64_t zone_range;
405 uint64_t zone_size;
406 uint64_t zone_skip;
ae278f9a 407 uint64_t lockmem;
2dc1cbb5
JA
408 uint32_t mem_type;
409 uint32_t mem_align;
410
1e5324e7
JA
411 uint32_t max_latency;
412
2dc1cbb5
JA
413 uint32_t stonewall;
414 uint32_t new_group;
415 uint32_t numjobs;
416 uint8_t cpumask[FIO_TOP_STR_MAX];
2dc1cbb5 417 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
c2acfbac 418 uint32_t cpus_allowed_policy;
2dc1cbb5
JA
419 uint32_t iolog;
420 uint32_t rwmixcycle;
5054e67c 421 uint32_t rwmix[DDIR_RWDIR_CNT];
2dc1cbb5 422 uint32_t nice;
28727df7
JA
423 uint32_t ioprio;
424 uint32_t ioprio_class;
2dc1cbb5
JA
425 uint32_t file_service_type;
426 uint32_t group_reporting;
427 uint32_t fadvise_hint;
37659335 428 uint32_t fadvise_stream;
2dc1cbb5
JA
429 uint32_t fallocate_mode;
430 uint32_t zero_buffers;
431 uint32_t refill_buffers;
432 uint32_t scramble_buffers;
ce35b1ec
JA
433 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
434 uint32_t buffer_pattern_bytes;
5c94b008
JA
435 uint32_t compress_percentage;
436 uint32_t compress_chunk;
437 uint32_t dedupe_percentage;
2dc1cbb5
JA
438 uint32_t time_based;
439 uint32_t disable_lat;
440 uint32_t disable_clat;
441 uint32_t disable_slat;
442 uint32_t disable_bw;
95820b6e 443 uint32_t unified_rw_rep;
2dc1cbb5
JA
444 uint32_t gtod_reduce;
445 uint32_t gtod_cpu;
2dc1cbb5
JA
446 uint32_t clocksource;
447 uint32_t no_stall;
448 uint32_t trim_percentage;
449 uint32_t trim_batch;
450 uint32_t trim_zero;
451 uint64_t trim_backlog;
452 uint32_t clat_percentiles;
9db01ef9 453 uint32_t percentile_precision;
2dc1cbb5
JA
454 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
455
456 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
457 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
458 uint8_t bw_log_file[FIO_TOP_STR_MAX];
459 uint8_t lat_log_file[FIO_TOP_STR_MAX];
460 uint8_t iops_log_file[FIO_TOP_STR_MAX];
461 uint8_t replay_redirect[FIO_TOP_STR_MAX];
462
463 /*
464 * Pre-run and post-run shell
465 */
466 uint8_t exec_prerun[FIO_TOP_STR_MAX];
467 uint8_t exec_postrun[FIO_TOP_STR_MAX];
468
b999b3c7
JA
469 uint32_t rate[DDIR_RWDIR_CNT];
470 uint32_t ratemin[DDIR_RWDIR_CNT];
2dc1cbb5 471 uint32_t ratecycle;
a9da8ab2 472 uint32_t io_submit_mode;
b999b3c7
JA
473 uint32_t rate_iops[DDIR_RWDIR_CNT];
474 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
6de65959 475 uint32_t rate_process;
ff6bb260 476 uint32_t padding_0; /* for alignment assert */
2dc1cbb5
JA
477
478 uint8_t ioscheduler[FIO_TOP_STR_MAX];
479
2dc1cbb5
JA
480 /*
481 * I/O Error handling
482 */
483 uint32_t continue_on_error;
484
485 /*
486 * Benchmark profile type
487 */
488 uint8_t profile[FIO_TOP_STR_MAX];
489
490 /*
491 * blkio cgroup support
492 */
493 uint8_t cgroup[FIO_TOP_STR_MAX];
494 uint32_t cgroup_weight;
495 uint32_t cgroup_nodelete;
496
497 uint32_t uid;
498 uint32_t gid;
499
500 int32_t flow_id;
501 int32_t flow;
502 int32_t flow_watermark;
503 uint32_t flow_sleep;
504
6a4cf74f 505 uint64_t offset_increment;
ddf24e42 506 uint64_t number_ios;
6a4cf74f 507
2dc1cbb5 508 uint32_t sync_file_range;
3e260a46
JA
509
510 uint64_t latency_target;
511 uint64_t latency_window;
512 fio_fp64_t latency_percentile;
66347cfa
DE
513
514 uint32_t block_error_hist;
65fa28ca 515 uint32_t skip_bad;
0c63576e
JA
516
517 uint32_t replay_align;
518 uint32_t replay_scale;
3a5db920
JA
519
520 uint32_t per_job_logs;
2378826d
JA
521
522 uint32_t allow_create;
e81ecca3 523 uint32_t allow_mounted_write;
2dc1cbb5
JA
524} __attribute__((packed));
525
526extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
527extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
51167799 528extern int fio_test_cconv(struct thread_options *);
588b7f09 529extern void options_default_fill(struct thread_options *o);
2dc1cbb5 530
8062f527 531#endif