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 perf_cpu_map; 18 struct print_callbacks; 19 20 enum { 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 64 29 #define MAX_PMU_NAME_LEN 128 30 31 struct perf_event_attr; 32 33 struct perf_pmu_caps { 34 char *name; 35 char *value; 36 struct list_head list; 37 }; 38 39 enum { 40 PERF_PMU_TYPE_FAKE = 0xFFFFFFFF, 41 }; 42 43 /** 44 * struct perf_pmu 45 */ 46 struct 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 in 51 * architecture specific code. 52 */ 53 char *alias_name; 54 /** 55 * @id: Optional PMU identifier read from 56 * <sysfs>/bus/event_source/devices/<name>/identifier. 57 */ 58 const char *id; 59 /** 60 * @type: Perf event attributed type value, read from 61 * <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 being 70 * "cpu" or by the presence of 71 * <sysfs>/bus/event_source/devices/<name>/cpus. There may be >1 core 72 * 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 the 77 * presence of <sysfs>/bus/event_source/devices/<name>/cpumask. 78 */ 79 bool is_uncore; 80 /** 81 * @auxtrace: Are events auxiliary events? Determined in architecture 82 * specific code. 83 */ 84 bool auxtrace; 85 /** 86 * @formats_checked: Only check PMU's formats are valid for 87 * 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 the 96 * PMU, read from 97 * <sysfs>/bus/event_source/devices/<name>/caps/max_precise. 98 */ 99 int max_precise; 100 /** 101 * @perf_event_attr_init_default: Optional function to default 102 * 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 from 114 * <sysfs>/bus/event_source/devices/<name>/format/. The contents specify 115 * 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 an 120 * event read from <sysfs>/bus/event_source/devices/<name>/events/ or 121 * 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 /** 135 * @cpu_common_json_aliases: Number of json events that overlapped with sysfs when 136 * loading all sysfs events. 137 */ 138 uint32_t cpu_common_json_aliases; 139 /** @sysfs_aliases_loaded: Are sysfs aliases loaded from disk? */ 140 bool sysfs_aliases_loaded; 141 /** 142 * @cpu_aliases_added: Have all json events table entries for the PMU 143 * been added? 144 */ 145 bool cpu_aliases_added; 146 /** @caps_initialized: Has the list caps been initialized? */ 147 bool caps_initialized; 148 /** @nr_caps: The length of the list caps. */ 149 u32 nr_caps; 150 /** 151 * @caps: Holds the contents of files read from 152 * <sysfs>/bus/event_source/devices/<name>/caps/. 153 * 154 * The contents are pairs of the filename with the value of its 155 * contents, for example, max_precise (see above) may have a value of 3. 156 */ 157 struct list_head caps; 158 /** @list: Element on pmus list in pmu.c. */ 159 struct list_head list; 160 161 /** 162 * @config_masks: Derived from the PMU's format data, bits that are 163 * valid within the config value. 164 */ 165 __u64 config_masks[PERF_PMU_FORMAT_VALUE_CONFIG_END]; 166 167 /** 168 * @missing_features: Features to inhibit when events on this PMU are 169 * opened. 170 */ 171 struct { 172 /** 173 * @exclude_guest: Disables perf_event_attr exclude_guest and 174 * exclude_host. 175 */ 176 bool exclude_guest; 177 } missing_features; 178 179 /** 180 * @mem_events: List of the supported mem events 181 */ 182 struct perf_mem_event *mem_events; 183 }; 184 185 struct perf_pmu_info { 186 const char *unit; 187 double scale; 188 bool per_pkg; 189 bool snapshot; 190 }; 191 192 struct pmu_event_info { 193 const struct perf_pmu *pmu; 194 const char *name; 195 const char* alias; 196 const char *scale_unit; 197 const char *desc; 198 const char *long_desc; 199 const char *encoding_desc; 200 const char *topic; 201 const char *pmu_name; 202 const char *event_type_desc; 203 const char *str; 204 bool deprecated; 205 }; 206 207 typedef int (*pmu_event_callback)(void *state, struct pmu_event_info *info); 208 typedef int (*pmu_format_callback)(void *state, const char *name, int config, 209 const unsigned long *bits); 210 211 void pmu_add_sys_aliases(struct perf_pmu *pmu); 212 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr, 213 struct parse_events_terms *head_terms, 214 struct parse_events_error *error); 215 int perf_pmu__config_terms(const struct perf_pmu *pmu, 216 struct perf_event_attr *attr, 217 struct parse_events_terms *terms, 218 bool zero, struct parse_events_error *error); 219 __u64 perf_pmu__format_bits(struct perf_pmu *pmu, const char *name); 220 int perf_pmu__format_type(struct perf_pmu *pmu, const char *name); 221 int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_terms, 222 struct perf_pmu_info *info, bool *rewrote_terms, 223 struct parse_events_error *err); 224 int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb); 225 226 void perf_pmu_format__set_value(void *format, int config, unsigned long *bits); 227 bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name); 228 int perf_pmu__for_each_format(struct perf_pmu *pmu, void *state, pmu_format_callback cb); 229 230 bool is_pmu_core(const char *name); 231 bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu); 232 bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu); 233 bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name); 234 size_t perf_pmu__num_events(struct perf_pmu *pmu); 235 int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus, 236 void *state, pmu_event_callback cb); 237 bool pmu__name_match(const struct perf_pmu *pmu, const char *pmu_name); 238 239 /** 240 * perf_pmu_is_software - is the PMU a software PMU as in it uses the 241 * perf_sw_context in the kernel? 242 */ 243 bool perf_pmu__is_software(const struct perf_pmu *pmu); 244 245 FILE *perf_pmu__open_file(const struct perf_pmu *pmu, const char *name); 246 FILE *perf_pmu__open_file_at(const struct perf_pmu *pmu, int dirfd, const char *name); 247 248 int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt, ...) 249 __scanf(3, 4); 250 int perf_pmu__scan_file_at(const struct perf_pmu *pmu, int dirfd, const char *name, 251 const char *fmt, ...) __scanf(4, 5); 252 253 bool perf_pmu__file_exists(const struct perf_pmu *pmu, const char *name); 254 255 int perf_pmu__test(void); 256 257 void perf_pmu__arch_init(struct perf_pmu *pmu); 258 void pmu_add_cpu_aliases_table(struct perf_pmu *pmu, 259 const struct pmu_events_table *table); 260 261 char *perf_pmu__getcpuid(struct perf_pmu *pmu); 262 const struct pmu_metrics_table *pmu_metrics_table__find(void); 263 bool pmu_uncore_identifier_match(const char *compat, const char *id); 264 265 int perf_pmu__convert_scale(const char *scale, char **end, double *sval); 266 267 int perf_pmu__caps_parse(struct perf_pmu *pmu); 268 269 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config, 270 const char *name, int config_num, 271 const char *config_name); 272 void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu); 273 274 bool perf_pmu__match(const struct perf_pmu *pmu, const char *tok); 275 276 double perf_pmu__cpu_slots_per_cycle(void); 277 int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size); 278 int perf_pmu__pathname_scnprintf(char *buf, size_t size, 279 const char *pmu_name, const char *filename); 280 int perf_pmu__event_source_devices_fd(void); 281 int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags); 282 283 struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name, 284 bool eager_load); 285 struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus); 286 void perf_pmu__delete(struct perf_pmu *pmu); 287 struct perf_pmu *perf_pmus__find_core_pmu(void); 288 const char *perf_pmu__name_from_config(struct perf_pmu *pmu, u64 config); 289 290 #endif /* __PMU_H */ 291