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