1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_CALLCHAIN_H
3#define __PERF_CALLCHAIN_H
4
5#include <linux/list.h>
6#include <linux/rbtree.h>
7#include "map_symbol.h"
8#include "branch.h"
9
10struct addr_location;
11struct evsel;
12struct ip_callchain;
13struct map;
14struct perf_sample;
15struct thread;
16struct hists;
17
18#define HELP_PAD "\t\t\t\t"
19
20#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
21
22# define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
23
24#define RECORD_SIZE_HELP \
25 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
26 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
27
28#define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
29
30#define CALLCHAIN_REPORT_HELP \
31 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
32 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
33 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
34 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
35 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
36 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
37 HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
38
39enum perf_call_graph_mode {
40 CALLCHAIN_NONE,
41 CALLCHAIN_FP,
42 CALLCHAIN_DWARF,
43 CALLCHAIN_LBR,
44 CALLCHAIN_MAX
45};
46
47enum chain_mode {
48 CHAIN_NONE,
49 CHAIN_FLAT,
50 CHAIN_GRAPH_ABS,
51 CHAIN_GRAPH_REL,
52 CHAIN_FOLDED,
53};
54
55enum chain_order {
56 ORDER_CALLER,
57 ORDER_CALLEE
58};
59
60struct callchain_node {
61 struct callchain_node *parent;
62 struct list_head val;
63 struct list_head parent_val;
64 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
65 struct rb_node rb_node; /* to sort nodes in an output tree */
66 struct rb_root rb_root_in; /* input tree of children */
67 struct rb_root rb_root; /* sorted output tree of children */
68 unsigned int val_nr;
69 unsigned int count;
70 unsigned int children_count;
71 u64 hit;
72 u64 children_hit;
73};
74
75struct callchain_root {
76 u64 max_depth;
77 struct callchain_node node;
78};
79
80struct callchain_param;
81
82typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
83 u64, struct callchain_param *);
84
85enum chain_key {
86 CCKEY_FUNCTION,
87 CCKEY_ADDRESS,
88 CCKEY_SRCLINE
89};
90
91enum chain_value {
92 CCVAL_PERCENT,
93 CCVAL_PERIOD,
94 CCVAL_COUNT,
95};
96
97extern bool dwarf_callchain_users;
98
99struct callchain_param {
100 bool enabled;
101 bool defer;
102 enum perf_call_graph_mode record_mode;
103 u32 dump_size;
104 enum chain_mode mode;
105 u16 max_stack;
106 u32 print_limit;
107 double min_percent;
108 sort_chain_func_t sort;
109 enum chain_order order;
110 bool order_set;
111 enum chain_key key;
112 bool branch_callstack;
113 enum chain_value value;
114};
115
116extern struct callchain_param callchain_param;
117extern struct callchain_param callchain_param_default;
118
119struct callchain_list {
120 struct list_head list;
121 u64 ip;
122 struct map_symbol ms;
123 const char *srcline;
124 u64 branch_count;
125 u64 from_count;
126 u64 cycles_count;
127 u64 iter_count;
128 u64 iter_cycles;
129 struct branch_type_stat *brtype_stat;
130 u64 predicted_count;
131 u64 abort_count;
132 struct /* for TUI */ {
133 bool unfolded;
134 bool has_children;
135 };
136};
137
138/*
139 * A callchain cursor is a single linked list that
140 * let one feed a callchain progressively.
141 * It keeps persistent allocated entries to minimize
142 * allocations.
143 */
144struct callchain_cursor_node {
145 u64 ip;
146 struct map_symbol ms;
147 const char *srcline;
148 /* Indicate valid cursor node for LBR stitch */
149 bool valid;
150
151 bool branch;
152 struct branch_flags branch_flags;
153 u64 branch_from;
154 int nr_loop_iter;
155 u64 iter_cycles;
156 struct callchain_cursor_node *next;
157};
158
159struct stitch_list {
160 struct list_head node;
161 struct callchain_cursor_node cursor;
162};
163
164struct callchain_cursor {
165 u64 nr;
166 struct callchain_cursor_node *first;
167 struct callchain_cursor_node **last;
168 u64 pos;
169 struct callchain_cursor_node *curr;
170};
171
172static inline void callchain_init(struct callchain_root *root)
173{
174 INIT_LIST_HEAD(list: &root->node.val);
175 INIT_LIST_HEAD(list: &root->node.parent_val);
176
177 root->node.parent = NULL;
178 root->node.hit = 0;
179 root->node.children_hit = 0;
180 root->node.rb_root_in = RB_ROOT;
181 root->max_depth = 0;
182}
183
184static inline u64 callchain_cumul_hits(struct callchain_node *node)
185{
186 return node->hit + node->children_hit;
187}
188
189static inline unsigned callchain_cumul_counts(struct callchain_node *node)
190{
191 return node->count + node->children_count;
192}
193
194int callchain_register_param(struct callchain_param *param);
195int callchain_append(struct callchain_root *root,
196 struct callchain_cursor *cursor,
197 u64 period);
198
199int callchain_merge(struct callchain_cursor *cursor,
200 struct callchain_root *dst, struct callchain_root *src);
201
202void callchain_cursor_reset(struct callchain_cursor *cursor);
203
204int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
205 struct map_symbol *ms,
206 bool branch, struct branch_flags *flags,
207 int nr_loop_iter, u64 iter_cycles, u64 branch_from,
208 const char *srcline);
209
210/* Close a cursor writing session. Initialize for the reader */
211static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
212{
213 if (cursor == NULL)
214 return;
215 cursor->curr = cursor->first;
216 cursor->pos = 0;
217}
218
219/* Cursor reading iteration helpers */
220static inline struct callchain_cursor_node *
221callchain_cursor_current(struct callchain_cursor *cursor)
222{
223 if (cursor == NULL || cursor->pos == cursor->nr)
224 return NULL;
225
226 return cursor->curr;
227}
228
229static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
230{
231 cursor->curr = cursor->curr->next;
232 cursor->pos++;
233}
234
235struct callchain_cursor *get_tls_callchain_cursor(void);
236
237int callchain_cursor__copy(struct callchain_cursor *dst,
238 struct callchain_cursor *src);
239
240struct option;
241struct hist_entry;
242
243int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
244int record_callchain_opt(const struct option *opt, const char *arg, int unset);
245
246struct record_opts;
247
248int record_opts__parse_callchain(struct record_opts *record,
249 struct callchain_param *callchain,
250 const char *arg, bool unset);
251
252int sample__resolve_callchain(struct perf_sample *sample,
253 struct callchain_cursor *cursor, struct symbol **parent,
254 struct evsel *evsel, struct addr_location *al,
255 int max_stack);
256int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
257int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
258 bool hide_unresolved);
259
260extern const char record_callchain_help[];
261int parse_callchain_record(const char *arg, struct callchain_param *param);
262int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
263int parse_callchain_report_opt(const char *arg);
264int parse_callchain_top_opt(const char *arg);
265int perf_callchain_config(const char *var, const char *value);
266
267static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
268 struct callchain_cursor *src)
269{
270 *dest = *src;
271
272 dest->first = src->curr;
273 dest->nr -= src->pos;
274}
275
276#ifdef HAVE_SKIP_CALLCHAIN_IDX
277int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
278#else
279static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
280 struct ip_callchain *chain __maybe_unused)
281{
282 return -1;
283}
284#endif
285
286void arch__add_leaf_frame_record_opts(struct record_opts *opts);
287
288char *callchain_list__sym_name(struct callchain_list *cl,
289 char *bf, size_t bfsize, bool show_dso);
290char *callchain_node__scnprintf_value(struct callchain_node *node,
291 char *bf, size_t bfsize, u64 total);
292int callchain_node__fprintf_value(struct callchain_node *node,
293 FILE *fp, u64 total);
294
295int callchain_list_counts__printf_value(struct callchain_list *clist,
296 FILE *fp, char *bf, int bfsize);
297
298void free_callchain(struct callchain_root *root);
299void decay_callchain(struct callchain_root *root);
300int callchain_node__make_parent_list(struct callchain_node *node);
301
302int callchain_branch_counts(struct callchain_root *root,
303 u64 *branch_count, u64 *predicted_count,
304 u64 *abort_count, u64 *cycles_count);
305
306void callchain_param_setup(u64 sample_type, const char *arch);
307
308bool callchain_cnode_matched(struct callchain_node *base_cnode,
309 struct callchain_node *pair_cnode);
310
311u64 callchain_total_hits(struct hists *hists);
312
313s64 callchain_avg_cycles(struct callchain_node *cnode);
314
315typedef int (*callchain_iter_fn)(struct callchain_cursor_node *node, void *data);
316
317int sample__for_each_callchain_node(struct thread *thread, struct evsel *evsel,
318 struct perf_sample *sample, int max_stack,
319 bool symbols, callchain_iter_fn cb, void *data);
320
321int sample__merge_deferred_callchain(struct perf_sample *sample_orig,
322 struct perf_sample *sample_callchain);
323
324#endif /* __PERF_CALLCHAIN_H */
325

source code of linux/tools/perf/util/callchain.h