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