xref: /linux/tools/perf/util/callchain.h (revision c0e297dc61f8d4453e07afbea1fa8d0e67cd4a34)
1 #ifndef __PERF_CALLCHAIN_H
2 #define __PERF_CALLCHAIN_H
3 
4 #include "../perf.h"
5 #include <linux/list.h>
6 #include <linux/rbtree.h>
7 #include "event.h"
8 #include "symbol.h"
9 
10 enum perf_call_graph_mode {
11 	CALLCHAIN_NONE,
12 	CALLCHAIN_FP,
13 	CALLCHAIN_DWARF,
14 	CALLCHAIN_LBR,
15 	CALLCHAIN_MAX
16 };
17 
18 enum chain_mode {
19 	CHAIN_NONE,
20 	CHAIN_FLAT,
21 	CHAIN_GRAPH_ABS,
22 	CHAIN_GRAPH_REL
23 };
24 
25 enum chain_order {
26 	ORDER_CALLER,
27 	ORDER_CALLEE
28 };
29 
30 struct callchain_node {
31 	struct callchain_node	*parent;
32 	struct list_head	val;
33 	struct rb_node		rb_node_in; /* to insert nodes in an rbtree */
34 	struct rb_node		rb_node;    /* to sort nodes in an output tree */
35 	struct rb_root		rb_root_in; /* input tree of children */
36 	struct rb_root		rb_root;    /* sorted output tree of children */
37 	unsigned int		val_nr;
38 	u64			hit;
39 	u64			children_hit;
40 };
41 
42 struct callchain_root {
43 	u64			max_depth;
44 	struct callchain_node	node;
45 };
46 
47 struct callchain_param;
48 
49 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
50 				 u64, struct callchain_param *);
51 
52 enum chain_key {
53 	CCKEY_FUNCTION,
54 	CCKEY_ADDRESS
55 };
56 
57 struct callchain_param {
58 	bool			enabled;
59 	enum perf_call_graph_mode record_mode;
60 	u32			dump_size;
61 	enum chain_mode 	mode;
62 	u32			print_limit;
63 	double			min_percent;
64 	sort_chain_func_t	sort;
65 	enum chain_order	order;
66 	enum chain_key		key;
67 	bool			branch_callstack;
68 };
69 
70 extern struct callchain_param callchain_param;
71 
72 struct callchain_list {
73 	u64			ip;
74 	struct map_symbol	ms;
75 	struct /* for TUI */ {
76 		bool		unfolded;
77 		bool		has_children;
78 	};
79 	char		       *srcline;
80 	struct list_head	list;
81 };
82 
83 /*
84  * A callchain cursor is a single linked list that
85  * let one feed a callchain progressively.
86  * It keeps persistent allocated entries to minimize
87  * allocations.
88  */
89 struct callchain_cursor_node {
90 	u64				ip;
91 	struct map			*map;
92 	struct symbol			*sym;
93 	struct callchain_cursor_node	*next;
94 };
95 
96 struct callchain_cursor {
97 	u64				nr;
98 	struct callchain_cursor_node	*first;
99 	struct callchain_cursor_node	**last;
100 	u64				pos;
101 	struct callchain_cursor_node	*curr;
102 };
103 
104 extern __thread struct callchain_cursor callchain_cursor;
105 
106 static inline void callchain_init(struct callchain_root *root)
107 {
108 	INIT_LIST_HEAD(&root->node.val);
109 
110 	root->node.parent = NULL;
111 	root->node.hit = 0;
112 	root->node.children_hit = 0;
113 	root->node.rb_root_in = RB_ROOT;
114 	root->max_depth = 0;
115 }
116 
117 static inline u64 callchain_cumul_hits(struct callchain_node *node)
118 {
119 	return node->hit + node->children_hit;
120 }
121 
122 int callchain_register_param(struct callchain_param *param);
123 int callchain_append(struct callchain_root *root,
124 		     struct callchain_cursor *cursor,
125 		     u64 period);
126 
127 int callchain_merge(struct callchain_cursor *cursor,
128 		    struct callchain_root *dst, struct callchain_root *src);
129 
130 /*
131  * Initialize a cursor before adding entries inside, but keep
132  * the previously allocated entries as a cache.
133  */
134 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
135 {
136 	cursor->nr = 0;
137 	cursor->last = &cursor->first;
138 }
139 
140 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
141 			    struct map *map, struct symbol *sym);
142 
143 /* Close a cursor writing session. Initialize for the reader */
144 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
145 {
146 	cursor->curr = cursor->first;
147 	cursor->pos = 0;
148 }
149 
150 /* Cursor reading iteration helpers */
151 static inline struct callchain_cursor_node *
152 callchain_cursor_current(struct callchain_cursor *cursor)
153 {
154 	if (cursor->pos == cursor->nr)
155 		return NULL;
156 
157 	return cursor->curr;
158 }
159 
160 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
161 {
162 	cursor->curr = cursor->curr->next;
163 	cursor->pos++;
164 }
165 
166 struct option;
167 struct hist_entry;
168 
169 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
170 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
171 
172 int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent,
173 			      struct perf_evsel *evsel, struct addr_location *al,
174 			      int max_stack);
175 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
176 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
177 			bool hide_unresolved);
178 
179 extern const char record_callchain_help[];
180 int parse_callchain_record_opt(const char *arg);
181 int parse_callchain_report_opt(const char *arg);
182 int perf_callchain_config(const char *var, const char *value);
183 
184 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
185 					     struct callchain_cursor *src)
186 {
187 	*dest = *src;
188 
189 	dest->first = src->curr;
190 	dest->nr -= src->pos;
191 }
192 
193 #ifdef HAVE_SKIP_CALLCHAIN_IDX
194 extern int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
195 #else
196 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
197 			struct ip_callchain *chain __maybe_unused)
198 {
199 	return -1;
200 }
201 #endif
202 
203 char *callchain_list__sym_name(struct callchain_list *cl,
204 			       char *bf, size_t bfsize, bool show_dso);
205 
206 void free_callchain(struct callchain_root *root);
207 
208 #endif	/* __PERF_CALLCHAIN_H */
209