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