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