286 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef __PMU_H3#define __PMU_H4 5#include <linux/bitmap.h>6#include <linux/compiler.h>7#include <linux/perf_event.h>8#include <linux/list.h>9#include <stdbool.h>10#include <stdio.h>11#include "parse-events.h"12#include "pmu-events/pmu-events.h"13#include "map_symbol.h"14#include "mem-events.h"15 16struct evsel_config_term;17struct perf_cpu_map;18struct print_callbacks;19 20enum {21 PERF_PMU_FORMAT_VALUE_CONFIG,22 PERF_PMU_FORMAT_VALUE_CONFIG1,23 PERF_PMU_FORMAT_VALUE_CONFIG2,24 PERF_PMU_FORMAT_VALUE_CONFIG3,25 PERF_PMU_FORMAT_VALUE_CONFIG_END,26};27 28#define PERF_PMU_FORMAT_BITS 6429#define MAX_PMU_NAME_LEN 12830 31struct perf_event_attr;32 33struct perf_pmu_caps {34 char *name;35 char *value;36 struct list_head list;37};38 39enum {40 PERF_PMU_TYPE_FAKE = 0xFFFFFFFF,41};42 43/**44 * struct perf_pmu45 */46struct perf_pmu {47 /** @name: The name of the PMU such as "cpu". */48 const char *name;49 /**50 * @alias_name: Optional alternate name for the PMU determined in51 * architecture specific code.52 */53 char *alias_name;54 /**55 * @id: Optional PMU identifier read from56 * <sysfs>/bus/event_source/devices/<name>/identifier.57 */58 const char *id;59 /**60 * @type: Perf event attributed type value, read from61 * <sysfs>/bus/event_source/devices/<name>/type.62 */63 __u32 type;64 /**65 * @selectable: Can the PMU name be selected as if it were an event?66 */67 bool selectable;68 /**69 * @is_core: Is the PMU the core CPU PMU? Determined by the name being70 * "cpu" or by the presence of71 * <sysfs>/bus/event_source/devices/<name>/cpus. There may be >1 core72 * PMU on systems like Intel hybrid.73 */74 bool is_core;75 /**76 * @is_uncore: Is the PMU not within the CPU core? Determined by the77 * presence of <sysfs>/bus/event_source/devices/<name>/cpumask.78 */79 bool is_uncore;80 /**81 * @auxtrace: Are events auxiliary events? Determined in architecture82 * specific code.83 */84 bool auxtrace;85 /**86 * @formats_checked: Only check PMU's formats are valid for87 * perf_event_attr once.88 */89 bool formats_checked;90 /** @config_masks_present: Are there config format values? */91 bool config_masks_present;92 /** @config_masks_computed: Set when masks are lazily computed. */93 bool config_masks_computed;94 /**95 * @max_precise: Number of levels of :ppp precision supported by the96 * PMU, read from97 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise.98 */99 int max_precise;100 /**101 * @perf_event_attr_init_default: Optional function to default102 * initialize PMU specific parts of the perf_event_attr.103 */104 void (*perf_event_attr_init_default)(const struct perf_pmu *pmu,105 struct perf_event_attr *attr);106 /**107 * @cpus: Empty or the contents of either of:108 * <sysfs>/bus/event_source/devices/<name>/cpumask.109 * <sysfs>/bus/event_source/devices/<cpu>/cpus.110 */111 struct perf_cpu_map *cpus;112 /**113 * @format: Holds the contents of files read from114 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify115 * which event parameter changes what config, config1 or config2 bits.116 */117 struct list_head format;118 /**119 * @aliases: List of struct perf_pmu_alias. Each alias corresponds to an120 * event read from <sysfs>/bus/event_source/devices/<name>/events/ or121 * from json events in pmu-events.c.122 */123 struct list_head aliases;124 /**125 * @events_table: The events table for json events in pmu-events.c.126 */127 const struct pmu_events_table *events_table;128 /** @sysfs_aliases: Number of sysfs aliases loaded. */129 uint32_t sysfs_aliases;130 /** @cpu_json_aliases: Number of json event aliases loaded specific to the CPUID. */131 uint32_t cpu_json_aliases;132 /** @sys_json_aliases: Number of json event aliases loaded matching the PMU's identifier. */133 uint32_t sys_json_aliases;134 /** @sysfs_aliases_loaded: Are sysfs aliases loaded from disk? */135 bool sysfs_aliases_loaded;136 /**137 * @cpu_aliases_added: Have all json events table entries for the PMU138 * been added?139 */140 bool cpu_aliases_added;141 /** @caps_initialized: Has the list caps been initialized? */142 bool caps_initialized;143 /** @nr_caps: The length of the list caps. */144 u32 nr_caps;145 /**146 * @caps: Holds the contents of files read from147 * <sysfs>/bus/event_source/devices/<name>/caps/.148 *149 * The contents are pairs of the filename with the value of its150 * contents, for example, max_precise (see above) may have a value of 3.151 */152 struct list_head caps;153 /** @list: Element on pmus list in pmu.c. */154 struct list_head list;155 156 /**157 * @config_masks: Derived from the PMU's format data, bits that are158 * valid within the config value.159 */160 __u64 config_masks[PERF_PMU_FORMAT_VALUE_CONFIG_END];161 162 /**163 * @missing_features: Features to inhibit when events on this PMU are164 * opened.165 */166 struct {167 /**168 * @exclude_guest: Disables perf_event_attr exclude_guest and169 * exclude_host.170 */171 bool exclude_guest;172 } missing_features;173 174 /**175 * @mem_events: List of the supported mem events176 */177 struct perf_mem_event *mem_events;178};179 180struct perf_pmu_info {181 const char *unit;182 double scale;183 bool per_pkg;184 bool snapshot;185};186 187struct pmu_event_info {188 const struct perf_pmu *pmu;189 const char *name;190 const char* alias;191 const char *scale_unit;192 const char *desc;193 const char *long_desc;194 const char *encoding_desc;195 const char *topic;196 const char *pmu_name;197 const char *event_type_desc;198 const char *str;199 bool deprecated;200};201 202typedef int (*pmu_event_callback)(void *state, struct pmu_event_info *info);203typedef int (*pmu_format_callback)(void *state, const char *name, int config,204 const unsigned long *bits);205 206void pmu_add_sys_aliases(struct perf_pmu *pmu);207int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,208 struct parse_events_terms *head_terms,209 struct parse_events_error *error);210int perf_pmu__config_terms(const struct perf_pmu *pmu,211 struct perf_event_attr *attr,212 struct parse_events_terms *terms,213 bool zero, struct parse_events_error *error);214__u64 perf_pmu__format_bits(struct perf_pmu *pmu, const char *name);215int perf_pmu__format_type(struct perf_pmu *pmu, const char *name);216int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_terms,217 struct perf_pmu_info *info, bool *rewrote_terms,218 struct parse_events_error *err);219int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb);220 221void perf_pmu_format__set_value(void *format, int config, unsigned long *bits);222bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name);223int perf_pmu__for_each_format(struct perf_pmu *pmu, void *state, pmu_format_callback cb);224 225bool is_pmu_core(const char *name);226bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu);227bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu);228bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name);229size_t perf_pmu__num_events(struct perf_pmu *pmu);230int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus,231 void *state, pmu_event_callback cb);232bool pmu__name_match(const struct perf_pmu *pmu, const char *pmu_name);233 234/**235 * perf_pmu_is_software - is the PMU a software PMU as in it uses the236 * perf_sw_context in the kernel?237 */238bool perf_pmu__is_software(const struct perf_pmu *pmu);239 240FILE *perf_pmu__open_file(const struct perf_pmu *pmu, const char *name);241FILE *perf_pmu__open_file_at(const struct perf_pmu *pmu, int dirfd, const char *name);242 243int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt, ...)244 __scanf(3, 4);245int perf_pmu__scan_file_at(const struct perf_pmu *pmu, int dirfd, const char *name,246 const char *fmt, ...) __scanf(4, 5);247 248bool perf_pmu__file_exists(const struct perf_pmu *pmu, const char *name);249 250int perf_pmu__test(void);251 252void perf_pmu__arch_init(struct perf_pmu *pmu);253void pmu_add_cpu_aliases_table(struct perf_pmu *pmu,254 const struct pmu_events_table *table);255 256char *perf_pmu__getcpuid(struct perf_pmu *pmu);257const struct pmu_metrics_table *pmu_metrics_table__find(void);258bool pmu_uncore_identifier_match(const char *compat, const char *id);259 260int perf_pmu__convert_scale(const char *scale, char **end, double *sval);261 262int perf_pmu__caps_parse(struct perf_pmu *pmu);263 264void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,265 const char *name, int config_num,266 const char *config_name);267void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu);268 269bool perf_pmu__match(const struct perf_pmu *pmu, const char *tok);270 271double perf_pmu__cpu_slots_per_cycle(void);272int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size);273int perf_pmu__pathname_scnprintf(char *buf, size_t size,274 const char *pmu_name, const char *filename);275int perf_pmu__event_source_devices_fd(void);276int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags);277 278struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name,279 bool eager_load);280struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus);281void perf_pmu__delete(struct perf_pmu *pmu);282struct perf_pmu *perf_pmus__find_core_pmu(void);283const char *perf_pmu__name_from_config(struct perf_pmu *pmu, u64 config);284 285#endif /* __PMU_H */286