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