client/server: transparent handling of storing compressed logs
[fio.git] / iolog.h
CommitLineData
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 */
12struct 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
21/*
22 * A single data sample
23 */
24struct io_sample {
1b42725f
JA
25 uint64_t time;
26 uint64_t val;
b26317c9 27 uint32_t __ddir;
1b42725f 28 uint32_t bs;
5995a6a4
JA
29};
30
ae588852
JA
31struct io_sample_offset {
32 struct io_sample s;
33 uint64_t offset;
34};
35
ea51b956
JA
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
5995a6a4
JA
44/*
45 * Dynamically growing data sample log
46 */
47struct io_log {
b8bc8cba
JA
48 /*
49 * Entries already logged
50 */
3c865f32
JA
51 uint64_t nr_samples;
52 uint64_t max_samples;
ae588852 53 void *log;
b8bc8cba 54
b26317c9
JA
55 unsigned int log_ddir_mask;
56
cb7e0ace
JA
57 char *filename;
58
aee2ab67
JA
59 struct thread_data *td;
60
1b42725f 61 unsigned int log_type;
ea51b956 62
3c568239
JA
63 /*
64 * If we fail extending the log, stop collecting more entries.
65 */
66 unsigned int disabled;
67
ae588852
JA
68 /*
69 * Log offsets
70 */
71 unsigned int log_offset;
72
aee2ab67
JA
73 /*
74 * Max size of log entries before a chunk is compressed
75 */
76 unsigned int log_gz;
77
b26317c9
JA
78 /*
79 * Don't deflate for storing, just store the compressed bits
80 */
81 unsigned int log_gz_store;
82
b8bc8cba
JA
83 /*
84 * Windowed average, for logging single entries average over some
85 * period of time.
86 */
6eaf09d6 87 struct io_stat avg_window[DDIR_RWDIR_CNT];
b8bc8cba
JA
88 unsigned long avg_msec;
89 unsigned long avg_last;
aee2ab67
JA
90
91 pthread_mutex_t chunk_lock;
92 unsigned int chunk_seq;
93 struct flist_head chunk_list;
5995a6a4
JA
94};
95
49e98daa
JA
96/*
97 * If the upper bit is set, then we have the offset as well
98 */
99#define LOG_OFFSET_SAMPLE_BIT 0x80000000U
100#define io_sample_ddir(io) ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)
b26317c9
JA
101
102static inline void io_sample_set_ddir(struct io_log *log,
103 struct io_sample *io,
104 enum fio_ddir ddir)
105{
106 io->__ddir = ddir | log->log_ddir_mask;
107}
108
ae588852
JA
109static inline size_t __log_entry_sz(int log_offset)
110{
111 if (log_offset)
112 return sizeof(struct io_sample_offset);
113 else
114 return sizeof(struct io_sample);
115}
116
117static inline size_t log_entry_sz(struct io_log *log)
118{
119 return __log_entry_sz(log->log_offset);
120}
121
122static inline struct io_sample *__get_sample(void *samples, int log_offset,
123 uint64_t sample)
124{
6f9bbb55
CB
125 uint64_t sample_offset = sample * __log_entry_sz(log_offset);
126 return (struct io_sample *) ((char *) samples + sample_offset);
ae588852
JA
127}
128
129static inline struct io_sample *get_sample(struct io_log *iolog,
130 uint64_t sample)
131{
132 return __get_sample(iolog->log, iolog->log_offset, sample);
133}
134
0d29de83
JA
135enum {
136 IP_F_ONRB = 1,
137 IP_F_ONLIST = 2,
138 IP_F_TRIMMED = 4,
f9401285 139 IP_F_IN_FLIGHT = 8,
0d29de83
JA
140};
141
5995a6a4
JA
142/*
143 * When logging io actions, this matches a single sent io_u
144 */
145struct io_piece {
146 union {
147 struct rb_node rb_node;
148 struct flist_head list;
149 };
0d29de83 150 struct flist_head trim_list;
5995a6a4
JA
151 union {
152 int fileno;
153 struct fio_file *file;
154 };
155 unsigned long long offset;
da0a7bd2 156 unsigned short numberio;
5995a6a4 157 unsigned long len;
a917a8b3 158 unsigned int flags;
5995a6a4
JA
159 enum fio_ddir ddir;
160 union {
161 unsigned long delay;
162 unsigned int file_action;
163 };
164};
165
166/*
167 * Log exports
168 */
169enum file_log_act {
170 FIO_LOG_ADD_FILE,
171 FIO_LOG_OPEN_FILE,
172 FIO_LOG_CLOSE_FILE,
173 FIO_LOG_UNLINK_FILE,
174};
175
8062f527 176struct io_u;
5995a6a4 177extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
1f440ece 178extern void log_io_u(const struct thread_data *, const struct io_u *);
5995a6a4
JA
179extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
180extern int __must_check init_iolog(struct thread_data *td);
181extern void log_io_piece(struct thread_data *, struct io_u *);
890b6656 182extern void unlog_io_piece(struct thread_data *, struct io_u *);
1f440ece 183extern void trim_io_piece(struct thread_data *, const struct io_u *);
5995a6a4
JA
184extern void queue_io_piece(struct thread_data *, struct io_piece *);
185extern void prune_io_piece_log(struct thread_data *);
186extern void write_iolog_close(struct thread_data *);
24660963 187extern int iolog_compress_init(struct thread_data *, struct sk_out *);
155f2f02 188extern void iolog_compress_exit(struct thread_data *);
0cba0f91 189extern size_t log_chunk_sizes(struct io_log *);
5995a6a4 190
b26317c9
JA
191#ifdef CONFIG_ZLIB
192extern int iolog_file_inflate(const char *);
193#endif
194
5995a6a4
JA
195/*
196 * Logging
197 */
aee2ab67
JA
198struct log_params {
199 struct thread_data *td;
200 unsigned long avg_msec;
201 int log_type;
202 int log_offset;
203 int log_gz;
b26317c9 204 int log_gz_store;
aee2ab67
JA
205 int log_compress;
206};
207
99007068 208extern void finalize_logs(struct thread_data *td);
aee2ab67 209extern void setup_log(struct io_log **, struct log_params *, const char *);
3a5db920 210extern void flush_log(struct io_log *, int);
bead01d7 211extern void flush_samples(FILE *, void *, uint64_t);
518dac09 212extern void free_log(struct io_log *);
905e3d4f 213extern void fio_writeout_logs(struct thread_data *);
aee2ab67 214extern int iolog_flush(struct io_log *, int);
5995a6a4 215
0d29de83
JA
216static inline void init_ipo(struct io_piece *ipo)
217{
218 memset(ipo, 0, sizeof(*ipo));
219 INIT_FLIST_HEAD(&ipo->trim_list);
220}
221
0cba0f91
JA
222struct iolog_compress {
223 struct flist_head list;
224 void *buf;
225 size_t len;
226 unsigned int seq;
227};
228
5995a6a4 229#endif