]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - tools/perf/util/evsel.h
Merge tag 'xfs-4.13-fixes-2' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[mirror_ubuntu-bionic-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"
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,
792d48b4 47 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
626a6b78 48 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
dd60fba7 49 PERF_EVSEL__CONFIG_TERM_DRV_CFG,
ac12f676 50 PERF_EVSEL__CONFIG_TERM_BRANCH,
930a2e29
JO
51 PERF_EVSEL__CONFIG_TERM_MAX,
52};
53
54struct perf_evsel_config_term {
55 struct list_head list;
56 int type;
57 union {
58 u64 period;
09af2a55 59 u64 freq;
32067712 60 bool time;
d457c963 61 char *callgraph;
dd60fba7 62 char *drv_cfg;
d457c963 63 u64 stack_user;
792d48b4 64 int max_stack;
374ce938 65 bool inherit;
626a6b78 66 bool overwrite;
ac12f676 67 char *branch;
930a2e29
JO
68 } val;
69};
70
f0c55bcf
SE
71/** struct perf_evsel - event selector
72 *
d49e4695
ACM
73 * @evlist - evlist this evsel is in, if it is in one.
74 * @node - To insert it into evlist->entries or in other list_heads, say in
75 * the event parsing routines.
f0c55bcf
SE
76 * @name - Can be set to retain the original event name passed by the user,
77 * so that when showing results in tools such as 'perf stat', we
78 * show the name used, not some alias.
75562573
AH
79 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
80 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
81 * struct sample_event
82 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
83 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
84 * is used there is an id sample appended to non-sample events
0db15b1e 85 * @priv: And what is in its containing unnamed union are tool specific
f0c55bcf 86 */
69aad6f1
ACM
87struct perf_evsel {
88 struct list_head node;
d49e4695 89 struct perf_evlist *evlist;
69aad6f1
ACM
90 struct perf_event_attr attr;
91 char *filter;
92 struct xyarray *fd;
a91e5431
ACM
93 struct xyarray *sample_id;
94 u64 *id;
c52b12ed 95 struct perf_counts *counts;
c7a79c47 96 struct perf_counts *prev_raw_counts;
69aad6f1 97 int idx;
f4d83436 98 u32 ids;
f0c55bcf 99 char *name;
410136f5
SE
100 double scale;
101 const char *unit;
fcf65bf1 102 struct event_format *tp_format;
af339981 103 off_t id_offset;
616df645
CP
104 void *priv;
105 u64 db_id;
023695d9 106 struct cgroup_sel *cgrp;
744a9719 107 void *handler;
7ae92e74 108 struct cpu_map *cpus;
fce4d296 109 struct cpu_map *own_cpus;
578e91ec 110 struct thread_map *threads;
bde09467 111 unsigned int sample_size;
75562573
AH
112 int id_pos;
113 int is_pos;
86066064 114 bool snapshot;
2cee77c4 115 bool supported;
0807d2d8 116 bool needs_swap;
6ff1ce76 117 bool no_aux_samples;
2afd2bcf 118 bool immediate;
bf8e8f4b 119 bool system_wide;
60b0896c 120 bool tracking;
044330c1 121 bool per_pkg;
7f94af7a 122 bool precise_max;
a359c17a 123 bool ignore_missing_thread;
f5b1135b
JO
124 /* parse modifier helper */
125 int exclude_GH;
97f63e4a 126 int nr_members;
3c176311 127 int sample_read;
86066064 128 unsigned long *per_pkg_mask;
6a4bb04c
JO
129 struct perf_evsel *leader;
130 char *group_name;
15bfd2cc 131 bool cmdline_group_boundary;
930a2e29 132 struct list_head config_terms;
1f45b1d4 133 int bpf_fd;
430daf2d 134 bool merged_stat;
37932c18 135 const char * metric_expr;
96284814 136 const char * metric_name;
37932c18
AK
137 struct perf_evsel **metric_events;
138 bool collect_stat;
69aad6f1
ACM
139};
140
88080ce7
BP
141union u64_swap {
142 u64 val64;
143 u32 val32[2];
144};
145
86bd5e86 146struct cpu_map;
80b2210c 147struct target;
86bd5e86 148struct thread_map;
b4006796 149struct record_opts;
86bd5e86 150
a22e99cd
JO
151static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
152{
153 return evsel->cpus;
154}
155
156static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
157{
158 return perf_evsel__cpus(evsel)->nr;
159}
160
13112bbf
JO
161void perf_counts_values__scale(struct perf_counts_values *count,
162 bool scale, s8 *pscaled);
163
a6fa0038 164void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
857a94a2
JO
165 struct perf_counts_values *count);
166
ce8ccff5
ACM
167int perf_evsel__object_config(size_t object_size,
168 int (*init)(struct perf_evsel *evsel),
169 void (*fini)(struct perf_evsel *evsel));
170
ef503831
ACM
171struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
172
173static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
174{
175 return perf_evsel__new_idx(attr, 0);
176}
177
178struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
179
8dd2a131
JO
180/*
181 * Returns pointer with encoded error via <linux/err.h> interface.
182 */
ef503831
ACM
183static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
184{
185 return perf_evsel__newtp_idx(sys, name, 0);
186}
201b7334 187
7c48dcfd
ACM
188struct perf_evsel *perf_evsel__new_cycles(void);
189
201b7334
ACM
190struct event_format *event_format__new(const char *sys, const char *name);
191
ef1d1af2
ACM
192void perf_evsel__init(struct perf_evsel *evsel,
193 struct perf_event_attr *attr, int idx);
194void perf_evsel__exit(struct perf_evsel *evsel);
69aad6f1
ACM
195void perf_evsel__delete(struct perf_evsel *evsel);
196
e68ae9cf
ACM
197struct callchain_param;
198
0f82ebc4 199void perf_evsel__config(struct perf_evsel *evsel,
e68ae9cf
ACM
200 struct record_opts *opts,
201 struct callchain_param *callchain);
01e0d50c
ACM
202void perf_evsel__config_callchain(struct perf_evsel *evsel,
203 struct record_opts *opts,
204 struct callchain_param *callchain);
0f82ebc4 205
75562573
AH
206int __perf_evsel__sample_size(u64 sample_type);
207void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
208
0b668bc9
ACM
209bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
210
211#define PERF_EVSEL__MAX_ALIASES 8
212
213extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
214 [PERF_EVSEL__MAX_ALIASES];
215extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
216 [PERF_EVSEL__MAX_ALIASES];
8ad7013b
ACM
217extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
218 [PERF_EVSEL__MAX_ALIASES];
219extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
220extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
0b668bc9
ACM
221int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
222 char *bf, size_t size);
7289f83c 223const char *perf_evsel__name(struct perf_evsel *evsel);
410136f5 224
717e263f
NK
225const char *perf_evsel__group_name(struct perf_evsel *evsel);
226int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
c410431c 227
70db7533 228int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
c52b12ed 229void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
69aad6f1 230
7be5ebe8
ACM
231void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
232 enum perf_event_sample_format bit);
233void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
234 enum perf_event_sample_format bit);
235
236#define perf_evsel__set_sample_bit(evsel, bit) \
237 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
238
239#define perf_evsel__reset_sample_bit(evsel, bit) \
240 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
241
75562573
AH
242void perf_evsel__set_sample_id(struct perf_evsel *evsel,
243 bool use_sample_identifier);
7a5a5ca5 244
12467ae4 245int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
3541c034 246int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
1e857484
MP
247int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
248 const char *filter);
f47805a2
ACM
249int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
250 const char *filter);
5cd95fc3 251int perf_evsel__enable(struct perf_evsel *evsel);
e98a4cbb 252int perf_evsel__disable(struct perf_evsel *evsel);
745cefc5 253
f08199d3 254int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
6a4bb04c 255 struct cpu_map *cpus);
f08199d3 256int perf_evsel__open_per_thread(struct perf_evsel *evsel,
6a4bb04c 257 struct thread_map *threads);
f08199d3 258int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
6a4bb04c 259 struct thread_map *threads);
727ab04e 260void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
48290609 261
5555ded4
ACM
262struct perf_sample;
263
5d2074ea 264void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
5555ded4
ACM
265 const char *name);
266u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
267 const char *name);
268
5d2074ea
ACM
269static inline char *perf_evsel__strval(struct perf_evsel *evsel,
270 struct perf_sample *sample,
271 const char *name)
272{
273 return perf_evsel__rawptr(evsel, sample, name);
274}
275
efd2b924
ACM
276struct format_field;
277
90525176
ACM
278u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
279
efd2b924
ACM
280struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
281
daec78a0
ACM
282#define perf_evsel__match(evsel, t, c) \
283 (evsel->attr.type == PERF_TYPE_##t && \
284 evsel->attr.config == PERF_COUNT_##c)
285
863e451f
JO
286static inline bool perf_evsel__match2(struct perf_evsel *e1,
287 struct perf_evsel *e2)
288{
289 return (e1->attr.type == e2->attr.type) &&
290 (e1->attr.config == e2->attr.config);
291}
292
4cabc3d1
AK
293#define perf_evsel__cmp(a, b) \
294 ((a) && \
295 (b) && \
296 (a)->attr.type == (b)->attr.type && \
297 (a)->attr.config == (b)->attr.config)
298
f99f4719
JO
299int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
300 struct perf_counts_values *count);
301
c52b12ed
ACM
302int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
303 int cpu, int thread, bool scale);
304
305/**
306 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
307 *
308 * @evsel - event selector to read value
309 * @cpu - CPU of interest
310 * @thread - thread of interest
311 */
312static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
313 int cpu, int thread)
314{
315 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
316}
317
318/**
319 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
320 *
321 * @evsel - event selector to read value
322 * @cpu - CPU of interest
323 * @thread - thread of interest
324 */
325static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
326 int cpu, int thread)
327{
328 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
329}
330
a3f698fe 331int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
0807d2d8 332 struct perf_sample *sample);
0c21f736
ACM
333
334static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
335{
336 return list_entry(evsel->node.next, struct perf_evsel, node);
337}
07ac002f 338
d87fcb4a
ACM
339static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
340{
341 return list_entry(evsel->node.prev, struct perf_evsel, node);
342}
343
759ff497
NK
344/**
345 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
346 *
347 * @evsel - evsel selector to be tested
348 *
349 * Return %true if @evsel is a group leader or a stand-alone event
350 */
823254ed 351static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
07ac002f 352{
823254ed 353 return evsel->leader == evsel;
07ac002f 354}
0698aedd 355
759ff497
NK
356/**
357 * perf_evsel__is_group_event - Return whether given evsel is a group event
358 *
359 * @evsel - evsel selector to be tested
360 *
361 * Return %true iff event group view is enabled and @evsel is a actual group
362 * leader which has other members in the group
363 */
364static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
365{
366 if (!symbol_conf.event_group)
367 return false;
368
369 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
370}
371
5496bc0c 372bool perf_evsel__is_function_event(struct perf_evsel *evsel);
6bedfab6 373
03e0a7df
WN
374static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
375{
376 struct perf_event_attr *attr = &evsel->attr;
377
378 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
379 (attr->type == PERF_TYPE_SOFTWARE);
380}
381
0698aedd
ACM
382struct perf_attr_details {
383 bool freq;
384 bool verbose;
e35ef355 385 bool event_group;
9e3b6ec1 386 bool force;
775d8a1b 387 bool trace_fields;
0698aedd
ACM
388};
389
390int perf_evsel__fprintf(struct perf_evsel *evsel,
391 struct perf_attr_details *details, FILE *fp);
c0a54341 392
e20ab86e
ACM
393#define EVSEL__PRINT_IP (1<<0)
394#define EVSEL__PRINT_SYM (1<<1)
395#define EVSEL__PRINT_DSO (1<<2)
396#define EVSEL__PRINT_SYMOFFSET (1<<3)
397#define EVSEL__PRINT_ONELINE (1<<4)
398#define EVSEL__PRINT_SRCLINE (1<<5)
399#define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
69b7e480 400#define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
2d9bbf6e 401#define EVSEL__PRINT_SKIP_IGNORED (1<<8)
e20ab86e 402
6f736735
ACM
403struct callchain_cursor;
404
d327e60c
ACM
405int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
406 unsigned int print_opts,
6f736735
ACM
407 struct callchain_cursor *cursor, FILE *fp);
408
409int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
410 int left_alignment, unsigned int print_opts,
411 struct callchain_cursor *cursor, FILE *fp);
e20ab86e 412
c0a54341
ACM
413bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
414 char *msg, size_t msgsize);
602ad878 415int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
56e52e85 416 int err, char *msg, size_t size);
97f63e4a
NK
417
418static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
419{
420 return evsel->idx - evsel->leader->idx;
421}
717e263f
NK
422
423#define for_each_group_member(_evsel, _leader) \
424for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
425 (_evsel) && (_evsel)->leader == (_leader); \
426 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
427
acf2abbd 428static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
384b6055
KL
429{
430 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
431}
2c5e8c52
PZ
432
433typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
434
435int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
436 attr__fprintf_f attr__fprintf, void *priv);
437
f4e47f9f
RB
438char *perf_evsel__env_arch(struct perf_evsel *evsel);
439
69aad6f1 440#endif /* __PERF_EVSEL_H */