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