xref: /linux/tools/perf/util/hist.h (revision 64af4e0da419ef9e9db0d34a3b5836adbf90a5e8)
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 	struct thread		*thread_filter;
70 	const struct dso	*dso_filter;
71 	const char		*uid_filter_str;
72 	const char		*symbol_filter_str;
73 	pthread_mutex_t		lock;
74 	struct events_stats	stats;
75 	u64			event_stream;
76 	u16			col_len[HISTC_NR_COLS];
77 	int			socket_filter;
78 };
79 
80 struct hist_entry_iter;
81 
82 struct hist_iter_ops {
83 	int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
84 	int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
85 	int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
86 	int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
87 	int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
88 };
89 
90 struct hist_entry_iter {
91 	int total;
92 	int curr;
93 
94 	bool hide_unresolved;
95 	int max_stack;
96 
97 	struct perf_evsel *evsel;
98 	struct perf_sample *sample;
99 	struct hist_entry *he;
100 	struct symbol *parent;
101 	void *priv;
102 
103 	const struct hist_iter_ops *ops;
104 	/* user-defined callback function (optional) */
105 	int (*add_entry_cb)(struct hist_entry_iter *iter,
106 			    struct addr_location *al, bool single, void *arg);
107 };
108 
109 extern const struct hist_iter_ops hist_iter_normal;
110 extern const struct hist_iter_ops hist_iter_branch;
111 extern const struct hist_iter_ops hist_iter_mem;
112 extern const struct hist_iter_ops hist_iter_cumulative;
113 
114 struct hist_entry *__hists__add_entry(struct hists *hists,
115 				      struct addr_location *al,
116 				      struct symbol *parent,
117 				      struct branch_info *bi,
118 				      struct mem_info *mi,
119 				      struct perf_sample *sample,
120 				      bool sample_self);
121 int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
122 			 int max_stack_depth, void *arg);
123 
124 int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
125 int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
126 int hist_entry__transaction_len(void);
127 int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
128 			      struct hists *hists);
129 void hist_entry__delete(struct hist_entry *he);
130 
131 void hists__output_resort(struct hists *hists, struct ui_progress *prog);
132 void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
133 
134 void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
135 void hists__delete_entries(struct hists *hists);
136 void hists__output_recalc_col_len(struct hists *hists, int max_rows);
137 
138 u64 hists__total_period(struct hists *hists);
139 void hists__reset_stats(struct hists *hists);
140 void hists__inc_stats(struct hists *hists, struct hist_entry *h);
141 void hists__inc_nr_events(struct hists *hists, u32 type);
142 void hists__inc_nr_samples(struct hists *hists, bool filtered);
143 void events_stats__inc(struct events_stats *stats, u32 type);
144 size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
145 
146 size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
147 		      int max_cols, float min_pcnt, FILE *fp);
148 size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
149 
150 void hists__filter_by_dso(struct hists *hists);
151 void hists__filter_by_thread(struct hists *hists);
152 void hists__filter_by_symbol(struct hists *hists);
153 void hists__filter_by_socket(struct hists *hists);
154 
155 static inline bool hists__has_filter(struct hists *hists)
156 {
157 	return hists->thread_filter || hists->dso_filter ||
158 		hists->symbol_filter_str || (hists->socket_filter > -1);
159 }
160 
161 u16 hists__col_len(struct hists *hists, enum hist_column col);
162 void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
163 bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
164 void hists__reset_col_len(struct hists *hists);
165 void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
166 
167 void hists__match(struct hists *leader, struct hists *other);
168 int hists__link(struct hists *leader, struct hists *other);
169 
170 struct hists_evsel {
171 	struct perf_evsel evsel;
172 	struct hists	  hists;
173 };
174 
175 static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
176 {
177 	struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
178 	return &hevsel->evsel;
179 }
180 
181 static inline struct hists *evsel__hists(struct perf_evsel *evsel)
182 {
183 	struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
184 	return &hevsel->hists;
185 }
186 
187 int hists__init(void);
188 
189 struct perf_hpp {
190 	char *buf;
191 	size_t size;
192 	const char *sep;
193 	void *ptr;
194 };
195 
196 struct perf_hpp_fmt {
197 	const char *name;
198 	int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
199 		      struct perf_evsel *evsel);
200 	int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
201 		     struct perf_evsel *evsel);
202 	int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
203 		     struct hist_entry *he);
204 	int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
205 		     struct hist_entry *he);
206 	int64_t (*cmp)(struct perf_hpp_fmt *fmt,
207 		       struct hist_entry *a, struct hist_entry *b);
208 	int64_t (*collapse)(struct perf_hpp_fmt *fmt,
209 			    struct hist_entry *a, struct hist_entry *b);
210 	int64_t (*sort)(struct perf_hpp_fmt *fmt,
211 			struct hist_entry *a, struct hist_entry *b);
212 
213 	struct list_head list;
214 	struct list_head sort_list;
215 	bool elide;
216 	int len;
217 	int user_len;
218 };
219 
220 extern struct list_head perf_hpp__list;
221 extern struct list_head perf_hpp__sort_list;
222 
223 #define perf_hpp__for_each_format(format) \
224 	list_for_each_entry(format, &perf_hpp__list, list)
225 
226 #define perf_hpp__for_each_format_safe(format, tmp)	\
227 	list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
228 
229 #define perf_hpp__for_each_sort_list(format) \
230 	list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
231 
232 #define perf_hpp__for_each_sort_list_safe(format, tmp)	\
233 	list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
234 
235 extern struct perf_hpp_fmt perf_hpp__format[];
236 
237 enum {
238 	/* Matches perf_hpp__format array. */
239 	PERF_HPP__OVERHEAD,
240 	PERF_HPP__OVERHEAD_SYS,
241 	PERF_HPP__OVERHEAD_US,
242 	PERF_HPP__OVERHEAD_GUEST_SYS,
243 	PERF_HPP__OVERHEAD_GUEST_US,
244 	PERF_HPP__OVERHEAD_ACC,
245 	PERF_HPP__SAMPLES,
246 	PERF_HPP__PERIOD,
247 
248 	PERF_HPP__MAX_INDEX
249 };
250 
251 void perf_hpp__init(void);
252 void perf_hpp__column_register(struct perf_hpp_fmt *format);
253 void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
254 void perf_hpp__column_enable(unsigned col);
255 void perf_hpp__column_disable(unsigned col);
256 void perf_hpp__cancel_cumulate(void);
257 
258 void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
259 void perf_hpp__setup_output_field(void);
260 void perf_hpp__reset_output_field(void);
261 void perf_hpp__append_sort_keys(void);
262 
263 bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
264 bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
265 bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
266 bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
267 
268 static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
269 					 struct hists *hists)
270 {
271 	if (format->elide)
272 		return true;
273 
274 	if (perf_hpp__is_dynamic_entry(format) &&
275 	    !perf_hpp__defined_dynamic_entry(format, hists))
276 		return true;
277 
278 	return false;
279 }
280 
281 void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
282 void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
283 void perf_hpp__set_user_width(const char *width_list_str);
284 
285 typedef u64 (*hpp_field_fn)(struct hist_entry *he);
286 typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
287 typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
288 
289 int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
290 	     struct hist_entry *he, hpp_field_fn get_field,
291 	     const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
292 int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
293 		 struct hist_entry *he, hpp_field_fn get_field,
294 		 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
295 
296 static inline void advance_hpp(struct perf_hpp *hpp, int inc)
297 {
298 	hpp->buf  += inc;
299 	hpp->size -= inc;
300 }
301 
302 static inline size_t perf_hpp__use_color(void)
303 {
304 	return !symbol_conf.field_sep;
305 }
306 
307 static inline size_t perf_hpp__color_overhead(void)
308 {
309 	return perf_hpp__use_color() ?
310 	       (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
311 	       : 0;
312 }
313 
314 struct perf_evlist;
315 
316 struct hist_browser_timer {
317 	void (*timer)(void *arg);
318 	void *arg;
319 	int refresh;
320 };
321 
322 #ifdef HAVE_SLANG_SUPPORT
323 #include "../ui/keysyms.h"
324 int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
325 			     struct hist_browser_timer *hbt);
326 
327 int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
328 			     struct hist_browser_timer *hbt);
329 
330 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
331 				  struct hist_browser_timer *hbt,
332 				  float min_pcnt,
333 				  struct perf_env *env);
334 int script_browse(const char *script_opt);
335 #else
336 static inline
337 int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
338 				  const char *help __maybe_unused,
339 				  struct hist_browser_timer *hbt __maybe_unused,
340 				  float min_pcnt __maybe_unused,
341 				  struct perf_env *env __maybe_unused)
342 {
343 	return 0;
344 }
345 static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
346 					   struct perf_evsel *evsel __maybe_unused,
347 					   struct hist_browser_timer *hbt __maybe_unused)
348 {
349 	return 0;
350 }
351 
352 static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
353 					   struct perf_evsel *evsel __maybe_unused,
354 					   struct hist_browser_timer *hbt __maybe_unused)
355 {
356 	return 0;
357 }
358 
359 static inline int script_browse(const char *script_opt __maybe_unused)
360 {
361 	return 0;
362 }
363 
364 #define K_LEFT  -1000
365 #define K_RIGHT -2000
366 #define K_SWITCH_INPUT_DATA -3000
367 #endif
368 
369 unsigned int hists__sort_list_width(struct hists *hists);
370 
371 void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
372 			  struct perf_sample *sample, bool nonany_branch_mode);
373 
374 struct option;
375 int parse_filter_percentage(const struct option *opt __maybe_unused,
376 			    const char *arg, int unset __maybe_unused);
377 int perf_hist_config(const char *var, const char *value);
378 
379 #endif	/* __PERF_HIST_H */
380