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
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 PERF_TOOL_USER_TIME = 2,
33 PERF_TOOL_SYSTEM_TIME = 3,
34
35 PERF_TOOL_MAX,
36 };
37
38 const char *perf_tool_event__to_str(enum perf_tool_event ev);
39 enum 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 */
59 struct 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 /* For tool events */
175 /* Beginning time subtracted when the counter is read. */
176 union {
177 /* duration_time is a single global time. */
178 __u64 start_time;
179 /*
180 * user_time and system_time read an initial value potentially
181 * per-CPU or per-pid.
182 */
183 struct xyarray *start_times;
184 };
185 /* Is the tool's fd for /proc/pid/stat or /proc/stat. */
186 bool pid_stat;
187 };
188
189 struct perf_missing_features {
190 bool sample_id_all;
191 bool exclude_guest;
192 bool mmap2;
193 bool cloexec;
194 bool clockid;
195 bool clockid_wrong;
196 bool lbr_flags;
197 bool write_backward;
198 bool group_read;
199 bool ksymbol;
200 bool bpf;
201 bool aux_output;
202 bool branch_hw_idx;
203 bool cgroup;
204 bool data_page_size;
205 bool code_page_size;
206 bool weight_struct;
207 bool read_lost;
208 bool branch_counters;
209 };
210
211 extern struct perf_missing_features perf_missing_features;
212
213 struct perf_cpu_map;
214 struct thread_map;
215 struct record_opts;
216
217 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
218 {
219 return perf_evsel__cpus(&evsel->core);
220 }
221
222 static inline int evsel__nr_cpus(struct evsel *evsel)
223 {
224 return perf_cpu_map__nr(evsel__cpus(evsel));
225 }
226
227 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
228 struct perf_counts_values *count);
229
230 int evsel__object_config(size_t object_size,
231 int (*init)(struct evsel *evsel),
232 void (*fini)(struct evsel *evsel));
233
234 struct perf_pmu *evsel__find_pmu(const struct evsel *evsel);
235 bool evsel__is_aux_event(const struct evsel *evsel);
236
237 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
238
239 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
240 {
241 return evsel__new_idx(attr, 0);
242 }
243
244 struct evsel *evsel__clone(struct evsel *orig);
245
246 int copy_config_terms(struct list_head *dst, struct list_head *src);
247 void free_config_terms(struct list_head *config_terms);
248
249
250 #ifdef HAVE_LIBTRACEEVENT
251 struct 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 */
256 static 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
263 struct tep_event *event_format__new(const char *sys, const char *name);
264 #endif
265
266 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
267 void evsel__exit(struct evsel *evsel);
268 void evsel__delete(struct evsel *evsel);
269
270 struct callchain_param;
271
272 void evsel__config(struct evsel *evsel, struct record_opts *opts,
273 struct callchain_param *callchain);
274 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
275 struct callchain_param *callchain);
276
277 int __evsel__sample_size(u64 sample_type);
278 void evsel__calc_id_pos(struct evsel *evsel);
279
280 bool evsel__is_cache_op_valid(u8 type, u8 op);
281
282 static inline bool evsel__is_bpf(struct evsel *evsel)
283 {
284 return evsel->bpf_counter_ops != NULL;
285 }
286
287 static 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
294 extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
295 extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
296 extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
297 extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX];
298 extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX];
299 extern char *evsel__bpf_counter_events;
300 bool evsel__match_bpf_counter_events(const char *name);
301 int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);
302
303 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
304 const char *evsel__name(struct evsel *evsel);
305 bool evsel__name_is(struct evsel *evsel, const char *name);
306 const char *evsel__metric_id(const struct evsel *evsel);
307
308 static inline bool evsel__is_tool(const struct evsel *evsel)
309 {
310 return evsel->tool_event != PERF_TOOL_NONE;
311 }
312
313 const char *evsel__group_name(struct evsel *evsel);
314 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
315
316 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
317 void __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
325 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
326
327 void arch_evsel__set_sample_weight(struct evsel *evsel);
328 void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);
329 int arch_evsel__open_strerror(struct evsel *evsel, char *msg, size_t size);
330
331 int evsel__set_filter(struct evsel *evsel, const char *filter);
332 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
333 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
334 int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);
335 int evsel__enable(struct evsel *evsel);
336 int evsel__disable(struct evsel *evsel);
337 int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);
338
339 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);
340 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
341 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
342 struct perf_thread_map *threads);
343 void evsel__close(struct evsel *evsel);
344 int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,
345 struct perf_thread_map *threads);
346 bool evsel__detect_missing_features(struct evsel *evsel);
347
348 bool evsel__precise_ip_fallback(struct evsel *evsel);
349
350 struct perf_sample;
351
352 #ifdef HAVE_LIBTRACEEVENT
353 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
354 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
355 u64 evsel__intval_common(struct evsel *evsel, struct perf_sample *sample, const char *name);
356 char evsel__taskstate(struct evsel *evsel, struct perf_sample *sample, const char *name);
357
358 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
359 {
360 return evsel__rawptr(evsel, sample, name);
361 }
362 #endif
363
364 struct tep_format_field;
365
366 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
367
368 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
369 struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name);
370
371 static inline bool __evsel__match(const struct evsel *evsel, u32 type, u64 config)
372 {
373 if (evsel->core.attr.type != type)
374 return false;
375
376 if ((type == PERF_TYPE_HARDWARE || type == PERF_TYPE_HW_CACHE) &&
377 perf_pmus__supports_extended_type())
378 return (evsel->core.attr.config & PERF_HW_EVENT_MASK) == config;
379
380 return evsel->core.attr.config == config;
381 }
382
383 #define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c)
384
385 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
386 {
387 return (e1->core.attr.type == e2->core.attr.type) &&
388 (e1->core.attr.config == e2->core.attr.config);
389 }
390
391 int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);
392
393 int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);
394
395 /**
396 * evsel__read_on_cpu - Read out the results on a CPU and thread
397 *
398 * @evsel - event selector to read value
399 * @cpu_map_idx - CPU of interest
400 * @thread - thread of interest
401 */
402 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)
403 {
404 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);
405 }
406
407 /**
408 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
409 *
410 * @evsel - event selector to read value
411 * @cpu_map_idx - CPU of interest
412 * @thread - thread of interest
413 */
414 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)
415 {
416 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);
417 }
418
419 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
420 struct perf_sample *sample);
421
422 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
423 u64 *timestamp);
424
425 u16 evsel__id_hdr_size(struct evsel *evsel);
426
427 static inline struct evsel *evsel__next(struct evsel *evsel)
428 {
429 return list_entry(evsel->core.node.next, struct evsel, core.node);
430 }
431
432 static inline struct evsel *evsel__prev(struct evsel *evsel)
433 {
434 return list_entry(evsel->core.node.prev, struct evsel, core.node);
435 }
436
437 /**
438 * evsel__is_group_leader - Return whether given evsel is a leader event
439 *
440 * @evsel - evsel selector to be tested
441 *
442 * Return %true if @evsel is a group leader or a stand-alone event
443 */
444 static inline bool evsel__is_group_leader(const struct evsel *evsel)
445 {
446 return evsel->core.leader == &evsel->core;
447 }
448
449 /**
450 * evsel__is_group_event - Return whether given evsel is a group event
451 *
452 * @evsel - evsel selector to be tested
453 *
454 * Return %true iff event group view is enabled and @evsel is a actual group
455 * leader which has other members in the group
456 */
457 static inline bool evsel__is_group_event(struct evsel *evsel)
458 {
459 if (!symbol_conf.event_group)
460 return false;
461
462 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
463 }
464
465 bool evsel__is_function_event(struct evsel *evsel);
466
467 static inline bool evsel__is_bpf_output(struct evsel *evsel)
468 {
469 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
470 }
471
472 static inline bool evsel__is_clock(const struct evsel *evsel)
473 {
474 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
475 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
476 }
477
478 bool evsel__fallback(struct evsel *evsel, struct target *target, int err,
479 char *msg, size_t msgsize);
480 int evsel__open_strerror(struct evsel *evsel, struct target *target,
481 int err, char *msg, size_t size);
482
483 static inline int evsel__group_idx(struct evsel *evsel)
484 {
485 return evsel->core.idx - evsel->core.leader->idx;
486 }
487
488 /* Iterates group WITHOUT the leader. */
489 #define for_each_group_member_head(_evsel, _leader, _head) \
490 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
491 (_evsel) && &(_evsel)->core.node != (_head) && \
492 (_evsel)->core.leader == &(_leader)->core; \
493 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
494
495 #define for_each_group_member(_evsel, _leader) \
496 for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries)
497
498 /* Iterates group WITH the leader. */
499 #define for_each_group_evsel_head(_evsel, _leader, _head) \
500 for ((_evsel) = _leader; \
501 (_evsel) && &(_evsel)->core.node != (_head) && \
502 (_evsel)->core.leader == &(_leader)->core; \
503 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
504
505 #define for_each_group_evsel(_evsel, _leader) \
506 for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries)
507
508 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
509 {
510 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
511 }
512
513 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
514 {
515 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
516 }
517
518 static inline bool evsel__has_callchain(const struct evsel *evsel)
519 {
520 /*
521 * For reporting purposes, an evsel sample can have a recorded callchain
522 * or a callchain synthesized from AUX area data.
523 */
524 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
525 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
526 }
527
528 static inline bool evsel__has_br_stack(const struct evsel *evsel)
529 {
530 /*
531 * For reporting purposes, an evsel sample can have a recorded branch
532 * stack or a branch stack synthesized from AUX area data.
533 */
534 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
535 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
536 }
537
538 static inline bool evsel__is_dummy_event(struct evsel *evsel)
539 {
540 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
541 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
542 }
543
544 struct perf_env *evsel__env(struct evsel *evsel);
545
546 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
547
548 void evsel__zero_per_pkg(struct evsel *evsel);
549 bool evsel__is_hybrid(const struct evsel *evsel);
550 struct evsel *evsel__leader(const struct evsel *evsel);
551 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
552 bool evsel__is_leader(struct evsel *evsel);
553 void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
554 int evsel__source_count(const struct evsel *evsel);
555 void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);
556
557 bool arch_evsel__must_be_in_group(const struct evsel *evsel);
558
559 /*
560 * Macro to swap the bit-field postition and size.
561 * Used when,
562 * - dont need to swap the entire u64 &&
563 * - when u64 has variable bit-field sizes &&
564 * - when presented in a host endian which is different
565 * than the source endian of the perf.data file
566 */
567 #define bitfield_swap(src, pos, size) \
568 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1)))
569
570 u64 evsel__bitfield_swap_branch_flags(u64 value);
571 void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,
572 const char *config_name, u64 val);
573
574 #endif /* __PERF_EVSEL_H */
575
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.