[fio.git] / iolog.h

#ifndef FIO_IOLOG_H
#define FIO_IOLOG_H

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

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

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

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

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