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