init: fix dead check for !td
[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 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#define io_sample_ddir(io) ((io)->__ddir & ~0x80000000U)
97
98static inline void io_sample_set_ddir(struct io_log *log,
99 struct io_sample *io,
100 enum fio_ddir ddir)
101{
102 io->__ddir = ddir | log->log_ddir_mask;
103}
104
105static inline size_t __log_entry_sz(int log_offset)
106{
107 if (log_offset)
108 return sizeof(struct io_sample_offset);
109 else
110 return sizeof(struct io_sample);
111}
112
113static inline size_t log_entry_sz(struct io_log *log)
114{
115 return __log_entry_sz(log->log_offset);
116}
117
118static inline struct io_sample *__get_sample(void *samples, int log_offset,
119 uint64_t sample)
120{
121 return samples + sample * __log_entry_sz(log_offset);
122}
123
124static inline struct io_sample *get_sample(struct io_log *iolog,
125 uint64_t sample)
126{
127 return __get_sample(iolog->log, iolog->log_offset, sample);
128}
129
130enum {
131 IP_F_ONRB = 1,
132 IP_F_ONLIST = 2,
133 IP_F_TRIMMED = 4,
134 IP_F_IN_FLIGHT = 8,
135};
136
137/*
138 * When logging io actions, this matches a single sent io_u
139 */
140struct io_piece {
141 union {
142 struct rb_node rb_node;
143 struct flist_head list;
144 };
145 struct flist_head trim_list;
146 union {
147 int fileno;
148 struct fio_file *file;
149 };
150 unsigned long long offset;
151 unsigned short numberio;
152 unsigned long len;
153 unsigned int flags;
154 enum fio_ddir ddir;
155 union {
156 unsigned long delay;
157 unsigned int file_action;
158 };
159};
160
161/*
162 * Log exports
163 */
164enum file_log_act {
165 FIO_LOG_ADD_FILE,
166 FIO_LOG_OPEN_FILE,
167 FIO_LOG_CLOSE_FILE,
168 FIO_LOG_UNLINK_FILE,
169};
170
171struct io_u;
172extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
173extern void log_io_u(struct thread_data *, struct io_u *);
174extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
175extern int __must_check init_iolog(struct thread_data *td);
176extern void log_io_piece(struct thread_data *, struct io_u *);
177extern void unlog_io_piece(struct thread_data *, struct io_u *);
178extern void trim_io_piece(struct thread_data *, struct io_u *);
179extern void queue_io_piece(struct thread_data *, struct io_piece *);
180extern void prune_io_piece_log(struct thread_data *);
181extern void write_iolog_close(struct thread_data *);
182
183#ifdef CONFIG_ZLIB
184extern int iolog_file_inflate(const char *);
185#endif
186
187/*
188 * Logging
189 */
190struct log_params {
191 struct thread_data *td;
192 unsigned long avg_msec;
193 int log_type;
194 int log_offset;
195 int log_gz;
196 int log_gz_store;
197 int log_compress;
198};
199
200extern void finalize_logs(struct thread_data *td);
201extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
202 unsigned int, uint64_t);
203extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
204 unsigned int, uint64_t);
205extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
206 unsigned int, uint64_t);
207extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
208 struct timeval *);
209extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
210 struct timeval *);
211extern void init_disk_util(struct thread_data *);
212extern void update_rusage_stat(struct thread_data *);
213extern void setup_log(struct io_log **, struct log_params *, const char *);
214extern void flush_log(struct io_log *);
215extern void free_log(struct io_log *);
216extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
217extern int write_bw_log;
218extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
219extern void fio_writeout_logs(struct thread_data *);
220extern int iolog_flush(struct io_log *, int);
221
222static inline void init_ipo(struct io_piece *ipo)
223{
224 memset(ipo, 0, sizeof(*ipo));
225 INIT_FLIST_HEAD(&ipo->trim_list);
226}
227
228#endif