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