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