[fio.git] / iolog.h

#ifndef FIO_IOLOG_H
#define FIO_IOLOG_H

#include "lib/rbtree.h"
#include "lib/ieee754.h"
#include "flist.h"
#include "ioengine.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;
};

/*
 * A single data sample
 */
struct io_sample {
	uint64_t time;
	uint64_t val;
	uint32_t __ddir;
	uint32_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,
};

/*
 * Dynamically growing data sample log
 */
struct io_log {
	/*
	 * Entries already logged
	 */
	uint64_t nr_samples;
	uint64_t max_samples;
	void *log;

	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.
	 */
	unsigned int 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;

	pthread_mutex_t chunk_lock;
	unsigned int chunk_seq;
	struct flist_head chunk_list;
};

/*
 * 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 struct io_sample *__get_sample(void *samples, int log_offset,
					     uint64_t sample)
{
	return samples + sample * __log_entry_sz(log_offset);
}

static inline struct io_sample *get_sample(struct io_log *iolog,
					   uint64_t sample)
{
	return __get_sample(iolog->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 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 int __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(struct thread_data *, 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 *);

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

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

extern void finalize_logs(struct thread_data *td);
extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
				unsigned int, uint64_t);
extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
				unsigned int, uint64_t);
extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
				unsigned int, uint64_t);
extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
				struct timeval *);
extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
				struct timeval *);
extern void init_disk_util(struct thread_data *);
extern void update_rusage_stat(struct thread_data *);
extern void setup_log(struct io_log **, struct log_params *, const char *);
extern void flush_log(struct io_log *);
extern void free_log(struct io_log *);
extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
extern int write_bw_log;
extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
extern void fio_writeout_logs(struct thread_data *);
extern int iolog_flush(struct io_log *, int);

static inline void init_ipo(struct io_piece *ipo)
{
	memset(ipo, 0, sizeof(*ipo));
	INIT_FLIST_HEAD(&ipo->trim_list);
}

#endif
Commit	Line	Data
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	*/
	12	struct 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;
802ad4a8 JA	18	fio_fp64_t S;
5995a6a4 JA	19	};
	20
	21	/*
	22	* A single data sample
	23	*/
	24	struct io_sample {
1b42725f JA	25	uint64_t time;
1b42725f JA	26	uint64_t val;
b26317c9	27	uint32_t __ddir;
1b42725f	28	uint32_t bs;
5995a6a4 JA	29	};
5995a6a4 JA	30
ae588852 JA	31	struct io_sample_offset {
	32	struct io_sample s;
	33	uint64_t offset;
	34	};
	35
ea51b956 JA	36	enum {
	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	*/
	47	struct io_log {
b8bc8cba JA	48	/*
	49	* Entries already logged
	50	*/
3c865f32 JA	51	uint64_t nr_samples;
3c865f32 JA	52	uint64_t max_samples;
ae588852	53	void *log;
b8bc8cba	54
b26317c9 JA	55	unsigned int log_ddir_mask;
b26317c9 JA	56
cb7e0ace JA	57	char *filename;
cb7e0ace JA	58
aee2ab67 JA	59	struct thread_data *td;
aee2ab67 JA	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;
b8bc8cba JA	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	};
5995a6a4 JA	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
	102	static 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	109	static 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
	117	static inline size_t log_entry_sz(struct io_log *log)
	118	{
	119	return __log_entry_sz(log->log_offset);
	120	}
	121
	122	static inline struct io_sample __get_sample(void samples, int log_offset,
	123	uint64_t sample)
	124	{
	125	return samples + sample * __log_entry_sz(log_offset);
	126	}
	127
	128	static inline struct io_sample get_sample(struct io_log iolog,
	129	uint64_t sample)
	130	{
	131	return __get_sample(iolog->log, iolog->log_offset, sample);
	132	}
	133
0d29de83 JA	134	enum {
	135	IP_F_ONRB = 1,
	136	IP_F_ONLIST = 2,
	137	IP_F_TRIMMED = 4,
f9401285	138	IP_F_IN_FLIGHT = 8,
0d29de83 JA	139	};
0d29de83 JA	140
5995a6a4 JA	141	/*
	142	* When logging io actions, this matches a single sent io_u
	143	*/
	144	struct io_piece {
	145	union {
	146	struct rb_node rb_node;
	147	struct flist_head list;
	148	};
0d29de83	149	struct flist_head trim_list;
5995a6a4 JA	150	union {
	151	int fileno;
	152	struct fio_file *file;
	153	};
	154	unsigned long long offset;
da0a7bd2	155	unsigned short numberio;
5995a6a4	156	unsigned long len;
a917a8b3	157	unsigned int flags;
5995a6a4 JA	158	enum fio_ddir ddir;
	159	union {
	160	unsigned long delay;
	161	unsigned int file_action;
	162	};
	163	};
	164
	165	/*
	166	* Log exports
	167	*/
	168	enum file_log_act {
	169	FIO_LOG_ADD_FILE,
	170	FIO_LOG_OPEN_FILE,
	171	FIO_LOG_CLOSE_FILE,
	172	FIO_LOG_UNLINK_FILE,
	173	};
	174
8062f527	175	struct io_u;
5995a6a4	176	extern int __must_check read_iolog_get(struct thread_data , struct io_u );
1f440ece	177	extern void log_io_u(const struct thread_data , const struct io_u );
5995a6a4 JA	178	extern void log_file(struct thread_data , struct fio_file , enum file_log_act);
	179	extern int __must_check init_iolog(struct thread_data *td);
	180	extern void log_io_piece(struct thread_data , struct io_u );
890b6656	181	extern void unlog_io_piece(struct thread_data , struct io_u );
1f440ece	182	extern void trim_io_piece(struct thread_data , const struct io_u );
5995a6a4 JA	183	extern void queue_io_piece(struct thread_data , struct io_piece );
	184	extern void prune_io_piece_log(struct thread_data *);
	185	extern void write_iolog_close(struct thread_data *);
	186
b26317c9 JA	187	#ifdef CONFIG_ZLIB
	188	extern int iolog_file_inflate(const char *);
	189	#endif
	190
5995a6a4 JA	191	/*
	192	* Logging
	193	*/
aee2ab67 JA	194	struct log_params {
	195	struct thread_data *td;
	196	unsigned long avg_msec;
	197	int log_type;
	198	int log_offset;
	199	int log_gz;
b26317c9	200	int log_gz_store;
aee2ab67 JA	201	int log_compress;
	202	};
	203
99007068	204	extern void finalize_logs(struct thread_data *td);
02af0988	205	extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	206	unsigned int, uint64_t);
5995a6a4	207	extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	208	unsigned int, uint64_t);
5995a6a4	209	extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	210	unsigned int, uint64_t);
5995a6a4 JA	211	extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
5995a6a4 JA	212	struct timeval *);
9b7e600d EV	213	extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
9b7e600d EV	214	struct timeval *);
5995a6a4 JA	215	extern void init_disk_util(struct thread_data *);
5995a6a4 JA	216	extern void update_rusage_stat(struct thread_data *);
aee2ab67 JA	217	extern void setup_log(struct io_log *, struct log_params , const char *);
aee2ab67 JA	218	extern void flush_log(struct io_log *);
518dac09	219	extern void free_log(struct io_log *);
6eaf09d6	220	extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
5995a6a4 JA	221	extern int write_bw_log;
5995a6a4 JA	222	extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
905e3d4f	223	extern void fio_writeout_logs(struct thread_data *);
aee2ab67	224	extern int iolog_flush(struct io_log *, int);
5995a6a4	225
0d29de83 JA	226	static inline void init_ipo(struct io_piece *ipo)
	227	{
	228	memset(ipo, 0, sizeof(*ipo));
	229	INIT_FLIST_HEAD(&ipo->trim_list);
	230	}
	231
5995a6a4	232	#endif