xref: /linux-6.15/tools/perf/util/parse-events.l (revision ae4aa00a)
1 
2 %option reentrant
3 %option bison-bridge
4 %option prefix="parse_events_"
5 %option stack
6 %option bison-locations
7 %option yylineno
8 %option reject
9 
10 %{
11 #include <errno.h>
12 #include <sys/types.h>
13 #include <sys/stat.h>
14 #include <unistd.h>
15 #include "parse-events.h"
16 #include "parse-events-bison.h"
17 #include "evsel.h"
18 
19 char *parse_events_get_text(yyscan_t yyscanner);
20 YYSTYPE *parse_events_get_lval(yyscan_t yyscanner);
21 
22 static int __value(YYSTYPE *yylval, char *str, int base, int token)
23 {
24 	u64 num;
25 
26 	errno = 0;
27 	num = strtoull(str, NULL, base);
28 	if (errno)
29 		return PE_ERROR;
30 
31 	yylval->num = num;
32 	return token;
33 }
34 
35 static int value(yyscan_t scanner, int base)
36 {
37 	YYSTYPE *yylval = parse_events_get_lval(scanner);
38 	char *text = parse_events_get_text(scanner);
39 
40 	return __value(yylval, text, base, PE_VALUE);
41 }
42 
43 static int str(yyscan_t scanner, int token)
44 {
45 	YYSTYPE *yylval = parse_events_get_lval(scanner);
46 	char *text = parse_events_get_text(scanner);
47 
48 	if (text[0] != '\'') {
49 		yylval->str = strdup(text);
50 	} else {
51 		/*
52 		 * If a text tag specified on the command line
53 		 * contains opening single quite ' then it is
54 		 * expected that the tag ends with single quote
55 		 * as well, like this:
56 		 *     name=\'CPU_CLK_UNHALTED.THREAD:cmask=1\'
57 		 * quotes need to be escaped to bypass shell
58 		 * processing.
59 		 */
60 		yylval->str = strndup(&text[1], strlen(text) - 2);
61 	}
62 
63 	return token;
64 }
65 
66 static bool isbpf_suffix(char *text)
67 {
68 	int len = strlen(text);
69 
70 	if (len < 2)
71 		return false;
72 	if ((text[len - 1] == 'c' || text[len - 1] == 'o') &&
73 	    text[len - 2] == '.')
74 		return true;
75 	if (len > 4 && !strcmp(text + len - 4, ".obj"))
76 		return true;
77 	return false;
78 }
79 
80 static bool isbpf(yyscan_t scanner)
81 {
82 	char *text = parse_events_get_text(scanner);
83 	struct stat st;
84 
85 	if (!isbpf_suffix(text))
86 		return false;
87 
88 	return stat(text, &st) == 0;
89 }
90 
91 /*
92  * This function is called when the parser gets two kind of input:
93  *
94  * 	@cfg1 or @cfg2=config
95  *
96  * The leading '@' is stripped off before 'cfg1' and 'cfg2=config' are given to
97  * bison.  In the latter case it is necessary to keep the string intact so that
98  * the PMU kernel driver can determine what configurable is associated to
99  * 'config'.
100  */
101 static int drv_str(yyscan_t scanner, int token)
102 {
103 	YYSTYPE *yylval = parse_events_get_lval(scanner);
104 	char *text = parse_events_get_text(scanner);
105 
106 	/* Strip off the '@' */
107 	yylval->str = strdup(text + 1);
108 	return token;
109 }
110 
111 #define REWIND(__alloc)				\
112 do {								\
113 	YYSTYPE *__yylval = parse_events_get_lval(yyscanner);	\
114 	char *text = parse_events_get_text(yyscanner);		\
115 								\
116 	if (__alloc)						\
117 		__yylval->str = strdup(text);			\
118 								\
119 	yycolumn -= strlen(text);				\
120 	yyless(0);						\
121 } while (0)
122 
123 static int sym(yyscan_t scanner, int type, int config)
124 {
125 	YYSTYPE *yylval = parse_events_get_lval(scanner);
126 
127 	yylval->num = (type << 16) + config;
128 	return type == PERF_TYPE_HARDWARE ? PE_VALUE_SYM_HW : PE_VALUE_SYM_SW;
129 }
130 
131 static int tool(yyscan_t scanner, enum perf_tool_event event)
132 {
133 	YYSTYPE *yylval = parse_events_get_lval(scanner);
134 
135 	yylval->num = event;
136 	return PE_VALUE_SYM_TOOL;
137 }
138 
139 static int term(yyscan_t scanner, int type)
140 {
141 	YYSTYPE *yylval = parse_events_get_lval(scanner);
142 
143 	yylval->num = type;
144 	return PE_TERM;
145 }
146 
147 #define YY_USER_ACTION					\
148 do {							\
149 	yylloc->last_column  = yylloc->first_column;	\
150 	yylloc->first_column = yycolumn;		\
151 	yycolumn += yyleng;				\
152 } while (0);
153 
154 #define USER_REJECT		\
155 	yycolumn -= yyleng;	\
156 	REJECT
157 
158 %}
159 
160 %x mem
161 %s config
162 %x event
163 %x array
164 
165 group		[^,{}/]*[{][^}]*[}][^,{}/]*
166 event_pmu	[^,{}/]+[/][^/]*[/][^,{}/]*
167 event		[^,{}/]+
168 bpf_object	[^,{}]+\.(o|bpf)[a-zA-Z0-9._]*
169 bpf_source	[^,{}]+\.c[a-zA-Z0-9._]*
170 
171 num_dec		[0-9]+
172 num_hex		0x[a-fA-F0-9]+
173 num_raw_hex	[a-fA-F0-9]+
174 name		[a-zA-Z_*?\[\]][a-zA-Z0-9_*?.\[\]!\-]*
175 name_tag	[\'][a-zA-Z_*?\[\]][a-zA-Z0-9_*?\-,\.\[\]:=]*[\']
176 name_minus	[a-zA-Z_*?][a-zA-Z0-9\-_*?.:]*
177 drv_cfg_term	[a-zA-Z0-9_\.]+(=[a-zA-Z0-9_*?\.:]+)?
178 /* If you add a modifier you need to update check_modifier() */
179 modifier_event	[ukhpPGHSDIWeb]+
180 modifier_bp	[rwx]{1,3}
181 lc_type 	(L1-dcache|l1-d|l1d|L1-data|L1-icache|l1-i|l1i|L1-instruction|LLC|L2|dTLB|d-tlb|Data-TLB|iTLB|i-tlb|Instruction-TLB|branch|branches|bpu|btb|bpc|node)
182 lc_op_result	(load|loads|read|store|stores|write|prefetch|prefetches|speculative-read|speculative-load|refs|Reference|ops|access|misses|miss)
183 
184 %%
185 
186 %{
187 	struct parse_events_state *_parse_state = parse_events_get_extra(yyscanner);
188 
189 	{
190 		int start_token = _parse_state->stoken;
191 
192 		if (start_token == PE_START_TERMS)
193 			BEGIN(config);
194 		else if (start_token == PE_START_EVENTS)
195 			BEGIN(event);
196 
197 		if (start_token) {
198 			_parse_state->stoken = 0;
199 			/*
200 			 * The flex parser does not init locations variable
201 			 * via the scan_string interface, so we need do the
202 			 * init in here.
203 			 */
204 			yycolumn = 0;
205 			return start_token;
206 		}
207          }
208 %}
209 
210 <event>{
211 
212 {group}		{
213 			BEGIN(INITIAL);
214 			REWIND(0);
215 		}
216 
217 {event_pmu}	|
218 {bpf_object}	|
219 {bpf_source}	|
220 {event}		{
221 			BEGIN(INITIAL);
222 			REWIND(1);
223 			return PE_EVENT_NAME;
224 		}
225 
226 <<EOF>>		{
227 			BEGIN(INITIAL);
228 			REWIND(0);
229 		}
230 ,		{
231 			return ',';
232 		}
233 }
234 
235 <array>{
236 "]"			{ BEGIN(config); return ']'; }
237 {num_dec}		{ return value(yyscanner, 10); }
238 {num_hex}		{ return value(yyscanner, 16); }
239 ,			{ return ','; }
240 "\.\.\."		{ return PE_ARRAY_RANGE; }
241 }
242 
243 <config>{
244 	/*
245 	 * Please update config_term_names when new static term is added.
246 	 */
247 config			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG); }
248 config1			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG1); }
249 config2			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG2); }
250 config3			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG3); }
251 name			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NAME); }
252 period			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD); }
253 freq			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ); }
254 branch_type		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE); }
255 time			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_TIME); }
256 call-graph		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CALLGRAPH); }
257 stack-size		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_STACKSIZE); }
258 max-stack		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_MAX_STACK); }
259 nr			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_MAX_EVENTS); }
260 inherit			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_INHERIT); }
261 no-inherit		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NOINHERIT); }
262 overwrite		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_OVERWRITE); }
263 no-overwrite		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NOOVERWRITE); }
264 percore			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_PERCORE); }
265 aux-output		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT); }
266 aux-sample-size		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE); }
267 metric-id		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_METRIC_ID); }
268 r{num_raw_hex}		{ return str(yyscanner, PE_RAW); }
269 r0x{num_raw_hex}	{ return str(yyscanner, PE_RAW); }
270 ,			{ return ','; }
271 "/"			{ BEGIN(INITIAL); return '/'; }
272 {name_minus}		{ return str(yyscanner, PE_NAME); }
273 \[all\]			{ return PE_ARRAY_ALL; }
274 "["			{ BEGIN(array); return '['; }
275 @{drv_cfg_term}		{ return drv_str(yyscanner, PE_DRV_CFG_TERM); }
276 }
277 
278 <mem>{
279 {modifier_bp}		{ return str(yyscanner, PE_MODIFIER_BP); }
280 :			{ return ':'; }
281 "/"			{ return '/'; }
282 {num_dec}		{ return value(yyscanner, 10); }
283 {num_hex}		{ return value(yyscanner, 16); }
284 	/*
285 	 * We need to separate 'mem:' scanner part, in order to get specific
286 	 * modifier bits parsed out. Otherwise we would need to handle PE_NAME
287 	 * and we'd need to parse it manually. During the escape from <mem>
288 	 * state we need to put the escaping char back, so we dont miss it.
289 	 */
290 .			{ unput(*yytext); BEGIN(INITIAL); }
291 	/*
292 	 * We destroy the scanner after reaching EOF,
293 	 * but anyway just to be sure get back to INIT state.
294 	 */
295 <<EOF>>			{ BEGIN(INITIAL); }
296 }
297 
298 cpu-cycles|cycles				{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CPU_CYCLES); }
299 stalled-cycles-frontend|idle-cycles-frontend	{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND); }
300 stalled-cycles-backend|idle-cycles-backend	{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_BACKEND); }
301 instructions					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_INSTRUCTIONS); }
302 cache-references				{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_REFERENCES); }
303 cache-misses					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_MISSES); }
304 branch-instructions|branches			{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_INSTRUCTIONS); }
305 branch-misses					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES); }
306 bus-cycles					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BUS_CYCLES); }
307 ref-cycles					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_REF_CPU_CYCLES); }
308 cpu-clock					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_CLOCK); }
309 task-clock					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_TASK_CLOCK); }
310 page-faults|faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS); }
311 minor-faults					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MIN); }
312 major-faults					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MAJ); }
313 context-switches|cs				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CONTEXT_SWITCHES); }
314 cpu-migrations|migrations			{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_MIGRATIONS); }
315 alignment-faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_ALIGNMENT_FAULTS); }
316 emulation-faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_EMULATION_FAULTS); }
317 dummy						{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_DUMMY); }
318 duration_time					{ return tool(yyscanner, PERF_TOOL_DURATION_TIME); }
319 user_time						{ return tool(yyscanner, PERF_TOOL_USER_TIME); }
320 system_time						{ return tool(yyscanner, PERF_TOOL_SYSTEM_TIME); }
321 bpf-output					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_BPF_OUTPUT); }
322 cgroup-switches					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CGROUP_SWITCHES); }
323 
324 {lc_type}			{ return str(yyscanner, PE_LEGACY_CACHE); }
325 {lc_type}-{lc_op_result}	{ return str(yyscanner, PE_LEGACY_CACHE); }
326 {lc_type}-{lc_op_result}-{lc_op_result}	{ return str(yyscanner, PE_LEGACY_CACHE); }
327 mem:			{ BEGIN(mem); return PE_PREFIX_MEM; }
328 r{num_raw_hex}		{ return str(yyscanner, PE_RAW); }
329 {num_dec}		{ return value(yyscanner, 10); }
330 {num_hex}		{ return value(yyscanner, 16); }
331 
332 {modifier_event}	{ return str(yyscanner, PE_MODIFIER_EVENT); }
333 {bpf_object}		{ if (!isbpf(yyscanner)) { USER_REJECT }; return str(yyscanner, PE_BPF_OBJECT); }
334 {bpf_source}		{ if (!isbpf(yyscanner)) { USER_REJECT }; return str(yyscanner, PE_BPF_SOURCE); }
335 {name}			{ return str(yyscanner, PE_NAME); }
336 {name_tag}		{ return str(yyscanner, PE_NAME); }
337 "/"			{ BEGIN(config); return '/'; }
338 ,			{ BEGIN(event); return ','; }
339 :			{ return ':'; }
340 "{"			{ BEGIN(event); return '{'; }
341 "}"			{ return '}'; }
342 =			{ return '='; }
343 \n			{ }
344 .			{ }
345 
346 %%
347 
348 int parse_events_wrap(void *scanner __maybe_unused)
349 {
350 	return 1;
351 }
352