]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - tools/perf/util/evsel.h
perf tools: Remove hists from evsel
[mirror_ubuntu-jammy-kernel.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>
d944c4ee 8#include <linux/types.h>
69aad6f1 9#include "xyarray.h"
023695d9 10#include "cgroup.h"
759ff497 11#include "symbol.h"
d944c4ee 12
c52b12ed
ACM
13struct perf_counts_values {
14 union {
15 struct {
16 u64 val;
17 u64 ena;
18 u64 run;
19 };
20 u64 values[3];
21 };
22};
23
24struct perf_counts {
25 s8 scaled;
26 struct perf_counts_values aggr;
27 struct perf_counts_values cpu[];
28};
69aad6f1 29
70db7533
ACM
30struct 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 */
36struct perf_sample_id {
37 struct hlist_node node;
38 u64 id;
39 struct perf_evsel *evsel;
e4caec0d
JO
40
41 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
42 u64 period;
70db7533
ACM
43};
44
f0c55bcf
SE
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.
75562573
AH
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
f0c55bcf 56 */
69aad6f1
ACM
57struct perf_evsel {
58 struct list_head node;
59 struct perf_event_attr attr;
60 char *filter;
61 struct xyarray *fd;
a91e5431
ACM
62 struct xyarray *sample_id;
63 u64 *id;
c52b12ed 64 struct perf_counts *counts;
c7a79c47 65 struct perf_counts *prev_raw_counts;
69aad6f1 66 int idx;
f4d83436 67 u32 ids;
f0c55bcf 68 char *name;
410136f5
SE
69 double scale;
70 const char *unit;
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;
6ff1ce76 84 bool no_aux_samples;
2afd2bcf 85 bool immediate;
bf8e8f4b 86 bool system_wide;
60b0896c 87 bool tracking;
f5b1135b
JO
88 /* parse modifier helper */
89 int exclude_GH;
97f63e4a 90 int nr_members;
3c176311 91 int sample_read;
6a4bb04c
JO
92 struct perf_evsel *leader;
93 char *group_name;
69aad6f1
ACM
94};
95
88080ce7
BP
96union u64_swap {
97 u64 val64;
98 u32 val32[2];
99};
100
86bd5e86
ACM
101struct cpu_map;
102struct thread_map;
70082dd9 103struct perf_evlist;
b4006796 104struct record_opts;
86bd5e86 105
ce8ccff5
ACM
106int perf_evsel__object_config(size_t object_size,
107 int (*init)(struct perf_evsel *evsel),
108 void (*fini)(struct perf_evsel *evsel));
109
ef503831
ACM
110struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
111
112static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
113{
114 return perf_evsel__new_idx(attr, 0);
115}
116
117struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
118
119static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
120{
121 return perf_evsel__newtp_idx(sys, name, 0);
122}
201b7334
ACM
123
124struct event_format *event_format__new(const char *sys, const char *name);
125
ef1d1af2
ACM
126void perf_evsel__init(struct perf_evsel *evsel,
127 struct perf_event_attr *attr, int idx);
128void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
129void perf_evsel__delete(struct perf_evsel *evsel);
130
0f82ebc4 131void perf_evsel__config(struct perf_evsel *evsel,
b4006796 132 struct record_opts *opts);
0f82ebc4 133
75562573
AH
134int __perf_evsel__sample_size(u64 sample_type);
135void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
136
0b668bc9
ACM
137bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
138
139#define PERF_EVSEL__MAX_ALIASES 8
140
141extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
142 [PERF_EVSEL__MAX_ALIASES];
143extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
144 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
145extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
146 [PERF_EVSEL__MAX_ALIASES];
147extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
148extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
149int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
150 char *bf, size_t size);
7289f83c 151const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 152
717e263f
NK
153const char *perf_evsel__group_name(struct perf_evsel *evsel);
154int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 155
69aad6f1 156int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
70db7533 157int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 158int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
a7e191c3 159void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
69aad6f1 160void perf_evsel__free_fd(struct perf_evsel *evsel);
70db7533 161void perf_evsel__free_id(struct perf_evsel *evsel);
43f8e76e 162void perf_evsel__free_counts(struct perf_evsel *evsel);
c52b12ed 163void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 164
7be5ebe8
ACM
165void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
166 enum perf_event_sample_format bit);
167void __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
75562573
AH
176void perf_evsel__set_sample_id(struct perf_evsel *evsel,
177 bool use_sample_identifier);
7a5a5ca5 178
745cefc5
ACM
179int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
180 const char *filter);
e2407bef 181int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
745cefc5 182
f08199d3 183int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 184 struct cpu_map *cpus);
f08199d3 185int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 186 struct thread_map *threads);
f08199d3 187int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 188 struct thread_map *threads);
727ab04e 189void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 190
5555ded4
ACM
191struct perf_sample;
192
5d2074ea 193void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
194 const char *name);
195u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
196 const char *name);
197
5d2074ea
ACM
198static 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
efd2b924
ACM
205struct format_field;
206
207struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
208
daec78a0
ACM
209#define perf_evsel__match(evsel, t, c) \
210 (evsel->attr.type == PERF_TYPE_##t && \
211 evsel->attr.config == PERF_COUNT_##c)
212
863e451f
JO
213static 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
4cabc3d1
AK
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
c52b12ed
ACM
226int __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 */
236static 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 */
249static 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
255int __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 */
265static 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 */
278static 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
a3f698fe 284int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 285 struct perf_sample *sample);
0c21f736
ACM
286
287static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
288{
289 return list_entry(evsel->node.next, struct perf_evsel, node);
290}
07ac002f 291
d87fcb4a
ACM
292static 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
759ff497
NK
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 */
823254ed 304static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 305{
823254ed 306 return evsel->leader == evsel;
07ac002f 307}
0698aedd 308
759ff497
NK
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 */
317static 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
6bedfab6
JO
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 */
333static 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
0698aedd
ACM
343struct perf_attr_details {
344 bool freq;
345 bool verbose;
e35ef355 346 bool event_group;
0698aedd
ACM
347};
348
349int perf_evsel__fprintf(struct perf_evsel *evsel,
350 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
351
352bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
353 char *msg, size_t msgsize);
602ad878 354int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 355 int err, char *msg, size_t size);
97f63e4a
NK
356
357static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
358{
359 return evsel->idx - evsel->leader->idx;
360}
717e263f
NK
361
362#define for_each_group_member(_evsel, _leader) \
363for ((_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
69aad6f1 367#endif /* __PERF_EVSEL_H */