1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __PERF_PARSE_EVENTS_H
3 #define __PERF_PARSE_EVENTS_H
4 /*
5 * Parse symbolic events/counts passed in as options:
6 */
7
8 #include <linux/list.h>
9 #include <stdbool.h>
10 #include <linux/types.h>
11 #include <linux/perf_event.h>
12 #include <stdio.h>
13 #include <string.h>
14 #include <sys/types.h>
15
16 struct evsel;
17 struct evlist;
18 struct parse_events_error;
19
20 struct option;
21 struct perf_pmu;
22 struct strbuf;
23
24 const char *event_type(size_t type);
25
26 /* Arguments encoded in opt->value. */
27 struct parse_events_option_args {
28 struct evlist **evlistp;
29 const char *pmu_filter;
30 };
31 int parse_events_option(const struct option *opt, const char *str, int unset);
32 int parse_events_option_new_evlist(const struct option *opt, const char *str, int unset);
33 __attribute__((nonnull(1, 2, 4)))
34 int __parse_events(struct evlist *evlist, const char *str, const char *pmu_filter,
35 struct parse_events_error *error, bool fake_pmu,
36 bool warn_if_reordered, bool fake_tp);
37
38 __attribute__((nonnull(1, 2, 3)))
parse_events(struct evlist * evlist,const char * str,struct parse_events_error * err)39 static inline int parse_events(struct evlist *evlist, const char *str,
40 struct parse_events_error *err)
41 {
42 return __parse_events(evlist, str, /*pmu_filter=*/NULL, err, /*fake_pmu=*/false,
43 /*warn_if_reordered=*/true, /*fake_tp=*/false);
44 }
45
46 int parse_event(struct evlist *evlist, const char *str);
47
48 int parse_filter(const struct option *opt, const char *str, int unset);
49 int parse_uid_filter(struct evlist *evlist, uid_t uid);
50 int exclude_perf(const struct option *opt, const char *arg, int unset);
51
52 enum parse_events__term_val_type {
53 PARSE_EVENTS__TERM_TYPE_NUM,
54 PARSE_EVENTS__TERM_TYPE_STR,
55 };
56
57 enum parse_events__term_type {
58 PARSE_EVENTS__TERM_TYPE_USER,
59 PARSE_EVENTS__TERM_TYPE_CONFIG,
60 PARSE_EVENTS__TERM_TYPE_CONFIG1,
61 PARSE_EVENTS__TERM_TYPE_CONFIG2,
62 PARSE_EVENTS__TERM_TYPE_CONFIG3,
63 PARSE_EVENTS__TERM_TYPE_NAME,
64 PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD,
65 PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ,
66 PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE,
67 PARSE_EVENTS__TERM_TYPE_TIME,
68 PARSE_EVENTS__TERM_TYPE_CALLGRAPH,
69 PARSE_EVENTS__TERM_TYPE_STACKSIZE,
70 PARSE_EVENTS__TERM_TYPE_NOINHERIT,
71 PARSE_EVENTS__TERM_TYPE_INHERIT,
72 PARSE_EVENTS__TERM_TYPE_MAX_STACK,
73 PARSE_EVENTS__TERM_TYPE_MAX_EVENTS,
74 PARSE_EVENTS__TERM_TYPE_NOOVERWRITE,
75 PARSE_EVENTS__TERM_TYPE_OVERWRITE,
76 PARSE_EVENTS__TERM_TYPE_DRV_CFG,
77 PARSE_EVENTS__TERM_TYPE_PERCORE,
78 PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT,
79 PARSE_EVENTS__TERM_TYPE_AUX_ACTION,
80 PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE,
81 PARSE_EVENTS__TERM_TYPE_METRIC_ID,
82 PARSE_EVENTS__TERM_TYPE_RAW,
83 PARSE_EVENTS__TERM_TYPE_LEGACY_CACHE,
84 PARSE_EVENTS__TERM_TYPE_HARDWARE,
85 PARSE_EVENTS__TERM_TYPE_CPU,
86 PARSE_EVENTS__TERM_TYPE_RATIO_TO_PREV,
87 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_RATIO_TO_PREV + 1)
88 };
89
90 struct parse_events_term {
91 /** @list: The term list the term is a part of. */
92 struct list_head list;
93 /**
94 * @config: The left-hand side of a term assignment, so the term
95 * "event=8" would have the config be "event"
96 */
97 const char *config;
98 /**
99 * @val: The right-hand side of a term assignment that can either be a
100 * string or a number depending on type_val.
101 */
102 union {
103 char *str;
104 u64 num;
105 } val;
106 /** @type_val: The union variable in val to be used for the term. */
107 enum parse_events__term_val_type type_val;
108 /**
109 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER
110 * when not inbuilt.
111 */
112 enum parse_events__term_type type_term;
113 /**
114 * @err_term: The column index of the term from parsing, used during
115 * error output.
116 */
117 int err_term;
118 /**
119 * @err_val: The column index of the val from parsing, used during error
120 * output.
121 */
122 int err_val;
123 /** @used: Was the term used during parameterized-eval. */
124 bool used;
125 /**
126 * @weak: A term from the sysfs or json encoding of an event that
127 * shouldn't override terms coming from the command line.
128 */
129 bool weak;
130 /**
131 * @no_value: Is there no value. If a numeric term has no value then the
132 * value is assumed to be 1. An event name also has no value.
133 */
134 bool no_value;
135 /**
136 * @alternate_hw_config: config is the event name but num is an
137 * alternate PERF_TYPE_HARDWARE config value which is often nice for the
138 * sake of quick matching.
139 */
140 bool alternate_hw_config;
141 };
142
143 struct parse_events_error {
144 /** @list: The head of a list of errors. */
145 struct list_head list;
146 };
147
148 /* A wrapper around a list of terms for the sake of better type safety. */
149 struct parse_events_terms {
150 struct list_head terms;
151 };
152
153 struct parse_events_state {
154 /* The list parsed events are placed on. */
155 struct list_head list;
156 /* The updated index used by entries as they are added. */
157 int idx;
158 /* Error information. */
159 struct parse_events_error *error;
160 /* Holds returned terms for term parsing. */
161 struct parse_events_terms *terms;
162 /* Start token. */
163 int stoken;
164 /* Use the fake PMU marker for testing. */
165 bool fake_pmu;
166 /* Skip actual tracepoint processing for testing. */
167 bool fake_tp;
168 /* If non-null, when wildcard matching only match the given PMU. */
169 const char *pmu_filter;
170 /* Should PE_LEGACY_NAME tokens be generated for config terms? */
171 bool match_legacy_cache_terms;
172 /* Were multiple PMUs scanned to find events? */
173 bool wild_card_pmus;
174 };
175
176 const char *parse_events__term_type_str(enum parse_events__term_type term_type);
177
178 bool parse_events__filter_pmu(const struct parse_events_state *parse_state,
179 const struct perf_pmu *pmu);
180 void parse_events__shrink_config_terms(void);
181 int parse_events__is_hardcoded_term(struct parse_events_term *term);
182 int parse_events_term__num(struct parse_events_term **term,
183 enum parse_events__term_type type_term,
184 const char *config, u64 num,
185 bool novalue,
186 void *loc_term, void *loc_val);
187 int parse_events_term__str(struct parse_events_term **term,
188 enum parse_events__term_type type_term,
189 char *config, char *str,
190 void *loc_term, void *loc_val);
191 int parse_events_term__term(struct parse_events_term **term,
192 enum parse_events__term_type term_lhs,
193 enum parse_events__term_type term_rhs,
194 void *loc_term, void *loc_val);
195 int parse_events_term__clone(struct parse_events_term **new,
196 const struct parse_events_term *term);
197 void parse_events_term__delete(struct parse_events_term *term);
198
199 void parse_events_terms__delete(struct parse_events_terms *terms);
200 void parse_events_terms__init(struct parse_events_terms *terms);
201 void parse_events_terms__exit(struct parse_events_terms *terms);
202 int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input);
203 int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb);
204
205 struct parse_events_modifier {
206 u8 precise; /* Number of repeated 'p' for precision. */
207 bool precise_max : 1; /* 'P' */
208 bool non_idle : 1; /* 'I' */
209 bool sample_read : 1; /* 'S' */
210 bool pinned : 1; /* 'D' */
211 bool exclusive : 1; /* 'e' */
212 bool weak : 1; /* 'W' */
213 bool bpf : 1; /* 'b' */
214 bool user : 1; /* 'u' */
215 bool kernel : 1; /* 'k' */
216 bool hypervisor : 1; /* 'h' */
217 bool guest : 1; /* 'G' */
218 bool host : 1; /* 'H' */
219 bool retire_lat : 1; /* 'R' */
220 bool dont_regroup : 1; /* 'X' */
221 };
222
223 int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc,
224 struct list_head *list, struct parse_events_modifier mod);
225 int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc,
226 struct list_head *list, struct parse_events_modifier mod);
227 int parse_events__set_default_name(struct list_head *list, char *name);
228 int parse_events_add_tracepoint(struct parse_events_state *parse_state,
229 struct list_head *list,
230 const char *sys, const char *event,
231 struct parse_events_error *error,
232 struct parse_events_terms *head_config, void *loc);
233 int parse_events_add_numeric(struct parse_events_state *parse_state,
234 struct list_head *list,
235 u32 type, u64 config,
236 const struct parse_events_terms *head_config,
237 bool wildcard);
238 int parse_events_add_cache(struct list_head *list, int *idx, const char *name,
239 struct parse_events_state *parse_state,
240 struct parse_events_terms *parsed_terms);
241 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);
242 int parse_events_add_breakpoint(struct parse_events_state *parse_state,
243 struct list_head *list,
244 u64 addr, char *type, u64 len,
245 struct parse_events_terms *head_config);
246
247 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
248 const char *name, const char *metric_id,
249 struct perf_pmu *pmu);
250
251 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
252 const char *event_name, u64 hw_config,
253 const struct parse_events_terms *const_parsed_terms,
254 struct list_head **listp, void *loc);
255
256 int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state,
257 const char *event_or_pmu,
258 const struct parse_events_terms *const_parsed_terms,
259 struct list_head **listp,
260 void *loc_);
261
262 void parse_events__set_leader(char *name, struct list_head *list);
263
264 struct event_symbol {
265 const char *symbol;
266 const char *alias;
267 };
268 extern const struct event_symbol event_symbols_hw[];
269
270 char *parse_events_formats_error_string(char *additional_terms);
271
272 void parse_events_error__init(struct parse_events_error *err);
273 void parse_events_error__exit(struct parse_events_error *err);
274 void parse_events_error__handle(struct parse_events_error *err, int idx,
275 char *str, char *help);
276 void parse_events_error__print(const struct parse_events_error *err,
277 const char *event);
278 bool parse_events_error__contains(const struct parse_events_error *err,
279 const char *needle);
280 #ifdef HAVE_LIBELF_SUPPORT
281 /*
282 * If the probe point starts with '%',
283 * or starts with "sdt_" and has a ':' but no '=',
284 * then it should be a SDT/cached probe point.
285 */
is_sdt_event(char * str)286 static inline bool is_sdt_event(char *str)
287 {
288 return (str[0] == '%' ||
289 (!strncmp(str, "sdt_", 4) &&
290 !!strchr(str, ':') && !strchr(str, '=')));
291 }
292 #else
is_sdt_event(char * str __maybe_unused)293 static inline bool is_sdt_event(char *str __maybe_unused)
294 {
295 return false;
296 }
297 #endif /* HAVE_LIBELF_SUPPORT */
298
299 size_t default_breakpoint_len(void);
300
301 #endif /* __PERF_PARSE_EVENTS_H */
302