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