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