Commit | Line | Data |
---|---|---|
5995a6a4 JA |
1 | #ifndef FIO_IOLOG_H |
2 | #define FIO_IOLOG_H | |
3 | ||
05775438 | 4 | #include "lib/rbtree.h" |
c7c6cb4c | 5 | #include "lib/ieee754.h" |
836fcc0f | 6 | #include "flist.h" |
ec41265e | 7 | #include "ioengine.h" |
802ad4a8 | 8 | |
5995a6a4 JA |
9 | /* |
10 | * Use for maintaining statistics | |
11 | */ | |
12 | struct io_stat { | |
7b9f733a JA |
13 | uint64_t max_val; |
14 | uint64_t min_val; | |
15 | uint64_t samples; | |
5995a6a4 | 16 | |
802ad4a8 JA |
17 | fio_fp64_t mean; |
18 | fio_fp64_t S; | |
5995a6a4 JA |
19 | }; |
20 | ||
1e613c9c KC |
21 | struct io_hist { |
22 | uint64_t samples; | |
23 | unsigned long hist_last; | |
24 | }; | |
25 | ||
5995a6a4 JA |
26 | /* |
27 | * A single data sample | |
28 | */ | |
29 | struct io_sample { | |
1b42725f JA |
30 | uint64_t time; |
31 | uint64_t val; | |
b26317c9 | 32 | uint32_t __ddir; |
1b42725f | 33 | uint32_t bs; |
5995a6a4 JA |
34 | }; |
35 | ||
ae588852 JA |
36 | struct io_sample_offset { |
37 | struct io_sample s; | |
38 | uint64_t offset; | |
39 | }; | |
40 | ||
ea51b956 JA |
41 | enum { |
42 | IO_LOG_TYPE_LAT = 1, | |
43 | IO_LOG_TYPE_CLAT, | |
44 | IO_LOG_TYPE_SLAT, | |
45 | IO_LOG_TYPE_BW, | |
46 | IO_LOG_TYPE_IOPS, | |
1e613c9c | 47 | IO_LOG_TYPE_HIST, |
ea51b956 JA |
48 | }; |
49 | ||
6d37f67f | 50 | #define DEF_LOG_ENTRIES 1024 |
7e419452 JA |
51 | #define MAX_LOG_ENTRIES (1024 * DEF_LOG_ENTRIES) |
52 | ||
7e419452 JA |
53 | struct io_logs { |
54 | struct flist_head list; | |
55 | uint64_t nr_samples; | |
56 | uint64_t max_samples; | |
57 | void *log; | |
58 | }; | |
6d37f67f | 59 | |
5995a6a4 JA |
60 | /* |
61 | * Dynamically growing data sample log | |
62 | */ | |
63 | struct io_log { | |
b8bc8cba JA |
64 | /* |
65 | * Entries already logged | |
66 | */ | |
7e419452 JA |
67 | struct flist_head io_logs; |
68 | uint32_t cur_log_max; | |
b8bc8cba | 69 | |
1fed2080 JA |
70 | /* |
71 | * When the current log runs out of space, store events here until | |
72 | * we have a chance to regrow | |
73 | */ | |
74 | struct io_logs *pending; | |
75 | ||
b26317c9 JA |
76 | unsigned int log_ddir_mask; |
77 | ||
cb7e0ace JA |
78 | char *filename; |
79 | ||
aee2ab67 JA |
80 | struct thread_data *td; |
81 | ||
1b42725f | 82 | unsigned int log_type; |
ea51b956 | 83 | |
3c568239 JA |
84 | /* |
85 | * If we fail extending the log, stop collecting more entries. | |
86 | */ | |
7e419452 | 87 | bool disabled; |
3c568239 | 88 | |
ae588852 JA |
89 | /* |
90 | * Log offsets | |
91 | */ | |
92 | unsigned int log_offset; | |
93 | ||
aee2ab67 JA |
94 | /* |
95 | * Max size of log entries before a chunk is compressed | |
96 | */ | |
97 | unsigned int log_gz; | |
98 | ||
b26317c9 JA |
99 | /* |
100 | * Don't deflate for storing, just store the compressed bits | |
101 | */ | |
102 | unsigned int log_gz_store; | |
103 | ||
b8bc8cba JA |
104 | /* |
105 | * Windowed average, for logging single entries average over some | |
106 | * period of time. | |
107 | */ | |
6eaf09d6 | 108 | struct io_stat avg_window[DDIR_RWDIR_CNT]; |
b8bc8cba JA |
109 | unsigned long avg_msec; |
110 | unsigned long avg_last; | |
aee2ab67 | 111 | |
1e613c9c KC |
112 | /* |
113 | * Windowed latency histograms, for keeping track of when we need to | |
114 | * save a copy of the histogram every approximately hist_msec milliseconds. | |
115 | */ | |
116 | struct io_hist hist_window[DDIR_RWDIR_CNT]; | |
117 | unsigned long hist_msec; | |
118 | int hist_coarseness; | |
119 | ||
aee2ab67 JA |
120 | pthread_mutex_t chunk_lock; |
121 | unsigned int chunk_seq; | |
122 | struct flist_head chunk_list; | |
5995a6a4 JA |
123 | }; |
124 | ||
49e98daa JA |
125 | /* |
126 | * If the upper bit is set, then we have the offset as well | |
127 | */ | |
128 | #define LOG_OFFSET_SAMPLE_BIT 0x80000000U | |
129 | #define io_sample_ddir(io) ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT) | |
b26317c9 JA |
130 | |
131 | static inline void io_sample_set_ddir(struct io_log *log, | |
132 | struct io_sample *io, | |
133 | enum fio_ddir ddir) | |
134 | { | |
135 | io->__ddir = ddir | log->log_ddir_mask; | |
136 | } | |
137 | ||
ae588852 JA |
138 | static inline size_t __log_entry_sz(int log_offset) |
139 | { | |
140 | if (log_offset) | |
141 | return sizeof(struct io_sample_offset); | |
142 | else | |
143 | return sizeof(struct io_sample); | |
144 | } | |
145 | ||
146 | static inline size_t log_entry_sz(struct io_log *log) | |
147 | { | |
148 | return __log_entry_sz(log->log_offset); | |
149 | } | |
150 | ||
151 | static inline struct io_sample *__get_sample(void *samples, int log_offset, | |
152 | uint64_t sample) | |
153 | { | |
6f9bbb55 CB |
154 | uint64_t sample_offset = sample * __log_entry_sz(log_offset); |
155 | return (struct io_sample *) ((char *) samples + sample_offset); | |
ae588852 JA |
156 | } |
157 | ||
7e419452 JA |
158 | struct io_logs *iolog_cur_log(struct io_log *); |
159 | uint64_t iolog_nr_samples(struct io_log *); | |
1fed2080 | 160 | void regrow_logs(struct thread_data *); |
7e419452 | 161 | |
ae588852 | 162 | static inline struct io_sample *get_sample(struct io_log *iolog, |
7e419452 | 163 | struct io_logs *cur_log, |
ae588852 JA |
164 | uint64_t sample) |
165 | { | |
7e419452 | 166 | return __get_sample(cur_log->log, iolog->log_offset, sample); |
ae588852 JA |
167 | } |
168 | ||
0d29de83 JA |
169 | enum { |
170 | IP_F_ONRB = 1, | |
171 | IP_F_ONLIST = 2, | |
172 | IP_F_TRIMMED = 4, | |
f9401285 | 173 | IP_F_IN_FLIGHT = 8, |
0d29de83 JA |
174 | }; |
175 | ||
5995a6a4 JA |
176 | /* |
177 | * When logging io actions, this matches a single sent io_u | |
178 | */ | |
179 | struct io_piece { | |
180 | union { | |
181 | struct rb_node rb_node; | |
182 | struct flist_head list; | |
183 | }; | |
0d29de83 | 184 | struct flist_head trim_list; |
5995a6a4 JA |
185 | union { |
186 | int fileno; | |
187 | struct fio_file *file; | |
188 | }; | |
189 | unsigned long long offset; | |
da0a7bd2 | 190 | unsigned short numberio; |
5995a6a4 | 191 | unsigned long len; |
a917a8b3 | 192 | unsigned int flags; |
5995a6a4 JA |
193 | enum fio_ddir ddir; |
194 | union { | |
195 | unsigned long delay; | |
196 | unsigned int file_action; | |
197 | }; | |
198 | }; | |
199 | ||
200 | /* | |
201 | * Log exports | |
202 | */ | |
203 | enum file_log_act { | |
204 | FIO_LOG_ADD_FILE, | |
205 | FIO_LOG_OPEN_FILE, | |
206 | FIO_LOG_CLOSE_FILE, | |
207 | FIO_LOG_UNLINK_FILE, | |
208 | }; | |
209 | ||
8062f527 | 210 | struct io_u; |
5995a6a4 | 211 | extern int __must_check read_iolog_get(struct thread_data *, struct io_u *); |
1f440ece | 212 | extern void log_io_u(const struct thread_data *, const struct io_u *); |
5995a6a4 JA |
213 | extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act); |
214 | extern int __must_check init_iolog(struct thread_data *td); | |
215 | extern void log_io_piece(struct thread_data *, struct io_u *); | |
890b6656 | 216 | extern void unlog_io_piece(struct thread_data *, struct io_u *); |
1f440ece | 217 | extern void trim_io_piece(struct thread_data *, const struct io_u *); |
5995a6a4 JA |
218 | extern void queue_io_piece(struct thread_data *, struct io_piece *); |
219 | extern void prune_io_piece_log(struct thread_data *); | |
220 | extern void write_iolog_close(struct thread_data *); | |
24660963 | 221 | extern int iolog_compress_init(struct thread_data *, struct sk_out *); |
155f2f02 | 222 | extern void iolog_compress_exit(struct thread_data *); |
0cba0f91 | 223 | extern size_t log_chunk_sizes(struct io_log *); |
5995a6a4 | 224 | |
b26317c9 JA |
225 | #ifdef CONFIG_ZLIB |
226 | extern int iolog_file_inflate(const char *); | |
227 | #endif | |
228 | ||
5995a6a4 JA |
229 | /* |
230 | * Logging | |
231 | */ | |
aee2ab67 JA |
232 | struct log_params { |
233 | struct thread_data *td; | |
234 | unsigned long avg_msec; | |
1e613c9c KC |
235 | unsigned long hist_msec; |
236 | int hist_coarseness; | |
aee2ab67 JA |
237 | int log_type; |
238 | int log_offset; | |
239 | int log_gz; | |
b26317c9 | 240 | int log_gz_store; |
aee2ab67 JA |
241 | int log_compress; |
242 | }; | |
243 | ||
a47591e4 JA |
244 | static inline bool per_unit_log(struct io_log *log) |
245 | { | |
246 | return log && !log->avg_msec; | |
247 | } | |
248 | ||
b392f36d JA |
249 | static inline bool inline_log(struct io_log *log) |
250 | { | |
251 | return log->log_type == IO_LOG_TYPE_LAT || | |
252 | log->log_type == IO_LOG_TYPE_CLAT || | |
253 | log->log_type == IO_LOG_TYPE_SLAT; | |
254 | } | |
255 | ||
a47591e4 | 256 | extern void finalize_logs(struct thread_data *td, bool); |
aee2ab67 | 257 | extern void setup_log(struct io_log **, struct log_params *, const char *); |
60a25727 | 258 | extern void flush_log(struct io_log *, bool); |
bead01d7 | 259 | extern void flush_samples(FILE *, void *, uint64_t); |
518dac09 | 260 | extern void free_log(struct io_log *); |
a47591e4 JA |
261 | extern void fio_writeout_logs(bool); |
262 | extern void td_writeout_logs(struct thread_data *, bool); | |
7e419452 | 263 | extern int iolog_cur_flush(struct io_log *, struct io_logs *); |
5995a6a4 | 264 | |
0d29de83 JA |
265 | static inline void init_ipo(struct io_piece *ipo) |
266 | { | |
267 | memset(ipo, 0, sizeof(*ipo)); | |
268 | INIT_FLIST_HEAD(&ipo->trim_list); | |
269 | } | |
270 | ||
0cba0f91 JA |
271 | struct iolog_compress { |
272 | struct flist_head list; | |
273 | void *buf; | |
274 | size_t len; | |
275 | unsigned int seq; | |
276 | }; | |
277 | ||
5995a6a4 | 278 | #endif |