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