1
2#ifndef __PERF_CALLCHAIN_H
3#define __PERF_CALLCHAIN_H
4
5#include <linux/list.h>
6#include <linux/rbtree.h>
7#include "event.h"
8#include "map_symbol.h"
9#include "branch.h"
10
11struct map;
12
13#define HELP_PAD "\t\t\t\t"
14
15#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
16
17# define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
18
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 \
26 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
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" \
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"
33
34enum perf_call_graph_mode {
35 CALLCHAIN_NONE,
36 CALLCHAIN_FP,
37 CALLCHAIN_DWARF,
38 CALLCHAIN_LBR,
39 CALLCHAIN_MAX
40};
41
42enum chain_mode {
43 CHAIN_NONE,
44 CHAIN_FLAT,
45 CHAIN_GRAPH_ABS,
46 CHAIN_GRAPH_REL,
47 CHAIN_FOLDED,
48};
49
50enum chain_order {
51 ORDER_CALLER,
52 ORDER_CALLEE
53};
54
55struct callchain_node {
56 struct callchain_node *parent;
57 struct list_head val;
58 struct list_head parent_val;
59 struct rb_node rb_node_in;
60 struct rb_node rb_node;
61 struct rb_root rb_root_in;
62 struct rb_root rb_root;
63 unsigned int val_nr;
64 unsigned int count;
65 unsigned int children_count;
66 u64 hit;
67 u64 children_hit;
68};
69
70struct callchain_root {
71 u64 max_depth;
72 struct callchain_node node;
73};
74
75struct callchain_param;
76
77typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
78 u64, struct callchain_param *);
79
80enum chain_key {
81 CCKEY_FUNCTION,
82 CCKEY_ADDRESS,
83 CCKEY_SRCLINE
84};
85
86enum chain_value {
87 CCVAL_PERCENT,
88 CCVAL_PERIOD,
89 CCVAL_COUNT,
90};
91
92extern bool dwarf_callchain_users;
93
94struct callchain_param {
95 bool enabled;
96 enum perf_call_graph_mode record_mode;
97 u32 dump_size;
98 enum chain_mode mode;
99 u16 max_stack;
100 u32 print_limit;
101 double min_percent;
102 sort_chain_func_t sort;
103 enum chain_order order;
104 bool order_set;
105 enum chain_key key;
106 bool branch_callstack;
107 enum chain_value value;
108};
109
110extern struct callchain_param callchain_param;
111extern struct callchain_param callchain_param_default;
112
113struct callchain_list {
114 u64 ip;
115 struct map_symbol ms;
116 struct {
117 bool unfolded;
118 bool has_children;
119 };
120 u64 branch_count;
121 u64 from_count;
122 u64 predicted_count;
123 u64 abort_count;
124 u64 cycles_count;
125 u64 iter_count;
126 u64 iter_cycles;
127 struct branch_type_stat brtype_stat;
128 const char *srcline;
129 struct list_head list;
130};
131
132
133
134
135
136
137
138struct callchain_cursor_node {
139 u64 ip;
140 struct map *map;
141 struct symbol *sym;
142 const char *srcline;
143 bool branch;
144 struct branch_flags branch_flags;
145 u64 branch_from;
146 int nr_loop_iter;
147 u64 iter_cycles;
148 struct callchain_cursor_node *next;
149};
150
151struct 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
159extern __thread struct callchain_cursor callchain_cursor;
160
161static inline void callchain_init(struct callchain_root *root)
162{
163 INIT_LIST_HEAD(&root->node.val);
164 INIT_LIST_HEAD(&root->node.parent_val);
165
166 root->node.parent = NULL;
167 root->node.hit = 0;
168 root->node.children_hit = 0;
169 root->node.rb_root_in = RB_ROOT;
170 root->max_depth = 0;
171}
172
173static inline u64 callchain_cumul_hits(struct callchain_node *node)
174{
175 return node->hit + node->children_hit;
176}
177
178static inline unsigned callchain_cumul_counts(struct callchain_node *node)
179{
180 return node->count + node->children_count;
181}
182
183int callchain_register_param(struct callchain_param *param);
184int callchain_append(struct callchain_root *root,
185 struct callchain_cursor *cursor,
186 u64 period);
187
188int callchain_merge(struct callchain_cursor *cursor,
189 struct callchain_root *dst, struct callchain_root *src);
190
191void callchain_cursor_reset(struct callchain_cursor *cursor);
192
193int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
194 struct map *map, struct symbol *sym,
195 bool branch, struct branch_flags *flags,
196 int nr_loop_iter, u64 iter_cycles, u64 branch_from,
197 const char *srcline);
198
199
200static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
201{
202 cursor->curr = cursor->first;
203 cursor->pos = 0;
204}
205
206
207static inline struct callchain_cursor_node *
208callchain_cursor_current(struct callchain_cursor *cursor)
209{
210 if (cursor->pos == cursor->nr)
211 return NULL;
212
213 return cursor->curr;
214}
215
216static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
217{
218 cursor->curr = cursor->curr->next;
219 cursor->pos++;
220}
221
222int callchain_cursor__copy(struct callchain_cursor *dst,
223 struct callchain_cursor *src);
224
225struct option;
226struct hist_entry;
227
228int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
229int record_callchain_opt(const struct option *opt, const char *arg, int unset);
230
231struct record_opts;
232
233int record_opts__parse_callchain(struct record_opts *record,
234 struct callchain_param *callchain,
235 const char *arg, bool unset);
236
237int sample__resolve_callchain(struct perf_sample *sample,
238 struct callchain_cursor *cursor, struct symbol **parent,
239 struct perf_evsel *evsel, struct addr_location *al,
240 int max_stack);
241int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
242int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
243 bool hide_unresolved);
244
245extern const char record_callchain_help[];
246int parse_callchain_record(const char *arg, struct callchain_param *param);
247int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
248int parse_callchain_report_opt(const char *arg);
249int parse_callchain_top_opt(const char *arg);
250int perf_callchain_config(const char *var, const char *value);
251
252static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
253 struct callchain_cursor *src)
254{
255 *dest = *src;
256
257 dest->first = src->curr;
258 dest->nr -= src->pos;
259}
260
261#ifdef HAVE_SKIP_CALLCHAIN_IDX
262int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
263#else
264static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
265 struct ip_callchain *chain __maybe_unused)
266{
267 return -1;
268}
269#endif
270
271char *callchain_list__sym_name(struct callchain_list *cl,
272 char *bf, size_t bfsize, bool show_dso);
273char *callchain_node__scnprintf_value(struct callchain_node *node,
274 char *bf, size_t bfsize, u64 total);
275int callchain_node__fprintf_value(struct callchain_node *node,
276 FILE *fp, u64 total);
277
278int callchain_list_counts__printf_value(struct callchain_list *clist,
279 FILE *fp, char *bf, int bfsize);
280
281void free_callchain(struct callchain_root *root);
282void decay_callchain(struct callchain_root *root);
283int callchain_node__make_parent_list(struct callchain_node *node);
284
285int callchain_branch_counts(struct callchain_root *root,
286 u64 *branch_count, u64 *predicted_count,
287 u64 *abort_count, u64 *cycles_count);
288
289#endif
290
