a1e32ae7335b0b439518f3e1940235c041158ab1
[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 struct io_sample_offset {
32         struct io_sample s;
33         uint64_t offset;
34 };
35
36 enum {
37         IO_LOG_TYPE_LAT = 1,
38         IO_LOG_TYPE_CLAT,
39         IO_LOG_TYPE_SLAT,
40         IO_LOG_TYPE_BW,
41         IO_LOG_TYPE_IOPS,
42 };
43
44 /*
45  * Dynamically growing data sample log
46  */
47 struct io_log {
48         /*
49          * Entries already logged
50          */
51         uint64_t nr_samples;
52         uint64_t max_samples;
53         void *log;
54
55         unsigned int log_ddir_mask;
56
57         char *filename;
58
59         struct thread_data *td;
60
61         unsigned int log_type;
62
63         /*
64          * If we fail extending the log, stop collecting more entries.
65          */
66         unsigned int disabled;
67
68         /*
69          * Log offsets
70          */
71         unsigned int log_offset;
72
73         /*
74          * Max size of log entries before a chunk is compressed
75          */
76         unsigned int log_gz;
77
78         /*
79          * Don't deflate for storing, just store the compressed bits
80          */
81         unsigned int log_gz_store;
82
83         /*
84          * Windowed average, for logging single entries average over some
85          * period of time.
86          */
87         struct io_stat avg_window[DDIR_RWDIR_CNT];
88         unsigned long avg_msec;
89         unsigned long avg_last;
90
91         pthread_mutex_t chunk_lock;
92         unsigned int chunk_seq;
93         struct flist_head chunk_list;
94 };
95
96 /*
97  * If the upper bit is set, then we have the offset as well
98  */
99 #define LOG_OFFSET_SAMPLE_BIT   0x80000000U
100 #define io_sample_ddir(io)      ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)
101
102 static inline void io_sample_set_ddir(struct io_log *log,
103                                       struct io_sample *io,
104                                       enum fio_ddir ddir)
105 {
106         io->__ddir = ddir | log->log_ddir_mask;
107 }
108
109 static inline size_t __log_entry_sz(int log_offset)
110 {
111         if (log_offset)
112                 return sizeof(struct io_sample_offset);
113         else
114                 return sizeof(struct io_sample);
115 }
116
117 static inline size_t log_entry_sz(struct io_log *log)
118 {
119         return __log_entry_sz(log->log_offset);
120 }
121
122 static inline struct io_sample *__get_sample(void *samples, int log_offset,
123                                              uint64_t sample)
124 {
125         return samples + sample * __log_entry_sz(log_offset);
126 }
127
128 static inline struct io_sample *get_sample(struct io_log *iolog,
129                                            uint64_t sample)
130 {
131         return __get_sample(iolog->log, iolog->log_offset, sample);
132 }
133
134 enum {
135         IP_F_ONRB       = 1,
136         IP_F_ONLIST     = 2,
137         IP_F_TRIMMED    = 4,
138         IP_F_IN_FLIGHT  = 8,
139 };
140
141 /*
142  * When logging io actions, this matches a single sent io_u
143  */
144 struct io_piece {
145         union {
146                 struct rb_node rb_node;
147                 struct flist_head list;
148         };
149         struct flist_head trim_list;
150         union {
151                 int fileno;
152                 struct fio_file *file;
153         };
154         unsigned long long offset;
155         unsigned short numberio;
156         unsigned long len;
157         unsigned int flags;
158         enum fio_ddir ddir;
159         union {
160                 unsigned long delay;
161                 unsigned int file_action;
162         };
163 };
164
165 /*
166  * Log exports
167  */
168 enum file_log_act {
169         FIO_LOG_ADD_FILE,
170         FIO_LOG_OPEN_FILE,
171         FIO_LOG_CLOSE_FILE,
172         FIO_LOG_UNLINK_FILE,
173 };
174
175 struct io_u;
176 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
177 extern void log_io_u(const struct thread_data *, const struct io_u *);
178 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
179 extern int __must_check init_iolog(struct thread_data *td);
180 extern void log_io_piece(struct thread_data *, struct io_u *);
181 extern void unlog_io_piece(struct thread_data *, struct io_u *);
182 extern void trim_io_piece(struct thread_data *, const struct io_u *);
183 extern void queue_io_piece(struct thread_data *, struct io_piece *);
184 extern void prune_io_piece_log(struct thread_data *);
185 extern void write_iolog_close(struct thread_data *);
186
187 #ifdef CONFIG_ZLIB
188 extern int iolog_file_inflate(const char *);
189 #endif
190
191 /*
192  * Logging
193  */
194 struct log_params {
195         struct thread_data *td;
196         unsigned long avg_msec;
197         int log_type;
198         int log_offset;
199         int log_gz;
200         int log_gz_store;
201         int log_compress;
202 };
203
204 extern void finalize_logs(struct thread_data *td);
205 extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
206                                 unsigned int, uint64_t);
207 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
208                                 unsigned int, uint64_t);
209 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
210                                 unsigned int, uint64_t);
211 extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
212                                 struct timeval *);
213 extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
214                                 struct timeval *);
215 extern void init_disk_util(struct thread_data *);
216 extern void update_rusage_stat(struct thread_data *);
217 extern void setup_log(struct io_log **, struct log_params *, const char *);
218 extern void flush_log(struct io_log *);
219 extern void free_log(struct io_log *);
220 extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
221 extern int write_bw_log;
222 extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
223 extern void fio_writeout_logs(struct thread_data *);
224 extern int iolog_flush(struct io_log *, int);
225
226 static inline void init_ipo(struct io_piece *ipo)
227 {
228         memset(ipo, 0, sizeof(*ipo));
229         INIT_FLIST_HEAD(&ipo->trim_list);
230 }
231
232 #endif