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