1 /* SPDX-License-Identifier: GPL-2.0 */
3 #define __PERF_EVSEL_H 1
5 #include <linux/list.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 #include <internal/cpumap.h>
18 struct perf_stat_evsel;
20 struct bpf_counter_ops;
23 struct bperf_leader_bpf;
24 struct bperf_follower_bpf;
26 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
28 enum perf_tool_event {
30 PERF_TOOL_DURATION_TIME = 1,
33 /** struct evsel - event selector
35 * @evlist - evlist this evsel is in, if it is in one.
36 * @core - libperf evsel object
37 * @name - Can be set to retain the original event name passed by the user,
38 * so that when showing results in tools such as 'perf stat', we
39 * show the name used, not some alias.
40 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
41 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
42 * struct perf_record_sample
43 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
44 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
45 * is used there is an id sample appended to non-sample events
46 * @priv: And what is in its containing unnamed union are tool specific
49 struct perf_evsel core;
50 struct evlist *evlist;
54 unsigned int sample_size;
57 * These fields can be set in the parse-events code or similar.
58 * Please check evsel__clone() to copy them properly so that
59 * they can be released properly.
65 struct tep_event *tp_format;
67 unsigned long max_events;
71 enum perf_tool_event tool_event;
72 /* parse modifier helper */
79 bool use_uncore_alias;
81 bool auto_merge_stats;
87 struct bpf_object *bpf_obj;
88 struct list_head config_terms;
92 * metric fields are similar, but needs more care as they can have
93 * references to other metric (evsel).
95 const char * metric_expr;
96 const char * metric_name;
97 struct evsel **metric_events;
98 struct evsel *metric_leader;
101 struct perf_counts *counts;
102 struct perf_counts *prev_raw_counts;
103 unsigned long nr_events_printed;
104 struct perf_stat_evsel *stats;
107 bool uniquified_name;
114 bool ignore_missing_thread;
116 bool cmdline_group_boundary;
120 struct hashmap *per_pkg_mask;
128 * For reporting purposes, an evsel sample can have a callchain
129 * synthesized from AUX area data. Keep track of synthesized sample
130 * types here. Note, the recorded sample_type cannot be changed because
131 * it is needed to continue to parse events.
132 * See also evsel__has_callchain().
134 __u64 synth_sample_type;
137 * bpf_counter_ops serves two use cases:
138 * 1. perf-stat -b counting events used byBPF programs
139 * 2. perf-stat --use-bpf use BPF programs to aggregate counts
141 struct bpf_counter_ops *bpf_counter_ops;
143 /* for perf-stat -b */
144 struct list_head bpf_counter_list;
146 /* for perf-stat --use-bpf */
147 int bperf_leader_prog_fd;
148 int bperf_leader_link_fd;
150 struct bperf_leader_bpf *leader_skel;
151 struct bperf_follower_bpf *follower_skel;
155 struct perf_missing_features {
175 extern struct perf_missing_features perf_missing_features;
181 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
183 return perf_evsel__cpus(&evsel->core);
186 static inline int evsel__nr_cpus(struct evsel *evsel)
188 return evsel__cpus(evsel)->nr;
191 void perf_counts_values__scale(struct perf_counts_values *count,
192 bool scale, s8 *pscaled);
194 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
195 struct perf_counts_values *count);
197 int evsel__object_config(size_t object_size,
198 int (*init)(struct evsel *evsel),
199 void (*fini)(struct evsel *evsel));
201 struct perf_pmu *evsel__find_pmu(struct evsel *evsel);
202 bool evsel__is_aux_event(struct evsel *evsel);
204 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
206 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
208 return evsel__new_idx(attr, 0);
211 struct evsel *evsel__clone(struct evsel *orig);
212 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
215 * Returns pointer with encoded error via <linux/err.h> interface.
217 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
219 return evsel__newtp_idx(sys, name, 0);
222 struct evsel *evsel__new_cycles(bool precise, __u32 type, __u64 config);
224 struct tep_event *event_format__new(const char *sys, const char *name);
226 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
227 void evsel__exit(struct evsel *evsel);
228 void evsel__delete(struct evsel *evsel);
230 struct callchain_param;
232 void evsel__config(struct evsel *evsel, struct record_opts *opts,
233 struct callchain_param *callchain);
234 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
235 struct callchain_param *callchain);
237 int __evsel__sample_size(u64 sample_type);
238 void evsel__calc_id_pos(struct evsel *evsel);
240 bool evsel__is_cache_op_valid(u8 type, u8 op);
242 static inline bool evsel__is_bpf(struct evsel *evsel)
244 return evsel->bpf_counter_ops != NULL;
247 #define EVSEL__MAX_ALIASES 8
249 extern const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
250 extern const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
251 extern const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
252 extern const char *evsel__hw_names[PERF_COUNT_HW_MAX];
253 extern const char *evsel__sw_names[PERF_COUNT_SW_MAX];
254 extern char *evsel__bpf_counter_events;
255 bool evsel__match_bpf_counter_events(const char *name);
257 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
258 const char *evsel__name(struct evsel *evsel);
260 const char *evsel__group_name(struct evsel *evsel);
261 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
263 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
264 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
266 #define evsel__set_sample_bit(evsel, bit) \
267 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
269 #define evsel__reset_sample_bit(evsel, bit) \
270 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
272 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
274 void arch_evsel__set_sample_weight(struct evsel *evsel);
276 int evsel__set_filter(struct evsel *evsel, const char *filter);
277 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
278 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
279 int evsel__enable_cpu(struct evsel *evsel, int cpu);
280 int evsel__enable(struct evsel *evsel);
281 int evsel__disable(struct evsel *evsel);
282 int evsel__disable_cpu(struct evsel *evsel, int cpu);
284 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu);
285 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
286 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
287 struct perf_thread_map *threads);
288 void evsel__close(struct evsel *evsel);
292 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
293 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
295 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
297 return evsel__rawptr(evsel, sample, name);
300 struct tep_format_field;
302 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
304 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
306 #define evsel__match(evsel, t, c) \
307 (evsel->core.attr.type == PERF_TYPE_##t && \
308 evsel->core.attr.config == PERF_COUNT_##c)
310 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
312 return (e1->core.attr.type == e2->core.attr.type) &&
313 (e1->core.attr.config == e2->core.attr.config);
316 int evsel__read_counter(struct evsel *evsel, int cpu, int thread);
318 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale);
321 * evsel__read_on_cpu - Read out the results on a CPU and thread
323 * @evsel - event selector to read value
324 * @cpu - CPU of interest
325 * @thread - thread of interest
327 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread)
329 return __evsel__read_on_cpu(evsel, cpu, thread, false);
333 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
335 * @evsel - event selector to read value
336 * @cpu - CPU of interest
337 * @thread - thread of interest
339 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread)
341 return __evsel__read_on_cpu(evsel, cpu, thread, true);
344 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
345 struct perf_sample *sample);
347 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
350 static inline struct evsel *evsel__next(struct evsel *evsel)
352 return list_entry(evsel->core.node.next, struct evsel, core.node);
355 static inline struct evsel *evsel__prev(struct evsel *evsel)
357 return list_entry(evsel->core.node.prev, struct evsel, core.node);
361 * evsel__is_group_leader - Return whether given evsel is a leader event
363 * @evsel - evsel selector to be tested
365 * Return %true if @evsel is a group leader or a stand-alone event
367 static inline bool evsel__is_group_leader(const struct evsel *evsel)
369 return evsel->core.leader == &evsel->core;
373 * evsel__is_group_event - Return whether given evsel is a group event
375 * @evsel - evsel selector to be tested
377 * Return %true iff event group view is enabled and @evsel is a actual group
378 * leader which has other members in the group
380 static inline bool evsel__is_group_event(struct evsel *evsel)
382 if (!symbol_conf.event_group)
385 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
388 bool evsel__is_function_event(struct evsel *evsel);
390 static inline bool evsel__is_bpf_output(struct evsel *evsel)
392 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
395 static inline bool evsel__is_clock(struct evsel *evsel)
397 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
398 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
401 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize);
402 int evsel__open_strerror(struct evsel *evsel, struct target *target,
403 int err, char *msg, size_t size);
405 static inline int evsel__group_idx(struct evsel *evsel)
407 return evsel->core.idx - evsel->core.leader->idx;
410 /* Iterates group WITHOUT the leader. */
411 #define for_each_group_member(_evsel, _leader) \
412 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
413 (_evsel) && (_evsel)->core.leader == (&_leader->core); \
414 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
416 /* Iterates group WITH the leader. */
417 #define for_each_group_evsel(_evsel, _leader) \
418 for ((_evsel) = _leader; \
419 (_evsel) && (_evsel)->core.leader == (&_leader->core); \
420 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
422 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
424 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
427 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
429 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
432 static inline bool evsel__has_callchain(const struct evsel *evsel)
435 * For reporting purposes, an evsel sample can have a recorded callchain
436 * or a callchain synthesized from AUX area data.
438 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
439 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
442 static inline bool evsel__has_br_stack(const struct evsel *evsel)
445 * For reporting purposes, an evsel sample can have a recorded branch
446 * stack or a branch stack synthesized from AUX area data.
448 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
449 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
452 static inline bool evsel__is_dummy_event(struct evsel *evsel)
454 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&
455 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);
458 struct perf_env *evsel__env(struct evsel *evsel);
460 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
462 void evsel__zero_per_pkg(struct evsel *evsel);
463 bool evsel__is_hybrid(struct evsel *evsel);
464 struct evsel *evsel__leader(struct evsel *evsel);
465 bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);
466 bool evsel__is_leader(struct evsel *evsel);
467 void evsel__set_leader(struct evsel *evsel, struct evsel *leader);
468 #endif /* __PERF_EVSEL_H */