Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_EVSEL_H
3#define __PERF_EVSEL_H 1
4
5#include <linux/list.h>
6#include <stdbool.h>
7#include <stddef.h>
8#include <linux/perf_event.h>
9#include <linux/types.h>
10#include "xyarray.h"
11#include "symbol.h"
12#include "cpumap.h"
13#include "counts.h"
14
15struct perf_evsel;
16
17/*
18 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
19 * more than one entry in the evlist.
20 */
21struct perf_sample_id {
22 struct hlist_node node;
23 u64 id;
24 struct perf_evsel *evsel;
25 int idx;
26 int cpu;
27 pid_t tid;
28
29 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
30 u64 period;
31};
32
33struct cgroup;
34
35/*
36 * The 'struct perf_evsel_config_term' is used to pass event
37 * specific configuration data to perf_evsel__config routine.
38 * It is allocated within event parsing and attached to
39 * perf_evsel::config_terms list head.
40*/
41enum term_type {
42 PERF_EVSEL__CONFIG_TERM_PERIOD,
43 PERF_EVSEL__CONFIG_TERM_FREQ,
44 PERF_EVSEL__CONFIG_TERM_TIME,
45 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
46 PERF_EVSEL__CONFIG_TERM_STACK_USER,
47 PERF_EVSEL__CONFIG_TERM_INHERIT,
48 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
49 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
50 PERF_EVSEL__CONFIG_TERM_DRV_CFG,
51 PERF_EVSEL__CONFIG_TERM_BRANCH,
52};
53
54struct perf_evsel_config_term {
55 struct list_head list;
56 enum term_type type;
57 union {
58 u64 period;
59 u64 freq;
60 bool time;
61 char *callgraph;
62 char *drv_cfg;
63 u64 stack_user;
64 int max_stack;
65 bool inherit;
66 bool overwrite;
67 char *branch;
68 } val;
69 bool weak;
70};
71
72struct perf_stat_evsel;
73
74/** struct perf_evsel - event selector
75 *
76 * @evlist - evlist this evsel is in, if it is in one.
77 * @node - To insert it into evlist->entries or in other list_heads, say in
78 * the event parsing routines.
79 * @name - Can be set to retain the original event name passed by the user,
80 * so that when showing results in tools such as 'perf stat', we
81 * show the name used, not some alias.
82 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
83 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
84 * struct sample_event
85 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
86 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
87 * is used there is an id sample appended to non-sample events
88 * @priv: And what is in its containing unnamed union are tool specific
89 */
90struct perf_evsel {
91 struct list_head node;
92 struct perf_evlist *evlist;
93 struct perf_event_attr attr;
94 char *filter;
95 struct xyarray *fd;
96 struct xyarray *sample_id;
97 u64 *id;
98 struct perf_counts *counts;
99 struct perf_counts *prev_raw_counts;
100 int idx;
101 u32 ids;
102 char *name;
103 double scale;
104 const char *unit;
105 struct event_format *tp_format;
106 off_t id_offset;
107 struct perf_stat_evsel *stats;
108 void *priv;
109 u64 db_id;
110 struct cgroup *cgrp;
111 void *handler;
112 struct cpu_map *cpus;
113 struct cpu_map *own_cpus;
114 struct thread_map *threads;
115 unsigned int sample_size;
116 int id_pos;
117 int is_pos;
118 bool uniquified_name;
119 bool snapshot;
120 bool supported;
121 bool needs_swap;
122 bool no_aux_samples;
123 bool immediate;
124 bool system_wide;
125 bool tracking;
126 bool per_pkg;
127 bool precise_max;
128 bool ignore_missing_thread;
129 bool forced_leader;
130 bool use_uncore_alias;
131 /* parse modifier helper */
132 int exclude_GH;
133 int nr_members;
134 int sample_read;
135 unsigned long *per_pkg_mask;
136 struct perf_evsel *leader;
137 char *group_name;
138 bool cmdline_group_boundary;
139 struct list_head config_terms;
140 int bpf_fd;
141 bool auto_merge_stats;
142 bool merged_stat;
143 const char * metric_expr;
144 const char * metric_name;
145 struct perf_evsel **metric_events;
146 bool collect_stat;
147 bool weak_group;
148 const char *pmu_name;
149};
150
151union u64_swap {
152 u64 val64;
153 u32 val32[2];
154};
155
156struct perf_missing_features {
157 bool sample_id_all;
158 bool exclude_guest;
159 bool mmap2;
160 bool cloexec;
161 bool clockid;
162 bool clockid_wrong;
163 bool lbr_flags;
164 bool write_backward;
165 bool group_read;
166};
167
168extern struct perf_missing_features perf_missing_features;
169
170struct cpu_map;
171struct target;
172struct thread_map;
173struct record_opts;
174
175static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
176{
177 return evsel->cpus;
178}
179
180static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
181{
182 return perf_evsel__cpus(evsel)->nr;
183}
184
185void perf_counts_values__scale(struct perf_counts_values *count,
186 bool scale, s8 *pscaled);
187
188void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
189 struct perf_counts_values *count);
190
191int perf_evsel__object_config(size_t object_size,
192 int (*init)(struct perf_evsel *evsel),
193 void (*fini)(struct perf_evsel *evsel));
194
195struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
196
197static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
198{
199 return perf_evsel__new_idx(attr, 0);
200}
201
202struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
203
204/*
205 * Returns pointer with encoded error via <linux/err.h> interface.
206 */
207static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
208{
209 return perf_evsel__newtp_idx(sys, name, 0);
210}
211
212struct perf_evsel *perf_evsel__new_cycles(bool precise);
213
214struct event_format *event_format__new(const char *sys, const char *name);
215
216void perf_evsel__init(struct perf_evsel *evsel,
217 struct perf_event_attr *attr, int idx);
218void perf_evsel__exit(struct perf_evsel *evsel);
219void perf_evsel__delete(struct perf_evsel *evsel);
220
221struct callchain_param;
222
223void perf_evsel__config(struct perf_evsel *evsel,
224 struct record_opts *opts,
225 struct callchain_param *callchain);
226void perf_evsel__config_callchain(struct perf_evsel *evsel,
227 struct record_opts *opts,
228 struct callchain_param *callchain);
229
230int __perf_evsel__sample_size(u64 sample_type);
231void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
232
233bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
234
235#define PERF_EVSEL__MAX_ALIASES 8
236
237extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
238 [PERF_EVSEL__MAX_ALIASES];
239extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
240 [PERF_EVSEL__MAX_ALIASES];
241extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
242 [PERF_EVSEL__MAX_ALIASES];
243extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
244extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
245int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
246 char *bf, size_t size);
247const char *perf_evsel__name(struct perf_evsel *evsel);
248
249const char *perf_evsel__group_name(struct perf_evsel *evsel);
250int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
251
252int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
253void perf_evsel__close_fd(struct perf_evsel *evsel);
254
255void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
256 enum perf_event_sample_format bit);
257void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
258 enum perf_event_sample_format bit);
259
260#define perf_evsel__set_sample_bit(evsel, bit) \
261 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
262
263#define perf_evsel__reset_sample_bit(evsel, bit) \
264 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
265
266void perf_evsel__set_sample_id(struct perf_evsel *evsel,
267 bool use_sample_identifier);
268
269int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
270int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
271int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
272 const char *filter);
273int perf_evsel__apply_filter(struct perf_evsel *evsel, const char *filter);
274int perf_evsel__enable(struct perf_evsel *evsel);
275int perf_evsel__disable(struct perf_evsel *evsel);
276
277int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
278 struct cpu_map *cpus);
279int perf_evsel__open_per_thread(struct perf_evsel *evsel,
280 struct thread_map *threads);
281int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
282 struct thread_map *threads);
283void perf_evsel__close(struct perf_evsel *evsel);
284
285struct perf_sample;
286
287void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
288 const char *name);
289u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
290 const char *name);
291
292static inline char *perf_evsel__strval(struct perf_evsel *evsel,
293 struct perf_sample *sample,
294 const char *name)
295{
296 return perf_evsel__rawptr(evsel, sample, name);
297}
298
299struct format_field;
300
301u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
302
303struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
304
305#define perf_evsel__match(evsel, t, c) \
306 (evsel->attr.type == PERF_TYPE_##t && \
307 evsel->attr.config == PERF_COUNT_##c)
308
309static inline bool perf_evsel__match2(struct perf_evsel *e1,
310 struct perf_evsel *e2)
311{
312 return (e1->attr.type == e2->attr.type) &&
313 (e1->attr.config == e2->attr.config);
314}
315
316#define perf_evsel__cmp(a, b) \
317 ((a) && \
318 (b) && \
319 (a)->attr.type == (b)->attr.type && \
320 (a)->attr.config == (b)->attr.config)
321
322int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
323 struct perf_counts_values *count);
324
325int perf_evsel__read_counter(struct perf_evsel *evsel, int cpu, int thread);
326
327int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
328 int cpu, int thread, bool scale);
329
330/**
331 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
332 *
333 * @evsel - event selector to read value
334 * @cpu - CPU of interest
335 * @thread - thread of interest
336 */
337static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
338 int cpu, int thread)
339{
340 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
341}
342
343/**
344 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
345 *
346 * @evsel - event selector to read value
347 * @cpu - CPU of interest
348 * @thread - thread of interest
349 */
350static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
351 int cpu, int thread)
352{
353 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
354}
355
356int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
357 struct perf_sample *sample);
358
359int perf_evsel__parse_sample_timestamp(struct perf_evsel *evsel,
360 union perf_event *event,
361 u64 *timestamp);
362
363static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
364{
365 return list_entry(evsel->node.next, struct perf_evsel, node);
366}
367
368static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
369{
370 return list_entry(evsel->node.prev, struct perf_evsel, node);
371}
372
373/**
374 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
375 *
376 * @evsel - evsel selector to be tested
377 *
378 * Return %true if @evsel is a group leader or a stand-alone event
379 */
380static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
381{
382 return evsel->leader == evsel;
383}
384
385/**
386 * perf_evsel__is_group_event - Return whether given evsel is a group event
387 *
388 * @evsel - evsel selector to be tested
389 *
390 * Return %true iff event group view is enabled and @evsel is a actual group
391 * leader which has other members in the group
392 */
393static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
394{
395 if (!symbol_conf.event_group)
396 return false;
397
398 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
399}
400
401bool perf_evsel__is_function_event(struct perf_evsel *evsel);
402
403static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
404{
405 struct perf_event_attr *attr = &evsel->attr;
406
407 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
408 (attr->type == PERF_TYPE_SOFTWARE);
409}
410
411struct perf_attr_details {
412 bool freq;
413 bool verbose;
414 bool event_group;
415 bool force;
416 bool trace_fields;
417};
418
419int perf_evsel__fprintf(struct perf_evsel *evsel,
420 struct perf_attr_details *details, FILE *fp);
421
422#define EVSEL__PRINT_IP (1<<0)
423#define EVSEL__PRINT_SYM (1<<1)
424#define EVSEL__PRINT_DSO (1<<2)
425#define EVSEL__PRINT_SYMOFFSET (1<<3)
426#define EVSEL__PRINT_ONELINE (1<<4)
427#define EVSEL__PRINT_SRCLINE (1<<5)
428#define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
429#define EVSEL__PRINT_CALLCHAIN_ARROW (1<<7)
430#define EVSEL__PRINT_SKIP_IGNORED (1<<8)
431
432struct callchain_cursor;
433
434int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
435 unsigned int print_opts,
436 struct callchain_cursor *cursor, FILE *fp);
437
438int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
439 int left_alignment, unsigned int print_opts,
440 struct callchain_cursor *cursor, FILE *fp);
441
442bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
443 char *msg, size_t msgsize);
444int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
445 int err, char *msg, size_t size);
446
447static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
448{
449 return evsel->idx - evsel->leader->idx;
450}
451
452#define for_each_group_member(_evsel, _leader) \
453for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
454 (_evsel) && (_evsel)->leader == (_leader); \
455 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
456
457static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
458{
459 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
460}
461
462typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
463
464int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
465 attr__fprintf_f attr__fprintf, void *priv);
466
467struct perf_env *perf_evsel__env(struct perf_evsel *evsel);
468
469#endif /* __PERF_EVSEL_H */
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __PERF_EVSEL_H
3#define __PERF_EVSEL_H 1
4
5#include <linux/list.h>
6#include <stdbool.h>
7#include <sys/types.h>
8#include <linux/perf_event.h>
9#include <linux/types.h>
10#include <internal/evsel.h>
11#include <perf/evsel.h>
12#include "symbol_conf.h"
13#include "pmus.h"
14#include "pmu.h"
15
16struct bpf_object;
17struct cgroup;
18struct perf_counts;
19struct perf_stat_evsel;
20union perf_event;
21struct bpf_counter_ops;
22struct target;
23struct hashmap;
24struct bperf_leader_bpf;
25struct bperf_follower_bpf;
26
27typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
28
29/** struct evsel - event selector
30 *
31 * @evlist - evlist this evsel is in, if it is in one.
32 * @core - libperf evsel object
33 * @name - Can be set to retain the original event name passed by the user,
34 * so that when showing results in tools such as 'perf stat', we
35 * show the name used, not some alias.
36 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
37 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
38 * struct perf_record_sample
39 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
40 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
41 * is used there is an id sample appended to non-sample events
42 * @priv: And what is in its containing unnamed union are tool specific
43 */
44struct evsel {
45 struct perf_evsel core;
46 struct evlist *evlist;
47 off_t id_offset;
48 int id_pos;
49 int is_pos;
50 unsigned int sample_size;
51
52 /*
53 * These fields can be set in the parse-events code or similar.
54 * Please check evsel__clone() to copy them properly so that
55 * they can be released properly.
56 */
57 struct {
58 char *name;
59 char *group_name;
60 const char *group_pmu_name;
61#ifdef HAVE_LIBTRACEEVENT
62 struct tep_event *tp_format;
63#endif
64 char *filter;
65 unsigned long max_events;
66 double scale;
67 const char *unit;
68 struct cgroup *cgrp;
69 const char *metric_id;
70 /* parse modifier helper */
71 int exclude_GH;
72 int sample_read;
73 bool snapshot;
74 bool per_pkg;
75 bool percore;
76 bool precise_max;
77 bool is_libpfm_event;
78 bool auto_merge_stats;
79 bool collect_stat;
80 bool weak_group;
81 bool bpf_counter;
82 bool use_config_name;
83 bool skippable;
84 bool retire_lat;
85 int bpf_fd;
86 struct bpf_object *bpf_obj;
87 struct list_head config_terms;
88 u64 alternate_hw_config;
89 };
90
91 /*
92 * metric fields are similar, but needs more care as they can have
93 * references to other metric (evsel).
94 */
95 struct evsel **metric_events;
96 struct evsel *metric_leader;
97
98 void *handler;
99 struct perf_counts *counts;
100 struct perf_counts *prev_raw_counts;
101 unsigned long nr_events_printed;
102 struct perf_stat_evsel *stats;
103 void *priv;
104 u64 db_id;
105 bool uniquified_name;
106 bool supported;
107 bool needs_swap;
108 bool disabled;
109 bool no_aux_samples;
110 bool immediate;
111 bool tracking;
112 bool ignore_missing_thread;
113 bool forced_leader;
114 bool cmdline_group_boundary;
115 bool merged_stat;
116 bool reset_group;
117 bool errored;
118 bool needs_auxtrace_mmap;
119 bool default_metricgroup; /* A member of the Default metricgroup */
120 struct hashmap *per_pkg_mask;
121 int err;
122 struct {
123 evsel__sb_cb_t *cb;
124 void *data;
125 } side_band;
126 /*
127 * For reporting purposes, an evsel sample can have a callchain
128 * synthesized from AUX area data. Keep track of synthesized sample
129 * types here. Note, the recorded sample_type cannot be changed because
130 * it is needed to continue to parse events.
131 * See also evsel__has_callchain().
132 */
133 __u64 synth_sample_type;
134
135 /*
136 * Store the branch counter related information.
137 * br_cntr_idx: The idx of the branch counter event in the evlist
138 * br_cntr_nr: The number of the branch counter event in the group
139 * (Only available for the leader event)
140 * abbr_name: The abbreviation name assigned to an event which is
141 * logged by the branch counter.
142 * The abbr name is from A to Z9. NA is applied if out
143 * of the range.
144 */
145 int br_cntr_idx;
146 int br_cntr_nr;
147 char abbr_name[3];
148
149 /*
150 * bpf_counter_ops serves two use cases:
151 * 1. perf-stat -b counting events used byBPF programs
152 * 2. perf-stat --use-bpf use BPF programs to aggregate counts
153 */
154 struct bpf_counter_ops *bpf_counter_ops;
155
156 struct list_head bpf_counter_list; /* for perf-stat -b */
157 struct list_head bpf_filters; /* for perf-record --filter */
158
159 /* for perf-stat --use-bpf */
160 int bperf_leader_prog_fd;
161 int bperf_leader_link_fd;
162 union {
163 struct bperf_leader_bpf *leader_skel;
164 struct bperf_follower_bpf *follower_skel;
165 void *bpf_skel;
166 };
167 unsigned long open_flags;
168 int precise_ip_original;
169
170 /* The PMU the event is from. Used for missing_features, PMU name, etc. */
171 struct perf_pmu *pmu;
172
173 /* For tool events */
174 /* Beginning time subtracted when the counter is read. */
175 union {
176 /* duration_time is a single global time. */
177 __u64 start_time;
178 /*
179 * user_time and system_time read an initial value potentially
180 * per-CPU or per-pid.
181 */
182 struct xyarray *start_times;
183 };
184 /* Is the tool's fd for /proc/pid/stat or /proc/stat. */
185 bool pid_stat;
186};
187
188struct perf_missing_features {
189 bool sample_id_all;
190 bool exclude_guest;
191 bool mmap2;
192 bool cloexec;
193 bool clockid;
194 bool clockid_wrong;
195 bool lbr_flags;
196 bool write_backward;
197 bool group_read;
198 bool ksymbol;
199 bool bpf;
200 bool aux_output;
201 bool branch_hw_idx;
202 bool cgroup;
203 bool data_page_size;
204 bool code_page_size;
205 bool weight_struct;
206 bool read_lost;
207 bool branch_counters;
208 bool inherit_sample_read;
209};
210
211extern struct perf_missing_features perf_missing_features;
212
213struct perf_cpu_map;
214struct thread_map;
215struct record_opts;
216
217static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
218{
219 return perf_evsel__cpus(&evsel->core);
220}
221
222static inline int evsel__nr_cpus(struct evsel *evsel)
223{
224 return perf_cpu_map__nr(evsel__cpus(evsel));
225}
226
227void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
228 struct perf_counts_values *count);
229
230int evsel__object_config(size_t object_size,
231 int (*init)(struct evsel *evsel),
232 void (*fini)(struct evsel *evsel));
233
234struct perf_pmu *evsel__find_pmu(const struct evsel *evsel);
235bool evsel__is_aux_event(const struct evsel *evsel);
236
237struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
238
239static inline struct evsel *evsel__new(struct perf_event_attr *attr)
240{
241 return evsel__new_idx(attr, 0);
242}
243
244struct evsel *evsel__clone(struct evsel *orig);
245
246int copy_config_terms(struct list_head *dst, struct list_head *src);
247void free_config_terms(struct list_head *config_terms);
248
249
250#ifdef HAVE_LIBTRACEEVENT
251struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, bool format);
252
253/*
254 * Returns pointer with encoded error via <linux/err.h> interface.
255 */
256static inline struct evsel *evsel__newtp(const char *sys, const char *name)
257{
258 return evsel__newtp_idx(sys, name, 0, true);
259}
260#endif
261
262#ifdef HAVE_LIBTRACEEVENT
263struct tep_event *event_format__new(const char *sys, const char *name);
264#endif
265
266void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
267void evsel__exit(struct evsel *evsel);
268void evsel__delete(struct evsel *evsel);
269
270struct callchain_param;
271
272void evsel__config(struct evsel *evsel, struct record_opts *opts,
273 struct callchain_param *callchain);
274void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
275 struct callchain_param *callchain);
276
277int __evsel__sample_size(u64 sample_type);
278void evsel__calc_id_pos(struct evsel *evsel);
279
280bool evsel__is_cache_op_valid(u8 type, u8 op);
281
282static inline bool evsel__is_bpf(struct evsel *evsel)
283{
284 return evsel->bpf_counter_ops != NULL;
285}
286
287static inline bool evsel__is_bperf(struct evsel *evsel)
288{
289 return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list);
290}
291
292#define EVSEL__MAX_ALIASES 8
293
294extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
295extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
296extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
297extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX];
298extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX];
299extern char *evsel__bpf_counter_events;
300bool evsel__match_bpf_counter_events(const char *name);
301int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);
302
303int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
304const char *evsel__name(struct evsel *evsel);
305bool evsel__name_is(struct evsel *evsel, const char *name);
306const char *evsel__metric_id(const struct evsel *evsel);
307
308static inline bool evsel__is_retire_lat(const struct evsel *evsel)
309{
310 return evsel->retire_lat;
311}
312
313const char *evsel__group_name(struct evsel *evsel);
314int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
315
316void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
317void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
318
319#define evsel__set_sample_bit(evsel, bit) \
320 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
321
322#define evsel__reset_sample_bit(evsel, bit) \
323 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
324
325void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
326
327void arch_evsel__set_sample_weight(struct evsel *evsel);
328void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);
329int arch_evsel__open_strerror(struct evsel *evsel, char *msg, size_t size);
330
331int evsel__set_filter(struct evsel *evsel, const char *filter);
332int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
333int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
334int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);
335int evsel__enable(struct evsel *evsel);
336int evsel__disable(struct evsel *evsel);
337int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);
338
339int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);
340int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
341int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
342 struct perf_thread_map *threads);
343void evsel__close(struct evsel *evsel);
344int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,
345 struct perf_thread_map *threads);
346
347bool evsel__precise_ip_fallback(struct evsel *evsel);
348
349struct perf_sample;
350
351#ifdef HAVE_LIBTRACEEVENT
352void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
353u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
354u64 evsel__intval_common(struct evsel *evsel, struct perf_sample *sample, const char *name);
355char evsel__taskstate(struct evsel *evsel, struct perf_sample *sample, const char *name);
356
357static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
358{
359 return evsel__rawptr(evsel, sample, name);
360}
361#endif
362
363struct tep_format_field;
364
365u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
366
367struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
368struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name);
369
370bool __evsel__match(const struct evsel *evsel, u32 type, u64 config);
371
372#define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c)
373
374int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);
375
376int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);
377
378/**
379 * evsel__read_on_cpu - Read out the results on a CPU and thread
380 *
381 * @evsel - event selector to read value
382 * @cpu_map_idx - CPU of interest
383 * @thread - thread of interest
384 */
385static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)
386{
387 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);
388}
389
390/**
391 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
392 *
393 * @evsel - event selector to read value
394 * @cpu_map_idx - CPU of interest
395 * @thread - thread of interest
396 */
397static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)
398{
399 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);
400}
401
402int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
403 struct perf_sample *sample);
404
405int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
406 u64 *timestamp);
407
408u16 evsel__id_hdr_size(const struct evsel *evsel);
409
410static inline struct evsel *evsel__next(struct evsel *evsel)
411{
412 return list_entry(evsel->core.node.next, struct evsel, core.node);
413}
414
415static inline struct evsel *evsel__prev(struct evsel *evsel)
416{
417 return list_entry(evsel->core.node.prev, struct evsel, core.node);
418}
419
420/**
421 * evsel__is_group_leader - Return whether given evsel is a leader event
422 *
423 * @evsel - evsel selector to be tested
424 *
425 * Return %true if @evsel is a group leader or a stand-alone event
426 */
427static inline bool evsel__is_group_leader(const struct evsel *evsel)
428{
429 return evsel->core.leader == &evsel->core;
430}
431
432/**
433 * evsel__is_group_event - Return whether given evsel is a group event
434 *
435 * @evsel - evsel selector to be tested
436 *
437 * Return %true iff event group view is enabled and @evsel is a actual group
438 * leader which has other members in the group
439 */
440static inline bool evsel__is_group_event(struct evsel *evsel)
441{
442 if (!symbol_conf.event_group)
443 return false;
444
445 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
446}
447
448bool evsel__is_function_event(struct evsel *evsel);
449
450static inline bool evsel__is_bpf_output(struct evsel *evsel)
451{
452 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
453}
454
455static inline bool evsel__is_clock(const struct evsel *evsel)
456{
457 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
458 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
459}
460
461bool evsel__fallback(struct evsel *evsel, struct target *target, int err,
462 char *msg, size_t msgsize);
463int evsel__open_strerror(struct evsel *evsel, struct target *target,
464 int err, char *msg, size_t size);
465
466static inline int evsel__group_idx(struct evsel *evsel)
467{
468 return evsel->core.idx - evsel->core.leader->idx;
469}
470
471/* Iterates group WITHOUT the leader. */
472#define for_each_group_member_head(_evsel, _leader, _head) \
473for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
474 (_evsel) && &(_evsel)->core.node != (_head) && \
475 (_evsel)->core.leader == &(_leader)->core; \
476 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
477
478#define for_each_group_member(_evsel, _leader) \
479 for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries)
480
481/* Iterates group WITH the leader. */
482#define for_each_group_evsel_head(_evsel, _leader, _head) \
483for ((_evsel) = _leader; \
484 (_evsel) && &(_evsel)->core.node != (_head) && \
485 (_evsel)->core.leader == &(_leader)->core; \
486 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
487
488#define for_each_group_evsel(_evsel, _leader) \
489 for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries)
490
491static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
492{
493 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
494}
495
496static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
497{
498 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
499}
500
501static inline bool evsel__has_callchain(const struct evsel *evsel)
502{
503 /*
504 * For reporting purposes, an evsel sample can have a recorded callchain
505 * or a callchain synthesized from AUX area data.
506 */
507 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
508 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
509}
510
511static inline bool evsel__has_br_stack(const struct evsel *evsel)
512{
513 /*
514 * For reporting purposes, an evsel sample can have a recorded branch
515 * stack or a branch stack synthesized from AUX area data.
516 */
517 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
518 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
519}
520
521static inline bool evsel__is_dummy_event(struct evsel *evsel)
522{
523 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
524 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
525}
526
527struct perf_env *evsel__env(struct evsel *evsel);
528
529int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
530
531void evsel__zero_per_pkg(struct evsel *evsel);
532bool evsel__is_hybrid(const struct evsel *evsel);
533struct evsel *evsel__leader(const struct evsel *evsel);
534bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
535bool evsel__is_leader(struct evsel *evsel);
536void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
537int evsel__source_count(const struct evsel *evsel);
538void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);
539
540bool arch_evsel__must_be_in_group(const struct evsel *evsel);
541
542/*
543 * Macro to swap the bit-field postition and size.
544 * Used when,
545 * - dont need to swap the entire u64 &&
546 * - when u64 has variable bit-field sizes &&
547 * - when presented in a host endian which is different
548 * than the source endian of the perf.data file
549 */
550#define bitfield_swap(src, pos, size) \
551 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1)))
552
553u64 evsel__bitfield_swap_branch_flags(u64 value);
554void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,
555 const char *config_name, u64 val);
556
557#endif /* __PERF_EVSEL_H */