blob: eaafaee206d184dbbca87d3db20970ac08a64673 [file] [log] [blame]
Jens Axboe8062f522013-04-10 15:01:42 +02001#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"
Jens Axboe888677a2013-04-10 22:19:46 +02008#include "lib/ieee754.h"
Jens Axboe3c978122013-04-17 19:27:46 +02009#include "td_error.h"
Jens Axboe8062f522013-04-10 15:01:42 +020010
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
Jens Axboe8062f522013-04-10 15:01:42 +020022#define ERROR_STR_MAX 128
23
Jens Axboe8062f522013-04-10 15:01:42 +020024#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;
Jens Axboe83ea4222012-03-28 14:01:46 +020040 char *mmapfile;
Jens Axboe8062f522013-04-10 15:01:42 +020041 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;
75 unsigned int invalidate_cache;
76 unsigned int create_serialize;
77 unsigned int create_fsync;
78 unsigned int create_on_open;
79 unsigned int create_only;
80 unsigned int end_fsync;
81 unsigned int pre_read;
82 unsigned int sync_io;
83 unsigned int verify;
84 unsigned int do_verify;
85 unsigned int verifysort;
86 unsigned int verifysort_nr;
87 unsigned int verify_interval;
88 unsigned int verify_offset;
89 char verify_pattern[MAX_PATTERN_SIZE];
90 unsigned int verify_pattern_bytes;
91 unsigned int verify_fatal;
92 unsigned int verify_dump;
93 unsigned int verify_async;
94 unsigned long long verify_backlog;
95 unsigned int verify_batch;
96 unsigned int experimental_verify;
97 unsigned int use_thread;
98 unsigned int unlink;
99 unsigned int do_disk_util;
100 unsigned int override_sync;
101 unsigned int rand_repeatable;
102 unsigned int use_os_rand;
Jens Axboe8062f522013-04-10 15:01:42 +0200103 unsigned int log_avg_msec;
104 unsigned int norandommap;
105 unsigned int softrandommap;
106 unsigned int bs_unaligned;
107 unsigned int fsync_on_close;
Jens Axboe6aca9b32013-07-25 12:45:26 -0600108 unsigned int bs_is_seq_rand;
Jens Axboe8062f522013-04-10 15:01:42 +0200109
110 unsigned int random_distribution;
Jens Axboeb7f487c2013-04-10 19:50:32 +0200111
Jens Axboe888677a2013-04-10 22:19:46 +0200112 fio_fp64_t zipf_theta;
113 fio_fp64_t pareto_h;
Jens Axboe8062f522013-04-10 15:01:42 +0200114
115 unsigned int random_generator;
116
Jens Axboed9472272013-07-25 10:20:45 -0600117 unsigned int perc_rand[DDIR_RWDIR_CNT];
Jens Axboe211c9b82013-04-26 08:56:17 -0600118
Jens Axboe8062f522013-04-10 15:01:42 +0200119 unsigned int hugepage_size;
120 unsigned int rw_min_bs;
121 unsigned int thinktime;
122 unsigned int thinktime_spin;
123 unsigned int thinktime_blocks;
124 unsigned int fsync_blocks;
125 unsigned int fdatasync_blocks;
126 unsigned int barrier_blocks;
127 unsigned long long start_delay;
128 unsigned long long timeout;
129 unsigned long long ramp_time;
130 unsigned int overwrite;
131 unsigned int bw_avg_time;
132 unsigned int iops_avg_time;
133 unsigned int loops;
134 unsigned long long zone_range;
135 unsigned long long zone_size;
136 unsigned long long zone_skip;
Jens Axboe81c6b6c2013-04-10 19:30:50 +0200137 unsigned long long lockmem;
Jens Axboe8062f522013-04-10 15:01:42 +0200138 enum fio_memtype mem_type;
139 unsigned int mem_align;
140
141 unsigned int max_latency;
142
143 unsigned int stonewall;
144 unsigned int new_group;
145 unsigned int numjobs;
146 os_cpu_mask_t cpumask;
147 unsigned int cpumask_set;
148 os_cpu_mask_t verify_cpumask;
149 unsigned int verify_cpumask_set;
150#ifdef CONFIG_LIBNUMA
151 struct bitmask *numa_cpunodesmask;
152 unsigned int numa_cpumask_set;
153 unsigned short numa_mem_mode;
154 unsigned int numa_mem_prefer_node;
155 struct bitmask *numa_memnodesmask;
156 unsigned int numa_memmask_set;
157#endif
158 unsigned int iolog;
159 unsigned int rwmixcycle;
160 unsigned int rwmix[2];
161 unsigned int nice;
Jens Axboe81c6b6c2013-04-10 19:30:50 +0200162 unsigned int ioprio;
163 unsigned int ioprio_class;
Jens Axboe8062f522013-04-10 15:01:42 +0200164 unsigned int file_service_type;
165 unsigned int group_reporting;
166 unsigned int fadvise_hint;
167 enum fio_fallocate_mode fallocate_mode;
168 unsigned int zero_buffers;
169 unsigned int refill_buffers;
170 unsigned int scramble_buffers;
171 unsigned int compress_percentage;
172 unsigned int compress_chunk;
173 unsigned int time_based;
174 unsigned int disable_lat;
175 unsigned int disable_clat;
176 unsigned int disable_slat;
177 unsigned int disable_bw;
178 unsigned int unified_rw_rep;
179 unsigned int gtod_reduce;
180 unsigned int gtod_cpu;
181 unsigned int gtod_offload;
182 enum fio_cs clocksource;
183 unsigned int no_stall;
184 unsigned int trim_percentage;
185 unsigned int trim_batch;
186 unsigned int trim_zero;
187 unsigned long long trim_backlog;
188 unsigned int clat_percentiles;
189 unsigned int percentile_precision; /* digits after decimal for percentiles */
190 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
191
192 char *read_iolog_file;
193 char *write_iolog_file;
194 char *bw_log_file;
195 char *lat_log_file;
196 char *iops_log_file;
197 char *replay_redirect;
198
199 /*
200 * Pre-run and post-run shell
201 */
202 char *exec_prerun;
203 char *exec_postrun;
204
205 unsigned int rate[DDIR_RWDIR_CNT];
206 unsigned int ratemin[DDIR_RWDIR_CNT];
207 unsigned int ratecycle;
208 unsigned int rate_iops[DDIR_RWDIR_CNT];
209 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
210
211 char *ioscheduler;
212
213 /*
Jens Axboe8062f522013-04-10 15:01:42 +0200214 * I/O Error handling
215 */
216 enum error_type continue_on_error;
217
218 /*
219 * Benchmark profile type
220 */
221 char *profile;
222
223 /*
224 * blkio cgroup support
225 */
226 char *cgroup;
227 unsigned int cgroup_weight;
228 unsigned int cgroup_nodelete;
229
230 unsigned int uid;
231 unsigned int gid;
232
233 int flow_id;
234 int flow;
235 int flow_watermark;
236 unsigned int flow_sleep;
237
238 unsigned long long offset_increment;
239
240 unsigned int sync_file_range;
241};
242
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100243#define FIO_TOP_STR_MAX 256
244
245struct thread_options_pack {
246 uint8_t description[FIO_TOP_STR_MAX];
247 uint8_t name[FIO_TOP_STR_MAX];
248 uint8_t directory[FIO_TOP_STR_MAX];
249 uint8_t filename[FIO_TOP_STR_MAX];
Jens Axboe22f80452013-04-09 20:29:16 +0200250 uint8_t filename_format[FIO_TOP_STR_MAX];
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100251 uint8_t opendir[FIO_TOP_STR_MAX];
252 uint8_t ioengine[FIO_TOP_STR_MAX];
Jens Axboe83ea4222012-03-28 14:01:46 +0200253 uint8_t mmapfile[FIO_TOP_STR_MAX];
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100254 uint32_t td_ddir;
255 uint32_t rw_seq;
256 uint32_t kb_base;
Jens Axboe22f80452013-04-09 20:29:16 +0200257 uint32_t unit_base;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100258 uint32_t ddir_seq_nr;
259 uint64_t ddir_seq_add;
260 uint32_t iodepth;
261 uint32_t iodepth_low;
262 uint32_t iodepth_batch;
263 uint32_t iodepth_batch_complete;
264
265 uint64_t size;
266 uint32_t size_percent;
267 uint32_t fill_device;
268 uint64_t file_size_low;
269 uint64_t file_size_high;
270 uint64_t start_offset;
271
Jens Axboeb999b3c2012-09-24 09:39:49 +0200272 uint32_t bs[DDIR_RWDIR_CNT];
273 uint32_t ba[DDIR_RWDIR_CNT];
274 uint32_t min_bs[DDIR_RWDIR_CNT];
275 uint32_t max_bs[DDIR_RWDIR_CNT];
276 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
277 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100278
Jens Axboee65a9502012-09-24 09:24:04 +0200279 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
280 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
281 uint32_t error_dump;
282
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100283 uint32_t nr_files;
284 uint32_t open_files;
285 uint32_t file_lock_mode;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100286
287 uint32_t odirect;
288 uint32_t invalidate_cache;
289 uint32_t create_serialize;
290 uint32_t create_fsync;
291 uint32_t create_on_open;
Jens Axboefb390e22012-05-07 09:54:41 +0200292 uint32_t create_only;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100293 uint32_t end_fsync;
294 uint32_t pre_read;
295 uint32_t sync_io;
296 uint32_t verify;
297 uint32_t do_verify;
298 uint32_t verifysort;
Jens Axboe836fcc02013-01-24 09:08:45 -0700299 uint32_t verifysort_nr;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100300 uint32_t verify_interval;
301 uint32_t verify_offset;
302 uint8_t verify_pattern[MAX_PATTERN_SIZE];
303 uint32_t verify_pattern_bytes;
304 uint32_t verify_fatal;
305 uint32_t verify_dump;
306 uint32_t verify_async;
307 uint64_t verify_backlog;
308 uint32_t verify_batch;
Jens Axboe836fcc02013-01-24 09:08:45 -0700309 uint32_t experimental_verify;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100310 uint32_t use_thread;
311 uint32_t unlink;
312 uint32_t do_disk_util;
313 uint32_t override_sync;
314 uint32_t rand_repeatable;
315 uint32_t use_os_rand;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100316 uint32_t log_avg_msec;
317 uint32_t norandommap;
318 uint32_t softrandommap;
319 uint32_t bs_unaligned;
320 uint32_t fsync_on_close;
Jens Axboe6aca9b32013-07-25 12:45:26 -0600321 uint32_t bs_is_seq_rand;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100322
Jens Axboe1e5324e2012-11-14 14:25:31 -0700323 uint32_t random_distribution;
324 fio_fp64_t zipf_theta;
325 fio_fp64_t pareto_h;
326
Jens Axboe49758e12012-12-03 14:37:23 +0100327 uint32_t random_generator;
328
Jens Axboed9472272013-07-25 10:20:45 -0600329 uint32_t perc_rand[DDIR_RWDIR_CNT];
Jens Axboe211c9b82013-04-26 08:56:17 -0600330
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100331 uint32_t hugepage_size;
332 uint32_t rw_min_bs;
333 uint32_t thinktime;
334 uint32_t thinktime_spin;
335 uint32_t thinktime_blocks;
336 uint32_t fsync_blocks;
337 uint32_t fdatasync_blocks;
338 uint32_t barrier_blocks;
339 uint64_t start_delay;
340 uint64_t timeout;
341 uint64_t ramp_time;
342 uint32_t overwrite;
343 uint32_t bw_avg_time;
344 uint32_t iops_avg_time;
345 uint32_t loops;
346 uint64_t zone_range;
347 uint64_t zone_size;
348 uint64_t zone_skip;
Jens Axboeae278f92012-03-28 20:52:55 +0200349 uint64_t lockmem;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100350 uint32_t mem_type;
351 uint32_t mem_align;
352
Jens Axboe1e5324e2012-11-14 14:25:31 -0700353 uint32_t max_latency;
354
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100355 uint32_t stonewall;
356 uint32_t new_group;
357 uint32_t numjobs;
358 uint8_t cpumask[FIO_TOP_STR_MAX];
359 uint32_t cpumask_set;
360 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
361 uint32_t verify_cpumask_set;
362 uint32_t iolog;
363 uint32_t rwmixcycle;
364 uint32_t rwmix[2];
365 uint32_t nice;
Jens Axboe28727df2012-03-29 08:33:15 +0200366 uint32_t ioprio;
367 uint32_t ioprio_class;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100368 uint32_t file_service_type;
369 uint32_t group_reporting;
370 uint32_t fadvise_hint;
371 uint32_t fallocate_mode;
372 uint32_t zero_buffers;
373 uint32_t refill_buffers;
374 uint32_t scramble_buffers;
Jens Axboee4769942012-03-13 14:01:11 +0100375 unsigned int compress_percentage;
376 unsigned int compress_chunk;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100377 uint32_t time_based;
378 uint32_t disable_lat;
379 uint32_t disable_clat;
380 uint32_t disable_slat;
381 uint32_t disable_bw;
Jens Axboe95820b62013-01-31 13:23:40 +0100382 uint32_t unified_rw_rep;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100383 uint32_t gtod_reduce;
384 uint32_t gtod_cpu;
385 uint32_t gtod_offload;
386 uint32_t clocksource;
387 uint32_t no_stall;
388 uint32_t trim_percentage;
389 uint32_t trim_batch;
390 uint32_t trim_zero;
391 uint64_t trim_backlog;
392 uint32_t clat_percentiles;
Jens Axboe9db01ef2013-02-07 15:45:39 +0100393 uint32_t percentile_precision;
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100394 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
395
396 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
397 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
398 uint8_t bw_log_file[FIO_TOP_STR_MAX];
399 uint8_t lat_log_file[FIO_TOP_STR_MAX];
400 uint8_t iops_log_file[FIO_TOP_STR_MAX];
401 uint8_t replay_redirect[FIO_TOP_STR_MAX];
402
403 /*
404 * Pre-run and post-run shell
405 */
406 uint8_t exec_prerun[FIO_TOP_STR_MAX];
407 uint8_t exec_postrun[FIO_TOP_STR_MAX];
408
Jens Axboeb999b3c2012-09-24 09:39:49 +0200409 uint32_t rate[DDIR_RWDIR_CNT];
410 uint32_t ratemin[DDIR_RWDIR_CNT];
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100411 uint32_t ratecycle;
Jens Axboeb999b3c2012-09-24 09:39:49 +0200412 uint32_t rate_iops[DDIR_RWDIR_CNT];
413 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100414
415 uint8_t ioscheduler[FIO_TOP_STR_MAX];
416
417 /*
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100418 * I/O Error handling
419 */
420 uint32_t continue_on_error;
421
422 /*
423 * Benchmark profile type
424 */
425 uint8_t profile[FIO_TOP_STR_MAX];
426
427 /*
428 * blkio cgroup support
429 */
430 uint8_t cgroup[FIO_TOP_STR_MAX];
431 uint32_t cgroup_weight;
432 uint32_t cgroup_nodelete;
433
434 uint32_t uid;
435 uint32_t gid;
436
437 int32_t flow_id;
438 int32_t flow;
439 int32_t flow_watermark;
440 uint32_t flow_sleep;
441
Jens Axboe6a4cf742012-03-16 14:02:54 +0100442 uint64_t offset_increment;
443
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100444 uint32_t sync_file_range;
445} __attribute__((packed));
446
447extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
448extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
Jens Axboe51167792012-03-08 21:34:18 +0100449extern int fio_test_cconv(struct thread_options *);
Jens Axboe588b7f02012-03-19 20:37:41 +0100450extern void options_default_fill(struct thread_options *o);
Jens Axboe2dc1cbb2012-03-08 14:52:25 +0100451
Jens Axboe8062f522013-04-10 15:01:42 +0200452#endif