1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_CALLCHAIN_H
3 #define __PERF_CALLCHAIN_H
4
5 #include "../perf.h"
6 #include <linux/list.h>
7 #include <linux/rbtree.h>
8 #include "event.h"
9 #include "map.h"
10 #include "symbol.h"
11 #include "branch.h"
12
13 #define HELP_PAD "\t\t\t\t"
14
15 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
16
17 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
18
19 #define RECORD_SIZE_HELP \
20 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
21 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
22
23 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
24
25 #define CALLCHAIN_REPORT_HELP \
26 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
27 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
28 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
29 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
30 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
31 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
32 HELP_PAD "value:\t\tcall graph value (percent|period|count)\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 CHAIN_FOLDED,
48 };
49
50 enum chain_order {
51 ORDER_CALLER,
52 ORDER_CALLEE
53 };
54
55 struct callchain_node {
56 struct callchain_node *parent;
57 struct list_head val;
58 struct list_head parent_val;
59 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
60 struct rb_node rb_node; /* to sort nodes in an output tree */
61 struct rb_root rb_root_in; /* input tree of children */
62 struct rb_root rb_root; /* sorted output tree of children */
63 unsigned int val_nr;
64 unsigned int count;
65 unsigned int children_count;
66 u64 hit;
67 u64 children_hit;
68 };
69
70 struct callchain_root {
71 u64 max_depth;
72 struct callchain_node node;
73 };
74
75 struct callchain_param;
76
77 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
78 u64, struct callchain_param *);
79
80 enum chain_key {
81 CCKEY_FUNCTION,
82 CCKEY_ADDRESS,
83 CCKEY_SRCLINE
84 };
85
86 enum chain_value {
87 CCVAL_PERCENT,
88 CCVAL_PERIOD,
89 CCVAL_COUNT,
90 };
91
92 extern bool dwarf_callchain_users;
93
94 struct callchain_param {
95 bool enabled;
96 enum perf_call_graph_mode record_mode;
97 u32 dump_size;
98 enum chain_mode mode;
99 u16 max_stack;
100 u32 print_limit;
101 double min_percent;
102 sort_chain_func_t sort;
103 enum chain_order order;
104 bool order_set;
105 enum chain_key key;
106 bool branch_callstack;
107 enum chain_value value;
108 };
109
110 extern struct callchain_param callchain_param;
111 extern struct callchain_param callchain_param_default;
112
113 struct callchain_list {
114 u64 ip;
115 struct map_symbol ms;
116 struct /* for TUI */ {
117 bool unfolded;
118 bool has_children;
119 };
120 u64 branch_count;
121 u64 predicted_count;
122 u64 abort_count;
123 u64 cycles_count;
124 u64 iter_count;
125 u64 iter_cycles;
126 struct branch_type_stat brtype_stat;
127 char *srcline;
128 struct list_head list;
129 };
130
131 /*
132 * A callchain cursor is a single linked list that
133 * let one feed a callchain progressively.
134 * It keeps persistent allocated entries to minimize
135 * allocations.
136 */
137 struct callchain_cursor_node {
138 u64 ip;
139 struct map *map;
140 struct symbol *sym;
141 bool branch;
142 struct branch_flags branch_flags;
143 u64 branch_from;
144 int nr_loop_iter;
145 u64 iter_cycles;
146 struct callchain_cursor_node *next;
147 };
148
149 struct callchain_cursor {
150 u64 nr;
151 struct callchain_cursor_node *first;
152 struct callchain_cursor_node **last;
153 u64 pos;
154 struct callchain_cursor_node *curr;
155 };
156
157 extern __thread struct callchain_cursor callchain_cursor;
158
callchain_init(struct callchain_root * root)159 static inline void callchain_init(struct callchain_root *root)
160 {
161 INIT_LIST_HEAD(&root->node.val);
162 INIT_LIST_HEAD(&root->node.parent_val);
163
164 root->node.parent = NULL;
165 root->node.hit = 0;
166 root->node.children_hit = 0;
167 root->node.rb_root_in = RB_ROOT;
168 root->max_depth = 0;
169 }
170
callchain_cumul_hits(struct callchain_node * node)171 static inline u64 callchain_cumul_hits(struct callchain_node *node)
172 {
173 return node->hit + node->children_hit;
174 }
175
callchain_cumul_counts(struct callchain_node * node)176 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
177 {
178 return node->count + node->children_count;
179 }
180
181 int callchain_register_param(struct callchain_param *param);
182 int callchain_append(struct callchain_root *root,
183 struct callchain_cursor *cursor,
184 u64 period);
185
186 int callchain_merge(struct callchain_cursor *cursor,
187 struct callchain_root *dst, struct callchain_root *src);
188
189 /*
190 * Initialize a cursor before adding entries inside, but keep
191 * the previously allocated entries as a cache.
192 */
callchain_cursor_reset(struct callchain_cursor * cursor)193 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
194 {
195 struct callchain_cursor_node *node;
196
197 cursor->nr = 0;
198 cursor->last = &cursor->first;
199
200 for (node = cursor->first; node != NULL; node = node->next)
201 map__zput(node->map);
202 }
203
204 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
205 struct map *map, struct symbol *sym,
206 bool branch, struct branch_flags *flags,
207 int nr_loop_iter, u64 iter_cycles, u64 branch_from);
208
209 /* Close a cursor writing session. Initialize for the reader */
callchain_cursor_commit(struct callchain_cursor * cursor)210 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
211 {
212 cursor->curr = cursor->first;
213 cursor->pos = 0;
214 }
215
216 /* Cursor reading iteration helpers */
217 static inline struct callchain_cursor_node *
callchain_cursor_current(struct callchain_cursor * cursor)218 callchain_cursor_current(struct callchain_cursor *cursor)
219 {
220 if (cursor->pos == cursor->nr)
221 return NULL;
222
223 return cursor->curr;
224 }
225
callchain_cursor_advance(struct callchain_cursor * cursor)226 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
227 {
228 cursor->curr = cursor->curr->next;
229 cursor->pos++;
230 }
231
232 int callchain_cursor__copy(struct callchain_cursor *dst,
233 struct callchain_cursor *src);
234
235 struct option;
236 struct hist_entry;
237
238 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
239 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
240
241 struct record_opts;
242
243 int record_opts__parse_callchain(struct record_opts *record,
244 struct callchain_param *callchain,
245 const char *arg, bool unset);
246
247 int sample__resolve_callchain(struct perf_sample *sample,
248 struct callchain_cursor *cursor, struct symbol **parent,
249 struct perf_evsel *evsel, struct addr_location *al,
250 int max_stack);
251 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
252 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
253 bool hide_unresolved);
254
255 extern const char record_callchain_help[];
256 int parse_callchain_record(const char *arg, struct callchain_param *param);
257 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
258 int parse_callchain_report_opt(const char *arg);
259 int parse_callchain_top_opt(const char *arg);
260 int perf_callchain_config(const char *var, const char *value);
261
callchain_cursor_snapshot(struct callchain_cursor * dest,struct callchain_cursor * src)262 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
263 struct callchain_cursor *src)
264 {
265 *dest = *src;
266
267 dest->first = src->curr;
268 dest->nr -= src->pos;
269 }
270
271 #ifdef HAVE_SKIP_CALLCHAIN_IDX
272 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
273 #else
arch_skip_callchain_idx(struct thread * thread __maybe_unused,struct ip_callchain * chain __maybe_unused)274 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
275 struct ip_callchain *chain __maybe_unused)
276 {
277 return -1;
278 }
279 #endif
280
281 char *callchain_list__sym_name(struct callchain_list *cl,
282 char *bf, size_t bfsize, bool show_dso);
283 char *callchain_node__scnprintf_value(struct callchain_node *node,
284 char *bf, size_t bfsize, u64 total);
285 int callchain_node__fprintf_value(struct callchain_node *node,
286 FILE *fp, u64 total);
287
288 int callchain_list_counts__printf_value(struct callchain_list *clist,
289 FILE *fp, char *bf, int bfsize);
290
291 void free_callchain(struct callchain_root *root);
292 void decay_callchain(struct callchain_root *root);
293 int callchain_node__make_parent_list(struct callchain_node *node);
294
295 int callchain_branch_counts(struct callchain_root *root,
296 u64 *branch_count, u64 *predicted_count,
297 u64 *abort_count, u64 *cycles_count);
298
299 #endif /* __PERF_CALLCHAIN_H */
300