]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - tools/perf/util/hist.h
perf tests: Add parsing test for 'P' modifier
[mirror_ubuntu-bionic-kernel.git] / tools / perf / util / hist.h
CommitLineData
3d1d07ec
JK
1#ifndef __PERF_HIST_H
2#define __PERF_HIST_H
3d1d07ec 3
4e4f06e4 4#include <linux/types.h>
1980c2eb 5#include <pthread.h>
3d1d07ec 6#include "callchain.h"
a635fc51 7#include "evsel.h"
68d80758 8#include "header.h"
9754c4f9 9#include "color.h"
c1fb5651 10#include "ui/progress.h"
3d1d07ec 11
4e4f06e4
ACM
12struct hist_entry;
13struct addr_location;
14struct symbol;
ef7b93a1 15
b3cef7f6
NK
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,
21394d94 23 HIST_FILTER__SOCKET,
b3cef7f6
NK
24};
25
8a6c5b26
ACM
26enum hist_column {
27 HISTC_SYMBOL,
28 HISTC_DSO,
29 HISTC_THREAD,
30 HISTC_COMM,
31 HISTC_PARENT,
32 HISTC_CPU,
2e7ea3ab 33 HISTC_SOCKET,
dfd3b2fd 34 HISTC_SRCLINE,
31191a85 35 HISTC_SRCFILE,
b5387528 36 HISTC_MISPREDICT,
f5d05bce
AK
37 HISTC_IN_TX,
38 HISTC_ABORT,
b5387528
RAV
39 HISTC_SYMBOL_FROM,
40 HISTC_SYMBOL_TO,
41 HISTC_DSO_FROM,
42 HISTC_DSO_TO,
05484298
AK
43 HISTC_LOCAL_WEIGHT,
44 HISTC_GLOBAL_WEIGHT,
98a3b32c
SE
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,
9b32ba71 51 HISTC_MEM_DCACHELINE,
475eeab9 52 HISTC_TRANSACTION,
0e332f03 53 HISTC_CYCLES,
8a6c5b26
ACM
54 HISTC_NR_COLS, /* Last entry */
55};
56
d7b76f09
ACM
57struct thread;
58struct dso;
59
1c02c4d2 60struct hists {
1980c2eb
ACM
61 struct rb_root entries_in_array[2];
62 struct rb_root *entries_in;
1c02c4d2 63 struct rb_root entries;
1980c2eb 64 struct rb_root entries_collapsed;
fefb0b94 65 u64 nr_entries;
1ab1fa5d 66 u64 nr_non_filtered_entries;
f3b623b8 67 struct thread *thread_filter;
d7b76f09 68 const struct dso *dso_filter;
0d37aa34 69 const char *uid_filter_str;
e94d53eb 70 const char *symbol_filter_str;
1980c2eb 71 pthread_mutex_t lock;
1c02c4d2 72 struct events_stats stats;
1c02c4d2 73 u64 event_stream;
8a6c5b26 74 u16 col_len[HISTC_NR_COLS];
21394d94 75 int socket_filter;
1c02c4d2
ACM
76};
77
69bcb019
NK
78struct hist_entry_iter;
79
80struct hist_iter_ops {
81 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
82 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
83 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
84 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
85 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
86};
87
88struct hist_entry_iter {
89 int total;
90 int curr;
91
92 bool hide_unresolved;
96b40f3c 93 int max_stack;
69bcb019
NK
94
95 struct perf_evsel *evsel;
96 struct perf_sample *sample;
97 struct hist_entry *he;
98 struct symbol *parent;
99 void *priv;
100
101 const struct hist_iter_ops *ops;
9d3c02d7
NK
102 /* user-defined callback function (optional) */
103 int (*add_entry_cb)(struct hist_entry_iter *iter,
104 struct addr_location *al, bool single, void *arg);
69bcb019
NK
105};
106
107extern const struct hist_iter_ops hist_iter_normal;
108extern const struct hist_iter_ops hist_iter_branch;
109extern const struct hist_iter_ops hist_iter_mem;
7a13aa28 110extern const struct hist_iter_ops hist_iter_cumulative;
69bcb019 111
316c7136 112struct hist_entry *__hists__add_entry(struct hists *hists,
1c02c4d2 113 struct addr_location *al,
41a4e6e2
NK
114 struct symbol *parent,
115 struct branch_info *bi,
116 struct mem_info *mi, u64 period,
a0b51af3
NK
117 u64 weight, u64 transaction,
118 bool sample_self);
69bcb019 119int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
9d3c02d7 120 int max_stack_depth, void *arg);
69bcb019 121
12c14278
ACM
122int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
123int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
475eeab9 124int hist_entry__transaction_len(void);
316c7136 125int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
000078bc 126 struct hists *hists);
6733d1bf 127void hist_entry__delete(struct hist_entry *he);
4e4f06e4 128
740b97f9 129void hists__output_resort(struct hists *hists, struct ui_progress *prog);
316c7136 130void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
c8446b9b 131
b079d4e9 132void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
701937bd 133void hists__delete_entries(struct hists *hists);
ab81f3fd
ACM
134void hists__output_recalc_col_len(struct hists *hists, int max_rows);
135
f2148330 136u64 hists__total_period(struct hists *hists);
9283ba9b 137void hists__reset_stats(struct hists *hists);
6263835a 138void hists__inc_stats(struct hists *hists, struct hist_entry *h);
316c7136 139void hists__inc_nr_events(struct hists *hists, u32 type);
1844dbcb 140void hists__inc_nr_samples(struct hists *hists, bool filtered);
28a6b6aa 141void events_stats__inc(struct events_stats *stats, u32 type);
52168eea 142size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
c8446b9b 143
316c7136 144size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
064f1981 145 int max_cols, float min_pcnt, FILE *fp);
2a1731fb 146size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
b09e0190 147
d7b76f09
ACM
148void hists__filter_by_dso(struct hists *hists);
149void hists__filter_by_thread(struct hists *hists);
e94d53eb 150void hists__filter_by_symbol(struct hists *hists);
84734b06 151void hists__filter_by_socket(struct hists *hists);
b09e0190 152
268397cb
NK
153static inline bool hists__has_filter(struct hists *hists)
154{
155 return hists->thread_filter || hists->dso_filter ||
21394d94 156 hists->symbol_filter_str || (hists->socket_filter > -1);
268397cb
NK
157}
158
316c7136
ACM
159u16 hists__col_len(struct hists *hists, enum hist_column col);
160void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
161bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
7ccf4f90
NK
162void hists__reset_col_len(struct hists *hists);
163void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
8a6c5b26 164
95529be4 165void hists__match(struct hists *leader, struct hists *other);
494d70a1 166int hists__link(struct hists *leader, struct hists *other);
95529be4 167
a635fc51
ACM
168struct hists_evsel {
169 struct perf_evsel evsel;
170 struct hists hists;
171};
172
173static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
174{
175 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
176 return &hevsel->evsel;
177}
178
179static inline struct hists *evsel__hists(struct perf_evsel *evsel)
180{
181 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
182 return &hevsel->hists;
183}
184
185int hists__init(void);
186
ea251d51
NK
187struct perf_hpp {
188 char *buf;
189 size_t size;
ea251d51 190 const char *sep;
ea251d51
NK
191 void *ptr;
192};
193
194struct perf_hpp_fmt {
1ecd4453 195 const char *name;
94a0793d
NK
196 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
197 struct perf_evsel *evsel);
198 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
199 struct perf_evsel *evsel);
2c5d4b4a
JO
200 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
201 struct hist_entry *he);
202 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
203 struct hist_entry *he);
87bbdf76
NK
204 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
205 struct hist_entry *a, struct hist_entry *b);
206 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
207 struct hist_entry *a, struct hist_entry *b);
208 int64_t (*sort)(struct perf_hpp_fmt *fmt,
209 struct hist_entry *a, struct hist_entry *b);
1240005e
JO
210
211 struct list_head list;
8b536999 212 struct list_head sort_list;
f2998422 213 bool elide;
e0d66c74 214 int len;
5b591669 215 int user_len;
ea251d51
NK
216};
217
1240005e 218extern struct list_head perf_hpp__list;
8b536999 219extern struct list_head perf_hpp__sort_list;
1240005e
JO
220
221#define perf_hpp__for_each_format(format) \
222 list_for_each_entry(format, &perf_hpp__list, list)
223
1c89fe9b
NK
224#define perf_hpp__for_each_format_safe(format, tmp) \
225 list_for_each_entry_safe(format, tmp, &perf_hpp__list, list)
226
8b536999
NK
227#define perf_hpp__for_each_sort_list(format) \
228 list_for_each_entry(format, &perf_hpp__sort_list, sort_list)
229
1c89fe9b
NK
230#define perf_hpp__for_each_sort_list_safe(format, tmp) \
231 list_for_each_entry_safe(format, tmp, &perf_hpp__sort_list, sort_list)
232
ea251d51
NK
233extern struct perf_hpp_fmt perf_hpp__format[];
234
235enum {
345dc0b4 236 /* Matches perf_hpp__format array. */
ea251d51
NK
237 PERF_HPP__OVERHEAD,
238 PERF_HPP__OVERHEAD_SYS,
239 PERF_HPP__OVERHEAD_US,
240 PERF_HPP__OVERHEAD_GUEST_SYS,
241 PERF_HPP__OVERHEAD_GUEST_US,
594dcbf3 242 PERF_HPP__OVERHEAD_ACC,
ea251d51
NK
243 PERF_HPP__SAMPLES,
244 PERF_HPP__PERIOD,
ea251d51
NK
245
246 PERF_HPP__MAX_INDEX
247};
248
1d77822e 249void perf_hpp__init(void);
1240005e 250void perf_hpp__column_register(struct perf_hpp_fmt *format);
77284de3 251void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
1240005e 252void perf_hpp__column_enable(unsigned col);
77284de3
NK
253void perf_hpp__column_disable(unsigned col);
254void perf_hpp__cancel_cumulate(void);
255
8b536999 256void perf_hpp__register_sort_field(struct perf_hpp_fmt *format);
26d8b338 257void perf_hpp__setup_output_field(void);
1c89fe9b 258void perf_hpp__reset_output_field(void);
a7d945bc
NK
259void perf_hpp__append_sort_keys(void);
260
261bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
262bool perf_hpp__same_sort_entry(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
f2998422
JO
263
264static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format)
265{
266 return format->elide;
267}
268
678a500d 269void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
e0d66c74 270void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
5b591669 271void perf_hpp__set_user_width(const char *width_list_str);
ea251d51 272
2f6d9009
NK
273typedef u64 (*hpp_field_fn)(struct hist_entry *he);
274typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
a0088adc 275typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
4a62109f 276
5b591669
NK
277int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
278 struct hist_entry *he, hpp_field_fn get_field,
279 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
280int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
281 struct hist_entry *he, hpp_field_fn get_field,
282 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
4a62109f 283
a0088adc
NK
284static inline void advance_hpp(struct perf_hpp *hpp, int inc)
285{
286 hpp->buf += inc;
287 hpp->size -= inc;
288}
289
9754c4f9
JO
290static inline size_t perf_hpp__use_color(void)
291{
292 return !symbol_conf.field_sep;
293}
294
295static inline size_t perf_hpp__color_overhead(void)
296{
297 return perf_hpp__use_color() ?
298 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
299 : 0;
300}
301
e248de33
ACM
302struct perf_evlist;
303
9783adf7
NK
304struct hist_browser_timer {
305 void (*timer)(void *arg);
306 void *arg;
307 int refresh;
308};
309
89fe808a 310#ifdef HAVE_SLANG_SUPPORT
1254b51e 311#include "../ui/keysyms.h"
d5dbc518
ACM
312int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
313 struct hist_browser_timer *hbt);
314
db8fd07a 315int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
9783adf7 316 struct hist_browser_timer *hbt);
1254b51e
NK
317
318int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
68d80758 319 struct hist_browser_timer *hbt,
064f1981 320 float min_pcnt,
ce80d3be 321 struct perf_env *env);
66517826 322int script_browse(const char *script_opt);
1254b51e 323#else
7f0030b2 324static inline
1d037ca1
IT
325int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
326 const char *help __maybe_unused,
68d80758 327 struct hist_browser_timer *hbt __maybe_unused,
064f1981 328 float min_pcnt __maybe_unused,
ce80d3be 329 struct perf_env *env __maybe_unused)
d67f088e
ACM
330{
331 return 0;
332}
d5dbc518
ACM
333static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
334 struct perf_evsel *evsel __maybe_unused,
335 struct hist_browser_timer *hbt __maybe_unused)
336{
337 return 0;
338}
d67f088e 339
316c7136
ACM
340static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
341 struct perf_evsel *evsel __maybe_unused,
342 struct hist_browser_timer *hbt __maybe_unused)
46e3e055
ACM
343{
344 return 0;
345}
66517826 346
4f746c95 347static inline int script_browse(const char *script_opt __maybe_unused)
66517826
FT
348{
349 return 0;
350}
351
1e825efb
ME
352#define K_LEFT -1000
353#define K_RIGHT -2000
5f7439e0 354#define K_SWITCH_INPUT_DATA -3000
b09e0190 355#endif
06daaaba 356
316c7136 357unsigned int hists__sort_list_width(struct hists *hists);
33db4568 358
57849998
AK
359void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
360 struct perf_sample *sample, bool nonany_branch_mode);
361
33db4568
NK
362struct option;
363int parse_filter_percentage(const struct option *opt __maybe_unused,
364 const char *arg, int unset __maybe_unused);
0b93da17 365int perf_hist_config(const char *var, const char *value);
33db4568 366
3d1d07ec 367#endif /* __PERF_HIST_H */