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