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         CCKEY_SRCLINE
  82 };
  83
  84 enum chain_value {
  85         CCVAL_PERCENT,
  86         CCVAL_PERIOD,
  87         CCVAL_COUNT,
  88 };
  89
  90 struct callchain_param {
  91         bool                    enabled;
  92         enum perf_call_graph_mode record_mode;
  93         u32                     dump_size;
  94         enum chain_mode         mode;
  95         u16                     max_stack;
  96         u32                     print_limit;
  97         double                  min_percent;
  98         sort_chain_func_t       sort;
  99         enum chain_order        order;
 100         bool                    order_set;
 101         enum chain_key          key;
 102         bool                    branch_callstack;
 103         enum chain_value        value;
 104 };
 105
 106 extern struct callchain_param callchain_param;
 107 extern struct callchain_param callchain_param_default;
 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         u64                     branch_count;
 117         u64                     predicted_count;
 118         u64                     abort_count;
 119         u64                     cycles_count;
 120         u64                     iter_count;
 121         u64                     samples_count;
 122         char                   *srcline;
 123         struct list_head        list;
 124 };
 125
 126 /*
 127  * A callchain cursor is a single linked list that
 128  * let one feed a callchain progressively.
 129  * It keeps persistent allocated entries to minimize
 130  * allocations.
 131  */
 132 struct callchain_cursor_node {
 133         u64                             ip;
 134         struct map                      *map;
 135         struct symbol                   *sym;
 136         bool                            branch;
 137         struct branch_flags             branch_flags;
 138         int                             nr_loop_iter;
 139         int                             samples;
 140         struct callchain_cursor_node    *next;
 141 };
 142
 143 struct callchain_cursor {
 144         u64                             nr;
 145         struct callchain_cursor_node    *first;
 146         struct callchain_cursor_node    **last;
 147         u64                             pos;
 148         struct callchain_cursor_node    *curr;
 149 };
 150
 151 extern __thread struct callchain_cursor callchain_cursor;
 152
 153 static inline void callchain_init(struct callchain_root *root)
 154 {
 155         INIT_LIST_HEAD(&root->node.val);
 156         INIT_LIST_HEAD(&root->node.parent_val);
 157
 158         root->node.parent = NULL;
 159         root->node.hit = 0;
 160         root->node.children_hit = 0;
 161         root->node.rb_root_in = RB_ROOT;
 162         root->max_depth = 0;
 163 }
 164
 165 static inline u64 callchain_cumul_hits(struct callchain_node *node)
 166 {
 167         return node->hit + node->children_hit;
 168 }
 169
 170 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
 171 {
 172         return node->count + node->children_count;
 173 }
 174
 175 int callchain_register_param(struct callchain_param *param);
 176 int callchain_append(struct callchain_root *root,
 177                      struct callchain_cursor *cursor,
 178                      u64 period);
 179
 180 int callchain_merge(struct callchain_cursor *cursor,
 181                     struct callchain_root *dst, struct callchain_root *src);
 182
 183 /*
 184  * Initialize a cursor before adding entries inside, but keep
 185  * the previously allocated entries as a cache.
 186  */
 187 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
 188 {
 189         struct callchain_cursor_node *node;
 190
 191         cursor->nr = 0;
 192         cursor->last = &cursor->first;
 193
 194         for (node = cursor->first; node != NULL; node = node->next)
 195                 map__zput(node->map);
 196 }
 197
 198 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
 199                             struct map *map, struct symbol *sym,
 200                             bool branch, struct branch_flags *flags,
 201                             int nr_loop_iter, int samples);
 202
 203 /* Close a cursor writing session. Initialize for the reader */
 204 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
 205 {
 206         cursor->curr = cursor->first;
 207         cursor->pos = 0;
 208 }
 209
 210 /* Cursor reading iteration helpers */
 211 static inline struct callchain_cursor_node *
 212 callchain_cursor_current(struct callchain_cursor *cursor)
 213 {
 214         if (cursor->pos == cursor->nr)
 215                 return NULL;
 216
 217         return cursor->curr;
 218 }
 219
 220 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
 221 {
 222         cursor->curr = cursor->curr->next;
 223         cursor->pos++;
 224 }
 225
 226 int callchain_cursor__copy(struct callchain_cursor *dst,
 227                            struct callchain_cursor *src);
 228
 229 struct option;
 230 struct hist_entry;
 231
 232 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
 233 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
 234
 235 struct record_opts;
 236
 237 int record_opts__parse_callchain(struct record_opts *record,
 238                                  struct callchain_param *callchain,
 239                                  const char *arg, bool unset);
 240
 241 int sample__resolve_callchain(struct perf_sample *sample,
 242                               struct callchain_cursor *cursor, struct symbol **parent,
 243                               struct perf_evsel *evsel, struct addr_location *al,
 244                               int max_stack);
 245 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
 246 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
 247                         bool hide_unresolved);
 248
 249 extern const char record_callchain_help[];
 250 int parse_callchain_record(const char *arg, struct callchain_param *param);
 251 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
 252 int parse_callchain_report_opt(const char *arg);
 253 int parse_callchain_top_opt(const char *arg);
 254 int perf_callchain_config(const char *var, const char *value);
 255
 256 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
 257                                              struct callchain_cursor *src)
 258 {
 259         *dest = *src;
 260
 261         dest->first = src->curr;
 262         dest->nr -= src->pos;
 263 }
 264
 265 #ifdef HAVE_SKIP_CALLCHAIN_IDX
 266 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
 267 #else
 268 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
 269                         struct ip_callchain *chain __maybe_unused)
 270 {
 271         return -1;
 272 }
 273 #endif
 274
 275 char *callchain_list__sym_name(struct callchain_list *cl,
 276                                char *bf, size_t bfsize, bool show_dso);
 277 char *callchain_node__scnprintf_value(struct callchain_node *node,
 278                                       char *bf, size_t bfsize, u64 total);
 279 int callchain_node__fprintf_value(struct callchain_node *node,
 280                                   FILE *fp, u64 total);
 281
 282 int callchain_list_counts__printf_value(struct callchain_node *node,
 283                                         struct callchain_list *clist,
 284                                         FILE *fp, char *bf, int bfsize);
 285
 286 void free_callchain(struct callchain_root *root);
 287 void decay_callchain(struct callchain_root *root);
 288 int callchain_node__make_parent_list(struct callchain_node *node);
 289
 290 int callchain_branch_counts(struct callchain_root *root,
 291                             u64 *branch_count, u64 *predicted_count,
 292                             u64 *abort_count, u64 *cycles_count);
 293
 294 #endif  /* __PERF_CALLCHAIN_H */