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