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