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