4 #include <linux/types.h>
10 #include "ui/progress.h"
13 struct hist_entry_ops;
46 HISTC_MEM_DADDR_SYMBOL,
53 HISTC_MEM_IADDR_SYMBOL,
59 HISTC_NR_COLS, /* Last entry */
66 struct rb_root entries_in_array[2];
67 struct rb_root *entries_in;
68 struct rb_root entries;
69 struct rb_root entries_collapsed;
71 u64 nr_non_filtered_entries;
73 u64 callchain_non_filtered_period;
74 struct thread *thread_filter;
75 const struct dso *dso_filter;
76 const char *uid_filter_str;
77 const char *symbol_filter_str;
79 struct events_stats stats;
81 u16 col_len[HISTC_NR_COLS];
83 struct perf_hpp_list *hpp_list;
84 struct list_head hpp_formats;
88 #define hists__has(__h, __f) (__h)->hpp_list->__f
90 struct hist_entry_iter;
92 struct hist_iter_ops {
93 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
94 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
95 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
96 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
97 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
100 struct hist_entry_iter {
104 bool hide_unresolved;
107 struct perf_evsel *evsel;
108 struct perf_sample *sample;
109 struct hist_entry *he;
110 struct symbol *parent;
113 const struct hist_iter_ops *ops;
114 /* user-defined callback function (optional) */
115 int (*add_entry_cb)(struct hist_entry_iter *iter,
116 struct addr_location *al, bool single, void *arg);
119 extern const struct hist_iter_ops hist_iter_normal;
120 extern const struct hist_iter_ops hist_iter_branch;
121 extern const struct hist_iter_ops hist_iter_mem;
122 extern const struct hist_iter_ops hist_iter_cumulative;
124 struct hist_entry *hists__add_entry(struct hists *hists,
125 struct addr_location *al,
126 struct symbol *parent,
127 struct branch_info *bi,
129 struct perf_sample *sample,
132 struct hist_entry *hists__add_entry_ops(struct hists *hists,
133 struct hist_entry_ops *ops,
134 struct addr_location *al,
135 struct symbol *sym_parent,
136 struct branch_info *bi,
138 struct perf_sample *sample,
141 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
142 int max_stack_depth, void *arg);
147 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
148 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
149 int hist_entry__transaction_len(void);
150 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
151 struct hists *hists);
152 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
153 struct perf_hpp_fmt *fmt, int printed);
154 void hist_entry__delete(struct hist_entry *he);
156 typedef int (*hists__resort_cb_t)(struct hist_entry *he);
158 void perf_evsel__output_resort(struct perf_evsel *evsel, struct ui_progress *prog);
159 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
160 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
161 hists__resort_cb_t cb);
162 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
164 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
165 void hists__delete_entries(struct hists *hists);
166 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
168 u64 hists__total_period(struct hists *hists);
169 void hists__reset_stats(struct hists *hists);
170 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
171 void hists__inc_nr_events(struct hists *hists, u32 type);
172 void hists__inc_nr_samples(struct hists *hists, bool filtered);
173 void events_stats__inc(struct events_stats *stats, u32 type);
174 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
176 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
177 int max_cols, float min_pcnt, FILE *fp,
179 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
181 void hists__filter_by_dso(struct hists *hists);
182 void hists__filter_by_thread(struct hists *hists);
183 void hists__filter_by_symbol(struct hists *hists);
184 void hists__filter_by_socket(struct hists *hists);
186 static inline bool hists__has_filter(struct hists *hists)
188 return hists->thread_filter || hists->dso_filter ||
189 hists->symbol_filter_str || (hists->socket_filter > -1);
192 u16 hists__col_len(struct hists *hists, enum hist_column col);
193 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
194 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
195 void hists__reset_col_len(struct hists *hists);
196 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
198 void hists__match(struct hists *leader, struct hists *other);
199 int hists__link(struct hists *leader, struct hists *other);
202 struct perf_evsel evsel;
206 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
208 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
209 return &hevsel->evsel;
212 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
214 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
215 return &hevsel->hists;
218 int hists__init(void);
219 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
221 struct rb_root *hists__get_rotate_entries_in(struct hists *hists);
230 struct perf_hpp_fmt {
232 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
233 struct hists *hists, int line, int *span);
234 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
235 struct hists *hists);
236 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
237 struct hist_entry *he);
238 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
239 struct hist_entry *he);
240 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
241 struct hist_entry *a, struct hist_entry *b);
242 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
243 struct hist_entry *a, struct hist_entry *b);
244 int64_t (*sort)(struct perf_hpp_fmt *fmt,
245 struct hist_entry *a, struct hist_entry *b);
246 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
247 void (*free)(struct perf_hpp_fmt *fmt);
249 struct list_head list;
250 struct list_head sort_list;
258 struct perf_hpp_list {
259 struct list_head fields;
260 struct list_head sorts;
272 extern struct perf_hpp_list perf_hpp_list;
274 struct perf_hpp_list_node {
275 struct list_head list;
276 struct perf_hpp_list hpp;
281 void perf_hpp_list__column_register(struct perf_hpp_list *list,
282 struct perf_hpp_fmt *format);
283 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
284 struct perf_hpp_fmt *format);
286 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
288 perf_hpp_list__column_register(&perf_hpp_list, format);
291 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
293 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
296 #define perf_hpp_list__for_each_format(_list, format) \
297 list_for_each_entry(format, &(_list)->fields, list)
299 #define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
300 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
302 #define perf_hpp_list__for_each_sort_list(_list, format) \
303 list_for_each_entry(format, &(_list)->sorts, sort_list)
305 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
306 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
308 #define hists__for_each_format(hists, format) \
309 perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
311 #define hists__for_each_sort_list(hists, format) \
312 perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
314 extern struct perf_hpp_fmt perf_hpp__format[];
317 /* Matches perf_hpp__format array. */
319 PERF_HPP__OVERHEAD_SYS,
320 PERF_HPP__OVERHEAD_US,
321 PERF_HPP__OVERHEAD_GUEST_SYS,
322 PERF_HPP__OVERHEAD_GUEST_US,
323 PERF_HPP__OVERHEAD_ACC,
330 void perf_hpp__init(void);
331 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
332 void perf_hpp__cancel_cumulate(void);
333 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
334 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
335 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
336 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
337 struct perf_evlist *evlist);
340 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
341 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
342 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
343 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
344 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
345 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
346 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
347 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
348 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
349 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
351 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
353 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
355 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
361 if (perf_hpp__is_dynamic_entry(format) &&
362 !perf_hpp__defined_dynamic_entry(format, hists))
368 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
369 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
370 void perf_hpp__set_user_width(const char *width_list_str);
371 void hists__reset_column_width(struct hists *hists);
373 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
374 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
375 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
377 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
378 struct hist_entry *he, hpp_field_fn get_field,
379 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
380 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
381 struct hist_entry *he, hpp_field_fn get_field,
382 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
384 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
390 static inline size_t perf_hpp__use_color(void)
392 return !symbol_conf.field_sep;
395 static inline size_t perf_hpp__color_overhead(void)
397 return perf_hpp__use_color() ?
398 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
404 struct hist_browser_timer {
405 void (*timer)(void *arg);
410 #ifdef HAVE_SLANG_SUPPORT
411 #include "../ui/keysyms.h"
412 int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
413 struct hist_browser_timer *hbt);
415 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
416 struct hist_browser_timer *hbt);
418 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
419 struct hist_browser_timer *hbt,
421 struct perf_env *env);
422 int script_browse(const char *script_opt);
425 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
426 const char *help __maybe_unused,
427 struct hist_browser_timer *hbt __maybe_unused,
428 float min_pcnt __maybe_unused,
429 struct perf_env *env __maybe_unused)
433 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
434 struct perf_evsel *evsel __maybe_unused,
435 struct hist_browser_timer *hbt __maybe_unused)
440 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
441 struct perf_evsel *evsel __maybe_unused,
442 struct hist_browser_timer *hbt __maybe_unused)
447 static inline int script_browse(const char *script_opt __maybe_unused)
453 #define K_RIGHT -2000
454 #define K_SWITCH_INPUT_DATA -3000
457 unsigned int hists__sort_list_width(struct hists *hists);
458 unsigned int hists__overhead_width(struct hists *hists);
460 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
461 struct perf_sample *sample, bool nonany_branch_mode);
464 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
465 int perf_hist_config(const char *var, const char *value);
467 void perf_hpp_list__init(struct perf_hpp_list *list);
469 enum hierarchy_move_dir {
475 struct rb_node *rb_hierarchy_last(struct rb_node *node);
476 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
477 enum hierarchy_move_dir hmd);
478 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
480 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
482 return __rb_hierarchy_next(node, HMD_NORMAL);
485 #define HIERARCHY_INDENT 3
487 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
488 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
489 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
490 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
491 struct perf_hpp_list *hpp_list);
492 int hists__fprintf_headers(struct hists *hists, FILE *fp);
494 #endif /* __PERF_HIST_H */