1 #ifndef __PERF_CALLCHAIN_H
2 #define __PERF_CALLCHAIN_H
5 #include <linux/list.h>
6 #include <linux/rbtree.h>
10 #define HELP_PAD "\t\t\t\t"
12 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
14 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
16 #define RECORD_SIZE_HELP \
17 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
18 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
20 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
22 #define CALLCHAIN_REPORT_HELP \
23 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
24 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
25 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
26 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
27 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
28 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
29 HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
31 enum perf_call_graph_mode {
52 struct callchain_node {
53 struct callchain_node *parent;
55 struct list_head parent_val;
56 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
57 struct rb_node rb_node; /* to sort nodes in an output tree */
58 struct rb_root rb_root_in; /* input tree of children */
59 struct rb_root rb_root; /* sorted output tree of children */
62 unsigned int children_count;
67 struct callchain_root {
69 struct callchain_node node;
72 struct callchain_param;
74 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
75 u64, struct callchain_param *);
88 struct callchain_param {
90 enum perf_call_graph_mode record_mode;
96 sort_chain_func_t sort;
97 enum chain_order order;
100 bool branch_callstack;
101 enum chain_value value;
104 extern struct callchain_param callchain_param;
105 extern struct callchain_param callchain_param_default;
107 struct callchain_list {
109 struct map_symbol ms;
110 struct /* for TUI */ {
121 struct list_head list;
125 * A callchain cursor is a single linked list that
126 * let one feed a callchain progressively.
127 * It keeps persistent allocated entries to minimize
130 struct callchain_cursor_node {
135 struct branch_flags branch_flags;
138 struct callchain_cursor_node *next;
141 struct callchain_cursor {
143 struct callchain_cursor_node *first;
144 struct callchain_cursor_node **last;
146 struct callchain_cursor_node *curr;
149 extern __thread struct callchain_cursor callchain_cursor;
151 static inline void callchain_init(struct callchain_root *root)
153 INIT_LIST_HEAD(&root->node.val);
154 INIT_LIST_HEAD(&root->node.parent_val);
156 root->node.parent = NULL;
158 root->node.children_hit = 0;
159 root->node.rb_root_in = RB_ROOT;
163 static inline u64 callchain_cumul_hits(struct callchain_node *node)
165 return node->hit + node->children_hit;
168 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
170 return node->count + node->children_count;
173 int callchain_register_param(struct callchain_param *param);
174 int callchain_append(struct callchain_root *root,
175 struct callchain_cursor *cursor,
178 int callchain_merge(struct callchain_cursor *cursor,
179 struct callchain_root *dst, struct callchain_root *src);
182 * Initialize a cursor before adding entries inside, but keep
183 * the previously allocated entries as a cache.
185 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
188 cursor->last = &cursor->first;
191 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
192 struct map *map, struct symbol *sym,
193 bool branch, struct branch_flags *flags,
194 int nr_loop_iter, int samples);
196 /* Close a cursor writing session. Initialize for the reader */
197 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
199 cursor->curr = cursor->first;
203 /* Cursor reading iteration helpers */
204 static inline struct callchain_cursor_node *
205 callchain_cursor_current(struct callchain_cursor *cursor)
207 if (cursor->pos == cursor->nr)
213 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
215 cursor->curr = cursor->curr->next;
219 int callchain_cursor__copy(struct callchain_cursor *dst,
220 struct callchain_cursor *src);
225 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
226 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
230 int record_opts__parse_callchain(struct record_opts *record,
231 struct callchain_param *callchain,
232 const char *arg, bool unset);
234 int sample__resolve_callchain(struct perf_sample *sample,
235 struct callchain_cursor *cursor, struct symbol **parent,
236 struct perf_evsel *evsel, struct addr_location *al,
238 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
239 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
240 bool hide_unresolved);
242 extern const char record_callchain_help[];
243 int parse_callchain_record(const char *arg, struct callchain_param *param);
244 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
245 int parse_callchain_report_opt(const char *arg);
246 int parse_callchain_top_opt(const char *arg);
247 int perf_callchain_config(const char *var, const char *value);
249 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
250 struct callchain_cursor *src)
254 dest->first = src->curr;
255 dest->nr -= src->pos;
258 #ifdef HAVE_SKIP_CALLCHAIN_IDX
259 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
261 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
262 struct ip_callchain *chain __maybe_unused)
268 char *callchain_list__sym_name(struct callchain_list *cl,
269 char *bf, size_t bfsize, bool show_dso);
270 char *callchain_node__scnprintf_value(struct callchain_node *node,
271 char *bf, size_t bfsize, u64 total);
272 int callchain_node__fprintf_value(struct callchain_node *node,
273 FILE *fp, u64 total);
275 int callchain_list_counts__printf_value(struct callchain_node *node,
276 struct callchain_list *clist,
277 FILE *fp, char *bf, int bfsize);
279 void free_callchain(struct callchain_root *root);
280 void decay_callchain(struct callchain_root *root);
281 int callchain_node__make_parent_list(struct callchain_node *node);
283 int callchain_branch_counts(struct callchain_root *root,
284 u64 *branch_count, u64 *predicted_count,
285 u64 *abort_count, u64 *cycles_count);
287 #endif /* __PERF_CALLCHAIN_H */