tools/perf/util/callchain.h

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