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
14 struct list_head;
15 struct evsel;
16 struct evlist;
17 struct parse_events_error;
18
19 struct option;
20
21 struct tracepoint_path {
22 char *system;
23 char *name;
24 struct tracepoint_path *next;
25 };
26
27 struct tracepoint_path *tracepoint_id_to_path(u64 config);
28 struct tracepoint_path *tracepoint_name_to_path(const char *name);
29 bool have_tracepoints(struct list_head *evlist);
30
31 const char *event_type(int type);
32
33 int parse_events_option(const struct option *opt, const char *str, int unset);
34 int parse_events(struct evlist *evlist, const char *str,
35 struct parse_events_error *error);
36 int parse_events_terms(struct list_head *terms, const char *str);
37 int parse_filter(const struct option *opt, const char *str, int unset);
38 int exclude_perf(const struct option *opt, const char *arg, int unset);
39
40 #define EVENTS_HELP_MAX (128*1024)
41
42 enum 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
49 struct perf_pmu_event_symbol {
50 char *symbol;
51 enum perf_pmu_event_symbol_type type;
52 };
53
54 enum {
55 PARSE_EVENTS__TERM_TYPE_NUM,
56 PARSE_EVENTS__TERM_TYPE_STR,
57 };
58
59 enum {
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
83 struct parse_events_array {
84 size_t nr_ranges;
85 struct {
86 unsigned int start;
87 size_t length;
88 } *ranges;
89 };
90
91 struct 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
112 struct 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
118 struct 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
127 void parse_events__shrink_config_terms(void);
128 int parse_events__is_hardcoded_term(struct parse_events_term *term);
129 int 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);
133 int parse_events_term__str(struct parse_events_term **term,
134 int type_term, char *config, char *str,
135 void *loc_term, void *loc_val);
136 int parse_events_term__sym_hw(struct parse_events_term **term,
137 char *config, unsigned idx);
138 int parse_events_term__clone(struct parse_events_term **new,
139 struct parse_events_term *term);
140 void parse_events_terms__delete(struct list_head *terms);
141 void parse_events_terms__purge(struct list_head *terms);
142 void parse_events__clear_array(struct parse_events_array *a);
143 int parse_events__modifier_event(struct list_head *list, char *str, bool add);
144 int parse_events__modifier_group(struct list_head *list, char *event_mod);
145 int parse_events_name(struct list_head *list, char *name);
146 int 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);
150 int 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 */
156 struct bpf_object;
157 int 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);
161 int 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);
165 enum perf_tool_event;
166 int parse_events_add_tool(struct parse_events_state *parse_state,
167 struct list_head *list,
168 enum perf_tool_event tool_event);
169 int 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);
173 int parse_events_add_breakpoint(struct list_head *list, int *idx,
174 void *ptr, char *type, u64 len);
175 int 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
181 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
182 char *str,
183 struct list_head **listp);
184
185 int parse_events_copy_term_list(struct list_head *old,
186 struct list_head **new);
187
188 enum perf_pmu_event_symbol_type
189 perf_pmu__parse_check(const char *name);
190 void parse_events__set_leader(char *name, struct list_head *list,
191 struct parse_events_state *parse_state);
192 void parse_events_update_lists(struct list_head *list_event,
193 struct list_head *list_all);
194 void parse_events_evlist_error(struct parse_events_state *parse_state,
195 int idx, const char *str);
196
197 void print_events(const char *event_glob, bool name_only, bool quiet,
198 bool long_desc, bool details_flag);
199
200 struct event_symbol {
201 const char *symbol;
202 const char *alias;
203 };
204 extern struct event_symbol event_symbols_hw[];
205 extern struct event_symbol event_symbols_sw[];
206 void print_symbol_events(const char *event_glob, unsigned type,
207 struct event_symbol *syms, unsigned max,
208 bool name_only);
209 void print_tool_events(const char *event_glob, bool name_only);
210 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
211 bool name_only);
212 int print_hwcache_events(const char *event_glob, bool name_only);
213 void print_sdt_events(const char *subsys_glob, const char *event_glob,
214 bool name_only);
215 int is_valid_tracepoint(const char *event_string);
216
217 int valid_event_mount(const char *eventfs);
218 char *parse_events_formats_error_string(char *additional_terms);
219
220 void 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 */
is_sdt_event(char * str)229 static 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
is_sdt_event(char * str __maybe_unused)236 static 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 */
243