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