xref: /openbmc/linux/tools/perf/util/evsel.h (revision 161f4089)
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(struct perf_event_attr *attr, int idx);
100 struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name, int idx);
101 
102 struct event_format *event_format__new(const char *sys, const char *name);
103 
104 void perf_evsel__init(struct perf_evsel *evsel,
105 		      struct perf_event_attr *attr, int idx);
106 void perf_evsel__exit(struct perf_evsel *evsel);
107 void perf_evsel__delete(struct perf_evsel *evsel);
108 
109 void perf_evsel__config(struct perf_evsel *evsel,
110 			struct perf_record_opts *opts);
111 
112 int __perf_evsel__sample_size(u64 sample_type);
113 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
114 
115 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
116 
117 #define PERF_EVSEL__MAX_ALIASES 8
118 
119 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
120 				       [PERF_EVSEL__MAX_ALIASES];
121 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
122 					  [PERF_EVSEL__MAX_ALIASES];
123 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
124 					      [PERF_EVSEL__MAX_ALIASES];
125 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
126 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
127 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
128 					    char *bf, size_t size);
129 const char *perf_evsel__name(struct perf_evsel *evsel);
130 const char *perf_evsel__group_name(struct perf_evsel *evsel);
131 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
132 
133 int perf_evsel__alloc_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
134 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
135 int perf_evsel__alloc_counts(struct perf_evsel *evsel, int ncpus);
136 void perf_evsel__reset_counts(struct perf_evsel *evsel, int ncpus);
137 void perf_evsel__free_fd(struct perf_evsel *evsel);
138 void perf_evsel__free_id(struct perf_evsel *evsel);
139 void perf_evsel__free_counts(struct perf_evsel *evsel);
140 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
141 
142 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
143 				  enum perf_event_sample_format bit);
144 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
145 				    enum perf_event_sample_format bit);
146 
147 #define perf_evsel__set_sample_bit(evsel, bit) \
148 	__perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
149 
150 #define perf_evsel__reset_sample_bit(evsel, bit) \
151 	__perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
152 
153 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
154 			       bool use_sample_identifier);
155 
156 int perf_evsel__set_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
157 			   const char *filter);
158 int perf_evsel__enable(struct perf_evsel *evsel, int ncpus, int nthreads);
159 
160 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
161 			     struct cpu_map *cpus);
162 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
163 				struct thread_map *threads);
164 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
165 		     struct thread_map *threads);
166 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
167 
168 struct perf_sample;
169 
170 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
171 			 const char *name);
172 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
173 		       const char *name);
174 
175 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
176 				       struct perf_sample *sample,
177 				       const char *name)
178 {
179 	return perf_evsel__rawptr(evsel, sample, name);
180 }
181 
182 struct format_field;
183 
184 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
185 
186 #define perf_evsel__match(evsel, t, c)		\
187 	(evsel->attr.type == PERF_TYPE_##t &&	\
188 	 evsel->attr.config == PERF_COUNT_##c)
189 
190 static inline bool perf_evsel__match2(struct perf_evsel *e1,
191 				      struct perf_evsel *e2)
192 {
193 	return (e1->attr.type == e2->attr.type) &&
194 	       (e1->attr.config == e2->attr.config);
195 }
196 
197 #define perf_evsel__cmp(a, b)			\
198 	((a) &&					\
199 	 (b) &&					\
200 	 (a)->attr.type == (b)->attr.type &&	\
201 	 (a)->attr.config == (b)->attr.config)
202 
203 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
204 			      int cpu, int thread, bool scale);
205 
206 /**
207  * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
208  *
209  * @evsel - event selector to read value
210  * @cpu - CPU of interest
211  * @thread - thread of interest
212  */
213 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
214 					  int cpu, int thread)
215 {
216 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
217 }
218 
219 /**
220  * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
221  *
222  * @evsel - event selector to read value
223  * @cpu - CPU of interest
224  * @thread - thread of interest
225  */
226 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
227 						 int cpu, int thread)
228 {
229 	return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
230 }
231 
232 int __perf_evsel__read(struct perf_evsel *evsel, int ncpus, int nthreads,
233 		       bool scale);
234 
235 /**
236  * perf_evsel__read - Read the aggregate results on all CPUs
237  *
238  * @evsel - event selector to read value
239  * @ncpus - Number of cpus affected, from zero
240  * @nthreads - Number of threads affected, from zero
241  */
242 static inline int perf_evsel__read(struct perf_evsel *evsel,
243 				    int ncpus, int nthreads)
244 {
245 	return __perf_evsel__read(evsel, ncpus, nthreads, false);
246 }
247 
248 /**
249  * perf_evsel__read_scaled - Read the aggregate results on all CPUs, scaled
250  *
251  * @evsel - event selector to read value
252  * @ncpus - Number of cpus affected, from zero
253  * @nthreads - Number of threads affected, from zero
254  */
255 static inline int perf_evsel__read_scaled(struct perf_evsel *evsel,
256 					  int ncpus, int nthreads)
257 {
258 	return __perf_evsel__read(evsel, ncpus, nthreads, true);
259 }
260 
261 void hists__init(struct hists *hists);
262 
263 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
264 			     struct perf_sample *sample);
265 
266 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
267 {
268 	return list_entry(evsel->node.next, struct perf_evsel, node);
269 }
270 
271 /**
272  * perf_evsel__is_group_leader - Return whether given evsel is a leader event
273  *
274  * @evsel - evsel selector to be tested
275  *
276  * Return %true if @evsel is a group leader or a stand-alone event
277  */
278 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
279 {
280 	return evsel->leader == evsel;
281 }
282 
283 /**
284  * perf_evsel__is_group_event - Return whether given evsel is a group event
285  *
286  * @evsel - evsel selector to be tested
287  *
288  * Return %true iff event group view is enabled and @evsel is a actual group
289  * leader which has other members in the group
290  */
291 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
292 {
293 	if (!symbol_conf.event_group)
294 		return false;
295 
296 	return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
297 }
298 
299 struct perf_attr_details {
300 	bool freq;
301 	bool verbose;
302 	bool event_group;
303 };
304 
305 int perf_evsel__fprintf(struct perf_evsel *evsel,
306 			struct perf_attr_details *details, FILE *fp);
307 
308 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
309 			  char *msg, size_t msgsize);
310 int perf_evsel__open_strerror(struct perf_evsel *evsel,
311 			      struct perf_target *target,
312 			      int err, char *msg, size_t size);
313 
314 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
315 {
316 	return evsel->idx - evsel->leader->idx;
317 }
318 
319 #define for_each_group_member(_evsel, _leader) 					\
320 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); 	\
321      (_evsel) && (_evsel)->leader == (_leader);					\
322      (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
323 
324 #endif /* __PERF_EVSEL_H */
325