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