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