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