perf tools: Remove hists from evsel
[cascardo/linux.git] / tools / perf / util / evsel.h
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7 #include <linux/perf_event.h>
8 #include <linux/types.h>
9 #include "xyarray.h"
10 #include "cgroup.h"
11 #include "symbol.h"
12
13 struct perf_counts_values {
14         union {
15                 struct {
16                         u64 val;
17                         u64 ena;
18                         u64 run;
19                 };
20                 u64 values[3];
21         };
22 };
23
24 struct perf_counts {
25         s8                        scaled;
26         struct perf_counts_values aggr;
27         struct perf_counts_values cpu[];
28 };
29
30 struct perf_evsel;
31
32 /*
33  * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
34  * more than one entry in the evlist.
35  */
36 struct perf_sample_id {
37         struct hlist_node       node;
38         u64                     id;
39         struct perf_evsel       *evsel;
40
41         /* Holds total ID period value for PERF_SAMPLE_READ processing. */
42         u64                     period;
43 };
44
45 /** struct perf_evsel - event selector
46  *
47  * @name - Can be set to retain the original event name passed by the user,
48  *         so that when showing results in tools such as 'perf stat', we
49  *         show the name used, not some alias.
50  * @id_pos: the position of the event id (PERF_SAMPLE_ID or
51  *          PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
52  *          struct sample_event
53  * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
54  *          PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
55  *          is used there is an id sample appended to non-sample events
56  */
57 struct perf_evsel {
58         struct list_head        node;
59         struct perf_event_attr  attr;
60         char                    *filter;
61         struct xyarray          *fd;
62         struct xyarray          *sample_id;
63         u64                     *id;
64         struct perf_counts      *counts;
65         struct perf_counts      *prev_raw_counts;
66         int                     idx;
67         u32                     ids;
68         char                    *name;
69         double                  scale;
70         const char              *unit;
71         struct event_format     *tp_format;
72         union {
73                 void            *priv;
74                 off_t           id_offset;
75         };
76         struct cgroup_sel       *cgrp;
77         void                    *handler;
78         struct cpu_map          *cpus;
79         unsigned int            sample_size;
80         int                     id_pos;
81         int                     is_pos;
82         bool                    supported;
83         bool                    needs_swap;
84         bool                    no_aux_samples;
85         bool                    immediate;
86         bool                    system_wide;
87         bool                    tracking;
88         /* parse modifier helper */
89         int                     exclude_GH;
90         int                     nr_members;
91         int                     sample_read;
92         struct perf_evsel       *leader;
93         char                    *group_name;
94 };
95
96 union u64_swap {
97         u64 val64;
98         u32 val32[2];
99 };
100
101 struct cpu_map;
102 struct thread_map;
103 struct perf_evlist;
104 struct record_opts;
105
106 int perf_evsel__object_config(size_t object_size,
107                               int (*init)(struct perf_evsel *evsel),
108                               void (*fini)(struct perf_evsel *evsel));
109
110 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
111
112 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
113 {
114         return perf_evsel__new_idx(attr, 0);
115 }
116
117 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
118
119 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
120 {
121         return perf_evsel__newtp_idx(sys, name, 0);
122 }
123
124 struct event_format *event_format__new(const char *sys, const char *name);
125
126 void perf_evsel__init(struct perf_evsel *evsel,
127                       struct perf_event_attr *attr, int idx);
128 void perf_evsel__exit(struct perf_evsel *evsel);
129 void perf_evsel__delete(struct perf_evsel *evsel);
130
131 void perf_evsel__config(struct perf_evsel *evsel,
132                         struct record_opts *opts);
133
134 int __perf_evsel__sample_size(u64 sample_type);
135 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
136
137 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
138
139 #define PERF_EVSEL__MAX_ALIASES 8
140
141 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
142                                        [PERF_EVSEL__MAX_ALIASES];
143 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
144                                           [PERF_EVSEL__MAX_ALIASES];
145 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
146                                               [PERF_EVSEL__MAX_ALIASES];
147 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
148 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
149 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
150                                             char *bf, size_t size);
151 const char *perf_evsel__name(struct perf_evsel *evsel);
152
153 const char *perf_evsel__group_name(struct perf_evsel *evsel);
154 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
155
156 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
157 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
158 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
159 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
160 void perf_evsel__free_fd(struct perf_evsel *evsel);
161 void perf_evsel__free_id(struct perf_evsel *evsel);
162 void perf_evsel__free_counts(struct perf_evsel *evsel);
163 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
164
165 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
166                                   enum perf_event_sample_format bit);
167 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
168                                     enum perf_event_sample_format bit);
169
170 #define perf_evsel__set_sample_bit(evsel, bit) \
171         __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
172
173 #define perf_evsel__reset_sample_bit(evsel, bit) \
174         __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
175
176 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
177                                bool use_sample_identifier);
178
179 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
180                            const char *filter);
181 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
182
183 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
184                              struct cpu_map *cpus);
185 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
186                                 struct thread_map *threads);
187 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
188                      struct thread_map *threads);
189 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
190
191 struct perf_sample;
192
193 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
194                          const char *name);
195 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
196                        const char *name);
197
198 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
199                                        struct perf_sample *sample,
200                                        const char *name)
201 {
202         return perf_evsel__rawptr(evsel, sample, name);
203 }
204
205 struct format_field;
206
207 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
208
209 #define perf_evsel__match(evsel, t, c)          \
210         (evsel->attr.type == PERF_TYPE_##t &&   \
211          evsel->attr.config == PERF_COUNT_##c)
212
213 static inline bool perf_evsel__match2(struct perf_evsel *e1,
214                                       struct perf_evsel *e2)
215 {
216         return (e1->attr.type == e2->attr.type) &&
217                (e1->attr.config == e2->attr.config);
218 }
219
220 #define perf_evsel__cmp(a, b)                   \
221         ((a) &&                                 \
222          (b) &&                                 \
223          (a)->attr.type == (b)->attr.type &&    \
224          (a)->attr.config == (b)->attr.config)
225
226 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
227                               int cpu, int thread, bool scale);
228
229 /**
230  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
231  *
232  * @evsel - event selector to read value
233  * @cpu - CPU of interest
234  * @thread - thread of interest
235  */
236 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
237                                           int cpu, int thread)
238 {
239         return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
240 }
241
242 /**
243  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
244  *
245  * @evsel - event selector to read value
246  * @cpu - CPU of interest
247  * @thread - thread of interest
248  */
249 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
250                                                  int cpu, int thread)
251 {
252         return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
253 }
254
255 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
256                        bool scale);
257
258 /**
259  * perf_evsel__read - Read the aggregate results on all CPUs
260  *
261  * @evsel - event selector to read value
262  * @ncpus - Number of cpus affected, from zero
263  * @nthreads - Number of threads affected, from zero
264  */
265 static inline int perf_evsel__read(struct perf_evsel *evsel,
266                                     int ncpus, int nthreads)
267 {
268         return __perf_evsel__read(evsel, ncpus, nthreads, false);
269 }
270
271 /**
272  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
273  *
274  * @evsel - event selector to read value
275  * @ncpus - Number of cpus affected, from zero
276  * @nthreads - Number of threads affected, from zero
277  */
278 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
279                                           int ncpus, int nthreads)
280 {
281         return __perf_evsel__read(evsel, ncpus, nthreads, true);
282 }
283
284 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
285                              struct perf_sample *sample);
286
287 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
288 {
289         return list_entry(evsel->node.next, struct perf_evsel, node);
290 }
291
292 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
293 {
294         return list_entry(evsel->node.prev, struct perf_evsel, node);
295 }
296
297 /**
298  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
299  *
300  * @evsel - evsel selector to be tested
301  *
302  * Return %true if @evsel is a group leader or a stand-alone event
303  */
304 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
305 {
306         return evsel->leader == evsel;
307 }
308
309 /**
310  * perf_evsel__is_group_event - Return whether given evsel is a group event
311  *
312  * @evsel - evsel selector to be tested
313  *
314  * Return %true iff event group view is enabled and @evsel is a actual group
315  * leader which has other members in the group
316  */
317 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
318 {
319         if (!symbol_conf.event_group)
320                 return false;
321
322         return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
323 }
324
325 /**
326  * perf_evsel__is_function_event - Return whether given evsel is a function
327  * trace event
328  *
329  * @evsel - evsel selector to be tested
330  *
331  * Return %true if event is function trace event
332  */
333 static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
334 {
335 #define FUNCTION_EVENT "ftrace:function"
336
337         return evsel->name &&
338                !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
339
340 #undef FUNCTION_EVENT
341 }
342
343 struct perf_attr_details {
344         bool freq;
345         bool verbose;
346         bool event_group;
347 };
348
349 int perf_evsel__fprintf(struct perf_evsel *evsel,
350                         struct perf_attr_details *details, FILE *fp);
351
352 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
353                           char *msg, size_t msgsize);
354 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
355                               int err, char *msg, size_t size);
356
357 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
358 {
359         return evsel->idx - evsel->leader->idx;
360 }
361
362 #define for_each_group_member(_evsel, _leader)                                  \
363 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node);      \
364      (_evsel) && (_evsel)->leader == (_leader);                                 \
365      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
366
367 #endif /* __PERF_EVSEL_H */