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