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