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