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,
79 HISTC_NR_COLS, /* Last entry */
86 struct rb_root_cached entries_in_array[2];
87 struct rb_root_cached *entries_in;
88 struct rb_root_cached entries;
89 struct rb_root_cached entries_collapsed;
91 u64 nr_non_filtered_entries;
93 u64 callchain_non_filtered_period;
94 struct thread *thread_filter;
95 const struct dso *dso_filter;
96 const char *uid_filter_str;
97 const char *symbol_filter_str;
99 struct hists_stats stats;
101 u16 col_len[HISTC_NR_COLS];
104 struct perf_hpp_list *hpp_list;
105 struct list_head hpp_formats;
109 #define hists__has(__h, __f) (__h)->hpp_list->__f
111 struct hist_entry_iter;
113 struct hist_iter_ops {
114 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
115 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
116 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
117 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
118 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
121 struct hist_entry_iter {
125 bool hide_unresolved;
128 struct perf_sample *sample;
129 struct hist_entry *he;
130 struct symbol *parent;
133 const struct hist_iter_ops *ops;
134 /* user-defined callback function (optional) */
135 int (*add_entry_cb)(struct hist_entry_iter *iter,
136 struct addr_location *al, bool single, void *arg);
139 extern const struct hist_iter_ops hist_iter_normal;
140 extern const struct hist_iter_ops hist_iter_branch;
141 extern const struct hist_iter_ops hist_iter_mem;
142 extern const struct hist_iter_ops hist_iter_cumulative;
144 struct hist_entry *hists__add_entry(struct hists *hists,
145 struct addr_location *al,
146 struct symbol *parent,
147 struct branch_info *bi,
149 struct perf_sample *sample,
152 struct hist_entry *hists__add_entry_ops(struct hists *hists,
153 struct hist_entry_ops *ops,
154 struct addr_location *al,
155 struct symbol *sym_parent,
156 struct branch_info *bi,
158 struct perf_sample *sample,
161 struct hist_entry *hists__add_entry_block(struct hists *hists,
162 struct addr_location *al,
163 struct block_info *bi);
165 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
166 int max_stack_depth, void *arg);
171 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
172 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
173 int hist_entry__transaction_len(void);
174 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
175 struct hists *hists);
176 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
177 struct perf_hpp_fmt *fmt, int printed);
178 void hist_entry__delete(struct hist_entry *he);
180 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
182 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
183 hists__resort_cb_t cb, void *cb_arg);
184 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
185 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
186 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
187 hists__resort_cb_t cb);
188 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
190 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
191 void hists__delete_entries(struct hists *hists);
192 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
194 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
196 u64 hists__total_period(struct hists *hists);
197 void hists__reset_stats(struct hists *hists);
198 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
199 void hists__inc_nr_events(struct hists *hists);
200 void hists__inc_nr_samples(struct hists *hists, bool filtered);
202 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
203 int max_cols, float min_pcnt, FILE *fp,
204 bool ignore_callchains);
205 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp,
208 void hists__filter_by_dso(struct hists *hists);
209 void hists__filter_by_thread(struct hists *hists);
210 void hists__filter_by_symbol(struct hists *hists);
211 void hists__filter_by_socket(struct hists *hists);
213 static inline bool hists__has_filter(struct hists *hists)
215 return hists->thread_filter || hists->dso_filter ||
216 hists->symbol_filter_str || (hists->socket_filter > -1);
219 u16 hists__col_len(struct hists *hists, enum hist_column col);
220 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
221 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
222 void hists__reset_col_len(struct hists *hists);
223 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
225 void hists__match(struct hists *leader, struct hists *other);
226 int hists__link(struct hists *leader, struct hists *other);
227 int hists__unlink(struct hists *hists);
234 static inline struct evsel *hists_to_evsel(struct hists *hists)
236 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
237 return &hevsel->evsel;
240 static inline struct hists *evsel__hists(struct evsel *evsel)
242 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
243 return &hevsel->hists;
246 static __pure inline bool hists__has_callchains(struct hists *hists)
248 return hists->has_callchains;
251 int hists__init(void);
252 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
254 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
264 struct perf_hpp_fmt {
266 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
267 struct hists *hists, int line, int *span);
268 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
269 struct hists *hists);
270 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
271 struct hist_entry *he);
272 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
273 struct hist_entry *he);
274 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
275 struct hist_entry *a, struct hist_entry *b);
276 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
277 struct hist_entry *a, struct hist_entry *b);
278 int64_t (*sort)(struct perf_hpp_fmt *fmt,
279 struct hist_entry *a, struct hist_entry *b);
280 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
281 void (*free)(struct perf_hpp_fmt *fmt);
283 struct list_head list;
284 struct list_head sort_list;
292 struct perf_hpp_list {
293 struct list_head fields;
294 struct list_head sorts;
306 extern struct perf_hpp_list perf_hpp_list;
308 struct perf_hpp_list_node {
309 struct list_head list;
310 struct perf_hpp_list hpp;
315 void perf_hpp_list__column_register(struct perf_hpp_list *list,
316 struct perf_hpp_fmt *format);
317 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
318 struct perf_hpp_fmt *format);
319 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
320 struct perf_hpp_fmt *format);
322 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
324 perf_hpp_list__column_register(&perf_hpp_list, format);
327 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
329 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
332 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
334 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
337 #define perf_hpp_list__for_each_format(_list, format) \
338 list_for_each_entry(format, &(_list)->fields, list)
340 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
341 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
343 #define perf_hpp_list__for_each_sort_list(_list, format) \
344 list_for_each_entry(format, &(_list)->sorts, sort_list)
346 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
347 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
349 #define hists__for_each_format(hists, format) \
350 perf_hpp_list__for_each_format((hists)->hpp_list, format)
352 #define hists__for_each_sort_list(hists, format) \
353 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
355 extern struct perf_hpp_fmt perf_hpp__format[];
358 /* Matches perf_hpp__format array. */
360 PERF_HPP__OVERHEAD_SYS,
361 PERF_HPP__OVERHEAD_US,
362 PERF_HPP__OVERHEAD_GUEST_SYS,
363 PERF_HPP__OVERHEAD_GUEST_US,
364 PERF_HPP__OVERHEAD_ACC,
371 void perf_hpp__init(void);
372 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
373 void perf_hpp__cancel_cumulate(void);
374 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
375 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
376 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
377 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
378 struct evlist *evlist);
381 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
382 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
383 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
384 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
385 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
386 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
387 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
388 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
389 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
390 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
392 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
394 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
396 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
402 if (perf_hpp__is_dynamic_entry(format) &&
403 !perf_hpp__defined_dynamic_entry(format, hists))
409 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
410 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
411 void perf_hpp__set_user_width(const char *width_list_str);
412 void hists__reset_column_width(struct hists *hists);
414 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
415 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
416 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
418 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
419 struct hist_entry *he, hpp_field_fn get_field,
420 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
421 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
422 struct hist_entry *he, hpp_field_fn get_field,
423 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
425 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
431 static inline size_t perf_hpp__use_color(void)
433 return !symbol_conf.field_sep;
436 static inline size_t perf_hpp__color_overhead(void)
438 return perf_hpp__use_color() ?
439 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
445 struct hist_browser_timer {
446 void (*timer)(void *arg);
451 struct annotation_options;
462 #ifdef HAVE_SLANG_SUPPORT
463 #include "../ui/keysyms.h"
464 void attr_to_script(char *buf, struct perf_event_attr *attr);
466 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
467 struct hist_browser_timer *hbt,
468 struct annotation_options *annotation_opts);
470 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
471 struct hist_browser_timer *hbt,
472 struct annotation_options *annotation_opts);
474 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
475 float min_pcnt, struct perf_env *env, bool warn_lost_event,
476 struct annotation_options *annotation_options);
478 int script_browse(const char *script_opt, struct evsel *evsel);
480 void run_script(char *cmd);
481 int res_sample_browse(struct res_sample *res_samples, int num_res,
482 struct evsel *evsel, enum rstype rstype);
483 void res_sample_init(void);
485 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
486 float min_percent, struct perf_env *env,
487 struct annotation_options *annotation_opts);
490 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
491 const char *help __maybe_unused,
492 struct hist_browser_timer *hbt __maybe_unused,
493 float min_pcnt __maybe_unused,
494 struct perf_env *env __maybe_unused,
495 bool warn_lost_event __maybe_unused,
496 struct annotation_options *annotation_options __maybe_unused)
500 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
501 struct evsel *evsel __maybe_unused,
502 struct hist_browser_timer *hbt __maybe_unused,
503 struct annotation_options *annotation_options __maybe_unused)
508 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
509 struct evsel *evsel __maybe_unused,
510 struct hist_browser_timer *hbt __maybe_unused,
511 struct annotation_options *annotation_opts __maybe_unused)
516 static inline int script_browse(const char *script_opt __maybe_unused,
517 struct evsel *evsel __maybe_unused)
522 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
523 int num_res __maybe_unused,
524 struct evsel *evsel __maybe_unused,
525 enum rstype rstype __maybe_unused)
530 static inline void res_sample_init(void) {}
532 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
533 struct evsel *evsel __maybe_unused,
534 float min_percent __maybe_unused,
535 struct perf_env *env __maybe_unused,
536 struct annotation_options *annotation_opts __maybe_unused)
542 #define K_RIGHT -2000
543 #define K_SWITCH_INPUT_DATA -3000
544 #define K_RELOAD -4000
547 unsigned int hists__sort_list_width(struct hists *hists);
548 unsigned int hists__overhead_width(struct hists *hists);
550 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
551 struct perf_sample *sample, bool nonany_branch_mode,
555 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
556 int perf_hist_config(const char *var, const char *value);
558 void perf_hpp_list__init(struct perf_hpp_list *list);
560 enum hierarchy_move_dir {
566 struct rb_node *rb_hierarchy_last(struct rb_node *node);
567 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
568 enum hierarchy_move_dir hmd);
569 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
571 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
573 return __rb_hierarchy_next(node, HMD_NORMAL);
576 #define HIERARCHY_INDENT 3
578 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
579 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
580 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
581 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
582 struct perf_hpp_list *hpp_list);
583 int hists__fprintf_headers(struct hists *hists, FILE *fp);
584 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
586 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
588 return __hists__scnprintf_title(hists, bf, size, true);
591 #endif /* __PERF_HIST_H */