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|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"
34 enum perf_call_graph_mode {
54 struct callchain_node {
55 struct callchain_node *parent;
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 */
66 struct callchain_root {
68 struct callchain_node node;
71 struct callchain_param;
73 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
74 u64, struct callchain_param *);
81 struct callchain_param {
83 enum perf_call_graph_mode record_mode;
88 sort_chain_func_t sort;
89 enum chain_order order;
92 bool branch_callstack;
95 extern struct callchain_param callchain_param;
97 struct callchain_list {
100 struct /* for TUI */ {
105 struct list_head list;
109 * A callchain cursor is a single linked list that
110 * let one feed a callchain progressively.
111 * It keeps persistent allocated entries to minimize
114 struct callchain_cursor_node {
118 struct callchain_cursor_node *next;
121 struct callchain_cursor {
123 struct callchain_cursor_node *first;
124 struct callchain_cursor_node **last;
126 struct callchain_cursor_node *curr;
129 extern __thread struct callchain_cursor callchain_cursor;
131 static inline void callchain_init(struct callchain_root *root)
133 INIT_LIST_HEAD(&root->node.val);
135 root->node.parent = NULL;
137 root->node.children_hit = 0;
138 root->node.rb_root_in = RB_ROOT;
142 static inline u64 callchain_cumul_hits(struct callchain_node *node)
144 return node->hit + node->children_hit;
147 int callchain_register_param(struct callchain_param *param);
148 int callchain_append(struct callchain_root *root,
149 struct callchain_cursor *cursor,
152 int callchain_merge(struct callchain_cursor *cursor,
153 struct callchain_root *dst, struct callchain_root *src);
156 * Initialize a cursor before adding entries inside, but keep
157 * the previously allocated entries as a cache.
159 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
162 cursor->last = &cursor->first;
165 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
166 struct map *map, struct symbol *sym);
168 /* Close a cursor writing session. Initialize for the reader */
169 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
171 cursor->curr = cursor->first;
175 /* Cursor reading iteration helpers */
176 static inline struct callchain_cursor_node *
177 callchain_cursor_current(struct callchain_cursor *cursor)
179 if (cursor->pos == cursor->nr)
185 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
187 cursor->curr = cursor->curr->next;
194 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
195 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
197 int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent,
198 struct perf_evsel *evsel, struct addr_location *al,
200 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
201 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
202 bool hide_unresolved);
204 extern const char record_callchain_help[];
205 extern int parse_callchain_record(const char *arg, struct callchain_param *param);
206 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
207 int parse_callchain_report_opt(const char *arg);
208 int parse_callchain_top_opt(const char *arg);
209 int perf_callchain_config(const char *var, const char *value);
211 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
212 struct callchain_cursor *src)
216 dest->first = src->curr;
217 dest->nr -= src->pos;
220 #ifdef HAVE_SKIP_CALLCHAIN_IDX
221 extern int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
223 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
224 struct ip_callchain *chain __maybe_unused)
230 char *callchain_list__sym_name(struct callchain_list *cl,
231 char *bf, size_t bfsize, bool show_dso);
233 void free_callchain(struct callchain_root *root);
235 #endif /* __PERF_CALLCHAIN_H */