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