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 #define __PARSE_EVENTS__TERM_TYPE_NR (PARSE_EVENTS__TERM_TYPE_CPU + 1)
87 };
88
89 struct parse_events_term {
90 /** @list: The term list the term is a part of. */
91 struct list_head list;
92 /**
93 * @config: The left-hand side of a term assignment, so the term
94 * "event=8" would have the config be "event"
95 */
96 const char *config;
97 /**
98 * @val: The right-hand side of a term assignment that can either be a
99 * string or a number depending on type_val.
100 */
101 union {
102 char *str;
103 u64 num;
104 } val;
105 /** @type_val: The union variable in val to be used for the term. */
106 enum parse_events__term_val_type type_val;
107 /**
108 * @type_term: A predefined term type or PARSE_EVENTS__TERM_TYPE_USER
109 * when not inbuilt.
110 */
111 enum parse_events__term_type type_term;
112 /**
113 * @err_term: The column index of the term from parsing, used during
114 * error output.
115 */
116 int err_term;
117 /**
118 * @err_val: The column index of the val from parsing, used during error
119 * output.
120 */
121 int err_val;
122 /** @used: Was the term used during parameterized-eval. */
123 bool used;
124 /**
125 * @weak: A term from the sysfs or json encoding of an event that
126 * shouldn't override terms coming from the command line.
127 */
128 bool weak;
129 /**
130 * @no_value: Is there no value. If a numeric term has no value then the
131 * value is assumed to be 1. An event name also has no value.
132 */
133 bool no_value;
134 /**
135 * @alternate_hw_config: config is the event name but num is an
136 * alternate PERF_TYPE_HARDWARE config value which is often nice for the
137 * sake of quick matching.
138 */
139 bool alternate_hw_config;
140 };
141
142 struct parse_events_error {
143 /** @list: The head of a list of errors. */
144 struct list_head list;
145 };
146
147 /* A wrapper around a list of terms for the sake of better type safety. */
148 struct parse_events_terms {
149 struct list_head terms;
150 };
151
152 struct parse_events_state {
153 /* The list parsed events are placed on. */
154 struct list_head list;
155 /* The updated index used by entries as they are added. */
156 int idx;
157 /* Error information. */
158 struct parse_events_error *error;
159 /* Holds returned terms for term parsing. */
160 struct parse_events_terms *terms;
161 /* Start token. */
162 int stoken;
163 /* Use the fake PMU marker for testing. */
164 bool fake_pmu;
165 /* Skip actual tracepoint processing for testing. */
166 bool fake_tp;
167 /* If non-null, when wildcard matching only match the given PMU. */
168 const char *pmu_filter;
169 /* Should PE_LEGACY_NAME tokens be generated for config terms? */
170 bool match_legacy_cache_terms;
171 /* Were multiple PMUs scanned to find events? */
172 bool wild_card_pmus;
173 };
174
175 const char *parse_events__term_type_str(enum parse_events__term_type term_type);
176
177 bool parse_events__filter_pmu(const struct parse_events_state *parse_state,
178 const struct perf_pmu *pmu);
179 void parse_events__shrink_config_terms(void);
180 int parse_events__is_hardcoded_term(struct parse_events_term *term);
181 int parse_events_term__num(struct parse_events_term **term,
182 enum parse_events__term_type type_term,
183 const char *config, u64 num,
184 bool novalue,
185 void *loc_term, void *loc_val);
186 int parse_events_term__str(struct parse_events_term **term,
187 enum parse_events__term_type type_term,
188 char *config, char *str,
189 void *loc_term, void *loc_val);
190 int parse_events_term__term(struct parse_events_term **term,
191 enum parse_events__term_type term_lhs,
192 enum parse_events__term_type term_rhs,
193 void *loc_term, void *loc_val);
194 int parse_events_term__clone(struct parse_events_term **new,
195 const struct parse_events_term *term);
196 void parse_events_term__delete(struct parse_events_term *term);
197
198 void parse_events_terms__delete(struct parse_events_terms *terms);
199 void parse_events_terms__init(struct parse_events_terms *terms);
200 void parse_events_terms__exit(struct parse_events_terms *terms);
201 int parse_events_terms(struct parse_events_terms *terms, const char *str, FILE *input);
202 int parse_events_terms__to_strbuf(const struct parse_events_terms *terms, struct strbuf *sb);
203
204 struct parse_events_modifier {
205 u8 precise; /* Number of repeated 'p' for precision. */
206 bool precise_max : 1; /* 'P' */
207 bool non_idle : 1; /* 'I' */
208 bool sample_read : 1; /* 'S' */
209 bool pinned : 1; /* 'D' */
210 bool exclusive : 1; /* 'e' */
211 bool weak : 1; /* 'W' */
212 bool bpf : 1; /* 'b' */
213 bool user : 1; /* 'u' */
214 bool kernel : 1; /* 'k' */
215 bool hypervisor : 1; /* 'h' */
216 bool guest : 1; /* 'G' */
217 bool host : 1; /* 'H' */
218 bool retire_lat : 1; /* 'R' */
219 };
220
221 int parse_events__modifier_event(struct parse_events_state *parse_state, void *loc,
222 struct list_head *list, struct parse_events_modifier mod);
223 int parse_events__modifier_group(struct parse_events_state *parse_state, void *loc,
224 struct list_head *list, struct parse_events_modifier mod);
225 int parse_events__set_default_name(struct list_head *list, char *name);
226 int parse_events_add_tracepoint(struct parse_events_state *parse_state,
227 struct list_head *list,
228 const char *sys, const char *event,
229 struct parse_events_error *error,
230 struct parse_events_terms *head_config, void *loc);
231 int parse_events_add_numeric(struct parse_events_state *parse_state,
232 struct list_head *list,
233 u32 type, u64 config,
234 const struct parse_events_terms *head_config,
235 bool wildcard);
236 int parse_events_add_cache(struct list_head *list, int *idx, const char *name,
237 struct parse_events_state *parse_state,
238 struct parse_events_terms *parsed_terms);
239 int parse_events__decode_legacy_cache(const char *name, int pmu_type, __u64 *config);
240 int parse_events_add_breakpoint(struct parse_events_state *parse_state,
241 struct list_head *list,
242 u64 addr, char *type, u64 len,
243 struct parse_events_terms *head_config);
244
245 struct evsel *parse_events__add_event(int idx, struct perf_event_attr *attr,
246 const char *name, const char *metric_id,
247 struct perf_pmu *pmu);
248
249 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
250 const char *event_name, u64 hw_config,
251 const struct parse_events_terms *const_parsed_terms,
252 struct list_head **listp, void *loc);
253
254 int parse_events_multi_pmu_add_or_add_pmu(struct parse_events_state *parse_state,
255 const char *event_or_pmu,
256 const struct parse_events_terms *const_parsed_terms,
257 struct list_head **listp,
258 void *loc_);
259
260 void parse_events__set_leader(char *name, struct list_head *list);
261
262 struct event_symbol {
263 const char *symbol;
264 const char *alias;
265 };
266 extern const struct event_symbol event_symbols_hw[];
267
268 char *parse_events_formats_error_string(char *additional_terms);
269
270 void parse_events_error__init(struct parse_events_error *err);
271 void parse_events_error__exit(struct parse_events_error *err);
272 void parse_events_error__handle(struct parse_events_error *err, int idx,
273 char *str, char *help);
274 void parse_events_error__print(const struct parse_events_error *err,
275 const char *event);
276 bool parse_events_error__contains(const struct parse_events_error *err,
277 const char *needle);
278 #ifdef HAVE_LIBELF_SUPPORT
279 /*
280 * If the probe point starts with '%',
281 * or starts with "sdt_" and has a ':' but no '=',
282 * then it should be a SDT/cached probe point.
283 */
is_sdt_event(char * str)284 static inline bool is_sdt_event(char *str)
285 {
286 return (str[0] == '%' ||
287 (!strncmp(str, "sdt_", 4) &&
288 !!strchr(str, ':') && !strchr(str, '=')));
289 }
290 #else
is_sdt_event(char * str __maybe_unused)291 static inline bool is_sdt_event(char *str __maybe_unused)
292 {
293 return false;
294 }
295 #endif /* HAVE_LIBELF_SUPPORT */
296
297 size_t default_breakpoint_len(void);
298
299 #endif /* __PERF_PARSE_EVENTS_H */
300