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