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