1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/rbtree.h>
6 #include <linux/types.h>
10 #include "events_stats.h"
13 struct hist_entry_ops;
56 HISTC_MEM_DADDR_SYMBOL,
59 HISTC_MEM_DATA_PAGE_SIZE,
65 HISTC_MEM_IADDR_SYMBOL,
74 HISTC_NR_COLS, /* Last entry */
81 struct rb_root_cached entries_in_array[2];
82 struct rb_root_cached *entries_in;
83 struct rb_root_cached entries;
84 struct rb_root_cached entries_collapsed;
86 u64 nr_non_filtered_entries;
88 u64 callchain_non_filtered_period;
89 struct thread *thread_filter;
90 const struct dso *dso_filter;
91 const char *uid_filter_str;
92 const char *symbol_filter_str;
94 struct events_stats stats;
96 u16 col_len[HISTC_NR_COLS];
99 struct perf_hpp_list *hpp_list;
100 struct list_head hpp_formats;
104 #define hists__has(__h, __f) (__h)->hpp_list->__f
106 struct hist_entry_iter;
108 struct hist_iter_ops {
109 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
110 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
111 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
112 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
113 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
116 struct hist_entry_iter {
120 bool hide_unresolved;
123 struct perf_sample *sample;
124 struct hist_entry *he;
125 struct symbol *parent;
128 const struct hist_iter_ops *ops;
129 /* user-defined callback function (optional) */
130 int (*add_entry_cb)(struct hist_entry_iter *iter,
131 struct addr_location *al, bool single, void *arg);
134 extern const struct hist_iter_ops hist_iter_normal;
135 extern const struct hist_iter_ops hist_iter_branch;
136 extern const struct hist_iter_ops hist_iter_mem;
137 extern const struct hist_iter_ops hist_iter_cumulative;
139 struct hist_entry *hists__add_entry(struct hists *hists,
140 struct addr_location *al,
141 struct symbol *parent,
142 struct branch_info *bi,
144 struct perf_sample *sample,
147 struct hist_entry *hists__add_entry_ops(struct hists *hists,
148 struct hist_entry_ops *ops,
149 struct addr_location *al,
150 struct symbol *sym_parent,
151 struct branch_info *bi,
153 struct perf_sample *sample,
156 struct hist_entry *hists__add_entry_block(struct hists *hists,
157 struct addr_location *al,
158 struct block_info *bi);
160 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
161 int max_stack_depth, void *arg);
166 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
167 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
168 int hist_entry__transaction_len(void);
169 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
170 struct hists *hists);
171 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
172 struct perf_hpp_fmt *fmt, int printed);
173 void hist_entry__delete(struct hist_entry *he);
175 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
177 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
178 hists__resort_cb_t cb, void *cb_arg);
179 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
180 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
181 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
182 hists__resort_cb_t cb);
183 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
185 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
186 void hists__delete_entries(struct hists *hists);
187 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
189 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
191 u64 hists__total_period(struct hists *hists);
192 void hists__reset_stats(struct hists *hists);
193 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
194 void hists__inc_nr_events(struct hists *hists, u32 type);
195 void hists__inc_nr_samples(struct hists *hists, bool filtered);
197 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
198 int max_cols, float min_pcnt, FILE *fp,
199 bool ignore_callchains);
200 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp);
202 void hists__filter_by_dso(struct hists *hists);
203 void hists__filter_by_thread(struct hists *hists);
204 void hists__filter_by_symbol(struct hists *hists);
205 void hists__filter_by_socket(struct hists *hists);
207 static inline bool hists__has_filter(struct hists *hists)
209 return hists->thread_filter || hists->dso_filter ||
210 hists->symbol_filter_str || (hists->socket_filter > -1);
213 u16 hists__col_len(struct hists *hists, enum hist_column col);
214 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
215 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
216 void hists__reset_col_len(struct hists *hists);
217 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
219 void hists__match(struct hists *leader, struct hists *other);
220 int hists__link(struct hists *leader, struct hists *other);
221 int hists__unlink(struct hists *hists);
228 static inline struct evsel *hists_to_evsel(struct hists *hists)
230 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
231 return &hevsel->evsel;
234 static inline struct hists *evsel__hists(struct evsel *evsel)
236 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
237 return &hevsel->hists;
240 static __pure inline bool hists__has_callchains(struct hists *hists)
242 return hists->has_callchains;
245 int hists__init(void);
246 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
248 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
258 struct perf_hpp_fmt {
260 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
261 struct hists *hists, int line, int *span);
262 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
263 struct hists *hists);
264 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
265 struct hist_entry *he);
266 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
267 struct hist_entry *he);
268 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
269 struct hist_entry *a, struct hist_entry *b);
270 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
271 struct hist_entry *a, struct hist_entry *b);
272 int64_t (*sort)(struct perf_hpp_fmt *fmt,
273 struct hist_entry *a, struct hist_entry *b);
274 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
275 void (*free)(struct perf_hpp_fmt *fmt);
277 struct list_head list;
278 struct list_head sort_list;
286 struct perf_hpp_list {
287 struct list_head fields;
288 struct list_head sorts;
300 extern struct perf_hpp_list perf_hpp_list;
302 struct perf_hpp_list_node {
303 struct list_head list;
304 struct perf_hpp_list hpp;
309 void perf_hpp_list__column_register(struct perf_hpp_list *list,
310 struct perf_hpp_fmt *format);
311 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
312 struct perf_hpp_fmt *format);
313 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
314 struct perf_hpp_fmt *format);
316 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
318 perf_hpp_list__column_register(&perf_hpp_list, format);
321 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
323 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
326 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
328 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
331 #define perf_hpp_list__for_each_format(_list, format) \
332 list_for_each_entry(format, &(_list)->fields, list)
334 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
335 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
337 #define perf_hpp_list__for_each_sort_list(_list, format) \
338 list_for_each_entry(format, &(_list)->sorts, sort_list)
340 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
341 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
343 #define hists__for_each_format(hists, format) \
344 perf_hpp_list__for_each_format((hists)->hpp_list, format)
346 #define hists__for_each_sort_list(hists, format) \
347 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
349 extern struct perf_hpp_fmt perf_hpp__format[];
352 /* Matches perf_hpp__format array. */
354 PERF_HPP__OVERHEAD_SYS,
355 PERF_HPP__OVERHEAD_US,
356 PERF_HPP__OVERHEAD_GUEST_SYS,
357 PERF_HPP__OVERHEAD_GUEST_US,
358 PERF_HPP__OVERHEAD_ACC,
365 void perf_hpp__init(void);
366 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
367 void perf_hpp__cancel_cumulate(void);
368 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
369 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
370 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
371 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
372 struct evlist *evlist);
375 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
376 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
377 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
378 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
379 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
380 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
381 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
382 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
383 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
384 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
386 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
388 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
390 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
396 if (perf_hpp__is_dynamic_entry(format) &&
397 !perf_hpp__defined_dynamic_entry(format, hists))
403 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
404 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
405 void perf_hpp__set_user_width(const char *width_list_str);
406 void hists__reset_column_width(struct hists *hists);
408 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
409 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
410 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
412 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
413 struct hist_entry *he, hpp_field_fn get_field,
414 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
415 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
416 struct hist_entry *he, hpp_field_fn get_field,
417 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
419 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
425 static inline size_t perf_hpp__use_color(void)
427 return !symbol_conf.field_sep;
430 static inline size_t perf_hpp__color_overhead(void)
432 return perf_hpp__use_color() ?
433 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
439 struct hist_browser_timer {
440 void (*timer)(void *arg);
445 struct annotation_options;
456 #ifdef HAVE_SLANG_SUPPORT
457 #include "../ui/keysyms.h"
458 void attr_to_script(char *buf, struct perf_event_attr *attr);
460 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
461 struct hist_browser_timer *hbt,
462 struct annotation_options *annotation_opts);
464 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
465 struct hist_browser_timer *hbt,
466 struct annotation_options *annotation_opts);
468 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
469 float min_pcnt, struct perf_env *env, bool warn_lost_event,
470 struct annotation_options *annotation_options);
472 int script_browse(const char *script_opt, struct evsel *evsel);
474 void run_script(char *cmd);
475 int res_sample_browse(struct res_sample *res_samples, int num_res,
476 struct evsel *evsel, enum rstype rstype);
477 void res_sample_init(void);
479 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
480 float min_percent, struct perf_env *env,
481 struct annotation_options *annotation_opts);
484 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
485 const char *help __maybe_unused,
486 struct hist_browser_timer *hbt __maybe_unused,
487 float min_pcnt __maybe_unused,
488 struct perf_env *env __maybe_unused,
489 bool warn_lost_event __maybe_unused,
490 struct annotation_options *annotation_options __maybe_unused)
494 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
495 struct evsel *evsel __maybe_unused,
496 struct hist_browser_timer *hbt __maybe_unused,
497 struct annotation_options *annotation_options __maybe_unused)
502 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
503 struct evsel *evsel __maybe_unused,
504 struct hist_browser_timer *hbt __maybe_unused,
505 struct annotation_options *annotation_opts __maybe_unused)
510 static inline int script_browse(const char *script_opt __maybe_unused,
511 struct evsel *evsel __maybe_unused)
516 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
517 int num_res __maybe_unused,
518 struct evsel *evsel __maybe_unused,
519 enum rstype rstype __maybe_unused)
524 static inline void res_sample_init(void) {}
526 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
527 struct evsel *evsel __maybe_unused,
528 float min_percent __maybe_unused,
529 struct perf_env *env __maybe_unused,
530 struct annotation_options *annotation_opts __maybe_unused)
536 #define K_RIGHT -2000
537 #define K_SWITCH_INPUT_DATA -3000
538 #define K_RELOAD -4000
541 unsigned int hists__sort_list_width(struct hists *hists);
542 unsigned int hists__overhead_width(struct hists *hists);
544 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
545 struct perf_sample *sample, bool nonany_branch_mode,
549 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
550 int perf_hist_config(const char *var, const char *value);
552 void perf_hpp_list__init(struct perf_hpp_list *list);
554 enum hierarchy_move_dir {
560 struct rb_node *rb_hierarchy_last(struct rb_node *node);
561 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
562 enum hierarchy_move_dir hmd);
563 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
565 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
567 return __rb_hierarchy_next(node, HMD_NORMAL);
570 #define HIERARCHY_INDENT 3
572 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
573 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
574 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
575 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
576 struct perf_hpp_list *hpp_list);
577 int hists__fprintf_headers(struct hists *hists, FILE *fp);
578 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
580 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
582 return __hists__scnprintf_title(hists, bf, size, true);
585 #endif /* __PERF_HIST_H */