tools/perf/util/callchain.h

   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         char                   *srcline;
 115         struct list_head        list;
 116 };
 117
 118 /*
 119  * A callchain cursor is a single linked list that
 120  * let one feed a callchain progressively.
 121  * It keeps persistent allocated entries to minimize
 122  * allocations.
 123  */
 124 struct callchain_cursor_node {
 125         u64                             ip;
 126         struct map                      *map;
 127         struct symbol                   *sym;
 128         struct callchain_cursor_node    *next;
 129 };
 130
 131 struct callchain_cursor {
 132         u64                             nr;
 133         struct callchain_cursor_node    *first;
 134         struct callchain_cursor_node    **last;
 135         u64                             pos;
 136         struct callchain_cursor_node    *curr;
 137 };
 138
 139 extern __thread struct callchain_cursor callchain_cursor;
 140
 141 static inline void callchain_init(struct callchain_root *root)
 142 {
 143         INIT_LIST_HEAD(&root->node.val);
 144         INIT_LIST_HEAD(&root->node.parent_val);
 145
 146         root->node.parent = NULL;
 147         root->node.hit = 0;
 148         root->node.children_hit = 0;
 149         root->node.rb_root_in = RB_ROOT;
 150         root->max_depth = 0;
 151 }
 152
 153 static inline u64 callchain_cumul_hits(struct callchain_node *node)
 154 {
 155         return node->hit + node->children_hit;
 156 }
 157
 158 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
 159 {
 160         return node->count + node->children_count;
 161 }
 162
 163 int callchain_register_param(struct callchain_param *param);
 164 int callchain_append(struct callchain_root *root,
 165                      struct callchain_cursor *cursor,
 166                      u64 period);
 167
 168 int callchain_merge(struct callchain_cursor *cursor,
 169                     struct callchain_root *dst, struct callchain_root *src);
 170
 171 /*
 172  * Initialize a cursor before adding entries inside, but keep
 173  * the previously allocated entries as a cache.
 174  */
 175 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
 176 {
 177         cursor->nr = 0;
 178         cursor->last = &cursor->first;
 179 }
 180
 181 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
 182                             struct map *map, struct symbol *sym);
 183
 184 /* Close a cursor writing session. Initialize for the reader */
 185 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
 186 {
 187         cursor->curr = cursor->first;
 188         cursor->pos = 0;
 189 }
 190
 191 /* Cursor reading iteration helpers */
 192 static inline struct callchain_cursor_node *
 193 callchain_cursor_current(struct callchain_cursor *cursor)
 194 {
 195         if (cursor->pos == cursor->nr)
 196                 return NULL;
 197
 198         return cursor->curr;
 199 }
 200
 201 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
 202 {
 203         cursor->curr = cursor->curr->next;
 204         cursor->pos++;
 205 }
 206
 207 struct option;
 208 struct hist_entry;
 209
 210 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
 211 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
 212
 213 struct record_opts;
 214
 215 int record_opts__parse_callchain(struct record_opts *record,
 216                                  struct callchain_param *callchain,
 217                                  const char *arg, bool unset);
 218
 219 int sample__resolve_callchain(struct perf_sample *sample,
 220                               struct callchain_cursor *cursor, struct symbol **parent,
 221                               struct perf_evsel *evsel, struct addr_location *al,
 222                               int max_stack);
 223 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
 224 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
 225                         bool hide_unresolved);
 226
 227 extern const char record_callchain_help[];
 228 int parse_callchain_record(const char *arg, struct callchain_param *param);
 229 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
 230 int parse_callchain_report_opt(const char *arg);
 231 int parse_callchain_top_opt(const char *arg);
 232 int perf_callchain_config(const char *var, const char *value);
 233
 234 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
 235                                              struct callchain_cursor *src)
 236 {
 237         *dest = *src;
 238
 239         dest->first = src->curr;
 240         dest->nr -= src->pos;
 241 }
 242
 243 #ifdef HAVE_SKIP_CALLCHAIN_IDX
 244 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
 245 #else
 246 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
 247                         struct ip_callchain *chain __maybe_unused)
 248 {
 249         return -1;
 250 }
 251 #endif
 252
 253 char *callchain_list__sym_name(struct callchain_list *cl,
 254                                char *bf, size_t bfsize, bool show_dso);
 255 char *callchain_node__scnprintf_value(struct callchain_node *node,
 256                                       char *bf, size_t bfsize, u64 total);
 257 int callchain_node__fprintf_value(struct callchain_node *node,
 258                                   FILE *fp, u64 total);
 259
 260 void free_callchain(struct callchain_root *root);
 261 void decay_callchain(struct callchain_root *root);
 262 int callchain_node__make_parent_list(struct callchain_node *node);
 263
 264 #endif  /* __PERF_CALLCHAIN_H */