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