[deliverable/linux.git] / tools / perf / util / callchain.h

#ifndef __PERF_CALLCHAIN_H
#define __PERF_CALLCHAIN_H

#include "../perf.h"
#include <linux/list.h>
#include <linux/rbtree.h>
#include "event.h"
#include "symbol.h"

enum chain_mode {
	CHAIN_NONE,
	CHAIN_FLAT,
	CHAIN_GRAPH_ABS,
	CHAIN_GRAPH_REL
};

struct callchain_node {
	struct callchain_node	*parent;
	struct list_head	brothers;
	struct list_head	children;
	struct list_head	val;
	struct rb_node		rb_node; /* to sort nodes in an rbtree */
	struct rb_root		rb_root; /* sorted tree of children */
	unsigned int		val_nr;
	u64			hit;
	u64			children_hit;
};

struct callchain_root {
	u64			max_depth;
	struct callchain_node	node;
};

struct callchain_param;

typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
				 u64, struct callchain_param *);

struct callchain_param {
	enum chain_mode 	mode;
	u32			print_limit;
	double			min_percent;
	sort_chain_func_t	sort;
};

struct callchain_list {
	u64			ip;
	struct map_symbol	ms;
	struct list_head	list;
};

/*
 * A callchain cursor is a single linked list that
 * let one feed a callchain progressively.
 * It keeps persitent allocated entries to minimize
 * allocations.
 */
struct callchain_cursor_node {
	u64				ip;
	struct map			*map;
	struct symbol			*sym;
	struct callchain_cursor_node	*next;
};

struct callchain_cursor {
	u64				nr;
	struct callchain_cursor_node	*first;
	struct callchain_cursor_node	**last;
	u64				pos;
	struct callchain_cursor_node	*curr;
};

static inline void callchain_init(struct callchain_root *root)
{
	INIT_LIST_HEAD(&root->node.brothers);
	INIT_LIST_HEAD(&root->node.children);
	INIT_LIST_HEAD(&root->node.val);

	root->node.parent = NULL;
	root->node.hit = 0;
	root->node.children_hit = 0;
	root->max_depth = 0;
}

static inline u64 cumul_hits(struct callchain_node *node)
{
	return node->hit + node->children_hit;
}

int register_callchain_param(struct callchain_param *param);
int callchain_append(struct callchain_root *root,
		     struct callchain_cursor *cursor,
		     u64 period);

int callchain_merge(struct callchain_cursor *cursor,
		    struct callchain_root *dst, struct callchain_root *src);

bool ip_callchain__valid(struct ip_callchain *chain, const event_t *event);

/*
 * Initialize a cursor before adding entries inside, but keep
 * the previously allocated entries as a cache.
 */
static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
{
	cursor->nr = 0;
	cursor->last = &cursor->first;
}

int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
			    struct map *map, struct symbol *sym);

/* Close a cursor writing session. Initialize for the reader */
static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
{
	cursor->curr = cursor->first;
	cursor->pos = 0;
}

/* Cursor reading iteration helpers */
static inline struct callchain_cursor_node *
callchain_cursor_current(struct callchain_cursor *cursor)
{
	if (cursor->pos == cursor->nr)
		return NULL;

	return cursor->curr;
}

static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
{
	cursor->curr = cursor->curr->next;
	cursor->pos++;
}
#endif	/* __PERF_CALLCHAIN_H */
Commit	Line	Data
8cb76d99 FW	1	#ifndef __PERF_CALLCHAIN_H
	2	#define __PERF_CALLCHAIN_H
	3
	4	#include "../perf.h"
5da50258	5	#include <linux/list.h>
43cbcd8a	6	#include <linux/rbtree.h>
139633c6	7	#include "event.h"
4424961a	8	#include "symbol.h"
8cb76d99	9
4eb3e478	10	enum chain_mode {
b1a88349	11	CHAIN_NONE,
805d127d FW	12	CHAIN_FLAT,
	13	CHAIN_GRAPH_ABS,
	14	CHAIN_GRAPH_REL
4eb3e478	15	};
8cb76d99 FW	16
	17	struct callchain_node {
	18	struct callchain_node *parent;
	19	struct list_head brothers;
f37a291c IM	20	struct list_head children;
f37a291c IM	21	struct list_head val;
4eb3e478 FW	22	struct rb_node rb_node; /* to sort nodes in an rbtree */
4eb3e478 FW	23	struct rb_root rb_root; /* sorted tree of children */
f37a291c IM	24	unsigned int val_nr;
f37a291c IM	25	u64 hit;
1953287b	26	u64 children_hit;
8cb76d99 FW	27	};
8cb76d99 FW	28
d2009c51 FW	29	struct callchain_root {
	30	u64 max_depth;
	31	struct callchain_node node;
	32	};
	33
805d127d FW	34	struct callchain_param;
805d127d FW	35
d2009c51	36	typedef void (sort_chain_func_t)(struct rb_root , struct callchain_root *,
805d127d FW	37	u64, struct callchain_param *);
	38
	39	struct callchain_param {
	40	enum chain_mode mode;
232a5c94	41	u32 print_limit;
805d127d FW	42	double min_percent;
	43	sort_chain_func_t sort;
	44	};
	45
8cb76d99	46	struct callchain_list {
f37a291c	47	u64 ip;
b3c9ac08	48	struct map_symbol ms;
8cb76d99 FW	49	struct list_head list;
	50	};
	51
1b3a0e95 FW	52	/*
	53	* A callchain cursor is a single linked list that
	54	* let one feed a callchain progressively.
	55	* It keeps persitent allocated entries to minimize
	56	* allocations.
	57	*/
	58	struct callchain_cursor_node {
	59	u64 ip;
	60	struct map *map;
	61	struct symbol *sym;
	62	struct callchain_cursor_node *next;
	63	};
	64
	65	struct callchain_cursor {
	66	u64 nr;
	67	struct callchain_cursor_node *first;
	68	struct callchain_cursor_node **last;
	69	u64 pos;
	70	struct callchain_cursor_node *curr;
	71	};
	72
d2009c51	73	static inline void callchain_init(struct callchain_root *root)
8cb76d99	74	{
d2009c51 FW	75	INIT_LIST_HEAD(&root->node.brothers);
	76	INIT_LIST_HEAD(&root->node.children);
	77	INIT_LIST_HEAD(&root->node.val);
97aa1052	78
d2009c51 FW	79	root->node.parent = NULL;
d2009c51 FW	80	root->node.hit = 0;
98ee74a7	81	root->node.children_hit = 0;
d2009c51	82	root->max_depth = 0;
8cb76d99 FW	83	}
8cb76d99 FW	84
1953287b FW	85	static inline u64 cumul_hits(struct callchain_node *node)
	86	{
	87	return node->hit + node->children_hit;
	88	}
	89
805d127d	90	int register_callchain_param(struct callchain_param *param);
1b3a0e95 FW	91	int callchain_append(struct callchain_root *root,
	92	struct callchain_cursor *cursor,
	93	u64 period);
	94
	95	int callchain_merge(struct callchain_cursor *cursor,
	96	struct callchain_root dst, struct callchain_root src);
139633c6	97
41a37e20	98	bool ip_callchain__valid(struct ip_callchain chain, const event_t event);
1b3a0e95 FW	99
	100	/*
	101	* Initialize a cursor before adding entries inside, but keep
	102	* the previously allocated entries as a cache.
	103	*/
	104	static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
	105	{
	106	cursor->nr = 0;
	107	cursor->last = &cursor->first;
	108	}
	109
	110	int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
	111	struct map map, struct symbol sym);
	112
	113	/* Close a cursor writing session. Initialize for the reader */
	114	static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
	115	{
	116	cursor->curr = cursor->first;
	117	cursor->pos = 0;
	118	}
	119
	120	/* Cursor reading iteration helpers */
	121	static inline struct callchain_cursor_node *
	122	callchain_cursor_current(struct callchain_cursor *cursor)
	123	{
	124	if (cursor->pos == cursor->nr)
	125	return NULL;
	126
	127	return cursor->curr;
	128	}
	129
	130	static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
	131	{
	132	cursor->curr = cursor->curr->next;
	133	cursor->pos++;
	134	}
8b40f521	135	#endif /* __PERF_CALLCHAIN_H */