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 #ifdef HAVE_DWARF_UNWIND_SUPPORT
15 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
17 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|lbr)\n"
20 #define RECORD_SIZE_HELP \
21 HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
22 HELP_PAD "\t\tdefault: 8192 (bytes)\n"
24 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
26 #define CALLCHAIN_REPORT_HELP \
27 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
28 HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
29 HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
30 HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
31 HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
32 HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
33 HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
35 enum perf_call_graph_mode {
56 struct callchain_node {
57 struct callchain_node *parent;
59 struct list_head parent_val;
60 struct rb_node rb_node_in; /* to insert nodes in an rbtree */
61 struct rb_node rb_node; /* to sort nodes in an output tree */
62 struct rb_root rb_root_in; /* input tree of children */
63 struct rb_root rb_root; /* sorted output tree of children */
66 unsigned int children_count;
71 struct callchain_root {
73 struct callchain_node node;
76 struct callchain_param;
78 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
79 u64, struct callchain_param *);
92 struct callchain_param {
94 enum perf_call_graph_mode record_mode;
100 sort_chain_func_t sort;
101 enum chain_order order;
104 bool branch_callstack;
105 enum chain_value value;
108 extern struct callchain_param callchain_param;
110 struct callchain_list {
112 struct map_symbol ms;
113 struct /* for TUI */ {
118 struct list_head list;
122 * A callchain cursor is a single linked list that
123 * let one feed a callchain progressively.
124 * It keeps persistent allocated entries to minimize
127 struct callchain_cursor_node {
131 struct callchain_cursor_node *next;
134 struct callchain_cursor {
136 struct callchain_cursor_node *first;
137 struct callchain_cursor_node **last;
139 struct callchain_cursor_node *curr;
142 extern __thread struct callchain_cursor callchain_cursor;
144 static inline void callchain_init(struct callchain_root *root)
146 INIT_LIST_HEAD(&root->node.val);
147 INIT_LIST_HEAD(&root->node.parent_val);
149 root->node.parent = NULL;
151 root->node.children_hit = 0;
152 root->node.rb_root_in = RB_ROOT;
156 static inline u64 callchain_cumul_hits(struct callchain_node *node)
158 return node->hit + node->children_hit;
161 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
163 return node->count + node->children_count;
166 int callchain_register_param(struct callchain_param *param);
167 int callchain_append(struct callchain_root *root,
168 struct callchain_cursor *cursor,
171 int callchain_merge(struct callchain_cursor *cursor,
172 struct callchain_root *dst, struct callchain_root *src);
175 * Initialize a cursor before adding entries inside, but keep
176 * the previously allocated entries as a cache.
178 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
181 cursor->last = &cursor->first;
184 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
185 struct map *map, struct symbol *sym);
187 /* Close a cursor writing session. Initialize for the reader */
188 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
190 cursor->curr = cursor->first;
194 /* Cursor reading iteration helpers */
195 static inline struct callchain_cursor_node *
196 callchain_cursor_current(struct callchain_cursor *cursor)
198 if (cursor->pos == cursor->nr)
204 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
206 cursor->curr = cursor->curr->next;
213 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
214 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
218 int record_opts__parse_callchain(struct record_opts *record,
219 struct callchain_param *callchain,
220 const char *arg, bool unset);
222 int sample__resolve_callchain(struct perf_sample *sample,
223 struct callchain_cursor *cursor, struct symbol **parent,
224 struct perf_evsel *evsel, struct addr_location *al,
226 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
227 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
228 bool hide_unresolved);
230 extern const char record_callchain_help[];
231 int parse_callchain_record(const char *arg, struct callchain_param *param);
232 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
233 int parse_callchain_report_opt(const char *arg);
234 int parse_callchain_top_opt(const char *arg);
235 int perf_callchain_config(const char *var, const char *value);
237 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
238 struct callchain_cursor *src)
242 dest->first = src->curr;
243 dest->nr -= src->pos;
246 #ifdef HAVE_SKIP_CALLCHAIN_IDX
247 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
249 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
250 struct ip_callchain *chain __maybe_unused)
256 char *callchain_list__sym_name(struct callchain_list *cl,
257 char *bf, size_t bfsize, bool show_dso);
258 char *callchain_node__scnprintf_value(struct callchain_node *node,
259 char *bf, size_t bfsize, u64 total);
260 int callchain_node__fprintf_value(struct callchain_node *node,
261 FILE *fp, u64 total);
263 void free_callchain(struct callchain_root *root);
264 void decay_callchain(struct callchain_root *root);
265 int callchain_node__make_parent_list(struct callchain_node *node);
267 #endif /* __PERF_CALLCHAIN_H */