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