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