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