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