1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_CALLCHAIN_H
3 #define __PERF_CALLCHAIN_H
5 #include <linux/list.h>
6 #include <linux/rbtree.h>
8 #include "map_symbol.h"
13 #define HELP_PAD "\t\t\t\t"
15 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
17 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
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"
23 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
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"
34 enum perf_call_graph_mode
{
55 struct callchain_node
{
56 struct callchain_node
*parent
;
58 struct list_head parent_val
;
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 */
65 unsigned int children_count
;
70 struct callchain_root
{
72 struct callchain_node node
;
75 struct callchain_param
;
77 typedef void (*sort_chain_func_t
)(struct rb_root
*, struct callchain_root
*,
78 u64
, struct callchain_param
*);
92 extern bool dwarf_callchain_users
;
94 struct callchain_param
{
96 enum perf_call_graph_mode record_mode
;
102 sort_chain_func_t sort
;
103 enum chain_order order
;
106 bool branch_callstack
;
107 enum chain_value value
;
110 extern struct callchain_param callchain_param
;
111 extern struct callchain_param callchain_param_default
;
113 struct callchain_list
{
115 struct map_symbol ms
;
116 struct /* for TUI */ {
127 struct branch_type_stat brtype_stat
;
129 struct list_head list
;
133 * A callchain cursor is a single linked list that
134 * let one feed a callchain progressively.
135 * It keeps persistent allocated entries to minimize
138 struct callchain_cursor_node
{
144 struct branch_flags branch_flags
;
148 struct callchain_cursor_node
*next
;
151 struct callchain_cursor
{
153 struct callchain_cursor_node
*first
;
154 struct callchain_cursor_node
**last
;
156 struct callchain_cursor_node
*curr
;
159 extern __thread
struct callchain_cursor callchain_cursor
;
161 static inline void callchain_init(struct callchain_root
*root
)
163 INIT_LIST_HEAD(&root
->node
.val
);
164 INIT_LIST_HEAD(&root
->node
.parent_val
);
166 root
->node
.parent
= NULL
;
168 root
->node
.children_hit
= 0;
169 root
->node
.rb_root_in
= RB_ROOT
;
173 static inline u64
callchain_cumul_hits(struct callchain_node
*node
)
175 return node
->hit
+ node
->children_hit
;
178 static inline unsigned callchain_cumul_counts(struct callchain_node
*node
)
180 return node
->count
+ node
->children_count
;
183 int callchain_register_param(struct callchain_param
*param
);
184 int callchain_append(struct callchain_root
*root
,
185 struct callchain_cursor
*cursor
,
188 int callchain_merge(struct callchain_cursor
*cursor
,
189 struct callchain_root
*dst
, struct callchain_root
*src
);
191 void callchain_cursor_reset(struct callchain_cursor
*cursor
);
193 int 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
);
199 /* Close a cursor writing session. Initialize for the reader */
200 static inline void callchain_cursor_commit(struct callchain_cursor
*cursor
)
202 cursor
->curr
= cursor
->first
;
206 /* Cursor reading iteration helpers */
207 static inline struct callchain_cursor_node
*
208 callchain_cursor_current(struct callchain_cursor
*cursor
)
210 if (cursor
->pos
== cursor
->nr
)
216 static inline void callchain_cursor_advance(struct callchain_cursor
*cursor
)
218 cursor
->curr
= cursor
->curr
->next
;
222 int callchain_cursor__copy(struct callchain_cursor
*dst
,
223 struct callchain_cursor
*src
);
228 int record_parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
);
229 int record_callchain_opt(const struct option
*opt
, const char *arg
, int unset
);
233 int record_opts__parse_callchain(struct record_opts
*record
,
234 struct callchain_param
*callchain
,
235 const char *arg
, bool unset
);
237 int sample__resolve_callchain(struct perf_sample
*sample
,
238 struct callchain_cursor
*cursor
, struct symbol
**parent
,
239 struct perf_evsel
*evsel
, struct addr_location
*al
,
241 int hist_entry__append_callchain(struct hist_entry
*he
, struct perf_sample
*sample
);
242 int fill_callchain_info(struct addr_location
*al
, struct callchain_cursor_node
*node
,
243 bool hide_unresolved
);
245 extern const char record_callchain_help
[];
246 int parse_callchain_record(const char *arg
, struct callchain_param
*param
);
247 int parse_callchain_record_opt(const char *arg
, struct callchain_param
*param
);
248 int parse_callchain_report_opt(const char *arg
);
249 int parse_callchain_top_opt(const char *arg
);
250 int perf_callchain_config(const char *var
, const char *value
);
252 static inline void callchain_cursor_snapshot(struct callchain_cursor
*dest
,
253 struct callchain_cursor
*src
)
257 dest
->first
= src
->curr
;
258 dest
->nr
-= src
->pos
;
261 #ifdef HAVE_SKIP_CALLCHAIN_IDX
262 int arch_skip_callchain_idx(struct thread
*thread
, struct ip_callchain
*chain
);
264 static inline int arch_skip_callchain_idx(struct thread
*thread __maybe_unused
,
265 struct ip_callchain
*chain __maybe_unused
)
271 char *callchain_list__sym_name(struct callchain_list
*cl
,
272 char *bf
, size_t bfsize
, bool show_dso
);
273 char *callchain_node__scnprintf_value(struct callchain_node
*node
,
274 char *bf
, size_t bfsize
, u64 total
);
275 int callchain_node__fprintf_value(struct callchain_node
*node
,
276 FILE *fp
, u64 total
);
278 int callchain_list_counts__printf_value(struct callchain_list
*clist
,
279 FILE *fp
, char *bf
, int bfsize
);
281 void free_callchain(struct callchain_root
*root
);
282 void decay_callchain(struct callchain_root
*root
);
283 int callchain_node__make_parent_list(struct callchain_node
*node
);
285 int callchain_branch_counts(struct callchain_root
*root
,
286 u64
*branch_count
, u64
*predicted_count
,
287 u64
*abort_count
, u64
*cycles_count
);
289 #endif /* __PERF_CALLCHAIN_H */