1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/rbtree.h>
6 #include <linux/types.h>
9 #include "events_stats.h"
11 #include "map_symbol.h"
59 HISTC_MEM_DADDR_SYMBOL,
62 HISTC_MEM_DATA_PAGE_SIZE,
68 HISTC_MEM_IADDR_SYMBOL,
80 HISTC_LOCAL_P_STAGE_CYC,
81 HISTC_GLOBAL_P_STAGE_CYC,
89 HISTC_NR_COLS, /* Last entry */
96 struct rb_root_cached entries_in_array[2];
97 struct rb_root_cached *entries_in;
98 struct rb_root_cached entries;
99 struct rb_root_cached entries_collapsed;
101 u64 nr_non_filtered_entries;
102 u64 callchain_period;
103 u64 callchain_non_filtered_period;
104 struct thread *thread_filter;
105 const struct dso *dso_filter;
106 const char *uid_filter_str;
107 const char *symbol_filter_str;
109 struct hists_stats stats;
111 u16 col_len[HISTC_NR_COLS];
114 struct perf_hpp_list *hpp_list;
115 struct list_head hpp_formats;
119 #define hists__has(__h, __f) (__h)->hpp_list->__f
121 struct hist_entry_iter;
123 struct hist_iter_ops {
124 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
125 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
126 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
127 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
128 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
131 struct hist_entry_iter {
136 struct perf_sample *sample;
137 struct hist_entry *he;
138 struct symbol *parent;
141 struct branch_info *bi;
142 struct hist_entry **he_cache;
144 const struct hist_iter_ops *ops;
145 /* user-defined callback function (optional) */
146 int (*add_entry_cb)(struct hist_entry_iter *iter,
147 struct addr_location *al, bool single, void *arg);
148 bool hide_unresolved;
151 extern const struct hist_iter_ops hist_iter_normal;
152 extern const struct hist_iter_ops hist_iter_branch;
153 extern const struct hist_iter_ops hist_iter_mem;
154 extern const struct hist_iter_ops hist_iter_cumulative;
166 u64 period_guest_sys;
174 struct namespace_id {
179 struct hist_entry_diff {
182 /* PERF_HPP__DELTA */
183 double period_ratio_delta;
185 /* PERF_HPP__RATIO */
188 /* HISTC_WEIGHTED_DIFF */
191 /* PERF_HPP_DIFF__CYCLES */
195 unsigned long svals[NUM_SPARKS];
198 struct hist_entry_ops {
199 void *(*new)(size_t size);
200 void (*free)(void *ptr);
204 * struct hist_entry - histogram entry
206 * @row_offset - offset from the first callchain expanded to appear on screen
207 * @nr_rows - rows expanded in callchain, recalculated on folding/unfolding
210 struct rb_node rb_node_in;
211 struct rb_node rb_node;
213 struct list_head node;
214 struct list_head head;
217 struct he_stat *stat_acc;
218 struct map_symbol ms;
219 struct thread *thread;
221 struct namespace_id cgroup_id;
234 struct simd_flags simd_flags;
236 /* We are added by hists__add_dummy_entry. */
246 * Since perf diff only supports the stdio output, TUI
247 * fields are only accessed from perf report (or perf
248 * top). So make it a union to reduce memory usage.
250 struct hist_entry_diff diff;
251 struct /* for TUI */ {
254 bool init_have_children;
262 struct symbol *parent;
263 struct branch_info *branch_info;
266 struct mem_info *mem_info;
267 struct block_info *block_info;
268 struct kvm_info *kvm_info;
272 struct res_sample *res_samples;
274 struct perf_hpp_list *hpp_list;
275 struct hist_entry *parent_he;
276 struct hist_entry_ops *ops;
277 struct annotated_data_type *mem_type;
279 /* this is for hierarchical entry structure */
281 struct rb_root_cached hroot_in;
282 struct rb_root_cached hroot_out;
283 }; /* non-leaf entries */
284 struct rb_root sorted_chain; /* leaf entry has callchains */
286 struct callchain_root callchain[0]; /* must be last member */
289 static __pure inline bool hist_entry__has_callchains(struct hist_entry *he)
291 return he->callchain_size != 0;
294 static inline bool hist_entry__has_pairs(struct hist_entry *he)
296 return !list_empty(&he->pairs.node);
299 static inline struct hist_entry *hist_entry__next_pair(struct hist_entry *he)
301 if (hist_entry__has_pairs(he))
302 return list_entry(he->pairs.node.next, struct hist_entry, pairs.node);
306 static inline void hist_entry__add_pair(struct hist_entry *pair,
307 struct hist_entry *he)
309 list_add_tail(&pair->pairs.node, &he->pairs.head);
312 struct hist_entry *hists__add_entry(struct hists *hists,
313 struct addr_location *al,
314 struct symbol *parent,
315 struct branch_info *bi,
318 struct perf_sample *sample,
321 struct hist_entry *hists__add_entry_ops(struct hists *hists,
322 struct hist_entry_ops *ops,
323 struct addr_location *al,
324 struct symbol *sym_parent,
325 struct branch_info *bi,
328 struct perf_sample *sample,
331 struct hist_entry *hists__add_entry_block(struct hists *hists,
332 struct addr_location *al,
333 struct block_info *bi);
335 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
336 int max_stack_depth, void *arg);
341 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
342 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
343 int hist_entry__transaction_len(void);
344 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
345 struct hists *hists);
346 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
347 struct perf_hpp_fmt *fmt, int printed);
348 int hist_entry__sym_snprintf(struct hist_entry *he, char *bf, size_t size,
350 void hist_entry__delete(struct hist_entry *he);
352 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
354 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
355 hists__resort_cb_t cb, void *cb_arg);
356 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
357 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
358 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
359 hists__resort_cb_t cb);
360 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
362 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
363 void hists__delete_entries(struct hists *hists);
364 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
366 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
368 u64 hists__total_period(struct hists *hists);
369 void hists__reset_stats(struct hists *hists);
370 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
371 void hists__inc_nr_events(struct hists *hists);
372 void hists__inc_nr_samples(struct hists *hists, bool filtered);
373 void hists__inc_nr_lost_samples(struct hists *hists, u32 lost);
375 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
376 int max_cols, float min_pcnt, FILE *fp,
377 bool ignore_callchains);
378 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp,
381 void hists__filter_by_dso(struct hists *hists);
382 void hists__filter_by_thread(struct hists *hists);
383 void hists__filter_by_symbol(struct hists *hists);
384 void hists__filter_by_socket(struct hists *hists);
386 static inline bool hists__has_filter(struct hists *hists)
388 return hists->thread_filter || hists->dso_filter ||
389 hists->symbol_filter_str || (hists->socket_filter > -1);
392 u16 hists__col_len(struct hists *hists, enum hist_column col);
393 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
394 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
395 void hists__reset_col_len(struct hists *hists);
396 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
398 void hists__match(struct hists *leader, struct hists *other);
399 int hists__link(struct hists *leader, struct hists *other);
400 int hists__unlink(struct hists *hists);
402 static inline float hist_entry__get_percent_limit(struct hist_entry *he)
404 u64 period = he->stat.period;
405 u64 total_period = hists__total_period(he->hists);
407 if (unlikely(total_period == 0))
410 if (symbol_conf.cumulate_callchain)
411 period = he->stat_acc->period;
413 return period * 100.0 / total_period;
421 static inline struct evsel *hists_to_evsel(struct hists *hists)
423 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
424 return &hevsel->evsel;
427 static inline struct hists *evsel__hists(struct evsel *evsel)
429 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
430 return &hevsel->hists;
433 static __pure inline bool hists__has_callchains(struct hists *hists)
435 return hists->has_callchains;
438 int hists__init(void);
439 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
441 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
451 struct perf_hpp_fmt {
453 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
454 struct hists *hists, int line, int *span);
455 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
456 struct hists *hists);
457 void (*init)(struct perf_hpp_fmt *fmt, struct hist_entry *he);
458 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
459 struct hist_entry *he);
460 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
461 struct hist_entry *he);
462 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
463 struct hist_entry *a, struct hist_entry *b);
464 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
465 struct hist_entry *a, struct hist_entry *b);
466 int64_t (*sort)(struct perf_hpp_fmt *fmt,
467 struct hist_entry *a, struct hist_entry *b);
468 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
469 void (*free)(struct perf_hpp_fmt *fmt);
471 struct list_head list;
472 struct list_head sort_list;
480 struct perf_hpp_list {
481 struct list_head fields;
482 struct list_head sorts;
494 extern struct perf_hpp_list perf_hpp_list;
496 struct perf_hpp_list_node {
497 struct list_head list;
498 struct perf_hpp_list hpp;
503 void perf_hpp_list__column_register(struct perf_hpp_list *list,
504 struct perf_hpp_fmt *format);
505 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
506 struct perf_hpp_fmt *format);
507 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
508 struct perf_hpp_fmt *format);
510 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
512 perf_hpp_list__column_register(&perf_hpp_list, format);
515 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
517 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
520 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
522 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
525 #define perf_hpp_list__for_each_format(_list, format) \
526 list_for_each_entry(format, &(_list)->fields, list)
528 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
529 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
531 #define perf_hpp_list__for_each_sort_list(_list, format) \
532 list_for_each_entry(format, &(_list)->sorts, sort_list)
534 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
535 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
537 #define hists__for_each_format(hists, format) \
538 perf_hpp_list__for_each_format((hists)->hpp_list, format)
540 #define hists__for_each_sort_list(hists, format) \
541 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
543 extern struct perf_hpp_fmt perf_hpp__format[];
546 /* Matches perf_hpp__format array. */
548 PERF_HPP__OVERHEAD_SYS,
549 PERF_HPP__OVERHEAD_US,
550 PERF_HPP__OVERHEAD_GUEST_SYS,
551 PERF_HPP__OVERHEAD_GUEST_US,
552 PERF_HPP__OVERHEAD_ACC,
562 void perf_hpp__init(void);
563 void perf_hpp__cancel_cumulate(void);
564 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
565 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
566 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
567 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
568 struct evlist *evlist);
571 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
572 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
573 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
574 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
575 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
576 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
577 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
578 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
579 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
580 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
582 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
584 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
586 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
592 if (perf_hpp__is_dynamic_entry(format) &&
593 !perf_hpp__defined_dynamic_entry(format, hists))
599 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
600 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
601 void perf_hpp__set_user_width(const char *width_list_str);
602 void hists__reset_column_width(struct hists *hists);
604 enum perf_hpp_fmt_type {
605 PERF_HPP_FMT_TYPE__RAW,
606 PERF_HPP_FMT_TYPE__PERCENT,
607 PERF_HPP_FMT_TYPE__AVERAGE,
610 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
611 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
612 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
614 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
615 struct hist_entry *he, hpp_field_fn get_field,
616 const char *fmtstr, hpp_snprint_fn print_fn,
617 enum perf_hpp_fmt_type fmtype);
618 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
619 struct hist_entry *he, hpp_field_fn get_field,
620 const char *fmtstr, hpp_snprint_fn print_fn,
621 enum perf_hpp_fmt_type fmtype);
623 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
629 static inline size_t perf_hpp__use_color(void)
631 return !symbol_conf.field_sep;
634 static inline size_t perf_hpp__color_overhead(void)
636 return perf_hpp__use_color() ?
637 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
643 struct hist_browser_timer {
644 void (*timer)(void *arg);
656 struct hists block_hists;
657 struct perf_hpp_list block_list;
658 struct perf_hpp_fmt block_fmt;
661 struct hist_entry he;
664 #ifdef HAVE_SLANG_SUPPORT
665 #include "../ui/keysyms.h"
666 void attr_to_script(char *buf, struct perf_event_attr *attr);
668 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
669 struct hist_browser_timer *hbt);
671 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
672 struct hist_browser_timer *hbt);
674 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
675 float min_pcnt, struct perf_env *env, bool warn_lost_event);
677 int script_browse(const char *script_opt, struct evsel *evsel);
679 void run_script(char *cmd);
680 int res_sample_browse(struct res_sample *res_samples, int num_res,
681 struct evsel *evsel, enum rstype rstype);
682 void res_sample_init(void);
684 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
685 float min_percent, struct perf_env *env);
688 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
689 const char *help __maybe_unused,
690 struct hist_browser_timer *hbt __maybe_unused,
691 float min_pcnt __maybe_unused,
692 struct perf_env *env __maybe_unused,
693 bool warn_lost_event __maybe_unused)
697 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
698 struct evsel *evsel __maybe_unused,
699 struct hist_browser_timer *hbt __maybe_unused)
704 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
705 struct evsel *evsel __maybe_unused,
706 struct hist_browser_timer *hbt __maybe_unused)
711 static inline int script_browse(const char *script_opt __maybe_unused,
712 struct evsel *evsel __maybe_unused)
717 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
718 int num_res __maybe_unused,
719 struct evsel *evsel __maybe_unused,
720 enum rstype rstype __maybe_unused)
725 static inline void res_sample_init(void) {}
727 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
728 struct evsel *evsel __maybe_unused,
729 float min_percent __maybe_unused,
730 struct perf_env *env __maybe_unused)
736 #define K_RIGHT -2000
737 #define K_SWITCH_INPUT_DATA -3000
738 #define K_RELOAD -4000
741 unsigned int hists__sort_list_width(struct hists *hists);
742 unsigned int hists__overhead_width(struct hists *hists);
744 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
745 struct perf_sample *sample, bool nonany_branch_mode,
749 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
750 int perf_hist_config(const char *var, const char *value);
752 void perf_hpp_list__init(struct perf_hpp_list *list);
754 enum hierarchy_move_dir {
760 struct rb_node *rb_hierarchy_last(struct rb_node *node);
761 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
762 enum hierarchy_move_dir hmd);
763 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
765 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
767 return __rb_hierarchy_next(node, HMD_NORMAL);
770 #define HIERARCHY_INDENT 3
772 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
773 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
774 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
775 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
776 struct perf_hpp_list *hpp_list);
777 int hists__fprintf_headers(struct hists *hists, FILE *fp);
778 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
780 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
782 return __hists__scnprintf_title(hists, bf, size, true);
785 #endif /* __PERF_HIST_H */