blob: 13e75549c4407dcf750c52e123ce3d48cc57ed2c [file] [log] [blame]
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +02001#ifndef __PERF_CALLCHAIN_H
2#define __PERF_CALLCHAIN_H
3
4#include "../perf.h"
Arnaldo Carvalho de Melo5da50252009-07-01 14:46:08 -03005#include <linux/list.h>
Arnaldo Carvalho de Melo43cbcd82009-07-01 12:28:37 -03006#include <linux/rbtree.h>
Arnaldo Carvalho de Melo139633c2010-05-09 11:47:13 -03007#include "event.h"
Frederic Weisbecker44249612009-07-01 05:35:14 +02008#include "symbol.h"
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +02009
Namhyung Kim76a26542015-10-22 23:28:32 +090010#define HELP_PAD "\t\t\t\t"
11
12#define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
Namhyung Kim21cf6282015-10-22 15:28:48 +090013
14#ifdef HAVE_DWARF_UNWIND_SUPPORT
Namhyung Kim76a26542015-10-22 23:28:32 +090015# define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
Namhyung Kim21cf6282015-10-22 15:28:48 +090016#else
Namhyung Kim76a26542015-10-22 23:28:32 +090017# define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|lbr)\n"
Namhyung Kim21cf6282015-10-22 15:28:48 +090018#endif
19
Namhyung Kim76a26542015-10-22 23:28:32 +090020#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"
23
24#define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
25
26#define CALLCHAIN_REPORT_HELP \
Namhyung Kim26e77922015-11-09 14:45:37 +090027 HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
Namhyung Kim76a26542015-10-22 23:28:32 +090028 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" \
Namhyung Kimf2af0082015-11-09 14:45:41 +090032 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"
Namhyung Kim21cf6282015-10-22 15:28:48 +090034
Jiri Olsa2c83bc02014-05-05 12:46:17 +020035enum perf_call_graph_mode {
36 CALLCHAIN_NONE,
37 CALLCHAIN_FP,
38 CALLCHAIN_DWARF,
Kan Liangaad2b212015-01-05 13:23:04 -050039 CALLCHAIN_LBR,
Jiri Olsa2c83bc02014-05-05 12:46:17 +020040 CALLCHAIN_MAX
41};
42
Frederic Weisbecker4eb3e472009-07-02 17:58:21 +020043enum chain_mode {
Frederic Weisbeckerb1a88342009-08-08 02:16:24 +020044 CHAIN_NONE,
Frederic Weisbecker805d1272009-07-05 07:39:21 +020045 CHAIN_FLAT,
46 CHAIN_GRAPH_ABS,
Namhyung Kim26e77922015-11-09 14:45:37 +090047 CHAIN_GRAPH_REL,
48 CHAIN_FOLDED,
Frederic Weisbecker4eb3e472009-07-02 17:58:21 +020049};
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +020050
Sam Liaod797fdc2011-06-07 23:49:46 +080051enum chain_order {
52 ORDER_CALLER,
53 ORDER_CALLEE
54};
55
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +020056struct callchain_node {
57 struct callchain_node *parent;
Ingo Molnarf37a2912009-07-01 12:37:06 +020058 struct list_head val;
Namhyung Kim4b3a3212015-11-09 14:45:43 +090059 struct list_head parent_val;
Namhyung Kime3695172013-10-11 14:15:36 +090060 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 */
Ingo Molnarf37a2912009-07-01 12:37:06 +020064 unsigned int val_nr;
Namhyung Kim5e47f8f2015-11-09 14:45:40 +090065 unsigned int count;
66 unsigned int children_count;
Ingo Molnarf37a2912009-07-01 12:37:06 +020067 u64 hit;
Frederic Weisbecker19532872009-08-07 07:11:05 +020068 u64 children_hit;
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +020069};
70
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +020071struct callchain_root {
72 u64 max_depth;
73 struct callchain_node node;
74};
75
Frederic Weisbecker805d1272009-07-05 07:39:21 +020076struct callchain_param;
77
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +020078typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
Frederic Weisbecker805d1272009-07-05 07:39:21 +020079 u64, struct callchain_param *);
80
Andi Kleen99571ab2013-07-18 15:33:57 -070081enum chain_key {
82 CCKEY_FUNCTION,
83 CCKEY_ADDRESS
84};
85
Namhyung Kimf2af0082015-11-09 14:45:41 +090086enum chain_value {
87 CCVAL_PERCENT,
88 CCVAL_PERIOD,
89 CCVAL_COUNT,
90};
91
Frederic Weisbecker805d1272009-07-05 07:39:21 +020092struct callchain_param {
Namhyung Kim72a128a2014-09-23 10:01:41 +090093 bool enabled;
94 enum perf_call_graph_mode record_mode;
95 u32 dump_size;
Frederic Weisbecker805d1272009-07-05 07:39:21 +020096 enum chain_mode mode;
Arnaldo Carvalho de Melo792d48b2016-04-28 19:03:42 -030097 u16 max_stack;
Arnaldo Carvalho de Melo232a5c92010-05-09 20:28:10 -030098 u32 print_limit;
Frederic Weisbecker805d1272009-07-05 07:39:21 +020099 double min_percent;
100 sort_chain_func_t sort;
Sam Liaod797fdc2011-06-07 23:49:46 +0800101 enum chain_order order;
Namhyung Kim792aeaf2015-10-22 16:45:46 +0900102 bool order_set;
Andi Kleen99571ab2013-07-18 15:33:57 -0700103 enum chain_key key;
Andi Kleen8b7bad52014-11-12 18:05:20 -0800104 bool branch_callstack;
Namhyung Kimf2af0082015-11-09 14:45:41 +0900105 enum chain_value value;
Frederic Weisbecker805d1272009-07-05 07:39:21 +0200106};
107
Arnaldo Carvalho de Melo8f651ea2014-10-09 16:12:24 -0300108extern struct callchain_param callchain_param;
Jiri Olsa347ca872016-07-04 14:16:21 +0200109extern struct callchain_param callchain_param_default;
Arnaldo Carvalho de Melo8f651ea2014-10-09 16:12:24 -0300110
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +0200111struct callchain_list {
Ingo Molnarf37a2912009-07-01 12:37:06 +0200112 u64 ip;
Arnaldo Carvalho de Melob3c9ac02010-03-24 16:40:18 -0300113 struct map_symbol ms;
Namhyung Kim3698dab2015-05-05 23:55:46 +0900114 struct /* for TUI */ {
115 bool unfolded;
116 bool has_children;
117 };
Andi Kleen23f09812014-11-12 18:05:24 -0800118 char *srcline;
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +0200119 struct list_head list;
120};
121
Frederic Weisbecker1b3a0e92011-01-14 04:51:58 +0100122/*
123 * A callchain cursor is a single linked list that
124 * let one feed a callchain progressively.
Masanari Iida3fd44cd2012-07-18 01:20:59 +0900125 * It keeps persistent allocated entries to minimize
Frederic Weisbecker1b3a0e92011-01-14 04:51:58 +0100126 * allocations.
127 */
128struct callchain_cursor_node {
129 u64 ip;
130 struct map *map;
131 struct symbol *sym;
132 struct callchain_cursor_node *next;
133};
134
135struct callchain_cursor {
136 u64 nr;
137 struct callchain_cursor_node *first;
138 struct callchain_cursor_node **last;
139 u64 pos;
140 struct callchain_cursor_node *curr;
141};
142
Namhyung Kim47260642012-05-31 14:43:26 +0900143extern __thread struct callchain_cursor callchain_cursor;
144
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +0200145static inline void callchain_init(struct callchain_root *root)
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +0200146{
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +0200147 INIT_LIST_HEAD(&root->node.val);
Jiri Olsa646a6e82015-11-21 11:23:55 +0100148 INIT_LIST_HEAD(&root->node.parent_val);
Frederic Weisbecker97aa1052010-07-08 06:06:17 +0200149
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +0200150 root->node.parent = NULL;
151 root->node.hit = 0;
Frederic Weisbecker98ee74a2010-08-27 02:28:40 +0200152 root->node.children_hit = 0;
Namhyung Kime3695172013-10-11 14:15:36 +0900153 root->node.rb_root_in = RB_ROOT;
Frederic Weisbeckerd2009c52010-08-22 20:05:22 +0200154 root->max_depth = 0;
Frederic Weisbecker8cb76d92009-06-26 16:28:00 +0200155}
156
Frederic Weisbeckerf08c3152011-01-14 04:51:59 +0100157static inline u64 callchain_cumul_hits(struct callchain_node *node)
Frederic Weisbecker19532872009-08-07 07:11:05 +0200158{
159 return node->hit + node->children_hit;
160}
161
Namhyung Kim5e47f8f2015-11-09 14:45:40 +0900162static inline unsigned callchain_cumul_counts(struct callchain_node *node)
163{
164 return node->count + node->children_count;
165}
166
Frederic Weisbecker16537f12011-01-14 04:52:00 +0100167int callchain_register_param(struct callchain_param *param);
Frederic Weisbecker1b3a0e92011-01-14 04:51:58 +0100168int callchain_append(struct callchain_root *root,
169 struct callchain_cursor *cursor,
170 u64 period);
171
172int callchain_merge(struct callchain_cursor *cursor,
173 struct callchain_root *dst, struct callchain_root *src);
Arnaldo Carvalho de Melo139633c2010-05-09 11:47:13 -0300174
Frederic Weisbecker1b3a0e92011-01-14 04:51:58 +0100175/*
176 * Initialize a cursor before adding entries inside, but keep
177 * the previously allocated entries as a cache.
178 */
179static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
180{
181 cursor->nr = 0;
182 cursor->last = &cursor->first;
183}
184
185int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
186 struct map *map, struct symbol *sym);
187
188/* Close a cursor writing session. Initialize for the reader */
189static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
190{
191 cursor->curr = cursor->first;
192 cursor->pos = 0;
193}
194
195/* Cursor reading iteration helpers */
196static inline struct callchain_cursor_node *
197callchain_cursor_current(struct callchain_cursor *cursor)
198{
199 if (cursor->pos == cursor->nr)
200 return NULL;
201
202 return cursor->curr;
203}
204
205static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
206{
207 cursor->curr = cursor->curr->next;
208 cursor->pos++;
209}
Arnaldo Carvalho de Melo75d9a1082012-12-11 16:46:05 -0300210
211struct option;
Namhyung Kim2dc9fb12014-01-14 14:25:35 +0900212struct hist_entry;
Arnaldo Carvalho de Melo75d9a1082012-12-11 16:46:05 -0300213
214int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
Jiri Olsa09b0fd42013-10-26 16:25:33 +0200215int record_callchain_opt(const struct option *opt, const char *arg, int unset);
216
Arnaldo Carvalho de Melo0883e822016-04-15 16:37:17 -0300217struct record_opts;
218
219int record_opts__parse_callchain(struct record_opts *record,
220 struct callchain_param *callchain,
221 const char *arg, bool unset);
222
Arnaldo Carvalho de Melo91d7b2d2016-04-14 14:48:07 -0300223int sample__resolve_callchain(struct perf_sample *sample,
224 struct callchain_cursor *cursor, struct symbol **parent,
Namhyung Kim2dc9fb12014-01-14 14:25:35 +0900225 struct perf_evsel *evsel, struct addr_location *al,
226 int max_stack);
227int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
Namhyung Kimc7405d82013-10-31 13:58:30 +0900228int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
229 bool hide_unresolved);
Namhyung Kim2dc9fb12014-01-14 14:25:35 +0900230
Arnaldo Carvalho de Melo75d9a1082012-12-11 16:46:05 -0300231extern const char record_callchain_help[];
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300232int parse_callchain_record(const char *arg, struct callchain_param *param);
Kan Liangc3a6a8c2015-08-04 04:30:20 -0400233int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
Don Zickuscff6bb42014-04-07 14:55:24 -0400234int parse_callchain_report_opt(const char *arg);
Namhyung Kima2c10d32015-10-22 15:28:49 +0900235int parse_callchain_top_opt(const char *arg);
Namhyung Kim2b9240c2014-09-23 10:01:43 +0900236int perf_callchain_config(const char *var, const char *value);
Namhyung Kimbe1f13e2012-09-10 13:38:00 +0900237
238static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
239 struct callchain_cursor *src)
240{
241 *dest = *src;
242
243 dest->first = src->curr;
244 dest->nr -= src->pos;
245}
Sukadev Bhattiprolua60335b2014-06-25 08:49:03 -0700246
247#ifdef HAVE_SKIP_CALLCHAIN_IDX
Arnaldo Carvalho de Melo3938bad2016-03-23 15:06:35 -0300248int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
Sukadev Bhattiprolua60335b2014-06-25 08:49:03 -0700249#else
Arnaldo Carvalho de Melobb871a92014-10-23 12:50:25 -0300250static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
Sukadev Bhattiprolua60335b2014-06-25 08:49:03 -0700251 struct ip_callchain *chain __maybe_unused)
252{
253 return -1;
254}
255#endif
256
Andi Kleen2989cca2014-11-12 18:05:23 -0800257char *callchain_list__sym_name(struct callchain_list *cl,
258 char *bf, size_t bfsize, bool show_dso);
Namhyung Kim5ab250c2015-11-09 14:45:39 +0900259char *callchain_node__scnprintf_value(struct callchain_node *node,
260 char *bf, size_t bfsize, u64 total);
261int callchain_node__fprintf_value(struct callchain_node *node,
262 FILE *fp, u64 total);
Andi Kleen2989cca2014-11-12 18:05:23 -0800263
Namhyung Kimd1149602014-12-30 14:38:13 +0900264void free_callchain(struct callchain_root *root);
Namhyung Kim42b276a2016-01-05 12:06:00 +0900265void decay_callchain(struct callchain_root *root);
Namhyung Kim4b3a3212015-11-09 14:45:43 +0900266int callchain_node__make_parent_list(struct callchain_node *node);
Namhyung Kimd1149602014-12-30 14:38:13 +0900267
John Kacur8b40f522009-09-24 18:02:18 +0200268#endif /* __PERF_CALLCHAIN_H */