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