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