xref: /linux/tools/perf/util/parse-events.c (revision 95e9fd10f06cb5642028b6b851e32b8c8afb4571)
1 #include "../../../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 "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 static int add_event(struct list_head **_list, int *idx,
243 		     struct perf_event_attr *attr, char *name)
244 {
245 	struct perf_evsel *evsel;
246 	struct list_head *list = *_list;
247 
248 	if (!list) {
249 		list = malloc(sizeof(*list));
250 		if (!list)
251 			return -ENOMEM;
252 		INIT_LIST_HEAD(list);
253 	}
254 
255 	event_attr_init(attr);
256 
257 	evsel = perf_evsel__new(attr, (*idx)++);
258 	if (!evsel) {
259 		free(list);
260 		return -ENOMEM;
261 	}
262 
263 	if (name)
264 		evsel->name = strdup(name);
265 	list_add_tail(&evsel->node, list);
266 	*_list = list;
267 	return 0;
268 }
269 
270 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
271 {
272 	int i, j;
273 	int n, longest = -1;
274 
275 	for (i = 0; i < size; i++) {
276 		for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
277 			n = strlen(names[i][j]);
278 			if (n > longest && !strncasecmp(str, names[i][j], n))
279 				longest = n;
280 		}
281 		if (longest > 0)
282 			return i;
283 	}
284 
285 	return -1;
286 }
287 
288 int parse_events_add_cache(struct list_head **list, int *idx,
289 			   char *type, char *op_result1, char *op_result2)
290 {
291 	struct perf_event_attr attr;
292 	char name[MAX_NAME_LEN];
293 	int cache_type = -1, cache_op = -1, cache_result = -1;
294 	char *op_result[2] = { op_result1, op_result2 };
295 	int i, n;
296 
297 	/*
298 	 * No fallback - if we cannot get a clear cache type
299 	 * then bail out:
300 	 */
301 	cache_type = parse_aliases(type, perf_evsel__hw_cache,
302 				   PERF_COUNT_HW_CACHE_MAX);
303 	if (cache_type == -1)
304 		return -EINVAL;
305 
306 	n = snprintf(name, MAX_NAME_LEN, "%s", type);
307 
308 	for (i = 0; (i < 2) && (op_result[i]); i++) {
309 		char *str = op_result[i];
310 
311 		snprintf(name + n, MAX_NAME_LEN - n, "-%s\n", str);
312 
313 		if (cache_op == -1) {
314 			cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
315 						 PERF_COUNT_HW_CACHE_OP_MAX);
316 			if (cache_op >= 0) {
317 				if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
318 					return -EINVAL;
319 				continue;
320 			}
321 		}
322 
323 		if (cache_result == -1) {
324 			cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
325 						     PERF_COUNT_HW_CACHE_RESULT_MAX);
326 			if (cache_result >= 0)
327 				continue;
328 		}
329 	}
330 
331 	/*
332 	 * Fall back to reads:
333 	 */
334 	if (cache_op == -1)
335 		cache_op = PERF_COUNT_HW_CACHE_OP_READ;
336 
337 	/*
338 	 * Fall back to accesses:
339 	 */
340 	if (cache_result == -1)
341 		cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
342 
343 	memset(&attr, 0, sizeof(attr));
344 	attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
345 	attr.type = PERF_TYPE_HW_CACHE;
346 	return add_event(list, idx, &attr, name);
347 }
348 
349 static int add_tracepoint(struct list_head **list, int *idx,
350 			  char *sys_name, char *evt_name)
351 {
352 	struct perf_event_attr attr;
353 	char name[MAX_NAME_LEN];
354 	char evt_path[MAXPATHLEN];
355 	char id_buf[4];
356 	u64 id;
357 	int fd;
358 
359 	snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
360 		 sys_name, evt_name);
361 
362 	fd = open(evt_path, O_RDONLY);
363 	if (fd < 0)
364 		return -1;
365 
366 	if (read(fd, id_buf, sizeof(id_buf)) < 0) {
367 		close(fd);
368 		return -1;
369 	}
370 
371 	close(fd);
372 	id = atoll(id_buf);
373 
374 	memset(&attr, 0, sizeof(attr));
375 	attr.config = id;
376 	attr.type = PERF_TYPE_TRACEPOINT;
377 	attr.sample_type |= PERF_SAMPLE_RAW;
378 	attr.sample_type |= PERF_SAMPLE_TIME;
379 	attr.sample_type |= PERF_SAMPLE_CPU;
380 	attr.sample_type |= PERF_SAMPLE_PERIOD;
381 	attr.sample_period = 1;
382 
383 	snprintf(name, MAX_NAME_LEN, "%s:%s", sys_name, evt_name);
384 	return add_event(list, idx, &attr, name);
385 }
386 
387 static int add_tracepoint_multi(struct list_head **list, int *idx,
388 				char *sys_name, char *evt_name)
389 {
390 	char evt_path[MAXPATHLEN];
391 	struct dirent *evt_ent;
392 	DIR *evt_dir;
393 	int ret = 0;
394 
395 	snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
396 	evt_dir = opendir(evt_path);
397 	if (!evt_dir) {
398 		perror("Can't open event dir");
399 		return -1;
400 	}
401 
402 	while (!ret && (evt_ent = readdir(evt_dir))) {
403 		if (!strcmp(evt_ent->d_name, ".")
404 		    || !strcmp(evt_ent->d_name, "..")
405 		    || !strcmp(evt_ent->d_name, "enable")
406 		    || !strcmp(evt_ent->d_name, "filter"))
407 			continue;
408 
409 		if (!strglobmatch(evt_ent->d_name, evt_name))
410 			continue;
411 
412 		ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name);
413 	}
414 
415 	return ret;
416 }
417 
418 int parse_events_add_tracepoint(struct list_head **list, int *idx,
419 				char *sys, char *event)
420 {
421 	int ret;
422 
423 	ret = debugfs_valid_mountpoint(tracing_events_path);
424 	if (ret)
425 		return ret;
426 
427 	return strpbrk(event, "*?") ?
428 	       add_tracepoint_multi(list, idx, sys, event) :
429 	       add_tracepoint(list, idx, sys, event);
430 }
431 
432 static int
433 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
434 {
435 	int i;
436 
437 	for (i = 0; i < 3; i++) {
438 		if (!type || !type[i])
439 			break;
440 
441 #define CHECK_SET_TYPE(bit)		\
442 do {					\
443 	if (attr->bp_type & bit)	\
444 		return -EINVAL;		\
445 	else				\
446 		attr->bp_type |= bit;	\
447 } while (0)
448 
449 		switch (type[i]) {
450 		case 'r':
451 			CHECK_SET_TYPE(HW_BREAKPOINT_R);
452 			break;
453 		case 'w':
454 			CHECK_SET_TYPE(HW_BREAKPOINT_W);
455 			break;
456 		case 'x':
457 			CHECK_SET_TYPE(HW_BREAKPOINT_X);
458 			break;
459 		default:
460 			return -EINVAL;
461 		}
462 	}
463 
464 #undef CHECK_SET_TYPE
465 
466 	if (!attr->bp_type) /* Default */
467 		attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
468 
469 	return 0;
470 }
471 
472 int parse_events_add_breakpoint(struct list_head **list, int *idx,
473 				void *ptr, char *type)
474 {
475 	struct perf_event_attr attr;
476 
477 	memset(&attr, 0, sizeof(attr));
478 	attr.bp_addr = (unsigned long) ptr;
479 
480 	if (parse_breakpoint_type(type, &attr))
481 		return -EINVAL;
482 
483 	/*
484 	 * We should find a nice way to override the access length
485 	 * Provide some defaults for now
486 	 */
487 	if (attr.bp_type == HW_BREAKPOINT_X)
488 		attr.bp_len = sizeof(long);
489 	else
490 		attr.bp_len = HW_BREAKPOINT_LEN_4;
491 
492 	attr.type = PERF_TYPE_BREAKPOINT;
493 	attr.sample_period = 1;
494 
495 	return add_event(list, idx, &attr, NULL);
496 }
497 
498 static int config_term(struct perf_event_attr *attr,
499 		       struct parse_events__term *term)
500 {
501 #define CHECK_TYPE_VAL(type)					\
502 do {								\
503 	if (PARSE_EVENTS__TERM_TYPE_ ## type != term->type_val)	\
504 		return -EINVAL;					\
505 } while (0)
506 
507 	switch (term->type_term) {
508 	case PARSE_EVENTS__TERM_TYPE_CONFIG:
509 		CHECK_TYPE_VAL(NUM);
510 		attr->config = term->val.num;
511 		break;
512 	case PARSE_EVENTS__TERM_TYPE_CONFIG1:
513 		CHECK_TYPE_VAL(NUM);
514 		attr->config1 = term->val.num;
515 		break;
516 	case PARSE_EVENTS__TERM_TYPE_CONFIG2:
517 		CHECK_TYPE_VAL(NUM);
518 		attr->config2 = term->val.num;
519 		break;
520 	case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
521 		CHECK_TYPE_VAL(NUM);
522 		attr->sample_period = term->val.num;
523 		break;
524 	case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
525 		/*
526 		 * TODO uncomment when the field is available
527 		 * attr->branch_sample_type = term->val.num;
528 		 */
529 		break;
530 	case PARSE_EVENTS__TERM_TYPE_NAME:
531 		CHECK_TYPE_VAL(STR);
532 		break;
533 	default:
534 		return -EINVAL;
535 	}
536 
537 	return 0;
538 #undef CHECK_TYPE_VAL
539 }
540 
541 static int config_attr(struct perf_event_attr *attr,
542 		       struct list_head *head, int fail)
543 {
544 	struct parse_events__term *term;
545 
546 	list_for_each_entry(term, head, list)
547 		if (config_term(attr, term) && fail)
548 			return -EINVAL;
549 
550 	return 0;
551 }
552 
553 int parse_events_add_numeric(struct list_head **list, int *idx,
554 			     unsigned long type, unsigned long config,
555 			     struct list_head *head_config)
556 {
557 	struct perf_event_attr attr;
558 
559 	memset(&attr, 0, sizeof(attr));
560 	attr.type = type;
561 	attr.config = config;
562 
563 	if (head_config &&
564 	    config_attr(&attr, head_config, 1))
565 		return -EINVAL;
566 
567 	return add_event(list, idx, &attr, NULL);
568 }
569 
570 static int parse_events__is_name_term(struct parse_events__term *term)
571 {
572 	return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
573 }
574 
575 static char *pmu_event_name(struct list_head *head_terms)
576 {
577 	struct parse_events__term *term;
578 
579 	list_for_each_entry(term, head_terms, list)
580 		if (parse_events__is_name_term(term))
581 			return term->val.str;
582 
583 	return NULL;
584 }
585 
586 int parse_events_add_pmu(struct list_head **list, int *idx,
587 			 char *name, struct list_head *head_config)
588 {
589 	struct perf_event_attr attr;
590 	struct perf_pmu *pmu;
591 
592 	pmu = perf_pmu__find(name);
593 	if (!pmu)
594 		return -EINVAL;
595 
596 	memset(&attr, 0, sizeof(attr));
597 
598 	if (perf_pmu__check_alias(pmu, head_config))
599 		return -EINVAL;
600 
601 	/*
602 	 * Configure hardcoded terms first, no need to check
603 	 * return value when called with fail == 0 ;)
604 	 */
605 	config_attr(&attr, head_config, 0);
606 
607 	if (perf_pmu__config(pmu, &attr, head_config))
608 		return -EINVAL;
609 
610 	return add_event(list, idx, &attr,
611 			 pmu_event_name(head_config));
612 }
613 
614 void parse_events_update_lists(struct list_head *list_event,
615 			       struct list_head *list_all)
616 {
617 	/*
618 	 * Called for single event definition. Update the
619 	 * 'all event' list, and reinit the 'signle event'
620 	 * list, for next event definition.
621 	 */
622 	list_splice_tail(list_event, list_all);
623 	free(list_event);
624 }
625 
626 int parse_events_modifier(struct list_head *list, char *str)
627 {
628 	struct perf_evsel *evsel;
629 	int exclude = 0, exclude_GH = 0;
630 	int eu = 0, ek = 0, eh = 0, eH = 0, eG = 0, precise = 0;
631 
632 	if (str == NULL)
633 		return 0;
634 
635 	while (*str) {
636 		if (*str == 'u') {
637 			if (!exclude)
638 				exclude = eu = ek = eh = 1;
639 			eu = 0;
640 		} else if (*str == 'k') {
641 			if (!exclude)
642 				exclude = eu = ek = eh = 1;
643 			ek = 0;
644 		} else if (*str == 'h') {
645 			if (!exclude)
646 				exclude = eu = ek = eh = 1;
647 			eh = 0;
648 		} else if (*str == 'G') {
649 			if (!exclude_GH)
650 				exclude_GH = eG = eH = 1;
651 			eG = 0;
652 		} else if (*str == 'H') {
653 			if (!exclude_GH)
654 				exclude_GH = eG = eH = 1;
655 			eH = 0;
656 		} else if (*str == 'p') {
657 			precise++;
658 		} else
659 			break;
660 
661 		++str;
662 	}
663 
664 	/*
665 	 * precise ip:
666 	 *
667 	 *  0 - SAMPLE_IP can have arbitrary skid
668 	 *  1 - SAMPLE_IP must have constant skid
669 	 *  2 - SAMPLE_IP requested to have 0 skid
670 	 *  3 - SAMPLE_IP must have 0 skid
671 	 *
672 	 *  See also PERF_RECORD_MISC_EXACT_IP
673 	 */
674 	if (precise > 3)
675 		return -EINVAL;
676 
677 	list_for_each_entry(evsel, list, node) {
678 		evsel->attr.exclude_user   = eu;
679 		evsel->attr.exclude_kernel = ek;
680 		evsel->attr.exclude_hv     = eh;
681 		evsel->attr.precise_ip     = precise;
682 		evsel->attr.exclude_host   = eH;
683 		evsel->attr.exclude_guest  = eG;
684 	}
685 
686 	return 0;
687 }
688 
689 static int parse_events__scanner(const char *str, void *data, int start_token)
690 {
691 	YY_BUFFER_STATE buffer;
692 	void *scanner;
693 	int ret;
694 
695 	ret = parse_events_lex_init_extra(start_token, &scanner);
696 	if (ret)
697 		return ret;
698 
699 	buffer = parse_events__scan_string(str, scanner);
700 
701 #ifdef PARSER_DEBUG
702 	parse_events_debug = 1;
703 #endif
704 	ret = parse_events_parse(data, scanner);
705 
706 	parse_events__flush_buffer(buffer, scanner);
707 	parse_events__delete_buffer(buffer, scanner);
708 	parse_events_lex_destroy(scanner);
709 	return ret;
710 }
711 
712 /*
713  * parse event config string, return a list of event terms.
714  */
715 int parse_events_terms(struct list_head *terms, const char *str)
716 {
717 	struct parse_events_data__terms data = {
718 		.terms = NULL,
719 	};
720 	int ret;
721 
722 	ret = parse_events__scanner(str, &data, PE_START_TERMS);
723 	if (!ret) {
724 		list_splice(data.terms, terms);
725 		free(data.terms);
726 		return 0;
727 	}
728 
729 	parse_events__free_terms(data.terms);
730 	return ret;
731 }
732 
733 int parse_events(struct perf_evlist *evlist, const char *str, int unset __used)
734 {
735 	struct parse_events_data__events data = {
736 		.list = LIST_HEAD_INIT(data.list),
737 		.idx  = evlist->nr_entries,
738 	};
739 	int ret;
740 
741 	ret = parse_events__scanner(str, &data, PE_START_EVENTS);
742 	if (!ret) {
743 		int entries = data.idx - evlist->nr_entries;
744 		perf_evlist__splice_list_tail(evlist, &data.list, entries);
745 		return 0;
746 	}
747 
748 	/*
749 	 * There are 2 users - builtin-record and builtin-test objects.
750 	 * Both call perf_evlist__delete in case of error, so we dont
751 	 * need to bother.
752 	 */
753 	fprintf(stderr, "invalid or unsupported event: '%s'\n", str);
754 	fprintf(stderr, "Run 'perf list' for a list of valid events\n");
755 	return ret;
756 }
757 
758 int parse_events_option(const struct option *opt, const char *str,
759 			int unset __used)
760 {
761 	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
762 	return parse_events(evlist, str, unset);
763 }
764 
765 int parse_filter(const struct option *opt, const char *str,
766 		 int unset __used)
767 {
768 	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
769 	struct perf_evsel *last = NULL;
770 
771 	if (evlist->nr_entries > 0)
772 		last = list_entry(evlist->entries.prev, struct perf_evsel, node);
773 
774 	if (last == NULL || last->attr.type != PERF_TYPE_TRACEPOINT) {
775 		fprintf(stderr,
776 			"-F option should follow a -e tracepoint option\n");
777 		return -1;
778 	}
779 
780 	last->filter = strdup(str);
781 	if (last->filter == NULL) {
782 		fprintf(stderr, "not enough memory to hold filter string\n");
783 		return -1;
784 	}
785 
786 	return 0;
787 }
788 
789 static const char * const event_type_descriptors[] = {
790 	"Hardware event",
791 	"Software event",
792 	"Tracepoint event",
793 	"Hardware cache event",
794 	"Raw hardware event descriptor",
795 	"Hardware breakpoint",
796 };
797 
798 /*
799  * Print the events from <debugfs_mount_point>/tracing/events
800  */
801 
802 void print_tracepoint_events(const char *subsys_glob, const char *event_glob)
803 {
804 	DIR *sys_dir, *evt_dir;
805 	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
806 	char evt_path[MAXPATHLEN];
807 	char dir_path[MAXPATHLEN];
808 
809 	if (debugfs_valid_mountpoint(tracing_events_path))
810 		return;
811 
812 	sys_dir = opendir(tracing_events_path);
813 	if (!sys_dir)
814 		return;
815 
816 	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
817 		if (subsys_glob != NULL &&
818 		    !strglobmatch(sys_dirent.d_name, subsys_glob))
819 			continue;
820 
821 		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
822 			 sys_dirent.d_name);
823 		evt_dir = opendir(dir_path);
824 		if (!evt_dir)
825 			continue;
826 
827 		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
828 			if (event_glob != NULL &&
829 			    !strglobmatch(evt_dirent.d_name, event_glob))
830 				continue;
831 
832 			snprintf(evt_path, MAXPATHLEN, "%s:%s",
833 				 sys_dirent.d_name, evt_dirent.d_name);
834 			printf("  %-50s [%s]\n", evt_path,
835 				event_type_descriptors[PERF_TYPE_TRACEPOINT]);
836 		}
837 		closedir(evt_dir);
838 	}
839 	closedir(sys_dir);
840 }
841 
842 /*
843  * Check whether event is in <debugfs_mount_point>/tracing/events
844  */
845 
846 int is_valid_tracepoint(const char *event_string)
847 {
848 	DIR *sys_dir, *evt_dir;
849 	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
850 	char evt_path[MAXPATHLEN];
851 	char dir_path[MAXPATHLEN];
852 
853 	if (debugfs_valid_mountpoint(tracing_events_path))
854 		return 0;
855 
856 	sys_dir = opendir(tracing_events_path);
857 	if (!sys_dir)
858 		return 0;
859 
860 	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
861 
862 		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
863 			 sys_dirent.d_name);
864 		evt_dir = opendir(dir_path);
865 		if (!evt_dir)
866 			continue;
867 
868 		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
869 			snprintf(evt_path, MAXPATHLEN, "%s:%s",
870 				 sys_dirent.d_name, evt_dirent.d_name);
871 			if (!strcmp(evt_path, event_string)) {
872 				closedir(evt_dir);
873 				closedir(sys_dir);
874 				return 1;
875 			}
876 		}
877 		closedir(evt_dir);
878 	}
879 	closedir(sys_dir);
880 	return 0;
881 }
882 
883 static void __print_events_type(u8 type, struct event_symbol *syms,
884 				unsigned max)
885 {
886 	char name[64];
887 	unsigned i;
888 
889 	for (i = 0; i < max ; i++, syms++) {
890 		if (strlen(syms->alias))
891 			snprintf(name, sizeof(name),  "%s OR %s",
892 				 syms->symbol, syms->alias);
893 		else
894 			snprintf(name, sizeof(name), "%s", syms->symbol);
895 
896 		printf("  %-50s [%s]\n", name,
897 			event_type_descriptors[type]);
898 	}
899 }
900 
901 void print_events_type(u8 type)
902 {
903 	if (type == PERF_TYPE_SOFTWARE)
904 		__print_events_type(type, event_symbols_sw, PERF_COUNT_SW_MAX);
905 	else
906 		__print_events_type(type, event_symbols_hw, PERF_COUNT_HW_MAX);
907 }
908 
909 int print_hwcache_events(const char *event_glob)
910 {
911 	unsigned int type, op, i, printed = 0;
912 	char name[64];
913 
914 	for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
915 		for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
916 			/* skip invalid cache type */
917 			if (!perf_evsel__is_cache_op_valid(type, op))
918 				continue;
919 
920 			for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
921 				__perf_evsel__hw_cache_type_op_res_name(type, op, i,
922 									name, sizeof(name));
923 				if (event_glob != NULL && !strglobmatch(name, event_glob))
924 					continue;
925 
926 				printf("  %-50s [%s]\n", name,
927 					event_type_descriptors[PERF_TYPE_HW_CACHE]);
928 				++printed;
929 			}
930 		}
931 	}
932 
933 	return printed;
934 }
935 
936 static void print_symbol_events(const char *event_glob, unsigned type,
937 				struct event_symbol *syms, unsigned max)
938 {
939 	unsigned i, printed = 0;
940 	char name[MAX_NAME_LEN];
941 
942 	for (i = 0; i < max; i++, syms++) {
943 
944 		if (event_glob != NULL &&
945 		    !(strglobmatch(syms->symbol, event_glob) ||
946 		      (syms->alias && strglobmatch(syms->alias, event_glob))))
947 			continue;
948 
949 		if (strlen(syms->alias))
950 			snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
951 		else
952 			strncpy(name, syms->symbol, MAX_NAME_LEN);
953 
954 		printf("  %-50s [%s]\n", name, event_type_descriptors[type]);
955 
956 		printed++;
957 	}
958 
959 	if (printed)
960 		printf("\n");
961 }
962 
963 /*
964  * Print the help text for the event symbols:
965  */
966 void print_events(const char *event_glob)
967 {
968 
969 	printf("\n");
970 	printf("List of pre-defined events (to be used in -e):\n");
971 
972 	print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
973 			    event_symbols_hw, PERF_COUNT_HW_MAX);
974 
975 	print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
976 			    event_symbols_sw, PERF_COUNT_SW_MAX);
977 
978 	print_hwcache_events(event_glob);
979 
980 	if (event_glob != NULL)
981 		return;
982 
983 	printf("\n");
984 	printf("  %-50s [%s]\n",
985 	       "rNNN",
986 	       event_type_descriptors[PERF_TYPE_RAW]);
987 	printf("  %-50s [%s]\n",
988 	       "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
989 	       event_type_descriptors[PERF_TYPE_RAW]);
990 	printf("   (see 'perf list --help' on how to encode it)\n");
991 	printf("\n");
992 
993 	printf("  %-50s [%s]\n",
994 			"mem:<addr>[:access]",
995 			event_type_descriptors[PERF_TYPE_BREAKPOINT]);
996 	printf("\n");
997 
998 	print_tracepoint_events(NULL, NULL);
999 }
1000 
1001 int parse_events__is_hardcoded_term(struct parse_events__term *term)
1002 {
1003 	return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
1004 }
1005 
1006 static int new_term(struct parse_events__term **_term, int type_val,
1007 		    int type_term, char *config,
1008 		    char *str, long num)
1009 {
1010 	struct parse_events__term *term;
1011 
1012 	term = zalloc(sizeof(*term));
1013 	if (!term)
1014 		return -ENOMEM;
1015 
1016 	INIT_LIST_HEAD(&term->list);
1017 	term->type_val  = type_val;
1018 	term->type_term = type_term;
1019 	term->config = config;
1020 
1021 	switch (type_val) {
1022 	case PARSE_EVENTS__TERM_TYPE_NUM:
1023 		term->val.num = num;
1024 		break;
1025 	case PARSE_EVENTS__TERM_TYPE_STR:
1026 		term->val.str = str;
1027 		break;
1028 	default:
1029 		return -EINVAL;
1030 	}
1031 
1032 	*_term = term;
1033 	return 0;
1034 }
1035 
1036 int parse_events__term_num(struct parse_events__term **term,
1037 			   int type_term, char *config, long num)
1038 {
1039 	return new_term(term, PARSE_EVENTS__TERM_TYPE_NUM, type_term,
1040 			config, NULL, num);
1041 }
1042 
1043 int parse_events__term_str(struct parse_events__term **term,
1044 			   int type_term, char *config, char *str)
1045 {
1046 	return new_term(term, PARSE_EVENTS__TERM_TYPE_STR, type_term,
1047 			config, str, 0);
1048 }
1049 
1050 int parse_events__term_clone(struct parse_events__term **new,
1051 			     struct parse_events__term *term)
1052 {
1053 	return new_term(new, term->type_val, term->type_term, term->config,
1054 			term->val.str, term->val.num);
1055 }
1056 
1057 void parse_events__free_terms(struct list_head *terms)
1058 {
1059 	struct parse_events__term *term, *h;
1060 
1061 	list_for_each_entry_safe(term, h, terms, list)
1062 		free(term);
1063 
1064 	free(terms);
1065 }
1066