log: fix use-after-free
[fio.git] / iolog.h
... / ...
CommitLineData
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 */
12struct 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 */
24struct io_sample {
25 uint64_t time;
26 uint64_t val;
27 uint32_t ddir;
28 uint32_t bs;
29};
30
31struct io_sample_offset {
32 struct io_sample s;
33 uint64_t offset;
34};
35
36enum {
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 */
47struct io_log {
48 /*
49 * Entries already logged
50 */
51 uint64_t nr_samples;
52 uint64_t max_samples;
53 void *log;
54
55 char *filename;
56
57 unsigned int log_type;
58
59 /*
60 * If we fail extending the log, stop collecting more entries.
61 */
62 unsigned int disabled;
63
64 /*
65 * Log offsets
66 */
67 unsigned int log_offset;
68
69 /*
70 * Windowed average, for logging single entries average over some
71 * period of time.
72 */
73 struct io_stat avg_window[DDIR_RWDIR_CNT];
74 unsigned long avg_msec;
75 unsigned long avg_last;
76};
77
78static inline size_t __log_entry_sz(int log_offset)
79{
80 if (log_offset)
81 return sizeof(struct io_sample_offset);
82 else
83 return sizeof(struct io_sample);
84}
85
86static inline size_t log_entry_sz(struct io_log *log)
87{
88 return __log_entry_sz(log->log_offset);
89}
90
91static inline struct io_sample *__get_sample(void *samples, int log_offset,
92 uint64_t sample)
93{
94 return samples + sample * __log_entry_sz(log_offset);
95}
96
97static inline struct io_sample *get_sample(struct io_log *iolog,
98 uint64_t sample)
99{
100 return __get_sample(iolog->log, iolog->log_offset, sample);
101}
102
103enum {
104 IP_F_ONRB = 1,
105 IP_F_ONLIST = 2,
106 IP_F_TRIMMED = 4,
107 IP_F_IN_FLIGHT = 8,
108};
109
110/*
111 * When logging io actions, this matches a single sent io_u
112 */
113struct io_piece {
114 union {
115 struct rb_node rb_node;
116 struct flist_head list;
117 };
118 struct flist_head trim_list;
119 union {
120 int fileno;
121 struct fio_file *file;
122 };
123 unsigned long long offset;
124 unsigned short numberio;
125 unsigned long len;
126 unsigned int flags;
127 enum fio_ddir ddir;
128 union {
129 unsigned long delay;
130 unsigned int file_action;
131 };
132};
133
134/*
135 * Log exports
136 */
137enum file_log_act {
138 FIO_LOG_ADD_FILE,
139 FIO_LOG_OPEN_FILE,
140 FIO_LOG_CLOSE_FILE,
141 FIO_LOG_UNLINK_FILE,
142};
143
144struct io_u;
145extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
146extern void log_io_u(struct thread_data *, struct io_u *);
147extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
148extern int __must_check init_iolog(struct thread_data *td);
149extern void log_io_piece(struct thread_data *, struct io_u *);
150extern void unlog_io_piece(struct thread_data *, struct io_u *);
151extern void trim_io_piece(struct thread_data *, struct io_u *);
152extern void queue_io_piece(struct thread_data *, struct io_piece *);
153extern void prune_io_piece_log(struct thread_data *);
154extern void write_iolog_close(struct thread_data *);
155
156/*
157 * Logging
158 */
159extern void finalize_logs(struct thread_data *td);
160extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
161 unsigned int, uint64_t);
162extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
163 unsigned int, uint64_t);
164extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
165 unsigned int, uint64_t);
166extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
167 struct timeval *);
168extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
169 struct timeval *);
170extern void init_disk_util(struct thread_data *);
171extern void update_rusage_stat(struct thread_data *);
172extern void setup_log(struct io_log **, unsigned long, int, int, const char *);
173extern void __finish_log(struct io_log *);
174extern void free_log(struct io_log *);
175extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
176extern int write_bw_log;
177extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
178extern void fio_writeout_logs(struct thread_data *);
179
180static inline void init_ipo(struct io_piece *ipo)
181{
182 memset(ipo, 0, sizeof(*ipo));
183 INIT_FLIST_HEAD(&ipo->trim_list);
184}
185
186#endif