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;
57 HISTC_MEM_DADDR_SYMBOL,
60 HISTC_MEM_DATA_PAGE_SIZE,
66 HISTC_MEM_IADDR_SYMBOL,
76 HISTC_NR_COLS, /* Last entry */
83 struct rb_root_cached entries_in_array[2];
84 struct rb_root_cached *entries_in;
85 struct rb_root_cached entries;
86 struct rb_root_cached entries_collapsed;
88 u64 nr_non_filtered_entries;
90 u64 callchain_non_filtered_period;
91 struct thread *thread_filter;
92 const struct dso *dso_filter;
93 const char *uid_filter_str;
94 const char *symbol_filter_str;
96 struct events_stats stats;
98 u16 col_len[HISTC_NR_COLS];
101 struct perf_hpp_list *hpp_list;
102 struct list_head hpp_formats;
106 #define hists__has(__h, __f) (__h)->hpp_list->__f
108 struct hist_entry_iter;
110 struct hist_iter_ops {
111 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
112 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
113 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
114 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
115 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
118 struct hist_entry_iter {
122 bool hide_unresolved;
125 struct perf_sample *sample;
126 struct hist_entry *he;
127 struct symbol *parent;
130 const struct hist_iter_ops *ops;
131 /* user-defined callback function (optional) */
132 int (*add_entry_cb)(struct hist_entry_iter *iter,
133 struct addr_location *al, bool single, void *arg);
136 extern const struct hist_iter_ops hist_iter_normal;
137 extern const struct hist_iter_ops hist_iter_branch;
138 extern const struct hist_iter_ops hist_iter_mem;
139 extern const struct hist_iter_ops hist_iter_cumulative;
141 struct hist_entry *hists__add_entry(struct hists *hists,
142 struct addr_location *al,
143 struct symbol *parent,
144 struct branch_info *bi,
146 struct perf_sample *sample,
149 struct hist_entry *hists__add_entry_ops(struct hists *hists,
150 struct hist_entry_ops *ops,
151 struct addr_location *al,
152 struct symbol *sym_parent,
153 struct branch_info *bi,
155 struct perf_sample *sample,
158 struct hist_entry *hists__add_entry_block(struct hists *hists,
159 struct addr_location *al,
160 struct block_info *bi);
162 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
163 int max_stack_depth, void *arg);
168 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
169 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
170 int hist_entry__transaction_len(void);
171 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
172 struct hists *hists);
173 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
174 struct perf_hpp_fmt *fmt, int printed);
175 void hist_entry__delete(struct hist_entry *he);
177 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
179 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
180 hists__resort_cb_t cb, void *cb_arg);
181 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
182 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
183 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
184 hists__resort_cb_t cb);
185 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
187 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
188 void hists__delete_entries(struct hists *hists);
189 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
191 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
193 u64 hists__total_period(struct hists *hists);
194 void hists__reset_stats(struct hists *hists);
195 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
196 void hists__inc_nr_events(struct hists *hists, u32 type);
197 void hists__inc_nr_samples(struct hists *hists, bool filtered);
199 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
200 int max_cols, float min_pcnt, FILE *fp,
201 bool ignore_callchains);
202 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp);
204 void hists__filter_by_dso(struct hists *hists);
205 void hists__filter_by_thread(struct hists *hists);
206 void hists__filter_by_symbol(struct hists *hists);
207 void hists__filter_by_socket(struct hists *hists);
209 static inline bool hists__has_filter(struct hists *hists)
211 return hists->thread_filter || hists->dso_filter ||
212 hists->symbol_filter_str || (hists->socket_filter > -1);
215 u16 hists__col_len(struct hists *hists, enum hist_column col);
216 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
217 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
218 void hists__reset_col_len(struct hists *hists);
219 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
221 void hists__match(struct hists *leader, struct hists *other);
222 int hists__link(struct hists *leader, struct hists *other);
223 int hists__unlink(struct hists *hists);
230 static inline struct evsel *hists_to_evsel(struct hists *hists)
232 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
233 return &hevsel->evsel;
236 static inline struct hists *evsel__hists(struct evsel *evsel)
238 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
239 return &hevsel->hists;
242 static __pure inline bool hists__has_callchains(struct hists *hists)
244 return hists->has_callchains;
247 int hists__init(void);
248 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
250 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
260 struct perf_hpp_fmt {
262 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
263 struct hists *hists, int line, int *span);
264 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
265 struct hists *hists);
266 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
267 struct hist_entry *he);
268 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
269 struct hist_entry *he);
270 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
271 struct hist_entry *a, struct hist_entry *b);
272 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
273 struct hist_entry *a, struct hist_entry *b);
274 int64_t (*sort)(struct perf_hpp_fmt *fmt,
275 struct hist_entry *a, struct hist_entry *b);
276 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
277 void (*free)(struct perf_hpp_fmt *fmt);
279 struct list_head list;
280 struct list_head sort_list;
288 struct perf_hpp_list {
289 struct list_head fields;
290 struct list_head sorts;
302 extern struct perf_hpp_list perf_hpp_list;
304 struct perf_hpp_list_node {
305 struct list_head list;
306 struct perf_hpp_list hpp;
311 void perf_hpp_list__column_register(struct perf_hpp_list *list,
312 struct perf_hpp_fmt *format);
313 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
314 struct perf_hpp_fmt *format);
315 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
316 struct perf_hpp_fmt *format);
318 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
320 perf_hpp_list__column_register(&perf_hpp_list, format);
323 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
325 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
328 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
330 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
333 #define perf_hpp_list__for_each_format(_list, format) \
334 list_for_each_entry(format, &(_list)->fields, list)
336 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
337 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
339 #define perf_hpp_list__for_each_sort_list(_list, format) \
340 list_for_each_entry(format, &(_list)->sorts, sort_list)
342 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
343 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
345 #define hists__for_each_format(hists, format) \
346 perf_hpp_list__for_each_format((hists)->hpp_list, format)
348 #define hists__for_each_sort_list(hists, format) \
349 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
351 extern struct perf_hpp_fmt perf_hpp__format[];
354 /* Matches perf_hpp__format array. */
356 PERF_HPP__OVERHEAD_SYS,
357 PERF_HPP__OVERHEAD_US,
358 PERF_HPP__OVERHEAD_GUEST_SYS,
359 PERF_HPP__OVERHEAD_GUEST_US,
360 PERF_HPP__OVERHEAD_ACC,
367 void perf_hpp__init(void);
368 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
369 void perf_hpp__cancel_cumulate(void);
370 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
371 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
372 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
373 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
374 struct evlist *evlist);
377 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
378 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
379 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
380 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
381 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
382 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
383 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
384 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
385 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
386 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
388 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
390 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
392 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
398 if (perf_hpp__is_dynamic_entry(format) &&
399 !perf_hpp__defined_dynamic_entry(format, hists))
405 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
406 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
407 void perf_hpp__set_user_width(const char *width_list_str);
408 void hists__reset_column_width(struct hists *hists);
410 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
411 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
412 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
414 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
415 struct hist_entry *he, hpp_field_fn get_field,
416 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
417 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
418 struct hist_entry *he, hpp_field_fn get_field,
419 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
421 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
427 static inline size_t perf_hpp__use_color(void)
429 return !symbol_conf.field_sep;
432 static inline size_t perf_hpp__color_overhead(void)
434 return perf_hpp__use_color() ?
435 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
441 struct hist_browser_timer {
442 void (*timer)(void *arg);
447 struct annotation_options;
458 #ifdef HAVE_SLANG_SUPPORT
459 #include "../ui/keysyms.h"
460 void attr_to_script(char *buf, struct perf_event_attr *attr);
462 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
463 struct hist_browser_timer *hbt,
464 struct annotation_options *annotation_opts);
466 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
467 struct hist_browser_timer *hbt,
468 struct annotation_options *annotation_opts);
470 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
471 float min_pcnt, struct perf_env *env, bool warn_lost_event,
472 struct annotation_options *annotation_options);
474 int script_browse(const char *script_opt, struct evsel *evsel);
476 void run_script(char *cmd);
477 int res_sample_browse(struct res_sample *res_samples, int num_res,
478 struct evsel *evsel, enum rstype rstype);
479 void res_sample_init(void);
481 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
482 float min_percent, struct perf_env *env,
483 struct annotation_options *annotation_opts);
486 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
487 const char *help __maybe_unused,
488 struct hist_browser_timer *hbt __maybe_unused,
489 float min_pcnt __maybe_unused,
490 struct perf_env *env __maybe_unused,
491 bool warn_lost_event __maybe_unused,
492 struct annotation_options *annotation_options __maybe_unused)
496 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
497 struct evsel *evsel __maybe_unused,
498 struct hist_browser_timer *hbt __maybe_unused,
499 struct annotation_options *annotation_options __maybe_unused)
504 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
505 struct evsel *evsel __maybe_unused,
506 struct hist_browser_timer *hbt __maybe_unused,
507 struct annotation_options *annotation_opts __maybe_unused)
512 static inline int script_browse(const char *script_opt __maybe_unused,
513 struct evsel *evsel __maybe_unused)
518 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
519 int num_res __maybe_unused,
520 struct evsel *evsel __maybe_unused,
521 enum rstype rstype __maybe_unused)
526 static inline void res_sample_init(void) {}
528 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
529 struct evsel *evsel __maybe_unused,
530 float min_percent __maybe_unused,
531 struct perf_env *env __maybe_unused,
532 struct annotation_options *annotation_opts __maybe_unused)
538 #define K_RIGHT -2000
539 #define K_SWITCH_INPUT_DATA -3000
540 #define K_RELOAD -4000
543 unsigned int hists__sort_list_width(struct hists *hists);
544 unsigned int hists__overhead_width(struct hists *hists);
546 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
547 struct perf_sample *sample, bool nonany_branch_mode,
551 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
552 int perf_hist_config(const char *var, const char *value);
554 void perf_hpp_list__init(struct perf_hpp_list *list);
556 enum hierarchy_move_dir {
562 struct rb_node *rb_hierarchy_last(struct rb_node *node);
563 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
564 enum hierarchy_move_dir hmd);
565 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
567 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
569 return __rb_hierarchy_next(node, HMD_NORMAL);
572 #define HIERARCHY_INDENT 3
574 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
575 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
576 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
577 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
578 struct perf_hpp_list *hpp_list);
579 int hists__fprintf_headers(struct hists *hists, FILE *fp);
580 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
582 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
584 return __hists__scnprintf_title(hists, bf, size, true);
587 #endif /* __PERF_HIST_H */