Merge remote-tracking branch 'asoc/topic/topology' into asoc-next
[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>
d944c4ee 8#include <linux/types.h>
69aad6f1 9#include "xyarray.h"
759ff497 10#include "symbol.h"
a22e99cd 11#include "cpumap.h"
d809560b 12#include "counts.h"
69aad6f1 13
70db7533
ACM
14struct perf_evsel;
15
16/*
17 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
18 * more than one entry in the evlist.
19 */
20struct perf_sample_id {
21 struct hlist_node node;
22 u64 id;
23 struct perf_evsel *evsel;
3c659eed
AH
24 int idx;
25 int cpu;
26 pid_t tid;
e4caec0d
JO
27
28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
29 u64 period;
70db7533
ACM
30};
31
f14d5707
ACM
32struct cgroup_sel;
33
930a2e29
JO
34/*
35 * The 'struct perf_evsel_config_term' is used to pass event
36 * specific configuration data to perf_evsel__config routine.
37 * It is allocated within event parsing and attached to
38 * perf_evsel::config_terms list head.
39*/
40enum {
ee4c7588 41 PERF_EVSEL__CONFIG_TERM_PERIOD,
09af2a55 42 PERF_EVSEL__CONFIG_TERM_FREQ,
32067712 43 PERF_EVSEL__CONFIG_TERM_TIME,
d457c963
KL
44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
45 PERF_EVSEL__CONFIG_TERM_STACK_USER,
374ce938 46 PERF_EVSEL__CONFIG_TERM_INHERIT,
930a2e29
JO
47 PERF_EVSEL__CONFIG_TERM_MAX,
48};
49
50struct perf_evsel_config_term {
51 struct list_head list;
52 int type;
53 union {
54 u64 period;
09af2a55 55 u64 freq;
32067712 56 bool time;
d457c963
KL
57 char *callgraph;
58 u64 stack_user;
374ce938 59 bool inherit;
930a2e29
JO
60 } val;
61};
62
f0c55bcf
SE
63/** struct perf_evsel - event selector
64 *
d49e4695
ACM
65 * @evlist - evlist this evsel is in, if it is in one.
66 * @node - To insert it into evlist->entries or in other list_heads, say in
67 * the event parsing routines.
f0c55bcf
SE
68 * @name - Can be set to retain the original event name passed by the user,
69 * so that when showing results in tools such as 'perf stat', we
70 * show the name used, not some alias.
75562573
AH
71 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
72 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
73 * struct sample_event
74 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
75 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
76 * is used there is an id sample appended to non-sample events
0db15b1e 77 * @priv: And what is in its containing unnamed union are tool specific
f0c55bcf 78 */
69aad6f1
ACM
79struct perf_evsel {
80 struct list_head node;
d49e4695 81 struct perf_evlist *evlist;
69aad6f1
ACM
82 struct perf_event_attr attr;
83 char *filter;
84 struct xyarray *fd;
a91e5431
ACM
85 struct xyarray *sample_id;
86 u64 *id;
c52b12ed 87 struct perf_counts *counts;
c7a79c47 88 struct perf_counts *prev_raw_counts;
69aad6f1 89 int idx;
f4d83436 90 u32 ids;
f0c55bcf 91 char *name;
410136f5
SE
92 double scale;
93 const char *unit;
fcf65bf1 94 struct event_format *tp_format;
af339981 95 off_t id_offset;
616df645
CP
96 void *priv;
97 u64 db_id;
023695d9 98 struct cgroup_sel *cgrp;
744a9719 99 void *handler;
7ae92e74 100 struct cpu_map *cpus;
fce4d296 101 struct cpu_map *own_cpus;
578e91ec 102 struct thread_map *threads;
bde09467 103 unsigned int sample_size;
75562573
AH
104 int id_pos;
105 int is_pos;
86066064 106 bool snapshot;
2cee77c4 107 bool supported;
0807d2d8 108 bool needs_swap;
6ff1ce76 109 bool no_aux_samples;
2afd2bcf 110 bool immediate;
bf8e8f4b 111 bool system_wide;
60b0896c 112 bool tracking;
044330c1 113 bool per_pkg;
7f94af7a 114 bool precise_max;
f5b1135b
JO
115 /* parse modifier helper */
116 int exclude_GH;
97f63e4a 117 int nr_members;
3c176311 118 int sample_read;
86066064 119 unsigned long *per_pkg_mask;
6a4bb04c
JO
120 struct perf_evsel *leader;
121 char *group_name;
15bfd2cc 122 bool cmdline_group_boundary;
930a2e29 123 struct list_head config_terms;
1f45b1d4 124 int bpf_fd;
69aad6f1
ACM
125};
126
88080ce7
BP
127union u64_swap {
128 u64 val64;
129 u32 val32[2];
130};
131
86bd5e86 132struct cpu_map;
80b2210c 133struct target;
86bd5e86 134struct thread_map;
b4006796 135struct record_opts;
86bd5e86 136
a22e99cd
JO
137static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
138{
139 return evsel->cpus;
140}
141
142static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
143{
144 return perf_evsel__cpus(evsel)->nr;
145}
146
13112bbf
JO
147void perf_counts_values__scale(struct perf_counts_values *count,
148 bool scale, s8 *pscaled);
149
a6fa0038 150void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
857a94a2
JO
151 struct perf_counts_values *count);
152
ce8ccff5
ACM
153int perf_evsel__object_config(size_t object_size,
154 int (*init)(struct perf_evsel *evsel),
155 void (*fini)(struct perf_evsel *evsel));
156
ef503831
ACM
157struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
158
159static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
160{
161 return perf_evsel__new_idx(attr, 0);
162}
163
164struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
165
8dd2a131
JO
166/*
167 * Returns pointer with encoded error via <linux/err.h> interface.
168 */
ef503831
ACM
169static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
170{
171 return perf_evsel__newtp_idx(sys, name, 0);
172}
201b7334
ACM
173
174struct event_format *event_format__new(const char *sys, const char *name);
175
ef1d1af2
ACM
176void perf_evsel__init(struct perf_evsel *evsel,
177 struct perf_event_attr *attr, int idx);
178void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
179void perf_evsel__delete(struct perf_evsel *evsel);
180
0f82ebc4 181void perf_evsel__config(struct perf_evsel *evsel,
b4006796 182 struct record_opts *opts);
0f82ebc4 183
75562573
AH
184int __perf_evsel__sample_size(u64 sample_type);
185void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
186
0b668bc9
ACM
187bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
188
189#define PERF_EVSEL__MAX_ALIASES 8
190
191extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
192 [PERF_EVSEL__MAX_ALIASES];
193extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
194 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
195extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
196 [PERF_EVSEL__MAX_ALIASES];
197extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
198extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
199int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
200 char *bf, size_t size);
7289f83c 201const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 202
717e263f
NK
203const char *perf_evsel__group_name(struct perf_evsel *evsel);
204int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 205
70db7533 206int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 207void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 208
7be5ebe8
ACM
209void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
210 enum perf_event_sample_format bit);
211void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
212 enum perf_event_sample_format bit);
213
214#define perf_evsel__set_sample_bit(evsel, bit) \
215 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
216
217#define perf_evsel__reset_sample_bit(evsel, bit) \
218 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
219
75562573
AH
220void perf_evsel__set_sample_id(struct perf_evsel *evsel,
221 bool use_sample_identifier);
7a5a5ca5 222
12467ae4 223int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
64ec84f5
ACM
224int perf_evsel__append_filter(struct perf_evsel *evsel,
225 const char *op, const char *filter);
f47805a2
ACM
226int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
227 const char *filter);
5cd95fc3 228int perf_evsel__enable(struct perf_evsel *evsel);
e98a4cbb 229int perf_evsel__disable(struct perf_evsel *evsel);
745cefc5 230
f08199d3 231int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 232 struct cpu_map *cpus);
f08199d3 233int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 234 struct thread_map *threads);
f08199d3 235int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 236 struct thread_map *threads);
727ab04e 237void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 238
5555ded4
ACM
239struct perf_sample;
240
5d2074ea 241void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
242 const char *name);
243u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
244 const char *name);
245
5d2074ea
ACM
246static inline char *perf_evsel__strval(struct perf_evsel *evsel,
247 struct perf_sample *sample,
248 const char *name)
249{
250 return perf_evsel__rawptr(evsel, sample, name);
251}
252
efd2b924
ACM
253struct format_field;
254
255struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
256
daec78a0
ACM
257#define perf_evsel__match(evsel, t, c) \
258 (evsel->attr.type == PERF_TYPE_##t && \
259 evsel->attr.config == PERF_COUNT_##c)
260
863e451f
JO
261static inline bool perf_evsel__match2(struct perf_evsel *e1,
262 struct perf_evsel *e2)
263{
264 return (e1->attr.type == e2->attr.type) &&
265 (e1->attr.config == e2->attr.config);
266}
267
4cabc3d1
AK
268#define perf_evsel__cmp(a, b) \
269 ((a) && \
270 (b) && \
271 (a)->attr.type == (b)->attr.type && \
272 (a)->attr.config == (b)->attr.config)
273
f99f4719
JO
274int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
275 struct perf_counts_values *count);
276
c52b12ed
ACM
277int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
278 int cpu, int thread, bool scale);
279
280/**
281 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
282 *
283 * @evsel - event selector to read value
284 * @cpu - CPU of interest
285 * @thread - thread of interest
286 */
287static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
288 int cpu, int thread)
289{
290 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
291}
292
293/**
294 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
295 *
296 * @evsel - event selector to read value
297 * @cpu - CPU of interest
298 * @thread - thread of interest
299 */
300static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
301 int cpu, int thread)
302{
303 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
304}
305
a3f698fe 306int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 307 struct perf_sample *sample);
0c21f736
ACM
308
309static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
310{
311 return list_entry(evsel->node.next, struct perf_evsel, node);
312}
07ac002f 313
d87fcb4a
ACM
314static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
315{
316 return list_entry(evsel->node.prev, struct perf_evsel, node);
317}
318
759ff497
NK
319/**
320 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
321 *
322 * @evsel - evsel selector to be tested
323 *
324 * Return %true if @evsel is a group leader or a stand-alone event
325 */
823254ed 326static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 327{
823254ed 328 return evsel->leader == evsel;
07ac002f 329}
0698aedd 330
759ff497
NK
331/**
332 * perf_evsel__is_group_event - Return whether given evsel is a group event
333 *
334 * @evsel - evsel selector to be tested
335 *
336 * Return %true iff event group view is enabled and @evsel is a actual group
337 * leader which has other members in the group
338 */
339static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
340{
341 if (!symbol_conf.event_group)
342 return false;
343
344 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
345}
346
6bedfab6
JO
347/**
348 * perf_evsel__is_function_event - Return whether given evsel is a function
349 * trace event
350 *
351 * @evsel - evsel selector to be tested
352 *
353 * Return %true if event is function trace event
354 */
355static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
356{
357#define FUNCTION_EVENT "ftrace:function"
358
359 return evsel->name &&
360 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
361
362#undef FUNCTION_EVENT
363}
364
03e0a7df
WN
365static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
366{
367 struct perf_event_attr *attr = &evsel->attr;
368
369 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
370 (attr->type == PERF_TYPE_SOFTWARE);
371}
372
0698aedd
ACM
373struct perf_attr_details {
374 bool freq;
375 bool verbose;
e35ef355 376 bool event_group;
9e3b6ec1 377 bool force;
775d8a1b 378 bool trace_fields;
0698aedd
ACM
379};
380
381int perf_evsel__fprintf(struct perf_evsel *evsel,
382 struct perf_attr_details *details, FILE *fp);
c0a54341
ACM
383
384bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
385 char *msg, size_t msgsize);
602ad878 386int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 387 int err, char *msg, size_t size);
97f63e4a
NK
388
389static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
390{
391 return evsel->idx - evsel->leader->idx;
392}
717e263f
NK
393
394#define for_each_group_member(_evsel, _leader) \
395for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
396 (_evsel) && (_evsel)->leader == (_leader); \
397 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
398
384b6055
KL
399static inline bool has_branch_callstack(struct perf_evsel *evsel)
400{
401 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
402}
2c5e8c52
PZ
403
404typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
405
406int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
407 attr__fprintf_f attr__fprintf, void *priv);
408
69aad6f1 409#endif /* __PERF_EVSEL_H */
This page took 0.244322 seconds and 5 git commands to generate.