server: comments, and clear sk_out->sk when we close the 'sk'
[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"
a8523a6a 6#include "options.h"
8062f527
JA
7#include "stat.h"
8#include "gettime.h"
888677a4 9#include "lib/ieee754.h"
61b9861d 10#include "lib/pattern.h"
3c978125 11#include "td_error.h"
8062f527
JA
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 */
217b0f1d 22 MEM_MMAPSHARED, /* use mmap with shared flag */
8062f527
JA
23};
24
8062f527
JA
25#define ERROR_STR_MAX 128
26
8062f527
JA
27#define BSSPLIT_MAX 64
28
29struct bssplit {
30 uint32_t bs;
31 uint32_t perc;
32};
33
a8523a6a
JA
34#define NR_OPTS_SZ (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
35
cb1402d6
JA
36#define OPT_MAGIC 0x4f50544e
37
8062f527 38struct thread_options {
cb1402d6 39 int magic;
a8523a6a 40 uint64_t set_options[NR_OPTS_SZ];
8062f527
JA
41 char *description;
42 char *name;
43 char *directory;
44 char *filename;
45 char *filename_format;
46 char *opendir;
47 char *ioengine;
83ea422a 48 char *mmapfile;
8062f527
JA
49 enum td_ddir td_ddir;
50 unsigned int rw_seq;
51 unsigned int kb_base;
52 unsigned int unit_base;
53 unsigned int ddir_seq_nr;
c46fda90 54 long long ddir_seq_add;
8062f527
JA
55 unsigned int iodepth;
56 unsigned int iodepth_low;
57 unsigned int iodepth_batch;
82407585
RP
58 unsigned int iodepth_batch_complete_min;
59 unsigned int iodepth_batch_complete_max;
8062f527
JA
60
61 unsigned long long size;
77731b29 62 unsigned long long io_limit;
8062f527
JA
63 unsigned int size_percent;
64 unsigned int fill_device;
bedc9dc2 65 unsigned int file_append;
8062f527
JA
66 unsigned long long file_size_low;
67 unsigned long long file_size_high;
68 unsigned long long start_offset;
69
70 unsigned int bs[DDIR_RWDIR_CNT];
71 unsigned int ba[DDIR_RWDIR_CNT];
72 unsigned int min_bs[DDIR_RWDIR_CNT];
73 unsigned int max_bs[DDIR_RWDIR_CNT];
74 struct bssplit *bssplit[DDIR_RWDIR_CNT];
75 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
76
77 int *ignore_error[ERROR_TYPE_CNT];
78 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
79 unsigned int error_dump;
80
81 unsigned int nr_files;
82 unsigned int open_files;
83 enum file_lock_mode file_lock_mode;
84
85 unsigned int odirect;
d01612f3 86 unsigned int oatomic;
8062f527
JA
87 unsigned int invalidate_cache;
88 unsigned int create_serialize;
89 unsigned int create_fsync;
90 unsigned int create_on_open;
91 unsigned int create_only;
92 unsigned int end_fsync;
93 unsigned int pre_read;
94 unsigned int sync_io;
95 unsigned int verify;
96 unsigned int do_verify;
97 unsigned int verifysort;
98 unsigned int verifysort_nr;
99 unsigned int verify_interval;
100 unsigned int verify_offset;
101 char verify_pattern[MAX_PATTERN_SIZE];
102 unsigned int verify_pattern_bytes;
61b9861d
RP
103 struct pattern_fmt verify_fmt[8];
104 unsigned int verify_fmt_sz;
8062f527
JA
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;
110 unsigned int experimental_verify;
ca09be4b
JA
111 unsigned int verify_state;
112 unsigned int verify_state_save;
8062f527
JA
113 unsigned int use_thread;
114 unsigned int unlink;
115 unsigned int do_disk_util;
116 unsigned int override_sync;
117 unsigned int rand_repeatable;
56e2a5fc 118 unsigned int allrand_repeatable;
363cffa7 119 unsigned long long rand_seed;
54a21917 120 unsigned int dep_use_os_rand;
8062f527 121 unsigned int log_avg_msec;
ae588852 122 unsigned int log_offset;
aee2ab67 123 unsigned int log_gz;
b26317c9 124 unsigned int log_gz_store;
8062f527
JA
125 unsigned int norandommap;
126 unsigned int softrandommap;
127 unsigned int bs_unaligned;
128 unsigned int fsync_on_close;
6aca9b3d 129 unsigned int bs_is_seq_rand;
8062f527 130
62167762
JC
131 unsigned int verify_only;
132
8062f527 133 unsigned int random_distribution;
f9cafb12 134 unsigned int exitall_error;
b7f487cf 135
888677a4
JA
136 fio_fp64_t zipf_theta;
137 fio_fp64_t pareto_h;
f88cd222 138 fio_fp64_t gauss_dev;
8062f527
JA
139
140 unsigned int random_generator;
141
d9472271 142 unsigned int perc_rand[DDIR_RWDIR_CNT];
211c9b89 143
8062f527
JA
144 unsigned int hugepage_size;
145 unsigned int rw_min_bs;
146 unsigned int thinktime;
147 unsigned int thinktime_spin;
148 unsigned int thinktime_blocks;
149 unsigned int fsync_blocks;
150 unsigned int fdatasync_blocks;
151 unsigned int barrier_blocks;
152 unsigned long long start_delay;
23ed19b0 153 unsigned long long start_delay_high;
8062f527
JA
154 unsigned long long timeout;
155 unsigned long long ramp_time;
156 unsigned int overwrite;
157 unsigned int bw_avg_time;
158 unsigned int iops_avg_time;
159 unsigned int loops;
160 unsigned long long zone_range;
161 unsigned long long zone_size;
162 unsigned long long zone_skip;
81c6b6cd 163 unsigned long long lockmem;
8062f527
JA
164 enum fio_memtype mem_type;
165 unsigned int mem_align;
166
167 unsigned int max_latency;
168
169 unsigned int stonewall;
170 unsigned int new_group;
171 unsigned int numjobs;
172 os_cpu_mask_t cpumask;
8062f527 173 os_cpu_mask_t verify_cpumask;
c08f9fe2 174 os_cpu_mask_t log_gz_cpumask;
c2acfbac 175 unsigned int cpus_allowed_policy;
43522848 176 char *numa_cpunodes;
8062f527
JA
177 unsigned short numa_mem_mode;
178 unsigned int numa_mem_prefer_node;
43522848 179 char *numa_memnodes;
8062f527
JA
180 unsigned int iolog;
181 unsigned int rwmixcycle;
5054e67c 182 unsigned int rwmix[DDIR_RWDIR_CNT];
8062f527 183 unsigned int nice;
81c6b6cd
JA
184 unsigned int ioprio;
185 unsigned int ioprio_class;
8062f527
JA
186 unsigned int file_service_type;
187 unsigned int group_reporting;
188 unsigned int fadvise_hint;
37659335 189 unsigned int fadvise_stream;
8062f527
JA
190 enum fio_fallocate_mode fallocate_mode;
191 unsigned int zero_buffers;
192 unsigned int refill_buffers;
193 unsigned int scramble_buffers;
ce35b1ec
JA
194 char buffer_pattern[MAX_PATTERN_SIZE];
195 unsigned int buffer_pattern_bytes;
8062f527
JA
196 unsigned int compress_percentage;
197 unsigned int compress_chunk;
5c94b008 198 unsigned int dedupe_percentage;
8062f527
JA
199 unsigned int time_based;
200 unsigned int disable_lat;
201 unsigned int disable_clat;
202 unsigned int disable_slat;
203 unsigned int disable_bw;
204 unsigned int unified_rw_rep;
205 unsigned int gtod_reduce;
206 unsigned int gtod_cpu;
8062f527
JA
207 enum fio_cs clocksource;
208 unsigned int no_stall;
209 unsigned int trim_percentage;
210 unsigned int trim_batch;
211 unsigned int trim_zero;
212 unsigned long long trim_backlog;
213 unsigned int clat_percentiles;
214 unsigned int percentile_precision; /* digits after decimal for percentiles */
215 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
216
217 char *read_iolog_file;
218 char *write_iolog_file;
219 char *bw_log_file;
220 char *lat_log_file;
221 char *iops_log_file;
222 char *replay_redirect;
223
224 /*
225 * Pre-run and post-run shell
226 */
227 char *exec_prerun;
228 char *exec_postrun;
229
230 unsigned int rate[DDIR_RWDIR_CNT];
231 unsigned int ratemin[DDIR_RWDIR_CNT];
232 unsigned int ratecycle;
a9da8ab2 233 unsigned int io_submit_mode;
8062f527
JA
234 unsigned int rate_iops[DDIR_RWDIR_CNT];
235 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
6de65959 236 unsigned int rate_process;
8062f527
JA
237
238 char *ioscheduler;
239
8062f527
JA
240 /*
241 * I/O Error handling
242 */
243 enum error_type continue_on_error;
244
245 /*
246 * Benchmark profile type
247 */
248 char *profile;
249
250 /*
251 * blkio cgroup support
252 */
253 char *cgroup;
254 unsigned int cgroup_weight;
255 unsigned int cgroup_nodelete;
256
257 unsigned int uid;
258 unsigned int gid;
259
260 int flow_id;
261 int flow;
262 int flow_watermark;
263 unsigned int flow_sleep;
264
265 unsigned long long offset_increment;
ddf24e42 266 unsigned long long number_ios;
8062f527
JA
267
268 unsigned int sync_file_range;
3e260a46
JA
269
270 unsigned long long latency_target;
271 unsigned long long latency_window;
272 fio_fp64_t latency_percentile;
66347cfa
DE
273
274 unsigned block_error_hist;
65fa28ca 275 unsigned int skip_bad;
0c63576e
JA
276
277 unsigned int replay_align;
278 unsigned int replay_scale;
3a5db920
JA
279
280 unsigned int per_job_logs;
2378826d
JA
281
282 unsigned int allow_create;
e81ecca3 283 unsigned int allow_mounted_write;
8062f527
JA
284};
285
2dc1cbb5
JA
286#define FIO_TOP_STR_MAX 256
287
288struct thread_options_pack {
a8523a6a 289 uint64_t set_options[NR_OPTS_SZ];
2dc1cbb5
JA
290 uint8_t description[FIO_TOP_STR_MAX];
291 uint8_t name[FIO_TOP_STR_MAX];
292 uint8_t directory[FIO_TOP_STR_MAX];
293 uint8_t filename[FIO_TOP_STR_MAX];
22f80458 294 uint8_t filename_format[FIO_TOP_STR_MAX];
2dc1cbb5
JA
295 uint8_t opendir[FIO_TOP_STR_MAX];
296 uint8_t ioengine[FIO_TOP_STR_MAX];
83ea422a 297 uint8_t mmapfile[FIO_TOP_STR_MAX];
2dc1cbb5
JA
298 uint32_t td_ddir;
299 uint32_t rw_seq;
300 uint32_t kb_base;
22f80458 301 uint32_t unit_base;
2dc1cbb5
JA
302 uint32_t ddir_seq_nr;
303 uint64_t ddir_seq_add;
304 uint32_t iodepth;
305 uint32_t iodepth_low;
306 uint32_t iodepth_batch;
82407585
RP
307 uint32_t iodepth_batch_complete_min;
308 uint32_t iodepth_batch_complete_max;
309 uint32_t __proper_alignment_for_64b;
2dc1cbb5
JA
310
311 uint64_t size;
77731b29 312 uint64_t io_limit;
2dc1cbb5
JA
313 uint32_t size_percent;
314 uint32_t fill_device;
bedc9dc2 315 uint32_t file_append;
2dc1cbb5
JA
316 uint64_t file_size_low;
317 uint64_t file_size_high;
318 uint64_t start_offset;
319
b999b3c7
JA
320 uint32_t bs[DDIR_RWDIR_CNT];
321 uint32_t ba[DDIR_RWDIR_CNT];
322 uint32_t min_bs[DDIR_RWDIR_CNT];
323 uint32_t max_bs[DDIR_RWDIR_CNT];
324 struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
325 uint32_t bssplit_nr[DDIR_RWDIR_CNT];
2dc1cbb5 326
e65a950a
JA
327 uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
328 uint32_t ignore_error_nr[ERROR_TYPE_CNT];
329 uint32_t error_dump;
330
2dc1cbb5
JA
331 uint32_t nr_files;
332 uint32_t open_files;
333 uint32_t file_lock_mode;
2dc1cbb5
JA
334
335 uint32_t odirect;
d01612f3 336 uint32_t oatomic;
2dc1cbb5
JA
337 uint32_t invalidate_cache;
338 uint32_t create_serialize;
339 uint32_t create_fsync;
340 uint32_t create_on_open;
fb390e24 341 uint32_t create_only;
2dc1cbb5
JA
342 uint32_t end_fsync;
343 uint32_t pre_read;
344 uint32_t sync_io;
345 uint32_t verify;
346 uint32_t do_verify;
347 uint32_t verifysort;
836fcc0f 348 uint32_t verifysort_nr;
2dc1cbb5
JA
349 uint32_t verify_interval;
350 uint32_t verify_offset;
351 uint8_t verify_pattern[MAX_PATTERN_SIZE];
352 uint32_t verify_pattern_bytes;
353 uint32_t verify_fatal;
354 uint32_t verify_dump;
355 uint32_t verify_async;
356 uint64_t verify_backlog;
357 uint32_t verify_batch;
836fcc0f 358 uint32_t experimental_verify;
ca09be4b
JA
359 uint32_t verify_state;
360 uint32_t verify_state_save;
2dc1cbb5
JA
361 uint32_t use_thread;
362 uint32_t unlink;
363 uint32_t do_disk_util;
364 uint32_t override_sync;
365 uint32_t rand_repeatable;
56e2a5fc 366 uint32_t allrand_repeatable;
363cffa7 367 uint64_t rand_seed;
54a21917 368 uint32_t dep_use_os_rand;
2dc1cbb5 369 uint32_t log_avg_msec;
ae588852 370 uint32_t log_offset;
aee2ab67 371 uint32_t log_gz;
b26317c9 372 uint32_t log_gz_store;
2dc1cbb5
JA
373 uint32_t norandommap;
374 uint32_t softrandommap;
375 uint32_t bs_unaligned;
376 uint32_t fsync_on_close;
6aca9b3d 377 uint32_t bs_is_seq_rand;
2dc1cbb5 378
1e5324e7 379 uint32_t random_distribution;
f9cafb12 380 uint32_t exitall_error;
f88cd222 381
1e5324e7
JA
382 fio_fp64_t zipf_theta;
383 fio_fp64_t pareto_h;
f88cd222 384 fio_fp64_t gauss_dev;
1e5324e7 385
49758e11
JA
386 uint32_t random_generator;
387
d9472271 388 uint32_t perc_rand[DDIR_RWDIR_CNT];
211c9b89 389
2dc1cbb5
JA
390 uint32_t hugepage_size;
391 uint32_t rw_min_bs;
392 uint32_t thinktime;
393 uint32_t thinktime_spin;
394 uint32_t thinktime_blocks;
395 uint32_t fsync_blocks;
396 uint32_t fdatasync_blocks;
397 uint32_t barrier_blocks;
398 uint64_t start_delay;
23ed19b0 399 uint64_t start_delay_high;
2dc1cbb5
JA
400 uint64_t timeout;
401 uint64_t ramp_time;
402 uint32_t overwrite;
403 uint32_t bw_avg_time;
404 uint32_t iops_avg_time;
405 uint32_t loops;
406 uint64_t zone_range;
407 uint64_t zone_size;
408 uint64_t zone_skip;
ae278f9a 409 uint64_t lockmem;
2dc1cbb5
JA
410 uint32_t mem_type;
411 uint32_t mem_align;
412
1e5324e7
JA
413 uint32_t max_latency;
414
2dc1cbb5
JA
415 uint32_t stonewall;
416 uint32_t new_group;
417 uint32_t numjobs;
57535f41
JA
418 /*
419 * We currently can't convert these, so don't enable them
420 */
421#if 0
2dc1cbb5 422 uint8_t cpumask[FIO_TOP_STR_MAX];
2dc1cbb5 423 uint8_t verify_cpumask[FIO_TOP_STR_MAX];
c08f9fe2 424 uint8_t log_gz_cpumask[FIO_TOP_STR_MAX];
57535f41 425#endif
c2acfbac 426 uint32_t cpus_allowed_policy;
2dc1cbb5
JA
427 uint32_t iolog;
428 uint32_t rwmixcycle;
5054e67c 429 uint32_t rwmix[DDIR_RWDIR_CNT];
2dc1cbb5 430 uint32_t nice;
28727df7
JA
431 uint32_t ioprio;
432 uint32_t ioprio_class;
2dc1cbb5
JA
433 uint32_t file_service_type;
434 uint32_t group_reporting;
435 uint32_t fadvise_hint;
37659335 436 uint32_t fadvise_stream;
2dc1cbb5
JA
437 uint32_t fallocate_mode;
438 uint32_t zero_buffers;
439 uint32_t refill_buffers;
440 uint32_t scramble_buffers;
ce35b1ec
JA
441 uint8_t buffer_pattern[MAX_PATTERN_SIZE];
442 uint32_t buffer_pattern_bytes;
5c94b008
JA
443 uint32_t compress_percentage;
444 uint32_t compress_chunk;
445 uint32_t dedupe_percentage;
2dc1cbb5
JA
446 uint32_t time_based;
447 uint32_t disable_lat;
448 uint32_t disable_clat;
449 uint32_t disable_slat;
450 uint32_t disable_bw;
95820b6e 451 uint32_t unified_rw_rep;
2dc1cbb5
JA
452 uint32_t gtod_reduce;
453 uint32_t gtod_cpu;
2dc1cbb5
JA
454 uint32_t clocksource;
455 uint32_t no_stall;
456 uint32_t trim_percentage;
457 uint32_t trim_batch;
458 uint32_t trim_zero;
459 uint64_t trim_backlog;
460 uint32_t clat_percentiles;
9db01ef9 461 uint32_t percentile_precision;
2dc1cbb5
JA
462 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
463
464 uint8_t read_iolog_file[FIO_TOP_STR_MAX];
465 uint8_t write_iolog_file[FIO_TOP_STR_MAX];
466 uint8_t bw_log_file[FIO_TOP_STR_MAX];
467 uint8_t lat_log_file[FIO_TOP_STR_MAX];
468 uint8_t iops_log_file[FIO_TOP_STR_MAX];
469 uint8_t replay_redirect[FIO_TOP_STR_MAX];
470
471 /*
472 * Pre-run and post-run shell
473 */
474 uint8_t exec_prerun[FIO_TOP_STR_MAX];
475 uint8_t exec_postrun[FIO_TOP_STR_MAX];
476
b999b3c7
JA
477 uint32_t rate[DDIR_RWDIR_CNT];
478 uint32_t ratemin[DDIR_RWDIR_CNT];
2dc1cbb5 479 uint32_t ratecycle;
a9da8ab2 480 uint32_t io_submit_mode;
b999b3c7
JA
481 uint32_t rate_iops[DDIR_RWDIR_CNT];
482 uint32_t rate_iops_min[DDIR_RWDIR_CNT];
6de65959 483 uint32_t rate_process;
ff6bb260 484 uint32_t padding_0; /* for alignment assert */
2dc1cbb5
JA
485
486 uint8_t ioscheduler[FIO_TOP_STR_MAX];
487
2dc1cbb5
JA
488 /*
489 * I/O Error handling
490 */
491 uint32_t continue_on_error;
492
493 /*
494 * Benchmark profile type
495 */
496 uint8_t profile[FIO_TOP_STR_MAX];
497
498 /*
499 * blkio cgroup support
500 */
501 uint8_t cgroup[FIO_TOP_STR_MAX];
502 uint32_t cgroup_weight;
503 uint32_t cgroup_nodelete;
504
505 uint32_t uid;
506 uint32_t gid;
507
508 int32_t flow_id;
509 int32_t flow;
510 int32_t flow_watermark;
511 uint32_t flow_sleep;
512
6a4cf74f 513 uint64_t offset_increment;
ddf24e42 514 uint64_t number_ios;
6a4cf74f 515
2dc1cbb5 516 uint32_t sync_file_range;
3e260a46
JA
517
518 uint64_t latency_target;
519 uint64_t latency_window;
520 fio_fp64_t latency_percentile;
66347cfa
DE
521
522 uint32_t block_error_hist;
65fa28ca 523 uint32_t skip_bad;
0c63576e
JA
524
525 uint32_t replay_align;
526 uint32_t replay_scale;
3a5db920
JA
527
528 uint32_t per_job_logs;
2378826d
JA
529
530 uint32_t allow_create;
e81ecca3 531 uint32_t allow_mounted_write;
2dc1cbb5
JA
532} __attribute__((packed));
533
534extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
535extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
51167799 536extern int fio_test_cconv(struct thread_options *);
588b7f09 537extern void options_default_fill(struct thread_options *o);
2dc1cbb5 538
8062f527 539#endif