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