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