perf evsel: Ditch evsel->handler.data field
[deliverable/linux.git] / tools / perf / util / evsel.h
CommitLineData
69aad6f1
ACM
1#ifndef __PERF_EVSEL_H
2#define __PERF_EVSEL_H 1
3
4#include <linux/list.h>
c52b12ed 5#include <stdbool.h>
07ac002f 6#include <stddef.h>
d2709c7c 7#include <linux/perf_event.h>
69aad6f1
ACM
8#include "types.h"
9#include "xyarray.h"
023695d9 10#include "cgroup.h"
e248de33 11#include "hist.h"
759ff497 12#include "symbol.h"
c52b12ed
ACM
13
14struct perf_counts_values {
15 union {
16 struct {
17 u64 val;
18 u64 ena;
19 u64 run;
20 };
21 u64 values[3];
22 };
23};
24
25struct perf_counts {
26 s8 scaled;
27 struct perf_counts_values aggr;
28 struct perf_counts_values cpu[];
29};
69aad6f1 30
70db7533
ACM
31struct perf_evsel;
32
33/*
34 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
35 * more than one entry in the evlist.
36 */
37struct perf_sample_id {
38 struct hlist_node node;
39 u64 id;
40 struct perf_evsel *evsel;
e4caec0d
JO
41
42 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
43 u64 period;
70db7533
ACM
44};
45
f0c55bcf
SE
46/** struct perf_evsel - event selector
47 *
48 * @name - Can be set to retain the original event name passed by the user,
49 * so that when showing results in tools such as 'perf stat', we
50 * show the name used, not some alias.
75562573
AH
51 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
52 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
53 * struct sample_event
54 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
55 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
56 * is used there is an id sample appended to non-sample events
f0c55bcf 57 */
69aad6f1
ACM
58struct perf_evsel {
59 struct list_head node;
60 struct perf_event_attr attr;
61 char *filter;
62 struct xyarray *fd;
a91e5431
ACM
63 struct xyarray *sample_id;
64 u64 *id;
c52b12ed 65 struct perf_counts *counts;
c7a79c47 66 struct perf_counts *prev_raw_counts;
69aad6f1 67 int idx;
f4d83436 68 u32 ids;
e248de33 69 struct hists hists;
f0c55bcf 70 char *name;
fcf65bf1 71 struct event_format *tp_format;
a91e5431
ACM
72 union {
73 void *priv;
74 off_t id_offset;
75 };
023695d9 76 struct cgroup_sel *cgrp;
744a9719 77 void *handler;
7ae92e74 78 struct cpu_map *cpus;
bde09467 79 unsigned int sample_size;
75562573
AH
80 int id_pos;
81 int is_pos;
2cee77c4 82 bool supported;
0807d2d8 83 bool needs_swap;
f5b1135b
JO
84 /* parse modifier helper */
85 int exclude_GH;
97f63e4a 86 int nr_members;
3c176311 87 int sample_read;
6a4bb04c
JO
88 struct perf_evsel *leader;
89 char *group_name;
69aad6f1
ACM
90};
91
29d720ed
NK
92#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
93
86bd5e86
ACM
94struct cpu_map;
95struct thread_map;
70082dd9 96struct perf_evlist;
0f82ebc4 97struct perf_record_opts;
86bd5e86 98
23a2f3ab 99struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr, int idx);
efd2b924 100struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
201b7334
ACM
101
102struct event_format *event_format__new(const char *sys, const char *name);
103
ef1d1af2
ACM
104void perf_evsel__init(struct perf_evsel *evsel,
105 struct perf_event_attr *attr, int idx);
106void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
107void perf_evsel__delete(struct perf_evsel *evsel);
108
0f82ebc4 109void perf_evsel__config(struct perf_evsel *evsel,
cac21425 110 struct perf_record_opts *opts);
0f82ebc4 111
75562573
AH
112int __perf_evsel__sample_size(u64 sample_type);
113void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
114
0b668bc9
ACM
115bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
116
117#define PERF_EVSEL__MAX_ALIASES 8
118
119extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
120 [PERF_EVSEL__MAX_ALIASES];
121extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
122 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
123extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
124 [PERF_EVSEL__MAX_ALIASES];
125extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
126extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
127int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
128 char *bf, size_t size);
7289f83c 129const char *perf_evsel__name(struct perf_evsel *evsel);
717e263f
NK
130const char *perf_evsel__group_name(struct perf_evsel *evsel);
131int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 132
69aad6f1 133int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533 134int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 135int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3 136void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1 137void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533 138void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e 139void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed 140void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 141
7be5ebe8
ACM
142void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
143 enum perf_event_sample_format bit);
144void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
145 enum perf_event_sample_format bit);
146
147#define perf_evsel__set_sample_bit(evsel, bit) \
148 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
149
150#define perf_evsel__reset_sample_bit(evsel, bit) \
151 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
152
75562573
AH
153void perf_evsel__set_sample_id(struct perf_evsel *evsel,
154 bool use_sample_identifier);
7a5a5ca5 155
745cefc5
ACM
156int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
157 const char *filter);
e2407bef 158int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
745cefc5 159
f08199d3 160int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 161 struct cpu_map *cpus);
f08199d3 162int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 163 struct thread_map *threads);
f08199d3 164int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 165 struct thread_map *threads);
727ab04e 166void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 167
5555ded4
ACM
168struct perf_sample;
169
5d2074ea 170void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
171 const char *name);
172u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
173 const char *name);
174
5d2074ea
ACM
175static inline char *perf_evsel__strval(struct perf_evsel *evsel,
176 struct perf_sample *sample,
177 const char *name)
178{
179 return perf_evsel__rawptr(evsel, sample, name);
180}
181
efd2b924
ACM
182struct format_field;
183
184struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
185
daec78a0
ACM
186#define perf_evsel__match(evsel, t, c) \
187 (evsel->attr.type == PERF_TYPE_##t && \
188 evsel->attr.config == PERF_COUNT_##c)
189
863e451f
JO
190static inline bool perf_evsel__match2(struct perf_evsel *e1,
191 struct perf_evsel *e2)
192{
193 return (e1->attr.type == e2->attr.type) &&
194 (e1->attr.config == e2->attr.config);
195}
196
4cabc3d1
AK
197#define perf_evsel__cmp(a, b) \
198 ((a) && \
199 (b) && \
200 (a)->attr.type == (b)->attr.type && \
201 (a)->attr.config == (b)->attr.config)
202
c52b12ed
ACM
203int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
204 int cpu, int thread, bool scale);
205
206/**
207 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
208 *
209 * @evsel - event selector to read value
210 * @cpu - CPU of interest
211 * @thread - thread of interest
212 */
213static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
214 int cpu, int thread)
215{
216 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
217}
218
219/**
220 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
221 *
222 * @evsel - event selector to read value
223 * @cpu - CPU of interest
224 * @thread - thread of interest
225 */
226static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
227 int cpu, int thread)
228{
229 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
230}
231
232int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
233 bool scale);
234
235/**
236 * perf_evsel__read - Read the aggregate results on all CPUs
237 *
238 * @evsel - event selector to read value
239 * @ncpus - Number of cpus affected, from zero
240 * @nthreads - Number of threads affected, from zero
241 */
242static inline int perf_evsel__read(struct perf_evsel *evsel,
243 int ncpus, int nthreads)
244{
245 return __perf_evsel__read(evsel, ncpus, nthreads, false);
246}
247
248/**
249 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
250 *
251 * @evsel - event selector to read value
252 * @ncpus - Number of cpus affected, from zero
253 * @nthreads - Number of threads affected, from zero
254 */
255static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
256 int ncpus, int nthreads)
257{
258 return __perf_evsel__read(evsel, ncpus, nthreads, true);
259}
260
4bf9ce1b
JO
261void hists__init(struct hists *hists);
262
a3f698fe 263int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 264 struct perf_sample *sample);
0c21f736
ACM
265
266static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
267{
268 return list_entry(evsel->node.next, struct perf_evsel, node);
269}
07ac002f 270
759ff497
NK
271/**
272 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
273 *
274 * @evsel - evsel selector to be tested
275 *
276 * Return %true if @evsel is a group leader or a stand-alone event
277 */
823254ed 278static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 279{
823254ed 280 return evsel->leader == evsel;
07ac002f 281}
0698aedd 282
759ff497
NK
283/**
284 * perf_evsel__is_group_event - Return whether given evsel is a group event
285 *
286 * @evsel - evsel selector to be tested
287 *
288 * Return %true iff event group view is enabled and @evsel is a actual group
289 * leader which has other members in the group
290 */
291static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
292{
293 if (!symbol_conf.event_group)
294 return false;
295
296 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
297}
298
0698aedd
ACM
299struct perf_attr_details {
300 bool freq;
301 bool verbose;
e35ef355 302 bool event_group;
0698aedd
ACM
303};
304
305int perf_evsel__fprintf(struct perf_evsel *evsel,
306 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
307
308bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
309 char *msg, size_t msgsize);
56e52e85
ACM
310int perf_evsel__open_strerror(struct perf_evsel *evsel,
311 struct perf_target *target,
312 int err, char *msg, size_t size);
97f63e4a
NK
313
314static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
315{
316 return evsel->idx - evsel->leader->idx;
317}
717e263f
NK
318
319#define for_each_group_member(_evsel, _leader) \
320for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
321 (_evsel) && (_evsel)->leader == (_leader); \
322 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
323
69aad6f1 324#endif /* __PERF_EVSEL_H */
This page took 0.122018 seconds and 5 git commands to generate.