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