Merge tag 'arm64-perf' of git://git.kernel.org/pub/scm/linux/kernel/git/arm64/linux
[linux-2.6-block.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
e68ae9cf
ACM
181struct callchain_param;
182
0f82ebc4 183void perf_evsel__config(struct perf_evsel *evsel,
e68ae9cf
ACM
184 struct record_opts *opts,
185 struct callchain_param *callchain);
01e0d50c
ACM
186void perf_evsel__config_callchain(struct perf_evsel *evsel,
187 struct record_opts *opts,
188 struct callchain_param *callchain);
0f82ebc4 189
75562573
AH
190int __perf_evsel__sample_size(u64 sample_type);
191void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
192
0b668bc9
ACM
193bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
194
195#define PERF_EVSEL__MAX_ALIASES 8
196
197extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
198 [PERF_EVSEL__MAX_ALIASES];
199extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
200 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
201extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
202 [PERF_EVSEL__MAX_ALIASES];
203extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
204extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
205int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
206 char *bf, size_t size);
7289f83c 207const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 208
717e263f
NK
209const char *perf_evsel__group_name(struct perf_evsel *evsel);
210int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 211
70db7533 212int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 213void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 214
7be5ebe8
ACM
215void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
216 enum perf_event_sample_format bit);
217void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
218 enum perf_event_sample_format bit);
219
220#define perf_evsel__set_sample_bit(evsel, bit) \
221 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
222
223#define perf_evsel__reset_sample_bit(evsel, bit) \
224 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
225
75562573
AH
226void perf_evsel__set_sample_id(struct perf_evsel *evsel,
227 bool use_sample_identifier);
7a5a5ca5 228
12467ae4 229int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
64ec84f5
ACM
230int perf_evsel__append_filter(struct perf_evsel *evsel,
231 const char *op, const char *filter);
f47805a2
ACM
232int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
233 const char *filter);
5cd95fc3 234int perf_evsel__enable(struct perf_evsel *evsel);
e98a4cbb 235int perf_evsel__disable(struct perf_evsel *evsel);
745cefc5 236
f08199d3 237int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 238 struct cpu_map *cpus);
f08199d3 239int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 240 struct thread_map *threads);
f08199d3 241int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 242 struct thread_map *threads);
727ab04e 243void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 244
5555ded4
ACM
245struct perf_sample;
246
5d2074ea 247void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
248 const char *name);
249u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
250 const char *name);
251
5d2074ea
ACM
252static inline char *perf_evsel__strval(struct perf_evsel *evsel,
253 struct perf_sample *sample,
254 const char *name)
255{
256 return perf_evsel__rawptr(evsel, sample, name);
257}
258
efd2b924
ACM
259struct format_field;
260
261struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
262
daec78a0
ACM
263#define perf_evsel__match(evsel, t, c) \
264 (evsel->attr.type == PERF_TYPE_##t && \
265 evsel->attr.config == PERF_COUNT_##c)
266
863e451f
JO
267static inline bool perf_evsel__match2(struct perf_evsel *e1,
268 struct perf_evsel *e2)
269{
270 return (e1->attr.type == e2->attr.type) &&
271 (e1->attr.config == e2->attr.config);
272}
273
4cabc3d1
AK
274#define perf_evsel__cmp(a, b) \
275 ((a) && \
276 (b) && \
277 (a)->attr.type == (b)->attr.type && \
278 (a)->attr.config == (b)->attr.config)
279
f99f4719
JO
280int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
281 struct perf_counts_values *count);
282
c52b12ed
ACM
283int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
284 int cpu, int thread, bool scale);
285
286/**
287 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
288 *
289 * @evsel - event selector to read value
290 * @cpu - CPU of interest
291 * @thread - thread of interest
292 */
293static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
294 int cpu, int thread)
295{
296 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
297}
298
299/**
300 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
301 *
302 * @evsel - event selector to read value
303 * @cpu - CPU of interest
304 * @thread - thread of interest
305 */
306static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
307 int cpu, int thread)
308{
309 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
310}
311
a3f698fe 312int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 313 struct perf_sample *sample);
0c21f736
ACM
314
315static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
316{
317 return list_entry(evsel->node.next, struct perf_evsel, node);
318}
07ac002f 319
d87fcb4a
ACM
320static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
321{
322 return list_entry(evsel->node.prev, struct perf_evsel, node);
323}
324
759ff497
NK
325/**
326 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
327 *
328 * @evsel - evsel selector to be tested
329 *
330 * Return %true if @evsel is a group leader or a stand-alone event
331 */
823254ed 332static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 333{
823254ed 334 return evsel->leader == evsel;
07ac002f 335}
0698aedd 336
759ff497
NK
337/**
338 * perf_evsel__is_group_event - Return whether given evsel is a group event
339 *
340 * @evsel - evsel selector to be tested
341 *
342 * Return %true iff event group view is enabled and @evsel is a actual group
343 * leader which has other members in the group
344 */
345static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
346{
347 if (!symbol_conf.event_group)
348 return false;
349
350 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
351}
352
6bedfab6
JO
353/**
354 * perf_evsel__is_function_event - Return whether given evsel is a function
355 * trace event
356 *
357 * @evsel - evsel selector to be tested
358 *
359 * Return %true if event is function trace event
360 */
361static inline bool perf_evsel__is_function_event(struct perf_evsel *evsel)
362{
363#define FUNCTION_EVENT "ftrace:function"
364
365 return evsel->name &&
366 !strncmp(FUNCTION_EVENT, evsel->name, sizeof(FUNCTION_EVENT));
367
368#undef FUNCTION_EVENT
369}
370
03e0a7df
WN
371static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
372{
373 struct perf_event_attr *attr = &evsel->attr;
374
375 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
376 (attr->type == PERF_TYPE_SOFTWARE);
377}
378
0698aedd
ACM
379struct perf_attr_details {
380 bool freq;
381 bool verbose;
e35ef355 382 bool event_group;
9e3b6ec1 383 bool force;
775d8a1b 384 bool trace_fields;
0698aedd
ACM
385};
386
387int perf_evsel__fprintf(struct perf_evsel *evsel,
388 struct perf_attr_details *details, FILE *fp);
c0a54341 389
e20ab86e
ACM
390#define EVSEL__PRINT_IP (1<<0)
391#define EVSEL__PRINT_SYM (1<<1)
392#define EVSEL__PRINT_DSO (1<<2)
393#define EVSEL__PRINT_SYMOFFSET (1<<3)
394#define EVSEL__PRINT_ONELINE (1<<4)
395#define EVSEL__PRINT_SRCLINE (1<<5)
396#define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
397
6f736735
ACM
398struct callchain_cursor;
399
d327e60c
ACM
400int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
401 unsigned int print_opts,
6f736735
ACM
402 struct callchain_cursor *cursor, FILE *fp);
403
404int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
405 int left_alignment, unsigned int print_opts,
406 struct callchain_cursor *cursor, FILE *fp);
e20ab86e 407
c0a54341
ACM
408bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
409 char *msg, size_t msgsize);
602ad878 410int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 411 int err, char *msg, size_t size);
97f63e4a
NK
412
413static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
414{
415 return evsel->idx - evsel->leader->idx;
416}
717e263f
NK
417
418#define for_each_group_member(_evsel, _leader) \
419for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
420 (_evsel) && (_evsel)->leader == (_leader); \
421 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
422
acf2abbd 423static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
384b6055
KL
424{
425 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
426}
2c5e8c52
PZ
427
428typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
429
430int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
431 attr__fprintf_f attr__fprintf, void *priv);
432
69aad6f1 433#endif /* __PERF_EVSEL_H */