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 NK |
13 | |
14 | #ifdef HAVE_DWARF_UNWIND_SUPPORT | |
76a26549 | 15 | # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n" |
21cf6284 | 16 | #else |
76a26549 | 17 | # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|lbr)\n" |
21cf6284 NK |
18 | #endif |
19 | ||
76a26549 NK |
20 | #define RECORD_SIZE_HELP \ |
21 | HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \ | |
22 | HELP_PAD "\t\tdefault: 8192 (bytes)\n" | |
23 | ||
24 | #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP | |
25 | ||
26 | #define CALLCHAIN_REPORT_HELP \ | |
26e77924 | 27 | HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \ |
76a26549 NK |
28 | HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \ |
29 | HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \ | |
30 | HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \ | |
31 | HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \ | |
32 | HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\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; |
e369517c NK |
58 | struct rb_node rb_node_in; /* to insert nodes in an rbtree */ |
59 | struct rb_node rb_node; /* to sort nodes in an output tree */ | |
60 | struct rb_root rb_root_in; /* input tree of children */ | |
61 | struct rb_root rb_root; /* sorted output tree of children */ | |
f37a291c IM |
62 | unsigned int val_nr; |
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 | ||
805d127d | 82 | struct callchain_param { |
72a128aa NK |
83 | bool enabled; |
84 | enum perf_call_graph_mode record_mode; | |
85 | u32 dump_size; | |
805d127d | 86 | enum chain_mode mode; |
232a5c94 | 87 | u32 print_limit; |
805d127d FW |
88 | double min_percent; |
89 | sort_chain_func_t sort; | |
d797fdc5 | 90 | enum chain_order order; |
792aeafa | 91 | bool order_set; |
99571ab3 | 92 | enum chain_key key; |
8b7bad58 | 93 | bool branch_callstack; |
805d127d FW |
94 | }; |
95 | ||
8f651eae ACM |
96 | extern struct callchain_param callchain_param; |
97 | ||
8cb76d99 | 98 | struct callchain_list { |
f37a291c | 99 | u64 ip; |
b3c9ac08 | 100 | struct map_symbol ms; |
3698dab1 NK |
101 | struct /* for TUI */ { |
102 | bool unfolded; | |
103 | bool has_children; | |
104 | }; | |
23f0981b | 105 | char *srcline; |
8cb76d99 FW |
106 | struct list_head list; |
107 | }; | |
108 | ||
1b3a0e95 FW |
109 | /* |
110 | * A callchain cursor is a single linked list that | |
111 | * let one feed a callchain progressively. | |
3fd44cd4 | 112 | * It keeps persistent allocated entries to minimize |
1b3a0e95 FW |
113 | * allocations. |
114 | */ | |
115 | struct callchain_cursor_node { | |
116 | u64 ip; | |
117 | struct map *map; | |
118 | struct symbol *sym; | |
119 | struct callchain_cursor_node *next; | |
120 | }; | |
121 | ||
122 | struct callchain_cursor { | |
123 | u64 nr; | |
124 | struct callchain_cursor_node *first; | |
125 | struct callchain_cursor_node **last; | |
126 | u64 pos; | |
127 | struct callchain_cursor_node *curr; | |
128 | }; | |
129 | ||
47260645 NK |
130 | extern __thread struct callchain_cursor callchain_cursor; |
131 | ||
d2009c51 | 132 | static inline void callchain_init(struct callchain_root *root) |
8cb76d99 | 133 | { |
d2009c51 | 134 | INIT_LIST_HEAD(&root->node.val); |
97aa1052 | 135 | |
d2009c51 FW |
136 | root->node.parent = NULL; |
137 | root->node.hit = 0; | |
98ee74a7 | 138 | root->node.children_hit = 0; |
e369517c | 139 | root->node.rb_root_in = RB_ROOT; |
d2009c51 | 140 | root->max_depth = 0; |
8cb76d99 FW |
141 | } |
142 | ||
f08c3154 | 143 | static inline u64 callchain_cumul_hits(struct callchain_node *node) |
1953287b FW |
144 | { |
145 | return node->hit + node->children_hit; | |
146 | } | |
147 | ||
16537f13 | 148 | int callchain_register_param(struct callchain_param *param); |
1b3a0e95 FW |
149 | int callchain_append(struct callchain_root *root, |
150 | struct callchain_cursor *cursor, | |
151 | u64 period); | |
152 | ||
153 | int callchain_merge(struct callchain_cursor *cursor, | |
154 | struct callchain_root *dst, struct callchain_root *src); | |
139633c6 | 155 | |
1b3a0e95 FW |
156 | /* |
157 | * Initialize a cursor before adding entries inside, but keep | |
158 | * the previously allocated entries as a cache. | |
159 | */ | |
160 | static inline void callchain_cursor_reset(struct callchain_cursor *cursor) | |
161 | { | |
162 | cursor->nr = 0; | |
163 | cursor->last = &cursor->first; | |
164 | } | |
165 | ||
166 | int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, | |
167 | struct map *map, struct symbol *sym); | |
168 | ||
169 | /* Close a cursor writing session. Initialize for the reader */ | |
170 | static inline void callchain_cursor_commit(struct callchain_cursor *cursor) | |
171 | { | |
172 | cursor->curr = cursor->first; | |
173 | cursor->pos = 0; | |
174 | } | |
175 | ||
176 | /* Cursor reading iteration helpers */ | |
177 | static inline struct callchain_cursor_node * | |
178 | callchain_cursor_current(struct callchain_cursor *cursor) | |
179 | { | |
180 | if (cursor->pos == cursor->nr) | |
181 | return NULL; | |
182 | ||
183 | return cursor->curr; | |
184 | } | |
185 | ||
186 | static inline void callchain_cursor_advance(struct callchain_cursor *cursor) | |
187 | { | |
188 | cursor->curr = cursor->curr->next; | |
189 | cursor->pos++; | |
190 | } | |
75d9a108 ACM |
191 | |
192 | struct option; | |
2dc9fb1a | 193 | struct hist_entry; |
75d9a108 ACM |
194 | |
195 | int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset); | |
09b0fd45 JO |
196 | int record_callchain_opt(const struct option *opt, const char *arg, int unset); |
197 | ||
2dc9fb1a NK |
198 | int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent, |
199 | struct perf_evsel *evsel, struct addr_location *al, | |
200 | int max_stack); | |
201 | int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample); | |
c7405d85 NK |
202 | int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node, |
203 | bool hide_unresolved); | |
2dc9fb1a | 204 | |
75d9a108 | 205 | extern const char record_callchain_help[]; |
076a30c4 | 206 | extern int parse_callchain_record(const char *arg, struct callchain_param *param); |
c3a6a8c4 | 207 | int parse_callchain_record_opt(const char *arg, struct callchain_param *param); |
cff6bb46 | 208 | int parse_callchain_report_opt(const char *arg); |
a2c10d39 | 209 | int parse_callchain_top_opt(const char *arg); |
2b9240ca | 210 | int perf_callchain_config(const char *var, const char *value); |
be1f13e3 NK |
211 | |
212 | static inline void callchain_cursor_snapshot(struct callchain_cursor *dest, | |
213 | struct callchain_cursor *src) | |
214 | { | |
215 | *dest = *src; | |
216 | ||
217 | dest->first = src->curr; | |
218 | dest->nr -= src->pos; | |
219 | } | |
a60335ba SB |
220 | |
221 | #ifdef HAVE_SKIP_CALLCHAIN_IDX | |
bb871a9c | 222 | extern int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain); |
a60335ba | 223 | #else |
bb871a9c | 224 | static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused, |
a60335ba SB |
225 | struct ip_callchain *chain __maybe_unused) |
226 | { | |
227 | return -1; | |
228 | } | |
229 | #endif | |
230 | ||
2989ccaa AK |
231 | char *callchain_list__sym_name(struct callchain_list *cl, |
232 | char *bf, size_t bfsize, bool show_dso); | |
5ab250ca NK |
233 | char *callchain_node__scnprintf_value(struct callchain_node *node, |
234 | char *bf, size_t bfsize, u64 total); | |
235 | int callchain_node__fprintf_value(struct callchain_node *node, | |
236 | FILE *fp, u64 total); | |
2989ccaa | 237 | |
d114960c NK |
238 | void free_callchain(struct callchain_root *root); |
239 | ||
8b40f521 | 240 | #endif /* __PERF_CALLCHAIN_H */ |