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