[fio.git] / iolog.h

#ifndef FIO_IOLOG_H
#define FIO_IOLOG_H

#include <stdio.h>

#include "lib/rbtree.h"
#include "lib/ieee754.h"
#include "flist.h"
#include "ioengines.h"

/*
 * Use for maintaining statistics
 */
struct io_stat {
	uint64_t max_val;
	uint64_t min_val;
	uint64_t samples;

	fio_fp64_t mean;
	fio_fp64_t S;
};

struct io_hist {
	uint64_t samples;
	unsigned long hist_last;
	struct flist_head list;
};


union io_sample_data {
	uint64_t val;
	struct io_u_plat_entry *plat_entry;
};

#define sample_val(value) ((union io_sample_data) { .val = value })
#define sample_plat(plat) ((union io_sample_data) { .plat_entry = plat })

/*
 * A single data sample
 */
struct io_sample {
	uint64_t time;
	union io_sample_data data;
	uint32_t __ddir;
	uint8_t priority_bit;
	uint64_t bs;
};

struct io_sample_offset {
	struct io_sample s;
	uint64_t offset;
};

enum {
	IO_LOG_TYPE_LAT = 1,
	IO_LOG_TYPE_CLAT,
	IO_LOG_TYPE_SLAT,
	IO_LOG_TYPE_BW,
	IO_LOG_TYPE_IOPS,
	IO_LOG_TYPE_HIST,
};

#define DEF_LOG_ENTRIES		1024
#define MAX_LOG_ENTRIES		(1024 * DEF_LOG_ENTRIES)

struct io_logs {
	struct flist_head list;
	uint64_t nr_samples;
	uint64_t max_samples;
	void *log;
};

/*
 * Dynamically growing data sample log
 */
struct io_log {
	/*
	 * Entries already logged
	 */
	struct flist_head io_logs;
	uint32_t cur_log_max;

	/*
	 * When the current log runs out of space, store events here until
	 * we have a chance to regrow
	 */
	struct io_logs *pending;

	unsigned int log_ddir_mask;

	char *filename;

	struct thread_data *td;

	unsigned int log_type;

	/*
	 * If we fail extending the log, stop collecting more entries.
	 */
	bool disabled;

	/*
	 * Log offsets
	 */
	unsigned int log_offset;

	/*
	 * Max size of log entries before a chunk is compressed
	 */
	unsigned int log_gz;

	/*
	 * Don't deflate for storing, just store the compressed bits
	 */
	unsigned int log_gz_store;

	/*
	 * Windowed average, for logging single entries average over some
	 * period of time.
	 */
	struct io_stat avg_window[DDIR_RWDIR_CNT];
	unsigned long avg_msec;
	unsigned long avg_last[DDIR_RWDIR_CNT];

	/*
	 * Windowed latency histograms, for keeping track of when we need to
	 * save a copy of the histogram every approximately hist_msec
	 * milliseconds.
	 */
	struct io_hist hist_window[DDIR_RWDIR_CNT];
	unsigned long hist_msec;
	unsigned int hist_coarseness;

	pthread_mutex_t chunk_lock;
	unsigned int chunk_seq;
	struct flist_head chunk_list;

	pthread_mutex_t deferred_free_lock;
#define IOLOG_MAX_DEFER	8
	void *deferred_items[IOLOG_MAX_DEFER];
	unsigned int deferred;
};

/*
 * If the upper bit is set, then we have the offset as well
 */
#define LOG_OFFSET_SAMPLE_BIT	0x80000000U
#define io_sample_ddir(io)	((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)

static inline void io_sample_set_ddir(struct io_log *log,
				      struct io_sample *io,
				      enum fio_ddir ddir)
{
	io->__ddir = ddir | log->log_ddir_mask;
}

static inline size_t __log_entry_sz(int log_offset)
{
	if (log_offset)
		return sizeof(struct io_sample_offset);
	else
		return sizeof(struct io_sample);
}

static inline size_t log_entry_sz(struct io_log *log)
{
	return __log_entry_sz(log->log_offset);
}

static inline size_t log_sample_sz(struct io_log *log, struct io_logs *cur_log)
{
	return cur_log->nr_samples * log_entry_sz(log);
}

static inline struct io_sample *__get_sample(void *samples, int log_offset,
					     uint64_t sample)
{
	uint64_t sample_offset = sample * __log_entry_sz(log_offset);
	return (struct io_sample *) ((char *) samples + sample_offset);
}

struct io_logs *iolog_cur_log(struct io_log *);
uint64_t iolog_nr_samples(struct io_log *);
void regrow_logs(struct thread_data *);
void regrow_agg_logs(void);

static inline struct io_sample *get_sample(struct io_log *iolog,
					   struct io_logs *cur_log,
					   uint64_t sample)
{
	return __get_sample(cur_log->log, iolog->log_offset, sample);
}

enum {
	IP_F_ONRB	= 1,
	IP_F_ONLIST	= 2,
	IP_F_TRIMMED	= 4,
	IP_F_IN_FLIGHT	= 8,
};

/*
 * When logging io actions, this matches a single sent io_u
 */
struct io_piece {
	union {
		struct fio_rb_node rb_node;
		struct flist_head list;
	};
	struct flist_head trim_list;
	union {
		int fileno;
		struct fio_file *file;
	};
	unsigned long long offset;
	unsigned short numberio;
	unsigned long len;
	unsigned int flags;
	enum fio_ddir ddir;
	union {
		unsigned long delay;
		unsigned int file_action;
	};
};

/*
 * Log exports
 */
enum file_log_act {
	FIO_LOG_ADD_FILE,
	FIO_LOG_OPEN_FILE,
	FIO_LOG_CLOSE_FILE,
	FIO_LOG_UNLINK_FILE,
};

struct io_u;
extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
extern void log_io_u(const struct thread_data *, const struct io_u *);
extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
extern bool __must_check init_iolog(struct thread_data *td);
extern void log_io_piece(struct thread_data *, struct io_u *);
extern void unlog_io_piece(struct thread_data *, struct io_u *);
extern void trim_io_piece(const struct io_u *);
extern void queue_io_piece(struct thread_data *, struct io_piece *);
extern void prune_io_piece_log(struct thread_data *);
extern void write_iolog_close(struct thread_data *);
extern int iolog_compress_init(struct thread_data *, struct sk_out *);
extern void iolog_compress_exit(struct thread_data *);
extern size_t log_chunk_sizes(struct io_log *);
extern int init_io_u_buffers(struct thread_data *);

#ifdef CONFIG_ZLIB
extern int iolog_file_inflate(const char *);
#endif

/*
 * Logging
 */
struct log_params {
	struct thread_data *td;
	unsigned long avg_msec;
	unsigned long hist_msec;
	int hist_coarseness;
	int log_type;
	int log_offset;
	int log_gz;
	int log_gz_store;
	int log_compress;
};

static inline bool per_unit_log(struct io_log *log)
{
	return log && (!log->avg_msec || log->log_gz || log->log_gz_store);
}

static inline bool inline_log(struct io_log *log)
{
	return log->log_type == IO_LOG_TYPE_LAT ||
		log->log_type == IO_LOG_TYPE_CLAT ||
		log->log_type == IO_LOG_TYPE_SLAT;
}

static inline void ipo_bytes_align(unsigned int replay_align, struct io_piece *ipo)
{
	if (!replay_align)
		return;

	ipo->offset &= ~(replay_align - (uint64_t)1);
}

extern void finalize_logs(struct thread_data *td, bool);
extern void setup_log(struct io_log **, struct log_params *, const char *);
extern void flush_log(struct io_log *, bool);
extern void flush_samples(FILE *, void *, uint64_t);
extern uint64_t hist_sum(int, int, uint64_t *, uint64_t *);
extern void free_log(struct io_log *);
extern void fio_writeout_logs(bool);
extern void td_writeout_logs(struct thread_data *, bool);
extern int iolog_cur_flush(struct io_log *, struct io_logs *);

static inline void init_ipo(struct io_piece *ipo)
{
	INIT_FLIST_HEAD(&ipo->list);
	INIT_FLIST_HEAD(&ipo->trim_list);
}

struct iolog_compress {
	struct flist_head list;
	void *buf;
	size_t len;
	unsigned int seq;
};

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