perf record: Rename 'perf_record' to plain 'record'
[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;
410136f5
SE
71 double scale;
72 const char *unit;
fcf65bf1 73 struct event_format *tp_format;
a91e5431
ACM
74 union {
75 void *priv;
76 off_t id_offset;
77 };
023695d9 78 struct cgroup_sel *cgrp;
744a9719 79 void *handler;
7ae92e74 80 struct cpu_map *cpus;
bde09467 81 unsigned int sample_size;
75562573
AH
82 int id_pos;
83 int is_pos;
2cee77c4 84 bool supported;
0807d2d8 85 bool needs_swap;
f5b1135b
JO
86 /* parse modifier helper */
87 int exclude_GH;
97f63e4a 88 int nr_members;
3c176311 89 int sample_read;
6a4bb04c
JO
90 struct perf_evsel *leader;
91 char *group_name;
69aad6f1
ACM
92};
93
29d720ed
NK
94#define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
95
86bd5e86
ACM
96struct cpu_map;
97struct thread_map;
70082dd9 98struct perf_evlist;
0f82ebc4 99struct perf_record_opts;
86bd5e86 100
ef503831
ACM
101struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
102
103static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
104{
105 return perf_evsel__new_idx(attr, 0);
106}
107
108struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
109
110static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
111{
112 return perf_evsel__newtp_idx(sys, name, 0);
113}
201b7334
ACM
114
115struct event_format *event_format__new(const char *sys, const char *name);
116
ef1d1af2
ACM
117void perf_evsel__init(struct perf_evsel *evsel,
118 struct perf_event_attr *attr, int idx);
119void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
120void perf_evsel__delete(struct perf_evsel *evsel);
121
0f82ebc4 122void perf_evsel__config(struct perf_evsel *evsel,
cac21425 123 struct perf_record_opts *opts);
0f82ebc4 124
75562573
AH
125int __perf_evsel__sample_size(u64 sample_type);
126void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
127
0b668bc9
ACM
128bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
129
130#define PERF_EVSEL__MAX_ALIASES 8
131
132extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
133 [PERF_EVSEL__MAX_ALIASES];
134extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
135 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
136extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
137 [PERF_EVSEL__MAX_ALIASES];
138extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
139extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
140int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
141 char *bf, size_t size);
7289f83c 142const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 143
717e263f
NK
144const char *perf_evsel__group_name(struct perf_evsel *evsel);
145int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 146
69aad6f1 147int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533 148int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 149int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3 150void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1 151void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533 152void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e 153void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed 154void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 155
7be5ebe8
ACM
156void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
157 enum perf_event_sample_format bit);
158void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
159 enum perf_event_sample_format bit);
160
161#define perf_evsel__set_sample_bit(evsel, bit) \
162 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
163
164#define perf_evsel__reset_sample_bit(evsel, bit) \
165 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
166
75562573
AH
167void perf_evsel__set_sample_id(struct perf_evsel *evsel,
168 bool use_sample_identifier);
7a5a5ca5 169
745cefc5
ACM
170int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
171 const char *filter);
e2407bef 172int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
745cefc5 173
f08199d3 174int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 175 struct cpu_map *cpus);
f08199d3 176int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 177 struct thread_map *threads);
f08199d3 178int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 179 struct thread_map *threads);
727ab04e 180void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 181
5555ded4
ACM
182struct perf_sample;
183
5d2074ea 184void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
185 const char *name);
186u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
187 const char *name);
188
5d2074ea
ACM
189static inline char *perf_evsel__strval(struct perf_evsel *evsel,
190 struct perf_sample *sample,
191 const char *name)
192{
193 return perf_evsel__rawptr(evsel, sample, name);
194}
195
efd2b924
ACM
196struct format_field;
197
198struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
199
daec78a0
ACM
200#define perf_evsel__match(evsel, t, c) \
201 (evsel->attr.type == PERF_TYPE_##t && \
202 evsel->attr.config == PERF_COUNT_##c)
203
863e451f
JO
204static inline bool perf_evsel__match2(struct perf_evsel *e1,
205 struct perf_evsel *e2)
206{
207 return (e1->attr.type == e2->attr.type) &&
208 (e1->attr.config == e2->attr.config);
209}
210
4cabc3d1
AK
211#define perf_evsel__cmp(a, b) \
212 ((a) && \
213 (b) && \
214 (a)->attr.type == (b)->attr.type && \
215 (a)->attr.config == (b)->attr.config)
216
c52b12ed
ACM
217int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
218 int cpu, int thread, bool scale);
219
220/**
221 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
222 *
223 * @evsel - event selector to read value
224 * @cpu - CPU of interest
225 * @thread - thread of interest
226 */
227static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
228 int cpu, int thread)
229{
230 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
231}
232
233/**
234 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
235 *
236 * @evsel - event selector to read value
237 * @cpu - CPU of interest
238 * @thread - thread of interest
239 */
240static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
241 int cpu, int thread)
242{
243 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
244}
245
246int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
247 bool scale);
248
249/**
250 * perf_evsel__read - Read the aggregate results on all CPUs
251 *
252 * @evsel - event selector to read value
253 * @ncpus - Number of cpus affected, from zero
254 * @nthreads - Number of threads affected, from zero
255 */
256static inline int perf_evsel__read(struct perf_evsel *evsel,
257 int ncpus, int nthreads)
258{
259 return __perf_evsel__read(evsel, ncpus, nthreads, false);
260}
261
262/**
263 * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
264 *
265 * @evsel - event selector to read value
266 * @ncpus - Number of cpus affected, from zero
267 * @nthreads - Number of threads affected, from zero
268 */
269static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
270 int ncpus, int nthreads)
271{
272 return __perf_evsel__read(evsel, ncpus, nthreads, true);
273}
274
4bf9ce1b
JO
275void hists__init(struct hists *hists);
276
a3f698fe 277int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 278 struct perf_sample *sample);
0c21f736
ACM
279
280static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
281{
282 return list_entry(evsel->node.next, struct perf_evsel, node);
283}
07ac002f 284
d87fcb4a
ACM
285static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
286{
287 return list_entry(evsel->node.prev, struct perf_evsel, node);
288}
289
759ff497
NK
290/**
291 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
292 *
293 * @evsel - evsel selector to be tested
294 *
295 * Return %true if @evsel is a group leader or a stand-alone event
296 */
823254ed 297static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 298{
823254ed 299 return evsel->leader == evsel;
07ac002f 300}
0698aedd 301
759ff497
NK
302/**
303 * perf_evsel__is_group_event - Return whether given evsel is a group event
304 *
305 * @evsel - evsel selector to be tested
306 *
307 * Return %true iff event group view is enabled and @evsel is a actual group
308 * leader which has other members in the group
309 */
310static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
311{
312 if (!symbol_conf.event_group)
313 return false;
314
315 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
316}
317
0698aedd
ACM
318struct perf_attr_details {
319 bool freq;
320 bool verbose;
e35ef355 321 bool event_group;
0698aedd
ACM
322};
323
324int perf_evsel__fprintf(struct perf_evsel *evsel,
325 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
326
327bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
328 char *msg, size_t msgsize);
602ad878 329int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 330 int err, char *msg, size_t size);
97f63e4a
NK
331
332static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
333{
334 return evsel->idx - evsel->leader->idx;
335}
717e263f
NK
336
337#define for_each_group_member(_evsel, _leader) \
338for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
339 (_evsel) && (_evsel)->leader == (_leader); \
340 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
341
69aad6f1 342#endif /* __PERF_EVSEL_H */
This page took 0.200918 seconds and 5 git commands to generate.