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