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