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

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
	 */
	unsigned long nr_samples;
	unsigned long max_samples;
	struct io_sample *log;

	unsigned int log_type;

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

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

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 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);
extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
				unsigned int);
extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
				unsigned int);
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);
extern void finish_log(struct thread_data *, struct io_log *, const char *);
extern void finish_log_named(struct thread_data *, struct io_log *, const char *, const char *);
extern void __finish_log(struct io_log *, const char *);
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);

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
ea51b956 JA	31	enum {
	32	IO_LOG_TYPE_LAT = 1,
	33	IO_LOG_TYPE_CLAT,
	34	IO_LOG_TYPE_SLAT,
	35	IO_LOG_TYPE_BW,
	36	IO_LOG_TYPE_IOPS,
	37	};
	38
5995a6a4 JA	39	/*
	40	* Dynamically growing data sample log
	41	*/
	42	struct io_log {
b8bc8cba JA	43	/*
	44	* Entries already logged
	45	*/
5995a6a4 JA	46	unsigned long nr_samples;
	47	unsigned long max_samples;
	48	struct io_sample *log;
b8bc8cba	49
1b42725f	50	unsigned int log_type;
ea51b956	51
3c568239 JA	52	/*
	53	* If we fail extending the log, stop collecting more entries.
	54	*/
	55	unsigned int disabled;
	56
b8bc8cba JA	57	/*
	58	* Windowed average, for logging single entries average over some
	59	* period of time.
	60	*/
6eaf09d6	61	struct io_stat avg_window[DDIR_RWDIR_CNT];
b8bc8cba JA	62	unsigned long avg_msec;
b8bc8cba JA	63	unsigned long avg_last;
5995a6a4 JA	64	};
5995a6a4 JA	65
0d29de83 JA	66	enum {
	67	IP_F_ONRB = 1,
	68	IP_F_ONLIST = 2,
	69	IP_F_TRIMMED = 4,
f9401285	70	IP_F_IN_FLIGHT = 8,
0d29de83 JA	71	};
0d29de83 JA	72
5995a6a4 JA	73	/*
	74	* When logging io actions, this matches a single sent io_u
	75	*/
	76	struct io_piece {
	77	union {
	78	struct rb_node rb_node;
	79	struct flist_head list;
	80	};
0d29de83	81	struct flist_head trim_list;
5995a6a4 JA	82	union {
	83	int fileno;
	84	struct fio_file *file;
	85	};
	86	unsigned long long offset;
da0a7bd2	87	unsigned short numberio;
5995a6a4	88	unsigned long len;
a917a8b3	89	unsigned int flags;
5995a6a4 JA	90	enum fio_ddir ddir;
	91	union {
	92	unsigned long delay;
	93	unsigned int file_action;
	94	};
	95	};
	96
	97	/*
	98	* Log exports
	99	*/
	100	enum file_log_act {
	101	FIO_LOG_ADD_FILE,
	102	FIO_LOG_OPEN_FILE,
	103	FIO_LOG_CLOSE_FILE,
	104	FIO_LOG_UNLINK_FILE,
	105	};
	106
8062f527	107	struct io_u;
5995a6a4 JA	108	extern int __must_check read_iolog_get(struct thread_data , struct io_u );
	109	extern void log_io_u(struct thread_data , struct io_u );
	110	extern void log_file(struct thread_data , struct fio_file , enum file_log_act);
	111	extern int __must_check init_iolog(struct thread_data *td);
	112	extern void log_io_piece(struct thread_data , struct io_u );
	113	extern void queue_io_piece(struct thread_data , struct io_piece );
	114	extern void prune_io_piece_log(struct thread_data *);
	115	extern void write_iolog_close(struct thread_data *);
	116
	117	/*
	118	* Logging
	119	*/
99007068	120	extern void finalize_logs(struct thread_data *td);
02af0988 JA	121	extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
02af0988 JA	122	unsigned int);
5995a6a4 JA	123	extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
	124	unsigned int);
	125	extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
	126	unsigned int);
	127	extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
	128	struct timeval *);
9b7e600d EV	129	extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
9b7e600d EV	130	struct timeval *);
5995a6a4 JA	131	extern void init_disk_util(struct thread_data *);
5995a6a4 JA	132	extern void update_rusage_stat(struct thread_data *);
ea51b956	133	extern void setup_log(struct io_log **, unsigned long, int);
5995a6a4 JA	134	extern void finish_log(struct thread_data , struct io_log , const char *);
	135	extern void finish_log_named(struct thread_data , struct io_log , const char , const char );
	136	extern void __finish_log(struct io_log , const char );
6eaf09d6	137	extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
5995a6a4 JA	138	extern int write_bw_log;
	139	extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
	140
0d29de83 JA	141	static inline void init_ipo(struct io_piece *ipo)
	142	{
	143	memset(ipo, 0, sizeof(*ipo));
	144	INIT_FLIST_HEAD(&ipo->trim_list);
	145	}
	146
5995a6a4	147	#endif