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