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;
21 typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);
23 enum perf_tool_event {
25 PERF_TOOL_DURATION_TIME = 1,
28 /** struct evsel - event selector
30 * @evlist - evlist this evsel is in, if it is in one.
31 * @core - libperf evsel object
32 * @name - Can be set to retain the original event name passed by the user,
33 * so that when showing results in tools such as 'perf stat', we
34 * show the name used, not some alias.
35 * @id_pos: the position of the event id (PERF_SAMPLE_ID or
36 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of
37 * struct perf_record_sample
38 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or
39 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all
40 * is used there is an id sample appended to non-sample events
41 * @priv: And what is in its containing unnamed union are tool specific
44 struct perf_evsel core;
45 struct evlist *evlist;
47 struct perf_counts *counts;
48 struct perf_counts *prev_raw_counts;
50 unsigned long max_events;
51 unsigned long nr_events_printed;
55 struct tep_event *tp_format;
57 struct perf_stat_evsel *stats;
62 unsigned int sample_size;
65 enum perf_tool_event tool_event;
76 bool ignore_missing_thread;
78 bool use_uncore_alias;
80 /* parse modifier helper */
83 unsigned long *per_pkg_mask;
86 bool cmdline_group_boundary;
87 struct list_head config_terms;
88 struct bpf_object *bpf_obj;
91 bool auto_merge_stats;
93 const char * metric_expr;
94 const char * metric_name;
95 struct evsel **metric_events;
96 struct evsel *metric_leader;
103 const char *pmu_name;
109 * For reporting purposes, an evsel sample can have a callchain
110 * synthesized from AUX area data. Keep track of synthesized sample
111 * types here. Note, the recorded sample_type cannot be changed because
112 * it is needed to continue to parse events.
113 * See also evsel__has_callchain().
115 __u64 synth_sample_type;
118 struct perf_missing_features {
135 extern struct perf_missing_features perf_missing_features;
142 static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)
144 return perf_evsel__cpus(&evsel->core);
147 static inline int evsel__nr_cpus(struct evsel *evsel)
149 return evsel__cpus(evsel)->nr;
152 void perf_counts_values__scale(struct perf_counts_values *count,
153 bool scale, s8 *pscaled);
155 void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,
156 struct perf_counts_values *count);
158 int evsel__object_config(size_t object_size,
159 int (*init)(struct evsel *evsel),
160 void (*fini)(struct evsel *evsel));
162 struct perf_pmu *evsel__find_pmu(struct evsel *evsel);
163 bool evsel__is_aux_event(struct evsel *evsel);
165 struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);
167 static inline struct evsel *evsel__new(struct perf_event_attr *attr)
169 return evsel__new_idx(attr, 0);
172 struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx);
175 * Returns pointer with encoded error via <linux/err.h> interface.
177 static inline struct evsel *evsel__newtp(const char *sys, const char *name)
179 return evsel__newtp_idx(sys, name, 0);
182 struct evsel *evsel__new_cycles(bool precise);
184 struct tep_event *event_format__new(const char *sys, const char *name);
186 void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);
187 void evsel__exit(struct evsel *evsel);
188 void evsel__delete(struct evsel *evsel);
190 struct callchain_param;
192 void evsel__config(struct evsel *evsel, struct record_opts *opts,
193 struct callchain_param *callchain);
194 void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,
195 struct callchain_param *callchain);
197 int __evsel__sample_size(u64 sample_type);
198 void evsel__calc_id_pos(struct evsel *evsel);
200 bool evsel__is_cache_op_valid(u8 type, u8 op);
202 #define EVSEL__MAX_ALIASES 8
204 extern const char *evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];
205 extern const char *evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];
206 extern const char *evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];
207 extern const char *evsel__hw_names[PERF_COUNT_HW_MAX];
208 extern const char *evsel__sw_names[PERF_COUNT_SW_MAX];
209 int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);
210 const char *evsel__name(struct evsel *evsel);
212 const char *evsel__group_name(struct evsel *evsel);
213 int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);
215 void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
216 void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);
218 #define evsel__set_sample_bit(evsel, bit) \
219 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)
221 #define evsel__reset_sample_bit(evsel, bit) \
222 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)
224 void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);
226 int evsel__set_filter(struct evsel *evsel, const char *filter);
227 int evsel__append_tp_filter(struct evsel *evsel, const char *filter);
228 int evsel__append_addr_filter(struct evsel *evsel, const char *filter);
229 int evsel__enable_cpu(struct evsel *evsel, int cpu);
230 int evsel__enable(struct evsel *evsel);
231 int evsel__disable(struct evsel *evsel);
232 int evsel__disable_cpu(struct evsel *evsel, int cpu);
234 int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu);
235 int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);
236 int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,
237 struct perf_thread_map *threads);
238 void evsel__close(struct evsel *evsel);
242 void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);
243 u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);
245 static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)
247 return evsel__rawptr(evsel, sample, name);
250 struct tep_format_field;
252 u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);
254 struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);
256 #define evsel__match(evsel, t, c) \
257 (evsel->core.attr.type == PERF_TYPE_##t && \
258 evsel->core.attr.config == PERF_COUNT_##c)
260 static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)
262 return (e1->core.attr.type == e2->core.attr.type) &&
263 (e1->core.attr.config == e2->core.attr.config);
266 int evsel__read_counter(struct evsel *evsel, int cpu, int thread);
268 int __evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread, bool scale);
271 * evsel__read_on_cpu - Read out the results on a CPU and thread
273 * @evsel - event selector to read value
274 * @cpu - CPU of interest
275 * @thread - thread of interest
277 static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu, int thread)
279 return __evsel__read_on_cpu(evsel, cpu, thread, false);
283 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled
285 * @evsel - event selector to read value
286 * @cpu - CPU of interest
287 * @thread - thread of interest
289 static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu, int thread)
291 return __evsel__read_on_cpu(evsel, cpu, thread, true);
294 int evsel__parse_sample(struct evsel *evsel, union perf_event *event,
295 struct perf_sample *sample);
297 int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,
300 static inline struct evsel *evsel__next(struct evsel *evsel)
302 return list_entry(evsel->core.node.next, struct evsel, core.node);
305 static inline struct evsel *evsel__prev(struct evsel *evsel)
307 return list_entry(evsel->core.node.prev, struct evsel, core.node);
311 * evsel__is_group_leader - Return whether given evsel is a leader event
313 * @evsel - evsel selector to be tested
315 * Return %true if @evsel is a group leader or a stand-alone event
317 static inline bool evsel__is_group_leader(const struct evsel *evsel)
319 return evsel->leader == evsel;
323 * evsel__is_group_event - Return whether given evsel is a group event
325 * @evsel - evsel selector to be tested
327 * Return %true iff event group view is enabled and @evsel is a actual group
328 * leader which has other members in the group
330 static inline bool evsel__is_group_event(struct evsel *evsel)
332 if (!symbol_conf.event_group)
335 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;
338 bool evsel__is_function_event(struct evsel *evsel);
340 static inline bool evsel__is_bpf_output(struct evsel *evsel)
342 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);
345 static inline bool evsel__is_clock(struct evsel *evsel)
347 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
348 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);
351 bool evsel__fallback(struct evsel *evsel, int err, char *msg, size_t msgsize);
352 int evsel__open_strerror(struct evsel *evsel, struct target *target,
353 int err, char *msg, size_t size);
355 static inline int evsel__group_idx(struct evsel *evsel)
357 return evsel->idx - evsel->leader->idx;
360 /* Iterates group WITHOUT the leader. */
361 #define for_each_group_member(_evsel, _leader) \
362 for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \
363 (_evsel) && (_evsel)->leader == (_leader); \
364 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
366 /* Iterates group WITH the leader. */
367 #define for_each_group_evsel(_evsel, _leader) \
368 for ((_evsel) = _leader; \
369 (_evsel) && (_evsel)->leader == (_leader); \
370 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))
372 static inline bool evsel__has_branch_callstack(const struct evsel *evsel)
374 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;
377 static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)
379 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;
382 static inline bool evsel__has_callchain(const struct evsel *evsel)
385 * For reporting purposes, an evsel sample can have a recorded callchain
386 * or a callchain synthesized from AUX area data.
388 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||
389 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;
392 static inline bool evsel__has_br_stack(const struct evsel *evsel)
395 * For reporting purposes, an evsel sample can have a recorded branch
396 * stack or a branch stack synthesized from AUX area data.
398 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||
399 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;
402 struct perf_env *evsel__env(struct evsel *evsel);
404 int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);
405 #endif /* __PERF_EVSEL_H */