• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #define HELP_PAD "\t\t\t\t"
11 
12 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
13 
14 #ifdef HAVE_DWARF_UNWIND_SUPPORT
15 # define RECORD_MODE_HELP  HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
16 #else
17 # define RECORD_MODE_HELP  HELP_PAD "record_mode:\tcall graph recording mode (fp|lbr)\n"
18 #endif
19 
20 #define RECORD_SIZE_HELP						\
21 	HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
22 	HELP_PAD "\t\tdefault: 8192 (bytes)\n"
23 
24 #define CALLCHAIN_RECORD_HELP  CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
25 
26 #define CALLCHAIN_REPORT_HELP						\
27 	HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|none)\n" \
28 	HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
29 	HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
30 	HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
31 	HELP_PAD "sort_key:\tcall graph sort key (function|address)\n"	\
32 	HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n"
33 
34 enum perf_call_graph_mode {
35 	CALLCHAIN_NONE,
36 	CALLCHAIN_FP,
37 	CALLCHAIN_DWARF,
38 	CALLCHAIN_LBR,
39 	CALLCHAIN_MAX
40 };
41 
42 enum chain_mode {
43 	CHAIN_NONE,
44 	CHAIN_FLAT,
45 	CHAIN_GRAPH_ABS,
46 	CHAIN_GRAPH_REL
47 };
48 
49 enum chain_order {
50 	ORDER_CALLER,
51 	ORDER_CALLEE
52 };
53 
54 struct callchain_node {
55 	struct callchain_node	*parent;
56 	struct list_head	val;
57 	struct rb_node		rb_node_in; /* to insert nodes in an rbtree */
58 	struct rb_node		rb_node;    /* to sort nodes in an output tree */
59 	struct rb_root		rb_root_in; /* input tree of children */
60 	struct rb_root		rb_root;    /* sorted output tree of children */
61 	unsigned int		val_nr;
62 	u64			hit;
63 	u64			children_hit;
64 };
65 
66 struct callchain_root {
67 	u64			max_depth;
68 	struct callchain_node	node;
69 };
70 
71 struct callchain_param;
72 
73 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
74 				 u64, struct callchain_param *);
75 
76 enum chain_key {
77 	CCKEY_FUNCTION,
78 	CCKEY_ADDRESS
79 };
80 
81 struct callchain_param {
82 	bool			enabled;
83 	enum perf_call_graph_mode record_mode;
84 	u32			dump_size;
85 	enum chain_mode 	mode;
86 	u32			print_limit;
87 	double			min_percent;
88 	sort_chain_func_t	sort;
89 	enum chain_order	order;
90 	bool			order_set;
91 	enum chain_key		key;
92 	bool			branch_callstack;
93 };
94 
95 extern struct callchain_param callchain_param;
96 
97 struct callchain_list {
98 	u64			ip;
99 	struct map_symbol	ms;
100 	struct /* for TUI */ {
101 		bool		unfolded;
102 		bool		has_children;
103 	};
104 	char		       *srcline;
105 	struct list_head	list;
106 };
107 
108 /*
109  * A callchain cursor is a single linked list that
110  * let one feed a callchain progressively.
111  * It keeps persistent allocated entries to minimize
112  * allocations.
113  */
114 struct callchain_cursor_node {
115 	u64				ip;
116 	struct map			*map;
117 	struct symbol			*sym;
118 	struct callchain_cursor_node	*next;
119 };
120 
121 struct callchain_cursor {
122 	u64				nr;
123 	struct callchain_cursor_node	*first;
124 	struct callchain_cursor_node	**last;
125 	u64				pos;
126 	struct callchain_cursor_node	*curr;
127 };
128 
129 extern __thread struct callchain_cursor callchain_cursor;
130 
callchain_init(struct callchain_root * root)131 static inline void callchain_init(struct callchain_root *root)
132 {
133 	INIT_LIST_HEAD(&root->node.val);
134 
135 	root->node.parent = NULL;
136 	root->node.hit = 0;
137 	root->node.children_hit = 0;
138 	root->node.rb_root_in = RB_ROOT;
139 	root->max_depth = 0;
140 }
141 
callchain_cumul_hits(struct callchain_node * node)142 static inline u64 callchain_cumul_hits(struct callchain_node *node)
143 {
144 	return node->hit + node->children_hit;
145 }
146 
147 int callchain_register_param(struct callchain_param *param);
148 int callchain_append(struct callchain_root *root,
149 		     struct callchain_cursor *cursor,
150 		     u64 period);
151 
152 int callchain_merge(struct callchain_cursor *cursor,
153 		    struct callchain_root *dst, struct callchain_root *src);
154 
155 /*
156  * Initialize a cursor before adding entries inside, but keep
157  * the previously allocated entries as a cache.
158  */
callchain_cursor_reset(struct callchain_cursor * cursor)159 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
160 {
161 	cursor->nr = 0;
162 	cursor->last = &cursor->first;
163 }
164 
165 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
166 			    struct map *map, struct symbol *sym);
167 
168 /* Close a cursor writing session. Initialize for the reader */
callchain_cursor_commit(struct callchain_cursor * cursor)169 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
170 {
171 	cursor->curr = cursor->first;
172 	cursor->pos = 0;
173 }
174 
175 /* Cursor reading iteration helpers */
176 static inline struct callchain_cursor_node *
callchain_cursor_current(struct callchain_cursor * cursor)177 callchain_cursor_current(struct callchain_cursor *cursor)
178 {
179 	if (cursor->pos == cursor->nr)
180 		return NULL;
181 
182 	return cursor->curr;
183 }
184 
callchain_cursor_advance(struct callchain_cursor * cursor)185 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
186 {
187 	cursor->curr = cursor->curr->next;
188 	cursor->pos++;
189 }
190 
191 struct option;
192 struct hist_entry;
193 
194 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
195 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
196 
197 int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent,
198 			      struct perf_evsel *evsel, struct addr_location *al,
199 			      int max_stack);
200 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
201 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
202 			bool hide_unresolved);
203 
204 extern const char record_callchain_help[];
205 extern int parse_callchain_record(const char *arg, struct callchain_param *param);
206 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
207 int parse_callchain_report_opt(const char *arg);
208 int parse_callchain_top_opt(const char *arg);
209 int perf_callchain_config(const char *var, const char *value);
210 
callchain_cursor_snapshot(struct callchain_cursor * dest,struct callchain_cursor * src)211 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
212 					     struct callchain_cursor *src)
213 {
214 	*dest = *src;
215 
216 	dest->first = src->curr;
217 	dest->nr -= src->pos;
218 }
219 
220 #ifdef HAVE_SKIP_CALLCHAIN_IDX
221 extern int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
222 #else
arch_skip_callchain_idx(struct thread * thread __maybe_unused,struct ip_callchain * chain __maybe_unused)223 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
224 			struct ip_callchain *chain __maybe_unused)
225 {
226 	return -1;
227 }
228 #endif
229 
230 char *callchain_list__sym_name(struct callchain_list *cl,
231 			       char *bf, size_t bfsize, bool show_dso);
232 
233 void free_callchain(struct callchain_root *root);
234 
235 #endif	/* __PERF_CALLCHAIN_H */
236