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