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         bool                    branch_callstack;
  67 };
  68
  69 extern struct callchain_param callchain_param;
  70
  71 struct callchain_list {
  72         u64                     ip;
  73         struct map_symbol       ms;
  74         char                   *srcline;
  75         struct list_head        list;
  76 };
  77
  78 /*
  79  * A callchain cursor is a single linked list that
  80  * let one feed a callchain progressively.
  81  * It keeps persistent allocated entries to minimize
  82  * allocations.
  83  */
  84 struct callchain_cursor_node {
  85         u64                             ip;
  86         struct map                      *map;
  87         struct symbol                   *sym;
  88         struct callchain_cursor_node    *next;
  89 };
  90
  91 struct callchain_cursor {
  92         u64                             nr;
  93         struct callchain_cursor_node    *first;
  94         struct callchain_cursor_node    **last;
  95         u64                             pos;
  96         struct callchain_cursor_node    *curr;
  97 };
  98
  99 extern __thread struct callchain_cursor callchain_cursor;
 100
 101 static inline void callchain_init(struct callchain_root *root)
 102 {
 103         INIT_LIST_HEAD(&root->node.val);
 104
 105         root->node.parent = NULL;
 106         root->node.hit = 0;
 107         root->node.children_hit = 0;
 108         root->node.rb_root_in = RB_ROOT;
 109         root->max_depth = 0;
 110 }
 111
 112 static inline u64 callchain_cumul_hits(struct callchain_node *node)
 113 {
 114         return node->hit + node->children_hit;
 115 }
 116
 117 int callchain_register_param(struct callchain_param *param);
 118 int callchain_append(struct callchain_root *root,
 119                      struct callchain_cursor *cursor,
 120                      u64 period);
 121
 122 int callchain_merge(struct callchain_cursor *cursor,
 123                     struct callchain_root *dst, struct callchain_root *src);
 124
 125 /*
 126  * Initialize a cursor before adding entries inside, but keep
 127  * the previously allocated entries as a cache.
 128  */
 129 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
 130 {
 131         cursor->nr = 0;
 132         cursor->last = &cursor->first;
 133 }
 134
 135 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
 136                             struct map *map, struct symbol *sym);
 137
 138 /* Close a cursor writing session. Initialize for the reader */
 139 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
 140 {
 141         cursor->curr = cursor->first;
 142         cursor->pos = 0;
 143 }
 144
 145 /* Cursor reading iteration helpers */
 146 static inline struct callchain_cursor_node *
 147 callchain_cursor_current(struct callchain_cursor *cursor)
 148 {
 149         if (cursor->pos == cursor->nr)
 150                 return NULL;
 151
 152         return cursor->curr;
 153 }
 154
 155 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
 156 {
 157         cursor->curr = cursor->curr->next;
 158         cursor->pos++;
 159 }
 160
 161 struct option;
 162 struct hist_entry;
 163
 164 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
 165 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
 166
 167 int sample__resolve_callchain(struct perf_sample *sample, struct symbol **parent,
 168                               struct perf_evsel *evsel, struct addr_location *al,
 169                               int max_stack);
 170 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
 171 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
 172                         bool hide_unresolved);
 173
 174 extern const char record_callchain_help[];
 175 int parse_callchain_record_opt(const char *arg);
 176 int parse_callchain_report_opt(const char *arg);
 177 int perf_callchain_config(const char *var, const char *value);
 178
 179 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
 180                                              struct callchain_cursor *src)
 181 {
 182         *dest = *src;
 183
 184         dest->first = src->curr;
 185         dest->nr -= src->pos;
 186 }
 187
 188 #ifdef HAVE_SKIP_CALLCHAIN_IDX
 189 extern int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
 190 #else
 191 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
 192                         struct ip_callchain *chain __maybe_unused)
 193 {
 194         return -1;
 195 }
 196 #endif
 197
 198 char *callchain_list__sym_name(struct callchain_list *cl,
 199                                char *bf, size_t bfsize, bool show_dso);
 200
 201 void free_callchain(struct callchain_root *root);
 202
 203 #endif  /* __PERF_CALLCHAIN_H */