xref: /linux/tools/perf/util/hist.h (revision f3a8b6645dc2e60d11f20c1c23afd964ff4e55ae)
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 };
26 
27 enum hist_column {
28 	HISTC_SYMBOL,
29 	HISTC_DSO,
30 	HISTC_THREAD,
31 	HISTC_COMM,
32 	HISTC_PARENT,
33 	HISTC_CPU,
34 	HISTC_SOCKET,
35 	HISTC_SRCLINE,
36 	HISTC_SRCFILE,
37 	HISTC_MISPREDICT,
38 	HISTC_IN_TX,
39 	HISTC_ABORT,
40 	HISTC_SYMBOL_FROM,
41 	HISTC_SYMBOL_TO,
42 	HISTC_DSO_FROM,
43 	HISTC_DSO_TO,
44 	HISTC_LOCAL_WEIGHT,
45 	HISTC_GLOBAL_WEIGHT,
46 	HISTC_MEM_DADDR_SYMBOL,
47 	HISTC_MEM_DADDR_DSO,
48 	HISTC_MEM_LOCKED,
49 	HISTC_MEM_TLB,
50 	HISTC_MEM_LVL,
51 	HISTC_MEM_SNOOP,
52 	HISTC_MEM_DCACHELINE,
53 	HISTC_MEM_IADDR_SYMBOL,
54 	HISTC_TRANSACTION,
55 	HISTC_CYCLES,
56 	HISTC_SRCLINE_FROM,
57 	HISTC_SRCLINE_TO,
58 	HISTC_TRACE,
59 	HISTC_NR_COLS, /* Last entry */
60 };
61 
62 struct thread;
63 struct dso;
64 
65 struct hists {
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;
70 	u64			nr_entries;
71 	u64			nr_non_filtered_entries;
72 	u64			callchain_period;
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;
78 	pthread_mutex_t		lock;
79 	struct events_stats	stats;
80 	u64			event_stream;
81 	u16			col_len[HISTC_NR_COLS];
82 	int			socket_filter;
83 	struct perf_hpp_list	*hpp_list;
84 	struct list_head	hpp_formats;
85 	int			nr_hpp_node;
86 };
87 
88 #define hists__has(__h, __f) (__h)->hpp_list->__f
89 
90 struct hist_entry_iter;
91 
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 *);
98 };
99 
100 struct hist_entry_iter {
101 	int total;
102 	int curr;
103 
104 	bool hide_unresolved;
105 	int max_stack;
106 
107 	struct perf_evsel *evsel;
108 	struct perf_sample *sample;
109 	struct hist_entry *he;
110 	struct symbol *parent;
111 	void *priv;
112 
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);
117 };
118 
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;
123 
124 struct hist_entry *hists__add_entry(struct hists *hists,
125 				    struct addr_location *al,
126 				    struct symbol *parent,
127 				    struct branch_info *bi,
128 				    struct mem_info *mi,
129 				    struct perf_sample *sample,
130 				    bool sample_self);
131 
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,
137 					struct mem_info *mi,
138 					struct perf_sample *sample,
139 					bool sample_self);
140 
141 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
142 			 int max_stack_depth, void *arg);
143 
144 struct perf_hpp;
145 struct perf_hpp_fmt;
146 
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);
155 
156 typedef int (*hists__resort_cb_t)(struct hist_entry *he);
157 
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);
163 
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);
167 
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);
175 
176 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
177 		      int max_cols, float min_pcnt, FILE *fp,
178 		      bool use_callchain);
179 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
180 
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);
185 
186 static inline bool hists__has_filter(struct hists *hists)
187 {
188 	return hists->thread_filter || hists->dso_filter ||
189 		hists->symbol_filter_str || (hists->socket_filter > -1);
190 }
191 
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);
197 
198 void hists__match(struct hists *leader, struct hists *other);
199 int hists__link(struct hists *leader, struct hists *other);
200 
201 struct hists_evsel {
202 	struct perf_evsel evsel;
203 	struct hists	  hists;
204 };
205 
206 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
207 {
208 	struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
209 	return &hevsel->evsel;
210 }
211 
212 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
213 {
214 	struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
215 	return &hevsel->hists;
216 }
217 
218 int hists__init(void);
219 int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
220 
221 struct rb_root *hists__get_rotate_entries_in(struct hists *hists);
222 
223 struct perf_hpp {
224 	char *buf;
225 	size_t size;
226 	const char *sep;
227 	void *ptr;
228 };
229 
230 struct perf_hpp_fmt {
231 	const char *name;
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);
248 
249 	struct list_head list;
250 	struct list_head sort_list;
251 	bool elide;
252 	int len;
253 	int user_len;
254 	int idx;
255 	int level;
256 };
257 
258 struct perf_hpp_list {
259 	struct list_head fields;
260 	struct list_head sorts;
261 
262 	int nr_header_lines;
263 	int need_collapse;
264 	int parent;
265 	int sym;
266 	int dso;
267 	int socket;
268 	int thread;
269 	int comm;
270 };
271 
272 extern struct perf_hpp_list perf_hpp_list;
273 
274 struct perf_hpp_list_node {
275 	struct list_head	list;
276 	struct perf_hpp_list	hpp;
277 	int			level;
278 	bool			skip;
279 };
280 
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);
285 
286 static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
287 {
288 	perf_hpp_list__column_register(&perf_hpp_list, format);
289 }
290 
291 static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
292 {
293 	perf_hpp_list__register_sort_field(&perf_hpp_list, format);
294 }
295 
296 #define perf_hpp_list__for_each_format(_list, format) \
297 	list_for_each_entry(format, &(_list)->fields, list)
298 
299 #define perf_hpp_list__for_each_format_safe(_list, format, tmp)	\
300 	list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
301 
302 #define perf_hpp_list__for_each_sort_list(_list, format) \
303 	list_for_each_entry(format, &(_list)->sorts, sort_list)
304 
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)
307 
308 #define hists__for_each_format(hists, format) \
309 	perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
310 
311 #define hists__for_each_sort_list(hists, format) \
312 	perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
313 
314 extern struct perf_hpp_fmt perf_hpp__format[];
315 
316 enum {
317 	/* Matches perf_hpp__format array. */
318 	PERF_HPP__OVERHEAD,
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,
324 	PERF_HPP__SAMPLES,
325 	PERF_HPP__PERIOD,
326 
327 	PERF_HPP__MAX_INDEX
328 };
329 
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);
338 
339 
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);
350 
351 struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
352 
353 int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
354 
355 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
356 					 struct hists *hists)
357 {
358 	if (format->elide)
359 		return true;
360 
361 	if (perf_hpp__is_dynamic_entry(format) &&
362 	    !perf_hpp__defined_dynamic_entry(format, hists))
363 		return true;
364 
365 	return false;
366 }
367 
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);
372 
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, ...);
376 
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);
383 
384 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
385 {
386 	hpp->buf  += inc;
387 	hpp->size -= inc;
388 }
389 
390 static inline size_t perf_hpp__use_color(void)
391 {
392 	return !symbol_conf.field_sep;
393 }
394 
395 static inline size_t perf_hpp__color_overhead(void)
396 {
397 	return perf_hpp__use_color() ?
398 	       (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
399 	       : 0;
400 }
401 
402 struct perf_evlist;
403 
404 struct hist_browser_timer {
405 	void (*timer)(void *arg);
406 	void *arg;
407 	int refresh;
408 };
409 
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);
414 
415 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
416 			     struct hist_browser_timer *hbt);
417 
418 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
419 				  struct hist_browser_timer *hbt,
420 				  float min_pcnt,
421 				  struct perf_env *env);
422 int script_browse(const char *script_opt);
423 #else
424 static inline
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)
430 {
431 	return 0;
432 }
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)
436 {
437 	return 0;
438 }
439 
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)
443 {
444 	return 0;
445 }
446 
447 static inline int script_browse(const char *script_opt __maybe_unused)
448 {
449 	return 0;
450 }
451 
452 #define K_LEFT  -1000
453 #define K_RIGHT -2000
454 #define K_SWITCH_INPUT_DATA -3000
455 #endif
456 
457 unsigned int hists__sort_list_width(struct hists *hists);
458 unsigned int hists__overhead_width(struct hists *hists);
459 
460 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
461 			  struct perf_sample *sample, bool nonany_branch_mode);
462 
463 struct option;
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);
466 
467 void perf_hpp_list__init(struct perf_hpp_list *list);
468 
469 enum hierarchy_move_dir {
470 	HMD_NORMAL,
471 	HMD_FORCE_SIBLING,
472 	HMD_FORCE_CHILD,
473 };
474 
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);
479 
480 static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
481 {
482 	return __rb_hierarchy_next(node, HMD_NORMAL);
483 }
484 
485 #define HIERARCHY_INDENT  3
486 
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);
493 
494 #endif	/* __PERF_HIST_H */
495