Loading...
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
14struct evsel_config_term;
15struct perf_cpu_map;
16struct print_callbacks;
17
18enum {
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
29struct perf_event_attr;
30
31struct perf_pmu_caps {
32 char *name;
33 char *value;
34 struct list_head list;
35};
36
37/**
38 * struct perf_pmu
39 */
40struct 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. */
168extern struct perf_pmu perf_pmu__fake;
169
170struct perf_pmu_info {
171 const char *unit;
172 double scale;
173 bool per_pkg;
174 bool snapshot;
175};
176
177struct 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
191typedef int (*pmu_event_callback)(void *state, struct pmu_event_info *info);
192
193void pmu_add_sys_aliases(struct perf_pmu *pmu);
194int 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);
197int 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);
202int perf_pmu__format_type(struct perf_pmu *pmu, const char *name);
203int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_terms,
204 struct perf_pmu_info *info, bool *rewrote_terms,
205 struct parse_events_error *err);
206int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb);
207
208int perf_pmu__format_parse(struct perf_pmu *pmu, int dirfd, bool eager_load);
209void perf_pmu_format__set_value(void *format, int config, unsigned long *bits);
210bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name);
211
212bool is_pmu_core(const char *name);
213bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu);
214bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu);
215bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name);
216size_t perf_pmu__num_events(struct perf_pmu *pmu);
217int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus,
218 void *state, pmu_event_callback cb);
219bool pmu__name_match(const struct perf_pmu *pmu, const char *pmu_name);
220
221/**
222 * perf_pmu_is_software - is the PMU a software PMU as in it uses the
223 * perf_sw_context in the kernel?
224 */
225bool perf_pmu__is_software(const struct perf_pmu *pmu);
226
227FILE *perf_pmu__open_file(const struct perf_pmu *pmu, const char *name);
228FILE *perf_pmu__open_file_at(const struct perf_pmu *pmu, int dirfd, const char *name);
229
230int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt, ...)
231 __scanf(3, 4);
232int perf_pmu__scan_file_at(const struct perf_pmu *pmu, int dirfd, const char *name,
233 const char *fmt, ...) __scanf(4, 5);
234
235bool perf_pmu__file_exists(const struct perf_pmu *pmu, const char *name);
236
237int perf_pmu__test(void);
238
239void perf_pmu__arch_init(struct perf_pmu *pmu);
240void pmu_add_cpu_aliases_table(struct perf_pmu *pmu,
241 const struct pmu_events_table *table);
242
243char *perf_pmu__getcpuid(struct perf_pmu *pmu);
244const struct pmu_metrics_table *pmu_metrics_table__find(void);
245bool pmu_uncore_identifier_match(const char *compat, const char *id);
246
247int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
248
249int perf_pmu__caps_parse(struct perf_pmu *pmu);
250
251void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
252 const char *name, int config_num,
253 const char *config_name);
254void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu);
255
256int perf_pmu__match(const char *pattern, const char *name, const char *tok);
257
258double perf_pmu__cpu_slots_per_cycle(void);
259int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size);
260int perf_pmu__pathname_scnprintf(char *buf, size_t size,
261 const char *pmu_name, const char *filename);
262int perf_pmu__event_source_devices_fd(void);
263int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags);
264
265struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *lookup_name);
266struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus);
267void perf_pmu__delete(struct perf_pmu *pmu);
268struct perf_pmu *perf_pmus__find_core_pmu(void);
269
270#endif /* __PMU_H */
1#ifndef __PMU_H
2#define __PMU_H
3
4#include <linux/bitmap.h>
5#include <linux/perf_event.h>
6#include <stdbool.h>
7#include "parse-events.h"
8
9enum {
10 PERF_PMU_FORMAT_VALUE_CONFIG,
11 PERF_PMU_FORMAT_VALUE_CONFIG1,
12 PERF_PMU_FORMAT_VALUE_CONFIG2,
13};
14
15#define PERF_PMU_FORMAT_BITS 64
16
17struct perf_event_attr;
18
19struct perf_pmu {
20 char *name;
21 __u32 type;
22 bool selectable;
23 struct perf_event_attr *default_config;
24 struct cpu_map *cpus;
25 struct list_head format; /* HEAD struct perf_pmu_format -> list */
26 struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
27 struct list_head list; /* ELEM */
28};
29
30struct perf_pmu_info {
31 const char *unit;
32 double scale;
33 bool per_pkg;
34 bool snapshot;
35};
36
37#define UNIT_MAX_LEN 31 /* max length for event unit name */
38
39struct perf_pmu_alias {
40 char *name;
41 struct list_head terms; /* HEAD struct parse_events_term -> list */
42 struct list_head list; /* ELEM */
43 char unit[UNIT_MAX_LEN+1];
44 double scale;
45 bool per_pkg;
46 bool snapshot;
47};
48
49struct perf_pmu *perf_pmu__find(const char *name);
50int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
51 struct list_head *head_terms,
52 struct parse_events_error *error);
53int perf_pmu__config_terms(struct list_head *formats,
54 struct perf_event_attr *attr,
55 struct list_head *head_terms,
56 bool zero, struct parse_events_error *error);
57__u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
58int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
59 struct perf_pmu_info *info);
60struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
61 struct list_head *head_terms);
62int perf_pmu_wrap(void);
63void perf_pmu_error(struct list_head *list, char *name, char const *msg);
64
65int perf_pmu__new_format(struct list_head *list, char *name,
66 int config, unsigned long *bits);
67void perf_pmu__set_format(unsigned long *bits, long from, long to);
68int perf_pmu__format_parse(char *dir, struct list_head *head);
69
70struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
71
72void print_pmu_events(const char *event_glob, bool name_only);
73bool pmu_have_event(const char *pname, const char *name);
74
75int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
76 ...) __attribute__((format(scanf, 3, 4)));
77
78int perf_pmu__test(void);
79
80struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
81
82#endif /* __PMU_H */