1 #ifndef __PERF_CALLCHAIN_H
2 #define __PERF_CALLCHAIN_H
5 #include <linux/list.h>
6 #include <linux/rbtree.h>
11 #define HELP_PAD "\t\t\t\t"
13 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
15 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
17 #define RECORD_SIZE_HELP \
18 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
19 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
21 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
23 #define CALLCHAIN_REPORT_HELP \
24 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
25 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
26 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
27 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
28 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
29 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
30 HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
32 enum perf_call_graph_mode {
53 struct callchain_node {
54 struct callchain_node *parent;
56 struct list_head parent_val;
57 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
58 struct rb_node rb_node; /* to sort nodes in an output tree */
59 struct rb_root rb_root_in; /* input tree of children */
60 struct rb_root rb_root; /* sorted output tree of children */
63 unsigned int children_count;
68 struct callchain_root {
70 struct callchain_node node;
73 struct callchain_param;
75 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
76 u64, struct callchain_param *);
89 struct callchain_param {
91 enum perf_call_graph_mode record_mode;
97 sort_chain_func_t sort;
98 enum chain_order order;
101 bool branch_callstack;
102 enum chain_value value;
105 extern struct callchain_param callchain_param;
106 extern struct callchain_param callchain_param_default;
108 struct callchain_list {
110 struct map_symbol ms;
111 struct /* for TUI */ {
122 struct list_head list;
126 * A callchain cursor is a single linked list that
127 * let one feed a callchain progressively.
128 * It keeps persistent allocated entries to minimize
131 struct callchain_cursor_node {
136 struct branch_flags branch_flags;
139 struct callchain_cursor_node *next;
142 struct callchain_cursor {
144 struct callchain_cursor_node *first;
145 struct callchain_cursor_node **last;
147 struct callchain_cursor_node *curr;
150 extern __thread struct callchain_cursor callchain_cursor;
152 static inline void callchain_init(struct callchain_root *root)
154 INIT_LIST_HEAD(&root->node.val);
155 INIT_LIST_HEAD(&root->node.parent_val);
157 root->node.parent = NULL;
159 root->node.children_hit = 0;
160 root->node.rb_root_in = RB_ROOT;
164 static inline u64 callchain_cumul_hits(struct callchain_node *node)
166 return node->hit + node->children_hit;
169 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
171 return node->count + node->children_count;
174 int callchain_register_param(struct callchain_param *param);
175 int callchain_append(struct callchain_root *root,
176 struct callchain_cursor *cursor,
179 int callchain_merge(struct callchain_cursor *cursor,
180 struct callchain_root *dst, struct callchain_root *src);
183 * Initialize a cursor before adding entries inside, but keep
184 * the previously allocated entries as a cache.
186 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
188 struct callchain_cursor_node *node;
191 cursor->last = &cursor->first;
193 for (node = cursor->first; node != NULL; node = node->next)
194 map__zput(node->map);
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, int samples);
202 /* Close a cursor writing session. Initialize for the reader */
203 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
205 cursor->curr = cursor->first;
209 /* Cursor reading iteration helpers */
210 static inline struct callchain_cursor_node *
211 callchain_cursor_current(struct callchain_cursor *cursor)
213 if (cursor->pos == cursor->nr)
219 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
221 cursor->curr = cursor->curr->next;
225 int callchain_cursor__copy(struct callchain_cursor *dst,
226 struct callchain_cursor *src);
231 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
232 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
236 int record_opts__parse_callchain(struct record_opts *record,
237 struct callchain_param *callchain,
238 const char *arg, bool unset);
240 int sample__resolve_callchain(struct perf_sample *sample,
241 struct callchain_cursor *cursor, struct symbol **parent,
242 struct perf_evsel *evsel, struct addr_location *al,
244 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
245 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
246 bool hide_unresolved);
248 extern const char record_callchain_help[];
249 int parse_callchain_record(const char *arg, struct callchain_param *param);
250 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
251 int parse_callchain_report_opt(const char *arg);
252 int parse_callchain_top_opt(const char *arg);
253 int perf_callchain_config(const char *var, const char *value);
255 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
256 struct callchain_cursor *src)
260 dest->first = src->curr;
261 dest->nr -= src->pos;
264 #ifdef HAVE_SKIP_CALLCHAIN_IDX
265 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
267 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
268 struct ip_callchain *chain __maybe_unused)
274 char *callchain_list__sym_name(struct callchain_list *cl,
275 char *bf, size_t bfsize, bool show_dso);
276 char *callchain_node__scnprintf_value(struct callchain_node *node,
277 char *bf, size_t bfsize, u64 total);
278 int callchain_node__fprintf_value(struct callchain_node *node,
279 FILE *fp, u64 total);
281 int callchain_list_counts__printf_value(struct callchain_node *node,
282 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 */