Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
8cb76d99 FW |
2 | #ifndef __PERF_CALLCHAIN_H |
3 | #define __PERF_CALLCHAIN_H | |
4 | ||
5da50258 | 5 | #include <linux/list.h> |
43cbcd8a | 6 | #include <linux/rbtree.h> |
9f4e8ff2 | 7 | #include "map_symbol.h" |
b851dd49 | 8 | #include "branch.h" |
8cb76d99 | 9 | |
9c9e754f | 10 | struct addr_location; |
4cb3c6d5 | 11 | struct evsel; |
9c9e754f | 12 | struct ip_callchain; |
7b644f9a | 13 | struct map; |
9c9e754f ACM |
14 | struct perf_sample; |
15 | struct thread; | |
28904f4d | 16 | struct hists; |
7b644f9a | 17 | |
76a26549 NK |
18 | #define HELP_PAD "\t\t\t\t" |
19 | ||
20 | #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n" | |
21cf6284 | 21 | |
76a26549 | 22 | # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n" |
21cf6284 | 23 | |
76a26549 NK |
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 \ | |
26e77924 | 31 | HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \ |
76a26549 NK |
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" \ | |
f2af0086 NK |
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" | |
21cf6284 | 38 | |
2c83bc08 JO |
39 | enum perf_call_graph_mode { |
40 | CALLCHAIN_NONE, | |
41 | CALLCHAIN_FP, | |
42 | CALLCHAIN_DWARF, | |
aad2b21c | 43 | CALLCHAIN_LBR, |
2c83bc08 JO |
44 | CALLCHAIN_MAX |
45 | }; | |
46 | ||
4eb3e478 | 47 | enum chain_mode { |
b1a88349 | 48 | CHAIN_NONE, |
805d127d FW |
49 | CHAIN_FLAT, |
50 | CHAIN_GRAPH_ABS, | |
26e77924 NK |
51 | CHAIN_GRAPH_REL, |
52 | CHAIN_FOLDED, | |
4eb3e478 | 53 | }; |
8cb76d99 | 54 | |
d797fdc5 SL |
55 | enum chain_order { |
56 | ORDER_CALLER, | |
57 | ORDER_CALLEE | |
58 | }; | |
59 | ||
8cb76d99 FW |
60 | struct callchain_node { |
61 | struct callchain_node *parent; | |
f37a291c | 62 | struct list_head val; |
4b3a3212 | 63 | struct list_head parent_val; |
e369517c NK |
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 */ | |
f37a291c | 68 | unsigned int val_nr; |
5e47f8ff NK |
69 | unsigned int count; |
70 | unsigned int children_count; | |
f37a291c | 71 | u64 hit; |
1953287b | 72 | u64 children_hit; |
8cb76d99 FW |
73 | }; |
74 | ||
d2009c51 FW |
75 | struct callchain_root { |
76 | u64 max_depth; | |
77 | struct callchain_node node; | |
78 | }; | |
79 | ||
805d127d FW |
80 | struct callchain_param; |
81 | ||
d2009c51 | 82 | typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *, |
805d127d FW |
83 | u64, struct callchain_param *); |
84 | ||
99571ab3 AK |
85 | enum chain_key { |
86 | CCKEY_FUNCTION, | |
5dfa210e MW |
87 | CCKEY_ADDRESS, |
88 | CCKEY_SRCLINE | |
99571ab3 AK |
89 | }; |
90 | ||
f2af0086 NK |
91 | enum chain_value { |
92 | CCVAL_PERCENT, | |
93 | CCVAL_PERIOD, | |
94 | CCVAL_COUNT, | |
95 | }; | |
96 | ||
eabad8c6 ACM |
97 | extern bool dwarf_callchain_users; |
98 | ||
805d127d | 99 | struct callchain_param { |
72a128aa NK |
100 | bool enabled; |
101 | enum perf_call_graph_mode record_mode; | |
102 | u32 dump_size; | |
805d127d | 103 | enum chain_mode mode; |
792d48b4 | 104 | u16 max_stack; |
232a5c94 | 105 | u32 print_limit; |
805d127d FW |
106 | double min_percent; |
107 | sort_chain_func_t sort; | |
d797fdc5 | 108 | enum chain_order order; |
792aeafa | 109 | bool order_set; |
99571ab3 | 110 | enum chain_key key; |
8b7bad58 | 111 | bool branch_callstack; |
f2af0086 | 112 | enum chain_value value; |
805d127d FW |
113 | }; |
114 | ||
8f651eae | 115 | extern struct callchain_param callchain_param; |
347ca878 | 116 | extern struct callchain_param callchain_param_default; |
8f651eae | 117 | |
8cb76d99 | 118 | struct callchain_list { |
f37a291c | 119 | u64 ip; |
b3c9ac08 | 120 | struct map_symbol ms; |
3698dab1 NK |
121 | struct /* for TUI */ { |
122 | bool unfolded; | |
123 | bool has_children; | |
124 | }; | |
3dd029ef | 125 | u64 branch_count; |
a3366db0 | 126 | u64 from_count; |
3dd029ef JY |
127 | u64 predicted_count; |
128 | u64 abort_count; | |
129 | u64 cycles_count; | |
130 | u64 iter_count; | |
c4ee0625 | 131 | u64 iter_cycles; |
b851dd49 | 132 | struct branch_type_stat brtype_stat; |
40a342cd | 133 | const char *srcline; |
8cb76d99 FW |
134 | struct list_head list; |
135 | }; | |
136 | ||
1b3a0e95 FW |
137 | /* |
138 | * A callchain cursor is a single linked list that | |
139 | * let one feed a callchain progressively. | |
3fd44cd4 | 140 | * It keeps persistent allocated entries to minimize |
1b3a0e95 FW |
141 | * allocations. |
142 | */ | |
143 | struct callchain_cursor_node { | |
144 | u64 ip; | |
5f0fef8a | 145 | struct map_symbol ms; |
40a342cd | 146 | const char *srcline; |
7f1d3931 KL |
147 | /* Indicate valid cursor node for LBR stitch */ |
148 | bool valid; | |
149 | ||
410024db JY |
150 | bool branch; |
151 | struct branch_flags branch_flags; | |
b851dd49 | 152 | u64 branch_from; |
410024db | 153 | int nr_loop_iter; |
c4ee0625 | 154 | u64 iter_cycles; |
1b3a0e95 FW |
155 | struct callchain_cursor_node *next; |
156 | }; | |
157 | ||
ff165628 KL |
158 | struct stitch_list { |
159 | struct list_head node; | |
160 | struct callchain_cursor_node cursor; | |
161 | }; | |
162 | ||
1b3a0e95 FW |
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 | ||
47260645 NK |
171 | extern __thread struct callchain_cursor callchain_cursor; |
172 | ||
d2009c51 | 173 | static inline void callchain_init(struct callchain_root *root) |
8cb76d99 | 174 | { |
d2009c51 | 175 | INIT_LIST_HEAD(&root->node.val); |
646a6e84 | 176 | INIT_LIST_HEAD(&root->node.parent_val); |
97aa1052 | 177 | |
d2009c51 FW |
178 | root->node.parent = NULL; |
179 | root->node.hit = 0; | |
98ee74a7 | 180 | root->node.children_hit = 0; |
e369517c | 181 | root->node.rb_root_in = RB_ROOT; |
d2009c51 | 182 | root->max_depth = 0; |
8cb76d99 FW |
183 | } |
184 | ||
f08c3154 | 185 | static inline u64 callchain_cumul_hits(struct callchain_node *node) |
1953287b FW |
186 | { |
187 | return node->hit + node->children_hit; | |
188 | } | |
189 | ||
5e47f8ff NK |
190 | static inline unsigned callchain_cumul_counts(struct callchain_node *node) |
191 | { | |
192 | return node->count + node->children_count; | |
193 | } | |
194 | ||
16537f13 | 195 | int callchain_register_param(struct callchain_param *param); |
1b3a0e95 FW |
196 | int callchain_append(struct callchain_root *root, |
197 | struct callchain_cursor *cursor, | |
198 | u64 period); | |
199 | ||
200 | int callchain_merge(struct callchain_cursor *cursor, | |
201 | struct callchain_root *dst, struct callchain_root *src); | |
139633c6 | 202 | |
7b644f9a | 203 | void callchain_cursor_reset(struct callchain_cursor *cursor); |
1b3a0e95 FW |
204 | |
205 | int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, | |
5f0fef8a | 206 | struct map_symbol *ms, |
410024db | 207 | bool branch, struct branch_flags *flags, |
40a342cd MW |
208 | int nr_loop_iter, u64 iter_cycles, u64 branch_from, |
209 | const char *srcline); | |
1b3a0e95 FW |
210 | |
211 | /* Close a cursor writing session. Initialize for the reader */ | |
212 | static inline void callchain_cursor_commit(struct callchain_cursor *cursor) | |
213 | { | |
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->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 | } | |
75d9a108 | 233 | |
571f1eb9 NK |
234 | int callchain_cursor__copy(struct callchain_cursor *dst, |
235 | struct callchain_cursor *src); | |
236 | ||
75d9a108 | 237 | struct option; |
2dc9fb1a | 238 | struct hist_entry; |
75d9a108 ACM |
239 | |
240 | int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset); | |
09b0fd45 JO |
241 | int record_callchain_opt(const struct option *opt, const char *arg, int unset); |
242 | ||
0883e820 ACM |
243 | struct record_opts; |
244 | ||
245 | int record_opts__parse_callchain(struct record_opts *record, | |
246 | struct callchain_param *callchain, | |
247 | const char *arg, bool unset); | |
248 | ||
91d7b2de ACM |
249 | int sample__resolve_callchain(struct perf_sample *sample, |
250 | struct callchain_cursor *cursor, struct symbol **parent, | |
32dcd021 | 251 | struct evsel *evsel, struct addr_location *al, |
2dc9fb1a NK |
252 | int max_stack); |
253 | int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample); | |
c7405d85 NK |
254 | int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node, |
255 | bool hide_unresolved); | |
2dc9fb1a | 256 | |
75d9a108 | 257 | extern const char record_callchain_help[]; |
3938bad4 | 258 | int parse_callchain_record(const char *arg, struct callchain_param *param); |
c3a6a8c4 | 259 | int parse_callchain_record_opt(const char *arg, struct callchain_param *param); |
cff6bb46 | 260 | int parse_callchain_report_opt(const char *arg); |
a2c10d39 | 261 | int parse_callchain_top_opt(const char *arg); |
2b9240ca | 262 | int perf_callchain_config(const char *var, const char *value); |
be1f13e3 NK |
263 | |
264 | static inline void callchain_cursor_snapshot(struct callchain_cursor *dest, | |
265 | struct callchain_cursor *src) | |
266 | { | |
267 | *dest = *src; | |
268 | ||
269 | dest->first = src->curr; | |
270 | dest->nr -= src->pos; | |
271 | } | |
a60335ba SB |
272 | |
273 | #ifdef HAVE_SKIP_CALLCHAIN_IDX | |
3938bad4 | 274 | int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain); |
a60335ba | 275 | #else |
bb871a9c | 276 | static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused, |
a60335ba SB |
277 | struct ip_callchain *chain __maybe_unused) |
278 | { | |
279 | return -1; | |
280 | } | |
281 | #endif | |
282 | ||
7248e308 AT |
283 | void arch__add_leaf_frame_record_opts(struct record_opts *opts); |
284 | ||
2989ccaa AK |
285 | char *callchain_list__sym_name(struct callchain_list *cl, |
286 | char *bf, size_t bfsize, bool show_dso); | |
5ab250ca NK |
287 | char *callchain_node__scnprintf_value(struct callchain_node *node, |
288 | char *bf, size_t bfsize, u64 total); | |
289 | int callchain_node__fprintf_value(struct callchain_node *node, | |
290 | FILE *fp, u64 total); | |
2989ccaa | 291 | |
c4ee0625 | 292 | int callchain_list_counts__printf_value(struct callchain_list *clist, |
3dd029ef JY |
293 | FILE *fp, char *bf, int bfsize); |
294 | ||
d114960c | 295 | void free_callchain(struct callchain_root *root); |
42b276a2 | 296 | void decay_callchain(struct callchain_root *root); |
4b3a3212 | 297 | int callchain_node__make_parent_list(struct callchain_node *node); |
d114960c | 298 | |
3dd029ef JY |
299 | int callchain_branch_counts(struct callchain_root *root, |
300 | u64 *branch_count, u64 *predicted_count, | |
301 | u64 *abort_count, u64 *cycles_count); | |
302 | ||
0d71a2b2 | 303 | void callchain_param_setup(u64 sample_type); |
47ef8398 JY |
304 | |
305 | bool callchain_cnode_matched(struct callchain_node *base_cnode, | |
306 | struct callchain_node *pair_cnode); | |
307 | ||
28904f4d JY |
308 | u64 callchain_total_hits(struct hists *hists); |
309 | ||
5bbd6bad JY |
310 | s64 callchain_avg_cycles(struct callchain_node *cnode); |
311 | ||
8b40f521 | 312 | #endif /* __PERF_CALLCHAIN_H */ |