xref: /openbmc/linux/tools/perf/util/parse-events.c (revision 9344dade)
1 #include <linux/hw_breakpoint.h>
2 #include "util.h"
3 #include "../perf.h"
4 #include "evlist.h"
5 #include "evsel.h"
6 #include "parse-options.h"
7 #include "parse-events.h"
8 #include "exec_cmd.h"
9 #include "string.h"
10 #include "symbol.h"
11 #include "cache.h"
12 #include "header.h"
13 #include <lk/debugfs.h>
14 #include "parse-events-bison.h"
15 #define YY_EXTRA_TYPE int
16 #include "parse-events-flex.h"
17 #include "pmu.h"
18 
19 #define MAX_NAME_LEN 100
20 
21 struct event_symbol {
22 	const char	*symbol;
23 	const char	*alias;
24 };
25 
26 #ifdef PARSER_DEBUG
27 extern int parse_events_debug;
28 #endif
29 int parse_events_parse(void *data, void *scanner);
30 
31 static struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
32 	[PERF_COUNT_HW_CPU_CYCLES] = {
33 		.symbol = "cpu-cycles",
34 		.alias  = "cycles",
35 	},
36 	[PERF_COUNT_HW_INSTRUCTIONS] = {
37 		.symbol = "instructions",
38 		.alias  = "",
39 	},
40 	[PERF_COUNT_HW_CACHE_REFERENCES] = {
41 		.symbol = "cache-references",
42 		.alias  = "",
43 	},
44 	[PERF_COUNT_HW_CACHE_MISSES] = {
45 		.symbol = "cache-misses",
46 		.alias  = "",
47 	},
48 	[PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
49 		.symbol = "branch-instructions",
50 		.alias  = "branches",
51 	},
52 	[PERF_COUNT_HW_BRANCH_MISSES] = {
53 		.symbol = "branch-misses",
54 		.alias  = "",
55 	},
56 	[PERF_COUNT_HW_BUS_CYCLES] = {
57 		.symbol = "bus-cycles",
58 		.alias  = "",
59 	},
60 	[PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
61 		.symbol = "stalled-cycles-frontend",
62 		.alias  = "idle-cycles-frontend",
63 	},
64 	[PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
65 		.symbol = "stalled-cycles-backend",
66 		.alias  = "idle-cycles-backend",
67 	},
68 	[PERF_COUNT_HW_REF_CPU_CYCLES] = {
69 		.symbol = "ref-cycles",
70 		.alias  = "",
71 	},
72 };
73 
74 static struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
75 	[PERF_COUNT_SW_CPU_CLOCK] = {
76 		.symbol = "cpu-clock",
77 		.alias  = "",
78 	},
79 	[PERF_COUNT_SW_TASK_CLOCK] = {
80 		.symbol = "task-clock",
81 		.alias  = "",
82 	},
83 	[PERF_COUNT_SW_PAGE_FAULTS] = {
84 		.symbol = "page-faults",
85 		.alias  = "faults",
86 	},
87 	[PERF_COUNT_SW_CONTEXT_SWITCHES] = {
88 		.symbol = "context-switches",
89 		.alias  = "cs",
90 	},
91 	[PERF_COUNT_SW_CPU_MIGRATIONS] = {
92 		.symbol = "cpu-migrations",
93 		.alias  = "migrations",
94 	},
95 	[PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
96 		.symbol = "minor-faults",
97 		.alias  = "",
98 	},
99 	[PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
100 		.symbol = "major-faults",
101 		.alias  = "",
102 	},
103 	[PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
104 		.symbol = "alignment-faults",
105 		.alias  = "",
106 	},
107 	[PERF_COUNT_SW_EMULATION_FAULTS] = {
108 		.symbol = "emulation-faults",
109 		.alias  = "",
110 	},
111 };
112 
113 #define __PERF_EVENT_FIELD(config, name) \
114 	((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
115 
116 #define PERF_EVENT_RAW(config)		__PERF_EVENT_FIELD(config, RAW)
117 #define PERF_EVENT_CONFIG(config)	__PERF_EVENT_FIELD(config, CONFIG)
118 #define PERF_EVENT_TYPE(config)		__PERF_EVENT_FIELD(config, TYPE)
119 #define PERF_EVENT_ID(config)		__PERF_EVENT_FIELD(config, EVENT)
120 
121 #define for_each_subsystem(sys_dir, sys_dirent, sys_next)	       \
122 	while (!readdir_r(sys_dir, &sys_dirent, &sys_next) && sys_next)	       \
123 	if (sys_dirent.d_type == DT_DIR &&				       \
124 	   (strcmp(sys_dirent.d_name, ".")) &&				       \
125 	   (strcmp(sys_dirent.d_name, "..")))
126 
127 static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
128 {
129 	char evt_path[MAXPATHLEN];
130 	int fd;
131 
132 	snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
133 			sys_dir->d_name, evt_dir->d_name);
134 	fd = open(evt_path, O_RDONLY);
135 	if (fd < 0)
136 		return -EINVAL;
137 	close(fd);
138 
139 	return 0;
140 }
141 
142 #define for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next)	       \
143 	while (!readdir_r(evt_dir, &evt_dirent, &evt_next) && evt_next)        \
144 	if (evt_dirent.d_type == DT_DIR &&				       \
145 	   (strcmp(evt_dirent.d_name, ".")) &&				       \
146 	   (strcmp(evt_dirent.d_name, "..")) &&				       \
147 	   (!tp_event_has_id(&sys_dirent, &evt_dirent)))
148 
149 #define MAX_EVENT_LENGTH 512
150 
151 
152 struct tracepoint_path *tracepoint_id_to_path(u64 config)
153 {
154 	struct tracepoint_path *path = NULL;
155 	DIR *sys_dir, *evt_dir;
156 	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
157 	char id_buf[24];
158 	int fd;
159 	u64 id;
160 	char evt_path[MAXPATHLEN];
161 	char dir_path[MAXPATHLEN];
162 
163 	if (debugfs_valid_mountpoint(tracing_events_path))
164 		return NULL;
165 
166 	sys_dir = opendir(tracing_events_path);
167 	if (!sys_dir)
168 		return NULL;
169 
170 	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
171 
172 		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
173 			 sys_dirent.d_name);
174 		evt_dir = opendir(dir_path);
175 		if (!evt_dir)
176 			continue;
177 
178 		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
179 
180 			snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
181 				 evt_dirent.d_name);
182 			fd = open(evt_path, O_RDONLY);
183 			if (fd < 0)
184 				continue;
185 			if (read(fd, id_buf, sizeof(id_buf)) < 0) {
186 				close(fd);
187 				continue;
188 			}
189 			close(fd);
190 			id = atoll(id_buf);
191 			if (id == config) {
192 				closedir(evt_dir);
193 				closedir(sys_dir);
194 				path = zalloc(sizeof(*path));
195 				path->system = malloc(MAX_EVENT_LENGTH);
196 				if (!path->system) {
197 					free(path);
198 					return NULL;
199 				}
200 				path->name = malloc(MAX_EVENT_LENGTH);
201 				if (!path->name) {
202 					free(path->system);
203 					free(path);
204 					return NULL;
205 				}
206 				strncpy(path->system, sys_dirent.d_name,
207 					MAX_EVENT_LENGTH);
208 				strncpy(path->name, evt_dirent.d_name,
209 					MAX_EVENT_LENGTH);
210 				return path;
211 			}
212 		}
213 		closedir(evt_dir);
214 	}
215 
216 	closedir(sys_dir);
217 	return NULL;
218 }
219 
220 const char *event_type(int type)
221 {
222 	switch (type) {
223 	case PERF_TYPE_HARDWARE:
224 		return "hardware";
225 
226 	case PERF_TYPE_SOFTWARE:
227 		return "software";
228 
229 	case PERF_TYPE_TRACEPOINT:
230 		return "tracepoint";
231 
232 	case PERF_TYPE_HW_CACHE:
233 		return "hardware-cache";
234 
235 	default:
236 		break;
237 	}
238 
239 	return "unknown";
240 }
241 
242 
243 
244 static int __add_event(struct list_head **_list, int *idx,
245 		       struct perf_event_attr *attr,
246 		       char *name, struct cpu_map *cpus)
247 {
248 	struct perf_evsel *evsel;
249 	struct list_head *list = *_list;
250 
251 	if (!list) {
252 		list = malloc(sizeof(*list));
253 		if (!list)
254 			return -ENOMEM;
255 		INIT_LIST_HEAD(list);
256 	}
257 
258 	event_attr_init(attr);
259 
260 	evsel = perf_evsel__new(attr, (*idx)++);
261 	if (!evsel) {
262 		free(list);
263 		return -ENOMEM;
264 	}
265 
266 	evsel->cpus = cpus;
267 	if (name)
268 		evsel->name = strdup(name);
269 	list_add_tail(&evsel->node, list);
270 	*_list = list;
271 	return 0;
272 }
273 
274 static int add_event(struct list_head **_list, int *idx,
275 		     struct perf_event_attr *attr, char *name)
276 {
277 	return __add_event(_list, idx, attr, name, NULL);
278 }
279 
280 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
281 {
282 	int i, j;
283 	int n, longest = -1;
284 
285 	for (i = 0; i < size; i++) {
286 		for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
287 			n = strlen(names[i][j]);
288 			if (n > longest && !strncasecmp(str, names[i][j], n))
289 				longest = n;
290 		}
291 		if (longest > 0)
292 			return i;
293 	}
294 
295 	return -1;
296 }
297 
298 int parse_events_add_cache(struct list_head **list, int *idx,
299 			   char *type, char *op_result1, char *op_result2)
300 {
301 	struct perf_event_attr attr;
302 	char name[MAX_NAME_LEN];
303 	int cache_type = -1, cache_op = -1, cache_result = -1;
304 	char *op_result[2] = { op_result1, op_result2 };
305 	int i, n;
306 
307 	/*
308 	 * No fallback - if we cannot get a clear cache type
309 	 * then bail out:
310 	 */
311 	cache_type = parse_aliases(type, perf_evsel__hw_cache,
312 				   PERF_COUNT_HW_CACHE_MAX);
313 	if (cache_type == -1)
314 		return -EINVAL;
315 
316 	n = snprintf(name, MAX_NAME_LEN, "%s", type);
317 
318 	for (i = 0; (i < 2) && (op_result[i]); i++) {
319 		char *str = op_result[i];
320 
321 		n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
322 
323 		if (cache_op == -1) {
324 			cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
325 						 PERF_COUNT_HW_CACHE_OP_MAX);
326 			if (cache_op >= 0) {
327 				if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
328 					return -EINVAL;
329 				continue;
330 			}
331 		}
332 
333 		if (cache_result == -1) {
334 			cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
335 						     PERF_COUNT_HW_CACHE_RESULT_MAX);
336 			if (cache_result >= 0)
337 				continue;
338 		}
339 	}
340 
341 	/*
342 	 * Fall back to reads:
343 	 */
344 	if (cache_op == -1)
345 		cache_op = PERF_COUNT_HW_CACHE_OP_READ;
346 
347 	/*
348 	 * Fall back to accesses:
349 	 */
350 	if (cache_result == -1)
351 		cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
352 
353 	memset(&attr, 0, sizeof(attr));
354 	attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
355 	attr.type = PERF_TYPE_HW_CACHE;
356 	return add_event(list, idx, &attr, name);
357 }
358 
359 static int add_tracepoint(struct list_head **listp, int *idx,
360 			  char *sys_name, char *evt_name)
361 {
362 	struct perf_evsel *evsel;
363 	struct list_head *list = *listp;
364 
365 	if (!list) {
366 		list = malloc(sizeof(*list));
367 		if (!list)
368 			return -ENOMEM;
369 		INIT_LIST_HEAD(list);
370 	}
371 
372 	evsel = perf_evsel__newtp(sys_name, evt_name, (*idx)++);
373 	if (!evsel) {
374 		free(list);
375 		return -ENOMEM;
376 	}
377 
378 	list_add_tail(&evsel->node, list);
379 	*listp = list;
380 	return 0;
381 }
382 
383 static int add_tracepoint_multi_event(struct list_head **list, int *idx,
384 				      char *sys_name, char *evt_name)
385 {
386 	char evt_path[MAXPATHLEN];
387 	struct dirent *evt_ent;
388 	DIR *evt_dir;
389 	int ret = 0;
390 
391 	snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
392 	evt_dir = opendir(evt_path);
393 	if (!evt_dir) {
394 		perror("Can't open event dir");
395 		return -1;
396 	}
397 
398 	while (!ret && (evt_ent = readdir(evt_dir))) {
399 		if (!strcmp(evt_ent->d_name, ".")
400 		    || !strcmp(evt_ent->d_name, "..")
401 		    || !strcmp(evt_ent->d_name, "enable")
402 		    || !strcmp(evt_ent->d_name, "filter"))
403 			continue;
404 
405 		if (!strglobmatch(evt_ent->d_name, evt_name))
406 			continue;
407 
408 		ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name);
409 	}
410 
411 	closedir(evt_dir);
412 	return ret;
413 }
414 
415 static int add_tracepoint_event(struct list_head **list, int *idx,
416 				char *sys_name, char *evt_name)
417 {
418 	return strpbrk(evt_name, "*?") ?
419 	       add_tracepoint_multi_event(list, idx, sys_name, evt_name) :
420 	       add_tracepoint(list, idx, sys_name, evt_name);
421 }
422 
423 static int add_tracepoint_multi_sys(struct list_head **list, int *idx,
424 				    char *sys_name, char *evt_name)
425 {
426 	struct dirent *events_ent;
427 	DIR *events_dir;
428 	int ret = 0;
429 
430 	events_dir = opendir(tracing_events_path);
431 	if (!events_dir) {
432 		perror("Can't open event dir");
433 		return -1;
434 	}
435 
436 	while (!ret && (events_ent = readdir(events_dir))) {
437 		if (!strcmp(events_ent->d_name, ".")
438 		    || !strcmp(events_ent->d_name, "..")
439 		    || !strcmp(events_ent->d_name, "enable")
440 		    || !strcmp(events_ent->d_name, "header_event")
441 		    || !strcmp(events_ent->d_name, "header_page"))
442 			continue;
443 
444 		if (!strglobmatch(events_ent->d_name, sys_name))
445 			continue;
446 
447 		ret = add_tracepoint_event(list, idx, events_ent->d_name,
448 					   evt_name);
449 	}
450 
451 	closedir(events_dir);
452 	return ret;
453 }
454 
455 int parse_events_add_tracepoint(struct list_head **list, int *idx,
456 				char *sys, char *event)
457 {
458 	int ret;
459 
460 	ret = debugfs_valid_mountpoint(tracing_events_path);
461 	if (ret)
462 		return ret;
463 
464 	if (strpbrk(sys, "*?"))
465 		return add_tracepoint_multi_sys(list, idx, sys, event);
466 	else
467 		return add_tracepoint_event(list, idx, sys, event);
468 }
469 
470 static int
471 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
472 {
473 	int i;
474 
475 	for (i = 0; i < 3; i++) {
476 		if (!type || !type[i])
477 			break;
478 
479 #define CHECK_SET_TYPE(bit)		\
480 do {					\
481 	if (attr->bp_type & bit)	\
482 		return -EINVAL;		\
483 	else				\
484 		attr->bp_type |= bit;	\
485 } while (0)
486 
487 		switch (type[i]) {
488 		case 'r':
489 			CHECK_SET_TYPE(HW_BREAKPOINT_R);
490 			break;
491 		case 'w':
492 			CHECK_SET_TYPE(HW_BREAKPOINT_W);
493 			break;
494 		case 'x':
495 			CHECK_SET_TYPE(HW_BREAKPOINT_X);
496 			break;
497 		default:
498 			return -EINVAL;
499 		}
500 	}
501 
502 #undef CHECK_SET_TYPE
503 
504 	if (!attr->bp_type) /* Default */
505 		attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
506 
507 	return 0;
508 }
509 
510 int parse_events_add_breakpoint(struct list_head **list, int *idx,
511 				void *ptr, char *type)
512 {
513 	struct perf_event_attr attr;
514 
515 	memset(&attr, 0, sizeof(attr));
516 	attr.bp_addr = (unsigned long) ptr;
517 
518 	if (parse_breakpoint_type(type, &attr))
519 		return -EINVAL;
520 
521 	/*
522 	 * We should find a nice way to override the access length
523 	 * Provide some defaults for now
524 	 */
525 	if (attr.bp_type == HW_BREAKPOINT_X)
526 		attr.bp_len = sizeof(long);
527 	else
528 		attr.bp_len = HW_BREAKPOINT_LEN_4;
529 
530 	attr.type = PERF_TYPE_BREAKPOINT;
531 	attr.sample_period = 1;
532 
533 	return add_event(list, idx, &attr, NULL);
534 }
535 
536 static int config_term(struct perf_event_attr *attr,
537 		       struct parse_events_term *term)
538 {
539 #define CHECK_TYPE_VAL(type)					\
540 do {								\
541 	if (PARSE_EVENTS__TERM_TYPE_ ## type != term->type_val)	\
542 		return -EINVAL;					\
543 } while (0)
544 
545 	switch (term->type_term) {
546 	case PARSE_EVENTS__TERM_TYPE_CONFIG:
547 		CHECK_TYPE_VAL(NUM);
548 		attr->config = term->val.num;
549 		break;
550 	case PARSE_EVENTS__TERM_TYPE_CONFIG1:
551 		CHECK_TYPE_VAL(NUM);
552 		attr->config1 = term->val.num;
553 		break;
554 	case PARSE_EVENTS__TERM_TYPE_CONFIG2:
555 		CHECK_TYPE_VAL(NUM);
556 		attr->config2 = term->val.num;
557 		break;
558 	case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
559 		CHECK_TYPE_VAL(NUM);
560 		attr->sample_period = term->val.num;
561 		break;
562 	case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
563 		/*
564 		 * TODO uncomment when the field is available
565 		 * attr->branch_sample_type = term->val.num;
566 		 */
567 		break;
568 	case PARSE_EVENTS__TERM_TYPE_NAME:
569 		CHECK_TYPE_VAL(STR);
570 		break;
571 	default:
572 		return -EINVAL;
573 	}
574 
575 	return 0;
576 #undef CHECK_TYPE_VAL
577 }
578 
579 static int config_attr(struct perf_event_attr *attr,
580 		       struct list_head *head, int fail)
581 {
582 	struct parse_events_term *term;
583 
584 	list_for_each_entry(term, head, list)
585 		if (config_term(attr, term) && fail)
586 			return -EINVAL;
587 
588 	return 0;
589 }
590 
591 int parse_events_add_numeric(struct list_head **list, int *idx,
592 			     u32 type, u64 config,
593 			     struct list_head *head_config)
594 {
595 	struct perf_event_attr attr;
596 
597 	memset(&attr, 0, sizeof(attr));
598 	attr.type = type;
599 	attr.config = config;
600 
601 	if (head_config &&
602 	    config_attr(&attr, head_config, 1))
603 		return -EINVAL;
604 
605 	return add_event(list, idx, &attr, NULL);
606 }
607 
608 static int parse_events__is_name_term(struct parse_events_term *term)
609 {
610 	return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
611 }
612 
613 static char *pmu_event_name(struct list_head *head_terms)
614 {
615 	struct parse_events_term *term;
616 
617 	list_for_each_entry(term, head_terms, list)
618 		if (parse_events__is_name_term(term))
619 			return term->val.str;
620 
621 	return NULL;
622 }
623 
624 int parse_events_add_pmu(struct list_head **list, int *idx,
625 			 char *name, struct list_head *head_config)
626 {
627 	struct perf_event_attr attr;
628 	struct perf_pmu *pmu;
629 
630 	pmu = perf_pmu__find(name);
631 	if (!pmu)
632 		return -EINVAL;
633 
634 	memset(&attr, 0, sizeof(attr));
635 
636 	if (perf_pmu__check_alias(pmu, head_config))
637 		return -EINVAL;
638 
639 	/*
640 	 * Configure hardcoded terms first, no need to check
641 	 * return value when called with fail == 0 ;)
642 	 */
643 	config_attr(&attr, head_config, 0);
644 
645 	if (perf_pmu__config(pmu, &attr, head_config))
646 		return -EINVAL;
647 
648 	return __add_event(list, idx, &attr, pmu_event_name(head_config),
649 			   pmu->cpus);
650 }
651 
652 int parse_events__modifier_group(struct list_head *list,
653 				 char *event_mod)
654 {
655 	return parse_events__modifier_event(list, event_mod, true);
656 }
657 
658 void parse_events__set_leader(char *name, struct list_head *list)
659 {
660 	struct perf_evsel *leader;
661 
662 	__perf_evlist__set_leader(list);
663 	leader = list_entry(list->next, struct perf_evsel, node);
664 	leader->group_name = name ? strdup(name) : NULL;
665 }
666 
667 void parse_events_update_lists(struct list_head *list_event,
668 			       struct list_head *list_all)
669 {
670 	/*
671 	 * Called for single event definition. Update the
672 	 * 'all event' list, and reinit the 'single event'
673 	 * list, for next event definition.
674 	 */
675 	list_splice_tail(list_event, list_all);
676 	free(list_event);
677 }
678 
679 struct event_modifier {
680 	int eu;
681 	int ek;
682 	int eh;
683 	int eH;
684 	int eG;
685 	int precise;
686 	int exclude_GH;
687 };
688 
689 static int get_event_modifier(struct event_modifier *mod, char *str,
690 			       struct perf_evsel *evsel)
691 {
692 	int eu = evsel ? evsel->attr.exclude_user : 0;
693 	int ek = evsel ? evsel->attr.exclude_kernel : 0;
694 	int eh = evsel ? evsel->attr.exclude_hv : 0;
695 	int eH = evsel ? evsel->attr.exclude_host : 0;
696 	int eG = evsel ? evsel->attr.exclude_guest : 0;
697 	int precise = evsel ? evsel->attr.precise_ip : 0;
698 
699 	int exclude = eu | ek | eh;
700 	int exclude_GH = evsel ? evsel->exclude_GH : 0;
701 
702 	memset(mod, 0, sizeof(*mod));
703 
704 	while (*str) {
705 		if (*str == 'u') {
706 			if (!exclude)
707 				exclude = eu = ek = eh = 1;
708 			eu = 0;
709 		} else if (*str == 'k') {
710 			if (!exclude)
711 				exclude = eu = ek = eh = 1;
712 			ek = 0;
713 		} else if (*str == 'h') {
714 			if (!exclude)
715 				exclude = eu = ek = eh = 1;
716 			eh = 0;
717 		} else if (*str == 'G') {
718 			if (!exclude_GH)
719 				exclude_GH = eG = eH = 1;
720 			eG = 0;
721 		} else if (*str == 'H') {
722 			if (!exclude_GH)
723 				exclude_GH = eG = eH = 1;
724 			eH = 0;
725 		} else if (*str == 'p') {
726 			precise++;
727 			/* use of precise requires exclude_guest */
728 			if (!exclude_GH)
729 				eG = 1;
730 		} else
731 			break;
732 
733 		++str;
734 	}
735 
736 	/*
737 	 * precise ip:
738 	 *
739 	 *  0 - SAMPLE_IP can have arbitrary skid
740 	 *  1 - SAMPLE_IP must have constant skid
741 	 *  2 - SAMPLE_IP requested to have 0 skid
742 	 *  3 - SAMPLE_IP must have 0 skid
743 	 *
744 	 *  See also PERF_RECORD_MISC_EXACT_IP
745 	 */
746 	if (precise > 3)
747 		return -EINVAL;
748 
749 	mod->eu = eu;
750 	mod->ek = ek;
751 	mod->eh = eh;
752 	mod->eH = eH;
753 	mod->eG = eG;
754 	mod->precise = precise;
755 	mod->exclude_GH = exclude_GH;
756 	return 0;
757 }
758 
759 /*
760  * Basic modifier sanity check to validate it contains only one
761  * instance of any modifier (apart from 'p') present.
762  */
763 static int check_modifier(char *str)
764 {
765 	char *p = str;
766 
767 	/* The sizeof includes 0 byte as well. */
768 	if (strlen(str) > (sizeof("ukhGHppp") - 1))
769 		return -1;
770 
771 	while (*p) {
772 		if (*p != 'p' && strchr(p + 1, *p))
773 			return -1;
774 		p++;
775 	}
776 
777 	return 0;
778 }
779 
780 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
781 {
782 	struct perf_evsel *evsel;
783 	struct event_modifier mod;
784 
785 	if (str == NULL)
786 		return 0;
787 
788 	if (check_modifier(str))
789 		return -EINVAL;
790 
791 	if (!add && get_event_modifier(&mod, str, NULL))
792 		return -EINVAL;
793 
794 	list_for_each_entry(evsel, list, node) {
795 
796 		if (add && get_event_modifier(&mod, str, evsel))
797 			return -EINVAL;
798 
799 		evsel->attr.exclude_user   = mod.eu;
800 		evsel->attr.exclude_kernel = mod.ek;
801 		evsel->attr.exclude_hv     = mod.eh;
802 		evsel->attr.precise_ip     = mod.precise;
803 		evsel->attr.exclude_host   = mod.eH;
804 		evsel->attr.exclude_guest  = mod.eG;
805 		evsel->exclude_GH          = mod.exclude_GH;
806 	}
807 
808 	return 0;
809 }
810 
811 int parse_events_name(struct list_head *list, char *name)
812 {
813 	struct perf_evsel *evsel;
814 
815 	list_for_each_entry(evsel, list, node) {
816 		if (!evsel->name)
817 			evsel->name = strdup(name);
818 	}
819 
820 	return 0;
821 }
822 
823 static int parse_events__scanner(const char *str, void *data, int start_token)
824 {
825 	YY_BUFFER_STATE buffer;
826 	void *scanner;
827 	int ret;
828 
829 	ret = parse_events_lex_init_extra(start_token, &scanner);
830 	if (ret)
831 		return ret;
832 
833 	buffer = parse_events__scan_string(str, scanner);
834 
835 #ifdef PARSER_DEBUG
836 	parse_events_debug = 1;
837 #endif
838 	ret = parse_events_parse(data, scanner);
839 
840 	parse_events__flush_buffer(buffer, scanner);
841 	parse_events__delete_buffer(buffer, scanner);
842 	parse_events_lex_destroy(scanner);
843 	return ret;
844 }
845 
846 /*
847  * parse event config string, return a list of event terms.
848  */
849 int parse_events_terms(struct list_head *terms, const char *str)
850 {
851 	struct parse_events_terms data = {
852 		.terms = NULL,
853 	};
854 	int ret;
855 
856 	ret = parse_events__scanner(str, &data, PE_START_TERMS);
857 	if (!ret) {
858 		list_splice(data.terms, terms);
859 		free(data.terms);
860 		return 0;
861 	}
862 
863 	if (data.terms)
864 		parse_events__free_terms(data.terms);
865 	return ret;
866 }
867 
868 int parse_events(struct perf_evlist *evlist, const char *str)
869 {
870 	struct parse_events_evlist data = {
871 		.list = LIST_HEAD_INIT(data.list),
872 		.idx  = evlist->nr_entries,
873 	};
874 	int ret;
875 
876 	ret = parse_events__scanner(str, &data, PE_START_EVENTS);
877 	if (!ret) {
878 		int entries = data.idx - evlist->nr_entries;
879 		perf_evlist__splice_list_tail(evlist, &data.list, entries);
880 		evlist->nr_groups += data.nr_groups;
881 		return 0;
882 	}
883 
884 	/*
885 	 * There are 2 users - builtin-record and builtin-test objects.
886 	 * Both call perf_evlist__delete in case of error, so we dont
887 	 * need to bother.
888 	 */
889 	return ret;
890 }
891 
892 int parse_events_option(const struct option *opt, const char *str,
893 			int unset __maybe_unused)
894 {
895 	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
896 	int ret = parse_events(evlist, str);
897 
898 	if (ret) {
899 		fprintf(stderr, "invalid or unsupported event: '%s'\n", str);
900 		fprintf(stderr, "Run 'perf list' for a list of valid events\n");
901 	}
902 	return ret;
903 }
904 
905 int parse_filter(const struct option *opt, const char *str,
906 		 int unset __maybe_unused)
907 {
908 	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
909 	struct perf_evsel *last = NULL;
910 
911 	if (evlist->nr_entries > 0)
912 		last = perf_evlist__last(evlist);
913 
914 	if (last == NULL || last->attr.type != PERF_TYPE_TRACEPOINT) {
915 		fprintf(stderr,
916 			"-F option should follow a -e tracepoint option\n");
917 		return -1;
918 	}
919 
920 	last->filter = strdup(str);
921 	if (last->filter == NULL) {
922 		fprintf(stderr, "not enough memory to hold filter string\n");
923 		return -1;
924 	}
925 
926 	return 0;
927 }
928 
929 static const char * const event_type_descriptors[] = {
930 	"Hardware event",
931 	"Software event",
932 	"Tracepoint event",
933 	"Hardware cache event",
934 	"Raw hardware event descriptor",
935 	"Hardware breakpoint",
936 };
937 
938 /*
939  * Print the events from <debugfs_mount_point>/tracing/events
940  */
941 
942 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
943 			     bool name_only)
944 {
945 	DIR *sys_dir, *evt_dir;
946 	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
947 	char evt_path[MAXPATHLEN];
948 	char dir_path[MAXPATHLEN];
949 
950 	if (debugfs_valid_mountpoint(tracing_events_path))
951 		return;
952 
953 	sys_dir = opendir(tracing_events_path);
954 	if (!sys_dir)
955 		return;
956 
957 	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
958 		if (subsys_glob != NULL &&
959 		    !strglobmatch(sys_dirent.d_name, subsys_glob))
960 			continue;
961 
962 		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
963 			 sys_dirent.d_name);
964 		evt_dir = opendir(dir_path);
965 		if (!evt_dir)
966 			continue;
967 
968 		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
969 			if (event_glob != NULL &&
970 			    !strglobmatch(evt_dirent.d_name, event_glob))
971 				continue;
972 
973 			if (name_only) {
974 				printf("%s:%s ", sys_dirent.d_name, evt_dirent.d_name);
975 				continue;
976 			}
977 
978 			snprintf(evt_path, MAXPATHLEN, "%s:%s",
979 				 sys_dirent.d_name, evt_dirent.d_name);
980 			printf("  %-50s [%s]\n", evt_path,
981 				event_type_descriptors[PERF_TYPE_TRACEPOINT]);
982 		}
983 		closedir(evt_dir);
984 	}
985 	closedir(sys_dir);
986 }
987 
988 /*
989  * Check whether event is in <debugfs_mount_point>/tracing/events
990  */
991 
992 int is_valid_tracepoint(const char *event_string)
993 {
994 	DIR *sys_dir, *evt_dir;
995 	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
996 	char evt_path[MAXPATHLEN];
997 	char dir_path[MAXPATHLEN];
998 
999 	if (debugfs_valid_mountpoint(tracing_events_path))
1000 		return 0;
1001 
1002 	sys_dir = opendir(tracing_events_path);
1003 	if (!sys_dir)
1004 		return 0;
1005 
1006 	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
1007 
1008 		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
1009 			 sys_dirent.d_name);
1010 		evt_dir = opendir(dir_path);
1011 		if (!evt_dir)
1012 			continue;
1013 
1014 		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
1015 			snprintf(evt_path, MAXPATHLEN, "%s:%s",
1016 				 sys_dirent.d_name, evt_dirent.d_name);
1017 			if (!strcmp(evt_path, event_string)) {
1018 				closedir(evt_dir);
1019 				closedir(sys_dir);
1020 				return 1;
1021 			}
1022 		}
1023 		closedir(evt_dir);
1024 	}
1025 	closedir(sys_dir);
1026 	return 0;
1027 }
1028 
1029 static void __print_events_type(u8 type, struct event_symbol *syms,
1030 				unsigned max)
1031 {
1032 	char name[64];
1033 	unsigned i;
1034 
1035 	for (i = 0; i < max ; i++, syms++) {
1036 		if (strlen(syms->alias))
1037 			snprintf(name, sizeof(name),  "%s OR %s",
1038 				 syms->symbol, syms->alias);
1039 		else
1040 			snprintf(name, sizeof(name), "%s", syms->symbol);
1041 
1042 		printf("  %-50s [%s]\n", name,
1043 			event_type_descriptors[type]);
1044 	}
1045 }
1046 
1047 void print_events_type(u8 type)
1048 {
1049 	if (type == PERF_TYPE_SOFTWARE)
1050 		__print_events_type(type, event_symbols_sw, PERF_COUNT_SW_MAX);
1051 	else
1052 		__print_events_type(type, event_symbols_hw, PERF_COUNT_HW_MAX);
1053 }
1054 
1055 int print_hwcache_events(const char *event_glob, bool name_only)
1056 {
1057 	unsigned int type, op, i, printed = 0;
1058 	char name[64];
1059 
1060 	for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
1061 		for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
1062 			/* skip invalid cache type */
1063 			if (!perf_evsel__is_cache_op_valid(type, op))
1064 				continue;
1065 
1066 			for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
1067 				__perf_evsel__hw_cache_type_op_res_name(type, op, i,
1068 									name, sizeof(name));
1069 				if (event_glob != NULL && !strglobmatch(name, event_glob))
1070 					continue;
1071 
1072 				if (name_only)
1073 					printf("%s ", name);
1074 				else
1075 					printf("  %-50s [%s]\n", name,
1076 					       event_type_descriptors[PERF_TYPE_HW_CACHE]);
1077 				++printed;
1078 			}
1079 		}
1080 	}
1081 
1082 	return printed;
1083 }
1084 
1085 static void print_symbol_events(const char *event_glob, unsigned type,
1086 				struct event_symbol *syms, unsigned max,
1087 				bool name_only)
1088 {
1089 	unsigned i, printed = 0;
1090 	char name[MAX_NAME_LEN];
1091 
1092 	for (i = 0; i < max; i++, syms++) {
1093 
1094 		if (event_glob != NULL &&
1095 		    !(strglobmatch(syms->symbol, event_glob) ||
1096 		      (syms->alias && strglobmatch(syms->alias, event_glob))))
1097 			continue;
1098 
1099 		if (name_only) {
1100 			printf("%s ", syms->symbol);
1101 			continue;
1102 		}
1103 
1104 		if (strlen(syms->alias))
1105 			snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
1106 		else
1107 			strncpy(name, syms->symbol, MAX_NAME_LEN);
1108 
1109 		printf("  %-50s [%s]\n", name, event_type_descriptors[type]);
1110 
1111 		printed++;
1112 	}
1113 
1114 	if (printed)
1115 		printf("\n");
1116 }
1117 
1118 /*
1119  * Print the help text for the event symbols:
1120  */
1121 void print_events(const char *event_glob, bool name_only)
1122 {
1123 	if (!name_only) {
1124 		printf("\n");
1125 		printf("List of pre-defined events (to be used in -e):\n");
1126 	}
1127 
1128 	print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
1129 			    event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
1130 
1131 	print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
1132 			    event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
1133 
1134 	print_hwcache_events(event_glob, name_only);
1135 
1136 	if (event_glob != NULL)
1137 		return;
1138 
1139 	if (!name_only) {
1140 		printf("\n");
1141 		printf("  %-50s [%s]\n",
1142 		       "rNNN",
1143 		       event_type_descriptors[PERF_TYPE_RAW]);
1144 		printf("  %-50s [%s]\n",
1145 		       "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
1146 		       event_type_descriptors[PERF_TYPE_RAW]);
1147 		printf("   (see 'man perf-list' on how to encode it)\n");
1148 		printf("\n");
1149 
1150 		printf("  %-50s [%s]\n",
1151 		       "mem:<addr>[:access]",
1152 			event_type_descriptors[PERF_TYPE_BREAKPOINT]);
1153 		printf("\n");
1154 	}
1155 
1156 	print_tracepoint_events(NULL, NULL, name_only);
1157 }
1158 
1159 int parse_events__is_hardcoded_term(struct parse_events_term *term)
1160 {
1161 	return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
1162 }
1163 
1164 static int new_term(struct parse_events_term **_term, int type_val,
1165 		    int type_term, char *config,
1166 		    char *str, u64 num)
1167 {
1168 	struct parse_events_term *term;
1169 
1170 	term = zalloc(sizeof(*term));
1171 	if (!term)
1172 		return -ENOMEM;
1173 
1174 	INIT_LIST_HEAD(&term->list);
1175 	term->type_val  = type_val;
1176 	term->type_term = type_term;
1177 	term->config = config;
1178 
1179 	switch (type_val) {
1180 	case PARSE_EVENTS__TERM_TYPE_NUM:
1181 		term->val.num = num;
1182 		break;
1183 	case PARSE_EVENTS__TERM_TYPE_STR:
1184 		term->val.str = str;
1185 		break;
1186 	default:
1187 		free(term);
1188 		return -EINVAL;
1189 	}
1190 
1191 	*_term = term;
1192 	return 0;
1193 }
1194 
1195 int parse_events_term__num(struct parse_events_term **term,
1196 			   int type_term, char *config, u64 num)
1197 {
1198 	return new_term(term, PARSE_EVENTS__TERM_TYPE_NUM, type_term,
1199 			config, NULL, num);
1200 }
1201 
1202 int parse_events_term__str(struct parse_events_term **term,
1203 			   int type_term, char *config, char *str)
1204 {
1205 	return new_term(term, PARSE_EVENTS__TERM_TYPE_STR, type_term,
1206 			config, str, 0);
1207 }
1208 
1209 int parse_events_term__sym_hw(struct parse_events_term **term,
1210 			      char *config, unsigned idx)
1211 {
1212 	struct event_symbol *sym;
1213 
1214 	BUG_ON(idx >= PERF_COUNT_HW_MAX);
1215 	sym = &event_symbols_hw[idx];
1216 
1217 	if (config)
1218 		return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
1219 				PARSE_EVENTS__TERM_TYPE_USER, config,
1220 				(char *) sym->symbol, 0);
1221 	else
1222 		return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
1223 				PARSE_EVENTS__TERM_TYPE_USER,
1224 				(char *) "event", (char *) sym->symbol, 0);
1225 }
1226 
1227 int parse_events_term__clone(struct parse_events_term **new,
1228 			     struct parse_events_term *term)
1229 {
1230 	return new_term(new, term->type_val, term->type_term, term->config,
1231 			term->val.str, term->val.num);
1232 }
1233 
1234 void parse_events__free_terms(struct list_head *terms)
1235 {
1236 	struct parse_events_term *term, *h;
1237 
1238 	list_for_each_entry_safe(term, h, terms, list)
1239 		free(term);
1240 
1241 	free(terms);
1242 }
1243