Linux Perf
callchain.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_CALLCHAIN_H
3 #define __PERF_CALLCHAIN_H
4 
5 #include "../perf.h"
6 #include <linux/list.h>
7 #include <linux/rbtree.h>
8 #include "event.h"
9 #include "map.h"
10 #include "symbol.h"
11 #include "branch.h"
12 
13 #define HELP_PAD "\t\t\t\t"
14 
15 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
16 
17 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
18 
19 #define RECORD_SIZE_HELP \
20  HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
21  HELP_PAD "\t\tdefault: 8192 (bytes)\n"
22 
23 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
24 
25 #define CALLCHAIN_REPORT_HELP \
26  HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
27  HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
28  HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
29  HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
30  HELP_PAD "sort_key:\tcall graph sort key (function|address)\n" \
31  HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
32  HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
33 
40 };
41 
42 enum chain_mode {
48 };
49 
53 };
54 
57  struct list_head val;
58  struct list_head parent_val;
59  struct rb_node rb_node_in; /* to insert nodes in an rbtree */
60  struct rb_node rb_node; /* to sort nodes in an output tree */
61  struct rb_root rb_root_in; /* input tree of children */
62  struct rb_root rb_root; /* sorted output tree of children */
63  unsigned int val_nr;
64  unsigned int count;
65  unsigned int children_count;
66  u64 hit;
68 };
69 
71  u64 max_depth;
73 };
74 
75 struct callchain_param;
76 
77 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
78  u64, struct callchain_param *);
79 
80 enum chain_key {
84 };
85 
90 };
91 
92 extern bool dwarf_callchain_users;
93 
95  bool enabled;
96  enum perf_call_graph_mode record_mode;
97  u32 dump_size;
98  enum chain_mode mode;
99  u16 max_stack;
101  double min_percent;
103  enum chain_order order;
104  bool order_set;
108 };
109 
110 extern struct callchain_param callchain_param;
112 
114  u64 ip;
115  struct map_symbol ms;
116  struct /* for TUI */ {
117  bool unfolded;
119  };
126  struct branch_type_stat brtype_stat;
127  const char *srcline;
128  struct list_head list;
129 };
130 
131 /*
132  * A callchain cursor is a single linked list that
133  * let one feed a callchain progressively.
134  * It keeps persistent allocated entries to minimize
135  * allocations.
136  */
138  u64 ip;
139  struct map *map;
140  struct symbol *sym;
141  const char *srcline;
142  bool branch;
148 };
149 
151  u64 nr;
154  u64 pos;
156 };
157 
158 extern __thread struct callchain_cursor callchain_cursor;
159 
160 static inline void callchain_init(struct callchain_root *root)
161 {
162  INIT_LIST_HEAD(&root->node.val);
163  INIT_LIST_HEAD(&root->node.parent_val);
164 
165  root->node.parent = NULL;
166  root->node.hit = 0;
167  root->node.children_hit = 0;
168  root->node.rb_root_in = RB_ROOT;
169  root->max_depth = 0;
170 }
171 
172 static inline u64 callchain_cumul_hits(struct callchain_node *node)
173 {
174  return node->hit + node->children_hit;
175 }
176 
177 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
178 {
179  return node->count + node->children_count;
180 }
181 
182 int callchain_register_param(struct callchain_param *param);
184  struct callchain_cursor *cursor,
185  u64 period);
186 
187 int callchain_merge(struct callchain_cursor *cursor,
188  struct callchain_root *dst, struct callchain_root *src);
189 
190 /*
191  * Initialize a cursor before adding entries inside, but keep
192  * the previously allocated entries as a cache.
193  */
194 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
195 {
196  struct callchain_cursor_node *node;
197 
198  cursor->nr = 0;
199  cursor->last = &cursor->first;
200 
201  for (node = cursor->first; node != NULL; node = node->next)
202  map__zput(node->map);
203 }
204 
205 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
206  struct map *map, struct symbol *sym,
207  bool branch, struct branch_flags *flags,
208  int nr_loop_iter, u64 iter_cycles, u64 branch_from,
209  const char *srcline);
210 
211 /* Close a cursor writing session. Initialize for the reader */
212 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
213 {
214  cursor->curr = cursor->first;
215  cursor->pos = 0;
216 }
217 
218 /* Cursor reading iteration helpers */
219 static inline struct callchain_cursor_node *
221 {
222  if (cursor->pos == cursor->nr)
223  return NULL;
224 
225  return cursor->curr;
226 }
227 
228 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
229 {
230  cursor->curr = cursor->curr->next;
231  cursor->pos++;
232 }
233 
235  struct callchain_cursor *src);
236 
237 struct option;
238 struct hist_entry;
239 
240 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
241 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
242 
243 struct record_opts;
244 
246  struct callchain_param *callchain,
247  const char *arg, bool unset);
248 
250  struct callchain_cursor *cursor, struct symbol **parent,
251  struct perf_evsel *evsel, struct addr_location *al,
252  int max_stack);
253 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
254 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
255  bool hide_unresolved);
256 
257 extern const char record_callchain_help[];
258 int parse_callchain_record(const char *arg, struct callchain_param *param);
259 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
260 int parse_callchain_report_opt(const char *arg);
261 int parse_callchain_top_opt(const char *arg);
262 int perf_callchain_config(const char *var, const char *value);
263 
264 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
265  struct callchain_cursor *src)
266 {
267  *dest = *src;
268 
269  dest->first = src->curr;
270  dest->nr -= src->pos;
271 }
272 
273 #ifdef HAVE_SKIP_CALLCHAIN_IDX
274 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
275 #else
276 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
277  struct ip_callchain *chain __maybe_unused)
278 {
279  return -1;
280 }
281 #endif
282 
284  char *bf, size_t bfsize, bool show_dso);
286  char *bf, size_t bfsize, u64 total);
288  FILE *fp, u64 total);
289 
291  FILE *fp, char *bf, int bfsize);
292 
293 void free_callchain(struct callchain_root *root);
294 void decay_callchain(struct callchain_root *root);
296 
297 int callchain_branch_counts(struct callchain_root *root,
298  u64 *branch_count, u64 *predicted_count,
299  u64 *abort_count, u64 *cycles_count);
300 
301 #endif /* __PERF_CALLCHAIN_H */
chain_key
Definition: callchain.h:80
struct list_head val
Definition: callchain.h:57
unsigned int val_nr
Definition: callchain.h:63
int parse_callchain_top_opt(const char *arg)
Definition: callchain.c:238
const char * srcline
Definition: callchain.h:141
Definition: mem2node.c:7
char * callchain_list__sym_name(struct callchain_list *cl, char *bf, size_t bfsize, bool show_dso)
Definition: callchain.c:1139
int value
Definition: python.c:1143
struct rb_node rb_node
Definition: callchain.h:60
static void callchain_cursor_snapshot(struct callchain_cursor *dest, struct callchain_cursor *src)
Definition: callchain.h:264
int record_callchain_opt(const struct option *opt, const char *arg, int unset)
static void callchain_cursor_reset(struct callchain_cursor *cursor)
Definition: callchain.h:194
int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, struct map *map, struct symbol *sym, bool branch, struct branch_flags *flags, int nr_loop_iter, u64 iter_cycles, u64 branch_from, const char *srcline)
Definition: callchain.c:1038
struct symbol * sym
Definition: callchain.h:140
struct rb_root root
Definition: block-range.c:6
int parse_callchain_report_opt(const char *arg)
Definition: callchain.c:233
struct callchain_param callchain_param_default
Definition: callchain.c:49
int sample__resolve_callchain(struct perf_sample *sample, struct callchain_cursor *cursor, struct symbol **parent, struct perf_evsel *evsel, struct addr_location *al, int max_stack)
Definition: callchain.c:1075
int parse_callchain_record(const char *arg, struct callchain_param *param)
Definition: callchain.c:243
int callchain_node__fprintf_value(struct callchain_node *node, FILE *fp, u64 total)
Definition: callchain.c:1197
struct rb_root rb_root_in
Definition: callchain.h:61
struct callchain_cursor_node * next
Definition: callchain.h:147
static void callchain_cursor_commit(struct callchain_cursor *cursor)
Definition: callchain.h:212
struct callchain_node node
Definition: callchain.h:72
void decay_callchain(struct callchain_root *root)
Definition: callchain.c:1496
static unsigned callchain_cumul_counts(struct callchain_node *node)
Definition: callchain.h:177
u64 predicted_count
Definition: callchain.h:121
Definition: sort.h:89
int callchain_append(struct callchain_root *root, struct callchain_cursor *cursor, u64 period)
Definition: callchain.c:969
bool has_children
Definition: callchain.h:118
bool branch_callstack
Definition: callchain.h:106
const char * key
Definition: bpf-loader.c:196
void free_callchain(struct callchain_root *root)
Definition: callchain.c:1468
unsigned int count
Definition: callchain.h:64
const char record_callchain_help[]
Definition: thread.h:18
static void callchain_cursor_advance(struct callchain_cursor *cursor)
Definition: callchain.h:228
int callchain_cursor__copy(struct callchain_cursor *dst, struct callchain_cursor *src)
Definition: callchain.c:1544
#define map__zput(map)
Definition: map.h:167
int parse_callchain_record_opt(const char *arg, struct callchain_param *param)
Definition: callchain.c:55
struct callchain_node * parent
Definition: callchain.h:56
int callchain_merge(struct callchain_cursor *cursor, struct callchain_root *dst, struct callchain_root *src)
Definition: callchain.c:1032
sort_chain_func_t sort
Definition: callchain.h:102
int record_opts__parse_callchain(struct record_opts *record, struct callchain_param *callchain, const char *arg, bool unset)
u64 children_hit
Definition: callchain.h:67
struct rb_node rb_node_in
Definition: callchain.h:59
int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node, bool hide_unresolved)
Definition: callchain.c:1099
unsigned int children_count
Definition: callchain.h:65
char * callchain_node__scnprintf_value(struct callchain_node *node, char *bf, size_t bfsize, u64 total)
Definition: callchain.c:1168
static void callchain_init(struct callchain_root *root)
Definition: callchain.h:160
struct map * map
Definition: callchain.h:139
bool dwarf_callchain_users
Definition: callchain.c:47
chain_mode
Definition: callchain.h:42
perf_call_graph_mode
Definition: callchain.h:34
double min_percent
Definition: callchain.h:101
const char * srcline
Definition: callchain.h:127
int callchain_node__make_parent_list(struct callchain_node *node)
Definition: callchain.c:1504
chain_value
Definition: callchain.h:86
int callchain_register_param(struct callchain_param *param)
Definition: callchain.c:494
Definition: jevents.c:228
int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
int callchain_branch_counts(struct callchain_root *root, u64 *branch_count, u64 *predicted_count, u64 *abort_count, u64 *cycles_count)
Definition: callchain.c:1271
static int sym(yyscan_t scanner, int type, int config)
u32 flags
int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample)
Definition: callchain.c:1091
struct rb_root rb_root
Definition: callchain.h:62
struct callchain_cursor_node ** last
Definition: callchain.h:153
Definition: symbol.h:55
static u64 callchain_cumul_hits(struct callchain_node *node)
Definition: callchain.h:172
int callchain_list_counts__printf_value(struct callchain_list *clist, FILE *fp, char *bf, int bfsize)
Definition: callchain.c:1419
void(* sort_chain_func_t)(struct rb_root *, struct callchain_root *, u64, struct callchain_param *)
Definition: callchain.h:77
int perf_callchain_config(const char *var, const char *value)
Definition: callchain.c:306
struct callchain_cursor_node * curr
Definition: callchain.h:155
chain_order
Definition: callchain.h:50
struct list_head parent_val
Definition: callchain.h:58
struct callchain_cursor_node * first
Definition: callchain.h:152
static int arch_skip_callchain_idx(struct thread *thread __maybe_unused, struct ip_callchain *chain __maybe_unused)
Definition: callchain.h:276
static struct callchain_cursor_node * callchain_cursor_current(struct callchain_cursor *cursor)
Definition: callchain.h:220