1 #ifndef FIO_IOLOG_H
2 #define FIO_IOLOG_H
3
4 #include <stdio.h>
5
6 #include "lib/rbtree.h"
7 #include "lib/ieee754.h"
8 #include "flist.h"
9 #include "ioengines.h"
10
11 /*
12 * Use for maintaining statistics
13 */
14 struct io_stat {
15 uint64_t max_val;
16 uint64_t min_val;
17 uint64_t samples;
18
19 fio_fp64_t mean;
20 fio_fp64_t S;
21 };
22
23 struct io_hist {
24 uint64_t samples;
25 unsigned long hist_last;
26 struct flist_head list;
27 };
28
29
30 union io_sample_data {
31 uint64_t val;
32 struct io_u_plat_entry *plat_entry;
33 };
34
35 #define sample_val(value) ((union io_sample_data) { .val = value })
36 #define sample_plat(plat) ((union io_sample_data) { .plat_entry = plat })
37
38 /*
39 * A single data sample
40 */
41 struct io_sample {
42 uint64_t time;
43 union io_sample_data data;
44 uint32_t __ddir;
_mm_empty(void)45 uint16_t priority;
46 uint64_t bs;
47 };
48
49 struct io_sample_offset {
50 struct io_sample s;
51 uint64_t offset;
52 };
53
54 enum {
55 IO_LOG_TYPE_LAT = 1,
56 IO_LOG_TYPE_CLAT,
57 IO_LOG_TYPE_SLAT,
58 IO_LOG_TYPE_BW,
59 IO_LOG_TYPE_IOPS,
60 IO_LOG_TYPE_HIST,
61 };
_mm_cvtsi32_si64(int __i)62
63 #define DEF_LOG_ENTRIES 1024
64 #define MAX_LOG_ENTRIES (1024 * DEF_LOG_ENTRIES)
65
66 struct io_logs {
67 struct flist_head list;
68 uint64_t nr_samples;
69 uint64_t max_samples;
70 void *log;
71 };
72
73 /*
74 * Dynamically growing data sample log
75 */
76 struct io_log {
77 /*
78 * Entries already logged
_mm_cvtsi64_si32(__m64 __m)79 */
80 struct flist_head io_logs;
81 uint32_t cur_log_max;
82
83 /*
84 * When the current log runs out of space, store events here until
85 * we have a chance to regrow
86 */
87 struct io_logs *pending;
88
89 unsigned int log_ddir_mask;
90
91 char *filename;
92
93 struct thread_data *td;
94
_mm_cvtsi64_m64(long long __i)95 unsigned int log_type;
96
97 /*
98 * If we fail extending the log, stop collecting more entries.
99 */
100 bool disabled;
101
102 /*
103 * Log offsets
104 */
105 unsigned int log_offset;
106
107 /*
108 * Log I/O priorities
109 */
110 unsigned int log_prio;
_mm_cvtm64_si64(__m64 __m)111
112 /*
113 * Max size of log entries before a chunk is compressed
114 */
115 unsigned int log_gz;
116
117 /*
118 * Don't deflate for storing, just store the compressed bits
119 */
120 unsigned int log_gz_store;
121
122 /*
123 * Windowed average, for logging single entries average over some
124 * period of time.
125 */
126 struct io_stat avg_window[DDIR_RWDIR_CNT];
127 unsigned long avg_msec;
128 unsigned long avg_last[DDIR_RWDIR_CNT];
129
130 /*
131 * Windowed latency histograms, for keeping track of when we need to
132 * save a copy of the histogram every approximately hist_msec
133 * milliseconds.
134 */
135 struct io_hist hist_window[DDIR_RWDIR_CNT];
136 unsigned long hist_msec;
137 unsigned int hist_coarseness;
138
139 pthread_mutex_t chunk_lock;
140 unsigned int chunk_seq;
_mm_packs_pi16(__m64 __m1,__m64 __m2)141 struct flist_head chunk_list;
142
143 pthread_mutex_t deferred_free_lock;
144 #define IOLOG_MAX_DEFER 8
145 void *deferred_items[IOLOG_MAX_DEFER];
146 unsigned int deferred;
147 };
148
149 /*
150 * If the upper bit is set, then we have the offset as well
151 */
152 #define LOG_OFFSET_SAMPLE_BIT 0x80000000U
153 /*
154 * If the bit following the upper bit is set, then we have the priority
155 */
156 #define LOG_PRIO_SAMPLE_BIT 0x40000000U
157
158 #define LOG_SAMPLE_BITS (LOG_OFFSET_SAMPLE_BIT | LOG_PRIO_SAMPLE_BIT)
159 #define io_sample_ddir(io) ((io)->__ddir & ~LOG_SAMPLE_BITS)
160
161 static inline void io_sample_set_ddir(struct io_log *log,
162 struct io_sample *io,
163 enum fio_ddir ddir)
164 {
165 io->__ddir = ddir | log->log_ddir_mask;
166 }
167
168 static inline size_t __log_entry_sz(int log_offset)
169 {
170 if (log_offset)
_mm_packs_pi32(__m64 __m1,__m64 __m2)171 return sizeof(struct io_sample_offset);
172 else
173 return sizeof(struct io_sample);
174 }
175
176 static inline size_t log_entry_sz(struct io_log *log)
177 {
178 return __log_entry_sz(log->log_offset);
179 }
180
181 static inline size_t log_sample_sz(struct io_log *log, struct io_logs *cur_log)
182 {
183 return cur_log->nr_samples * log_entry_sz(log);
184 }
185
186 static inline struct io_sample *__get_sample(void *samples, int log_offset,
187 uint64_t sample)
188 {
189 uint64_t sample_offset = sample * __log_entry_sz(log_offset);
190 return (struct io_sample *) ((char *) samples + sample_offset);
191 }
192
193 struct io_logs *iolog_cur_log(struct io_log *);
194 uint64_t iolog_nr_samples(struct io_log *);
195 void regrow_logs(struct thread_data *);
196 void regrow_agg_logs(void);
197
198 static inline struct io_sample *get_sample(struct io_log *iolog,
199 struct io_logs *cur_log,
200 uint64_t sample)
_mm_packs_pu16(__m64 __m1,__m64 __m2)201 {
202 return __get_sample(cur_log->log, iolog->log_offset, sample);
203 }
204
205 enum {
206 IP_F_ONRB = 1,
207 IP_F_ONLIST = 2,
208 IP_F_TRIMMED = 4,
209 IP_F_IN_FLIGHT = 8,
210 };
211
212 /*
213 * When logging io actions, this matches a single sent io_u
214 */
215 struct io_piece {
216 union {
217 struct fio_rb_node rb_node;
218 struct flist_head list;
219 };
220 struct flist_head trim_list;
221 union {
222 int fileno;
223 struct fio_file *file;
224 };
225 unsigned long long offset;
226 unsigned short numberio;
227 unsigned long len;
_mm_unpackhi_pi8(__m64 __m1,__m64 __m2)228 unsigned int flags;
229 enum fio_ddir ddir;
230 union {
231 unsigned long delay;
232 unsigned int file_action;
233 };
234 };
235
236 /*
237 * Log exports
238 */
239 enum file_log_act {
240 FIO_LOG_ADD_FILE,
241 FIO_LOG_OPEN_FILE,
242 FIO_LOG_CLOSE_FILE,
243 FIO_LOG_UNLINK_FILE,
244 };
245
246 struct io_u;
247 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
248 extern void log_io_u(const struct thread_data *, const struct io_u *);
249 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
250 extern bool __must_check init_iolog(struct thread_data *td);
_mm_unpackhi_pi16(__m64 __m1,__m64 __m2)251 extern void log_io_piece(struct thread_data *, struct io_u *);
252 extern void unlog_io_piece(struct thread_data *, struct io_u *);
253 extern void trim_io_piece(const struct io_u *);
254 extern void queue_io_piece(struct thread_data *, struct io_piece *);
255 extern void prune_io_piece_log(struct thread_data *);
256 extern void write_iolog_close(struct thread_data *);
257 extern int iolog_compress_init(struct thread_data *, struct sk_out *);
258 extern void iolog_compress_exit(struct thread_data *);
259 extern size_t log_chunk_sizes(struct io_log *);
260 extern int init_io_u_buffers(struct thread_data *);
261
262 #ifdef CONFIG_ZLIB
263 extern int iolog_file_inflate(const char *);
264 #endif
265
266 /*
267 * Logging
268 */
269 struct log_params {
270 struct thread_data *td;
271 unsigned long avg_msec;
_mm_unpackhi_pi32(__m64 __m1,__m64 __m2)272 unsigned long hist_msec;
273 int hist_coarseness;
274 int log_type;
275 int log_offset;
276 int log_prio;
277 int log_gz;
278 int log_gz_store;
279 int log_compress;
280 };
281
282 static inline bool per_unit_log(struct io_log *log)
283 {
284 return log && (!log->avg_msec || log->log_gz || log->log_gz_store);
285 }
286
287 static inline bool inline_log(struct io_log *log)
288 {
289 return log->log_type == IO_LOG_TYPE_LAT ||
290 log->log_type == IO_LOG_TYPE_CLAT ||
291 log->log_type == IO_LOG_TYPE_SLAT;
292 }
293
294 static inline void ipo_bytes_align(unsigned int replay_align, struct io_piece *ipo)
295 {
296 if (!replay_align)
297 return;
298
_mm_unpacklo_pi8(__m64 __m1,__m64 __m2)299 ipo->offset &= ~(replay_align - (uint64_t)1);
300 }
301
302 extern void finalize_logs(struct thread_data *td, bool);
303 extern void setup_log(struct io_log **, struct log_params *, const char *);
304 extern void flush_log(struct io_log *, bool);
305 extern void flush_samples(FILE *, void *, uint64_t);
306 extern uint64_t hist_sum(int, int, uint64_t *, uint64_t *);
307 extern void free_log(struct io_log *);
308 extern void fio_writeout_logs(bool);
309 extern void td_writeout_logs(struct thread_data *, bool);
310 extern int iolog_cur_flush(struct io_log *, struct io_logs *);
311
312 static inline void init_ipo(struct io_piece *ipo)
313 {
314 INIT_FLIST_HEAD(&ipo->list);
315 INIT_FLIST_HEAD(&ipo->trim_list);
316 }
317
318 struct iolog_compress {
319 struct flist_head list;
320 void *buf;
321 size_t len;
_mm_unpacklo_pi16(__m64 __m1,__m64 __m2)322 unsigned int seq;
323 };
324
325 #endif
326