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