iolog: note type of log
[fio.git] / iolog.h
CommitLineData
5995a6a4
JA
1#ifndef FIO_IOLOG_H
2#define FIO_IOLOG_H
3
7fb6d453 4#include "lib/rbtree.h"
c7c6cb4c 5#include "lib/ieee754.h"
802ad4a8 6
5995a6a4
JA
7/*
8 * Use for maintaining statistics
9 */
10struct io_stat {
7b9f733a
JA
11 uint64_t max_val;
12 uint64_t min_val;
13 uint64_t samples;
5995a6a4 14
802ad4a8
JA
15 fio_fp64_t mean;
16 fio_fp64_t S;
5995a6a4
JA
17};
18
19/*
20 * A single data sample
21 */
22struct io_sample {
23 unsigned long time;
24 unsigned long val;
25 enum fio_ddir ddir;
26 unsigned int bs;
27};
28
5a812f9b
JA
29enum {
30 IO_LOG_TYPE_LAT = 1,
31 IO_LOG_TYPE_CLAT,
32 IO_LOG_TYPE_SLAT,
33 IO_LOG_TYPE_BW,
34 IO_LOG_TYPE_IOPS,
35};
36
5995a6a4
JA
37/*
38 * Dynamically growing data sample log
39 */
40struct io_log {
b8bc8cba
JA
41 /*
42 * Entries already logged
43 */
5995a6a4
JA
44 unsigned long nr_samples;
45 unsigned long max_samples;
46 struct io_sample *log;
b8bc8cba 47
5a812f9b
JA
48 int log_type;
49
b8bc8cba
JA
50 /*
51 * Windowed average, for logging single entries average over some
52 * period of time.
53 */
6eaf09d6 54 struct io_stat avg_window[DDIR_RWDIR_CNT];
b8bc8cba
JA
55 unsigned long avg_msec;
56 unsigned long avg_last;
5995a6a4
JA
57};
58
0d29de83
JA
59enum {
60 IP_F_ONRB = 1,
61 IP_F_ONLIST = 2,
62 IP_F_TRIMMED = 4,
63};
64
5995a6a4
JA
65/*
66 * When logging io actions, this matches a single sent io_u
67 */
68struct io_piece {
69 union {
70 struct rb_node rb_node;
71 struct flist_head list;
72 };
0d29de83 73 struct flist_head trim_list;
5995a6a4
JA
74 union {
75 int fileno;
76 struct fio_file *file;
77 };
78 unsigned long long offset;
79 unsigned long len;
a917a8b3 80 unsigned int flags;
5995a6a4
JA
81 enum fio_ddir ddir;
82 union {
83 unsigned long delay;
84 unsigned int file_action;
85 };
86};
87
88/*
89 * Log exports
90 */
91enum file_log_act {
92 FIO_LOG_ADD_FILE,
93 FIO_LOG_OPEN_FILE,
94 FIO_LOG_CLOSE_FILE,
95 FIO_LOG_UNLINK_FILE,
96};
97
8062f527 98struct io_u;
5995a6a4
JA
99extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
100extern void log_io_u(struct thread_data *, struct io_u *);
101extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
102extern int __must_check init_iolog(struct thread_data *td);
103extern void log_io_piece(struct thread_data *, struct io_u *);
104extern void queue_io_piece(struct thread_data *, struct io_piece *);
105extern void prune_io_piece_log(struct thread_data *);
106extern void write_iolog_close(struct thread_data *);
107
108/*
109 * Logging
110 */
02af0988
JA
111extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
112 unsigned int);
5995a6a4
JA
113extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
114 unsigned int);
115extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
116 unsigned int);
117extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
118 struct timeval *);
c8eeb9df 119extern void add_iops_sample(struct thread_data *, enum fio_ddir, struct timeval *);
5995a6a4
JA
120extern void init_disk_util(struct thread_data *);
121extern void update_rusage_stat(struct thread_data *);
5a812f9b 122extern void setup_log(struct io_log **, unsigned long, int);
5995a6a4
JA
123extern void finish_log(struct thread_data *, struct io_log *, const char *);
124extern void finish_log_named(struct thread_data *, struct io_log *, const char *, const char *);
125extern void __finish_log(struct io_log *, const char *);
6eaf09d6 126extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
5995a6a4
JA
127extern int write_bw_log;
128extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
129
0d29de83
JA
130static inline void init_ipo(struct io_piece *ipo)
131{
132 memset(ipo, 0, sizeof(*ipo));
133 INIT_FLIST_HEAD(&ipo->trim_list);
134}
135
5995a6a4 136#endif