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