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