Merge remote-tracking branch 'asoc/topic/topology' into asoc-next
[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;
467ef10c
NK
69 u64 callchain_period;
70 u64 callchain_non_filtered_period;
f3b623b8 71 struct thread *thread_filter;
d7b76f09 72 const struct dso *dso_filter;
0d37aa34 73 const char *uid_filter_str;
e94d53eb 74 const char *symbol_filter_str;
1980c2eb 75 pthread_mutex_t lock;
1c02c4d2 76 struct events_stats stats;
1c02c4d2 77 u64 event_stream;
8a6c5b26 78 u16 col_len[HISTC_NR_COLS];
21394d94 79 int socket_filter;
5b65855e 80 struct perf_hpp_list *hpp_list;
c3bc0c43 81 struct list_head hpp_formats;
2dbbe9f2 82 int nr_hpp_node;
1c02c4d2
ACM
83};
84
69bcb019
NK
85struct hist_entry_iter;
86
87struct hist_iter_ops {
88 int (*prepare_entry)(struct hist_entry_iter *, struct addr_location *);
89 int (*add_single_entry)(struct hist_entry_iter *, struct addr_location *);
90 int (*next_entry)(struct hist_entry_iter *, struct addr_location *);
91 int (*add_next_entry)(struct hist_entry_iter *, struct addr_location *);
92 int (*finish_entry)(struct hist_entry_iter *, struct addr_location *);
93};
94
95struct hist_entry_iter {
96 int total;
97 int curr;
98
99 bool hide_unresolved;
96b40f3c 100 int max_stack;
69bcb019
NK
101
102 struct perf_evsel *evsel;
103 struct perf_sample *sample;
104 struct hist_entry *he;
105 struct symbol *parent;
106 void *priv;
107
108 const struct hist_iter_ops *ops;
9d3c02d7
NK
109 /* user-defined callback function (optional) */
110 int (*add_entry_cb)(struct hist_entry_iter *iter,
111 struct addr_location *al, bool single, void *arg);
69bcb019
NK
112};
113
114extern const struct hist_iter_ops hist_iter_normal;
115extern const struct hist_iter_ops hist_iter_branch;
116extern const struct hist_iter_ops hist_iter_mem;
7a13aa28 117extern const struct hist_iter_ops hist_iter_cumulative;
69bcb019 118
316c7136 119struct hist_entry *__hists__add_entry(struct hists *hists,
1c02c4d2 120 struct addr_location *al,
41a4e6e2
NK
121 struct symbol *parent,
122 struct branch_info *bi,
fd36f3dd
NK
123 struct mem_info *mi,
124 struct perf_sample *sample,
a0b51af3 125 bool sample_self);
69bcb019 126int hist_entry_iter__add(struct hist_entry_iter *iter, struct addr_location *al,
9d3c02d7 127 int max_stack_depth, void *arg);
69bcb019 128
89fee709
ACM
129struct perf_hpp;
130struct perf_hpp_fmt;
131
12c14278
ACM
132int64_t hist_entry__cmp(struct hist_entry *left, struct hist_entry *right);
133int64_t hist_entry__collapse(struct hist_entry *left, struct hist_entry *right);
475eeab9 134int hist_entry__transaction_len(void);
316c7136 135int hist_entry__sort_snprintf(struct hist_entry *he, char *bf, size_t size,
000078bc 136 struct hists *hists);
89fee709
ACM
137int hist_entry__snprintf_alignment(struct hist_entry *he, struct perf_hpp *hpp,
138 struct perf_hpp_fmt *fmt, int printed);
6733d1bf 139void hist_entry__delete(struct hist_entry *he);
4e4f06e4 140
452ce03b 141void perf_evsel__output_resort(struct perf_evsel *evsel, struct ui_progress *prog);
740b97f9 142void hists__output_resort(struct hists *hists, struct ui_progress *prog);
bba58cdf 143int hists__collapse_resort(struct hists *hists, struct ui_progress *prog);
c8446b9b 144
b079d4e9 145void hists__decay_entries(struct hists *hists, bool zap_user, bool zap_kernel);
701937bd 146void hists__delete_entries(struct hists *hists);
ab81f3fd
ACM
147void hists__output_recalc_col_len(struct hists *hists, int max_rows);
148
f2148330 149u64 hists__total_period(struct hists *hists);
9283ba9b 150void hists__reset_stats(struct hists *hists);
6263835a 151void hists__inc_stats(struct hists *hists, struct hist_entry *h);
316c7136 152void hists__inc_nr_events(struct hists *hists, u32 type);
1844dbcb 153void hists__inc_nr_samples(struct hists *hists, bool filtered);
28a6b6aa 154void events_stats__inc(struct events_stats *stats, u32 type);
52168eea 155size_t events_stats__fprintf(struct events_stats *stats, FILE *fp);
c8446b9b 156
316c7136 157size_t hists__fprintf(struct hists *hists, bool show_header, int max_rows,
064f1981 158 int max_cols, float min_pcnt, FILE *fp);
2a1731fb 159size_t perf_evlist__fprintf_nr_events(struct perf_evlist *evlist, FILE *fp);
b09e0190 160
d7b76f09
ACM
161void hists__filter_by_dso(struct hists *hists);
162void hists__filter_by_thread(struct hists *hists);
e94d53eb 163void hists__filter_by_symbol(struct hists *hists);
84734b06 164void hists__filter_by_socket(struct hists *hists);
b09e0190 165
268397cb
NK
166static inline bool hists__has_filter(struct hists *hists)
167{
168 return hists->thread_filter || hists->dso_filter ||
21394d94 169 hists->symbol_filter_str || (hists->socket_filter > -1);
268397cb
NK
170}
171
316c7136
ACM
172u16 hists__col_len(struct hists *hists, enum hist_column col);
173void hists__set_col_len(struct hists *hists, enum hist_column col, u16 len);
174bool hists__new_col_len(struct hists *hists, enum hist_column col, u16 len);
7ccf4f90
NK
175void hists__reset_col_len(struct hists *hists);
176void hists__calc_col_len(struct hists *hists, struct hist_entry *he);
8a6c5b26 177
95529be4 178void hists__match(struct hists *leader, struct hists *other);
494d70a1 179int hists__link(struct hists *leader, struct hists *other);
95529be4 180
a635fc51
ACM
181struct hists_evsel {
182 struct perf_evsel evsel;
183 struct hists hists;
184};
185
186static inline struct perf_evsel *hists_to_evsel(struct hists *hists)
187{
188 struct hists_evsel *hevsel = container_of(hists, struct hists_evsel, hists);
189 return &hevsel->evsel;
190}
191
192static inline struct hists *evsel__hists(struct perf_evsel *evsel)
193{
194 struct hists_evsel *hevsel = (struct hists_evsel *)evsel;
195 return &hevsel->hists;
196}
197
198int hists__init(void);
5b65855e 199int __hists__init(struct hists *hists, struct perf_hpp_list *hpp_list);
fc284be9
NK
200
201struct rb_root *hists__get_rotate_entries_in(struct hists *hists);
bba58cdf 202int hists__collapse_insert_entry(struct hists *hists,
fc284be9 203 struct rb_root *root, struct hist_entry *he);
a635fc51 204
ea251d51
NK
205struct perf_hpp {
206 char *buf;
207 size_t size;
ea251d51 208 const char *sep;
ea251d51
NK
209 void *ptr;
210};
211
212struct perf_hpp_fmt {
1ecd4453 213 const char *name;
94a0793d
NK
214 int (*header)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
215 struct perf_evsel *evsel);
216 int (*width)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
217 struct perf_evsel *evsel);
2c5d4b4a
JO
218 int (*color)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
219 struct hist_entry *he);
220 int (*entry)(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
221 struct hist_entry *he);
87bbdf76
NK
222 int64_t (*cmp)(struct perf_hpp_fmt *fmt,
223 struct hist_entry *a, struct hist_entry *b);
224 int64_t (*collapse)(struct perf_hpp_fmt *fmt,
225 struct hist_entry *a, struct hist_entry *b);
226 int64_t (*sort)(struct perf_hpp_fmt *fmt,
227 struct hist_entry *a, struct hist_entry *b);
97358084 228 bool (*equal)(struct perf_hpp_fmt *a, struct perf_hpp_fmt *b);
564132f3 229 void (*free)(struct perf_hpp_fmt *fmt);
1240005e
JO
230
231 struct list_head list;
8b536999 232 struct list_head sort_list;
f2998422 233 bool elide;
e0d66c74 234 int len;
5b591669 235 int user_len;
b21a763e 236 int idx;
4b633eba 237 int level;
ea251d51
NK
238};
239
7c31e102
JO
240struct perf_hpp_list {
241 struct list_head fields;
242 struct list_head sorts;
243};
244
245extern struct perf_hpp_list perf_hpp_list;
1240005e 246
c3bc0c43
NK
247struct perf_hpp_list_node {
248 struct list_head list;
249 struct perf_hpp_list hpp;
250 int level;
1b2dbbf4 251 bool skip;
c3bc0c43
NK
252};
253
ebdd98e0
JO
254void perf_hpp_list__column_register(struct perf_hpp_list *list,
255 struct perf_hpp_fmt *format);
256void perf_hpp_list__register_sort_field(struct perf_hpp_list *list,
257 struct perf_hpp_fmt *format);
258
259static inline void perf_hpp__column_register(struct perf_hpp_fmt *format)
260{
261 perf_hpp_list__column_register(&perf_hpp_list, format);
262}
263
264static inline void perf_hpp__register_sort_field(struct perf_hpp_fmt *format)
265{
266 perf_hpp_list__register_sort_field(&perf_hpp_list, format);
267}
268
cf094045
JO
269#define perf_hpp_list__for_each_format(_list, format) \
270 list_for_each_entry(format, &(_list)->fields, list)
1240005e 271
7a1799e0
JO
272#define perf_hpp_list__for_each_format_safe(_list, format, tmp) \
273 list_for_each_entry_safe(format, tmp, &(_list)->fields, list)
1c89fe9b 274
d29a4970
JO
275#define perf_hpp_list__for_each_sort_list(_list, format) \
276 list_for_each_entry(format, &(_list)->sorts, sort_list)
8b536999 277
1a8ebd24
JO
278#define perf_hpp_list__for_each_sort_list_safe(_list, format, tmp) \
279 list_for_each_entry_safe(format, tmp, &(_list)->sorts, sort_list)
1c89fe9b 280
f0786af5
JO
281#define hists__for_each_format(hists, format) \
282 perf_hpp_list__for_each_format((hists)->hpp_list, fmt)
283
aa6f50af
JO
284#define hists__for_each_sort_list(hists, format) \
285 perf_hpp_list__for_each_sort_list((hists)->hpp_list, fmt)
286
ea251d51
NK
287extern struct perf_hpp_fmt perf_hpp__format[];
288
289enum {
345dc0b4 290 /* Matches perf_hpp__format array. */
ea251d51
NK
291 PERF_HPP__OVERHEAD,
292 PERF_HPP__OVERHEAD_SYS,
293 PERF_HPP__OVERHEAD_US,
294 PERF_HPP__OVERHEAD_GUEST_SYS,
295 PERF_HPP__OVERHEAD_GUEST_US,
594dcbf3 296 PERF_HPP__OVERHEAD_ACC,
ea251d51
NK
297 PERF_HPP__SAMPLES,
298 PERF_HPP__PERIOD,
ea251d51
NK
299
300 PERF_HPP__MAX_INDEX
301};
302
1d77822e 303void perf_hpp__init(void);
77284de3 304void perf_hpp__column_unregister(struct perf_hpp_fmt *format);
77284de3 305void perf_hpp__cancel_cumulate(void);
43e0a68f
JO
306void perf_hpp__setup_output_field(struct perf_hpp_list *list);
307void perf_hpp__reset_output_field(struct perf_hpp_list *list);
308void perf_hpp__append_sort_keys(struct perf_hpp_list *list);
c3bc0c43
NK
309int perf_hpp__setup_hists_formats(struct perf_hpp_list *list,
310 struct perf_evlist *evlist);
43e0a68f 311
a7d945bc
NK
312
313bool perf_hpp__is_sort_entry(struct perf_hpp_fmt *format);
361459f1
NK
314bool perf_hpp__is_dynamic_entry(struct perf_hpp_fmt *format);
315bool perf_hpp__defined_dynamic_entry(struct perf_hpp_fmt *fmt, struct hists *hists);
a9c6e46c
NK
316bool perf_hpp__is_trace_entry(struct perf_hpp_fmt *fmt);
317bool perf_hpp__is_srcline_entry(struct perf_hpp_fmt *fmt);
318bool perf_hpp__is_srcfile_entry(struct perf_hpp_fmt *fmt);
4945cf2a
NK
319bool perf_hpp__is_thread_entry(struct perf_hpp_fmt *fmt);
320bool perf_hpp__is_comm_entry(struct perf_hpp_fmt *fmt);
321bool perf_hpp__is_dso_entry(struct perf_hpp_fmt *fmt);
322bool perf_hpp__is_sym_entry(struct perf_hpp_fmt *fmt);
f2998422 323
c3bc0c43
NK
324struct perf_hpp_fmt *perf_hpp_fmt__dup(struct perf_hpp_fmt *fmt);
325
54430101
NK
326int hist_entry__filter(struct hist_entry *he, int type, const void *arg);
327
361459f1
NK
328static inline bool perf_hpp__should_skip(struct perf_hpp_fmt *format,
329 struct hists *hists)
f2998422 330{
361459f1
NK
331 if (format->elide)
332 return true;
333
334 if (perf_hpp__is_dynamic_entry(format) &&
335 !perf_hpp__defined_dynamic_entry(format, hists))
336 return true;
337
338 return false;
f2998422
JO
339}
340
678a500d 341void perf_hpp__reset_width(struct perf_hpp_fmt *fmt, struct hists *hists);
e0d66c74 342void perf_hpp__reset_sort_width(struct perf_hpp_fmt *fmt, struct hists *hists);
5b591669 343void perf_hpp__set_user_width(const char *width_list_str);
ea251d51 344
2f6d9009
NK
345typedef u64 (*hpp_field_fn)(struct hist_entry *he);
346typedef int (*hpp_callback_fn)(struct perf_hpp *hpp, bool front);
a0088adc 347typedef int (*hpp_snprint_fn)(struct perf_hpp *hpp, const char *fmt, ...);
4a62109f 348
5b591669
NK
349int hpp__fmt(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
350 struct hist_entry *he, hpp_field_fn get_field,
351 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
352int hpp__fmt_acc(struct perf_hpp_fmt *fmt, struct perf_hpp *hpp,
353 struct hist_entry *he, hpp_field_fn get_field,
354 const char *fmtstr, hpp_snprint_fn print_fn, bool fmt_percent);
4a62109f 355
a0088adc
NK
356static inline void advance_hpp(struct perf_hpp *hpp, int inc)
357{
358 hpp->buf += inc;
359 hpp->size -= inc;
360}
361
9754c4f9
JO
362static inline size_t perf_hpp__use_color(void)
363{
364 return !symbol_conf.field_sep;
365}
366
367static inline size_t perf_hpp__color_overhead(void)
368{
369 return perf_hpp__use_color() ?
370 (COLOR_MAXLEN + sizeof(PERF_COLOR_RESET)) * PERF_HPP__MAX_INDEX
371 : 0;
372}
373
e248de33
ACM
374struct perf_evlist;
375
9783adf7
NK
376struct hist_browser_timer {
377 void (*timer)(void *arg);
378 void *arg;
379 int refresh;
380};
381
89fe808a 382#ifdef HAVE_SLANG_SUPPORT
1254b51e 383#include "../ui/keysyms.h"
d5dbc518
ACM
384int map_symbol__tui_annotate(struct map_symbol *ms, struct perf_evsel *evsel,
385 struct hist_browser_timer *hbt);
386
db8fd07a 387int hist_entry__tui_annotate(struct hist_entry *he, struct perf_evsel *evsel,
9783adf7 388 struct hist_browser_timer *hbt);
1254b51e
NK
389
390int perf_evlist__tui_browse_hists(struct perf_evlist *evlist, const char *help,
68d80758 391 struct hist_browser_timer *hbt,
064f1981 392 float min_pcnt,
ce80d3be 393 struct perf_env *env);
66517826 394int script_browse(const char *script_opt);
1254b51e 395#else
7f0030b2 396static inline
1d037ca1
IT
397int perf_evlist__tui_browse_hists(struct perf_evlist *evlist __maybe_unused,
398 const char *help __maybe_unused,
68d80758 399 struct hist_browser_timer *hbt __maybe_unused,
064f1981 400 float min_pcnt __maybe_unused,
ce80d3be 401 struct perf_env *env __maybe_unused)
d67f088e
ACM
402{
403 return 0;
404}
d5dbc518
ACM
405static inline int map_symbol__tui_annotate(struct map_symbol *ms __maybe_unused,
406 struct perf_evsel *evsel __maybe_unused,
407 struct hist_browser_timer *hbt __maybe_unused)
408{
409 return 0;
410}
d67f088e 411
316c7136
ACM
412static inline int hist_entry__tui_annotate(struct hist_entry *he __maybe_unused,
413 struct perf_evsel *evsel __maybe_unused,
414 struct hist_browser_timer *hbt __maybe_unused)
46e3e055
ACM
415{
416 return 0;
417}
66517826 418
4f746c95 419static inline int script_browse(const char *script_opt __maybe_unused)
66517826
FT
420{
421 return 0;
422}
423
1e825efb
ME
424#define K_LEFT -1000
425#define K_RIGHT -2000
5f7439e0 426#define K_SWITCH_INPUT_DATA -3000
b09e0190 427#endif
06daaaba 428
316c7136 429unsigned int hists__sort_list_width(struct hists *hists);
a7b5895b 430unsigned int hists__overhead_width(struct hists *hists);
33db4568 431
57849998
AK
432void hist__account_cycles(struct branch_stack *bs, struct addr_location *al,
433 struct perf_sample *sample, bool nonany_branch_mode);
434
33db4568 435struct option;
b8f8eb84 436int parse_filter_percentage(const struct option *opt, const char *arg, int unset);
0b93da17 437int perf_hist_config(const char *var, const char *value);
33db4568 438
94b3dc38
JO
439void perf_hpp_list__init(struct perf_hpp_list *list);
440
8c01872f
NK
441enum hierarchy_move_dir {
442 HMD_NORMAL,
443 HMD_FORCE_SIBLING,
444 HMD_FORCE_CHILD,
445};
446
447struct rb_node *rb_hierarchy_last(struct rb_node *node);
448struct rb_node *__rb_hierarchy_next(struct rb_node *node,
449 enum hierarchy_move_dir hmd);
450struct rb_node *rb_hierarchy_prev(struct rb_node *node);
451
452static inline struct rb_node *rb_hierarchy_next(struct rb_node *node)
453{
454 return __rb_hierarchy_next(node, HMD_NORMAL);
455}
456
ef86d68a
NK
457#define HIERARCHY_INDENT 3
458
a7b5895b
NK
459bool hist_entry__has_hierarchy_children(struct hist_entry *he, float limit);
460
3d1d07ec 461#endif /* __PERF_HIST_H */
This page took 0.252499 seconds and 5 git commands to generate.