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 <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
14struct bpf_object;
15struct cgroup;
16struct perf_counts;
17struct perf_stat_evsel;
18union perf_event;
19struct bpf_counter_ops;
20struct target;
21struct hashmap;
22struct bperf_leader_bpf;
23struct bperf_follower_bpf;
24struct perf_pmu;
25
26typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
27
28enum perf_tool_event {
29 PERF_TOOL_NONE = 0,
30 PERF_TOOL_DURATION_TIME = 1,
31 PERF_TOOL_USER_TIME = 2,
32 PERF_TOOL_SYSTEM_TIME = 3,
33
34 PERF_TOOL_MAX,
35};
36
37const char *perf_tool_event__to_str(enum perf_tool_event ev);
38enum perf_tool_event perf_tool_event__from_str(const char *str);
39
40#define perf_tool_event__for_each_event(ev) \
41 for ((ev) = PERF_TOOL_DURATION_TIME; (ev) < PERF_TOOL_MAX; ev++)
42
43/** struct evsel - event selector
44 *
45 * @evlist - evlist this evsel is in, if it is in one.
46 * @core - libperf evsel object
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.
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 perf_record_sample
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
56 * @priv: And what is in its containing unnamed union are tool specific
57 */
58struct evsel {
59 struct perf_evsel core;
60 struct evlist *evlist;
61 off_t id_offset;
62 int id_pos;
63 int is_pos;
64 unsigned int sample_size;
65
66 /*
67 * These fields can be set in the parse-events code or similar.
68 * Please check evsel__clone() to copy them properly so that
69 * they can be released properly.
70 */
71 struct {
72 char *name;
73 char *group_name;
74 const char *pmu_name;
75#ifdef HAVE_LIBTRACEEVENT
76 struct tep_event *tp_format;
77#endif
78 char *filter;
79 unsigned long max_events;
80 double scale;
81 const char *unit;
82 struct cgroup *cgrp;
83 const char *metric_id;
84 enum perf_tool_event tool_event;
85 /* parse modifier helper */
86 int exclude_GH;
87 int sample_read;
88 bool snapshot;
89 bool per_pkg;
90 bool percore;
91 bool precise_max;
92 bool use_uncore_alias;
93 bool is_libpfm_event;
94 bool auto_merge_stats;
95 bool collect_stat;
96 bool weak_group;
97 bool bpf_counter;
98 bool use_config_name;
99 int bpf_fd;
100 struct bpf_object *bpf_obj;
101 struct list_head config_terms;
102 };
103
104 /*
105 * metric fields are similar, but needs more care as they can have
106 * references to other metric (evsel).
107 */
108 const char * metric_expr;
109 const char * metric_name;
110 struct evsel **metric_events;
111 struct evsel *metric_leader;
112
113 void *handler;
114 struct perf_counts *counts;
115 struct perf_counts *prev_raw_counts;
116 unsigned long nr_events_printed;
117 struct perf_stat_evsel *stats;
118 void *priv;
119 u64 db_id;
120 bool uniquified_name;
121 bool supported;
122 bool needs_swap;
123 bool disabled;
124 bool no_aux_samples;
125 bool immediate;
126 bool tracking;
127 bool ignore_missing_thread;
128 bool forced_leader;
129 bool cmdline_group_boundary;
130 bool merged_stat;
131 bool reset_group;
132 bool errored;
133 bool needs_auxtrace_mmap;
134 struct hashmap *per_pkg_mask;
135 int err;
136 struct {
137 evsel__sb_cb_t *cb;
138 void *data;
139 } side_band;
140 /*
141 * For reporting purposes, an evsel sample can have a callchain
142 * synthesized from AUX area data. Keep track of synthesized sample
143 * types here. Note, the recorded sample_type cannot be changed because
144 * it is needed to continue to parse events.
145 * See also evsel__has_callchain().
146 */
147 __u64 synth_sample_type;
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 /* for perf-stat -b */
157 struct list_head bpf_counter_list;
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 };
166 unsigned long open_flags;
167 int precise_ip_original;
168
169 /* for missing_features */
170 struct perf_pmu *pmu;
171};
172
173struct perf_missing_features {
174 bool sample_id_all;
175 bool exclude_guest;
176 bool mmap2;
177 bool cloexec;
178 bool clockid;
179 bool clockid_wrong;
180 bool lbr_flags;
181 bool write_backward;
182 bool group_read;
183 bool ksymbol;
184 bool bpf;
185 bool aux_output;
186 bool branch_hw_idx;
187 bool cgroup;
188 bool data_page_size;
189 bool code_page_size;
190 bool weight_struct;
191 bool read_lost;
192};
193
194extern struct perf_missing_features perf_missing_features;
195
196struct perf_cpu_map;
197struct thread_map;
198struct record_opts;
199
200static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
201{
202 return perf_evsel__cpus(&evsel->core);
203}
204
205static inline int evsel__nr_cpus(struct evsel *evsel)
206{
207 return perf_cpu_map__nr(evsel__cpus(evsel));
208}
209
210void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
211 struct perf_counts_values *count);
212
213int evsel__object_config(size_t object_size,
214 int (*init)(struct evsel *evsel),
215 void (*fini)(struct evsel *evsel));
216
217struct perf_pmu *evsel__find_pmu(struct evsel *evsel);
218bool evsel__is_aux_event(struct evsel *evsel);
219
220struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
221
222static inline struct evsel *evsel__new(struct perf_event_attr *attr)
223{
224 return evsel__new_idx(attr, 0);
225}
226
227struct evsel *evsel__clone(struct evsel *orig);
228
229int copy_config_terms(struct list_head *dst, struct list_head *src);
230void free_config_terms(struct list_head *config_terms);
231
232
233#ifdef HAVE_LIBTRACEEVENT
234struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
235
236/*
237 * Returns pointer with encoded error via <linux/err.h> interface.
238 */
239static inline struct evsel *evsel__newtp(const char *sys, const char *name)
240{
241 return evsel__newtp_idx(sys, name, 0);
242}
243#endif
244
245struct evsel *evsel__new_cycles(bool precise, __u32 type, __u64 config);
246
247#ifdef HAVE_LIBTRACEEVENT
248struct tep_event *event_format__new(const char *sys, const char *name);
249#endif
250
251void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
252void evsel__exit(struct evsel *evsel);
253void evsel__delete(struct evsel *evsel);
254
255struct callchain_param;
256
257void evsel__config(struct evsel *evsel, struct record_opts *opts,
258 struct callchain_param *callchain);
259void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
260 struct callchain_param *callchain);
261
262int __evsel__sample_size(u64 sample_type);
263void evsel__calc_id_pos(struct evsel *evsel);
264
265bool evsel__is_cache_op_valid(u8 type, u8 op);
266
267static inline bool evsel__is_bpf(struct evsel *evsel)
268{
269 return evsel->bpf_counter_ops != NULL;
270}
271
272#define EVSEL__MAX_ALIASES 8
273
274extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
275extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
276extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
277extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX];
278extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX];
279extern char *evsel__bpf_counter_events;
280bool evsel__match_bpf_counter_events(const char *name);
281int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);
282
283int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
284const char *evsel__name(struct evsel *evsel);
285const char *evsel__metric_id(const struct evsel *evsel);
286
287static inline bool evsel__is_tool(const struct evsel *evsel)
288{
289 return evsel->tool_event != PERF_TOOL_NONE;
290}
291
292const char *evsel__group_name(struct evsel *evsel);
293int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
294
295void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
296void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
297
298#define evsel__set_sample_bit(evsel, bit) \
299 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
300
301#define evsel__reset_sample_bit(evsel, bit) \
302 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
303
304void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
305
306void arch_evsel__set_sample_weight(struct evsel *evsel);
307void arch_evsel__fixup_new_cycles(struct perf_event_attr *attr);
308void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);
309
310int evsel__set_filter(struct evsel *evsel, const char *filter);
311int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
312int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
313int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);
314int evsel__enable(struct evsel *evsel);
315int evsel__disable(struct evsel *evsel);
316int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);
317
318int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);
319int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
320int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
321 struct perf_thread_map *threads);
322void evsel__close(struct evsel *evsel);
323int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,
324 struct perf_thread_map *threads);
325bool evsel__detect_missing_features(struct evsel *evsel);
326
327enum rlimit_action { NO_CHANGE, SET_TO_MAX, INCREASED_MAX };
328bool evsel__increase_rlimit(enum rlimit_action *set_rlimit);
329
330bool evsel__precise_ip_fallback(struct evsel *evsel);
331
332struct perf_sample;
333
334#ifdef HAVE_LIBTRACEEVENT
335void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
336u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
337
338static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
339{
340 return evsel__rawptr(evsel, sample, name);
341}
342#endif
343
344struct tep_format_field;
345
346u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
347
348struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
349
350#define evsel__match(evsel, t, c) \
351 (evsel->core.attr.type == PERF_TYPE_##t && \
352 evsel->core.attr.config == PERF_COUNT_##c)
353
354static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
355{
356 return (e1->core.attr.type == e2->core.attr.type) &&
357 (e1->core.attr.config == e2->core.attr.config);
358}
359
360int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);
361
362int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);
363
364/**
365 * evsel__read_on_cpu - Read out the results on a CPU and thread
366 *
367 * @evsel - event selector to read value
368 * @cpu_map_idx - CPU of interest
369 * @thread - thread of interest
370 */
371static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)
372{
373 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);
374}
375
376/**
377 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
378 *
379 * @evsel - event selector to read value
380 * @cpu_map_idx - CPU of interest
381 * @thread - thread of interest
382 */
383static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)
384{
385 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);
386}
387
388int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
389 struct perf_sample *sample);
390
391int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
392 u64 *timestamp);
393
394u16 evsel__id_hdr_size(struct evsel *evsel);
395
396static inline struct evsel *evsel__next(struct evsel *evsel)
397{
398 return list_entry(evsel->core.node.next, struct evsel, core.node);
399}
400
401static inline struct evsel *evsel__prev(struct evsel *evsel)
402{
403 return list_entry(evsel->core.node.prev, struct evsel, core.node);
404}
405
406/**
407 * evsel__is_group_leader - Return whether given evsel is a leader event
408 *
409 * @evsel - evsel selector to be tested
410 *
411 * Return %true if @evsel is a group leader or a stand-alone event
412 */
413static inline bool evsel__is_group_leader(const struct evsel *evsel)
414{
415 return evsel->core.leader == &evsel->core;
416}
417
418/**
419 * evsel__is_group_event - Return whether given evsel is a group event
420 *
421 * @evsel - evsel selector to be tested
422 *
423 * Return %true iff event group view is enabled and @evsel is a actual group
424 * leader which has other members in the group
425 */
426static inline bool evsel__is_group_event(struct evsel *evsel)
427{
428 if (!symbol_conf.event_group)
429 return false;
430
431 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
432}
433
434bool evsel__is_function_event(struct evsel *evsel);
435
436static inline bool evsel__is_bpf_output(struct evsel *evsel)
437{
438 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
439}
440
441static inline bool evsel__is_clock(struct evsel *evsel)
442{
443 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
444 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
445}
446
447bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize);
448int evsel__open_strerror(struct evsel *evsel, struct target *target,
449 int err, char *msg, size_t size);
450
451static inline int evsel__group_idx(struct evsel *evsel)
452{
453 return evsel->core.idx - evsel->core.leader->idx;
454}
455
456/* Iterates group WITHOUT the leader. */
457#define for_each_group_member(_evsel, _leader) \
458for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
459 (_evsel) && (_evsel)->core.leader == (&_leader->core); \
460 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
461
462/* Iterates group WITH the leader. */
463#define for_each_group_evsel(_evsel, _leader) \
464for ((_evsel) = _leader; \
465 (_evsel) && (_evsel)->core.leader == (&_leader->core); \
466 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
467
468static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
469{
470 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
471}
472
473static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
474{
475 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
476}
477
478static inline bool evsel__has_callchain(const struct evsel *evsel)
479{
480 /*
481 * For reporting purposes, an evsel sample can have a recorded callchain
482 * or a callchain synthesized from AUX area data.
483 */
484 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
485 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
486}
487
488static inline bool evsel__has_br_stack(const struct evsel *evsel)
489{
490 /*
491 * For reporting purposes, an evsel sample can have a recorded branch
492 * stack or a branch stack synthesized from AUX area data.
493 */
494 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
495 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
496}
497
498static inline bool evsel__is_dummy_event(struct evsel *evsel)
499{
500 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
501 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
502}
503
504struct perf_env *evsel__env(struct evsel *evsel);
505
506int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
507
508void evsel__zero_per_pkg(struct evsel *evsel);
509bool evsel__is_hybrid(const struct evsel *evsel);
510struct evsel *evsel__leader(struct evsel *evsel);
511bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
512bool evsel__is_leader(struct evsel *evsel);
513void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
514int evsel__source_count(const struct evsel *evsel);
515void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);
516
517bool arch_evsel__must_be_in_group(const struct evsel *evsel);
518
519/*
520 * Macro to swap the bit-field postition and size.
521 * Used when,
522 * - dont need to swap the entire u64 &&
523 * - when u64 has variable bit-field sizes &&
524 * - when presented in a host endian which is different
525 * than the source endian of the perf.data file
526 */
527#define bitfield_swap(src, pos, size) \
528 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1)))
529
530u64 evsel__bitfield_swap_branch_flags(u64 value);
531#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 */