1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __PMU_H 3 #define __PMU_H 4 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 16 struct evsel_config_term; 17 struct hashmap; 18 struct perf_cpu_map; 19 struct print_callbacks; 20 21 enum { 22 PERF_PMU_FORMAT_VALUE_CONFIG, 23 PERF_PMU_FORMAT_VALUE_CONFIG1, 24 PERF_PMU_FORMAT_VALUE_CONFIG2, 25 PERF_PMU_FORMAT_VALUE_CONFIG3, 26 PERF_PMU_FORMAT_VALUE_CONFIG_END, 27 }; 28 29 #define PERF_PMU_FORMAT_BITS 64 30 #define MAX_PMU_NAME_LEN 128 31 32 struct perf_event_attr; 33 34 struct perf_pmu_caps { 35 char *name; 36 char *value; 37 struct list_head list; 38 }; 39 40 enum { 41 PERF_PMU_TYPE_PE_START = 0, 42 PERF_PMU_TYPE_PE_END = 0xFFFEFFFF, 43 PERF_PMU_TYPE_HWMON_START = 0xFFFF0000, 44 PERF_PMU_TYPE_HWMON_END = 0xFFFFFFFD, 45 PERF_PMU_TYPE_TOOL = 0xFFFFFFFE, 46 PERF_PMU_TYPE_FAKE = 0xFFFFFFFF, 47 }; 48 49 /** 50 * struct perf_pmu 51 */ 52 struct perf_pmu { 53 /** @name: The name of the PMU such as "cpu". */ 54 const char *name; 55 /** 56 * @alias_name: Optional alternate name for the PMU determined in 57 * architecture specific code. 58 */ 59 char *alias_name; 60 /** 61 * @id: Optional PMU identifier read from 62 * <sysfs>/bus/event_source/devices/<name>/identifier. 63 */ 64 const char *id; 65 /** 66 * @type: Perf event attributed type value, read from 67 * <sysfs>/bus/event_source/devices/<name>/type. 68 */ 69 __u32 type; 70 /** 71 * @selectable: Can the PMU name be selected as if it were an event? 72 */ 73 bool selectable; 74 /** 75 * @is_core: Is the PMU the core CPU PMU? Determined by the name being 76 * "cpu" or by the presence of 77 * <sysfs>/bus/event_source/devices/<name>/cpus. There may be >1 core 78 * PMU on systems like Intel hybrid. 79 */ 80 bool is_core; 81 /** 82 * @is_uncore: Is the PMU not within the CPU core? Determined by the 83 * presence of <sysfs>/bus/event_source/devices/<name>/cpumask. 84 */ 85 bool is_uncore; 86 /** 87 * @auxtrace: Are events auxiliary events? Determined in architecture 88 * specific code. 89 */ 90 bool auxtrace; 91 /** 92 * @formats_checked: Only check PMU's formats are valid for 93 * perf_event_attr once. 94 */ 95 bool formats_checked; 96 /** @config_masks_present: Are there config format values? */ 97 bool config_masks_present; 98 /** @config_masks_computed: Set when masks are lazily computed. */ 99 bool config_masks_computed; 100 /** 101 * @max_precise: Number of levels of :ppp precision supported by the 102 * PMU, read from 103 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise. 104 */ 105 int max_precise; 106 /** 107 * @perf_event_attr_init_default: Optional function to default 108 * initialize PMU specific parts of the perf_event_attr. 109 */ 110 void (*perf_event_attr_init_default)(const struct perf_pmu *pmu, 111 struct perf_event_attr *attr); 112 /** 113 * @cpus: Empty or the contents of either of: 114 * <sysfs>/bus/event_source/devices/<name>/cpumask. 115 * <sysfs>/bus/event_source/devices/<cpu>/cpus. 116 */ 117 struct perf_cpu_map *cpus; 118 /** 119 * @format: Holds the contents of files read from 120 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify 121 * which event parameter changes what config, config1 or config2 bits. 122 */ 123 struct list_head format; 124 /** 125 * @aliases: List of struct perf_pmu_alias. Each alias corresponds to an 126 * event read from <sysfs>/bus/event_source/devices/<name>/events/ or 127 * from json events in pmu-events.c. 128 */ 129 struct hashmap *aliases; 130 /** 131 * @events_table: The events table for json events in pmu-events.c. 132 */ 133 const struct pmu_events_table *events_table; 134 /** @sysfs_aliases: Number of sysfs aliases loaded. */ 135 uint32_t sysfs_aliases; 136 /** @cpu_json_aliases: Number of json event aliases loaded specific to the CPUID. */ 137 uint32_t cpu_json_aliases; 138 /** @sys_json_aliases: Number of json event aliases loaded matching the PMU's identifier. */ 139 uint32_t sys_json_aliases; 140 /** 141 * @cpu_common_json_aliases: Number of json events that overlapped with sysfs when 142 * loading all sysfs events. 143 */ 144 uint32_t cpu_common_json_aliases; 145 /** @sysfs_aliases_loaded: Are sysfs aliases loaded from disk? */ 146 bool sysfs_aliases_loaded; 147 /** 148 * @cpu_aliases_added: Have all json events table entries for the PMU 149 * been added? 150 */ 151 bool cpu_aliases_added; 152 /** @caps_initialized: Has the list caps been initialized? */ 153 bool caps_initialized; 154 /** @nr_caps: The length of the list caps. */ 155 u32 nr_caps; 156 /** 157 * @caps: Holds the contents of files read from 158 * <sysfs>/bus/event_source/devices/<name>/caps/. 159 * 160 * The contents are pairs of the filename with the value of its 161 * contents, for example, max_precise (see above) may have a value of 3. 162 */ 163 struct list_head caps; 164 /** @list: Element on pmus list in pmu.c. */ 165 struct list_head list; 166 167 /** 168 * @config_masks: Derived from the PMU's format data, bits that are 169 * valid within the config value. 170 */ 171 __u64 config_masks[PERF_PMU_FORMAT_VALUE_CONFIG_END]; 172 173 /** 174 * @missing_features: Features to inhibit when events on this PMU are 175 * opened. 176 */ 177 struct { 178 /** 179 * @exclude_guest: Disables perf_event_attr exclude_guest and 180 * exclude_host. 181 */ 182 bool exclude_guest; 183 /** 184 * @checked: Are the missing features checked? 185 */ 186 bool checked; 187 } missing_features; 188 189 /** 190 * @mem_events: List of the supported mem events 191 */ 192 struct perf_mem_event *mem_events; 193 }; 194 195 struct perf_pmu_info { 196 const char *unit; 197 double scale; 198 double retirement_latency_mean; 199 double retirement_latency_min; 200 double retirement_latency_max; 201 bool per_pkg; 202 bool snapshot; 203 }; 204 205 struct pmu_event_info { 206 const struct perf_pmu *pmu; 207 const char *name; 208 const char* alias; 209 const char *scale_unit; 210 const char *desc; 211 const char *long_desc; 212 const char *encoding_desc; 213 const char *topic; 214 const char *pmu_name; 215 const char *event_type_desc; 216 const char *str; 217 bool deprecated; 218 }; 219 220 typedef int (*pmu_event_callback)(void *state, struct pmu_event_info *info); 221 typedef int (*pmu_format_callback)(void *state, const char *name, int config, 222 const unsigned long *bits); 223 224 void pmu_add_sys_aliases(struct perf_pmu *pmu); 225 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr, 226 struct parse_events_terms *head_terms, 227 bool apply_hardcoded, 228 struct parse_events_error *error); 229 int perf_pmu__config_terms(const struct perf_pmu *pmu, 230 struct perf_event_attr *attr, 231 struct parse_events_terms *terms, 232 bool zero, bool apply_hardcoded, 233 struct parse_events_error *error); 234 __u64 perf_pmu__format_bits(struct perf_pmu *pmu, const char *name); 235 int perf_pmu__format_type(struct perf_pmu *pmu, const char *name); 236 int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_terms, 237 struct perf_pmu_info *info, bool *rewrote_terms, 238 u64 *alternate_hw_config, struct parse_events_error *err); 239 int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb); 240 241 void perf_pmu_format__set_value(void *format, int config, unsigned long *bits); 242 bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name); 243 int perf_pmu__for_each_format(struct perf_pmu *pmu, void *state, pmu_format_callback cb); 244 245 bool is_pmu_core(const char *name); 246 bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu); 247 bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu); 248 bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name); 249 size_t perf_pmu__num_events(struct perf_pmu *pmu); 250 int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus, 251 void *state, pmu_event_callback cb); 252 bool perf_pmu__name_wildcard_match(const struct perf_pmu *pmu, const char *to_match); 253 bool perf_pmu__name_no_suffix_match(const struct perf_pmu *pmu, const char *to_match); 254 255 /** 256 * perf_pmu_is_software - is the PMU a software PMU as in it uses the 257 * perf_sw_context in the kernel? 258 */ 259 bool perf_pmu__is_software(const struct perf_pmu *pmu); 260 261 FILE *perf_pmu__open_file(const struct perf_pmu *pmu, const char *name); 262 FILE *perf_pmu__open_file_at(const struct perf_pmu *pmu, int dirfd, const char *name); 263 264 int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt, ...) 265 __scanf(3, 4); 266 int perf_pmu__scan_file_at(const struct perf_pmu *pmu, int dirfd, const char *name, 267 const char *fmt, ...) __scanf(4, 5); 268 269 bool perf_pmu__file_exists(const struct perf_pmu *pmu, const char *name); 270 271 int perf_pmu__test(void); 272 273 void perf_pmu__arch_init(struct perf_pmu *pmu); 274 void pmu_add_cpu_aliases_table(struct perf_pmu *pmu, 275 const struct pmu_events_table *table); 276 277 bool pmu_uncore_identifier_match(const char *compat, const char *id); 278 279 int perf_pmu__convert_scale(const char *scale, char **end, double *sval); 280 281 struct perf_pmu_caps *perf_pmu__get_cap(struct perf_pmu *pmu, const char *name); 282 283 int perf_pmu__caps_parse(struct perf_pmu *pmu); 284 285 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config, 286 const char *name, int config_num, 287 const char *config_name); 288 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu); 289 290 bool perf_pmu__wildcard_match(const struct perf_pmu *pmu, const char *wildcard_to_match); 291 292 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size); 293 int perf_pmu__pathname_scnprintf(char *buf, size_t size, 294 const char *pmu_name, const char *filename); 295 int perf_pmu__event_source_devices_fd(void); 296 int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags); 297 298 int perf_pmu__init(struct perf_pmu *pmu, __u32 type, const char *name); 299 struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name, 300 bool eager_load); 301 struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus); 302 void perf_pmu__delete(struct perf_pmu *pmu); 303 struct perf_pmu *perf_pmus__find_core_pmu(void); 304 305 const char *perf_pmu__name_from_config(struct perf_pmu *pmu, u64 config); 306 bool perf_pmu__is_fake(const struct perf_pmu *pmu); 307 308 #endif /* __PMU_H */ 309