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