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,
78 HISTC_NR_COLS, /* Last entry */
85 struct rb_root_cached entries_in_array[2];
86 struct rb_root_cached *entries_in;
87 struct rb_root_cached entries;
88 struct rb_root_cached entries_collapsed;
90 u64 nr_non_filtered_entries;
92 u64 callchain_non_filtered_period;
93 struct thread *thread_filter;
94 const struct dso *dso_filter;
95 const char *uid_filter_str;
96 const char *symbol_filter_str;
98 struct events_stats stats;
100 u16 col_len[HISTC_NR_COLS];
103 struct perf_hpp_list *hpp_list;
104 struct list_head hpp_formats;
108 #define hists__has(__h, __f) (__h)->hpp_list->__f
110 struct hist_entry_iter;
112 struct hist_iter_ops {
113 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
114 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
115 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
116 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
117 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
120 struct hist_entry_iter {
124 bool hide_unresolved;
127 struct perf_sample *sample;
128 struct hist_entry *he;
129 struct symbol *parent;
132 const struct hist_iter_ops *ops;
133 /* user-defined callback function (optional) */
134 int (*add_entry_cb)(struct hist_entry_iter *iter,
135 struct addr_location *al, bool single, void *arg);
138 extern const struct hist_iter_ops hist_iter_normal;
139 extern const struct hist_iter_ops hist_iter_branch;
140 extern const struct hist_iter_ops hist_iter_mem;
141 extern const struct hist_iter_ops hist_iter_cumulative;
143 struct hist_entry *hists__add_entry(struct hists *hists,
144 struct addr_location *al,
145 struct symbol *parent,
146 struct branch_info *bi,
148 struct perf_sample *sample,
151 struct hist_entry *hists__add_entry_ops(struct hists *hists,
152 struct hist_entry_ops *ops,
153 struct addr_location *al,
154 struct symbol *sym_parent,
155 struct branch_info *bi,
157 struct perf_sample *sample,
160 struct hist_entry *hists__add_entry_block(struct hists *hists,
161 struct addr_location *al,
162 struct block_info *bi);
164 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
165 int max_stack_depth, void *arg);
170 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
171 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
172 int hist_entry__transaction_len(void);
173 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
174 struct hists *hists);
175 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
176 struct perf_hpp_fmt *fmt, int printed);
177 void hist_entry__delete(struct hist_entry *he);
179 typedef int (*hists__resort_cb_t)(struct hist_entry *he, void *arg);
181 void evsel__output_resort_cb(struct evsel *evsel, struct ui_progress *prog,
182 hists__resort_cb_t cb, void *cb_arg);
183 void evsel__output_resort(struct evsel *evsel, struct ui_progress *prog);
184 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
185 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
186 hists__resort_cb_t cb);
187 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
189 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
190 void hists__delete_entries(struct hists *hists);
191 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
193 struct hist_entry *hists__get_entry(struct hists *hists, int idx);
195 u64 hists__total_period(struct hists *hists);
196 void hists__reset_stats(struct hists *hists);
197 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
198 void hists__inc_nr_events(struct hists *hists, u32 type);
199 void hists__inc_nr_samples(struct hists *hists, bool filtered);
201 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
202 int max_cols, float min_pcnt, FILE *fp,
203 bool ignore_callchains);
204 size_t evlist__fprintf_nr_events(struct evlist *evlist, FILE *fp);
206 void hists__filter_by_dso(struct hists *hists);
207 void hists__filter_by_thread(struct hists *hists);
208 void hists__filter_by_symbol(struct hists *hists);
209 void hists__filter_by_socket(struct hists *hists);
211 static inline bool hists__has_filter(struct hists *hists)
213 return hists->thread_filter || hists->dso_filter ||
214 hists->symbol_filter_str || (hists->socket_filter > -1);
217 u16 hists__col_len(struct hists *hists, enum hist_column col);
218 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
219 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
220 void hists__reset_col_len(struct hists *hists);
221 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
223 void hists__match(struct hists *leader, struct hists *other);
224 int hists__link(struct hists *leader, struct hists *other);
225 int hists__unlink(struct hists *hists);
232 static inline struct evsel *hists_to_evsel(struct hists *hists)
234 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
235 return &hevsel->evsel;
238 static inline struct hists *evsel__hists(struct evsel *evsel)
240 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
241 return &hevsel->hists;
244 static __pure inline bool hists__has_callchains(struct hists *hists)
246 return hists->has_callchains;
249 int hists__init(void);
250 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
252 struct rb_root_cached *hists__get_rotate_entries_in(struct hists *hists);
262 struct perf_hpp_fmt {
264 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
265 struct hists *hists, int line, int *span);
266 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
267 struct hists *hists);
268 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
269 struct hist_entry *he);
270 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
271 struct hist_entry *he);
272 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
273 struct hist_entry *a, struct hist_entry *b);
274 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
275 struct hist_entry *a, struct hist_entry *b);
276 int64_t (*sort)(struct perf_hpp_fmt *fmt,
277 struct hist_entry *a, struct hist_entry *b);
278 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
279 void (*free)(struct perf_hpp_fmt *fmt);
281 struct list_head list;
282 struct list_head sort_list;
290 struct perf_hpp_list {
291 struct list_head fields;
292 struct list_head sorts;
304 extern struct perf_hpp_list perf_hpp_list;
306 struct perf_hpp_list_node {
307 struct list_head list;
308 struct perf_hpp_list hpp;
313 void perf_hpp_list__column_register(struct perf_hpp_list *list,
314 struct perf_hpp_fmt *format);
315 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
316 struct perf_hpp_fmt *format);
317 void perf_hpp_list__prepend_sort_field(struct perf_hpp_list *list,
318 struct perf_hpp_fmt *format);
320 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
322 perf_hpp_list__column_register(&perf_hpp_list, format);
325 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
327 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
330 static inline void perf_hpp__prepend_sort_field(struct perf_hpp_fmt *format)
332 perf_hpp_list__prepend_sort_field(&perf_hpp_list, format);
335 #define perf_hpp_list__for_each_format(_list, format) \
336 list_for_each_entry(format, &(_list)->fields, list)
338 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
339 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
341 #define perf_hpp_list__for_each_sort_list(_list, format) \
342 list_for_each_entry(format, &(_list)->sorts, sort_list)
344 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
345 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
347 #define hists__for_each_format(hists, format) \
348 perf_hpp_list__for_each_format((hists)->hpp_list, format)
350 #define hists__for_each_sort_list(hists, format) \
351 perf_hpp_list__for_each_sort_list((hists)->hpp_list, format)
353 extern struct perf_hpp_fmt perf_hpp__format[];
356 /* Matches perf_hpp__format array. */
358 PERF_HPP__OVERHEAD_SYS,
359 PERF_HPP__OVERHEAD_US,
360 PERF_HPP__OVERHEAD_GUEST_SYS,
361 PERF_HPP__OVERHEAD_GUEST_US,
362 PERF_HPP__OVERHEAD_ACC,
369 void perf_hpp__init(void);
370 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
371 void perf_hpp__cancel_cumulate(void);
372 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
373 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
374 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
375 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
376 struct evlist *evlist);
379 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
380 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
381 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
382 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
383 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
384 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
385 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
386 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
387 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
388 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
390 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
392 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
394 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
400 if (perf_hpp__is_dynamic_entry(format) &&
401 !perf_hpp__defined_dynamic_entry(format, hists))
407 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
408 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
409 void perf_hpp__set_user_width(const char *width_list_str);
410 void hists__reset_column_width(struct hists *hists);
412 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
413 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
414 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
416 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
417 struct hist_entry *he, hpp_field_fn get_field,
418 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
419 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
420 struct hist_entry *he, hpp_field_fn get_field,
421 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
423 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
429 static inline size_t perf_hpp__use_color(void)
431 return !symbol_conf.field_sep;
434 static inline size_t perf_hpp__color_overhead(void)
436 return perf_hpp__use_color() ?
437 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
443 struct hist_browser_timer {
444 void (*timer)(void *arg);
449 struct annotation_options;
460 #ifdef HAVE_SLANG_SUPPORT
461 #include "../ui/keysyms.h"
462 void attr_to_script(char *buf, struct perf_event_attr *attr);
464 int map_symbol__tui_annotate(struct map_symbol *ms, struct evsel *evsel,
465 struct hist_browser_timer *hbt,
466 struct annotation_options *annotation_opts);
468 int hist_entry__tui_annotate(struct hist_entry *he, struct evsel *evsel,
469 struct hist_browser_timer *hbt,
470 struct annotation_options *annotation_opts);
472 int evlist__tui_browse_hists(struct evlist *evlist, const char *help, struct hist_browser_timer *hbt,
473 float min_pcnt, struct perf_env *env, bool warn_lost_event,
474 struct annotation_options *annotation_options);
476 int script_browse(const char *script_opt, struct evsel *evsel);
478 void run_script(char *cmd);
479 int res_sample_browse(struct res_sample *res_samples, int num_res,
480 struct evsel *evsel, enum rstype rstype);
481 void res_sample_init(void);
483 int block_hists_tui_browse(struct block_hist *bh, struct evsel *evsel,
484 float min_percent, struct perf_env *env,
485 struct annotation_options *annotation_opts);
488 int evlist__tui_browse_hists(struct evlist *evlist __maybe_unused,
489 const char *help __maybe_unused,
490 struct hist_browser_timer *hbt __maybe_unused,
491 float min_pcnt __maybe_unused,
492 struct perf_env *env __maybe_unused,
493 bool warn_lost_event __maybe_unused,
494 struct annotation_options *annotation_options __maybe_unused)
498 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
499 struct evsel *evsel __maybe_unused,
500 struct hist_browser_timer *hbt __maybe_unused,
501 struct annotation_options *annotation_options __maybe_unused)
506 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
507 struct evsel *evsel __maybe_unused,
508 struct hist_browser_timer *hbt __maybe_unused,
509 struct annotation_options *annotation_opts __maybe_unused)
514 static inline int script_browse(const char *script_opt __maybe_unused,
515 struct evsel *evsel __maybe_unused)
520 static inline int res_sample_browse(struct res_sample *res_samples __maybe_unused,
521 int num_res __maybe_unused,
522 struct evsel *evsel __maybe_unused,
523 enum rstype rstype __maybe_unused)
528 static inline void res_sample_init(void) {}
530 static inline int block_hists_tui_browse(struct block_hist *bh __maybe_unused,
531 struct evsel *evsel __maybe_unused,
532 float min_percent __maybe_unused,
533 struct perf_env *env __maybe_unused,
534 struct annotation_options *annotation_opts __maybe_unused)
540 #define K_RIGHT -2000
541 #define K_SWITCH_INPUT_DATA -3000
542 #define K_RELOAD -4000
545 unsigned int hists__sort_list_width(struct hists *hists);
546 unsigned int hists__overhead_width(struct hists *hists);
548 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
549 struct perf_sample *sample, bool nonany_branch_mode,
553 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
554 int perf_hist_config(const char *var, const char *value);
556 void perf_hpp_list__init(struct perf_hpp_list *list);
558 enum hierarchy_move_dir {
564 struct rb_node *rb_hierarchy_last(struct rb_node *node);
565 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
566 enum hierarchy_move_dir hmd);
567 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
569 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
571 return __rb_hierarchy_next(node, HMD_NORMAL);
574 #define HIERARCHY_INDENT 3
576 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
577 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
578 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
579 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
580 struct perf_hpp_list *hpp_list);
581 int hists__fprintf_headers(struct hists *hists, FILE *fp);
582 int __hists__scnprintf_title(struct hists *hists, char *bf, size_t size, bool show_freq);
584 static inline int hists__scnprintf_title(struct hists *hists, char *bf, size_t size)
586 return __hists__scnprintf_title(hists, bf, size, true);
589 #endif /* __PERF_HIST_H */