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; | |
7b644f9a | 16 | |
76a26549 NK |
17 | #define HELP_PAD "\t\t\t\t" |
18 | ||
19 | #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n" | |
21cf6284 | 20 | |
76a26549 | 21 | # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n" |
21cf6284 | 22 | |
76a26549 NK |
23 | #define RECORD_SIZE_HELP \ |
24 | HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \ | |
25 | HELP_PAD "\t\tdefault: 8192 (bytes)\n" | |
26 | ||
27 | #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP | |
28 | ||
29 | #define CALLCHAIN_REPORT_HELP \ | |
26e77924 | 30 | HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \ |
76a26549 NK |
31 | HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \ |
32 | HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \ | |
33 | HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \ | |
34 | HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \ | |
f2af0086 NK |
35 | HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \ |
36 | HELP_PAD "value:\t\tcall graph value (percent|period|count)\n" | |
21cf6284 | 37 | |
2c83bc08 JO |
38 | enum perf_call_graph_mode { |
39 | CALLCHAIN_NONE, | |
40 | CALLCHAIN_FP, | |
41 | CALLCHAIN_DWARF, | |
aad2b21c | 42 | CALLCHAIN_LBR, |
2c83bc08 JO |
43 | CALLCHAIN_MAX |
44 | }; | |
45 | ||
4eb3e478 | 46 | enum chain_mode { |
b1a88349 | 47 | CHAIN_NONE, |
805d127d FW |
48 | CHAIN_FLAT, |
49 | CHAIN_GRAPH_ABS, | |
26e77924 NK |
50 | CHAIN_GRAPH_REL, |
51 | CHAIN_FOLDED, | |
4eb3e478 | 52 | }; |
8cb76d99 | 53 | |
d797fdc5 SL |
54 | enum chain_order { |
55 | ORDER_CALLER, | |
56 | ORDER_CALLEE | |
57 | }; | |
58 | ||
8cb76d99 FW |
59 | struct callchain_node { |
60 | struct callchain_node *parent; | |
f37a291c | 61 | struct list_head val; |
4b3a3212 | 62 | struct list_head parent_val; |
e369517c NK |
63 | struct rb_node rb_node_in; /* to insert nodes in an rbtree */ |
64 | struct rb_node rb_node; /* to sort nodes in an output tree */ | |
65 | struct rb_root rb_root_in; /* input tree of children */ | |
66 | struct rb_root rb_root; /* sorted output tree of children */ | |
f37a291c | 67 | unsigned int val_nr; |
5e47f8ff NK |
68 | unsigned int count; |
69 | unsigned int children_count; | |
f37a291c | 70 | u64 hit; |
1953287b | 71 | u64 children_hit; |
8cb76d99 FW |
72 | }; |
73 | ||
d2009c51 FW |
74 | struct callchain_root { |
75 | u64 max_depth; | |
76 | struct callchain_node node; | |
77 | }; | |
78 | ||
805d127d FW |
79 | struct callchain_param; |
80 | ||
d2009c51 | 81 | typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *, |
805d127d FW |
82 | u64, struct callchain_param *); |
83 | ||
99571ab3 AK |
84 | enum chain_key { |
85 | CCKEY_FUNCTION, | |
5dfa210e MW |
86 | CCKEY_ADDRESS, |
87 | CCKEY_SRCLINE | |
99571ab3 AK |
88 | }; |
89 | ||
f2af0086 NK |
90 | enum chain_value { |
91 | CCVAL_PERCENT, | |
92 | CCVAL_PERIOD, | |
93 | CCVAL_COUNT, | |
94 | }; | |
95 | ||
eabad8c6 ACM |
96 | extern bool dwarf_callchain_users; |
97 | ||
805d127d | 98 | struct callchain_param { |
72a128aa NK |
99 | bool enabled; |
100 | enum perf_call_graph_mode record_mode; | |
101 | u32 dump_size; | |
805d127d | 102 | enum chain_mode mode; |
792d48b4 | 103 | u16 max_stack; |
232a5c94 | 104 | u32 print_limit; |
805d127d FW |
105 | double min_percent; |
106 | sort_chain_func_t sort; | |
d797fdc5 | 107 | enum chain_order order; |
792aeafa | 108 | bool order_set; |
99571ab3 | 109 | enum chain_key key; |
8b7bad58 | 110 | bool branch_callstack; |
f2af0086 | 111 | enum chain_value value; |
805d127d FW |
112 | }; |
113 | ||
8f651eae | 114 | extern struct callchain_param callchain_param; |
347ca878 | 115 | extern struct callchain_param callchain_param_default; |
8f651eae | 116 | |
8cb76d99 | 117 | struct callchain_list { |
f37a291c | 118 | u64 ip; |
b3c9ac08 | 119 | struct map_symbol ms; |
3698dab1 NK |
120 | struct /* for TUI */ { |
121 | bool unfolded; | |
122 | bool has_children; | |
123 | }; | |
3dd029ef | 124 | u64 branch_count; |
a3366db0 | 125 | u64 from_count; |
3dd029ef JY |
126 | u64 predicted_count; |
127 | u64 abort_count; | |
128 | u64 cycles_count; | |
129 | u64 iter_count; | |
c4ee0625 | 130 | u64 iter_cycles; |
b851dd49 | 131 | struct branch_type_stat brtype_stat; |
40a342cd | 132 | const char *srcline; |
8cb76d99 FW |
133 | struct list_head list; |
134 | }; | |
135 | ||
1b3a0e95 FW |
136 | /* |
137 | * A callchain cursor is a single linked list that | |
138 | * let one feed a callchain progressively. | |
3fd44cd4 | 139 | * It keeps persistent allocated entries to minimize |
1b3a0e95 FW |
140 | * allocations. |
141 | */ | |
142 | struct callchain_cursor_node { | |
143 | u64 ip; | |
5f0fef8a | 144 | struct map_symbol ms; |
40a342cd | 145 | const char *srcline; |
7f1d3931 KL |
146 | /* Indicate valid cursor node for LBR stitch */ |
147 | bool valid; | |
148 | ||
410024db JY |
149 | bool branch; |
150 | struct branch_flags branch_flags; | |
b851dd49 | 151 | u64 branch_from; |
410024db | 152 | int nr_loop_iter; |
c4ee0625 | 153 | u64 iter_cycles; |
1b3a0e95 FW |
154 | struct callchain_cursor_node *next; |
155 | }; | |
156 | ||
157 | struct callchain_cursor { | |
158 | u64 nr; | |
159 | struct callchain_cursor_node *first; | |
160 | struct callchain_cursor_node **last; | |
161 | u64 pos; | |
162 | struct callchain_cursor_node *curr; | |
163 | }; | |
164 | ||
47260645 NK |
165 | extern __thread struct callchain_cursor callchain_cursor; |
166 | ||
d2009c51 | 167 | static inline void callchain_init(struct callchain_root *root) |
8cb76d99 | 168 | { |
d2009c51 | 169 | INIT_LIST_HEAD(&root->node.val); |
646a6e84 | 170 | INIT_LIST_HEAD(&root->node.parent_val); |
97aa1052 | 171 | |
d2009c51 FW |
172 | root->node.parent = NULL; |
173 | root->node.hit = 0; | |
98ee74a7 | 174 | root->node.children_hit = 0; |
e369517c | 175 | root->node.rb_root_in = RB_ROOT; |
d2009c51 | 176 | root->max_depth = 0; |
8cb76d99 FW |
177 | } |
178 | ||
f08c3154 | 179 | static inline u64 callchain_cumul_hits(struct callchain_node *node) |
1953287b FW |
180 | { |
181 | return node->hit + node->children_hit; | |
182 | } | |
183 | ||
5e47f8ff NK |
184 | static inline unsigned callchain_cumul_counts(struct callchain_node *node) |
185 | { | |
186 | return node->count + node->children_count; | |
187 | } | |
188 | ||
16537f13 | 189 | int callchain_register_param(struct callchain_param *param); |
1b3a0e95 FW |
190 | int callchain_append(struct callchain_root *root, |
191 | struct callchain_cursor *cursor, | |
192 | u64 period); | |
193 | ||
194 | int callchain_merge(struct callchain_cursor *cursor, | |
195 | struct callchain_root *dst, struct callchain_root *src); | |
139633c6 | 196 | |
7b644f9a | 197 | void callchain_cursor_reset(struct callchain_cursor *cursor); |
1b3a0e95 FW |
198 | |
199 | int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, | |
5f0fef8a | 200 | struct map_symbol *ms, |
410024db | 201 | bool branch, struct branch_flags *flags, |
40a342cd MW |
202 | int nr_loop_iter, u64 iter_cycles, u64 branch_from, |
203 | const char *srcline); | |
1b3a0e95 FW |
204 | |
205 | /* Close a cursor writing session. Initialize for the reader */ | |
206 | static inline void callchain_cursor_commit(struct callchain_cursor *cursor) | |
207 | { | |
208 | cursor->curr = cursor->first; | |
209 | cursor->pos = 0; | |
210 | } | |
211 | ||
212 | /* Cursor reading iteration helpers */ | |
213 | static inline struct callchain_cursor_node * | |
214 | callchain_cursor_current(struct callchain_cursor *cursor) | |
215 | { | |
216 | if (cursor->pos == cursor->nr) | |
217 | return NULL; | |
218 | ||
219 | return cursor->curr; | |
220 | } | |
221 | ||
222 | static inline void callchain_cursor_advance(struct callchain_cursor *cursor) | |
223 | { | |
224 | cursor->curr = cursor->curr->next; | |
225 | cursor->pos++; | |
226 | } | |
75d9a108 | 227 | |
571f1eb9 NK |
228 | int callchain_cursor__copy(struct callchain_cursor *dst, |
229 | struct callchain_cursor *src); | |
230 | ||
75d9a108 | 231 | struct option; |
2dc9fb1a | 232 | struct hist_entry; |
75d9a108 ACM |
233 | |
234 | int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset); | |
09b0fd45 JO |
235 | int record_callchain_opt(const struct option *opt, const char *arg, int unset); |
236 | ||
0883e820 ACM |
237 | struct record_opts; |
238 | ||
239 | int record_opts__parse_callchain(struct record_opts *record, | |
240 | struct callchain_param *callchain, | |
241 | const char *arg, bool unset); | |
242 | ||
91d7b2de ACM |
243 | int sample__resolve_callchain(struct perf_sample *sample, |
244 | struct callchain_cursor *cursor, struct symbol **parent, | |
32dcd021 | 245 | struct evsel *evsel, struct addr_location *al, |
2dc9fb1a NK |
246 | int max_stack); |
247 | int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample); | |
c7405d85 NK |
248 | int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node, |
249 | bool hide_unresolved); | |
2dc9fb1a | 250 | |
75d9a108 | 251 | extern const char record_callchain_help[]; |
3938bad4 | 252 | int parse_callchain_record(const char *arg, struct callchain_param *param); |
c3a6a8c4 | 253 | int parse_callchain_record_opt(const char *arg, struct callchain_param *param); |
cff6bb46 | 254 | int parse_callchain_report_opt(const char *arg); |
a2c10d39 | 255 | int parse_callchain_top_opt(const char *arg); |
2b9240ca | 256 | int perf_callchain_config(const char *var, const char *value); |
be1f13e3 NK |
257 | |
258 | static inline void callchain_cursor_snapshot(struct callchain_cursor *dest, | |
259 | struct callchain_cursor *src) | |
260 | { | |
261 | *dest = *src; | |
262 | ||
263 | dest->first = src->curr; | |
264 | dest->nr -= src->pos; | |
265 | } | |
a60335ba SB |
266 | |
267 | #ifdef HAVE_SKIP_CALLCHAIN_IDX | |
3938bad4 | 268 | int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain); |
a60335ba | 269 | #else |
bb871a9c | 270 | static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused, |
a60335ba SB |
271 | struct ip_callchain *chain __maybe_unused) |
272 | { | |
273 | return -1; | |
274 | } | |
275 | #endif | |
276 | ||
2989ccaa AK |
277 | char *callchain_list__sym_name(struct callchain_list *cl, |
278 | char *bf, size_t bfsize, bool show_dso); | |
5ab250ca NK |
279 | char *callchain_node__scnprintf_value(struct callchain_node *node, |
280 | char *bf, size_t bfsize, u64 total); | |
281 | int callchain_node__fprintf_value(struct callchain_node *node, | |
282 | FILE *fp, u64 total); | |
2989ccaa | 283 | |
c4ee0625 | 284 | int callchain_list_counts__printf_value(struct callchain_list *clist, |
3dd029ef JY |
285 | FILE *fp, char *bf, int bfsize); |
286 | ||
d114960c | 287 | void free_callchain(struct callchain_root *root); |
42b276a2 | 288 | void decay_callchain(struct callchain_root *root); |
4b3a3212 | 289 | int callchain_node__make_parent_list(struct callchain_node *node); |
d114960c | 290 | |
3dd029ef JY |
291 | int callchain_branch_counts(struct callchain_root *root, |
292 | u64 *branch_count, u64 *predicted_count, | |
293 | u64 *abort_count, u64 *cycles_count); | |
294 | ||
8b40f521 | 295 | #endif /* __PERF_CALLCHAIN_H */ |