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