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