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