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 enum perf_call_graph_mode {
  11         CALLCHAIN_NONE,
  12         CALLCHAIN_FP,
  13         CALLCHAIN_DWARF,
  14         CALLCHAIN_MAX
  15 };
  16
  17 enum chain_mode {
  18         CHAIN_NONE,
  19         CHAIN_FLAT,
  20         CHAIN_GRAPH_ABS,
  21         CHAIN_GRAPH_REL
  22 };
  23
  24 enum chain_order {
  25         ORDER_CALLER,
  26         ORDER_CALLEE
  27 };
  28
  29 struct callchain_node {
  30         struct callchain_node   *parent;
  31         struct list_head        val;
  32         struct rb_node          rb_node_in; /* to insert nodes in an rbtree */
  33         struct rb_node          rb_node;    /* to sort nodes in an output tree */
  34         struct rb_root          rb_root_in; /* input tree of children */
  35         struct rb_root          rb_root;    /* sorted output tree of children */
  36         unsigned int            val_nr;
  37         u64                     hit;
  38         u64                     children_hit;
  39 };
  40
  41 struct callchain_root {
  42         u64                     max_depth;
  43         struct callchain_node   node;
  44 };
  45
  46 struct callchain_param;
  47
  48 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
  49                                  u64, struct callchain_param *);
  50
  51 enum chain_key {
  52         CCKEY_FUNCTION,
  53         CCKEY_ADDRESS
  54 };
  55
  56 struct callchain_param {
  57         bool                    enabled;
  58         enum perf_call_graph_mode record_mode;
  59         u32                     dump_size;
  60         enum chain_mode         mode;
  61         u32                     print_limit;
  62         double                  min_percent;
  63         sort_chain_func_t       sort;
  64         enum chain_order        order;
  65         enum chain_key          key;
  66 };
  67
  68 extern struct callchain_param callchain_param;
  69
  70 struct callchain_list {
  71         u64                     ip;
  72         struct map_symbol       ms;
  73         struct list_head        list;
  74 };
  75
  76 /*
  77  * A callchain cursor is a single linked list that
  78  * let one feed a callchain progressively.
  79  * It keeps persistent allocated entries to minimize
  80  * allocations.
  81  */
  82 struct callchain_cursor_node {
  83         u64                             ip;
  84         struct map                      *map;
  85         struct symbol                   *sym;
  86         struct callchain_cursor_node    *next;
  87 };
  88
  89 struct callchain_cursor {
  90         u64                             nr;
  91         struct callchain_cursor_node    *first;
  92         struct callchain_cursor_node    **last;
  93         u64                             pos;
  94         struct callchain_cursor_node    *curr;
  95 };
  96
  97 extern __thread struct callchain_cursor callchain_cursor;
  98
  99 static inline void callchain_init(struct callchain_root *root)
 100 {
 101         INIT_LIST_HEAD(&root->node.val);
 102
 103         root->node.parent = NULL;
 104         root->node.hit = 0;
 105         root->node.children_hit = 0;
 106         root->node.rb_root_in = RB_ROOT;
 107         root->max_depth = 0;
 108 }
 109
 110 static inline u64 callchain_cumul_hits(struct callchain_node *node)
 111 {
 112         return node->hit + node->children_hit;
 113 }
 114
 115 int callchain_register_param(struct callchain_param *param);
 116 int callchain_append(struct callchain_root *root,
 117                      struct callchain_cursor *cursor,
 118                      u64 period);
 119
 120 int callchain_merge(struct callchain_cursor *cursor,
 121                     struct callchain_root *dst, struct callchain_root *src);
 122
 123 /*
 124  * Initialize a cursor before adding entries inside, but keep
 125  * the previously allocated entries as a cache.
 126  */
 127 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
 128 {
 129         cursor->nr = 0;
 130         cursor->last = &cursor->first;
 131 }
 132
 133 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
 134                             struct map *map, struct symbol *sym);
 135
 136 /* Close a cursor writing session. Initialize for the reader */
 137 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
 138 {
 139         cursor->curr = cursor->first;
 140         cursor->pos = 0;
 141 }
 142
 143 /* Cursor reading iteration helpers */
 144 static inline struct callchain_cursor_node *
 145 callchain_cursor_current(struct callchain_cursor *cursor)
 146 {
 147         if (cursor->pos == cursor->nr)
 148                 return NULL;
 149
 150         return cursor->curr;
 151 }
 152
 153 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
 154 {
 155         cursor->curr = cursor->curr->next;
 156         cursor->pos++;
 157 }
 158
 159 struct option;
 160 struct hist_entry;
 161
 162 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
 163 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
 164
 165 int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent,
 166                               struct perf_evsel *evsel, struct addr_location *al,
 167                               int max_stack);
 168 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
 169 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
 170                         bool hide_unresolved);
 171
 172 extern const char record_callchain_help[];
 173 int parse_callchain_record_opt(const char *arg);
 174 int parse_callchain_report_opt(const char *arg);
 175 int perf_callchain_config(const char *var, const char *value);
 176
 177 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
 178                                              struct callchain_cursor *src)
 179 {
 180         *dest = *src;
 181
 182         dest->first = src->curr;
 183         dest->nr -= src->pos;
 184 }
 185
 186 #ifdef HAVE_SKIP_CALLCHAIN_IDX
 187 extern int arch_skip_callchain_idx(struct machine *machine,
 188                         struct thread *thread, struct ip_callchain *chain);
 189 #else
 190 static inline int arch_skip_callchain_idx(struct machine *machine __maybe_unused,
 191                         struct thread *thread __maybe_unused,
 192                         struct ip_callchain *chain __maybe_unused)
 193 {
 194         return -1;
 195 }
 196 #endif
 197
 198 #endif  /* __PERF_CALLCHAIN_H */