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