genfio: Splitting gen_template in 2 parts
[fio.git] / iolog.h
1 #ifndef FIO_IOLOG_H
2 #define FIO_IOLOG_H
3
4 #include "lib/rbtree.h"
5 #include "lib/ieee754.h"
6 #include "flist.h"
7 #include "ioengine.h"
8
9 /*
10  * Use for maintaining statistics
11  */
12 struct io_stat {
13         uint64_t max_val;
14         uint64_t min_val;
15         uint64_t samples;
16
17         fio_fp64_t mean;
18         fio_fp64_t S;
19 };
20
21 /*
22  * A single data sample
23  */
24 struct io_sample {
25         uint64_t time;
26         uint64_t val;
27         uint32_t ddir;
28         uint32_t bs;
29 };
30
31 enum {
32         IO_LOG_TYPE_LAT = 1,
33         IO_LOG_TYPE_CLAT,
34         IO_LOG_TYPE_SLAT,
35         IO_LOG_TYPE_BW,
36         IO_LOG_TYPE_IOPS,
37 };
38
39 /*
40  * Dynamically growing data sample log
41  */
42 struct io_log {
43         /*
44          * Entries already logged
45          */
46         unsigned long nr_samples;
47         unsigned long max_samples;
48         struct io_sample *log;
49
50         unsigned int log_type;
51
52         /*
53          * Windowed average, for logging single entries average over some
54          * period of time.
55          */
56         struct io_stat avg_window[DDIR_RWDIR_CNT];
57         unsigned long avg_msec;
58         unsigned long avg_last;
59 };
60
61 enum {
62         IP_F_ONRB       = 1,
63         IP_F_ONLIST     = 2,
64         IP_F_TRIMMED    = 4,
65 };
66
67 /*
68  * When logging io actions, this matches a single sent io_u
69  */
70 struct io_piece {
71         union {
72                 struct rb_node rb_node;
73                 struct flist_head list;
74         };
75         struct flist_head trim_list;
76         union {
77                 int fileno;
78                 struct fio_file *file;
79         };
80         unsigned long long offset;
81         unsigned long len;
82         unsigned int flags;
83         enum fio_ddir ddir;
84         union {
85                 unsigned long delay;
86                 unsigned int file_action;
87         };
88 };
89
90 /*
91  * Log exports
92  */
93 enum file_log_act {
94         FIO_LOG_ADD_FILE,
95         FIO_LOG_OPEN_FILE,
96         FIO_LOG_CLOSE_FILE,
97         FIO_LOG_UNLINK_FILE,
98 };
99
100 struct io_u;
101 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
102 extern void log_io_u(struct thread_data *, struct io_u *);
103 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
104 extern int __must_check init_iolog(struct thread_data *td);
105 extern void log_io_piece(struct thread_data *, struct io_u *);
106 extern void queue_io_piece(struct thread_data *, struct io_piece *);
107 extern void prune_io_piece_log(struct thread_data *);
108 extern void write_iolog_close(struct thread_data *);
109
110 /*
111  * Logging
112  */
113 extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
114                                 unsigned int);
115 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
116                                 unsigned int);
117 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
118                                 unsigned int);
119 extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
120                                 struct timeval *);
121 extern void add_iops_sample(struct thread_data *, enum fio_ddir, struct timeval *);
122 extern void init_disk_util(struct thread_data *);
123 extern void update_rusage_stat(struct thread_data *);
124 extern void setup_log(struct io_log **, unsigned long, int);
125 extern void finish_log(struct thread_data *, struct io_log *, const char *);
126 extern void finish_log_named(struct thread_data *, struct io_log *, const char *, const char *);
127 extern void __finish_log(struct io_log *, const char *);
128 extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
129 extern int write_bw_log;
130 extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
131
132 static inline void init_ipo(struct io_piece *ipo)
133 {
134         memset(ipo, 0, sizeof(*ipo));
135         INIT_FLIST_HEAD(&ipo->trim_list);
136 }
137
138 #endif