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