Commit | Line | Data |
---|---|---|
5995a6a4 JA |
1 | #ifndef FIO_IOLOG_H |
2 | #define FIO_IOLOG_H | |
3 | ||
3d2d14bc SW |
4 | #include <stdio.h> |
5 | ||
05775438 | 6 | #include "lib/rbtree.h" |
c7c6cb4c | 7 | #include "lib/ieee754.h" |
836fcc0f | 8 | #include "flist.h" |
618ee94c | 9 | #include "ioengines.h" |
802ad4a8 | 10 | |
5995a6a4 JA |
11 | /* |
12 | * Use for maintaining statistics | |
13 | */ | |
14 | struct io_stat { | |
7b9f733a JA |
15 | uint64_t max_val; |
16 | uint64_t min_val; | |
17 | uint64_t samples; | |
5995a6a4 | 18 | |
802ad4a8 JA |
19 | fio_fp64_t mean; |
20 | fio_fp64_t S; | |
5995a6a4 JA |
21 | }; |
22 | ||
1e613c9c KC |
23 | struct io_hist { |
24 | uint64_t samples; | |
25 | unsigned long hist_last; | |
d730bc58 | 26 | struct flist_head list; |
1e613c9c KC |
27 | }; |
28 | ||
af2fde19 SW |
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 | ||
5995a6a4 JA |
38 | /* |
39 | * A single data sample | |
40 | */ | |
41 | struct io_sample { | |
1b42725f | 42 | uint64_t time; |
af2fde19 | 43 | union io_sample_data data; |
b26317c9 | 44 | uint32_t __ddir; |
03ec570f | 45 | uint16_t priority; |
5fff9543 | 46 | uint64_t bs; |
5995a6a4 JA |
47 | }; |
48 | ||
ae588852 JA |
49 | struct io_sample_offset { |
50 | struct io_sample s; | |
51 | uint64_t offset; | |
52 | }; | |
53 | ||
ea51b956 JA |
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, | |
1e613c9c | 60 | IO_LOG_TYPE_HIST, |
ea51b956 JA |
61 | }; |
62 | ||
6d37f67f | 63 | #define DEF_LOG_ENTRIES 1024 |
7e419452 JA |
64 | #define MAX_LOG_ENTRIES (1024 * DEF_LOG_ENTRIES) |
65 | ||
7e419452 JA |
66 | struct io_logs { |
67 | struct flist_head list; | |
68 | uint64_t nr_samples; | |
69 | uint64_t max_samples; | |
70 | void *log; | |
71 | }; | |
6d37f67f | 72 | |
5995a6a4 JA |
73 | /* |
74 | * Dynamically growing data sample log | |
75 | */ | |
76 | struct io_log { | |
b8bc8cba JA |
77 | /* |
78 | * Entries already logged | |
79 | */ | |
7e419452 JA |
80 | struct flist_head io_logs; |
81 | uint32_t cur_log_max; | |
b8bc8cba | 82 | |
1fed2080 JA |
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 | ||
b26317c9 JA |
89 | unsigned int log_ddir_mask; |
90 | ||
cb7e0ace JA |
91 | char *filename; |
92 | ||
aee2ab67 JA |
93 | struct thread_data *td; |
94 | ||
1b42725f | 95 | unsigned int log_type; |
ea51b956 | 96 | |
3c568239 JA |
97 | /* |
98 | * If we fail extending the log, stop collecting more entries. | |
99 | */ | |
7e419452 | 100 | bool disabled; |
3c568239 | 101 | |
ae588852 JA |
102 | /* |
103 | * Log offsets | |
104 | */ | |
105 | unsigned int log_offset; | |
106 | ||
03ec570f DLM |
107 | /* |
108 | * Log I/O priorities | |
109 | */ | |
110 | unsigned int log_prio; | |
111 | ||
aee2ab67 JA |
112 | /* |
113 | * Max size of log entries before a chunk is compressed | |
114 | */ | |
115 | unsigned int log_gz; | |
116 | ||
b26317c9 JA |
117 | /* |
118 | * Don't deflate for storing, just store the compressed bits | |
119 | */ | |
120 | unsigned int log_gz_store; | |
121 | ||
b8bc8cba JA |
122 | /* |
123 | * Windowed average, for logging single entries average over some | |
124 | * period of time. | |
125 | */ | |
6eaf09d6 | 126 | struct io_stat avg_window[DDIR_RWDIR_CNT]; |
b8bc8cba | 127 | unsigned long avg_msec; |
8355119b | 128 | unsigned long avg_last[DDIR_RWDIR_CNT]; |
aee2ab67 | 129 | |
8aa89d70 JA |
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 | */ | |
1e613c9c KC |
135 | struct io_hist hist_window[DDIR_RWDIR_CNT]; |
136 | unsigned long hist_msec; | |
868f6f03 | 137 | unsigned int hist_coarseness; |
1e613c9c | 138 | |
aee2ab67 JA |
139 | pthread_mutex_t chunk_lock; |
140 | unsigned int chunk_seq; | |
141 | struct flist_head chunk_list; | |
858bce70 JA |
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; | |
5995a6a4 JA |
147 | }; |
148 | ||
49e98daa JA |
149 | /* |
150 | * If the upper bit is set, then we have the offset as well | |
151 | */ | |
152 | #define LOG_OFFSET_SAMPLE_BIT 0x80000000U | |
03ec570f DLM |
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) | |
b26317c9 JA |
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 | ||
ae588852 JA |
168 | static inline size_t __log_entry_sz(int log_offset) |
169 | { | |
170 | if (log_offset) | |
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 | ||
868f6f03 KC |
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 | ||
ae588852 JA |
186 | static inline struct io_sample *__get_sample(void *samples, int log_offset, |
187 | uint64_t sample) | |
188 | { | |
6f9bbb55 CB |
189 | uint64_t sample_offset = sample * __log_entry_sz(log_offset); |
190 | return (struct io_sample *) ((char *) samples + sample_offset); | |
ae588852 JA |
191 | } |
192 | ||
7e419452 JA |
193 | struct io_logs *iolog_cur_log(struct io_log *); |
194 | uint64_t iolog_nr_samples(struct io_log *); | |
1fed2080 | 195 | void regrow_logs(struct thread_data *); |
76204de3 | 196 | void regrow_agg_logs(void); |
7e419452 | 197 | |
ae588852 | 198 | static inline struct io_sample *get_sample(struct io_log *iolog, |
7e419452 | 199 | struct io_logs *cur_log, |
ae588852 JA |
200 | uint64_t sample) |
201 | { | |
7e419452 | 202 | return __get_sample(cur_log->log, iolog->log_offset, sample); |
ae588852 JA |
203 | } |
204 | ||
0d29de83 JA |
205 | enum { |
206 | IP_F_ONRB = 1, | |
207 | IP_F_ONLIST = 2, | |
208 | IP_F_TRIMMED = 4, | |
f9401285 | 209 | IP_F_IN_FLIGHT = 8, |
0d29de83 JA |
210 | }; |
211 | ||
5995a6a4 JA |
212 | /* |
213 | * When logging io actions, this matches a single sent io_u | |
214 | */ | |
215 | struct io_piece { | |
216 | union { | |
e96c0125 | 217 | struct fio_rb_node rb_node; |
5995a6a4 JA |
218 | struct flist_head list; |
219 | }; | |
0d29de83 | 220 | struct flist_head trim_list; |
5995a6a4 JA |
221 | union { |
222 | int fileno; | |
223 | struct fio_file *file; | |
224 | }; | |
225 | unsigned long long offset; | |
da0a7bd2 | 226 | unsigned short numberio; |
5995a6a4 | 227 | unsigned long len; |
a917a8b3 | 228 | unsigned int flags; |
5995a6a4 | 229 | enum fio_ddir ddir; |
315bbf01 MG |
230 | unsigned long delay; |
231 | unsigned int file_action; | |
5995a6a4 JA |
232 | }; |
233 | ||
234 | /* | |
235 | * Log exports | |
236 | */ | |
237 | enum file_log_act { | |
238 | FIO_LOG_ADD_FILE, | |
239 | FIO_LOG_OPEN_FILE, | |
240 | FIO_LOG_CLOSE_FILE, | |
241 | FIO_LOG_UNLINK_FILE, | |
242 | }; | |
243 | ||
8062f527 | 244 | struct io_u; |
5995a6a4 | 245 | extern int __must_check read_iolog_get(struct thread_data *, struct io_u *); |
1f440ece | 246 | extern void log_io_u(const struct thread_data *, const struct io_u *); |
5995a6a4 | 247 | extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act); |
b153f94a | 248 | extern bool __must_check init_iolog(struct thread_data *td); |
5995a6a4 | 249 | extern void log_io_piece(struct thread_data *, struct io_u *); |
890b6656 | 250 | extern void unlog_io_piece(struct thread_data *, struct io_u *); |
94a78d52 | 251 | extern void trim_io_piece(const struct io_u *); |
5995a6a4 JA |
252 | extern void queue_io_piece(struct thread_data *, struct io_piece *); |
253 | extern void prune_io_piece_log(struct thread_data *); | |
254 | extern void write_iolog_close(struct thread_data *); | |
a21ed2b5 | 255 | int64_t iolog_items_to_fetch(struct thread_data *td); |
24660963 | 256 | extern int iolog_compress_init(struct thread_data *, struct sk_out *); |
155f2f02 | 257 | extern void iolog_compress_exit(struct thread_data *); |
0cba0f91 | 258 | extern size_t log_chunk_sizes(struct io_log *); |
71e6e5a2 | 259 | extern int init_io_u_buffers(struct thread_data *); |
315bbf01 MG |
260 | extern unsigned long long delay_since_ttime(const struct thread_data *, |
261 | unsigned long long); | |
5995a6a4 | 262 | |
b26317c9 JA |
263 | #ifdef CONFIG_ZLIB |
264 | extern int iolog_file_inflate(const char *); | |
265 | #endif | |
266 | ||
5995a6a4 JA |
267 | /* |
268 | * Logging | |
269 | */ | |
aee2ab67 JA |
270 | struct log_params { |
271 | struct thread_data *td; | |
272 | unsigned long avg_msec; | |
1e613c9c KC |
273 | unsigned long hist_msec; |
274 | int hist_coarseness; | |
aee2ab67 JA |
275 | int log_type; |
276 | int log_offset; | |
03ec570f | 277 | int log_prio; |
aee2ab67 | 278 | int log_gz; |
b26317c9 | 279 | int log_gz_store; |
aee2ab67 JA |
280 | int log_compress; |
281 | }; | |
282 | ||
a47591e4 JA |
283 | static inline bool per_unit_log(struct io_log *log) |
284 | { | |
83636545 | 285 | return log && (!log->avg_msec || log->log_gz || log->log_gz_store); |
a47591e4 JA |
286 | } |
287 | ||
b392f36d JA |
288 | static inline bool inline_log(struct io_log *log) |
289 | { | |
290 | return log->log_type == IO_LOG_TYPE_LAT || | |
291 | log->log_type == IO_LOG_TYPE_CLAT || | |
292 | log->log_type == IO_LOG_TYPE_SLAT; | |
293 | } | |
294 | ||
a79f17bf SW |
295 | static inline void ipo_bytes_align(unsigned int replay_align, struct io_piece *ipo) |
296 | { | |
3dd2e8aa | 297 | if (!replay_align) |
a79f17bf SW |
298 | return; |
299 | ||
300 | ipo->offset &= ~(replay_align - (uint64_t)1); | |
301 | } | |
302 | ||
a47591e4 | 303 | extern void finalize_logs(struct thread_data *td, bool); |
aee2ab67 | 304 | extern void setup_log(struct io_log **, struct log_params *, const char *); |
60a25727 | 305 | extern void flush_log(struct io_log *, bool); |
bead01d7 | 306 | extern void flush_samples(FILE *, void *, uint64_t); |
6cc0e5aa | 307 | extern uint64_t hist_sum(int, int, uint64_t *, uint64_t *); |
518dac09 | 308 | extern void free_log(struct io_log *); |
a47591e4 JA |
309 | extern void fio_writeout_logs(bool); |
310 | extern void td_writeout_logs(struct thread_data *, bool); | |
7e419452 | 311 | extern int iolog_cur_flush(struct io_log *, struct io_logs *); |
5995a6a4 | 312 | |
0d29de83 JA |
313 | static inline void init_ipo(struct io_piece *ipo) |
314 | { | |
8812d7f2 | 315 | INIT_FLIST_HEAD(&ipo->list); |
0d29de83 JA |
316 | INIT_FLIST_HEAD(&ipo->trim_list); |
317 | } | |
318 | ||
0cba0f91 JA |
319 | struct iolog_compress { |
320 | struct flist_head list; | |
321 | void *buf; | |
322 | size_t len; | |
323 | unsigned int seq; | |
324 | }; | |
325 | ||
5995a6a4 | 326 | #endif |