]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/util/hist.h
perf tools: Save column length in perf_hpp_fmt
[mirror_ubuntu-hirsute-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
3d1d07ec 11extern struct callchain_param callchain_param;
3d1d07ec 12
4e4f06e4
ACM
13struct hist_entry;
14struct addr_location;
15struct symbol;
ef7b93a1 16
b3cef7f6
NK
17enum hist_filter {
18 HIST_FILTER__DSO,
19 HIST_FILTER__THREAD,
20 HIST_FILTER__PARENT,
21 HIST_FILTER__SYMBOL,
22 HIST_FILTER__GUEST,
23 HIST_FILTER__HOST,
24};
25
cee75ac7
ACM
26/*
27 * The kernel collects the number of events it couldn't send in a stretch and
28 * when possible sends this number in a PERF_RECORD_LOST event. The number of
29 * such "chunks" of lost events is stored in .nr_events[PERF_EVENT_LOST] while
30 * total_lost tells exactly how many events the kernel in fact lost, i.e. it is
31 * the sum of all struct lost_event.lost fields reported.
32 *
33 * The total_period is needed because by default auto-freq is used, so
34 * multipling nr_events[PERF_EVENT_SAMPLE] by a frequency isn't possible to get
35 * the total number of low level events, it is necessary to to sum all struct
36 * sample_event.period and stash the result in total_period.
37 */
1c02c4d2 38struct events_stats {
cee75ac7 39 u64 total_period;
1ab1fa5d 40 u64 total_non_filtered_period;
cee75ac7 41 u64 total_lost;
640c03ce 42 u64 total_invalid_chains;
c8446b9b 43 u32 nr_events[PERF_RECORD_HEADER_MAX];
1ab1fa5d 44 u32 nr_non_filtered_samples;
7b27509f 45 u32 nr_lost_warned;
c8446b9b 46 u32 nr_unknown_events;
640c03ce 47 u32 nr_invalid_chains;
9e69c210 48 u32 nr_unknown_id;
0c095715 49 u32 nr_unprocessable_samples;
1c02c4d2
ACM
50};
51
8a6c5b26
ACM
52enum hist_column {
53 HISTC_SYMBOL,
54 HISTC_DSO,
55 HISTC_THREAD,
56 HISTC_COMM,
57 HISTC_PARENT,
58 HISTC_CPU,
dfd3b2fd 59 HISTC_SRCLINE,
b5387528 60 HISTC_MISPREDICT,
f5d05bce
AK
61 HISTC_IN_TX,
62 HISTC_ABORT,
b5387528
RAV
63 HISTC_SYMBOL_FROM,
64 HISTC_SYMBOL_TO,
65 HISTC_DSO_FROM,
66 HISTC_DSO_TO,
05484298
AK
67 HISTC_LOCAL_WEIGHT,
68 HISTC_GLOBAL_WEIGHT,
98a3b32c
SE
69 HISTC_MEM_DADDR_SYMBOL,
70 HISTC_MEM_DADDR_DSO,
71 HISTC_MEM_LOCKED,
72 HISTC_MEM_TLB,
73 HISTC_MEM_LVL,
74 HISTC_MEM_SNOOP,
9b32ba71 75 HISTC_MEM_DCACHELINE,
475eeab9 76 HISTC_TRANSACTION,
8a6c5b26
ACM
77 HISTC_NR_COLS, /* Last entry */
78};
79
d7b76f09
ACM
80struct thread;
81struct dso;
82
1c02c4d2 83struct hists {
1980c2eb
ACM
84 struct rb_root entries_in_array[2];
85 struct rb_root *entries_in;
1c02c4d2 86 struct rb_root entries;
1980c2eb 87 struct rb_root entries_collapsed;
fefb0b94 88 u64 nr_entries;
1ab1fa5d 89 u64 nr_non_filtered_entries;
d7b76f09
ACM
90 const struct thread *thread_filter;
91 const struct dso *dso_filter;
0d37aa34 92 const char *uid_filter_str;
e94d53eb 93 const char *symbol_filter_str;
1980c2eb 94 pthread_mutex_t lock;
1c02c4d2 95 struct events_stats stats;
1c02c4d2 96 u64 event_stream;
8a6c5b26 97 u16 col_len[HISTC_NR_COLS];
1c02c4d2
ACM
98};
99
69bcb019
NK
100struct hist_entry_iter;
101
102struct hist_iter_ops {
103 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
104 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
105 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
106 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
107 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
108};
109
110struct hist_entry_iter {
111 int total;
112 int curr;
113
114 bool hide_unresolved;
115
116 struct perf_evsel *evsel;
117 struct perf_sample *sample;
118 struct hist_entry *he;
119 struct symbol *parent;
120 void *priv;
121
122 const struct hist_iter_ops *ops;
9d3c02d7
NK
123 /* user-defined callback function (optional) */
124 int (*add_entry_cb)(struct hist_entry_iter *iter,
125 struct addr_location *al, bool single, void *arg);
69bcb019
NK
126};
127
128extern const struct hist_iter_ops hist_iter_normal;
129extern const struct hist_iter_ops hist_iter_branch;
130extern const struct hist_iter_ops hist_iter_mem;
7a13aa28 131extern const struct hist_iter_ops hist_iter_cumulative;
69bcb019 132
316c7136 133struct hist_entry *__hists__add_entry(struct hists *hists,
1c02c4d2 134 struct addr_location *al,
41a4e6e2
NK
135 struct symbol *parent,
136 struct branch_info *bi,
137 struct mem_info *mi, u64 period,
a0b51af3
NK
138 u64 weight, u64 transaction,
139 bool sample_self);
69bcb019
NK
140int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
141 struct perf_evsel *evsel, struct perf_sample *sample,
9d3c02d7 142 int max_stack_depth, void *arg);
69bcb019 143
12c14278
ACM
144int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
145int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
475eeab9 146int hist_entry__transaction_len(void);
316c7136 147int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
000078bc 148 struct hists *hists);
4e4f06e4
ACM
149void hist_entry__free(struct hist_entry *);
150
316c7136
ACM
151void hists__output_resort(struct hists *hists);
152void hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
c8446b9b 153
b079d4e9 154void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
ab81f3fd
ACM
155void hists__output_recalc_col_len(struct hists *hists, int max_rows);
156
f2148330 157u64 hists__total_period(struct hists *hists);
9283ba9b 158void hists__reset_stats(struct hists *hists);
6263835a 159void hists__inc_stats(struct hists *hists, struct hist_entry *h);
316c7136 160void hists__inc_nr_events(struct hists *hists, u32 type);
1844dbcb 161void hists__inc_nr_samples(struct hists *hists, bool filtered);
28a6b6aa 162void events_stats__inc(struct events_stats *stats, u32 type);
52168eea 163size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
c8446b9b 164
316c7136 165size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
064f1981 166 int max_cols, float min_pcnt, FILE *fp);
b09e0190 167
d7b76f09
ACM
168void hists__filter_by_dso(struct hists *hists);
169void hists__filter_by_thread(struct hists *hists);
e94d53eb 170void hists__filter_by_symbol(struct hists *hists);
b09e0190 171
268397cb
NK
172static inline bool hists__has_filter(struct hists *hists)
173{
174 return hists->thread_filter || hists->dso_filter ||
175 hists->symbol_filter_str;
176}
177
316c7136
ACM
178u16 hists__col_len(struct hists *hists, enum hist_column col);
179void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
180bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
7ccf4f90
NK
181void hists__reset_col_len(struct hists *hists);
182void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
8a6c5b26 183
95529be4 184void hists__match(struct hists *leader, struct hists *other);
494d70a1 185int hists__link(struct hists *leader, struct hists *other);
95529be4 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 {
94a0793d
NK
195 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
196 struct perf_evsel *evsel);
197 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
198 struct perf_evsel *evsel);
2c5d4b4a
JO
199 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
200 struct hist_entry *he);
201 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
202 struct hist_entry *he);
bc18b7f2
NK
203 int64_t (*cmp)(struct hist_entry *a, struct hist_entry *b);
204 int64_t (*collapse)(struct hist_entry *a, struct hist_entry *b);
205 int64_t (*sort)(struct hist_entry *a, struct hist_entry *b);
1240005e
JO
206
207 struct list_head list;
8b536999 208 struct list_head sort_list;
f2998422 209 bool elide;
e0d66c74 210 int 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);
ea251d51 266
2f6d9009
NK
267typedef u64 (*hpp_field_fn)(struct hist_entry *he);
268typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
a0088adc 269typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
4a62109f
NK
270
271int __hpp__fmt(struct perf_hpp *hpp, struct hist_entry *he,
d675107c 272 hpp_field_fn get_field, const char *fmt, int len,
fb821c9e 273 hpp_snprint_fn print_fn, bool fmt_percent);
594dcbf3 274int __hpp__fmt_acc(struct perf_hpp *hpp, struct hist_entry *he,
d675107c 275 hpp_field_fn get_field, const char *fmt, int len,
594dcbf3 276 hpp_snprint_fn print_fn, bool fmt_percent);
4a62109f 277
a0088adc
NK
278static inline void advance_hpp(struct perf_hpp *hpp, int inc)
279{
280 hpp->buf += inc;
281 hpp->size -= inc;
282}
283
9754c4f9
JO
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
e248de33
ACM
296struct perf_evlist;
297
9783adf7
NK
298struct hist_browser_timer {
299 void (*timer)(void *arg);
300 void *arg;
301 int refresh;
302};
303
89fe808a 304#ifdef HAVE_SLANG_SUPPORT
1254b51e 305#include "../ui/keysyms.h"
db8fd07a 306int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
9783adf7 307 struct hist_browser_timer *hbt);
1254b51e
NK
308
309int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
68d80758 310 struct hist_browser_timer *hbt,
064f1981 311 float min_pcnt,
68d80758 312 struct perf_session_env *env);
66517826 313int script_browse(const char *script_opt);
1254b51e 314#else
7f0030b2 315static inline
1d037ca1
IT
316int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
317 const char *help __maybe_unused,
68d80758 318 struct hist_browser_timer *hbt __maybe_unused,
064f1981 319 float min_pcnt __maybe_unused,
68d80758 320 struct perf_session_env *env __maybe_unused)
d67f088e
ACM
321{
322 return 0;
323}
324
316c7136
ACM
325static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
326 struct perf_evsel *evsel __maybe_unused,
327 struct hist_browser_timer *hbt __maybe_unused)
46e3e055
ACM
328{
329 return 0;
330}
66517826 331
4f746c95 332static inline int script_browse(const char *script_opt __maybe_unused)
66517826
FT
333{
334 return 0;
335}
336
1e825efb
ME
337#define K_LEFT -1000
338#define K_RIGHT -2000
5f7439e0 339#define K_SWITCH_INPUT_DATA -3000
b09e0190 340#endif
06daaaba 341
316c7136 342unsigned int hists__sort_list_width(struct hists *hists);
33db4568
NK
343
344struct option;
345int parse_filter_percentage(const struct option *opt __maybe_unused,
346 const char *arg, int unset __maybe_unused);
0b93da17 347int perf_hist_config(const char *var, const char *value);
33db4568 348
3d1d07ec 349#endif /* __PERF_HIST_H */