1 #ifndef __PERF_CALLCHAIN_H 2 #define __PERF_CALLCHAIN_H 3 4 #include "../perf.h" 5 #include <linux/list.h> 6 #include <linux/rbtree.h> 7 #include "event.h" 8 #include "symbol.h" 9 10 #define HELP_PAD "\t\t\t\t" 11 12 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n" 13 14 #ifdef HAVE_DWARF_UNWIND_SUPPORT 15 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n" 16 #else 17 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|lbr)\n" 18 #endif 19 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" 23 24 #define CALLCHAIN_RECORD_HELP CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP 25 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" 34 35 enum perf_call_graph_mode { 36 CALLCHAIN_NONE, 37 CALLCHAIN_FP, 38 CALLCHAIN_DWARF, 39 CALLCHAIN_LBR, 40 CALLCHAIN_MAX 41 }; 42 43 enum chain_mode { 44 CHAIN_NONE, 45 CHAIN_FLAT, 46 CHAIN_GRAPH_ABS, 47 CHAIN_GRAPH_REL, 48 CHAIN_FOLDED, 49 }; 50 51 enum chain_order { 52 ORDER_CALLER, 53 ORDER_CALLEE 54 }; 55 56 struct callchain_node { 57 struct callchain_node *parent; 58 struct list_head val; 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 */ 64 unsigned int val_nr; 65 unsigned int count; 66 unsigned int children_count; 67 u64 hit; 68 u64 children_hit; 69 }; 70 71 struct callchain_root { 72 u64 max_depth; 73 struct callchain_node node; 74 }; 75 76 struct callchain_param; 77 78 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *, 79 u64, struct callchain_param *); 80 81 enum chain_key { 82 CCKEY_FUNCTION, 83 CCKEY_ADDRESS 84 }; 85 86 enum chain_value { 87 CCVAL_PERCENT, 88 CCVAL_PERIOD, 89 CCVAL_COUNT, 90 }; 91 92 struct callchain_param { 93 bool enabled; 94 enum perf_call_graph_mode record_mode; 95 u32 dump_size; 96 enum chain_mode mode; 97 u16 max_stack; 98 u32 print_limit; 99 double min_percent; 100 sort_chain_func_t sort; 101 enum chain_order order; 102 bool order_set; 103 enum chain_key key; 104 bool branch_callstack; 105 enum chain_value value; 106 }; 107 108 extern struct callchain_param callchain_param; 109 110 struct callchain_list { 111 u64 ip; 112 struct map_symbol ms; 113 struct /* for TUI */ { 114 bool unfolded; 115 bool has_children; 116 }; 117 char *srcline; 118 struct list_head list; 119 }; 120 121 /* 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 125 * allocations. 126 */ 127 struct callchain_cursor_node { 128 u64 ip; 129 struct map *map; 130 struct symbol *sym; 131 struct callchain_cursor_node *next; 132 }; 133 134 struct callchain_cursor { 135 u64 nr; 136 struct callchain_cursor_node *first; 137 struct callchain_cursor_node **last; 138 u64 pos; 139 struct callchain_cursor_node *curr; 140 }; 141 142 extern __thread struct callchain_cursor callchain_cursor; 143 144 static inline void callchain_init(struct callchain_root *root) 145 { 146 INIT_LIST_HEAD(&root->node.val); 147 INIT_LIST_HEAD(&root->node.parent_val); 148 149 root->node.parent = NULL; 150 root->node.hit = 0; 151 root->node.children_hit = 0; 152 root->node.rb_root_in = RB_ROOT; 153 root->max_depth = 0; 154 } 155 156 static inline u64 callchain_cumul_hits(struct callchain_node *node) 157 { 158 return node->hit + node->children_hit; 159 } 160 161 static inline unsigned callchain_cumul_counts(struct callchain_node *node) 162 { 163 return node->count + node->children_count; 164 } 165 166 int callchain_register_param(struct callchain_param *param); 167 int callchain_append(struct callchain_root *root, 168 struct callchain_cursor *cursor, 169 u64 period); 170 171 int callchain_merge(struct callchain_cursor *cursor, 172 struct callchain_root *dst, struct callchain_root *src); 173 174 /* 175 * Initialize a cursor before adding entries inside, but keep 176 * the previously allocated entries as a cache. 177 */ 178 static inline void callchain_cursor_reset(struct callchain_cursor *cursor) 179 { 180 cursor->nr = 0; 181 cursor->last = &cursor->first; 182 } 183 184 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, 185 struct map *map, struct symbol *sym); 186 187 /* Close a cursor writing session. Initialize for the reader */ 188 static inline void callchain_cursor_commit(struct callchain_cursor *cursor) 189 { 190 cursor->curr = cursor->first; 191 cursor->pos = 0; 192 } 193 194 /* Cursor reading iteration helpers */ 195 static inline struct callchain_cursor_node * 196 callchain_cursor_current(struct callchain_cursor *cursor) 197 { 198 if (cursor->pos == cursor->nr) 199 return NULL; 200 201 return cursor->curr; 202 } 203 204 static inline void callchain_cursor_advance(struct callchain_cursor *cursor) 205 { 206 cursor->curr = cursor->curr->next; 207 cursor->pos++; 208 } 209 210 struct option; 211 struct hist_entry; 212 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); 215 216 struct record_opts; 217 218 int record_opts__parse_callchain(struct record_opts *record, 219 struct callchain_param *callchain, 220 const char *arg, bool unset); 221 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, 225 int max_stack); 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); 229 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); 236 237 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest, 238 struct callchain_cursor *src) 239 { 240 *dest = *src; 241 242 dest->first = src->curr; 243 dest->nr -= src->pos; 244 } 245 246 #ifdef HAVE_SKIP_CALLCHAIN_IDX 247 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain); 248 #else 249 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused, 250 struct ip_callchain *chain __maybe_unused) 251 { 252 return -1; 253 } 254 #endif 255 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); 262 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); 266 267 #endif /* __PERF_CALLCHAIN_H */ 268