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