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