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