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