[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;

	char *filename;

	unsigned int log_type;

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

	/*
	 * Log offsets
	 */
	unsigned int log_offset;

	/*
	 * 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;
};

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(struct thread_data *, 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 *, 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 *);

/*
 * Logging
 */
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 **, unsigned long, int, int, const char *);
extern void __finish_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 *);

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;
	26	uint64_t val;
	27	uint32_t ddir;
	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
cb7e0ace JA	55	char *filename;
cb7e0ace JA	56
1b42725f	57	unsigned int log_type;
ea51b956	58
3c568239 JA	59	/*
	60	* If we fail extending the log, stop collecting more entries.
	61	*/
	62	unsigned int disabled;
	63
ae588852 JA	64	/*
	65	* Log offsets
	66	*/
	67	unsigned int log_offset;
	68
b8bc8cba JA	69	/*
	70	* Windowed average, for logging single entries average over some
	71	* period of time.
	72	*/
6eaf09d6	73	struct io_stat avg_window[DDIR_RWDIR_CNT];
b8bc8cba JA	74	unsigned long avg_msec;
b8bc8cba JA	75	unsigned long avg_last;
5995a6a4 JA	76	};
5995a6a4 JA	77
ae588852 JA	78	static inline size_t __log_entry_sz(int log_offset)
	79	{
	80	if (log_offset)
	81	return sizeof(struct io_sample_offset);
	82	else
	83	return sizeof(struct io_sample);
	84	}
	85
	86	static inline size_t log_entry_sz(struct io_log *log)
	87	{
	88	return __log_entry_sz(log->log_offset);
	89	}
	90
	91	static inline struct io_sample __get_sample(void samples, int log_offset,
	92	uint64_t sample)
	93	{
	94	return samples + sample * __log_entry_sz(log_offset);
	95	}
	96
	97	static inline struct io_sample get_sample(struct io_log iolog,
	98	uint64_t sample)
	99	{
	100	return __get_sample(iolog->log, iolog->log_offset, sample);
	101	}
	102
0d29de83 JA	103	enum {
	104	IP_F_ONRB = 1,
	105	IP_F_ONLIST = 2,
	106	IP_F_TRIMMED = 4,
f9401285	107	IP_F_IN_FLIGHT = 8,
0d29de83 JA	108	};
0d29de83 JA	109
5995a6a4 JA	110	/*
	111	* When logging io actions, this matches a single sent io_u
	112	*/
	113	struct io_piece {
	114	union {
	115	struct rb_node rb_node;
	116	struct flist_head list;
	117	};
0d29de83	118	struct flist_head trim_list;
5995a6a4 JA	119	union {
	120	int fileno;
	121	struct fio_file *file;
	122	};
	123	unsigned long long offset;
da0a7bd2	124	unsigned short numberio;
5995a6a4	125	unsigned long len;
a917a8b3	126	unsigned int flags;
5995a6a4 JA	127	enum fio_ddir ddir;
	128	union {
	129	unsigned long delay;
	130	unsigned int file_action;
	131	};
	132	};
	133
	134	/*
	135	* Log exports
	136	*/
	137	enum file_log_act {
	138	FIO_LOG_ADD_FILE,
	139	FIO_LOG_OPEN_FILE,
	140	FIO_LOG_CLOSE_FILE,
	141	FIO_LOG_UNLINK_FILE,
	142	};
	143
8062f527	144	struct io_u;
5995a6a4 JA	145	extern int __must_check read_iolog_get(struct thread_data , struct io_u );
	146	extern void log_io_u(struct thread_data , struct io_u );
	147	extern void log_file(struct thread_data , struct fio_file , enum file_log_act);
	148	extern int __must_check init_iolog(struct thread_data *td);
	149	extern void log_io_piece(struct thread_data , struct io_u );
890b6656 JA	150	extern void unlog_io_piece(struct thread_data , struct io_u );
890b6656 JA	151	extern void trim_io_piece(struct thread_data , struct io_u );
5995a6a4 JA	152	extern void queue_io_piece(struct thread_data , struct io_piece );
	153	extern void prune_io_piece_log(struct thread_data *);
	154	extern void write_iolog_close(struct thread_data *);
	155
	156	/*
	157	* Logging
	158	*/
99007068	159	extern void finalize_logs(struct thread_data *td);
02af0988	160	extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	161	unsigned int, uint64_t);
5995a6a4	162	extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	163	unsigned int, uint64_t);
5995a6a4	164	extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
ae588852	165	unsigned int, uint64_t);
5995a6a4 JA	166	extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
5995a6a4 JA	167	struct timeval *);
9b7e600d EV	168	extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
9b7e600d EV	169	struct timeval *);
5995a6a4 JA	170	extern void init_disk_util(struct thread_data *);
5995a6a4 JA	171	extern void update_rusage_stat(struct thread_data *);
cb7e0ace JA	172	extern void setup_log(struct io_log *, unsigned long, int, int, const char );
cb7e0ace JA	173	extern void __finish_log(struct io_log *);
518dac09	174	extern void free_log(struct io_log *);
6eaf09d6	175	extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
5995a6a4 JA	176	extern int write_bw_log;
5995a6a4 JA	177	extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
905e3d4f	178	extern void fio_writeout_logs(struct thread_data *);
5995a6a4	179
0d29de83 JA	180	static inline void init_ipo(struct io_piece *ipo)
	181	{
	182	memset(ipo, 0, sizeof(*ipo));
	183	INIT_FLIST_HEAD(&ipo->trim_list);
	184	}
	185
5995a6a4	186	#endif