600 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef __PERF_EVSEL_H3#define __PERF_EVSEL_H 14 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#include "pmus.h"14 15struct bpf_object;16struct cgroup;17struct perf_counts;18struct perf_stat_evsel;19union perf_event;20struct bpf_counter_ops;21struct target;22struct hashmap;23struct bperf_leader_bpf;24struct bperf_follower_bpf;25struct perf_pmu;26 27typedef int (evsel__sb_cb_t)(union perf_event *event, void *data);28 29enum perf_tool_event {30 PERF_TOOL_NONE = 0,31 PERF_TOOL_DURATION_TIME = 1,32 PERF_TOOL_USER_TIME = 2,33 PERF_TOOL_SYSTEM_TIME = 3,34 35 PERF_TOOL_MAX,36};37 38const char *perf_tool_event__to_str(enum perf_tool_event ev);39enum perf_tool_event perf_tool_event__from_str(const char *str);40 41#define perf_tool_event__for_each_event(ev) \42 for ((ev) = PERF_TOOL_DURATION_TIME; (ev) < PERF_TOOL_MAX; ev++)43 44/** struct evsel - event selector45 *46 * @evlist - evlist this evsel is in, if it is in one.47 * @core - libperf evsel object48 * @name - Can be set to retain the original event name passed by the user,49 * so that when showing results in tools such as 'perf stat', we50 * show the name used, not some alias.51 * @id_pos: the position of the event id (PERF_SAMPLE_ID or52 * PERF_SAMPLE_IDENTIFIER) in a sample event i.e. in the array of53 * struct perf_record_sample54 * @is_pos: the position (counting backwards) of the event id (PERF_SAMPLE_ID or55 * PERF_SAMPLE_IDENTIFIER) in a non-sample event i.e. if sample_id_all56 * is used there is an id sample appended to non-sample events57 * @priv: And what is in its containing unnamed union are tool specific58 */59struct evsel {60 struct perf_evsel core;61 struct evlist *evlist;62 off_t id_offset;63 int id_pos;64 int is_pos;65 unsigned int sample_size;66 67 /*68 * These fields can be set in the parse-events code or similar.69 * Please check evsel__clone() to copy them properly so that70 * they can be released properly.71 */72 struct {73 char *name;74 char *group_name;75 const char *pmu_name;76 const char *group_pmu_name;77#ifdef HAVE_LIBTRACEEVENT78 struct tep_event *tp_format;79#endif80 char *filter;81 unsigned long max_events;82 double scale;83 const char *unit;84 struct cgroup *cgrp;85 const char *metric_id;86 enum perf_tool_event tool_event;87 /* parse modifier helper */88 int exclude_GH;89 int sample_read;90 bool snapshot;91 bool per_pkg;92 bool percore;93 bool precise_max;94 bool is_libpfm_event;95 bool auto_merge_stats;96 bool collect_stat;97 bool weak_group;98 bool bpf_counter;99 bool use_config_name;100 bool skippable;101 bool retire_lat;102 int bpf_fd;103 struct bpf_object *bpf_obj;104 struct list_head config_terms;105 };106 107 /*108 * metric fields are similar, but needs more care as they can have109 * references to other metric (evsel).110 */111 struct evsel **metric_events;112 struct evsel *metric_leader;113 114 void *handler;115 struct perf_counts *counts;116 struct perf_counts *prev_raw_counts;117 unsigned long nr_events_printed;118 struct perf_stat_evsel *stats;119 void *priv;120 u64 db_id;121 bool uniquified_name;122 bool supported;123 bool needs_swap;124 bool disabled;125 bool no_aux_samples;126 bool immediate;127 bool tracking;128 bool ignore_missing_thread;129 bool forced_leader;130 bool cmdline_group_boundary;131 bool merged_stat;132 bool reset_group;133 bool errored;134 bool needs_auxtrace_mmap;135 bool default_metricgroup; /* A member of the Default metricgroup */136 struct hashmap *per_pkg_mask;137 int err;138 struct {139 evsel__sb_cb_t *cb;140 void *data;141 } side_band;142 /*143 * For reporting purposes, an evsel sample can have a callchain144 * synthesized from AUX area data. Keep track of synthesized sample145 * types here. Note, the recorded sample_type cannot be changed because146 * it is needed to continue to parse events.147 * See also evsel__has_callchain().148 */149 __u64 synth_sample_type;150 151 /*152 * Store the branch counter related information.153 * br_cntr_idx: The idx of the branch counter event in the evlist154 * br_cntr_nr: The number of the branch counter event in the group155 * (Only available for the leader event)156 * abbr_name: The abbreviation name assigned to an event which is157 * logged by the branch counter.158 * The abbr name is from A to Z9. NA is applied if out159 * of the range.160 */161 int br_cntr_idx;162 int br_cntr_nr;163 char abbr_name[3];164 165 /*166 * bpf_counter_ops serves two use cases:167 * 1. perf-stat -b counting events used byBPF programs168 * 2. perf-stat --use-bpf use BPF programs to aggregate counts169 */170 struct bpf_counter_ops *bpf_counter_ops;171 172 struct list_head bpf_counter_list; /* for perf-stat -b */173 struct list_head bpf_filters; /* for perf-record --filter */174 175 /* for perf-stat --use-bpf */176 int bperf_leader_prog_fd;177 int bperf_leader_link_fd;178 union {179 struct bperf_leader_bpf *leader_skel;180 struct bperf_follower_bpf *follower_skel;181 void *bpf_skel;182 };183 unsigned long open_flags;184 int precise_ip_original;185 186 /* for missing_features */187 struct perf_pmu *pmu;188 189 /* For tool events */190 /* Beginning time subtracted when the counter is read. */191 union {192 /* duration_time is a single global time. */193 __u64 start_time;194 /*195 * user_time and system_time read an initial value potentially196 * per-CPU or per-pid.197 */198 struct xyarray *start_times;199 };200 /* Is the tool's fd for /proc/pid/stat or /proc/stat. */201 bool pid_stat;202};203 204struct perf_missing_features {205 bool sample_id_all;206 bool exclude_guest;207 bool mmap2;208 bool cloexec;209 bool clockid;210 bool clockid_wrong;211 bool lbr_flags;212 bool write_backward;213 bool group_read;214 bool ksymbol;215 bool bpf;216 bool aux_output;217 bool branch_hw_idx;218 bool cgroup;219 bool data_page_size;220 bool code_page_size;221 bool weight_struct;222 bool read_lost;223 bool branch_counters;224};225 226extern struct perf_missing_features perf_missing_features;227 228struct perf_cpu_map;229struct thread_map;230struct record_opts;231 232static inline struct perf_cpu_map *evsel__cpus(struct evsel *evsel)233{234 return perf_evsel__cpus(&evsel->core);235}236 237static inline int evsel__nr_cpus(struct evsel *evsel)238{239 return perf_cpu_map__nr(evsel__cpus(evsel));240}241 242void evsel__compute_deltas(struct evsel *evsel, int cpu, int thread,243 struct perf_counts_values *count);244 245int evsel__object_config(size_t object_size,246 int (*init)(struct evsel *evsel),247 void (*fini)(struct evsel *evsel));248 249struct perf_pmu *evsel__find_pmu(const struct evsel *evsel);250bool evsel__is_aux_event(const struct evsel *evsel);251 252struct evsel *evsel__new_idx(struct perf_event_attr *attr, int idx);253 254static inline struct evsel *evsel__new(struct perf_event_attr *attr)255{256 return evsel__new_idx(attr, 0);257}258 259struct evsel *evsel__clone(struct evsel *orig);260 261int copy_config_terms(struct list_head *dst, struct list_head *src);262void free_config_terms(struct list_head *config_terms);263 264 265#ifdef HAVE_LIBTRACEEVENT266struct evsel *evsel__newtp_idx(const char *sys, const char *name, int idx, bool format);267 268/*269 * Returns pointer with encoded error via <linux/err.h> interface.270 */271static inline struct evsel *evsel__newtp(const char *sys, const char *name)272{273 return evsel__newtp_idx(sys, name, 0, true);274}275#endif276 277#ifdef HAVE_LIBTRACEEVENT278struct tep_event *event_format__new(const char *sys, const char *name);279#endif280 281void evsel__init(struct evsel *evsel, struct perf_event_attr *attr, int idx);282void evsel__exit(struct evsel *evsel);283void evsel__delete(struct evsel *evsel);284 285struct callchain_param;286 287void evsel__config(struct evsel *evsel, struct record_opts *opts,288 struct callchain_param *callchain);289void evsel__config_callchain(struct evsel *evsel, struct record_opts *opts,290 struct callchain_param *callchain);291 292int __evsel__sample_size(u64 sample_type);293void evsel__calc_id_pos(struct evsel *evsel);294 295bool evsel__is_cache_op_valid(u8 type, u8 op);296 297static inline bool evsel__is_bpf(struct evsel *evsel)298{299 return evsel->bpf_counter_ops != NULL;300}301 302static inline bool evsel__is_bperf(struct evsel *evsel)303{304 return evsel->bpf_counter_ops != NULL && list_empty(&evsel->bpf_counter_list);305}306 307#define EVSEL__MAX_ALIASES 8308 309extern const char *const evsel__hw_cache[PERF_COUNT_HW_CACHE_MAX][EVSEL__MAX_ALIASES];310extern const char *const evsel__hw_cache_op[PERF_COUNT_HW_CACHE_OP_MAX][EVSEL__MAX_ALIASES];311extern const char *const evsel__hw_cache_result[PERF_COUNT_HW_CACHE_RESULT_MAX][EVSEL__MAX_ALIASES];312extern const char *const evsel__hw_names[PERF_COUNT_HW_MAX];313extern const char *const evsel__sw_names[PERF_COUNT_SW_MAX];314extern char *evsel__bpf_counter_events;315bool evsel__match_bpf_counter_events(const char *name);316int arch_evsel__hw_name(struct evsel *evsel, char *bf, size_t size);317 318int __evsel__hw_cache_type_op_res_name(u8 type, u8 op, u8 result, char *bf, size_t size);319const char *evsel__name(struct evsel *evsel);320bool evsel__name_is(struct evsel *evsel, const char *name);321const char *evsel__metric_id(const struct evsel *evsel);322 323static inline bool evsel__is_tool(const struct evsel *evsel)324{325 return evsel->tool_event != PERF_TOOL_NONE;326}327 328static inline bool evsel__is_retire_lat(const struct evsel *evsel)329{330 return evsel->retire_lat;331}332 333static inline enum perf_tool_event evsel__tool_event(const struct evsel *evsel)334{335 return evsel->tool_event;336}337 338const char *evsel__group_name(struct evsel *evsel);339int evsel__group_desc(struct evsel *evsel, char *buf, size_t size);340 341void __evsel__set_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);342void __evsel__reset_sample_bit(struct evsel *evsel, enum perf_event_sample_format bit);343 344#define evsel__set_sample_bit(evsel, bit) \345 __evsel__set_sample_bit(evsel, PERF_SAMPLE_##bit)346 347#define evsel__reset_sample_bit(evsel, bit) \348 __evsel__reset_sample_bit(evsel, PERF_SAMPLE_##bit)349 350void evsel__set_sample_id(struct evsel *evsel, bool use_sample_identifier);351 352void arch_evsel__set_sample_weight(struct evsel *evsel);353void arch__post_evsel_config(struct evsel *evsel, struct perf_event_attr *attr);354int arch_evsel__open_strerror(struct evsel *evsel, char *msg, size_t size);355 356int evsel__set_filter(struct evsel *evsel, const char *filter);357int evsel__append_tp_filter(struct evsel *evsel, const char *filter);358int evsel__append_addr_filter(struct evsel *evsel, const char *filter);359int evsel__enable_cpu(struct evsel *evsel, int cpu_map_idx);360int evsel__enable(struct evsel *evsel);361int evsel__disable(struct evsel *evsel);362int evsel__disable_cpu(struct evsel *evsel, int cpu_map_idx);363 364int evsel__open_per_cpu(struct evsel *evsel, struct perf_cpu_map *cpus, int cpu_map_idx);365int evsel__open_per_thread(struct evsel *evsel, struct perf_thread_map *threads);366int evsel__open(struct evsel *evsel, struct perf_cpu_map *cpus,367 struct perf_thread_map *threads);368void evsel__close(struct evsel *evsel);369int evsel__prepare_open(struct evsel *evsel, struct perf_cpu_map *cpus,370 struct perf_thread_map *threads);371bool evsel__detect_missing_features(struct evsel *evsel);372 373bool evsel__precise_ip_fallback(struct evsel *evsel);374 375struct perf_sample;376 377#ifdef HAVE_LIBTRACEEVENT378void *evsel__rawptr(struct evsel *evsel, struct perf_sample *sample, const char *name);379u64 evsel__intval(struct evsel *evsel, struct perf_sample *sample, const char *name);380u64 evsel__intval_common(struct evsel *evsel, struct perf_sample *sample, const char *name);381char evsel__taskstate(struct evsel *evsel, struct perf_sample *sample, const char *name);382 383static inline char *evsel__strval(struct evsel *evsel, struct perf_sample *sample, const char *name)384{385 return evsel__rawptr(evsel, sample, name);386}387#endif388 389struct tep_format_field;390 391u64 format_field__intval(struct tep_format_field *field, struct perf_sample *sample, bool needs_swap);392 393struct tep_format_field *evsel__field(struct evsel *evsel, const char *name);394struct tep_format_field *evsel__common_field(struct evsel *evsel, const char *name);395 396static inline bool __evsel__match(const struct evsel *evsel, u32 type, u64 config)397{398 if (evsel->core.attr.type != type)399 return false;400 401 if ((type == PERF_TYPE_HARDWARE || type == PERF_TYPE_HW_CACHE) &&402 perf_pmus__supports_extended_type())403 return (evsel->core.attr.config & PERF_HW_EVENT_MASK) == config;404 405 return evsel->core.attr.config == config;406}407 408#define evsel__match(evsel, t, c) __evsel__match(evsel, PERF_TYPE_##t, PERF_COUNT_##c)409 410static inline bool evsel__match2(struct evsel *e1, struct evsel *e2)411{412 return (e1->core.attr.type == e2->core.attr.type) &&413 (e1->core.attr.config == e2->core.attr.config);414}415 416int evsel__read_counter(struct evsel *evsel, int cpu_map_idx, int thread);417 418int __evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread, bool scale);419 420/**421 * evsel__read_on_cpu - Read out the results on a CPU and thread422 *423 * @evsel - event selector to read value424 * @cpu_map_idx - CPU of interest425 * @thread - thread of interest426 */427static inline int evsel__read_on_cpu(struct evsel *evsel, int cpu_map_idx, int thread)428{429 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, false);430}431 432/**433 * evsel__read_on_cpu_scaled - Read out the results on a CPU and thread, scaled434 *435 * @evsel - event selector to read value436 * @cpu_map_idx - CPU of interest437 * @thread - thread of interest438 */439static inline int evsel__read_on_cpu_scaled(struct evsel *evsel, int cpu_map_idx, int thread)440{441 return __evsel__read_on_cpu(evsel, cpu_map_idx, thread, true);442}443 444int evsel__parse_sample(struct evsel *evsel, union perf_event *event,445 struct perf_sample *sample);446 447int evsel__parse_sample_timestamp(struct evsel *evsel, union perf_event *event,448 u64 *timestamp);449 450u16 evsel__id_hdr_size(const struct evsel *evsel);451 452static inline struct evsel *evsel__next(struct evsel *evsel)453{454 return list_entry(evsel->core.node.next, struct evsel, core.node);455}456 457static inline struct evsel *evsel__prev(struct evsel *evsel)458{459 return list_entry(evsel->core.node.prev, struct evsel, core.node);460}461 462/**463 * evsel__is_group_leader - Return whether given evsel is a leader event464 *465 * @evsel - evsel selector to be tested466 *467 * Return %true if @evsel is a group leader or a stand-alone event468 */469static inline bool evsel__is_group_leader(const struct evsel *evsel)470{471 return evsel->core.leader == &evsel->core;472}473 474/**475 * evsel__is_group_event - Return whether given evsel is a group event476 *477 * @evsel - evsel selector to be tested478 *479 * Return %true iff event group view is enabled and @evsel is a actual group480 * leader which has other members in the group481 */482static inline bool evsel__is_group_event(struct evsel *evsel)483{484 if (!symbol_conf.event_group)485 return false;486 487 return evsel__is_group_leader(evsel) && evsel->core.nr_members > 1;488}489 490bool evsel__is_function_event(struct evsel *evsel);491 492static inline bool evsel__is_bpf_output(struct evsel *evsel)493{494 return evsel__match(evsel, SOFTWARE, SW_BPF_OUTPUT);495}496 497static inline bool evsel__is_clock(const struct evsel *evsel)498{499 return evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||500 evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK);501}502 503bool evsel__fallback(struct evsel *evsel, struct target *target, int err,504 char *msg, size_t msgsize);505int evsel__open_strerror(struct evsel *evsel, struct target *target,506 int err, char *msg, size_t size);507 508static inline int evsel__group_idx(struct evsel *evsel)509{510 return evsel->core.idx - evsel->core.leader->idx;511}512 513/* Iterates group WITHOUT the leader. */514#define for_each_group_member_head(_evsel, _leader, _head) \515for ((_evsel) = list_entry((_leader)->core.node.next, struct evsel, core.node); \516 (_evsel) && &(_evsel)->core.node != (_head) && \517 (_evsel)->core.leader == &(_leader)->core; \518 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))519 520#define for_each_group_member(_evsel, _leader) \521 for_each_group_member_head(_evsel, _leader, &(_leader)->evlist->core.entries)522 523/* Iterates group WITH the leader. */524#define for_each_group_evsel_head(_evsel, _leader, _head) \525for ((_evsel) = _leader; \526 (_evsel) && &(_evsel)->core.node != (_head) && \527 (_evsel)->core.leader == &(_leader)->core; \528 (_evsel) = list_entry((_evsel)->core.node.next, struct evsel, core.node))529 530#define for_each_group_evsel(_evsel, _leader) \531 for_each_group_evsel_head(_evsel, _leader, &(_leader)->evlist->core.entries)532 533static inline bool evsel__has_branch_callstack(const struct evsel *evsel)534{535 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_CALL_STACK;536}537 538static inline bool evsel__has_branch_hw_idx(const struct evsel *evsel)539{540 return evsel->core.attr.branch_sample_type & PERF_SAMPLE_BRANCH_HW_INDEX;541}542 543static inline bool evsel__has_callchain(const struct evsel *evsel)544{545 /*546 * For reporting purposes, an evsel sample can have a recorded callchain547 * or a callchain synthesized from AUX area data.548 */549 return evsel->core.attr.sample_type & PERF_SAMPLE_CALLCHAIN ||550 evsel->synth_sample_type & PERF_SAMPLE_CALLCHAIN;551}552 553static inline bool evsel__has_br_stack(const struct evsel *evsel)554{555 /*556 * For reporting purposes, an evsel sample can have a recorded branch557 * stack or a branch stack synthesized from AUX area data.558 */559 return evsel->core.attr.sample_type & PERF_SAMPLE_BRANCH_STACK ||560 evsel->synth_sample_type & PERF_SAMPLE_BRANCH_STACK;561}562 563static inline bool evsel__is_dummy_event(struct evsel *evsel)564{565 return (evsel->core.attr.type == PERF_TYPE_SOFTWARE) &&566 (evsel->core.attr.config == PERF_COUNT_SW_DUMMY);567}568 569struct perf_env *evsel__env(struct evsel *evsel);570 571int evsel__store_ids(struct evsel *evsel, struct evlist *evlist);572 573void evsel__zero_per_pkg(struct evsel *evsel);574bool evsel__is_hybrid(const struct evsel *evsel);575struct evsel *evsel__leader(const struct evsel *evsel);576bool evsel__has_leader(struct evsel *evsel, struct evsel *leader);577bool evsel__is_leader(struct evsel *evsel);578void evsel__set_leader(struct evsel *evsel, struct evsel *leader);579int evsel__source_count(const struct evsel *evsel);580void evsel__remove_from_group(struct evsel *evsel, struct evsel *leader);581 582bool arch_evsel__must_be_in_group(const struct evsel *evsel);583 584/*585 * Macro to swap the bit-field postition and size.586 * Used when,587 * - dont need to swap the entire u64 &&588 * - when u64 has variable bit-field sizes &&589 * - when presented in a host endian which is different590 * than the source endian of the perf.data file591 */592#define bitfield_swap(src, pos, size) \593 ((((src) >> (pos)) & ((1ull << (size)) - 1)) << (63 - ((pos) + (size) - 1)))594 595u64 evsel__bitfield_swap_branch_flags(u64 value);596void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,597 const char *config_name, u64 val);598 599#endif /* __PERF_EVSEL_H */600