perf tools: Support data block and addr block
[linux-2.6-microblaze.git] / tools / perf / util / hist.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_HIST_H
3 #define __PERF_HIST_H
4
5 #include <linux/rbtree.h>
6 #include <linux/types.h>
7 #include <pthread.h>
8 #include "evsel.h"
9 #include "color.h"
10 #include "events_stats.h"
11
12 struct hist_entry;
13 struct hist_entry_ops;
14 struct addr_location;
15 struct map_symbol;
16 struct mem_info;
17 struct branch_info;
18 struct branch_stack;
19 struct block_info;
20 struct symbol;
21 struct ui_progress;
22
23 enum hist_filter {
24         HIST_FILTER__DSO,
25         HIST_FILTER__THREAD,
26         HIST_FILTER__PARENT,
27         HIST_FILTER__SYMBOL,
28         HIST_FILTER__GUEST,
29         HIST_FILTER__HOST,
30         HIST_FILTER__SOCKET,
31         HIST_FILTER__C2C,
32 };
33
34 enum hist_column {
35         HISTC_SYMBOL,
36         HISTC_TIME,
37         HISTC_DSO,
38         HISTC_THREAD,
39         HISTC_COMM,
40         HISTC_CGROUP_ID,
41         HISTC_CGROUP,
42         HISTC_PARENT,
43         HISTC_CPU,
44         HISTC_SOCKET,
45         HISTC_SRCLINE,
46         HISTC_SRCFILE,
47         HISTC_MISPREDICT,
48         HISTC_IN_TX,
49         HISTC_ABORT,
50         HISTC_SYMBOL_FROM,
51         HISTC_SYMBOL_TO,
52         HISTC_DSO_FROM,
53         HISTC_DSO_TO,
54         HISTC_LOCAL_WEIGHT,
55         HISTC_GLOBAL_WEIGHT,
56         HISTC_CODE_PAGE_SIZE,
57         HISTC_MEM_DADDR_SYMBOL,
58         HISTC_MEM_DADDR_DSO,
59         HISTC_MEM_PHYS_DADDR,
60         HISTC_MEM_DATA_PAGE_SIZE,
61         HISTC_MEM_LOCKED,
62         HISTC_MEM_TLB,
63         HISTC_MEM_LVL,
64         HISTC_MEM_SNOOP,
65         HISTC_MEM_DCACHELINE,
66         HISTC_MEM_IADDR_SYMBOL,
67         HISTC_TRANSACTION,
68         HISTC_CYCLES,
69         HISTC_SRCLINE_FROM,
70         HISTC_SRCLINE_TO,
71         HISTC_TRACE,
72         HISTC_SYM_SIZE,
73         HISTC_DSO_SIZE,
74         HISTC_SYMBOL_IPC,
75         HISTC_MEM_BLOCKED,
76         HISTC_NR_COLS, /* Last entry */
77 };
78
79 struct thread;
80 struct dso;
81
82 struct hists {
83         struct rb_root_cached   entries_in_array[2];
84         struct rb_root_cached   *entries_in;
85         struct rb_root_cached   entries;
86         struct rb_root_cached   entries_collapsed;
87         u64                     nr_entries;
88         u64                     nr_non_filtered_entries;
89         u64                     callchain_period;
90         u64                     callchain_non_filtered_period;
91         struct thread           *thread_filter;
92         const struct dso        *dso_filter;
93         const char              *uid_filter_str;
94         const char              *symbol_filter_str;
95         pthread_mutex_t         lock;
96         struct events_stats     stats;
97         u64                     event_stream;
98         u16                     col_len[HISTC_NR_COLS];
99         bool                    has_callchains;
100         int                     socket_filter;
101         struct perf_hpp_list    *hpp_list;
102         struct list_head        hpp_formats;
103         int                     nr_hpp_node;
104 };
105
106 #define hists__has(__h, __f) (__h)->hpp_list->__f
107
108 struct hist_entry_iter;
109
110 struct hist_iter_ops {
111         int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
112         int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
113         int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
114         int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
115         int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
116 };
117
118 struct hist_entry_iter {
119         int total;
120         int curr;
121
122         bool hide_unresolved;
123
124         struct evsel *evsel;
125         struct perf_sample *sample;
126         struct hist_entry *he;
127         struct symbol *parent;
128         void *priv;
129
130         const struct hist_iter_ops *ops;
131         /* user-defined callback function (optional) */
132         int (*add_entry_cb)(struct hist_entry_iter *iter,
133                             struct addr_location *al, bool single, void *arg);
134 };
135
136 extern const struct hist_iter_ops hist_iter_normal;
137 extern const struct hist_iter_ops hist_iter_branch;
138 extern const struct hist_iter_ops hist_iter_mem;
139 extern const struct hist_iter_ops hist_iter_cumulative;
140
141 struct hist_entry *hists__add_entry(struct hists *hists,
142                                     struct addr_location *al,
143                                     struct symbol *parent,
144                                     struct branch_info *bi,
145                                     struct mem_info *mi,
146                                     struct perf_sample *sample,
147                                     bool sample_self);
148
149 struct hist_entry *hists__add_entry_ops(struct hists *hists,
150                                         struct hist_entry_ops *ops,
151                                         struct addr_location *al,
152                                         struct symbol *sym_parent,
153                                         struct branch_info *bi,
154                                         struct mem_info *mi,
155                                         struct perf_sample *sample,
156                                         bool sample_self);
157
158 struct hist_entry *hists__add_entry_block(struct hists *hists,
159                                           struct addr_location *al,
160                                           struct block_info *bi);
161
162 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
163                          int max_stack_depth, void *arg);
164
165 struct perf_hpp;
166 struct perf_hpp_fmt;
167
168 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
169 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
170 int hist_entry__transaction_len(void);
171 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
172                               struct hists *hists);
173 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
174                                    struct perf_hpp_fmt *fmt, int printed);
175 void hist_entry__delete(struct hist_entry *he);
176
177 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
178
179 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
180                              hists__resort_cb_t cb, void *cb_arg);
181 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
182 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
183 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
184                              hists__resort_cb_t cb);
185 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
186
187 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
188 void hists__delete_entries(struct hists *hists);
189 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
190
191 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
192
193 u64 hists__total_period(struct hists *hists);
194 void hists__reset_stats(struct hists *hists);
195 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
196 void hists__inc_nr_events(struct hists *hists, u32 type);
197 void hists__inc_nr_samples(struct hists *hists, bool filtered);
198
199 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
200                       int max_cols, float min_pcnt, FILE *fp,
201                       bool ignore_callchains);
202 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp);
203
204 void hists__filter_by_dso(struct hists *hists);
205 void hists__filter_by_thread(struct hists *hists);
206 void hists__filter_by_symbol(struct hists *hists);
207 void hists__filter_by_socket(struct hists *hists);
208
209 static inline bool hists__has_filter(struct hists *hists)
210 {
211         return hists->thread_filter || hists->dso_filter ||
212                 hists->symbol_filter_str || (hists->socket_filter > -1);
213 }
214
215 u16 hists__col_len(struct hists *hists, enum hist_column col);
216 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
217 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
218 void hists__reset_col_len(struct hists *hists);
219 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
220
221 void hists__match(struct hists *leader, struct hists *other);
222 int hists__link(struct hists *leader, struct hists *other);
223 int hists__unlink(struct hists *hists);
224
225 struct hists_evsel {
226         struct evsel evsel;
227         struct hists      hists;
228 };
229
230 static inline struct evsel *hists_to_evsel(struct hists *hists)
231 {
232         struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
233         return &hevsel->evsel;
234 }
235
236 static inline struct hists *evsel__hists(struct evsel *evsel)
237 {
238         struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
239         return &hevsel->hists;
240 }
241
242 static __pure inline bool hists__has_callchains(struct hists *hists)
243 {
244         return hists->has_callchains;
245 }
246
247 int hists__init(void);
248 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
249
250 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
251
252 struct perf_hpp {
253         char *buf;
254         size_t size;
255         const char *sep;
256         void *ptr;
257         bool skip;
258 };
259
260 struct perf_hpp_fmt {
261         const char *name;
262         int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
263                       struct hists *hists, int line, int *span);
264         int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
265                      struct hists *hists);
266         int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
267                      struct hist_entry *he);
268         int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
269                      struct hist_entry *he);
270         int64_t (*cmp)(struct perf_hpp_fmt *fmt,
271                        struct hist_entry *a, struct hist_entry *b);
272         int64_t (*collapse)(struct perf_hpp_fmt *fmt,
273                             struct hist_entry *a, struct hist_entry *b);
274         int64_t (*sort)(struct perf_hpp_fmt *fmt,
275                         struct hist_entry *a, struct hist_entry *b);
276         bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
277         void (*free)(struct perf_hpp_fmt *fmt);
278
279         struct list_head list;
280         struct list_head sort_list;
281         bool elide;
282         int len;
283         int user_len;
284         int idx;
285         int level;
286 };
287
288 struct perf_hpp_list {
289         struct list_head fields;
290         struct list_head sorts;
291
292         int nr_header_lines;
293         int need_collapse;
294         int parent;
295         int sym;
296         int dso;
297         int socket;
298         int thread;
299         int comm;
300 };
301
302 extern struct perf_hpp_list perf_hpp_list;
303
304 struct perf_hpp_list_node {
305         struct list_head        list;
306         struct perf_hpp_list    hpp;
307         int                     level;
308         bool                    skip;
309 };
310
311 void perf_hpp_list__column_register(struct perf_hpp_list *list,
312                                     struct perf_hpp_fmt *format);
313 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
314                                         struct perf_hpp_fmt *format);
315 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
316                                        struct perf_hpp_fmt *format);
317
318 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
319 {
320         perf_hpp_list__column_register(&perf_hpp_list, format);
321 }
322
323 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
324 {
325         perf_hpp_list__register_sort_field(&perf_hpp_list, format);
326 }
327
328 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
329 {
330         perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
331 }
332
333 #define perf_hpp_list__for_each_format(_list, format) \
334         list_for_each_entry(format, &(_list)->fields, list)
335
336 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
337         list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
338
339 #define perf_hpp_list__for_each_sort_list(_list, format) \
340         list_for_each_entry(format, &(_list)->sorts, sort_list)
341
342 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp)      \
343         list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
344
345 #define hists__for_each_format(hists, format) \
346         perf_hpp_list__for_each_format((hists)->hpp_list, format)
347
348 #define hists__for_each_sort_list(hists, format) \
349         perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
350
351 extern struct perf_hpp_fmt perf_hpp__format[];
352
353 enum {
354         /* Matches perf_hpp__format array. */
355         PERF_HPP__OVERHEAD,
356         PERF_HPP__OVERHEAD_SYS,
357         PERF_HPP__OVERHEAD_US,
358         PERF_HPP__OVERHEAD_GUEST_SYS,
359         PERF_HPP__OVERHEAD_GUEST_US,
360         PERF_HPP__OVERHEAD_ACC,
361         PERF_HPP__SAMPLES,
362         PERF_HPP__PERIOD,
363
364         PERF_HPP__MAX_INDEX
365 };
366
367 void perf_hpp__init(void);
368 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
369 void perf_hpp__cancel_cumulate(void);
370 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
371 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
372 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
373 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
374                                   struct evlist *evlist);
375
376
377 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
378 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
379 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
380 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
381 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
382 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
383 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
384 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
385 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
386 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
387
388 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
389
390 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
391
392 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
393                                          struct hists *hists)
394 {
395         if (format->elide)
396                 return true;
397
398         if (perf_hpp__is_dynamic_entry(format) &&
399             !perf_hpp__defined_dynamic_entry(format, hists))
400                 return true;
401
402         return false;
403 }
404
405 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
406 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
407 void perf_hpp__set_user_width(const char *width_list_str);
408 void hists__reset_column_width(struct hists *hists);
409
410 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
411 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
412 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
413
414 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
415              struct hist_entry *he, hpp_field_fn get_field,
416              const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
417 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
418                  struct hist_entry *he, hpp_field_fn get_field,
419                  const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
420
421 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
422 {
423         hpp->buf  += inc;
424         hpp->size -= inc;
425 }
426
427 static inline size_t perf_hpp__use_color(void)
428 {
429         return !symbol_conf.field_sep;
430 }
431
432 static inline size_t perf_hpp__color_overhead(void)
433 {
434         return perf_hpp__use_color() ?
435                (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
436                : 0;
437 }
438
439 struct evlist;
440
441 struct hist_browser_timer {
442         void (*timer)(void *arg);
443         void *arg;
444         int refresh;
445 };
446
447 struct annotation_options;
448 struct res_sample;
449
450 enum rstype {
451         A_NORMAL,
452         A_ASM,
453         A_SOURCE
454 };
455
456 struct block_hist;
457
458 #ifdef HAVE_SLANG_SUPPORT
459 #include "../ui/keysyms.h"
460 void attr_to_script(char *buf, struct perf_event_attr *attr);
461
462 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
463                              struct hist_browser_timer *hbt,
464                              struct annotation_options *annotation_opts);
465
466 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
467                              struct hist_browser_timer *hbt,
468                              struct annotation_options *annotation_opts);
469
470 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
471                              float min_pcnt, struct perf_env *env, bool warn_lost_event,
472                              struct annotation_options *annotation_options);
473
474 int script_browse(const char *script_opt, struct evsel *evsel);
475
476 void run_script(char *cmd);
477 int res_sample_browse(struct res_sample *res_samples, int num_res,
478                       struct evsel *evsel, enum rstype rstype);
479 void res_sample_init(void);
480
481 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
482                            float min_percent, struct perf_env *env,
483                            struct annotation_options *annotation_opts);
484 #else
485 static inline
486 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
487                              const char *help __maybe_unused,
488                              struct hist_browser_timer *hbt __maybe_unused,
489                              float min_pcnt __maybe_unused,
490                              struct perf_env *env __maybe_unused,
491                              bool warn_lost_event __maybe_unused,
492                              struct annotation_options *annotation_options __maybe_unused)
493 {
494         return 0;
495 }
496 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
497                                            struct evsel *evsel __maybe_unused,
498                                            struct hist_browser_timer *hbt __maybe_unused,
499                                            struct annotation_options *annotation_options __maybe_unused)
500 {
501         return 0;
502 }
503
504 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
505                                            struct evsel *evsel __maybe_unused,
506                                            struct hist_browser_timer *hbt __maybe_unused,
507                                            struct annotation_options *annotation_opts __maybe_unused)
508 {
509         return 0;
510 }
511
512 static inline int script_browse(const char *script_opt __maybe_unused,
513                                 struct evsel *evsel __maybe_unused)
514 {
515         return 0;
516 }
517
518 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
519                                     int num_res __maybe_unused,
520                                     struct evsel *evsel __maybe_unused,
521                                     enum rstype rstype __maybe_unused)
522 {
523         return 0;
524 }
525
526 static inline void res_sample_init(void) {}
527
528 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
529                                          struct evsel *evsel __maybe_unused,
530                                          float min_percent __maybe_unused,
531                                          struct perf_env *env __maybe_unused,
532                                          struct annotation_options *annotation_opts __maybe_unused)
533 {
534         return 0;
535 }
536
537 #define K_LEFT  -1000
538 #define K_RIGHT -2000
539 #define K_SWITCH_INPUT_DATA -3000
540 #define K_RELOAD -4000
541 #endif
542
543 unsigned int hists__sort_list_width(struct hists *hists);
544 unsigned int hists__overhead_width(struct hists *hists);
545
546 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
547                           struct perf_sample *sample, bool nonany_branch_mode,
548                           u64 *total_cycles);
549
550 struct option;
551 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
552 int perf_hist_config(const char *var, const char *value);
553
554 void perf_hpp_list__init(struct perf_hpp_list *list);
555
556 enum hierarchy_move_dir {
557         HMD_NORMAL,
558         HMD_FORCE_SIBLING,
559         HMD_FORCE_CHILD,
560 };
561
562 struct rb_node *rb_hierarchy_last(struct rb_node *node);
563 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
564                                     enum hierarchy_move_dir hmd);
565 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
566
567 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
568 {
569         return __rb_hierarchy_next(node, HMD_NORMAL);
570 }
571
572 #define HIERARCHY_INDENT  3
573
574 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
575 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
576 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
577 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
578                            struct perf_hpp_list *hpp_list);
579 int hists__fprintf_headers(struct hists *hists, FILE *fp);
580 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
581
582 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
583 {
584         return __hists__scnprintf_title(hists, bf, size, true);
585 }
586
587 #endif  /* __PERF_HIST_H */