xref: /openbmc/linux/tools/perf/util/hist.h (revision 8730046c)
1 #ifndef __PERF_HIST_H
2 #define __PERF_HIST_H
3 
4 #include <linux/types.h>
5 #include <pthread.h>
6 #include "callchain.h"
7 #include "evsel.h"
8 #include "header.h"
9 #include "color.h"
10 #include "ui/progress.h"
11 
12 struct hist_entry;
13 struct hist_entry_ops;
14 struct addr_location;
15 struct symbol;
16 
17 enum hist_filter {
18 	HIST_FILTER__DSO,
19 	HIST_FILTER__THREAD,
20 	HIST_FILTER__PARENT,
21 	HIST_FILTER__SYMBOL,
22 	HIST_FILTER__GUEST,
23 	HIST_FILTER__HOST,
24 	HIST_FILTER__SOCKET,
25 	HIST_FILTER__C2C,
26 };
27 
28 enum hist_column {
29 	HISTC_SYMBOL,
30 	HISTC_DSO,
31 	HISTC_THREAD,
32 	HISTC_COMM,
33 	HISTC_PARENT,
34 	HISTC_CPU,
35 	HISTC_SOCKET,
36 	HISTC_SRCLINE,
37 	HISTC_SRCFILE,
38 	HISTC_MISPREDICT,
39 	HISTC_IN_TX,
40 	HISTC_ABORT,
41 	HISTC_SYMBOL_FROM,
42 	HISTC_SYMBOL_TO,
43 	HISTC_DSO_FROM,
44 	HISTC_DSO_TO,
45 	HISTC_LOCAL_WEIGHT,
46 	HISTC_GLOBAL_WEIGHT,
47 	HISTC_MEM_DADDR_SYMBOL,
48 	HISTC_MEM_DADDR_DSO,
49 	HISTC_MEM_LOCKED,
50 	HISTC_MEM_TLB,
51 	HISTC_MEM_LVL,
52 	HISTC_MEM_SNOOP,
53 	HISTC_MEM_DCACHELINE,
54 	HISTC_MEM_IADDR_SYMBOL,
55 	HISTC_TRANSACTION,
56 	HISTC_CYCLES,
57 	HISTC_SRCLINE_FROM,
58 	HISTC_SRCLINE_TO,
59 	HISTC_TRACE,
60 	HISTC_NR_COLS, /* Last entry */
61 };
62 
63 struct thread;
64 struct dso;
65 
66 struct hists {
67 	struct rb_root		entries_in_array[2];
68 	struct rb_root		*entries_in;
69 	struct rb_root		entries;
70 	struct rb_root		entries_collapsed;
71 	u64			nr_entries;
72 	u64			nr_non_filtered_entries;
73 	u64			callchain_period;
74 	u64			callchain_non_filtered_period;
75 	struct thread		*thread_filter;
76 	const struct dso	*dso_filter;
77 	const char		*uid_filter_str;
78 	const char		*symbol_filter_str;
79 	pthread_mutex_t		lock;
80 	struct events_stats	stats;
81 	u64			event_stream;
82 	u16			col_len[HISTC_NR_COLS];
83 	int			socket_filter;
84 	struct perf_hpp_list	*hpp_list;
85 	struct list_head	hpp_formats;
86 	int			nr_hpp_node;
87 };
88 
89 #define hists__has(__h, __f) (__h)->hpp_list->__f
90 
91 struct hist_entry_iter;
92 
93 struct hist_iter_ops {
94 	int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
95 	int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
96 	int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
97 	int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
98 	int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
99 };
100 
101 struct hist_entry_iter {
102 	int total;
103 	int curr;
104 
105 	bool hide_unresolved;
106 	int max_stack;
107 
108 	struct perf_evsel *evsel;
109 	struct perf_sample *sample;
110 	struct hist_entry *he;
111 	struct symbol *parent;
112 	void *priv;
113 
114 	const struct hist_iter_ops *ops;
115 	/* user-defined callback function (optional) */
116 	int (*add_entry_cb)(struct hist_entry_iter *iter,
117 			    struct addr_location *al, bool single, void *arg);
118 };
119 
120 extern const struct hist_iter_ops hist_iter_normal;
121 extern const struct hist_iter_ops hist_iter_branch;
122 extern const struct hist_iter_ops hist_iter_mem;
123 extern const struct hist_iter_ops hist_iter_cumulative;
124 
125 struct hist_entry *hists__add_entry(struct hists *hists,
126 				    struct addr_location *al,
127 				    struct symbol *parent,
128 				    struct branch_info *bi,
129 				    struct mem_info *mi,
130 				    struct perf_sample *sample,
131 				    bool sample_self);
132 
133 struct hist_entry *hists__add_entry_ops(struct hists *hists,
134 					struct hist_entry_ops *ops,
135 					struct addr_location *al,
136 					struct symbol *sym_parent,
137 					struct branch_info *bi,
138 					struct mem_info *mi,
139 					struct perf_sample *sample,
140 					bool sample_self);
141 
142 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
143 			 int max_stack_depth, void *arg);
144 
145 struct perf_hpp;
146 struct perf_hpp_fmt;
147 
148 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
149 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
150 int hist_entry__transaction_len(void);
151 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
152 			      struct hists *hists);
153 int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
154 				   struct perf_hpp_fmt *fmt, int printed);
155 void hist_entry__delete(struct hist_entry *he);
156 
157 typedef int (*hists__resort_cb_t)(struct hist_entry *he);
158 
159 void perf_evsel__output_resort(struct perf_evsel *evsel, struct ui_progress *prog);
160 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
161 void hists__output_resort_cb(struct hists *hists, struct ui_progress *prog,
162 			     hists__resort_cb_t cb);
163 int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
164 
165 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
166 void hists__delete_entries(struct hists *hists);
167 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
168 
169 u64 hists__total_period(struct hists *hists);
170 void hists__reset_stats(struct hists *hists);
171 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
172 void hists__inc_nr_events(struct hists *hists, u32 type);
173 void hists__inc_nr_samples(struct hists *hists, bool filtered);
174 void events_stats__inc(struct events_stats *stats, u32 type);
175 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
176 
177 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
178 		      int max_cols, float min_pcnt, FILE *fp,
179 		      bool use_callchain);
180 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
181 
182 void hists__filter_by_dso(struct hists *hists);
183 void hists__filter_by_thread(struct hists *hists);
184 void hists__filter_by_symbol(struct hists *hists);
185 void hists__filter_by_socket(struct hists *hists);
186 
187 static inline bool hists__has_filter(struct hists *hists)
188 {
189 	return hists->thread_filter || hists->dso_filter ||
190 		hists->symbol_filter_str || (hists->socket_filter > -1);
191 }
192 
193 u16 hists__col_len(struct hists *hists, enum hist_column col);
194 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
195 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
196 void hists__reset_col_len(struct hists *hists);
197 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
198 
199 void hists__match(struct hists *leader, struct hists *other);
200 int hists__link(struct hists *leader, struct hists *other);
201 
202 struct hists_evsel {
203 	struct perf_evsel evsel;
204 	struct hists	  hists;
205 };
206 
207 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
208 {
209 	struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
210 	return &hevsel->evsel;
211 }
212 
213 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
214 {
215 	struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
216 	return &hevsel->hists;
217 }
218 
219 int hists__init(void);
220 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
221 
222 struct rb_root *hists__get_rotate_entries_in(struct hists *hists);
223 
224 struct perf_hpp {
225 	char *buf;
226 	size_t size;
227 	const char *sep;
228 	void *ptr;
229 };
230 
231 struct perf_hpp_fmt {
232 	const char *name;
233 	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
234 		      struct hists *hists, int line, int *span);
235 	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
236 		     struct hists *hists);
237 	int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
238 		     struct hist_entry *he);
239 	int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
240 		     struct hist_entry *he);
241 	int64_t (*cmp)(struct perf_hpp_fmt *fmt,
242 		       struct hist_entry *a, struct hist_entry *b);
243 	int64_t (*collapse)(struct perf_hpp_fmt *fmt,
244 			    struct hist_entry *a, struct hist_entry *b);
245 	int64_t (*sort)(struct perf_hpp_fmt *fmt,
246 			struct hist_entry *a, struct hist_entry *b);
247 	bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
248 	void (*free)(struct perf_hpp_fmt *fmt);
249 
250 	struct list_head list;
251 	struct list_head sort_list;
252 	bool elide;
253 	int len;
254 	int user_len;
255 	int idx;
256 	int level;
257 };
258 
259 struct perf_hpp_list {
260 	struct list_head fields;
261 	struct list_head sorts;
262 
263 	int nr_header_lines;
264 	int need_collapse;
265 	int parent;
266 	int sym;
267 	int dso;
268 	int socket;
269 	int thread;
270 	int comm;
271 };
272 
273 extern struct perf_hpp_list perf_hpp_list;
274 
275 struct perf_hpp_list_node {
276 	struct list_head	list;
277 	struct perf_hpp_list	hpp;
278 	int			level;
279 	bool			skip;
280 };
281 
282 void perf_hpp_list__column_register(struct perf_hpp_list *list,
283 				    struct perf_hpp_fmt *format);
284 void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
285 					struct perf_hpp_fmt *format);
286 
287 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
288 {
289 	perf_hpp_list__column_register(&perf_hpp_list, format);
290 }
291 
292 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
293 {
294 	perf_hpp_list__register_sort_field(&perf_hpp_list, format);
295 }
296 
297 #define perf_hpp_list__for_each_format(_list, format) \
298 	list_for_each_entry(format, &(_list)->fields, list)
299 
300 #define perf_hpp_list__for_each_format_safe(_list, format, tmp)	\
301 	list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
302 
303 #define perf_hpp_list__for_each_sort_list(_list, format) \
304 	list_for_each_entry(format, &(_list)->sorts, sort_list)
305 
306 #define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp)	\
307 	list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
308 
309 #define hists__for_each_format(hists, format) \
310 	perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
311 
312 #define hists__for_each_sort_list(hists, format) \
313 	perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
314 
315 extern struct perf_hpp_fmt perf_hpp__format[];
316 
317 enum {
318 	/* Matches perf_hpp__format array. */
319 	PERF_HPP__OVERHEAD,
320 	PERF_HPP__OVERHEAD_SYS,
321 	PERF_HPP__OVERHEAD_US,
322 	PERF_HPP__OVERHEAD_GUEST_SYS,
323 	PERF_HPP__OVERHEAD_GUEST_US,
324 	PERF_HPP__OVERHEAD_ACC,
325 	PERF_HPP__SAMPLES,
326 	PERF_HPP__PERIOD,
327 
328 	PERF_HPP__MAX_INDEX
329 };
330 
331 void perf_hpp__init(void);
332 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
333 void perf_hpp__cancel_cumulate(void);
334 void perf_hpp__setup_output_field(struct perf_hpp_list *list);
335 void perf_hpp__reset_output_field(struct perf_hpp_list *list);
336 void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
337 int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
338 				  struct perf_evlist *evlist);
339 
340 
341 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
342 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
343 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
344 bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
345 bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
346 bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
347 bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
348 bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
349 bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
350 bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
351 
352 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
353 
354 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
355 
356 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
357 					 struct hists *hists)
358 {
359 	if (format->elide)
360 		return true;
361 
362 	if (perf_hpp__is_dynamic_entry(format) &&
363 	    !perf_hpp__defined_dynamic_entry(format, hists))
364 		return true;
365 
366 	return false;
367 }
368 
369 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
370 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
371 void perf_hpp__set_user_width(const char *width_list_str);
372 void hists__reset_column_width(struct hists *hists);
373 
374 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
375 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
376 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
377 
378 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
379 	     struct hist_entry *he, hpp_field_fn get_field,
380 	     const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
381 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
382 		 struct hist_entry *he, hpp_field_fn get_field,
383 		 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
384 
385 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
386 {
387 	hpp->buf  += inc;
388 	hpp->size -= inc;
389 }
390 
391 static inline size_t perf_hpp__use_color(void)
392 {
393 	return !symbol_conf.field_sep;
394 }
395 
396 static inline size_t perf_hpp__color_overhead(void)
397 {
398 	return perf_hpp__use_color() ?
399 	       (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
400 	       : 0;
401 }
402 
403 struct perf_evlist;
404 
405 struct hist_browser_timer {
406 	void (*timer)(void *arg);
407 	void *arg;
408 	int refresh;
409 };
410 
411 #ifdef HAVE_SLANG_SUPPORT
412 #include "../ui/keysyms.h"
413 int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
414 			     struct hist_browser_timer *hbt);
415 
416 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
417 			     struct hist_browser_timer *hbt);
418 
419 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
420 				  struct hist_browser_timer *hbt,
421 				  float min_pcnt,
422 				  struct perf_env *env);
423 int script_browse(const char *script_opt);
424 #else
425 static inline
426 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
427 				  const char *help __maybe_unused,
428 				  struct hist_browser_timer *hbt __maybe_unused,
429 				  float min_pcnt __maybe_unused,
430 				  struct perf_env *env __maybe_unused)
431 {
432 	return 0;
433 }
434 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
435 					   struct perf_evsel *evsel __maybe_unused,
436 					   struct hist_browser_timer *hbt __maybe_unused)
437 {
438 	return 0;
439 }
440 
441 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
442 					   struct perf_evsel *evsel __maybe_unused,
443 					   struct hist_browser_timer *hbt __maybe_unused)
444 {
445 	return 0;
446 }
447 
448 static inline int script_browse(const char *script_opt __maybe_unused)
449 {
450 	return 0;
451 }
452 
453 #define K_LEFT  -1000
454 #define K_RIGHT -2000
455 #define K_SWITCH_INPUT_DATA -3000
456 #endif
457 
458 unsigned int hists__sort_list_width(struct hists *hists);
459 unsigned int hists__overhead_width(struct hists *hists);
460 
461 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
462 			  struct perf_sample *sample, bool nonany_branch_mode);
463 
464 struct option;
465 int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
466 int perf_hist_config(const char *var, const char *value);
467 
468 void perf_hpp_list__init(struct perf_hpp_list *list);
469 
470 enum hierarchy_move_dir {
471 	HMD_NORMAL,
472 	HMD_FORCE_SIBLING,
473 	HMD_FORCE_CHILD,
474 };
475 
476 struct rb_node *rb_hierarchy_last(struct rb_node *node);
477 struct rb_node *__rb_hierarchy_next(struct rb_node *node,
478 				    enum hierarchy_move_dir hmd);
479 struct rb_node *rb_hierarchy_prev(struct rb_node *node);
480 
481 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
482 {
483 	return __rb_hierarchy_next(node, HMD_NORMAL);
484 }
485 
486 #define HIERARCHY_INDENT  3
487 
488 bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
489 int hpp_color_scnprintf(struct perf_hpp *hpp, const char *fmt, ...);
490 int __hpp__slsmg_color_printf(struct perf_hpp *hpp, const char *fmt, ...);
491 int __hist_entry__snprintf(struct hist_entry *he, struct perf_hpp *hpp,
492 			   struct perf_hpp_list *hpp_list);
493 int hists__fprintf_headers(struct hists *hists, FILE *fp);
494 
495 #endif	/* __PERF_HIST_H */
496