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