1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PERF_CALLCHAIN_H 3 #define __PERF_CALLCHAIN_H 4 5 #include <linux/list.h> 6 #include <linux/rbtree.h> 7 #include "event.h" 8 #include "map_symbol.h" 9 #include "branch.h" 10 11 struct evsel; 12 struct map; 13 14 #define HELP_PAD "\t\t\t\t" 15 16 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n" 17 18 # define RECORD_MODE_HELP HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n" 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 CCKEY_SRCLINE 85 }; 86 87 enum chain_value { 88 CCVAL_PERCENT, 89 CCVAL_PERIOD, 90 CCVAL_COUNT, 91 }; 92 93 extern bool dwarf_callchain_users; 94 95 struct callchain_param { 96 bool enabled; 97 enum perf_call_graph_mode record_mode; 98 u32 dump_size; 99 enum chain_mode mode; 100 u16 max_stack; 101 u32 print_limit; 102 double min_percent; 103 sort_chain_func_t sort; 104 enum chain_order order; 105 bool order_set; 106 enum chain_key key; 107 bool branch_callstack; 108 enum chain_value value; 109 }; 110 111 extern struct callchain_param callchain_param; 112 extern struct callchain_param callchain_param_default; 113 114 struct callchain_list { 115 u64 ip; 116 struct map_symbol ms; 117 struct /* for TUI */ { 118 bool unfolded; 119 bool has_children; 120 }; 121 u64 branch_count; 122 u64 from_count; 123 u64 predicted_count; 124 u64 abort_count; 125 u64 cycles_count; 126 u64 iter_count; 127 u64 iter_cycles; 128 struct branch_type_stat brtype_stat; 129 const char *srcline; 130 struct list_head list; 131 }; 132 133 /* 134 * A callchain cursor is a single linked list that 135 * let one feed a callchain progressively. 136 * It keeps persistent allocated entries to minimize 137 * allocations. 138 */ 139 struct callchain_cursor_node { 140 u64 ip; 141 struct map *map; 142 struct symbol *sym; 143 const char *srcline; 144 bool branch; 145 struct branch_flags branch_flags; 146 u64 branch_from; 147 int nr_loop_iter; 148 u64 iter_cycles; 149 struct callchain_cursor_node *next; 150 }; 151 152 struct callchain_cursor { 153 u64 nr; 154 struct callchain_cursor_node *first; 155 struct callchain_cursor_node **last; 156 u64 pos; 157 struct callchain_cursor_node *curr; 158 }; 159 160 extern __thread struct callchain_cursor callchain_cursor; 161 162 static inline void callchain_init(struct callchain_root *root) 163 { 164 INIT_LIST_HEAD(&root->node.val); 165 INIT_LIST_HEAD(&root->node.parent_val); 166 167 root->node.parent = NULL; 168 root->node.hit = 0; 169 root->node.children_hit = 0; 170 root->node.rb_root_in = RB_ROOT; 171 root->max_depth = 0; 172 } 173 174 static inline u64 callchain_cumul_hits(struct callchain_node *node) 175 { 176 return node->hit + node->children_hit; 177 } 178 179 static inline unsigned callchain_cumul_counts(struct callchain_node *node) 180 { 181 return node->count + node->children_count; 182 } 183 184 int callchain_register_param(struct callchain_param *param); 185 int callchain_append(struct callchain_root *root, 186 struct callchain_cursor *cursor, 187 u64 period); 188 189 int callchain_merge(struct callchain_cursor *cursor, 190 struct callchain_root *dst, struct callchain_root *src); 191 192 void callchain_cursor_reset(struct callchain_cursor *cursor); 193 194 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip, 195 struct map *map, struct symbol *sym, 196 bool branch, struct branch_flags *flags, 197 int nr_loop_iter, u64 iter_cycles, u64 branch_from, 198 const char *srcline); 199 200 /* Close a cursor writing session. Initialize for the reader */ 201 static inline void callchain_cursor_commit(struct callchain_cursor *cursor) 202 { 203 cursor->curr = cursor->first; 204 cursor->pos = 0; 205 } 206 207 /* Cursor reading iteration helpers */ 208 static inline struct callchain_cursor_node * 209 callchain_cursor_current(struct callchain_cursor *cursor) 210 { 211 if (cursor->pos == cursor->nr) 212 return NULL; 213 214 return cursor->curr; 215 } 216 217 static inline void callchain_cursor_advance(struct callchain_cursor *cursor) 218 { 219 cursor->curr = cursor->curr->next; 220 cursor->pos++; 221 } 222 223 int callchain_cursor__copy(struct callchain_cursor *dst, 224 struct callchain_cursor *src); 225 226 struct option; 227 struct hist_entry; 228 229 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset); 230 int record_callchain_opt(const struct option *opt, const char *arg, int unset); 231 232 struct record_opts; 233 234 int record_opts__parse_callchain(struct record_opts *record, 235 struct callchain_param *callchain, 236 const char *arg, bool unset); 237 238 int sample__resolve_callchain(struct perf_sample *sample, 239 struct callchain_cursor *cursor, struct symbol **parent, 240 struct evsel *evsel, struct addr_location *al, 241 int max_stack); 242 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample); 243 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node, 244 bool hide_unresolved); 245 246 extern const char record_callchain_help[]; 247 int parse_callchain_record(const char *arg, struct callchain_param *param); 248 int parse_callchain_record_opt(const char *arg, struct callchain_param *param); 249 int parse_callchain_report_opt(const char *arg); 250 int parse_callchain_top_opt(const char *arg); 251 int perf_callchain_config(const char *var, const char *value); 252 253 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest, 254 struct callchain_cursor *src) 255 { 256 *dest = *src; 257 258 dest->first = src->curr; 259 dest->nr -= src->pos; 260 } 261 262 #ifdef HAVE_SKIP_CALLCHAIN_IDX 263 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain); 264 #else 265 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused, 266 struct ip_callchain *chain __maybe_unused) 267 { 268 return -1; 269 } 270 #endif 271 272 char *callchain_list__sym_name(struct callchain_list *cl, 273 char *bf, size_t bfsize, bool show_dso); 274 char *callchain_node__scnprintf_value(struct callchain_node *node, 275 char *bf, size_t bfsize, u64 total); 276 int callchain_node__fprintf_value(struct callchain_node *node, 277 FILE *fp, u64 total); 278 279 int callchain_list_counts__printf_value(struct callchain_list *clist, 280 FILE *fp, char *bf, int bfsize); 281 282 void free_callchain(struct callchain_root *root); 283 void decay_callchain(struct callchain_root *root); 284 int callchain_node__make_parent_list(struct callchain_node *node); 285 286 int callchain_branch_counts(struct callchain_root *root, 287 u64 *branch_count, u64 *predicted_count, 288 u64 *abort_count, u64 *cycles_count); 289 290 #endif /* __PERF_CALLCHAIN_H */ 291