[blktrace.git] / btt / globals.h

/*
 * blktrace output analysis: generate a timeline & gather statistics
 *
 * Copyright (C) 2006 Alan D. Brunelle <Alan.Brunelle@hp.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#include <assert.h>
#include <stdio.h>
#include <string.h>
#include <time.h>

#include "blktrace.h"
#include "rbtree.h"
#include "list.h"

#define BIT_TIME(t)	((double)SECONDS(t) + ((double)NANO_SECONDS(t) / 1.0e9))

#define BIT_START(iop)	((iop)->t.sector)
#define BIT_END(iop)	((iop)->t.sector + ((iop)->t.bytes >> 9))
#define IOP_READ(iop)	((iop)->t.action & BLK_TC_ACT(BLK_TC_READ))
#define IOP_RW(iop)	(IOP_READ(iop) ? 1 : 0)

#define TO_SEC(nanosec)	((double)(nanosec) / 1.0e9)
#define TO_MSEC(nanosec) (1000.0 * TO_SEC(nanosec))

#if defined(DEBUG)
#define DBG_PING()	dbg_ping()
#define ASSERT(truth)   do {						\
				if (!(truth)) {				\
					DBG_PING();			\
					assert(truth);			\
				}					\
			} while (0)


#define LIST_DEL(hp)	list_del(hp)
#else
#define ASSERT(truth)
#define DBG_PING()
#define LIST_DEL(hp)	do {						\
				ASSERT((hp)->next != NULL);		\
				ASSERT(!list_empty(hp));		\
				list_del(hp);				\
			} while (0)
#endif

enum iop_type {
	IOP_Q = 0,
	IOP_X = 1,
	IOP_A = 2,
	IOP_I = 3,
	IOP_M = 4,
	IOP_D = 5,
	IOP_C = 6,
	IOP_R = 7,
	IOP_L = 8, 	// IOP_A -> IOP_A + IOP_L
};
#define N_IOP_TYPES	(IOP_L + 1)

struct file_info {
	struct file_info *next;
	FILE *ofp;
	char oname[1];
};

struct mode {
	int most_seeks, nmds;
	long long *modes;
};

struct io;
struct io_list {
	struct list_head head;
	struct io *iop;
	int cy_users;
};

struct avg_info {
	__u64 min, max, total;
	double avg;
	int n;
};

struct avgs_info {
        struct avg_info q2q;
	struct avg_info q2c;
	struct avg_info q2a;		/* Q to (A or X) */
	struct avg_info q2i;		/* Q to (I or M) */
	struct avg_info i2d;		/* (I or M) to D */
	struct avg_info d2c;

	struct avg_info blks;		/* Blocks transferred */
};

struct range_info {
	struct list_head head;		/* on: qranges OR cranges */
	__u64 start, end;
};

struct region_info {
	struct list_head qranges;
	struct list_head cranges;
	struct range_info *qr_cur, *cr_cur;
};

struct p_info {
	struct region_info regions;
	struct avgs_info avgs;
	__u64 last_q;
	__u32 pid;
	char name[1];
};

struct devmap {
	struct devmap *next;
	unsigned int host, bus, target, lun, irq, cpu;
	char model[64];
	char device[32], node[32], pci[32], devno[32];
};

struct stats {
	__u64 rqm[2], ios[2], sec[2], wait, svctm;
	double last_qu_change, last_dev_change, tot_qusz, idle_time;
	int cur_qusz, cur_dev;
};

struct stats_t {
	double n;
	double rqm_s[2], ios_s[2], sec_s[2];
	double avgrq_sz, avgqu_sz, await, svctm, p_util;
};

struct d_info {
	struct list_head all_head, hash_head;
	void *heads;
	struct region_info regions;
	struct devmap *map;
	void *seek_handle;
	FILE *d2c_ofp, *q2c_ofp;
	struct avgs_info avgs;
	struct stats stats, all_stats;
	__u64 last_q, n_ds;
	__u32 device;
};

struct io {
	struct rb_node rb_node;
	struct list_head f_head, c_pending, retry;
	struct list_head down_list, up_list;
	struct d_info *dip;
	struct p_info *pip;
	void *pdu;
	struct blk_io_trace t;
	__u64 bytes_left;
	int linked, on_retry_list, down_len, up_len;
	enum iop_type type;
};

struct bilink {
	struct list_head down_head, up_head;
	struct io *diop, *uiop;
};

/* bt_timeline.c */

extern char bt_timeline_version[], *devices, *exes, *input_name, *output_name;
extern char *seek_name, *iostat_name, *d2c_name, *q2c_name, *per_io_name;
extern double range_delta;
extern FILE *ranges_ofp, *avgs_ofp, *iostat_ofp, *per_io_ofp;;
extern int verbose, done, time_bounded;
extern unsigned int n_devs;
extern unsigned long n_traces;
extern struct list_head all_devs, all_procs, retries;
extern struct avgs_info all_avgs;
extern __u64 last_q, next_retry_check;
extern struct region_info all_regions;
extern struct list_head free_ios;
extern __u64 iostat_interval, iostat_last_stamp;
extern time_t genesis, last_vtrace;
extern double t_astart, t_aend;
#if defined(DEBUG)
extern int rb_tree_size;
#endif

/* args.c */
void handle_args(int argc, char *argv[]);

/* dev_map.c */
int dev_map_read(char *fname);
struct devmap *dev_map_find(__u32 device);

/* devs.c */
#if defined(DEBUG)
void dump_rb_trees(void);
#endif
void init_dev_heads(void);
struct d_info *dip_add(__u32 device, struct io *iop);
void dip_rem(struct io *iop);
struct d_info *__dip_find(__u32 device);
void dip_foreach_list(struct io *iop, enum iop_type type, struct list_head *hd);
void dip_foreach(struct io *iop, enum iop_type type, 
		 void (*fnc)(struct io *iop, struct io *this), int rm_after);
struct io *dip_find_sec(struct d_info *dip, enum iop_type type, __u64 sec);
void dip_foreach_out(void (*func)(struct d_info *, void *), void *arg);

/* dip_rb.c */
int rb_insert(struct rb_root *root, struct io *iop);
struct io *rb_find_sec(struct rb_root *root, __u64 sec);
void rb_foreach(struct rb_node *n, struct io *iop, 
		      void (*fnc)(struct io *iop, struct io *this),
		      struct list_head *head);

/* iostat.c */
void iostat_init(void);
void iostat_insert(struct io *iop);
void iostat_merge(struct io *iop);
void iostat_issue(struct io *iop);
void iostat_unissue(struct io *iop);
void iostat_complete(struct io *d_iop, struct io *c_iop);
void iostat_check_time(__u64 stamp);
void iostat_dump_stats(__u64 stamp, int all);

/* latency.c */
void latency_init(struct d_info *dip);
void latency_clean(void);
void latency_d2c(struct d_info *dip, __u64 tstamp, __u64 latency);
void latency_q2c(struct d_info *dip, __u64 tstamp, __u64 latency);

/* misc.c */
int in_devices(struct blk_io_trace *t);
void add_file(struct file_info **fipp, FILE *fp, char *oname);
void clean_files(struct file_info **fipp);
void dbg_ping(void);

/* mmap.c */
void setup_ifile(char *fname);
void cleanup_ifile(void);
int next_trace(struct blk_io_trace *t, void **pdu);

/* output.c */
int output_avgs(FILE *ofp);
int output_ranges(FILE *ofp);
char *make_dev_hdr(char *pad, size_t len, struct d_info *dip);

/* proc.c */
void add_process(__u32 pid, char *name);
struct p_info *find_process(__u32 pid, char *name);
void pip_update_q(struct io *iop);
void pip_foreach_out(void (*f)(struct p_info *, void *), void *arg);

/* seek.c */
void *seeki_init(__u32 device);
void seek_clean(void);
void seeki_add(void *handle, struct io *iop);
double seeki_mean(void *handle);
long long seeki_nseeks(void *handle);
long long seeki_median(void *handle);
int seeki_mode(void *handle, struct mode *mp);

/* trace.c */
void __dump_iop(FILE *ofp, struct io *iop, int extra_nl);
void __dump_iop2(FILE *ofp, struct io *a_iop, struct io *l_iop);
void release_iops(struct list_head *rmhd);
void add_trace(struct io *iop);
void do_retries(__u64 now);

/* trace_complete.c */
void trace_complete(struct io *c_iop);
void retry_complete(struct io *c_iop, __u64 now);

/* trace_im.c */
void run_im(struct io *im_iop, struct io *c_iop, void *param);
void run_unim(struct io *im_iop, struct list_head *rmhd);
int ready_im(struct io *im_iop, struct io *c_iop);
void trace_insert(struct io *i_iop);
void trace_merge(struct io *m_iop);

/* trace_issue.c */
void run_issue(struct io *d_iop, struct io *c_iop, void *param);
void run_unissue(struct io *d_iop, struct list_head *rmhd);
int ready_issue(struct io *d_iop, struct io *c_iop);
void trace_issue(struct io *d_iop);

/* trace_queue.c */
void run_queue(struct io *q_iop, struct io *c_iop, struct list_head *rmhd);
int ready_queue(struct io *q_iop, struct io *c_iop);
void trace_queue(struct io *q_iop);

/* trace_remap.c */
void run_remap(struct io *a_iop, struct io *c_iop, void *param);
int ready_remap(struct io *a_iop, struct io *c_iop);
void trace_remap(struct io *a_iop);

/* trace_requeue.c */
void trace_requeue(struct io *r_iop);

#include "inlines.h"
Commit	Line	Data
63eba147 JA	1	/*
	2	* blktrace output analysis: generate a timeline & gather statistics
	3	*
	4	* Copyright (C) 2006 Alan D. Brunelle <Alan.Brunelle@hp.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*
	20	*/
	21	#include <assert.h>
	22	#include <stdio.h>
	23	#include <string.h>
6eb42155	24	#include <time.h>
63eba147 JA	25
63eba147 JA	26	#include "blktrace.h"
6eb42155	27	#include "rbtree.h"
63eba147 JA	28	#include "list.h"
63eba147 JA	29
63eba147 JA	30	#define BIT_TIME(t) ((double)SECONDS(t) + ((double)NANO_SECONDS(t) / 1.0e9))
	31
	32	#define BIT_START(iop) ((iop)->t.sector)
	33	#define BIT_END(iop) ((iop)->t.sector + ((iop)->t.bytes >> 9))
5225e788	34	#define IOP_READ(iop) ((iop)->t.action & BLK_TC_ACT(BLK_TC_READ))
21e47d90	35	#define IOP_RW(iop) (IOP_READ(iop) ? 1 : 0)
63eba147	36
b2ecdd0f ADB	37	#define TO_SEC(nanosec) ((double)(nanosec) / 1.0e9)
	38	#define TO_MSEC(nanosec) (1000.0 * TO_SEC(nanosec))
	39
63eba147	40	#if defined(DEBUG)
6eb42155	41	#define DBG_PING() dbg_ping()
63eba147 JA	42	#define ASSERT(truth) do { \
	43	if (!(truth)) { \
	44	DBG_PING(); \
	45	assert(truth); \
	46	} \
	47	} while (0)
	48
63eba147 JA	49
63eba147 JA	50	#define LIST_DEL(hp) list_del(hp)
63eba147 JA	51	#else
	52	#define ASSERT(truth)
	53	#define DBG_PING()
63eba147	54	#define LIST_DEL(hp) do { \
d76c5b81 AB	55	ASSERT((hp)->next != NULL); \
	56	ASSERT(!list_empty(hp)); \
	57	list_del(hp); \
63eba147 JA	58	} while (0)
	59	#endif
	60
63eba147 JA	61	enum iop_type {
	62	IOP_Q = 0,
	63	IOP_X = 1,
	64	IOP_A = 2,
d76c5b81	65	IOP_I = 3,
095181f2	66	IOP_M = 4,
d76c5b81 AB	67	IOP_D = 5,
	68	IOP_C = 6,
	69	IOP_R = 7,
	70	IOP_L = 8, // IOP_A -> IOP_A + IOP_L
63eba147	71	};
d76c5b81	72	#define N_IOP_TYPES (IOP_L + 1)
63eba147	73
b2ecdd0f ADB	74	struct file_info {
	75	struct file_info *next;
	76	FILE *ofp;
6eb42155	77	char oname[1];
b2ecdd0f ADB	78	};
b2ecdd0f ADB	79
6eb42155 ADB	80	struct mode {
	81	int most_seeks, nmds;
	82	long long *modes;
63eba147 JA	83	};
	84
	85	struct io;
	86	struct io_list {
	87	struct list_head head;
	88	struct io *iop;
	89	int cy_users;
	90	};
	91
	92	struct avg_info {
	93	__u64 min, max, total;
	94	double avg;
	95	int n;
	96	};
	97
	98	struct avgs_info {
	99	struct avg_info q2q;
	100	struct avg_info q2c;
	101	struct avg_info q2a; /* Q to (A or X) */
	102	struct avg_info q2i; /* Q to (I or M) */
	103	struct avg_info i2d; /* (I or M) to D */
	104	struct avg_info d2c;
	105
	106	struct avg_info blks; /* Blocks transferred */
	107	};
	108
	109	struct range_info {
	110	struct list_head head; /* on: qranges OR cranges */
	111	__u64 start, end;
	112	};
	113
	114	struct region_info {
	115	struct list_head qranges;
	116	struct list_head cranges;
	117	struct range_info qr_cur, cr_cur;
	118	};
	119
63eba147	120	struct p_info {
63eba147 JA	121	struct region_info regions;
63eba147 JA	122	struct avgs_info avgs;
63eba147	123	__u64 last_q;
6eb42155 ADB	124	__u32 pid;
6eb42155 ADB	125	char name[1];
63eba147 JA	126	};
	127
	128	struct devmap {
	129	struct devmap *next;
6eb42155	130	unsigned int host, bus, target, lun, irq, cpu;
63eba147	131	char model[64];
6eb42155	132	char device[32], node[32], pci[32], devno[32];
63eba147 JA	133	};
63eba147 JA	134
21e47d90	135	struct stats {
6eb42155	136	__u64 rqm[2], ios[2], sec[2], wait, svctm;
21e47d90	137	double last_qu_change, last_dev_change, tot_qusz, idle_time;
6eb42155	138	int cur_qusz, cur_dev;
21e47d90 ADB	139	};
21e47d90 ADB	140
4a5cddba JA	141	struct stats_t {
	142	double n;
	143	double rqm_s[2], ios_s[2], sec_s[2];
	144	double avgrq_sz, avgqu_sz, await, svctm, p_util;
	145	};
	146
63eba147	147	struct d_info {
6eb42155 ADB	148	struct list_head all_head, hash_head;
6eb42155 ADB	149	void *heads;
63eba147	150	struct region_info regions;
63eba147	151	struct devmap *map;
5225e788	152	void *seek_handle;
b2ecdd0f	153	FILE d2c_ofp, q2c_ofp;
6eb42155	154	struct avgs_info avgs;
21e47d90	155	struct stats stats, all_stats;
6eb42155 ADB	156	__u64 last_q, n_ds;
6eb42155 ADB	157	__u32 device;
63eba147 JA	158	};
	159
	160	struct io {
6eb42155	161	struct rb_node rb_node;
d76c5b81 AB	162	struct list_head f_head, c_pending, retry;
d76c5b81 AB	163	struct list_head down_list, up_list;
63eba147 JA	164	struct d_info *dip;
63eba147 JA	165	struct p_info *pip;
6eb42155	166	void *pdu;
d76c5b81 AB	167	struct blk_io_trace t;
	168	__u64 bytes_left;
	169	int linked, on_retry_list, down_len, up_len;
63eba147	170	enum iop_type type;
d76c5b81	171	};
095181f2	172
d76c5b81 AB	173	struct bilink {
	174	struct list_head down_head, up_head;
	175	struct io diop, uiop;
63eba147 JA	176	};
63eba147 JA	177
6eb42155 ADB	178	/* bt_timeline.c */
6eb42155 ADB	179
63eba147	180	extern char bt_timeline_version[], devices, exes, input_name, output_name;
095181f2	181	extern char seek_name, iostat_name, d2c_name, q2c_name, *per_io_name;
63eba147	182	extern double range_delta;
095181f2	183	extern FILE ranges_ofp, avgs_ofp, iostat_ofp, per_io_ofp;;
d76c5b81	184	extern int verbose, done, time_bounded;
63eba147	185	extern unsigned int n_devs;
6eb42155	186	extern unsigned long n_traces;
095181f2	187	extern struct list_head all_devs, all_procs, retries;
63eba147	188	extern struct avgs_info all_avgs;
d76c5b81	189	extern __u64 last_q, next_retry_check;
63eba147	190	extern struct region_info all_regions;
6eb42155	191	extern struct list_head free_ios;
21e47d90	192	extern __u64 iostat_interval, iostat_last_stamp;
6eb42155	193	extern time_t genesis, last_vtrace;
001b2633	194	extern double t_astart, t_aend;
d76c5b81 AB	195	#if defined(DEBUG)
	196	extern int rb_tree_size;
	197	#endif
63eba147	198
6eb42155	199	/* args.c */
63eba147	200	void handle_args(int argc, char *argv[]);
6eb42155 ADB	201
6eb42155 ADB	202	/* dev_map.c */
63eba147	203	int dev_map_read(char *fname);
6eb42155	204	struct devmap *dev_map_find(__u32 device);
63eba147	205
6eb42155	206	/* devs.c */
d76c5b81 AB	207	#if defined(DEBUG)
	208	void dump_rb_trees(void);
	209	#endif
6eb42155	210	void init_dev_heads(void);
095181f2	211	struct d_info dip_add(__u32 device, struct io iop);
6eb42155 ADB	212	void dip_rem(struct io *iop);
6eb42155 ADB	213	struct d_info *__dip_find(__u32 device);
095181f2	214	void dip_foreach_list(struct io iop, enum iop_type type, struct list_head hd);
6eb42155 ADB	215	void dip_foreach(struct io *iop, enum iop_type type,
	216	void (fnc)(struct io iop, struct io *this), int rm_after);
	217	struct io dip_find_sec(struct d_info dip, enum iop_type type, __u64 sec);
	218	void dip_foreach_out(void (func)(struct d_info , void ), void arg);
	219
	220	/* dip_rb.c */
095181f2	221	int rb_insert(struct rb_root root, struct io iop);
6eb42155 ADB	222	struct io rb_find_sec(struct rb_root root, __u64 sec);
	223	void rb_foreach(struct rb_node n, struct io iop,
	224	void (fnc)(struct io iop, struct io *this),
	225	struct list_head *head);
	226
	227	/* iostat.c */
21e47d90 ADB	228	void iostat_init(void);
	229	void iostat_insert(struct io *iop);
	230	void iostat_merge(struct io *iop);
	231	void iostat_issue(struct io *iop);
6eb42155 ADB	232	void iostat_unissue(struct io *iop);
6eb42155 ADB	233	void iostat_complete(struct io d_iop, struct io c_iop);
21e47d90 ADB	234	void iostat_check_time(__u64 stamp);
	235	void iostat_dump_stats(__u64 stamp, int all);
	236
6eb42155	237	/* latency.c */
b2ecdd0f ADB	238	void latency_init(struct d_info *dip);
	239	void latency_clean(void);
	240	void latency_d2c(struct d_info *dip, __u64 tstamp, __u64 latency);
	241	void latency_q2c(struct d_info *dip, __u64 tstamp, __u64 latency);
	242
6eb42155	243	/* misc.c */
6eb42155	244	int in_devices(struct blk_io_trace *t);
6eb42155 ADB	245	void add_file(struct file_info *fipp, FILE fp, char *oname);
	246	void clean_files(struct file_info **fipp);
	247	void dbg_ping(void);
	248
d76c5b81 AB	249	/* mmap.c */
	250	void setup_ifile(char *fname);
	251	void cleanup_ifile(void);
	252	int next_trace(struct blk_io_trace t, void *pdu);
	253
6eb42155 ADB	254	/* output.c */
	255	int output_avgs(FILE *ofp);
	256	int output_ranges(FILE *ofp);
	257	char make_dev_hdr(char pad, size_t len, struct d_info *dip);
	258
	259	/* proc.c */
	260	void add_process(__u32 pid, char *name);
	261	struct p_info find_process(__u32 pid, char name);
	262	void pip_update_q(struct io *iop);
	263	void pip_foreach_out(void (f)(struct p_info , void ), void arg);
	264
	265	/* seek.c */
	266	void *seeki_init(__u32 device);
	267	void seek_clean(void);
	268	void seeki_add(void handle, struct io iop);
	269	double seeki_mean(void *handle);
	270	long long seeki_nseeks(void *handle);
	271	long long seeki_median(void *handle);
	272	int seeki_mode(void handle, struct mode mp);
	273
	274	/* trace.c */
d76c5b81 AB	275	void __dump_iop(FILE ofp, struct io iop, int extra_nl);
	276	void __dump_iop2(FILE ofp, struct io a_iop, struct io *l_iop);
	277	void release_iops(struct list_head *rmhd);
6eb42155	278	void add_trace(struct io *iop);
d76c5b81	279	void do_retries(__u64 now);
6eb42155	280
095181f2 JA	281	/* trace_complete.c */
095181f2 JA	282	void trace_complete(struct io *c_iop);
d76c5b81	283	void retry_complete(struct io *c_iop, __u64 now);
095181f2 JA	284
095181f2 JA	285	/* trace_im.c */
d76c5b81 AB	286	void run_im(struct io im_iop, struct io c_iop, void *param);
	287	void run_unim(struct io im_iop, struct list_head rmhd);
	288	int ready_im(struct io im_iop, struct io c_iop);
095181f2 JA	289	void trace_insert(struct io *i_iop);
095181f2 JA	290	void trace_merge(struct io *m_iop);
095181f2 JA	291
095181f2 JA	292	/* trace_issue.c */
d76c5b81 AB	293	void run_issue(struct io d_iop, struct io c_iop, void *param);
	294	void run_unissue(struct io d_iop, struct list_head rmhd);
	295	int ready_issue(struct io d_iop, struct io c_iop);
095181f2	296	void trace_issue(struct io *d_iop);
095181f2 JA	297
095181f2 JA	298	/* trace_queue.c */
d76c5b81 AB	299	void run_queue(struct io q_iop, struct io c_iop, struct list_head *rmhd);
d76c5b81 AB	300	int ready_queue(struct io q_iop, struct io c_iop);
095181f2	301	void trace_queue(struct io *q_iop);
095181f2 JA	302
095181f2 JA	303	/* trace_remap.c */
d76c5b81 AB	304	void run_remap(struct io a_iop, struct io c_iop, void *param);
d76c5b81 AB	305	int ready_remap(struct io a_iop, struct io c_iop);
095181f2	306	void trace_remap(struct io *a_iop);
095181f2 JA	307
	308	/* trace_requeue.c */
	309	void trace_requeue(struct io *r_iop);
095181f2	310
63eba147	311	#include "inlines.h"