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