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