xref: /openbmc/linux/tools/perf/util/pmu.c (revision 31e67366)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/list.h>
3 #include <linux/compiler.h>
4 #include <linux/string.h>
5 #include <linux/zalloc.h>
6 #include <subcmd/pager.h>
7 #include <sys/types.h>
8 #include <errno.h>
9 #include <fcntl.h>
10 #include <sys/stat.h>
11 #include <unistd.h>
12 #include <stdio.h>
13 #include <stdbool.h>
14 #include <stdarg.h>
15 #include <dirent.h>
16 #include <api/fs/fs.h>
17 #include <locale.h>
18 #include <regex.h>
19 #include <perf/cpumap.h>
20 #include "debug.h"
21 #include "evsel.h"
22 #include "pmu.h"
23 #include "parse-events.h"
24 #include "header.h"
25 #include "string2.h"
26 #include "strbuf.h"
27 #include "fncache.h"
28 
29 struct perf_pmu perf_pmu__fake;
30 
31 struct perf_pmu_format {
32 	char *name;
33 	int value;
34 	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
35 	struct list_head list;
36 };
37 
38 int perf_pmu_parse(struct list_head *list, char *name);
39 extern FILE *perf_pmu_in;
40 
41 static LIST_HEAD(pmus);
42 
43 /*
44  * Parse & process all the sysfs attributes located under
45  * the directory specified in 'dir' parameter.
46  */
47 int perf_pmu__format_parse(char *dir, struct list_head *head)
48 {
49 	struct dirent *evt_ent;
50 	DIR *format_dir;
51 	int ret = 0;
52 
53 	format_dir = opendir(dir);
54 	if (!format_dir)
55 		return -EINVAL;
56 
57 	while (!ret && (evt_ent = readdir(format_dir))) {
58 		char path[PATH_MAX];
59 		char *name = evt_ent->d_name;
60 		FILE *file;
61 
62 		if (!strcmp(name, ".") || !strcmp(name, ".."))
63 			continue;
64 
65 		snprintf(path, PATH_MAX, "%s/%s", dir, name);
66 
67 		ret = -EINVAL;
68 		file = fopen(path, "r");
69 		if (!file)
70 			break;
71 
72 		perf_pmu_in = file;
73 		ret = perf_pmu_parse(head, name);
74 		fclose(file);
75 	}
76 
77 	closedir(format_dir);
78 	return ret;
79 }
80 
81 /*
82  * Reading/parsing the default pmu format definition, which should be
83  * located at:
84  * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
85  */
86 static int pmu_format(const char *name, struct list_head *format)
87 {
88 	char path[PATH_MAX];
89 	const char *sysfs = sysfs__mountpoint();
90 
91 	if (!sysfs)
92 		return -1;
93 
94 	snprintf(path, PATH_MAX,
95 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
96 
97 	if (!file_available(path))
98 		return 0;
99 
100 	if (perf_pmu__format_parse(path, format))
101 		return -1;
102 
103 	return 0;
104 }
105 
106 int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
107 {
108 	char *lc;
109 	int ret = 0;
110 
111 	/*
112 	 * save current locale
113 	 */
114 	lc = setlocale(LC_NUMERIC, NULL);
115 
116 	/*
117 	 * The lc string may be allocated in static storage,
118 	 * so get a dynamic copy to make it survive setlocale
119 	 * call below.
120 	 */
121 	lc = strdup(lc);
122 	if (!lc) {
123 		ret = -ENOMEM;
124 		goto out;
125 	}
126 
127 	/*
128 	 * force to C locale to ensure kernel
129 	 * scale string is converted correctly.
130 	 * kernel uses default C locale.
131 	 */
132 	setlocale(LC_NUMERIC, "C");
133 
134 	*sval = strtod(scale, end);
135 
136 out:
137 	/* restore locale */
138 	setlocale(LC_NUMERIC, lc);
139 	free(lc);
140 	return ret;
141 }
142 
143 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
144 {
145 	struct stat st;
146 	ssize_t sret;
147 	char scale[128];
148 	int fd, ret = -1;
149 	char path[PATH_MAX];
150 
151 	scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
152 
153 	fd = open(path, O_RDONLY);
154 	if (fd == -1)
155 		return -1;
156 
157 	if (fstat(fd, &st) < 0)
158 		goto error;
159 
160 	sret = read(fd, scale, sizeof(scale)-1);
161 	if (sret < 0)
162 		goto error;
163 
164 	if (scale[sret - 1] == '\n')
165 		scale[sret - 1] = '\0';
166 	else
167 		scale[sret] = '\0';
168 
169 	ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
170 error:
171 	close(fd);
172 	return ret;
173 }
174 
175 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
176 {
177 	char path[PATH_MAX];
178 	ssize_t sret;
179 	int fd;
180 
181 	scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
182 
183 	fd = open(path, O_RDONLY);
184 	if (fd == -1)
185 		return -1;
186 
187 	sret = read(fd, alias->unit, UNIT_MAX_LEN);
188 	if (sret < 0)
189 		goto error;
190 
191 	close(fd);
192 
193 	if (alias->unit[sret - 1] == '\n')
194 		alias->unit[sret - 1] = '\0';
195 	else
196 		alias->unit[sret] = '\0';
197 
198 	return 0;
199 error:
200 	close(fd);
201 	alias->unit[0] = '\0';
202 	return -1;
203 }
204 
205 static int
206 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
207 {
208 	char path[PATH_MAX];
209 	int fd;
210 
211 	scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
212 
213 	fd = open(path, O_RDONLY);
214 	if (fd == -1)
215 		return -1;
216 
217 	close(fd);
218 
219 	alias->per_pkg = true;
220 	return 0;
221 }
222 
223 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
224 				    char *dir, char *name)
225 {
226 	char path[PATH_MAX];
227 	int fd;
228 
229 	scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
230 
231 	fd = open(path, O_RDONLY);
232 	if (fd == -1)
233 		return -1;
234 
235 	alias->snapshot = true;
236 	close(fd);
237 	return 0;
238 }
239 
240 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
241 				char **new_str)
242 {
243 	if (!*old_str)
244 		goto set_new;
245 
246 	if (*new_str) {	/* Have new string, check with old */
247 		if (strcasecmp(*old_str, *new_str))
248 			pr_debug("alias %s differs in field '%s'\n",
249 				 name, field);
250 		zfree(old_str);
251 	} else		/* Nothing new --> keep old string */
252 		return;
253 set_new:
254 	*old_str = *new_str;
255 	*new_str = NULL;
256 }
257 
258 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
259 				  struct perf_pmu_alias *newalias)
260 {
261 	perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
262 	perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
263 			    &newalias->long_desc);
264 	perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
265 	perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
266 			    &newalias->metric_expr);
267 	perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
268 			    &newalias->metric_name);
269 	perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
270 	old->scale = newalias->scale;
271 	old->per_pkg = newalias->per_pkg;
272 	old->snapshot = newalias->snapshot;
273 	memcpy(old->unit, newalias->unit, sizeof(old->unit));
274 }
275 
276 /* Delete an alias entry. */
277 void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
278 {
279 	zfree(&newalias->name);
280 	zfree(&newalias->desc);
281 	zfree(&newalias->long_desc);
282 	zfree(&newalias->topic);
283 	zfree(&newalias->str);
284 	zfree(&newalias->metric_expr);
285 	zfree(&newalias->metric_name);
286 	parse_events_terms__purge(&newalias->terms);
287 	free(newalias);
288 }
289 
290 /* Merge an alias, search in alias list. If this name is already
291  * present merge both of them to combine all information.
292  */
293 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
294 				 struct list_head *alist)
295 {
296 	struct perf_pmu_alias *a;
297 
298 	list_for_each_entry(a, alist, list) {
299 		if (!strcasecmp(newalias->name, a->name)) {
300 			perf_pmu_update_alias(a, newalias);
301 			perf_pmu_free_alias(newalias);
302 			return true;
303 		}
304 	}
305 	return false;
306 }
307 
308 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
309 				 char *desc, char *val,
310 				 char *long_desc, char *topic,
311 				 char *unit, char *perpkg,
312 				 char *metric_expr,
313 				 char *metric_name,
314 				 char *deprecated)
315 {
316 	struct parse_events_term *term;
317 	struct perf_pmu_alias *alias;
318 	int ret;
319 	int num;
320 	char newval[256];
321 
322 	alias = malloc(sizeof(*alias));
323 	if (!alias)
324 		return -ENOMEM;
325 
326 	INIT_LIST_HEAD(&alias->terms);
327 	alias->scale = 1.0;
328 	alias->unit[0] = '\0';
329 	alias->per_pkg = false;
330 	alias->snapshot = false;
331 	alias->deprecated = false;
332 
333 	ret = parse_events_terms(&alias->terms, val);
334 	if (ret) {
335 		pr_err("Cannot parse alias %s: %d\n", val, ret);
336 		free(alias);
337 		return ret;
338 	}
339 
340 	/* Scan event and remove leading zeroes, spaces, newlines, some
341 	 * platforms have terms specified as
342 	 * event=0x0091 (read from files ../<PMU>/events/<FILE>
343 	 * and terms specified as event=0x91 (read from JSON files).
344 	 *
345 	 * Rebuild string to make alias->str member comparable.
346 	 */
347 	memset(newval, 0, sizeof(newval));
348 	ret = 0;
349 	list_for_each_entry(term, &alias->terms, list) {
350 		if (ret)
351 			ret += scnprintf(newval + ret, sizeof(newval) - ret,
352 					 ",");
353 		if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
354 			ret += scnprintf(newval + ret, sizeof(newval) - ret,
355 					 "%s=%#x", term->config, term->val.num);
356 		else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
357 			ret += scnprintf(newval + ret, sizeof(newval) - ret,
358 					 "%s=%s", term->config, term->val.str);
359 	}
360 
361 	alias->name = strdup(name);
362 	if (dir) {
363 		/*
364 		 * load unit name and scale if available
365 		 */
366 		perf_pmu__parse_unit(alias, dir, name);
367 		perf_pmu__parse_scale(alias, dir, name);
368 		perf_pmu__parse_per_pkg(alias, dir, name);
369 		perf_pmu__parse_snapshot(alias, dir, name);
370 	}
371 
372 	alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
373 	alias->metric_name = metric_name ? strdup(metric_name): NULL;
374 	alias->desc = desc ? strdup(desc) : NULL;
375 	alias->long_desc = long_desc ? strdup(long_desc) :
376 				desc ? strdup(desc) : NULL;
377 	alias->topic = topic ? strdup(topic) : NULL;
378 	if (unit) {
379 		if (perf_pmu__convert_scale(unit, &unit, &alias->scale) < 0)
380 			return -1;
381 		snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
382 	}
383 	alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
384 	alias->str = strdup(newval);
385 
386 	if (deprecated)
387 		alias->deprecated = true;
388 
389 	if (!perf_pmu_merge_alias(alias, list))
390 		list_add_tail(&alias->list, list);
391 
392 	return 0;
393 }
394 
395 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
396 {
397 	char buf[256];
398 	int ret;
399 
400 	ret = fread(buf, 1, sizeof(buf), file);
401 	if (ret == 0)
402 		return -EINVAL;
403 
404 	buf[ret] = 0;
405 
406 	/* Remove trailing newline from sysfs file */
407 	strim(buf);
408 
409 	return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, NULL,
410 				     NULL, NULL, NULL, NULL);
411 }
412 
413 static inline bool pmu_alias_info_file(char *name)
414 {
415 	size_t len;
416 
417 	len = strlen(name);
418 	if (len > 5 && !strcmp(name + len - 5, ".unit"))
419 		return true;
420 	if (len > 6 && !strcmp(name + len - 6, ".scale"))
421 		return true;
422 	if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
423 		return true;
424 	if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
425 		return true;
426 
427 	return false;
428 }
429 
430 /*
431  * Process all the sysfs attributes located under the directory
432  * specified in 'dir' parameter.
433  */
434 static int pmu_aliases_parse(char *dir, struct list_head *head)
435 {
436 	struct dirent *evt_ent;
437 	DIR *event_dir;
438 
439 	event_dir = opendir(dir);
440 	if (!event_dir)
441 		return -EINVAL;
442 
443 	while ((evt_ent = readdir(event_dir))) {
444 		char path[PATH_MAX];
445 		char *name = evt_ent->d_name;
446 		FILE *file;
447 
448 		if (!strcmp(name, ".") || !strcmp(name, ".."))
449 			continue;
450 
451 		/*
452 		 * skip info files parsed in perf_pmu__new_alias()
453 		 */
454 		if (pmu_alias_info_file(name))
455 			continue;
456 
457 		scnprintf(path, PATH_MAX, "%s/%s", dir, name);
458 
459 		file = fopen(path, "r");
460 		if (!file) {
461 			pr_debug("Cannot open %s\n", path);
462 			continue;
463 		}
464 
465 		if (perf_pmu__new_alias(head, dir, name, file) < 0)
466 			pr_debug("Cannot set up %s\n", name);
467 		fclose(file);
468 	}
469 
470 	closedir(event_dir);
471 	return 0;
472 }
473 
474 /*
475  * Reading the pmu event aliases definition, which should be located at:
476  * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
477  */
478 static int pmu_aliases(const char *name, struct list_head *head)
479 {
480 	char path[PATH_MAX];
481 	const char *sysfs = sysfs__mountpoint();
482 
483 	if (!sysfs)
484 		return -1;
485 
486 	snprintf(path, PATH_MAX,
487 		 "%s/bus/event_source/devices/%s/events", sysfs, name);
488 
489 	if (!file_available(path))
490 		return 0;
491 
492 	if (pmu_aliases_parse(path, head))
493 		return -1;
494 
495 	return 0;
496 }
497 
498 static int pmu_alias_terms(struct perf_pmu_alias *alias,
499 			   struct list_head *terms)
500 {
501 	struct parse_events_term *term, *cloned;
502 	LIST_HEAD(list);
503 	int ret;
504 
505 	list_for_each_entry(term, &alias->terms, list) {
506 		ret = parse_events_term__clone(&cloned, term);
507 		if (ret) {
508 			parse_events_terms__purge(&list);
509 			return ret;
510 		}
511 		/*
512 		 * Weak terms don't override command line options,
513 		 * which we don't want for implicit terms in aliases.
514 		 */
515 		cloned->weak = true;
516 		list_add_tail(&cloned->list, &list);
517 	}
518 	list_splice(&list, terms);
519 	return 0;
520 }
521 
522 /*
523  * Reading/parsing the default pmu type value, which should be
524  * located at:
525  * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
526  */
527 static int pmu_type(const char *name, __u32 *type)
528 {
529 	char path[PATH_MAX];
530 	FILE *file;
531 	int ret = 0;
532 	const char *sysfs = sysfs__mountpoint();
533 
534 	if (!sysfs)
535 		return -1;
536 
537 	snprintf(path, PATH_MAX,
538 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
539 
540 	if (access(path, R_OK) < 0)
541 		return -1;
542 
543 	file = fopen(path, "r");
544 	if (!file)
545 		return -EINVAL;
546 
547 	if (1 != fscanf(file, "%u", type))
548 		ret = -1;
549 
550 	fclose(file);
551 	return ret;
552 }
553 
554 /* Add all pmus in sysfs to pmu list: */
555 static void pmu_read_sysfs(void)
556 {
557 	char path[PATH_MAX];
558 	DIR *dir;
559 	struct dirent *dent;
560 	const char *sysfs = sysfs__mountpoint();
561 
562 	if (!sysfs)
563 		return;
564 
565 	snprintf(path, PATH_MAX,
566 		 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
567 
568 	dir = opendir(path);
569 	if (!dir)
570 		return;
571 
572 	while ((dent = readdir(dir))) {
573 		if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
574 			continue;
575 		/* add to static LIST_HEAD(pmus): */
576 		perf_pmu__find(dent->d_name);
577 	}
578 
579 	closedir(dir);
580 }
581 
582 static struct perf_cpu_map *__pmu_cpumask(const char *path)
583 {
584 	FILE *file;
585 	struct perf_cpu_map *cpus;
586 
587 	file = fopen(path, "r");
588 	if (!file)
589 		return NULL;
590 
591 	cpus = perf_cpu_map__read(file);
592 	fclose(file);
593 	return cpus;
594 }
595 
596 /*
597  * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
598  * may have a "cpus" file.
599  */
600 #define SYS_TEMPLATE_ID	"./bus/event_source/devices/%s/identifier"
601 #define CPUS_TEMPLATE_UNCORE	"%s/bus/event_source/devices/%s/cpumask"
602 #define CPUS_TEMPLATE_CPU	"%s/bus/event_source/devices/%s/cpus"
603 
604 static struct perf_cpu_map *pmu_cpumask(const char *name)
605 {
606 	char path[PATH_MAX];
607 	struct perf_cpu_map *cpus;
608 	const char *sysfs = sysfs__mountpoint();
609 	const char *templates[] = {
610 		CPUS_TEMPLATE_UNCORE,
611 		CPUS_TEMPLATE_CPU,
612 		NULL
613 	};
614 	const char **template;
615 
616 	if (!sysfs)
617 		return NULL;
618 
619 	for (template = templates; *template; template++) {
620 		snprintf(path, PATH_MAX, *template, sysfs, name);
621 		cpus = __pmu_cpumask(path);
622 		if (cpus)
623 			return cpus;
624 	}
625 
626 	return NULL;
627 }
628 
629 static bool pmu_is_uncore(const char *name)
630 {
631 	char path[PATH_MAX];
632 	const char *sysfs;
633 
634 	sysfs = sysfs__mountpoint();
635 	snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
636 	return file_available(path);
637 }
638 
639 static char *pmu_id(const char *name)
640 {
641 	char path[PATH_MAX], *str;
642 	size_t len;
643 
644 	snprintf(path, PATH_MAX, SYS_TEMPLATE_ID, name);
645 
646 	if (sysfs__read_str(path, &str, &len) < 0)
647 		return NULL;
648 
649 	str[len - 1] = 0; /* remove line feed */
650 
651 	return str;
652 }
653 
654 /*
655  *  PMU CORE devices have different name other than cpu in sysfs on some
656  *  platforms.
657  *  Looking for possible sysfs files to identify the arm core device.
658  */
659 static int is_arm_pmu_core(const char *name)
660 {
661 	char path[PATH_MAX];
662 	const char *sysfs = sysfs__mountpoint();
663 
664 	if (!sysfs)
665 		return 0;
666 
667 	/* Look for cpu sysfs (specific to arm) */
668 	scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
669 				sysfs, name);
670 	return file_available(path);
671 }
672 
673 static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
674 {
675 	char *cpuid;
676 	static bool printed;
677 
678 	cpuid = getenv("PERF_CPUID");
679 	if (cpuid)
680 		cpuid = strdup(cpuid);
681 	if (!cpuid)
682 		cpuid = get_cpuid_str(pmu);
683 	if (!cpuid)
684 		return NULL;
685 
686 	if (!printed) {
687 		pr_debug("Using CPUID %s\n", cpuid);
688 		printed = true;
689 	}
690 	return cpuid;
691 }
692 
693 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
694 {
695 	struct pmu_events_map *map;
696 	char *cpuid = perf_pmu__getcpuid(pmu);
697 	int i;
698 
699 	/* on some platforms which uses cpus map, cpuid can be NULL for
700 	 * PMUs other than CORE PMUs.
701 	 */
702 	if (!cpuid)
703 		return NULL;
704 
705 	i = 0;
706 	for (;;) {
707 		map = &pmu_events_map[i++];
708 		if (!map->table) {
709 			map = NULL;
710 			break;
711 		}
712 
713 		if (!strcmp_cpuid_str(map->cpuid, cpuid))
714 			break;
715 	}
716 	free(cpuid);
717 	return map;
718 }
719 
720 bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
721 {
722 	char *tmp = NULL, *tok, *str;
723 	bool res;
724 
725 	str = strdup(pmu_name);
726 	if (!str)
727 		return false;
728 
729 	/*
730 	 * uncore alias may be from different PMU with common prefix
731 	 */
732 	tok = strtok_r(str, ",", &tmp);
733 	if (strncmp(pmu_name, tok, strlen(tok))) {
734 		res = false;
735 		goto out;
736 	}
737 
738 	/*
739 	 * Match more complex aliases where the alias name is a comma-delimited
740 	 * list of tokens, orderly contained in the matching PMU name.
741 	 *
742 	 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
743 	 *	    match "socket" in "socketX_pmunameY" and then "pmuname" in
744 	 *	    "pmunameY".
745 	 */
746 	for (; tok; name += strlen(tok), tok = strtok_r(NULL, ",", &tmp)) {
747 		name = strstr(name, tok);
748 		if (!name) {
749 			res = false;
750 			goto out;
751 		}
752 	}
753 
754 	res = true;
755 out:
756 	free(str);
757 	return res;
758 }
759 
760 /*
761  * From the pmu_events_map, find the table of PMU events that corresponds
762  * to the current running CPU. Then, add all PMU events from that table
763  * as aliases.
764  */
765 void pmu_add_cpu_aliases_map(struct list_head *head, struct perf_pmu *pmu,
766 			     struct pmu_events_map *map)
767 {
768 	int i;
769 	const char *name = pmu->name;
770 	/*
771 	 * Found a matching PMU events table. Create aliases
772 	 */
773 	i = 0;
774 	while (1) {
775 		const char *cpu_name = is_arm_pmu_core(name) ? name : "cpu";
776 		struct pmu_event *pe = &map->table[i++];
777 		const char *pname = pe->pmu ? pe->pmu : cpu_name;
778 
779 		if (!pe->name) {
780 			if (pe->metric_group || pe->metric_name)
781 				continue;
782 			break;
783 		}
784 
785 		if (pmu_is_uncore(name) &&
786 		    pmu_uncore_alias_match(pname, name))
787 			goto new_alias;
788 
789 		if (strcmp(pname, name))
790 			continue;
791 
792 new_alias:
793 		/* need type casts to override 'const' */
794 		__perf_pmu__new_alias(head, NULL, (char *)pe->name,
795 				(char *)pe->desc, (char *)pe->event,
796 				(char *)pe->long_desc, (char *)pe->topic,
797 				(char *)pe->unit, (char *)pe->perpkg,
798 				(char *)pe->metric_expr,
799 				(char *)pe->metric_name,
800 				(char *)pe->deprecated);
801 	}
802 }
803 
804 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
805 {
806 	struct pmu_events_map *map;
807 
808 	map = perf_pmu__find_map(pmu);
809 	if (!map)
810 		return;
811 
812 	pmu_add_cpu_aliases_map(head, pmu, map);
813 }
814 
815 void pmu_for_each_sys_event(pmu_sys_event_iter_fn fn, void *data)
816 {
817 	int i = 0;
818 
819 	while (1) {
820 		struct pmu_sys_events *event_table;
821 		int j = 0;
822 
823 		event_table = &pmu_sys_event_tables[i++];
824 
825 		if (!event_table->table)
826 			break;
827 
828 		while (1) {
829 			struct pmu_event *pe = &event_table->table[j++];
830 			int ret;
831 
832 			if (!pe->name && !pe->metric_group && !pe->metric_name)
833 				break;
834 
835 			ret = fn(pe, data);
836 			if (ret)
837 				break;
838 		}
839 	}
840 }
841 
842 struct pmu_sys_event_iter_data {
843 	struct list_head *head;
844 	struct perf_pmu *pmu;
845 };
846 
847 static int pmu_add_sys_aliases_iter_fn(struct pmu_event *pe, void *data)
848 {
849 	struct pmu_sys_event_iter_data *idata = data;
850 	struct perf_pmu *pmu = idata->pmu;
851 
852 	if (!pe->name) {
853 		if (pe->metric_group || pe->metric_name)
854 			return 0;
855 		return -EINVAL;
856 	}
857 
858 	if (!pe->compat || !pe->pmu)
859 		return 0;
860 
861 	if (!strcmp(pmu->id, pe->compat) &&
862 	    pmu_uncore_alias_match(pe->pmu, pmu->name)) {
863 		__perf_pmu__new_alias(idata->head, NULL,
864 				      (char *)pe->name,
865 				      (char *)pe->desc,
866 				      (char *)pe->event,
867 				      (char *)pe->long_desc,
868 				      (char *)pe->topic,
869 				      (char *)pe->unit,
870 				      (char *)pe->perpkg,
871 				      (char *)pe->metric_expr,
872 				      (char *)pe->metric_name,
873 				      (char *)pe->deprecated);
874 	}
875 
876 	return 0;
877 }
878 
879 static void pmu_add_sys_aliases(struct list_head *head, struct perf_pmu *pmu)
880 {
881 	struct pmu_sys_event_iter_data idata = {
882 		.head = head,
883 		.pmu = pmu,
884 	};
885 
886 	if (!pmu->id)
887 		return;
888 
889 	pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, &idata);
890 }
891 
892 struct perf_event_attr * __weak
893 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
894 {
895 	return NULL;
896 }
897 
898 static int pmu_max_precise(const char *name)
899 {
900 	char path[PATH_MAX];
901 	int max_precise = -1;
902 
903 	scnprintf(path, PATH_MAX,
904 		 "bus/event_source/devices/%s/caps/max_precise",
905 		 name);
906 
907 	sysfs__read_int(path, &max_precise);
908 	return max_precise;
909 }
910 
911 static struct perf_pmu *pmu_lookup(const char *name)
912 {
913 	struct perf_pmu *pmu;
914 	LIST_HEAD(format);
915 	LIST_HEAD(aliases);
916 	__u32 type;
917 
918 	/*
919 	 * The pmu data we store & need consists of the pmu
920 	 * type value and format definitions. Load both right
921 	 * now.
922 	 */
923 	if (pmu_format(name, &format))
924 		return NULL;
925 
926 	/*
927 	 * Check the type first to avoid unnecessary work.
928 	 */
929 	if (pmu_type(name, &type))
930 		return NULL;
931 
932 	if (pmu_aliases(name, &aliases))
933 		return NULL;
934 
935 	pmu = zalloc(sizeof(*pmu));
936 	if (!pmu)
937 		return NULL;
938 
939 	pmu->cpus = pmu_cpumask(name);
940 	pmu->name = strdup(name);
941 	pmu->type = type;
942 	pmu->is_uncore = pmu_is_uncore(name);
943 	if (pmu->is_uncore)
944 		pmu->id = pmu_id(name);
945 	pmu->max_precise = pmu_max_precise(name);
946 	pmu_add_cpu_aliases(&aliases, pmu);
947 	pmu_add_sys_aliases(&aliases, pmu);
948 
949 	INIT_LIST_HEAD(&pmu->format);
950 	INIT_LIST_HEAD(&pmu->aliases);
951 	INIT_LIST_HEAD(&pmu->caps);
952 	list_splice(&format, &pmu->format);
953 	list_splice(&aliases, &pmu->aliases);
954 	list_add_tail(&pmu->list, &pmus);
955 
956 	pmu->default_config = perf_pmu__get_default_config(pmu);
957 
958 	return pmu;
959 }
960 
961 static struct perf_pmu *pmu_find(const char *name)
962 {
963 	struct perf_pmu *pmu;
964 
965 	list_for_each_entry(pmu, &pmus, list)
966 		if (!strcmp(pmu->name, name))
967 			return pmu;
968 
969 	return NULL;
970 }
971 
972 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
973 {
974 	struct perf_pmu *pmu;
975 
976 	list_for_each_entry(pmu, &pmus, list)
977 		if (pmu->type == type)
978 			return pmu;
979 
980 	return NULL;
981 }
982 
983 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
984 {
985 	/*
986 	 * pmu iterator: If pmu is NULL, we start at the begin,
987 	 * otherwise return the next pmu. Returns NULL on end.
988 	 */
989 	if (!pmu) {
990 		pmu_read_sysfs();
991 		pmu = list_prepare_entry(pmu, &pmus, list);
992 	}
993 	list_for_each_entry_continue(pmu, &pmus, list)
994 		return pmu;
995 	return NULL;
996 }
997 
998 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
999 {
1000 	struct perf_pmu *pmu = NULL;
1001 
1002 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1003 		if (pmu->type == evsel->core.attr.type)
1004 			break;
1005 	}
1006 
1007 	return pmu;
1008 }
1009 
1010 bool evsel__is_aux_event(struct evsel *evsel)
1011 {
1012 	struct perf_pmu *pmu = evsel__find_pmu(evsel);
1013 
1014 	return pmu && pmu->auxtrace;
1015 }
1016 
1017 struct perf_pmu *perf_pmu__find(const char *name)
1018 {
1019 	struct perf_pmu *pmu;
1020 
1021 	/*
1022 	 * Once PMU is loaded it stays in the list,
1023 	 * so we keep us from multiple reading/parsing
1024 	 * the pmu format definitions.
1025 	 */
1026 	pmu = pmu_find(name);
1027 	if (pmu)
1028 		return pmu;
1029 
1030 	return pmu_lookup(name);
1031 }
1032 
1033 static struct perf_pmu_format *
1034 pmu_find_format(struct list_head *formats, const char *name)
1035 {
1036 	struct perf_pmu_format *format;
1037 
1038 	list_for_each_entry(format, formats, list)
1039 		if (!strcmp(format->name, name))
1040 			return format;
1041 
1042 	return NULL;
1043 }
1044 
1045 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1046 {
1047 	struct perf_pmu_format *format = pmu_find_format(formats, name);
1048 	__u64 bits = 0;
1049 	int fbit;
1050 
1051 	if (!format)
1052 		return 0;
1053 
1054 	for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1055 		bits |= 1ULL << fbit;
1056 
1057 	return bits;
1058 }
1059 
1060 int perf_pmu__format_type(struct list_head *formats, const char *name)
1061 {
1062 	struct perf_pmu_format *format = pmu_find_format(formats, name);
1063 
1064 	if (!format)
1065 		return -1;
1066 
1067 	return format->value;
1068 }
1069 
1070 /*
1071  * Sets value based on the format definition (format parameter)
1072  * and unformated value (value parameter).
1073  */
1074 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1075 			     bool zero)
1076 {
1077 	unsigned long fbit, vbit;
1078 
1079 	for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1080 
1081 		if (!test_bit(fbit, format))
1082 			continue;
1083 
1084 		if (value & (1llu << vbit++))
1085 			*v |= (1llu << fbit);
1086 		else if (zero)
1087 			*v &= ~(1llu << fbit);
1088 	}
1089 }
1090 
1091 static __u64 pmu_format_max_value(const unsigned long *format)
1092 {
1093 	int w;
1094 
1095 	w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1096 	if (!w)
1097 		return 0;
1098 	if (w < 64)
1099 		return (1ULL << w) - 1;
1100 	return -1;
1101 }
1102 
1103 /*
1104  * Term is a string term, and might be a param-term. Try to look up it's value
1105  * in the remaining terms.
1106  * - We have a term like "base-or-format-term=param-term",
1107  * - We need to find the value supplied for "param-term" (with param-term named
1108  *   in a config string) later on in the term list.
1109  */
1110 static int pmu_resolve_param_term(struct parse_events_term *term,
1111 				  struct list_head *head_terms,
1112 				  __u64 *value)
1113 {
1114 	struct parse_events_term *t;
1115 
1116 	list_for_each_entry(t, head_terms, list) {
1117 		if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1118 		    t->config && !strcmp(t->config, term->config)) {
1119 			t->used = true;
1120 			*value = t->val.num;
1121 			return 0;
1122 		}
1123 	}
1124 
1125 	if (verbose > 0)
1126 		printf("Required parameter '%s' not specified\n", term->config);
1127 
1128 	return -1;
1129 }
1130 
1131 static char *pmu_formats_string(struct list_head *formats)
1132 {
1133 	struct perf_pmu_format *format;
1134 	char *str = NULL;
1135 	struct strbuf buf = STRBUF_INIT;
1136 	unsigned i = 0;
1137 
1138 	if (!formats)
1139 		return NULL;
1140 
1141 	/* sysfs exported terms */
1142 	list_for_each_entry(format, formats, list)
1143 		if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1144 			goto error;
1145 
1146 	str = strbuf_detach(&buf, NULL);
1147 error:
1148 	strbuf_release(&buf);
1149 
1150 	return str;
1151 }
1152 
1153 /*
1154  * Setup one of config[12] attr members based on the
1155  * user input data - term parameter.
1156  */
1157 static int pmu_config_term(const char *pmu_name,
1158 			   struct list_head *formats,
1159 			   struct perf_event_attr *attr,
1160 			   struct parse_events_term *term,
1161 			   struct list_head *head_terms,
1162 			   bool zero, struct parse_events_error *err)
1163 {
1164 	struct perf_pmu_format *format;
1165 	__u64 *vp;
1166 	__u64 val, max_val;
1167 
1168 	/*
1169 	 * If this is a parameter we've already used for parameterized-eval,
1170 	 * skip it in normal eval.
1171 	 */
1172 	if (term->used)
1173 		return 0;
1174 
1175 	/*
1176 	 * Hardcoded terms should be already in, so nothing
1177 	 * to be done for them.
1178 	 */
1179 	if (parse_events__is_hardcoded_term(term))
1180 		return 0;
1181 
1182 	format = pmu_find_format(formats, term->config);
1183 	if (!format) {
1184 		char *pmu_term = pmu_formats_string(formats);
1185 		char *unknown_term;
1186 		char *help_msg;
1187 
1188 		if (asprintf(&unknown_term,
1189 				"unknown term '%s' for pmu '%s'",
1190 				term->config, pmu_name) < 0)
1191 			unknown_term = NULL;
1192 		help_msg = parse_events_formats_error_string(pmu_term);
1193 		if (err) {
1194 			parse_events__handle_error(err, term->err_term,
1195 						   unknown_term,
1196 						   help_msg);
1197 		} else {
1198 			pr_debug("%s (%s)\n", unknown_term, help_msg);
1199 			free(unknown_term);
1200 		}
1201 		free(pmu_term);
1202 		return -EINVAL;
1203 	}
1204 
1205 	switch (format->value) {
1206 	case PERF_PMU_FORMAT_VALUE_CONFIG:
1207 		vp = &attr->config;
1208 		break;
1209 	case PERF_PMU_FORMAT_VALUE_CONFIG1:
1210 		vp = &attr->config1;
1211 		break;
1212 	case PERF_PMU_FORMAT_VALUE_CONFIG2:
1213 		vp = &attr->config2;
1214 		break;
1215 	default:
1216 		return -EINVAL;
1217 	}
1218 
1219 	/*
1220 	 * Either directly use a numeric term, or try to translate string terms
1221 	 * using event parameters.
1222 	 */
1223 	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1224 		if (term->no_value &&
1225 		    bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1226 			if (err) {
1227 				parse_events__handle_error(err, term->err_val,
1228 					   strdup("no value assigned for term"),
1229 					   NULL);
1230 			}
1231 			return -EINVAL;
1232 		}
1233 
1234 		val = term->val.num;
1235 	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1236 		if (strcmp(term->val.str, "?")) {
1237 			if (verbose > 0) {
1238 				pr_info("Invalid sysfs entry %s=%s\n",
1239 						term->config, term->val.str);
1240 			}
1241 			if (err) {
1242 				parse_events__handle_error(err, term->err_val,
1243 					strdup("expected numeric value"),
1244 					NULL);
1245 			}
1246 			return -EINVAL;
1247 		}
1248 
1249 		if (pmu_resolve_param_term(term, head_terms, &val))
1250 			return -EINVAL;
1251 	} else
1252 		return -EINVAL;
1253 
1254 	max_val = pmu_format_max_value(format->bits);
1255 	if (val > max_val) {
1256 		if (err) {
1257 			char *err_str;
1258 
1259 			parse_events__handle_error(err, term->err_val,
1260 				asprintf(&err_str,
1261 				    "value too big for format, maximum is %llu",
1262 				    (unsigned long long)max_val) < 0
1263 				    ? strdup("value too big for format")
1264 				    : err_str,
1265 				    NULL);
1266 			return -EINVAL;
1267 		}
1268 		/*
1269 		 * Assume we don't care if !err, in which case the value will be
1270 		 * silently truncated.
1271 		 */
1272 	}
1273 
1274 	pmu_format_value(format->bits, val, vp, zero);
1275 	return 0;
1276 }
1277 
1278 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1279 			   struct perf_event_attr *attr,
1280 			   struct list_head *head_terms,
1281 			   bool zero, struct parse_events_error *err)
1282 {
1283 	struct parse_events_term *term;
1284 
1285 	list_for_each_entry(term, head_terms, list) {
1286 		if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1287 				    zero, err))
1288 			return -EINVAL;
1289 	}
1290 
1291 	return 0;
1292 }
1293 
1294 /*
1295  * Configures event's 'attr' parameter based on the:
1296  * 1) users input - specified in terms parameter
1297  * 2) pmu format definitions - specified by pmu parameter
1298  */
1299 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1300 		     struct list_head *head_terms,
1301 		     struct parse_events_error *err)
1302 {
1303 	bool zero = !!pmu->default_config;
1304 
1305 	attr->type = pmu->type;
1306 	return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1307 				      head_terms, zero, err);
1308 }
1309 
1310 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1311 					     struct parse_events_term *term)
1312 {
1313 	struct perf_pmu_alias *alias;
1314 	char *name;
1315 
1316 	if (parse_events__is_hardcoded_term(term))
1317 		return NULL;
1318 
1319 	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1320 		if (term->val.num != 1)
1321 			return NULL;
1322 		if (pmu_find_format(&pmu->format, term->config))
1323 			return NULL;
1324 		name = term->config;
1325 	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1326 		if (strcasecmp(term->config, "event"))
1327 			return NULL;
1328 		name = term->val.str;
1329 	} else {
1330 		return NULL;
1331 	}
1332 
1333 	list_for_each_entry(alias, &pmu->aliases, list) {
1334 		if (!strcasecmp(alias->name, name))
1335 			return alias;
1336 	}
1337 	return NULL;
1338 }
1339 
1340 
1341 static int check_info_data(struct perf_pmu_alias *alias,
1342 			   struct perf_pmu_info *info)
1343 {
1344 	/*
1345 	 * Only one term in event definition can
1346 	 * define unit, scale and snapshot, fail
1347 	 * if there's more than one.
1348 	 */
1349 	if ((info->unit && alias->unit[0]) ||
1350 	    (info->scale && alias->scale) ||
1351 	    (info->snapshot && alias->snapshot))
1352 		return -EINVAL;
1353 
1354 	if (alias->unit[0])
1355 		info->unit = alias->unit;
1356 
1357 	if (alias->scale)
1358 		info->scale = alias->scale;
1359 
1360 	if (alias->snapshot)
1361 		info->snapshot = alias->snapshot;
1362 
1363 	return 0;
1364 }
1365 
1366 /*
1367  * Find alias in the terms list and replace it with the terms
1368  * defined for the alias
1369  */
1370 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1371 			  struct perf_pmu_info *info)
1372 {
1373 	struct parse_events_term *term, *h;
1374 	struct perf_pmu_alias *alias;
1375 	int ret;
1376 
1377 	info->per_pkg = false;
1378 
1379 	/*
1380 	 * Mark unit and scale as not set
1381 	 * (different from default values, see below)
1382 	 */
1383 	info->unit     = NULL;
1384 	info->scale    = 0.0;
1385 	info->snapshot = false;
1386 	info->metric_expr = NULL;
1387 	info->metric_name = NULL;
1388 
1389 	list_for_each_entry_safe(term, h, head_terms, list) {
1390 		alias = pmu_find_alias(pmu, term);
1391 		if (!alias)
1392 			continue;
1393 		ret = pmu_alias_terms(alias, &term->list);
1394 		if (ret)
1395 			return ret;
1396 
1397 		ret = check_info_data(alias, info);
1398 		if (ret)
1399 			return ret;
1400 
1401 		if (alias->per_pkg)
1402 			info->per_pkg = true;
1403 		info->metric_expr = alias->metric_expr;
1404 		info->metric_name = alias->metric_name;
1405 
1406 		list_del_init(&term->list);
1407 		parse_events_term__delete(term);
1408 	}
1409 
1410 	/*
1411 	 * if no unit or scale foundin aliases, then
1412 	 * set defaults as for evsel
1413 	 * unit cannot left to NULL
1414 	 */
1415 	if (info->unit == NULL)
1416 		info->unit   = "";
1417 
1418 	if (info->scale == 0.0)
1419 		info->scale  = 1.0;
1420 
1421 	return 0;
1422 }
1423 
1424 int perf_pmu__new_format(struct list_head *list, char *name,
1425 			 int config, unsigned long *bits)
1426 {
1427 	struct perf_pmu_format *format;
1428 
1429 	format = zalloc(sizeof(*format));
1430 	if (!format)
1431 		return -ENOMEM;
1432 
1433 	format->name = strdup(name);
1434 	format->value = config;
1435 	memcpy(format->bits, bits, sizeof(format->bits));
1436 
1437 	list_add_tail(&format->list, list);
1438 	return 0;
1439 }
1440 
1441 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1442 {
1443 	long b;
1444 
1445 	if (!to)
1446 		to = from;
1447 
1448 	memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1449 	for (b = from; b <= to; b++)
1450 		set_bit(b, bits);
1451 }
1452 
1453 void perf_pmu__del_formats(struct list_head *formats)
1454 {
1455 	struct perf_pmu_format *fmt, *tmp;
1456 
1457 	list_for_each_entry_safe(fmt, tmp, formats, list) {
1458 		list_del(&fmt->list);
1459 		free(fmt->name);
1460 		free(fmt);
1461 	}
1462 }
1463 
1464 static int sub_non_neg(int a, int b)
1465 {
1466 	if (b > a)
1467 		return 0;
1468 	return a - b;
1469 }
1470 
1471 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1472 			  struct perf_pmu_alias *alias)
1473 {
1474 	struct parse_events_term *term;
1475 	int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1476 
1477 	list_for_each_entry(term, &alias->terms, list) {
1478 		if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1479 			used += snprintf(buf + used, sub_non_neg(len, used),
1480 					",%s=%s", term->config,
1481 					term->val.str);
1482 	}
1483 
1484 	if (sub_non_neg(len, used) > 0) {
1485 		buf[used] = '/';
1486 		used++;
1487 	}
1488 	if (sub_non_neg(len, used) > 0) {
1489 		buf[used] = '\0';
1490 		used++;
1491 	} else
1492 		buf[len - 1] = '\0';
1493 
1494 	return buf;
1495 }
1496 
1497 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1498 			     struct perf_pmu_alias *alias)
1499 {
1500 	snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1501 	return buf;
1502 }
1503 
1504 struct sevent {
1505 	char *name;
1506 	char *desc;
1507 	char *topic;
1508 	char *str;
1509 	char *pmu;
1510 	char *metric_expr;
1511 	char *metric_name;
1512 	int is_cpu;
1513 };
1514 
1515 static int cmp_sevent(const void *a, const void *b)
1516 {
1517 	const struct sevent *as = a;
1518 	const struct sevent *bs = b;
1519 
1520 	/* Put extra events last */
1521 	if (!!as->desc != !!bs->desc)
1522 		return !!as->desc - !!bs->desc;
1523 	if (as->topic && bs->topic) {
1524 		int n = strcmp(as->topic, bs->topic);
1525 
1526 		if (n)
1527 			return n;
1528 	}
1529 
1530 	/* Order CPU core events to be first */
1531 	if (as->is_cpu != bs->is_cpu)
1532 		return bs->is_cpu - as->is_cpu;
1533 
1534 	return strcmp(as->name, bs->name);
1535 }
1536 
1537 static void wordwrap(char *s, int start, int max, int corr)
1538 {
1539 	int column = start;
1540 	int n;
1541 
1542 	while (*s) {
1543 		int wlen = strcspn(s, " \t");
1544 
1545 		if (column + wlen >= max && column > start) {
1546 			printf("\n%*s", start, "");
1547 			column = start + corr;
1548 		}
1549 		n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1550 		if (n <= 0)
1551 			break;
1552 		s += wlen;
1553 		column += n;
1554 		s = skip_spaces(s);
1555 	}
1556 }
1557 
1558 bool is_pmu_core(const char *name)
1559 {
1560 	return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1561 }
1562 
1563 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1564 			bool long_desc, bool details_flag, bool deprecated)
1565 {
1566 	struct perf_pmu *pmu;
1567 	struct perf_pmu_alias *alias;
1568 	char buf[1024];
1569 	int printed = 0;
1570 	int len, j;
1571 	struct sevent *aliases;
1572 	int numdesc = 0;
1573 	int columns = pager_get_columns();
1574 	char *topic = NULL;
1575 
1576 	pmu = NULL;
1577 	len = 0;
1578 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1579 		list_for_each_entry(alias, &pmu->aliases, list)
1580 			len++;
1581 		if (pmu->selectable)
1582 			len++;
1583 	}
1584 	aliases = zalloc(sizeof(struct sevent) * len);
1585 	if (!aliases)
1586 		goto out_enomem;
1587 	pmu = NULL;
1588 	j = 0;
1589 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1590 		list_for_each_entry(alias, &pmu->aliases, list) {
1591 			char *name = alias->desc ? alias->name :
1592 				format_alias(buf, sizeof(buf), pmu, alias);
1593 			bool is_cpu = is_pmu_core(pmu->name);
1594 
1595 			if (alias->deprecated && !deprecated)
1596 				continue;
1597 
1598 			if (event_glob != NULL &&
1599 			    !(strglobmatch_nocase(name, event_glob) ||
1600 			      (!is_cpu && strglobmatch_nocase(alias->name,
1601 						       event_glob)) ||
1602 			      (alias->topic &&
1603 			       strglobmatch_nocase(alias->topic, event_glob))))
1604 				continue;
1605 
1606 			if (is_cpu && !name_only && !alias->desc)
1607 				name = format_alias_or(buf, sizeof(buf), pmu, alias);
1608 
1609 			aliases[j].name = name;
1610 			if (is_cpu && !name_only && !alias->desc)
1611 				aliases[j].name = format_alias_or(buf,
1612 								  sizeof(buf),
1613 								  pmu, alias);
1614 			aliases[j].name = strdup(aliases[j].name);
1615 			if (!aliases[j].name)
1616 				goto out_enomem;
1617 
1618 			aliases[j].desc = long_desc ? alias->long_desc :
1619 						alias->desc;
1620 			aliases[j].topic = alias->topic;
1621 			aliases[j].str = alias->str;
1622 			aliases[j].pmu = pmu->name;
1623 			aliases[j].metric_expr = alias->metric_expr;
1624 			aliases[j].metric_name = alias->metric_name;
1625 			aliases[j].is_cpu = is_cpu;
1626 			j++;
1627 		}
1628 		if (pmu->selectable &&
1629 		    (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1630 			char *s;
1631 			if (asprintf(&s, "%s//", pmu->name) < 0)
1632 				goto out_enomem;
1633 			aliases[j].name = s;
1634 			j++;
1635 		}
1636 	}
1637 	len = j;
1638 	qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1639 	for (j = 0; j < len; j++) {
1640 		/* Skip duplicates */
1641 		if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1642 			continue;
1643 		if (name_only) {
1644 			printf("%s ", aliases[j].name);
1645 			continue;
1646 		}
1647 		if (aliases[j].desc && !quiet_flag) {
1648 			if (numdesc++ == 0)
1649 				printf("\n");
1650 			if (aliases[j].topic && (!topic ||
1651 					strcmp(topic, aliases[j].topic))) {
1652 				printf("%s%s:\n", topic ? "\n" : "",
1653 						aliases[j].topic);
1654 				topic = aliases[j].topic;
1655 			}
1656 			printf("  %-50s\n", aliases[j].name);
1657 			printf("%*s", 8, "[");
1658 			wordwrap(aliases[j].desc, 8, columns, 0);
1659 			printf("]\n");
1660 			if (details_flag) {
1661 				printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1662 				if (aliases[j].metric_name)
1663 					printf(" MetricName: %s", aliases[j].metric_name);
1664 				if (aliases[j].metric_expr)
1665 					printf(" MetricExpr: %s", aliases[j].metric_expr);
1666 				putchar('\n');
1667 			}
1668 		} else
1669 			printf("  %-50s [Kernel PMU event]\n", aliases[j].name);
1670 		printed++;
1671 	}
1672 	if (printed && pager_in_use())
1673 		printf("\n");
1674 out_free:
1675 	for (j = 0; j < len; j++)
1676 		zfree(&aliases[j].name);
1677 	zfree(&aliases);
1678 	return;
1679 
1680 out_enomem:
1681 	printf("FATAL: not enough memory to print PMU events\n");
1682 	if (aliases)
1683 		goto out_free;
1684 }
1685 
1686 bool pmu_have_event(const char *pname, const char *name)
1687 {
1688 	struct perf_pmu *pmu;
1689 	struct perf_pmu_alias *alias;
1690 
1691 	pmu = NULL;
1692 	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1693 		if (strcmp(pname, pmu->name))
1694 			continue;
1695 		list_for_each_entry(alias, &pmu->aliases, list)
1696 			if (!strcmp(alias->name, name))
1697 				return true;
1698 	}
1699 	return false;
1700 }
1701 
1702 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1703 {
1704 	char path[PATH_MAX];
1705 	const char *sysfs;
1706 
1707 	sysfs = sysfs__mountpoint();
1708 	if (!sysfs)
1709 		return NULL;
1710 
1711 	snprintf(path, PATH_MAX,
1712 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1713 	if (!file_available(path))
1714 		return NULL;
1715 	return fopen(path, "r");
1716 }
1717 
1718 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1719 			...)
1720 {
1721 	va_list args;
1722 	FILE *file;
1723 	int ret = EOF;
1724 
1725 	va_start(args, fmt);
1726 	file = perf_pmu__open_file(pmu, name);
1727 	if (file) {
1728 		ret = vfscanf(file, fmt, args);
1729 		fclose(file);
1730 	}
1731 	va_end(args);
1732 	return ret;
1733 }
1734 
1735 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1736 {
1737 	struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1738 
1739 	if (!caps)
1740 		return -ENOMEM;
1741 
1742 	caps->name = strdup(name);
1743 	if (!caps->name)
1744 		goto free_caps;
1745 	caps->value = strndup(value, strlen(value) - 1);
1746 	if (!caps->value)
1747 		goto free_name;
1748 	list_add_tail(&caps->list, list);
1749 	return 0;
1750 
1751 free_name:
1752 	zfree(caps->name);
1753 free_caps:
1754 	free(caps);
1755 
1756 	return -ENOMEM;
1757 }
1758 
1759 /*
1760  * Reading/parsing the given pmu capabilities, which should be located at:
1761  * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1762  * Return the number of capabilities
1763  */
1764 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1765 {
1766 	struct stat st;
1767 	char caps_path[PATH_MAX];
1768 	const char *sysfs = sysfs__mountpoint();
1769 	DIR *caps_dir;
1770 	struct dirent *evt_ent;
1771 	int nr_caps = 0;
1772 
1773 	if (!sysfs)
1774 		return -1;
1775 
1776 	snprintf(caps_path, PATH_MAX,
1777 		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1778 
1779 	if (stat(caps_path, &st) < 0)
1780 		return 0;	/* no error if caps does not exist */
1781 
1782 	caps_dir = opendir(caps_path);
1783 	if (!caps_dir)
1784 		return -EINVAL;
1785 
1786 	while ((evt_ent = readdir(caps_dir)) != NULL) {
1787 		char path[PATH_MAX + NAME_MAX + 1];
1788 		char *name = evt_ent->d_name;
1789 		char value[128];
1790 		FILE *file;
1791 
1792 		if (!strcmp(name, ".") || !strcmp(name, ".."))
1793 			continue;
1794 
1795 		snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1796 
1797 		file = fopen(path, "r");
1798 		if (!file)
1799 			continue;
1800 
1801 		if (!fgets(value, sizeof(value), file) ||
1802 		    (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1803 			fclose(file);
1804 			continue;
1805 		}
1806 
1807 		nr_caps++;
1808 		fclose(file);
1809 	}
1810 
1811 	closedir(caps_dir);
1812 
1813 	return nr_caps;
1814 }
1815