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