xref: /openbmc/linux/tools/perf/util/pmu.c (revision d457c963)
1 #include <linux/list.h>
2 #include <linux/compiler.h>
3 #include <sys/types.h>
4 #include <unistd.h>
5 #include <stdio.h>
6 #include <stdbool.h>
7 #include <stdarg.h>
8 #include <dirent.h>
9 #include <api/fs/fs.h>
10 #include <locale.h>
11 #include "util.h"
12 #include "pmu.h"
13 #include "parse-events.h"
14 #include "cpumap.h"
15 
16 struct perf_pmu_format {
17 	char *name;
18 	int value;
19 	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
20 	struct list_head list;
21 };
22 
23 #define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"
24 
25 int perf_pmu_parse(struct list_head *list, char *name);
26 extern FILE *perf_pmu_in;
27 
28 static LIST_HEAD(pmus);
29 
30 /*
31  * Parse & process all the sysfs attributes located under
32  * the directory specified in 'dir' parameter.
33  */
34 int perf_pmu__format_parse(char *dir, struct list_head *head)
35 {
36 	struct dirent *evt_ent;
37 	DIR *format_dir;
38 	int ret = 0;
39 
40 	format_dir = opendir(dir);
41 	if (!format_dir)
42 		return -EINVAL;
43 
44 	while (!ret && (evt_ent = readdir(format_dir))) {
45 		char path[PATH_MAX];
46 		char *name = evt_ent->d_name;
47 		FILE *file;
48 
49 		if (!strcmp(name, ".") || !strcmp(name, ".."))
50 			continue;
51 
52 		snprintf(path, PATH_MAX, "%s/%s", dir, name);
53 
54 		ret = -EINVAL;
55 		file = fopen(path, "r");
56 		if (!file)
57 			break;
58 
59 		perf_pmu_in = file;
60 		ret = perf_pmu_parse(head, name);
61 		fclose(file);
62 	}
63 
64 	closedir(format_dir);
65 	return ret;
66 }
67 
68 /*
69  * Reading/parsing the default pmu format definition, which should be
70  * located at:
71  * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
72  */
73 static int pmu_format(const char *name, struct list_head *format)
74 {
75 	struct stat st;
76 	char path[PATH_MAX];
77 	const char *sysfs = sysfs__mountpoint();
78 
79 	if (!sysfs)
80 		return -1;
81 
82 	snprintf(path, PATH_MAX,
83 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
84 
85 	if (stat(path, &st) < 0)
86 		return 0;	/* no error if format does not exist */
87 
88 	if (perf_pmu__format_parse(path, format))
89 		return -1;
90 
91 	return 0;
92 }
93 
94 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
95 {
96 	struct stat st;
97 	ssize_t sret;
98 	char scale[128];
99 	int fd, ret = -1;
100 	char path[PATH_MAX];
101 	const char *lc;
102 
103 	snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
104 
105 	fd = open(path, O_RDONLY);
106 	if (fd == -1)
107 		return -1;
108 
109 	if (fstat(fd, &st) < 0)
110 		goto error;
111 
112 	sret = read(fd, scale, sizeof(scale)-1);
113 	if (sret < 0)
114 		goto error;
115 
116 	if (scale[sret - 1] == '\n')
117 		scale[sret - 1] = '\0';
118 	else
119 		scale[sret] = '\0';
120 
121 	/*
122 	 * save current locale
123 	 */
124 	lc = setlocale(LC_NUMERIC, NULL);
125 
126 	/*
127 	 * force to C locale to ensure kernel
128 	 * scale string is converted correctly.
129 	 * kernel uses default C locale.
130 	 */
131 	setlocale(LC_NUMERIC, "C");
132 
133 	alias->scale = strtod(scale, NULL);
134 
135 	/* restore locale */
136 	setlocale(LC_NUMERIC, lc);
137 
138 	ret = 0;
139 error:
140 	close(fd);
141 	return ret;
142 }
143 
144 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
145 {
146 	char path[PATH_MAX];
147 	ssize_t sret;
148 	int fd;
149 
150 	snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
151 
152 	fd = open(path, O_RDONLY);
153 	if (fd == -1)
154 		return -1;
155 
156 		sret = read(fd, alias->unit, UNIT_MAX_LEN);
157 	if (sret < 0)
158 		goto error;
159 
160 	close(fd);
161 
162 	if (alias->unit[sret - 1] == '\n')
163 		alias->unit[sret - 1] = '\0';
164 	else
165 		alias->unit[sret] = '\0';
166 
167 	return 0;
168 error:
169 	close(fd);
170 	alias->unit[0] = '\0';
171 	return -1;
172 }
173 
174 static int
175 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
176 {
177 	char path[PATH_MAX];
178 	int fd;
179 
180 	snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
181 
182 	fd = open(path, O_RDONLY);
183 	if (fd == -1)
184 		return -1;
185 
186 	close(fd);
187 
188 	alias->per_pkg = true;
189 	return 0;
190 }
191 
192 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
193 				    char *dir, char *name)
194 {
195 	char path[PATH_MAX];
196 	int fd;
197 
198 	snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
199 
200 	fd = open(path, O_RDONLY);
201 	if (fd == -1)
202 		return -1;
203 
204 	alias->snapshot = true;
205 	close(fd);
206 	return 0;
207 }
208 
209 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
210 				 char *desc __maybe_unused, char *val)
211 {
212 	struct perf_pmu_alias *alias;
213 	int ret;
214 
215 	alias = malloc(sizeof(*alias));
216 	if (!alias)
217 		return -ENOMEM;
218 
219 	INIT_LIST_HEAD(&alias->terms);
220 	alias->scale = 1.0;
221 	alias->unit[0] = '\0';
222 	alias->per_pkg = false;
223 
224 	ret = parse_events_terms(&alias->terms, val);
225 	if (ret) {
226 		pr_err("Cannot parse alias %s: %d\n", val, ret);
227 		free(alias);
228 		return ret;
229 	}
230 
231 	alias->name = strdup(name);
232 	if (dir) {
233 		/*
234 		 * load unit name and scale if available
235 		 */
236 		perf_pmu__parse_unit(alias, dir, name);
237 		perf_pmu__parse_scale(alias, dir, name);
238 		perf_pmu__parse_per_pkg(alias, dir, name);
239 		perf_pmu__parse_snapshot(alias, dir, name);
240 	}
241 
242 	list_add_tail(&alias->list, list);
243 
244 	return 0;
245 }
246 
247 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
248 {
249 	char buf[256];
250 	int ret;
251 
252 	ret = fread(buf, 1, sizeof(buf), file);
253 	if (ret == 0)
254 		return -EINVAL;
255 
256 	buf[ret] = 0;
257 
258 	return __perf_pmu__new_alias(list, dir, name, NULL, buf);
259 }
260 
261 static inline bool pmu_alias_info_file(char *name)
262 {
263 	size_t len;
264 
265 	len = strlen(name);
266 	if (len > 5 && !strcmp(name + len - 5, ".unit"))
267 		return true;
268 	if (len > 6 && !strcmp(name + len - 6, ".scale"))
269 		return true;
270 	if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
271 		return true;
272 	if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
273 		return true;
274 
275 	return false;
276 }
277 
278 /*
279  * Process all the sysfs attributes located under the directory
280  * specified in 'dir' parameter.
281  */
282 static int pmu_aliases_parse(char *dir, struct list_head *head)
283 {
284 	struct dirent *evt_ent;
285 	DIR *event_dir;
286 	int ret = 0;
287 
288 	event_dir = opendir(dir);
289 	if (!event_dir)
290 		return -EINVAL;
291 
292 	while (!ret && (evt_ent = readdir(event_dir))) {
293 		char path[PATH_MAX];
294 		char *name = evt_ent->d_name;
295 		FILE *file;
296 
297 		if (!strcmp(name, ".") || !strcmp(name, ".."))
298 			continue;
299 
300 		/*
301 		 * skip info files parsed in perf_pmu__new_alias()
302 		 */
303 		if (pmu_alias_info_file(name))
304 			continue;
305 
306 		snprintf(path, PATH_MAX, "%s/%s", dir, name);
307 
308 		ret = -EINVAL;
309 		file = fopen(path, "r");
310 		if (!file)
311 			break;
312 
313 		ret = perf_pmu__new_alias(head, dir, name, file);
314 		fclose(file);
315 	}
316 
317 	closedir(event_dir);
318 	return ret;
319 }
320 
321 /*
322  * Reading the pmu event aliases definition, which should be located at:
323  * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
324  */
325 static int pmu_aliases(const char *name, struct list_head *head)
326 {
327 	struct stat st;
328 	char path[PATH_MAX];
329 	const char *sysfs = sysfs__mountpoint();
330 
331 	if (!sysfs)
332 		return -1;
333 
334 	snprintf(path, PATH_MAX,
335 		 "%s/bus/event_source/devices/%s/events", sysfs, name);
336 
337 	if (stat(path, &st) < 0)
338 		return 0;	 /* no error if 'events' does not exist */
339 
340 	if (pmu_aliases_parse(path, head))
341 		return -1;
342 
343 	return 0;
344 }
345 
346 static int pmu_alias_terms(struct perf_pmu_alias *alias,
347 			   struct list_head *terms)
348 {
349 	struct parse_events_term *term, *cloned;
350 	LIST_HEAD(list);
351 	int ret;
352 
353 	list_for_each_entry(term, &alias->terms, list) {
354 		ret = parse_events_term__clone(&cloned, term);
355 		if (ret) {
356 			parse_events__free_terms(&list);
357 			return ret;
358 		}
359 		list_add_tail(&cloned->list, &list);
360 	}
361 	list_splice(&list, terms);
362 	return 0;
363 }
364 
365 /*
366  * Reading/parsing the default pmu type value, which should be
367  * located at:
368  * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
369  */
370 static int pmu_type(const char *name, __u32 *type)
371 {
372 	struct stat st;
373 	char path[PATH_MAX];
374 	FILE *file;
375 	int ret = 0;
376 	const char *sysfs = sysfs__mountpoint();
377 
378 	if (!sysfs)
379 		return -1;
380 
381 	snprintf(path, PATH_MAX,
382 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
383 
384 	if (stat(path, &st) < 0)
385 		return -1;
386 
387 	file = fopen(path, "r");
388 	if (!file)
389 		return -EINVAL;
390 
391 	if (1 != fscanf(file, "%u", type))
392 		ret = -1;
393 
394 	fclose(file);
395 	return ret;
396 }
397 
398 /* Add all pmus in sysfs to pmu list: */
399 static void pmu_read_sysfs(void)
400 {
401 	char path[PATH_MAX];
402 	DIR *dir;
403 	struct dirent *dent;
404 	const char *sysfs = sysfs__mountpoint();
405 
406 	if (!sysfs)
407 		return;
408 
409 	snprintf(path, PATH_MAX,
410 		 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
411 
412 	dir = opendir(path);
413 	if (!dir)
414 		return;
415 
416 	while ((dent = readdir(dir))) {
417 		if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
418 			continue;
419 		/* add to static LIST_HEAD(pmus): */
420 		perf_pmu__find(dent->d_name);
421 	}
422 
423 	closedir(dir);
424 }
425 
426 static struct cpu_map *pmu_cpumask(const char *name)
427 {
428 	struct stat st;
429 	char path[PATH_MAX];
430 	FILE *file;
431 	struct cpu_map *cpus;
432 	const char *sysfs = sysfs__mountpoint();
433 
434 	if (!sysfs)
435 		return NULL;
436 
437 	snprintf(path, PATH_MAX,
438 		 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);
439 
440 	if (stat(path, &st) < 0)
441 		return NULL;
442 
443 	file = fopen(path, "r");
444 	if (!file)
445 		return NULL;
446 
447 	cpus = cpu_map__read(file);
448 	fclose(file);
449 	return cpus;
450 }
451 
452 struct perf_event_attr * __weak
453 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
454 {
455 	return NULL;
456 }
457 
458 static struct perf_pmu *pmu_lookup(const char *name)
459 {
460 	struct perf_pmu *pmu;
461 	LIST_HEAD(format);
462 	LIST_HEAD(aliases);
463 	__u32 type;
464 
465 	/* No support for intel_bts or intel_pt so disallow them */
466 	if (!strcmp(name, "intel_bts") || !strcmp(name, "intel_pt"))
467 		return NULL;
468 
469 	/*
470 	 * The pmu data we store & need consists of the pmu
471 	 * type value and format definitions. Load both right
472 	 * now.
473 	 */
474 	if (pmu_format(name, &format))
475 		return NULL;
476 
477 	if (pmu_aliases(name, &aliases))
478 		return NULL;
479 
480 	if (pmu_type(name, &type))
481 		return NULL;
482 
483 	pmu = zalloc(sizeof(*pmu));
484 	if (!pmu)
485 		return NULL;
486 
487 	pmu->cpus = pmu_cpumask(name);
488 
489 	INIT_LIST_HEAD(&pmu->format);
490 	INIT_LIST_HEAD(&pmu->aliases);
491 	list_splice(&format, &pmu->format);
492 	list_splice(&aliases, &pmu->aliases);
493 	pmu->name = strdup(name);
494 	pmu->type = type;
495 	list_add_tail(&pmu->list, &pmus);
496 
497 	pmu->default_config = perf_pmu__get_default_config(pmu);
498 
499 	return pmu;
500 }
501 
502 static struct perf_pmu *pmu_find(const char *name)
503 {
504 	struct perf_pmu *pmu;
505 
506 	list_for_each_entry(pmu, &pmus, list)
507 		if (!strcmp(pmu->name, name))
508 			return pmu;
509 
510 	return NULL;
511 }
512 
513 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
514 {
515 	/*
516 	 * pmu iterator: If pmu is NULL, we start at the begin,
517 	 * otherwise return the next pmu. Returns NULL on end.
518 	 */
519 	if (!pmu) {
520 		pmu_read_sysfs();
521 		pmu = list_prepare_entry(pmu, &pmus, list);
522 	}
523 	list_for_each_entry_continue(pmu, &pmus, list)
524 		return pmu;
525 	return NULL;
526 }
527 
528 struct perf_pmu *perf_pmu__find(const char *name)
529 {
530 	struct perf_pmu *pmu;
531 
532 	/*
533 	 * Once PMU is loaded it stays in the list,
534 	 * so we keep us from multiple reading/parsing
535 	 * the pmu format definitions.
536 	 */
537 	pmu = pmu_find(name);
538 	if (pmu)
539 		return pmu;
540 
541 	return pmu_lookup(name);
542 }
543 
544 static struct perf_pmu_format *
545 pmu_find_format(struct list_head *formats, const char *name)
546 {
547 	struct perf_pmu_format *format;
548 
549 	list_for_each_entry(format, formats, list)
550 		if (!strcmp(format->name, name))
551 			return format;
552 
553 	return NULL;
554 }
555 
556 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
557 {
558 	struct perf_pmu_format *format = pmu_find_format(formats, name);
559 	__u64 bits = 0;
560 	int fbit;
561 
562 	if (!format)
563 		return 0;
564 
565 	for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
566 		bits |= 1ULL << fbit;
567 
568 	return bits;
569 }
570 
571 /*
572  * Sets value based on the format definition (format parameter)
573  * and unformated value (value parameter).
574  */
575 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
576 			     bool zero)
577 {
578 	unsigned long fbit, vbit;
579 
580 	for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
581 
582 		if (!test_bit(fbit, format))
583 			continue;
584 
585 		if (value & (1llu << vbit++))
586 			*v |= (1llu << fbit);
587 		else if (zero)
588 			*v &= ~(1llu << fbit);
589 	}
590 }
591 
592 static __u64 pmu_format_max_value(const unsigned long *format)
593 {
594 	int w;
595 
596 	w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
597 	if (!w)
598 		return 0;
599 	if (w < 64)
600 		return (1ULL << w) - 1;
601 	return -1;
602 }
603 
604 /*
605  * Term is a string term, and might be a param-term. Try to look up it's value
606  * in the remaining terms.
607  * - We have a term like "base-or-format-term=param-term",
608  * - We need to find the value supplied for "param-term" (with param-term named
609  *   in a config string) later on in the term list.
610  */
611 static int pmu_resolve_param_term(struct parse_events_term *term,
612 				  struct list_head *head_terms,
613 				  __u64 *value)
614 {
615 	struct parse_events_term *t;
616 
617 	list_for_each_entry(t, head_terms, list) {
618 		if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
619 			if (!strcmp(t->config, term->config)) {
620 				t->used = true;
621 				*value = t->val.num;
622 				return 0;
623 			}
624 		}
625 	}
626 
627 	if (verbose)
628 		printf("Required parameter '%s' not specified\n", term->config);
629 
630 	return -1;
631 }
632 
633 static char *formats_error_string(struct list_head *formats)
634 {
635 	struct perf_pmu_format *format;
636 	char *err, *str;
637 	static const char *static_terms = "config,config1,config2,name,"
638 					  "period,freq,branch_type,time,"
639 					  "call-graph,stack-size\n";
640 	unsigned i = 0;
641 
642 	if (!asprintf(&str, "valid terms:"))
643 		return NULL;
644 
645 	/* sysfs exported terms */
646 	list_for_each_entry(format, formats, list) {
647 		char c = i++ ? ',' : ' ';
648 
649 		err = str;
650 		if (!asprintf(&str, "%s%c%s", err, c, format->name))
651 			goto fail;
652 		free(err);
653 	}
654 
655 	/* static terms */
656 	err = str;
657 	if (!asprintf(&str, "%s,%s", err, static_terms))
658 		goto fail;
659 
660 	free(err);
661 	return str;
662 fail:
663 	free(err);
664 	return NULL;
665 }
666 
667 /*
668  * Setup one of config[12] attr members based on the
669  * user input data - term parameter.
670  */
671 static int pmu_config_term(struct list_head *formats,
672 			   struct perf_event_attr *attr,
673 			   struct parse_events_term *term,
674 			   struct list_head *head_terms,
675 			   bool zero, struct parse_events_error *err)
676 {
677 	struct perf_pmu_format *format;
678 	__u64 *vp;
679 	__u64 val, max_val;
680 
681 	/*
682 	 * If this is a parameter we've already used for parameterized-eval,
683 	 * skip it in normal eval.
684 	 */
685 	if (term->used)
686 		return 0;
687 
688 	/*
689 	 * Hardcoded terms should be already in, so nothing
690 	 * to be done for them.
691 	 */
692 	if (parse_events__is_hardcoded_term(term))
693 		return 0;
694 
695 	format = pmu_find_format(formats, term->config);
696 	if (!format) {
697 		if (verbose)
698 			printf("Invalid event/parameter '%s'\n", term->config);
699 		if (err) {
700 			err->idx  = term->err_term;
701 			err->str  = strdup("unknown term");
702 			err->help = formats_error_string(formats);
703 		}
704 		return -EINVAL;
705 	}
706 
707 	switch (format->value) {
708 	case PERF_PMU_FORMAT_VALUE_CONFIG:
709 		vp = &attr->config;
710 		break;
711 	case PERF_PMU_FORMAT_VALUE_CONFIG1:
712 		vp = &attr->config1;
713 		break;
714 	case PERF_PMU_FORMAT_VALUE_CONFIG2:
715 		vp = &attr->config2;
716 		break;
717 	default:
718 		return -EINVAL;
719 	}
720 
721 	/*
722 	 * Either directly use a numeric term, or try to translate string terms
723 	 * using event parameters.
724 	 */
725 	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
726 		val = term->val.num;
727 	else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
728 		if (strcmp(term->val.str, "?")) {
729 			if (verbose) {
730 				pr_info("Invalid sysfs entry %s=%s\n",
731 						term->config, term->val.str);
732 			}
733 			if (err) {
734 				err->idx = term->err_val;
735 				err->str = strdup("expected numeric value");
736 			}
737 			return -EINVAL;
738 		}
739 
740 		if (pmu_resolve_param_term(term, head_terms, &val))
741 			return -EINVAL;
742 	} else
743 		return -EINVAL;
744 
745 	max_val = pmu_format_max_value(format->bits);
746 	if (val > max_val) {
747 		if (err) {
748 			err->idx = term->err_val;
749 			if (asprintf(&err->str,
750 				     "value too big for format, maximum is %llu",
751 				     (unsigned long long)max_val) < 0)
752 				err->str = strdup("value too big for format");
753 			return -EINVAL;
754 		}
755 		/*
756 		 * Assume we don't care if !err, in which case the value will be
757 		 * silently truncated.
758 		 */
759 	}
760 
761 	pmu_format_value(format->bits, val, vp, zero);
762 	return 0;
763 }
764 
765 int perf_pmu__config_terms(struct list_head *formats,
766 			   struct perf_event_attr *attr,
767 			   struct list_head *head_terms,
768 			   bool zero, struct parse_events_error *err)
769 {
770 	struct parse_events_term *term;
771 
772 	list_for_each_entry(term, head_terms, list) {
773 		if (pmu_config_term(formats, attr, term, head_terms,
774 				    zero, err))
775 			return -EINVAL;
776 	}
777 
778 	return 0;
779 }
780 
781 /*
782  * Configures event's 'attr' parameter based on the:
783  * 1) users input - specified in terms parameter
784  * 2) pmu format definitions - specified by pmu parameter
785  */
786 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
787 		     struct list_head *head_terms,
788 		     struct parse_events_error *err)
789 {
790 	bool zero = !!pmu->default_config;
791 
792 	attr->type = pmu->type;
793 	return perf_pmu__config_terms(&pmu->format, attr, head_terms,
794 				      zero, err);
795 }
796 
797 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
798 					     struct parse_events_term *term)
799 {
800 	struct perf_pmu_alias *alias;
801 	char *name;
802 
803 	if (parse_events__is_hardcoded_term(term))
804 		return NULL;
805 
806 	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
807 		if (term->val.num != 1)
808 			return NULL;
809 		if (pmu_find_format(&pmu->format, term->config))
810 			return NULL;
811 		name = term->config;
812 	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
813 		if (strcasecmp(term->config, "event"))
814 			return NULL;
815 		name = term->val.str;
816 	} else {
817 		return NULL;
818 	}
819 
820 	list_for_each_entry(alias, &pmu->aliases, list) {
821 		if (!strcasecmp(alias->name, name))
822 			return alias;
823 	}
824 	return NULL;
825 }
826 
827 
828 static int check_info_data(struct perf_pmu_alias *alias,
829 			   struct perf_pmu_info *info)
830 {
831 	/*
832 	 * Only one term in event definition can
833 	 * define unit, scale and snapshot, fail
834 	 * if there's more than one.
835 	 */
836 	if ((info->unit && alias->unit) ||
837 	    (info->scale && alias->scale) ||
838 	    (info->snapshot && alias->snapshot))
839 		return -EINVAL;
840 
841 	if (alias->unit)
842 		info->unit = alias->unit;
843 
844 	if (alias->scale)
845 		info->scale = alias->scale;
846 
847 	if (alias->snapshot)
848 		info->snapshot = alias->snapshot;
849 
850 	return 0;
851 }
852 
853 /*
854  * Find alias in the terms list and replace it with the terms
855  * defined for the alias
856  */
857 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
858 			  struct perf_pmu_info *info)
859 {
860 	struct parse_events_term *term, *h;
861 	struct perf_pmu_alias *alias;
862 	int ret;
863 
864 	info->per_pkg = false;
865 
866 	/*
867 	 * Mark unit and scale as not set
868 	 * (different from default values, see below)
869 	 */
870 	info->unit     = NULL;
871 	info->scale    = 0.0;
872 	info->snapshot = false;
873 
874 	list_for_each_entry_safe(term, h, head_terms, list) {
875 		alias = pmu_find_alias(pmu, term);
876 		if (!alias)
877 			continue;
878 		ret = pmu_alias_terms(alias, &term->list);
879 		if (ret)
880 			return ret;
881 
882 		ret = check_info_data(alias, info);
883 		if (ret)
884 			return ret;
885 
886 		if (alias->per_pkg)
887 			info->per_pkg = true;
888 
889 		list_del(&term->list);
890 		free(term);
891 	}
892 
893 	/*
894 	 * if no unit or scale foundin aliases, then
895 	 * set defaults as for evsel
896 	 * unit cannot left to NULL
897 	 */
898 	if (info->unit == NULL)
899 		info->unit   = "";
900 
901 	if (info->scale == 0.0)
902 		info->scale  = 1.0;
903 
904 	return 0;
905 }
906 
907 int perf_pmu__new_format(struct list_head *list, char *name,
908 			 int config, unsigned long *bits)
909 {
910 	struct perf_pmu_format *format;
911 
912 	format = zalloc(sizeof(*format));
913 	if (!format)
914 		return -ENOMEM;
915 
916 	format->name = strdup(name);
917 	format->value = config;
918 	memcpy(format->bits, bits, sizeof(format->bits));
919 
920 	list_add_tail(&format->list, list);
921 	return 0;
922 }
923 
924 void perf_pmu__set_format(unsigned long *bits, long from, long to)
925 {
926 	long b;
927 
928 	if (!to)
929 		to = from;
930 
931 	memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
932 	for (b = from; b <= to; b++)
933 		set_bit(b, bits);
934 }
935 
936 static int sub_non_neg(int a, int b)
937 {
938 	if (b > a)
939 		return 0;
940 	return a - b;
941 }
942 
943 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
944 			  struct perf_pmu_alias *alias)
945 {
946 	struct parse_events_term *term;
947 	int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
948 
949 	list_for_each_entry(term, &alias->terms, list) {
950 		if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
951 			used += snprintf(buf + used, sub_non_neg(len, used),
952 					",%s=%s", term->config,
953 					term->val.str);
954 	}
955 
956 	if (sub_non_neg(len, used) > 0) {
957 		buf[used] = '/';
958 		used++;
959 	}
960 	if (sub_non_neg(len, used) > 0) {
961 		buf[used] = '\0';
962 		used++;
963 	} else
964 		buf[len - 1] = '\0';
965 
966 	return buf;
967 }
968 
969 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
970 			     struct perf_pmu_alias *alias)
971 {
972 	snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
973 	return buf;
974 }
975 
976 static int cmp_string(const void *a, const void *b)
977 {
978 	const char * const *as = a;
979 	const char * const *bs = b;
980 	return strcmp(*as, *bs);
981 }
982 
983 void print_pmu_events(const char *event_glob, bool name_only)
984 {
985 	struct perf_pmu *pmu;
986 	struct perf_pmu_alias *alias;
987 	char buf[1024];
988 	int printed = 0;
989 	int len, j;
990 	char **aliases;
991 
992 	pmu = NULL;
993 	len = 0;
994 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
995 		list_for_each_entry(alias, &pmu->aliases, list)
996 			len++;
997 		if (pmu->selectable)
998 			len++;
999 	}
1000 	aliases = zalloc(sizeof(char *) * len);
1001 	if (!aliases)
1002 		goto out_enomem;
1003 	pmu = NULL;
1004 	j = 0;
1005 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1006 		list_for_each_entry(alias, &pmu->aliases, list) {
1007 			char *name = format_alias(buf, sizeof(buf), pmu, alias);
1008 			bool is_cpu = !strcmp(pmu->name, "cpu");
1009 
1010 			if (event_glob != NULL &&
1011 			    !(strglobmatch(name, event_glob) ||
1012 			      (!is_cpu && strglobmatch(alias->name,
1013 						       event_glob))))
1014 				continue;
1015 
1016 			if (is_cpu && !name_only)
1017 				name = format_alias_or(buf, sizeof(buf), pmu, alias);
1018 
1019 			aliases[j] = strdup(name);
1020 			if (aliases[j] == NULL)
1021 				goto out_enomem;
1022 			j++;
1023 		}
1024 		if (pmu->selectable) {
1025 			char *s;
1026 			if (asprintf(&s, "%s//", pmu->name) < 0)
1027 				goto out_enomem;
1028 			aliases[j] = s;
1029 			j++;
1030 		}
1031 	}
1032 	len = j;
1033 	qsort(aliases, len, sizeof(char *), cmp_string);
1034 	for (j = 0; j < len; j++) {
1035 		if (name_only) {
1036 			printf("%s ", aliases[j]);
1037 			continue;
1038 		}
1039 		printf("  %-50s [Kernel PMU event]\n", aliases[j]);
1040 		printed++;
1041 	}
1042 	if (printed)
1043 		printf("\n");
1044 out_free:
1045 	for (j = 0; j < len; j++)
1046 		zfree(&aliases[j]);
1047 	zfree(&aliases);
1048 	return;
1049 
1050 out_enomem:
1051 	printf("FATAL: not enough memory to print PMU events\n");
1052 	if (aliases)
1053 		goto out_free;
1054 }
1055 
1056 bool pmu_have_event(const char *pname, const char *name)
1057 {
1058 	struct perf_pmu *pmu;
1059 	struct perf_pmu_alias *alias;
1060 
1061 	pmu = NULL;
1062 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1063 		if (strcmp(pname, pmu->name))
1064 			continue;
1065 		list_for_each_entry(alias, &pmu->aliases, list)
1066 			if (!strcmp(alias->name, name))
1067 				return true;
1068 	}
1069 	return false;
1070 }
1071 
1072 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1073 {
1074 	struct stat st;
1075 	char path[PATH_MAX];
1076 	const char *sysfs;
1077 
1078 	sysfs = sysfs__mountpoint();
1079 	if (!sysfs)
1080 		return NULL;
1081 
1082 	snprintf(path, PATH_MAX,
1083 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1084 
1085 	if (stat(path, &st) < 0)
1086 		return NULL;
1087 
1088 	return fopen(path, "r");
1089 }
1090 
1091 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1092 			...)
1093 {
1094 	va_list args;
1095 	FILE *file;
1096 	int ret = EOF;
1097 
1098 	va_start(args, fmt);
1099 	file = perf_pmu__open_file(pmu, name);
1100 	if (file) {
1101 		ret = vfscanf(file, fmt, args);
1102 		fclose(file);
1103 	}
1104 	va_end(args);
1105 	return ret;
1106 }
1107