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>
7 #include "map_symbol.h"
17 #define HELP_PAD "\t\t\t\t"
19 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
21 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
23 #define RECORD_SIZE_HELP \
24 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
25 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
27 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
29 #define CALLCHAIN_REPORT_HELP \
30 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
31 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
32 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
33 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
34 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
35 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
36 HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
38 enum perf_call_graph_mode {
59 struct callchain_node {
60 struct callchain_node *parent;
62 struct list_head parent_val;
63 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
64 struct rb_node rb_node; /* to sort nodes in an output tree */
65 struct rb_root rb_root_in; /* input tree of children */
66 struct rb_root rb_root; /* sorted output tree of children */
69 unsigned int children_count;
74 struct callchain_root {
76 struct callchain_node node;
79 struct callchain_param;
81 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
82 u64, struct callchain_param *);
96 extern bool dwarf_callchain_users;
98 struct callchain_param {
100 enum perf_call_graph_mode record_mode;
102 enum chain_mode mode;
106 sort_chain_func_t sort;
107 enum chain_order order;
110 bool branch_callstack;
111 enum chain_value value;
114 extern struct callchain_param callchain_param;
115 extern struct callchain_param callchain_param_default;
117 struct callchain_list {
119 struct map_symbol ms;
120 struct /* for TUI */ {
131 struct branch_type_stat brtype_stat;
133 struct list_head list;
137 * A callchain cursor is a single linked list that
138 * let one feed a callchain progressively.
139 * It keeps persistent allocated entries to minimize
142 struct callchain_cursor_node {
148 struct branch_flags branch_flags;
152 struct callchain_cursor_node *next;
155 struct callchain_cursor {
157 struct callchain_cursor_node *first;
158 struct callchain_cursor_node **last;
160 struct callchain_cursor_node *curr;
163 extern __thread struct callchain_cursor callchain_cursor;
165 static inline void callchain_init(struct callchain_root *root)
167 INIT_LIST_HEAD(&root->node.val);
168 INIT_LIST_HEAD(&root->node.parent_val);
170 root->node.parent = NULL;
172 root->node.children_hit = 0;
173 root->node.rb_root_in = RB_ROOT;
177 static inline u64 callchain_cumul_hits(struct callchain_node *node)
179 return node->hit + node->children_hit;
182 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
184 return node->count + node->children_count;
187 int callchain_register_param(struct callchain_param *param);
188 int callchain_append(struct callchain_root *root,
189 struct callchain_cursor *cursor,
192 int callchain_merge(struct callchain_cursor *cursor,
193 struct callchain_root *dst, struct callchain_root *src);
195 void callchain_cursor_reset(struct callchain_cursor *cursor);
197 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
198 struct map *map, struct symbol *sym,
199 bool branch, struct branch_flags *flags,
200 int nr_loop_iter, u64 iter_cycles, u64 branch_from,
201 const char *srcline);
203 /* Close a cursor writing session. Initialize for the reader */
204 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
206 cursor->curr = cursor->first;
210 /* Cursor reading iteration helpers */
211 static inline struct callchain_cursor_node *
212 callchain_cursor_current(struct callchain_cursor *cursor)
214 if (cursor->pos == cursor->nr)
220 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
222 cursor->curr = cursor->curr->next;
226 int callchain_cursor__copy(struct callchain_cursor *dst,
227 struct callchain_cursor *src);
232 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
233 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
237 int record_opts__parse_callchain(struct record_opts *record,
238 struct callchain_param *callchain,
239 const char *arg, bool unset);
241 int sample__resolve_callchain(struct perf_sample *sample,
242 struct callchain_cursor *cursor, struct symbol **parent,
243 struct evsel *evsel, struct addr_location *al,
245 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
246 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
247 bool hide_unresolved);
249 extern const char record_callchain_help[];
250 int parse_callchain_record(const char *arg, struct callchain_param *param);
251 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
252 int parse_callchain_report_opt(const char *arg);
253 int parse_callchain_top_opt(const char *arg);
254 int perf_callchain_config(const char *var, const char *value);
256 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
257 struct callchain_cursor *src)
261 dest->first = src->curr;
262 dest->nr -= src->pos;
265 #ifdef HAVE_SKIP_CALLCHAIN_IDX
266 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
268 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
269 struct ip_callchain *chain __maybe_unused)
275 char *callchain_list__sym_name(struct callchain_list *cl,
276 char *bf, size_t bfsize, bool show_dso);
277 char *callchain_node__scnprintf_value(struct callchain_node *node,
278 char *bf, size_t bfsize, u64 total);
279 int callchain_node__fprintf_value(struct callchain_node *node,
280 FILE *fp, u64 total);
282 int callchain_list_counts__printf_value(struct callchain_list *clist,
283 FILE *fp, char *bf, int bfsize);
285 void free_callchain(struct callchain_root *root);
286 void decay_callchain(struct callchain_root *root);
287 int callchain_node__make_parent_list(struct callchain_node *node);
289 int callchain_branch_counts(struct callchain_root *root,
290 u64 *branch_count, u64 *predicted_count,
291 u64 *abort_count, u64 *cycles_count);
293 #endif /* __PERF_CALLCHAIN_H */