xref: /linux/tools/perf/util/parse-events.l (revision 84caba70d09c20638ee1ecdd24e0932520ad63fe)
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 int lc_str(yyscan_t scanner, const struct parse_events_state *state)
67 {
68 	return str(scanner, state->match_legacy_cache_terms ? PE_LEGACY_CACHE : PE_NAME);
69 }
70 
71 static bool isbpf_suffix(char *text)
72 {
73 	int len = strlen(text);
74 
75 	if (len < 2)
76 		return false;
77 	if ((text[len - 1] == 'c' || text[len - 1] == 'o') &&
78 	    text[len - 2] == '.')
79 		return true;
80 	if (len > 4 && !strcmp(text + len - 4, ".obj"))
81 		return true;
82 	return false;
83 }
84 
85 static bool isbpf(yyscan_t scanner)
86 {
87 	char *text = parse_events_get_text(scanner);
88 	struct stat st;
89 
90 	if (!isbpf_suffix(text))
91 		return false;
92 
93 	return stat(text, &st) == 0;
94 }
95 
96 /*
97  * This function is called when the parser gets two kind of input:
98  *
99  * 	@cfg1 or @cfg2=config
100  *
101  * The leading '@' is stripped off before 'cfg1' and 'cfg2=config' are given to
102  * bison.  In the latter case it is necessary to keep the string intact so that
103  * the PMU kernel driver can determine what configurable is associated to
104  * 'config'.
105  */
106 static int drv_str(yyscan_t scanner, int token)
107 {
108 	YYSTYPE *yylval = parse_events_get_lval(scanner);
109 	char *text = parse_events_get_text(scanner);
110 
111 	/* Strip off the '@' */
112 	yylval->str = strdup(text + 1);
113 	return token;
114 }
115 
116 #define REWIND(__alloc)				\
117 do {								\
118 	YYSTYPE *__yylval = parse_events_get_lval(yyscanner);	\
119 	char *text = parse_events_get_text(yyscanner);		\
120 								\
121 	if (__alloc)						\
122 		__yylval->str = strdup(text);			\
123 								\
124 	yycolumn -= strlen(text);				\
125 	yyless(0);						\
126 } while (0)
127 
128 static int sym(yyscan_t scanner, int type, int config)
129 {
130 	YYSTYPE *yylval = parse_events_get_lval(scanner);
131 
132 	yylval->num = (type << 16) + config;
133 	return type == PERF_TYPE_HARDWARE ? PE_VALUE_SYM_HW : PE_VALUE_SYM_SW;
134 }
135 
136 static int tool(yyscan_t scanner, enum perf_tool_event event)
137 {
138 	YYSTYPE *yylval = parse_events_get_lval(scanner);
139 
140 	yylval->num = event;
141 	return PE_VALUE_SYM_TOOL;
142 }
143 
144 static int term(yyscan_t scanner, int type)
145 {
146 	YYSTYPE *yylval = parse_events_get_lval(scanner);
147 
148 	yylval->num = type;
149 	return PE_TERM;
150 }
151 
152 static int hw_term(yyscan_t scanner, int config)
153 {
154 	YYSTYPE *yylval = parse_events_get_lval(scanner);
155 	char *text = parse_events_get_text(scanner);
156 
157 	yylval->hardware_term.str = strdup(text);
158 	yylval->hardware_term.num = PERF_TYPE_HARDWARE + config;
159 	return PE_TERM_HW;
160 }
161 
162 #define YY_USER_ACTION					\
163 do {							\
164 	yylloc->last_column  = yylloc->first_column;	\
165 	yylloc->first_column = yycolumn;		\
166 	yycolumn += yyleng;				\
167 } while (0);
168 
169 #define USER_REJECT		\
170 	yycolumn -= yyleng;	\
171 	REJECT
172 
173 %}
174 
175 %x mem
176 %s config
177 %x event
178 
179 group		[^,{}/]*[{][^}]*[}][^,{}/]*
180 event_pmu	[^,{}/]+[/][^/]*[/][^,{}/]*
181 event		[^,{}/]+
182 bpf_object	[^,{}]+\.(o|bpf)[a-zA-Z0-9._]*
183 bpf_source	[^,{}]+\.c[a-zA-Z0-9._]*
184 
185 num_dec		[0-9]+
186 num_hex		0x[a-fA-F0-9]+
187 num_raw_hex	[a-fA-F0-9]+
188 name		[a-zA-Z_*?\[\]][a-zA-Z0-9_*?.\[\]!\-]*
189 name_tag	[\'][a-zA-Z_*?\[\]][a-zA-Z0-9_*?\-,\.\[\]:=]*[\']
190 name_minus	[a-zA-Z_*?][a-zA-Z0-9\-_*?.:]*
191 drv_cfg_term	[a-zA-Z0-9_\.]+(=[a-zA-Z0-9_*?\.:]+)?
192 /*
193  * If you add a modifier you need to update check_modifier().
194  * Also, the letters in modifier_event must not be in modifier_bp.
195  */
196 modifier_event	[ukhpPGHSDIWeb]+
197 modifier_bp	[rwx]{1,3}
198 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)
199 lc_op_result	(load|loads|read|store|stores|write|prefetch|prefetches|speculative-read|speculative-load|refs|Reference|ops|access|misses|miss)
200 digit		[0-9]
201 non_digit	[^0-9]
202 
203 %%
204 
205 %{
206 	struct parse_events_state *_parse_state = parse_events_get_extra(yyscanner);
207 	{
208 		int start_token = _parse_state->stoken;
209 
210 		if (start_token == PE_START_TERMS)
211 			BEGIN(config);
212 		else if (start_token == PE_START_EVENTS)
213 			BEGIN(event);
214 
215 		if (start_token) {
216 			_parse_state->stoken = 0;
217 			/*
218 			 * The flex parser does not init locations variable
219 			 * via the scan_string interface, so we need do the
220 			 * init in here.
221 			 */
222 			yycolumn = 0;
223 			return start_token;
224 		}
225          }
226 %}
227 
228 <event>{
229 
230 {group}		{
231 			BEGIN(INITIAL);
232 			REWIND(0);
233 		}
234 
235 {event_pmu}	|
236 {bpf_object}	|
237 {bpf_source}	|
238 {event}		{
239 			BEGIN(INITIAL);
240 			REWIND(1);
241 			return PE_EVENT_NAME;
242 		}
243 
244 <<EOF>>		{
245 			BEGIN(INITIAL);
246 			REWIND(0);
247 		}
248 ,		{
249 			return ',';
250 		}
251 }
252 
253 <config>{
254 	/*
255 	 * Please update config_term_names when new static term is added.
256 	 */
257 config			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG); }
258 config1			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG1); }
259 config2			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG2); }
260 config3			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CONFIG3); }
261 name			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NAME); }
262 period			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD); }
263 freq			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ); }
264 branch_type		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE); }
265 time			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_TIME); }
266 call-graph		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_CALLGRAPH); }
267 stack-size		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_STACKSIZE); }
268 max-stack		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_MAX_STACK); }
269 nr			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_MAX_EVENTS); }
270 inherit			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_INHERIT); }
271 no-inherit		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NOINHERIT); }
272 overwrite		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_OVERWRITE); }
273 no-overwrite		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_NOOVERWRITE); }
274 percore			{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_PERCORE); }
275 aux-output		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_AUX_OUTPUT); }
276 aux-sample-size		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_AUX_SAMPLE_SIZE); }
277 metric-id		{ return term(yyscanner, PARSE_EVENTS__TERM_TYPE_METRIC_ID); }
278 cpu-cycles|cycles				{ return hw_term(yyscanner, PERF_COUNT_HW_CPU_CYCLES); }
279 stalled-cycles-frontend|idle-cycles-frontend	{ return hw_term(yyscanner, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND); }
280 stalled-cycles-backend|idle-cycles-backend	{ return hw_term(yyscanner, PERF_COUNT_HW_STALLED_CYCLES_BACKEND); }
281 instructions					{ return hw_term(yyscanner, PERF_COUNT_HW_INSTRUCTIONS); }
282 cache-references				{ return hw_term(yyscanner, PERF_COUNT_HW_CACHE_REFERENCES); }
283 cache-misses					{ return hw_term(yyscanner, PERF_COUNT_HW_CACHE_MISSES); }
284 branch-instructions|branches			{ return hw_term(yyscanner, PERF_COUNT_HW_BRANCH_INSTRUCTIONS); }
285 branch-misses					{ return hw_term(yyscanner, PERF_COUNT_HW_BRANCH_MISSES); }
286 bus-cycles					{ return hw_term(yyscanner, PERF_COUNT_HW_BUS_CYCLES); }
287 ref-cycles					{ return hw_term(yyscanner, PERF_COUNT_HW_REF_CPU_CYCLES); }
288 r{num_raw_hex}		{ return str(yyscanner, PE_RAW); }
289 r0x{num_raw_hex}	{ return str(yyscanner, PE_RAW); }
290 ,			{ return ','; }
291 "/"			{ BEGIN(INITIAL); return '/'; }
292 {lc_type}			{ return lc_str(yyscanner, _parse_state); }
293 {lc_type}-{lc_op_result}	{ return lc_str(yyscanner, _parse_state); }
294 {lc_type}-{lc_op_result}-{lc_op_result}	{ return lc_str(yyscanner, _parse_state); }
295 {name_minus}		{ return str(yyscanner, PE_NAME); }
296 @{drv_cfg_term}		{ return drv_str(yyscanner, PE_DRV_CFG_TERM); }
297 }
298 
299 <mem>{
300 {modifier_bp}		{ return str(yyscanner, PE_MODIFIER_BP); }
301 	/*
302 	 * The colon before memory access modifiers can get mixed up with the
303 	 * colon before event modifiers. Fortunately none of the option letters
304 	 * are the same, so trailing context can be used disambiguate the two
305 	 * cases.
306 	 */
307 ":"/{modifier_bp}	{ return PE_BP_COLON; }
308 	/*
309 	 * The slash before memory length can get mixed up with the slash before
310 	 * config terms. Fortunately config terms do not start with a numeric
311 	 * digit, so trailing context can be used disambiguate the two cases.
312 	 */
313 "/"/{digit}		{ return PE_BP_SLASH; }
314 "/"/{non_digit}		{ BEGIN(config); return '/'; }
315 {num_dec}		{ return value(yyscanner, 10); }
316 {num_hex}		{ return value(yyscanner, 16); }
317 	/*
318 	 * We need to separate 'mem:' scanner part, in order to get specific
319 	 * modifier bits parsed out. Otherwise we would need to handle PE_NAME
320 	 * and we'd need to parse it manually. During the escape from <mem>
321 	 * state we need to put the escaping char back, so we dont miss it.
322 	 */
323 .			{ unput(*yytext); BEGIN(INITIAL); }
324 	/*
325 	 * We destroy the scanner after reaching EOF,
326 	 * but anyway just to be sure get back to INIT state.
327 	 */
328 <<EOF>>			{ BEGIN(INITIAL); }
329 }
330 
331 cpu-cycles|cycles				{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CPU_CYCLES); }
332 stalled-cycles-frontend|idle-cycles-frontend	{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_FRONTEND); }
333 stalled-cycles-backend|idle-cycles-backend	{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_STALLED_CYCLES_BACKEND); }
334 instructions					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_INSTRUCTIONS); }
335 cache-references				{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_REFERENCES); }
336 cache-misses					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_MISSES); }
337 branch-instructions|branches			{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_INSTRUCTIONS); }
338 branch-misses					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES); }
339 bus-cycles					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_BUS_CYCLES); }
340 ref-cycles					{ return sym(yyscanner, PERF_TYPE_HARDWARE, PERF_COUNT_HW_REF_CPU_CYCLES); }
341 cpu-clock					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_CLOCK); }
342 task-clock					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_TASK_CLOCK); }
343 page-faults|faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS); }
344 minor-faults					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MIN); }
345 major-faults					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_PAGE_FAULTS_MAJ); }
346 context-switches|cs				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CONTEXT_SWITCHES); }
347 cpu-migrations|migrations			{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CPU_MIGRATIONS); }
348 alignment-faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_ALIGNMENT_FAULTS); }
349 emulation-faults				{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_EMULATION_FAULTS); }
350 dummy						{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_DUMMY); }
351 duration_time					{ return tool(yyscanner, PERF_TOOL_DURATION_TIME); }
352 user_time						{ return tool(yyscanner, PERF_TOOL_USER_TIME); }
353 system_time						{ return tool(yyscanner, PERF_TOOL_SYSTEM_TIME); }
354 bpf-output					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_BPF_OUTPUT); }
355 cgroup-switches					{ return sym(yyscanner, PERF_TYPE_SOFTWARE, PERF_COUNT_SW_CGROUP_SWITCHES); }
356 
357 {lc_type}			{ return str(yyscanner, PE_LEGACY_CACHE); }
358 {lc_type}-{lc_op_result}	{ return str(yyscanner, PE_LEGACY_CACHE); }
359 {lc_type}-{lc_op_result}-{lc_op_result}	{ return str(yyscanner, PE_LEGACY_CACHE); }
360 mem:			{ BEGIN(mem); return PE_PREFIX_MEM; }
361 r{num_raw_hex}		{ return str(yyscanner, PE_RAW); }
362 {num_dec}		{ return value(yyscanner, 10); }
363 {num_hex}		{ return value(yyscanner, 16); }
364 
365 {modifier_event}	{ return str(yyscanner, PE_MODIFIER_EVENT); }
366 {bpf_object}		{ if (!isbpf(yyscanner)) { USER_REJECT }; return str(yyscanner, PE_BPF_OBJECT); }
367 {bpf_source}		{ if (!isbpf(yyscanner)) { USER_REJECT }; return str(yyscanner, PE_BPF_SOURCE); }
368 {name}			{ return str(yyscanner, PE_NAME); }
369 {name_tag}		{ return str(yyscanner, PE_NAME); }
370 "/"			{ BEGIN(config); return '/'; }
371 ,			{ BEGIN(event); return ','; }
372 :			{ return ':'; }
373 "{"			{ BEGIN(event); return '{'; }
374 "}"			{ return '}'; }
375 =			{ return '='; }
376 \n			{ }
377 .			{ }
378 
379 %%
380 
381 int parse_events_wrap(void *scanner __maybe_unused)
382 {
383 	return 1;
384 }
385