~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/tools/perf/util/callchain.h

Version: ~ [ linux-5.10-rc5 ] ~ [ linux-5.9.10 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.79 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.159 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.208 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.245 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.245 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /* SPDX-License-Identifier: GPL-2.0 */
  2 #ifndef __PERF_CALLCHAIN_H
  3 #define __PERF_CALLCHAIN_H
  4 
  5 #include "../perf.h"
  6 #include <linux/list.h>
  7 #include <linux/rbtree.h>
  8 #include "event.h"
  9 #include "map.h"
 10 #include "symbol.h"
 11 #include "branch.h"
 12 
 13 #define HELP_PAD "\t\t\t\t"
 14 
 15 #define CALLCHAIN_HELP "setup and enables call-graph (stack chain/backtrace):\n\n"
 16 
 17 # define RECORD_MODE_HELP  HELP_PAD "record_mode:\tcall graph recording mode (fp|dwarf|lbr)\n"
 18 
 19 #define RECORD_SIZE_HELP                                                \
 20         HELP_PAD "record_size:\tif record_mode is 'dwarf', max size of stack recording (<bytes>)\n" \
 21         HELP_PAD "\t\tdefault: 8192 (bytes)\n"
 22 
 23 #define CALLCHAIN_RECORD_HELP  CALLCHAIN_HELP RECORD_MODE_HELP RECORD_SIZE_HELP
 24 
 25 #define CALLCHAIN_REPORT_HELP                                           \
 26         HELP_PAD "print_type:\tcall graph printing style (graph|flat|fractal|folded|none)\n" \
 27         HELP_PAD "threshold:\tminimum call graph inclusion threshold (<percent>)\n" \
 28         HELP_PAD "print_limit:\tmaximum number of call graph entry (<number>)\n" \
 29         HELP_PAD "order:\t\tcall graph order (caller|callee)\n" \
 30         HELP_PAD "sort_key:\tcall graph sort key (function|address)\n"  \
 31         HELP_PAD "branch:\t\tinclude last branch info to call graph (branch)\n" \
 32         HELP_PAD "value:\t\tcall graph value (percent|period|count)\n"
 33 
 34 enum perf_call_graph_mode {
 35         CALLCHAIN_NONE,
 36         CALLCHAIN_FP,
 37         CALLCHAIN_DWARF,
 38         CALLCHAIN_LBR,
 39         CALLCHAIN_MAX
 40 };
 41 
 42 enum chain_mode {
 43         CHAIN_NONE,
 44         CHAIN_FLAT,
 45         CHAIN_GRAPH_ABS,
 46         CHAIN_GRAPH_REL,
 47         CHAIN_FOLDED,
 48 };
 49 
 50 enum chain_order {
 51         ORDER_CALLER,
 52         ORDER_CALLEE
 53 };
 54 
 55 struct callchain_node {
 56         struct callchain_node   *parent;
 57         struct list_head        val;
 58         struct list_head        parent_val;
 59         struct rb_node          rb_node_in; /* to insert nodes in an rbtree */
 60         struct rb_node          rb_node;    /* to sort nodes in an output tree */
 61         struct rb_root          rb_root_in; /* input tree of children */
 62         struct rb_root          rb_root;    /* sorted output tree of children */
 63         unsigned int            val_nr;
 64         unsigned int            count;
 65         unsigned int            children_count;
 66         u64                     hit;
 67         u64                     children_hit;
 68 };
 69 
 70 struct callchain_root {
 71         u64                     max_depth;
 72         struct callchain_node   node;
 73 };
 74 
 75 struct callchain_param;
 76 
 77 typedef void (*sort_chain_func_t)(struct rb_root *, struct callchain_root *,
 78                                  u64, struct callchain_param *);
 79 
 80 enum chain_key {
 81         CCKEY_FUNCTION,
 82         CCKEY_ADDRESS,
 83         CCKEY_SRCLINE
 84 };
 85 
 86 enum chain_value {
 87         CCVAL_PERCENT,
 88         CCVAL_PERIOD,
 89         CCVAL_COUNT,
 90 };
 91 
 92 struct callchain_param {
 93         bool                    enabled;
 94         enum perf_call_graph_mode record_mode;
 95         u32                     dump_size;
 96         enum chain_mode         mode;
 97         u16                     max_stack;
 98         u32                     print_limit;
 99         double                  min_percent;
100         sort_chain_func_t       sort;
101         enum chain_order        order;
102         bool                    order_set;
103         enum chain_key          key;
104         bool                    branch_callstack;
105         enum chain_value        value;
106 };
107 
108 extern struct callchain_param callchain_param;
109 extern struct callchain_param callchain_param_default;
110 
111 struct callchain_list {
112         u64                     ip;
113         struct map_symbol       ms;
114         struct /* for TUI */ {
115                 bool            unfolded;
116                 bool            has_children;
117         };
118         u64                     branch_count;
119         u64                     predicted_count;
120         u64                     abort_count;
121         u64                     cycles_count;
122         u64                     iter_count;
123         u64                     iter_cycles;
124         struct branch_type_stat brtype_stat;
125         const char              *srcline;
126         struct list_head        list;
127 };
128 
129 /*
130  * A callchain cursor is a single linked list that
131  * let one feed a callchain progressively.
132  * It keeps persistent allocated entries to minimize
133  * allocations.
134  */
135 struct callchain_cursor_node {
136         u64                             ip;
137         struct map                      *map;
138         struct symbol                   *sym;
139         const char                      *srcline;
140         bool                            branch;
141         struct branch_flags             branch_flags;
142         u64                             branch_from;
143         int                             nr_loop_iter;
144         u64                             iter_cycles;
145         struct callchain_cursor_node    *next;
146 };
147 
148 struct callchain_cursor {
149         u64                             nr;
150         struct callchain_cursor_node    *first;
151         struct callchain_cursor_node    **last;
152         u64                             pos;
153         struct callchain_cursor_node    *curr;
154 };
155 
156 extern __thread struct callchain_cursor callchain_cursor;
157 
158 static inline void callchain_init(struct callchain_root *root)
159 {
160         INIT_LIST_HEAD(&root->node.val);
161         INIT_LIST_HEAD(&root->node.parent_val);
162 
163         root->node.parent = NULL;
164         root->node.hit = 0;
165         root->node.children_hit = 0;
166         root->node.rb_root_in = RB_ROOT;
167         root->max_depth = 0;
168 }
169 
170 static inline u64 callchain_cumul_hits(struct callchain_node *node)
171 {
172         return node->hit + node->children_hit;
173 }
174 
175 static inline unsigned callchain_cumul_counts(struct callchain_node *node)
176 {
177         return node->count + node->children_count;
178 }
179 
180 int callchain_register_param(struct callchain_param *param);
181 int callchain_append(struct callchain_root *root,
182                      struct callchain_cursor *cursor,
183                      u64 period);
184 
185 int callchain_merge(struct callchain_cursor *cursor,
186                     struct callchain_root *dst, struct callchain_root *src);
187 
188 /*
189  * Initialize a cursor before adding entries inside, but keep
190  * the previously allocated entries as a cache.
191  */
192 static inline void callchain_cursor_reset(struct callchain_cursor *cursor)
193 {
194         struct callchain_cursor_node *node;
195 
196         cursor->nr = 0;
197         cursor->last = &cursor->first;
198 
199         for (node = cursor->first; node != NULL; node = node->next)
200                 map__zput(node->map);
201 }
202 
203 int callchain_cursor_append(struct callchain_cursor *cursor, u64 ip,
204                             struct map *map, struct symbol *sym,
205                             bool branch, struct branch_flags *flags,
206                             int nr_loop_iter, u64 iter_cycles, u64 branch_from,
207                             const char *srcline);
208 
209 /* Close a cursor writing session. Initialize for the reader */
210 static inline void callchain_cursor_commit(struct callchain_cursor *cursor)
211 {
212         cursor->curr = cursor->first;
213         cursor->pos = 0;
214 }
215 
216 /* Cursor reading iteration helpers */
217 static inline struct callchain_cursor_node *
218 callchain_cursor_current(struct callchain_cursor *cursor)
219 {
220         if (cursor->pos == cursor->nr)
221                 return NULL;
222 
223         return cursor->curr;
224 }
225 
226 static inline void callchain_cursor_advance(struct callchain_cursor *cursor)
227 {
228         cursor->curr = cursor->curr->next;
229         cursor->pos++;
230 }
231 
232 int callchain_cursor__copy(struct callchain_cursor *dst,
233                            struct callchain_cursor *src);
234 
235 struct option;
236 struct hist_entry;
237 
238 int record_parse_callchain_opt(const struct option *opt, const char *arg, int unset);
239 int record_callchain_opt(const struct option *opt, const char *arg, int unset);
240 
241 struct record_opts;
242 
243 int record_opts__parse_callchain(struct record_opts *record,
244                                  struct callchain_param *callchain,
245                                  const char *arg, bool unset);
246 
247 int sample__resolve_callchain(struct perf_sample *sample,
248                               struct callchain_cursor *cursor, struct symbol **parent,
249                               struct perf_evsel *evsel, struct addr_location *al,
250                               int max_stack);
251 int hist_entry__append_callchain(struct hist_entry *he, struct perf_sample *sample);
252 int fill_callchain_info(struct addr_location *al, struct callchain_cursor_node *node,
253                         bool hide_unresolved);
254 
255 extern const char record_callchain_help[];
256 int parse_callchain_record(const char *arg, struct callchain_param *param);
257 int parse_callchain_record_opt(const char *arg, struct callchain_param *param);
258 int parse_callchain_report_opt(const char *arg);
259 int parse_callchain_top_opt(const char *arg);
260 int perf_callchain_config(const char *var, const char *value);
261 
262 static inline void callchain_cursor_snapshot(struct callchain_cursor *dest,
263                                              struct callchain_cursor *src)
264 {
265         *dest = *src;
266 
267         dest->first = src->curr;
268         dest->nr -= src->pos;
269 }
270 
271 #ifdef HAVE_SKIP_CALLCHAIN_IDX
272 int arch_skip_callchain_idx(struct thread *thread, struct ip_callchain *chain);
273 #else
274 static inline int arch_skip_callchain_idx(struct thread *thread __maybe_unused,
275                         struct ip_callchain *chain __maybe_unused)
276 {
277         return -1;
278 }
279 #endif
280 
281 char *callchain_list__sym_name(struct callchain_list *cl,
282                                char *bf, size_t bfsize, bool show_dso);
283 char *callchain_node__scnprintf_value(struct callchain_node *node,
284                                       char *bf, size_t bfsize, u64 total);
285 int callchain_node__fprintf_value(struct callchain_node *node,
286                                   FILE *fp, u64 total);
287 
288 int callchain_list_counts__printf_value(struct callchain_list *clist,
289                                         FILE *fp, char *bf, int bfsize);
290 
291 void free_callchain(struct callchain_root *root);
292 void decay_callchain(struct callchain_root *root);
293 int callchain_node__make_parent_list(struct callchain_node *node);
294 
295 int callchain_branch_counts(struct callchain_root *root,
296                             u64 *branch_count, u64 *predicted_count,
297                             u64 *abort_count, u64 *cycles_count);
298 
299 #endif  /* __PERF_CALLCHAIN_H */
300 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp