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