xref: /linux/tools/perf/util/evsel.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
1 #ifndef __PERF_EVSEL_H
2 #define __PERF_EVSEL_H 1
3 
4 #include <linux/list.h>
5 #include <stdbool.h>
6 #include <stddef.h>
7 #include <linux/perf_event.h>
8 #include "types.h"
9 #include "xyarray.h"
10 #include "cgroup.h"
11 #include "hist.h"
12 #include "symbol.h"
13 
14 struct perf_counts_values {
15 	union {
16 		struct {
17 			u64 val;
18 			u64 ena;
19 			u64 run;
20 		};
21 		u64 values[3];
22 	};
23 };
24 
25 struct perf_counts {
26 	s8		   	  scaled;
27 	struct perf_counts_values aggr;
28 	struct perf_counts_values cpu[];
29 };
30 
31 struct perf_evsel;
32 
33 /*
34  * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
35  * more than one entry in the evlist.
36  */
37 struct perf_sample_id {
38 	struct hlist_node 	node;
39 	u64		 	id;
40 	struct perf_evsel	*evsel;
41 
42 	/* Holds total ID period value for PERF_SAMPLE_READ processing. */
43 	u64			period;
44 };
45 
46 /** struct perf_evsel - event selector
47  *
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 sample_event
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  */
58 struct perf_evsel {
59 	struct list_head	node;
60 	struct perf_event_attr	attr;
61 	char			*filter;
62 	struct xyarray		*fd;
63 	struct xyarray		*sample_id;
64 	u64			*id;
65 	struct perf_counts	*counts;
66 	struct perf_counts	*prev_raw_counts;
67 	int			idx;
68 	u32			ids;
69 	struct hists		hists;
70 	char			*name;
71 	struct event_format	*tp_format;
72 	union {
73 		void		*priv;
74 		off_t		id_offset;
75 	};
76 	struct cgroup_sel	*cgrp;
77 	void			*handler;
78 	struct cpu_map		*cpus;
79 	unsigned int		sample_size;
80 	int			id_pos;
81 	int			is_pos;
82 	bool 			supported;
83 	bool 			needs_swap;
84 	/* parse modifier helper */
85 	int			exclude_GH;
86 	int			nr_members;
87 	int			sample_read;
88 	struct perf_evsel	*leader;
89 	char			*group_name;
90 };
91 
92 #define hists_to_evsel(h) container_of(h, struct perf_evsel, hists)
93 
94 struct cpu_map;
95 struct thread_map;
96 struct perf_evlist;
97 struct perf_record_opts;
98 
99 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
100 
101 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
102 {
103 	return perf_evsel__new_idx(attr, 0);
104 }
105 
106 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
107 
108 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
109 {
110 	return perf_evsel__newtp_idx(sys, name, 0);
111 }
112 
113 struct event_format *event_format__new(const char *sys, const char *name);
114 
115 void perf_evsel__init(struct perf_evsel *evsel,
116 		      struct perf_event_attr *attr, int idx);
117 void perf_evsel__exit(struct perf_evsel *evsel);
118 void perf_evsel__delete(struct perf_evsel *evsel);
119 
120 void perf_evsel__config(struct perf_evsel *evsel,
121 			struct perf_record_opts *opts);
122 
123 int __perf_evsel__sample_size(u64 sample_type);
124 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
125 
126 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
127 
128 #define PERF_EVSEL__MAX_ALIASES 8
129 
130 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
131 				       [PERF_EVSEL__MAX_ALIASES];
132 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
133 					  [PERF_EVSEL__MAX_ALIASES];
134 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
135 					      [PERF_EVSEL__MAX_ALIASES];
136 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
137 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
138 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
139 					    char *bf, size_t size);
140 const char *perf_evsel__name(struct perf_evsel *evsel);
141 const char *perf_evsel__group_name(struct perf_evsel *evsel);
142 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
143 
144 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
145 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
146 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
147 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
148 void perf_evsel__free_fd(struct perf_evsel *evsel);
149 void perf_evsel__free_id(struct perf_evsel *evsel);
150 void perf_evsel__free_counts(struct perf_evsel *evsel);
151 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
152 
153 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
154 				  enum perf_event_sample_format bit);
155 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
156 				    enum perf_event_sample_format bit);
157 
158 #define perf_evsel__set_sample_bit(evsel, bit) \
159 	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
160 
161 #define perf_evsel__reset_sample_bit(evsel, bit) \
162 	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
163 
164 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
165 			       bool use_sample_identifier);
166 
167 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
168 			   const char *filter);
169 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
170 
171 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
172 			     struct cpu_map *cpus);
173 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
174 				struct thread_map *threads);
175 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
176 		     struct thread_map *threads);
177 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
178 
179 struct perf_sample;
180 
181 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
182 			 const char *name);
183 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
184 		       const char *name);
185 
186 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
187 				       struct perf_sample *sample,
188 				       const char *name)
189 {
190 	return perf_evsel__rawptr(evsel, sample, name);
191 }
192 
193 struct format_field;
194 
195 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
196 
197 #define perf_evsel__match(evsel, t, c)		\
198 	(evsel->attr.type == PERF_TYPE_##t &&	\
199 	 evsel->attr.config == PERF_COUNT_##c)
200 
201 static inline bool perf_evsel__match2(struct perf_evsel *e1,
202 				      struct perf_evsel *e2)
203 {
204 	return (e1->attr.type == e2->attr.type) &&
205 	       (e1->attr.config == e2->attr.config);
206 }
207 
208 #define perf_evsel__cmp(a, b)			\
209 	((a) &&					\
210 	 (b) &&					\
211 	 (a)->attr.type == (b)->attr.type &&	\
212 	 (a)->attr.config == (b)->attr.config)
213 
214 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
215 			      int cpu, int thread, bool scale);
216 
217 /**
218  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
219  *
220  * @evsel - event selector to read value
221  * @cpu - CPU of interest
222  * @thread - thread of interest
223  */
224 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
225 					  int cpu, int thread)
226 {
227 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
228 }
229 
230 /**
231  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
232  *
233  * @evsel - event selector to read value
234  * @cpu - CPU of interest
235  * @thread - thread of interest
236  */
237 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
238 						 int cpu, int thread)
239 {
240 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
241 }
242 
243 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
244 		       bool scale);
245 
246 /**
247  * perf_evsel__read - Read the aggregate results on all CPUs
248  *
249  * @evsel - event selector to read value
250  * @ncpus - Number of cpus affected, from zero
251  * @nthreads - Number of threads affected, from zero
252  */
253 static inline int perf_evsel__read(struct perf_evsel *evsel,
254 				    int ncpus, int nthreads)
255 {
256 	return __perf_evsel__read(evsel, ncpus, nthreads, false);
257 }
258 
259 /**
260  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
261  *
262  * @evsel - event selector to read value
263  * @ncpus - Number of cpus affected, from zero
264  * @nthreads - Number of threads affected, from zero
265  */
266 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
267 					  int ncpus, int nthreads)
268 {
269 	return __perf_evsel__read(evsel, ncpus, nthreads, true);
270 }
271 
272 void hists__init(struct hists *hists);
273 
274 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
275 			     struct perf_sample *sample);
276 
277 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
278 {
279 	return list_entry(evsel->node.next, struct perf_evsel, node);
280 }
281 
282 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
283 {
284 	return list_entry(evsel->node.prev, struct perf_evsel, node);
285 }
286 
287 /**
288  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
289  *
290  * @evsel - evsel selector to be tested
291  *
292  * Return %true if @evsel is a group leader or a stand-alone event
293  */
294 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
295 {
296 	return evsel->leader == evsel;
297 }
298 
299 /**
300  * perf_evsel__is_group_event - Return whether given evsel is a group event
301  *
302  * @evsel - evsel selector to be tested
303  *
304  * Return %true iff event group view is enabled and @evsel is a actual group
305  * leader which has other members in the group
306  */
307 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
308 {
309 	if (!symbol_conf.event_group)
310 		return false;
311 
312 	return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
313 }
314 
315 struct perf_attr_details {
316 	bool freq;
317 	bool verbose;
318 	bool event_group;
319 };
320 
321 int perf_evsel__fprintf(struct perf_evsel *evsel,
322 			struct perf_attr_details *details, FILE *fp);
323 
324 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
325 			  char *msg, size_t msgsize);
326 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
327 			      int err, char *msg, size_t size);
328 
329 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
330 {
331 	return evsel->idx - evsel->leader->idx;
332 }
333 
334 #define for_each_group_member(_evsel, _leader) 					\
335 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); 	\
336      (_evsel) && (_evsel)->leader == (_leader);					\
337      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
338 
339 #endif /* __PERF_EVSEL_H */
340