xref: /linux/tools/perf/util/pmu.h (revision a44e4f3ab16bc808590763a543a93b6fbf3abcc4)
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 <stdbool.h>
9 #include "parse-events.h"
10 
11 struct perf_evsel_config_term;
12 
13 enum {
14 	PERF_PMU_FORMAT_VALUE_CONFIG,
15 	PERF_PMU_FORMAT_VALUE_CONFIG1,
16 	PERF_PMU_FORMAT_VALUE_CONFIG2,
17 };
18 
19 #define PERF_PMU_FORMAT_BITS 64
20 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
21 
22 struct perf_event_attr;
23 
24 struct perf_pmu {
25 	char *name;
26 	__u32 type;
27 	bool selectable;
28 	bool is_uncore;
29 	int max_precise;
30 	struct perf_event_attr *default_config;
31 	struct perf_cpu_map *cpus;
32 	struct list_head format;  /* HEAD struct perf_pmu_format -> list */
33 	struct list_head aliases; /* HEAD struct perf_pmu_alias -> list */
34 	struct list_head list;    /* ELEM */
35 };
36 
37 struct perf_pmu_info {
38 	const char *unit;
39 	const char *metric_expr;
40 	const char *metric_name;
41 	double scale;
42 	bool per_pkg;
43 	bool snapshot;
44 };
45 
46 #define UNIT_MAX_LEN	31 /* max length for event unit name */
47 
48 struct perf_pmu_alias {
49 	char *name;
50 	char *desc;
51 	char *long_desc;
52 	char *topic;
53 	char *str;
54 	struct list_head terms; /* HEAD struct parse_events_term -> list */
55 	struct list_head list;  /* ELEM */
56 	char unit[UNIT_MAX_LEN+1];
57 	double scale;
58 	bool per_pkg;
59 	bool snapshot;
60 	bool deprecated;
61 	char *metric_expr;
62 	char *metric_name;
63 };
64 
65 struct perf_pmu *perf_pmu__find(const char *name);
66 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
67 		     struct list_head *head_terms,
68 		     struct parse_events_error *error);
69 int perf_pmu__config_terms(struct list_head *formats,
70 			   struct perf_event_attr *attr,
71 			   struct list_head *head_terms,
72 			   bool zero, struct parse_events_error *error);
73 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name);
74 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
75 			  struct perf_pmu_info *info);
76 struct list_head *perf_pmu__alias(struct perf_pmu *pmu,
77 				  struct list_head *head_terms);
78 int perf_pmu_wrap(void);
79 void perf_pmu_error(struct list_head *list, char *name, char const *msg);
80 
81 int perf_pmu__new_format(struct list_head *list, char *name,
82 			 int config, unsigned long *bits);
83 void perf_pmu__set_format(unsigned long *bits, long from, long to);
84 int perf_pmu__format_parse(char *dir, struct list_head *head);
85 
86 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu);
87 
88 void print_pmu_events(const char *event_glob, bool name_only, bool quiet,
89 		      bool long_desc, bool details_flag,
90 		      bool deprecated);
91 bool pmu_have_event(const char *pname, const char *name);
92 
93 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt, ...) __scanf(3, 4);
94 
95 int perf_pmu__test(void);
96 
97 struct perf_event_attr *perf_pmu__get_default_config(struct perf_pmu *pmu);
98 
99 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu);
100 
101 int perf_pmu__convert_scale(const char *scale, char **end, double *sval);
102 
103 #endif /* __PMU_H */
104