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 <linux/types.h>
9 #include "xyarray.h"
10 #include "symbol.h"
11 #include "cpumap.h"
12 #include "counts.h"
13
14 struct perf_evsel;
15
16 /*
17 * Per fd, to map back from PERF_SAMPLE_ID to evsel, only used when there are
18 * more than one entry in the evlist.
19 */
20 struct perf_sample_id {
21 struct hlist_node node;
22 u64 id;
23 struct perf_evsel *evsel;
24 int idx;
25 int cpu;
26 pid_t tid;
27
28 /* Holds total ID period value for PERF_SAMPLE_READ processing. */
29 u64 period;
30 };
31
32 struct cgroup_sel;
33
34 /*
35 * The 'struct perf_evsel_config_term' is used to pass event
36 * specific configuration data to perf_evsel__config routine.
37 * It is allocated within event parsing and attached to
38 * perf_evsel::config_terms list head.
39 */
40 enum {
41 PERF_EVSEL__CONFIG_TERM_PERIOD,
42 PERF_EVSEL__CONFIG_TERM_FREQ,
43 PERF_EVSEL__CONFIG_TERM_TIME,
44 PERF_EVSEL__CONFIG_TERM_CALLGRAPH,
45 PERF_EVSEL__CONFIG_TERM_STACK_USER,
46 PERF_EVSEL__CONFIG_TERM_INHERIT,
47 PERF_EVSEL__CONFIG_TERM_MAX_STACK,
48 PERF_EVSEL__CONFIG_TERM_OVERWRITE,
49 PERF_EVSEL__CONFIG_TERM_DRV_CFG,
50 PERF_EVSEL__CONFIG_TERM_MAX,
51 };
52
53 struct perf_evsel_config_term {
54 struct list_head list;
55 int type;
56 union {
57 u64 period;
58 u64 freq;
59 bool time;
60 char *callgraph;
61 char *drv_cfg;
62 u64 stack_user;
63 int max_stack;
64 bool inherit;
65 bool overwrite;
66 } val;
67 };
68
69 /** struct perf_evsel - event selector
70 *
71 * @evlist - evlist this evsel is in, if it is in one.
72 * @node - To insert it into evlist->entries or in other list_heads, say in
73 * the event parsing routines.
74 * @name - Can be set to retain the original event name passed by the user,
75 * so that when showing results in tools such as 'perf stat', we
76 * show the name used, not some alias.
77 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
78 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
79 * struct sample_event
80 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
81 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
82 * is used there is an id sample appended to non-sample events
83 * @priv: And what is in its containing unnamed union are tool specific
84 */
85 struct perf_evsel {
86 struct list_head node;
87 struct perf_evlist *evlist;
88 struct perf_event_attr attr;
89 char *filter;
90 struct xyarray *fd;
91 struct xyarray *sample_id;
92 u64 *id;
93 struct perf_counts *counts;
94 struct perf_counts *prev_raw_counts;
95 int idx;
96 u32 ids;
97 char *name;
98 double scale;
99 const char *unit;
100 struct event_format *tp_format;
101 off_t id_offset;
102 void *priv;
103 u64 db_id;
104 struct cgroup_sel *cgrp;
105 void *handler;
106 struct cpu_map *cpus;
107 struct cpu_map *own_cpus;
108 struct thread_map *threads;
109 unsigned int sample_size;
110 int id_pos;
111 int is_pos;
112 bool snapshot;
113 bool supported;
114 bool needs_swap;
115 bool no_aux_samples;
116 bool immediate;
117 bool system_wide;
118 bool tracking;
119 bool per_pkg;
120 bool precise_max;
121 /* parse modifier helper */
122 int exclude_GH;
123 int nr_members;
124 int sample_read;
125 unsigned long *per_pkg_mask;
126 struct perf_evsel *leader;
127 char *group_name;
128 bool cmdline_group_boundary;
129 struct list_head config_terms;
130 int bpf_fd;
131 };
132
133 union u64_swap {
134 u64 val64;
135 u32 val32[2];
136 };
137
138 struct cpu_map;
139 struct target;
140 struct thread_map;
141 struct record_opts;
142
perf_evsel__cpus(struct perf_evsel * evsel)143 static inline struct cpu_map *perf_evsel__cpus(struct perf_evsel *evsel)
144 {
145 return evsel->cpus;
146 }
147
perf_evsel__nr_cpus(struct perf_evsel * evsel)148 static inline int perf_evsel__nr_cpus(struct perf_evsel *evsel)
149 {
150 return perf_evsel__cpus(evsel)->nr;
151 }
152
153 void perf_counts_values__scale(struct perf_counts_values *count,
154 bool scale, s8 *pscaled);
155
156 void perf_evsel__compute_deltas(struct perf_evsel *evsel, int cpu, int thread,
157 struct perf_counts_values *count);
158
159 int perf_evsel__object_config(size_t object_size,
160 int (*init)(struct perf_evsel *evsel),
161 void (*fini)(struct perf_evsel *evsel));
162
163 struct perf_evsel *perf_evsel__new_idx(struct perf_event_attr *attr, int idx);
164
perf_evsel__new(struct perf_event_attr * attr)165 static inline struct perf_evsel *perf_evsel__new(struct perf_event_attr *attr)
166 {
167 return perf_evsel__new_idx(attr, 0);
168 }
169
170 struct perf_evsel *perf_evsel__newtp_idx(const char *sys, const char *name, int idx);
171
172 /*
173 * Returns pointer with encoded error via <linux/err.h> interface.
174 */
perf_evsel__newtp(const char * sys,const char * name)175 static inline struct perf_evsel *perf_evsel__newtp(const char *sys, const char *name)
176 {
177 return perf_evsel__newtp_idx(sys, name, 0);
178 }
179
180 struct perf_evsel *perf_evsel__new_cycles(void);
181
182 struct event_format *event_format__new(const char *sys, const char *name);
183
184 void perf_evsel__init(struct perf_evsel *evsel,
185 struct perf_event_attr *attr, int idx);
186 void perf_evsel__exit(struct perf_evsel *evsel);
187 void perf_evsel__delete(struct perf_evsel *evsel);
188
189 struct callchain_param;
190
191 void perf_evsel__config(struct perf_evsel *evsel,
192 struct record_opts *opts,
193 struct callchain_param *callchain);
194 void perf_evsel__config_callchain(struct perf_evsel *evsel,
195 struct record_opts *opts,
196 struct callchain_param *callchain);
197
198 int __perf_evsel__sample_size(u64 sample_type);
199 void perf_evsel__calc_id_pos(struct perf_evsel *evsel);
200
201 bool perf_evsel__is_cache_op_valid(u8 type, u8 op);
202
203 #define PERF_EVSEL__MAX_ALIASES 8
204
205 extern const char *perf_evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX]
206 [PERF_EVSEL__MAX_ALIASES];
207 extern const char *perf_evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX]
208 [PERF_EVSEL__MAX_ALIASES];
209 extern const char *perf_evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX]
210 [PERF_EVSEL__MAX_ALIASES];
211 extern const char *perf_evsel__hw_names[PERF_COUNT_HW_MAX];
212 extern const char *perf_evsel__sw_names[PERF_COUNT_SW_MAX];
213 int __perf_evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result,
214 char *bf, size_t size);
215 const char *perf_evsel__name(struct perf_evsel *evsel);
216
217 const char *perf_evsel__group_name(struct perf_evsel *evsel);
218 int perf_evsel__group_desc(struct perf_evsel *evsel, char *buf, size_t size);
219
220 int perf_evsel__alloc_id(struct perf_evsel *evsel, int ncpus, int nthreads);
221 void perf_evsel__close_fd(struct perf_evsel *evsel, int ncpus, int nthreads);
222
223 void __perf_evsel__set_sample_bit(struct perf_evsel *evsel,
224 enum perf_event_sample_format bit);
225 void __perf_evsel__reset_sample_bit(struct perf_evsel *evsel,
226 enum perf_event_sample_format bit);
227
228 #define perf_evsel__set_sample_bit(evsel, bit) \
229 __perf_evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
230
231 #define perf_evsel__reset_sample_bit(evsel, bit) \
232 __perf_evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
233
234 void perf_evsel__set_sample_id(struct perf_evsel *evsel,
235 bool use_sample_identifier);
236
237 int perf_evsel__set_filter(struct perf_evsel *evsel, const char *filter);
238 int perf_evsel__append_tp_filter(struct perf_evsel *evsel, const char *filter);
239 int perf_evsel__append_addr_filter(struct perf_evsel *evsel,
240 const char *filter);
241 int perf_evsel__apply_filter(struct perf_evsel *evsel, int ncpus, int nthreads,
242 const char *filter);
243 int perf_evsel__enable(struct perf_evsel *evsel);
244 int perf_evsel__disable(struct perf_evsel *evsel);
245
246 int perf_evsel__open_per_cpu(struct perf_evsel *evsel,
247 struct cpu_map *cpus);
248 int perf_evsel__open_per_thread(struct perf_evsel *evsel,
249 struct thread_map *threads);
250 int perf_evsel__open(struct perf_evsel *evsel, struct cpu_map *cpus,
251 struct thread_map *threads);
252 void perf_evsel__close(struct perf_evsel *evsel, int ncpus, int nthreads);
253
254 struct perf_sample;
255
256 void *perf_evsel__rawptr(struct perf_evsel *evsel, struct perf_sample *sample,
257 const char *name);
258 u64 perf_evsel__intval(struct perf_evsel *evsel, struct perf_sample *sample,
259 const char *name);
260
perf_evsel__strval(struct perf_evsel * evsel,struct perf_sample * sample,const char * name)261 static inline char *perf_evsel__strval(struct perf_evsel *evsel,
262 struct perf_sample *sample,
263 const char *name)
264 {
265 return perf_evsel__rawptr(evsel, sample, name);
266 }
267
268 struct format_field;
269
270 u64 format_field__intval(struct format_field *field, struct perf_sample *sample, bool needs_swap);
271
272 struct format_field *perf_evsel__field(struct perf_evsel *evsel, const char *name);
273
274 #define perf_evsel__match(evsel, t, c) \
275 (evsel->attr.type == PERF_TYPE_##t && \
276 evsel->attr.config == PERF_COUNT_##c)
277
perf_evsel__match2(struct perf_evsel * e1,struct perf_evsel * e2)278 static inline bool perf_evsel__match2(struct perf_evsel *e1,
279 struct perf_evsel *e2)
280 {
281 return (e1->attr.type == e2->attr.type) &&
282 (e1->attr.config == e2->attr.config);
283 }
284
285 #define perf_evsel__cmp(a, b) \
286 ((a) && \
287 (b) && \
288 (a)->attr.type == (b)->attr.type && \
289 (a)->attr.config == (b)->attr.config)
290
291 int perf_evsel__read(struct perf_evsel *evsel, int cpu, int thread,
292 struct perf_counts_values *count);
293
294 int __perf_evsel__read_on_cpu(struct perf_evsel *evsel,
295 int cpu, int thread, bool scale);
296
297 /**
298 * perf_evsel__read_on_cpu - Read out the results on a CPU and thread
299 *
300 * @evsel - event selector to read value
301 * @cpu - CPU of interest
302 * @thread - thread of interest
303 */
perf_evsel__read_on_cpu(struct perf_evsel * evsel,int cpu,int thread)304 static inline int perf_evsel__read_on_cpu(struct perf_evsel *evsel,
305 int cpu, int thread)
306 {
307 return __perf_evsel__read_on_cpu(evsel, cpu, thread, false);
308 }
309
310 /**
311 * perf_evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
312 *
313 * @evsel - event selector to read value
314 * @cpu - CPU of interest
315 * @thread - thread of interest
316 */
perf_evsel__read_on_cpu_scaled(struct perf_evsel * evsel,int cpu,int thread)317 static inline int perf_evsel__read_on_cpu_scaled(struct perf_evsel *evsel,
318 int cpu, int thread)
319 {
320 return __perf_evsel__read_on_cpu(evsel, cpu, thread, true);
321 }
322
323 int perf_evsel__parse_sample(struct perf_evsel *evsel, union perf_event *event,
324 struct perf_sample *sample);
325
perf_evsel__next(struct perf_evsel * evsel)326 static inline struct perf_evsel *perf_evsel__next(struct perf_evsel *evsel)
327 {
328 return list_entry(evsel->node.next, struct perf_evsel, node);
329 }
330
perf_evsel__prev(struct perf_evsel * evsel)331 static inline struct perf_evsel *perf_evsel__prev(struct perf_evsel *evsel)
332 {
333 return list_entry(evsel->node.prev, struct perf_evsel, node);
334 }
335
336 /**
337 * perf_evsel__is_group_leader - Return whether given evsel is a leader event
338 *
339 * @evsel - evsel selector to be tested
340 *
341 * Return %true if @evsel is a group leader or a stand-alone event
342 */
perf_evsel__is_group_leader(const struct perf_evsel * evsel)343 static inline bool perf_evsel__is_group_leader(const struct perf_evsel *evsel)
344 {
345 return evsel->leader == evsel;
346 }
347
348 /**
349 * perf_evsel__is_group_event - Return whether given evsel is a group event
350 *
351 * @evsel - evsel selector to be tested
352 *
353 * Return %true iff event group view is enabled and @evsel is a actual group
354 * leader which has other members in the group
355 */
perf_evsel__is_group_event(struct perf_evsel * evsel)356 static inline bool perf_evsel__is_group_event(struct perf_evsel *evsel)
357 {
358 if (!symbol_conf.event_group)
359 return false;
360
361 return perf_evsel__is_group_leader(evsel) && evsel->nr_members > 1;
362 }
363
364 bool perf_evsel__is_function_event(struct perf_evsel *evsel);
365
perf_evsel__is_bpf_output(struct perf_evsel * evsel)366 static inline bool perf_evsel__is_bpf_output(struct perf_evsel *evsel)
367 {
368 struct perf_event_attr *attr = &evsel->attr;
369
370 return (attr->config == PERF_COUNT_SW_BPF_OUTPUT) &&
371 (attr->type == PERF_TYPE_SOFTWARE);
372 }
373
374 struct perf_attr_details {
375 bool freq;
376 bool verbose;
377 bool event_group;
378 bool force;
379 bool trace_fields;
380 };
381
382 int perf_evsel__fprintf(struct perf_evsel *evsel,
383 struct perf_attr_details *details, FILE *fp);
384
385 #define EVSEL__PRINT_IP (1<<0)
386 #define EVSEL__PRINT_SYM (1<<1)
387 #define EVSEL__PRINT_DSO (1<<2)
388 #define EVSEL__PRINT_SYMOFFSET (1<<3)
389 #define EVSEL__PRINT_ONELINE (1<<4)
390 #define EVSEL__PRINT_SRCLINE (1<<5)
391 #define EVSEL__PRINT_UNKNOWN_AS_ADDR (1<<6)
392
393 struct callchain_cursor;
394
395 int sample__fprintf_callchain(struct perf_sample *sample, int left_alignment,
396 unsigned int print_opts,
397 struct callchain_cursor *cursor, FILE *fp);
398
399 int sample__fprintf_sym(struct perf_sample *sample, struct addr_location *al,
400 int left_alignment, unsigned int print_opts,
401 struct callchain_cursor *cursor, FILE *fp);
402
403 bool perf_evsel__fallback(struct perf_evsel *evsel, int err,
404 char *msg, size_t msgsize);
405 int perf_evsel__open_strerror(struct perf_evsel *evsel, struct target *target,
406 int err, char *msg, size_t size);
407
perf_evsel__group_idx(struct perf_evsel * evsel)408 static inline int perf_evsel__group_idx(struct perf_evsel *evsel)
409 {
410 return evsel->idx - evsel->leader->idx;
411 }
412
413 #define for_each_group_member(_evsel, _leader) \
414 for ((_evsel) = list_entry((_leader)->node.next, struct perf_evsel, node); \
415 (_evsel) && (_evsel)->leader == (_leader); \
416 (_evsel) = list_entry((_evsel)->node.next, struct perf_evsel, node))
417
perf_evsel__has_branch_callstack(const struct perf_evsel * evsel)418 static inline bool perf_evsel__has_branch_callstack(const struct perf_evsel *evsel)
419 {
420 return evsel->attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
421 }
422
423 typedef int (*attr__fprintf_f)(FILE *, const char *, const char *, void *);
424
425 int perf_event_attr__fprintf(FILE *fp, struct perf_event_attr *attr,
426 attr__fprintf_f attr__fprintf, void *priv);
427
428 char *perf_evsel__env_arch(struct perf_evsel *evsel);
429
430 #endif /* __PERF_EVSEL_H */
431