pmu.c 21.9 KB
Newer Older
1
#include <linux/list.h>
2
#include <linux/compiler.h>
3 4 5
#include <sys/types.h>
#include <unistd.h>
#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 12 13
#include "util.h"
#include "pmu.h"
#include "parse-events.h"
Y
Yan, Zheng 已提交
14
#include "cpumap.h"
15

16 17 18 19 20 21 22
struct perf_pmu_format {
	char *name;
	int value;
	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
	struct list_head list;
};

23 24
#define EVENT_SOURCE_DEVICE_PATH "/bus/event_source/devices/"

25 26 27 28 29 30 31 32 33
int perf_pmu_parse(struct list_head *list, char *name);
extern FILE *perf_pmu_in;

static LIST_HEAD(pmus);

/*
 * Parse & process all the sysfs attributes located under
 * the directory specified in 'dir' parameter.
 */
34
int perf_pmu__format_parse(char *dir, struct list_head *head)
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
{
	struct dirent *evt_ent;
	DIR *format_dir;
	int ret = 0;

	format_dir = opendir(dir);
	if (!format_dir)
		return -EINVAL;

	while (!ret && (evt_ent = readdir(format_dir))) {
		char path[PATH_MAX];
		char *name = evt_ent->d_name;
		FILE *file;

		if (!strcmp(name, ".") || !strcmp(name, ".."))
			continue;

		snprintf(path, PATH_MAX, "%s/%s", dir, name);

		ret = -EINVAL;
		file = fopen(path, "r");
		if (!file)
			break;

		perf_pmu_in = file;
		ret = perf_pmu_parse(head, name);
		fclose(file);
	}

	closedir(format_dir);
	return ret;
}

/*
 * Reading/parsing the default pmu format definition, which should be
 * located at:
 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
 */
73
static int pmu_format(const char *name, struct list_head *format)
74 75 76
{
	struct stat st;
	char path[PATH_MAX];
77
	const char *sysfs = sysfs__mountpoint();
78 79 80 81 82

	if (!sysfs)
		return -1;

	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 90 91 92 93
		return -1;

	return 0;
}

94 95 96 97 98 99 100
static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
{
	struct stat st;
	ssize_t sret;
	char scale[128];
	int fd, ret = -1;
	char path[PATH_MAX];
101
	const char *lc;
102 103 104 105 106 107 108 109 110 111 112 113 114 115

	snprintf(path, PATH_MAX, "%s/%s.scale", dir, name);

	fd = open(path, O_RDONLY);
	if (fd == -1)
		return -1;

	if (fstat(fd, &st) < 0)
		goto error;

	sret = read(fd, scale, sizeof(scale)-1);
	if (sret < 0)
		goto error;

116 117 118 119 120
	if (scale[sret - 1] == '\n')
		scale[sret - 1] = '\0';
	else
		scale[sret] = '\0';

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
	/*
	 * save current locale
	 */
	lc = setlocale(LC_NUMERIC, NULL);

	/*
	 * force to C locale to ensure kernel
	 * scale string is converted correctly.
	 * kernel uses default C locale.
	 */
	setlocale(LC_NUMERIC, "C");

	alias->scale = strtod(scale, NULL);

	/* restore locale */
	setlocale(LC_NUMERIC, lc);

	ret = 0;
error:
	close(fd);
	return ret;
}

static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
{
	char path[PATH_MAX];
	ssize_t sret;
	int fd;

	snprintf(path, PATH_MAX, "%s/%s.unit", dir, name);

	fd = open(path, O_RDONLY);
	if (fd == -1)
		return -1;

156
	sret = read(fd, alias->unit, UNIT_MAX_LEN);
157 158 159 160 161
	if (sret < 0)
		goto error;

	close(fd);

162 163 164 165
	if (alias->unit[sret - 1] == '\n')
		alias->unit[sret - 1] = '\0';
	else
		alias->unit[sret] = '\0';
166 167 168 169 170 171 172 173

	return 0;
error:
	close(fd);
	alias->unit[0] = '\0';
	return -1;
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
static int
perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
{
	char path[PATH_MAX];
	int fd;

	snprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);

	fd = open(path, O_RDONLY);
	if (fd == -1)
		return -1;

	close(fd);

	alias->per_pkg = true;
	return 0;
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
				    char *dir, char *name)
{
	char path[PATH_MAX];
	int fd;

	snprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);

	fd = open(path, O_RDONLY);
	if (fd == -1)
		return -1;

	alias->snapshot = true;
	close(fd);
	return 0;
}

209 210
static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
				 char *desc __maybe_unused, char *val)
211
{
212
	struct perf_pmu_alias *alias;
213 214 215 216 217 218 219
	int ret;

	alias = malloc(sizeof(*alias));
	if (!alias)
		return -ENOMEM;

	INIT_LIST_HEAD(&alias->terms);
220 221
	alias->scale = 1.0;
	alias->unit[0] = '\0';
222
	alias->per_pkg = false;
223
	alias->snapshot = false;
224

225
	ret = parse_events_terms(&alias->terms, val);
226
	if (ret) {
227
		pr_err("Cannot parse alias %s: %d\n", val, ret);
228 229 230 231 232
		free(alias);
		return ret;
	}

	alias->name = strdup(name);
233 234 235 236 237 238 239 240 241
	if (dir) {
		/*
		 * load unit name and scale if available
		 */
		perf_pmu__parse_unit(alias, dir, name);
		perf_pmu__parse_scale(alias, dir, name);
		perf_pmu__parse_per_pkg(alias, dir, name);
		perf_pmu__parse_snapshot(alias, dir, name);
	}
242

243
	list_add_tail(&alias->list, list);
244

245 246 247
	return 0;
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261
static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
{
	char buf[256];
	int ret;

	ret = fread(buf, 1, sizeof(buf), file);
	if (ret == 0)
		return -EINVAL;

	buf[ret] = 0;

	return __perf_pmu__new_alias(list, dir, name, NULL, buf);
}

262 263 264 265 266 267 268 269 270
static inline bool pmu_alias_info_file(char *name)
{
	size_t len;

	len = strlen(name);
	if (len > 5 && !strcmp(name + len - 5, ".unit"))
		return true;
	if (len > 6 && !strcmp(name + len - 6, ".scale"))
		return true;
271 272
	if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
		return true;
273 274
	if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
		return true;
275 276 277 278

	return false;
}

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
/*
 * Process all the sysfs attributes located under the directory
 * specified in 'dir' parameter.
 */
static int pmu_aliases_parse(char *dir, struct list_head *head)
{
	struct dirent *evt_ent;
	DIR *event_dir;
	int ret = 0;

	event_dir = opendir(dir);
	if (!event_dir)
		return -EINVAL;

	while (!ret && (evt_ent = readdir(event_dir))) {
		char path[PATH_MAX];
		char *name = evt_ent->d_name;
		FILE *file;

		if (!strcmp(name, ".") || !strcmp(name, ".."))
			continue;

301
		/*
302
		 * skip info files parsed in perf_pmu__new_alias()
303
		 */
304
		if (pmu_alias_info_file(name))
305 306
			continue;

307 308 309 310 311 312
		snprintf(path, PATH_MAX, "%s/%s", dir, name);

		ret = -EINVAL;
		file = fopen(path, "r");
		if (!file)
			break;
313 314

		ret = perf_pmu__new_alias(head, dir, name, file);
315 316 317 318 319 320 321 322 323 324 325
		fclose(file);
	}

	closedir(event_dir);
	return ret;
}

/*
 * Reading the pmu event aliases definition, which should be located at:
 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
 */
326
static int pmu_aliases(const char *name, struct list_head *head)
327 328 329
{
	struct stat st;
	char path[PATH_MAX];
330
	const char *sysfs = sysfs__mountpoint();
331 332 333 334 335 336 337 338

	if (!sysfs)
		return -1;

	snprintf(path, PATH_MAX,
		 "%s/bus/event_source/devices/%s/events", sysfs, name);

	if (stat(path, &st) < 0)
339
		return 0;	 /* no error if 'events' does not exist */
340 341 342 343 344 345 346

	if (pmu_aliases_parse(path, head))
		return -1;

	return 0;
}

347
static int pmu_alias_terms(struct perf_pmu_alias *alias,
348 349
			   struct list_head *terms)
{
350
	struct parse_events_term *term, *cloned;
351 352 353 354
	LIST_HEAD(list);
	int ret;

	list_for_each_entry(term, &alias->terms, list) {
355
		ret = parse_events_term__clone(&cloned, term);
356 357 358 359
		if (ret) {
			parse_events__free_terms(&list);
			return ret;
		}
360
		list_add_tail(&cloned->list, &list);
361 362 363 364 365
	}
	list_splice(&list, terms);
	return 0;
}

366 367 368 369 370
/*
 * Reading/parsing the default pmu type value, which should be
 * located at:
 * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
 */
371
static int pmu_type(const char *name, __u32 *type)
372 373 374 375 376
{
	struct stat st;
	char path[PATH_MAX];
	FILE *file;
	int ret = 0;
377
	const char *sysfs = sysfs__mountpoint();
378 379 380 381 382

	if (!sysfs)
		return -1;

	snprintf(path, PATH_MAX,
383
		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

	if (stat(path, &st) < 0)
		return -1;

	file = fopen(path, "r");
	if (!file)
		return -EINVAL;

	if (1 != fscanf(file, "%u", type))
		ret = -1;

	fclose(file);
	return ret;
}

399 400 401 402 403 404
/* Add all pmus in sysfs to pmu list: */
static void pmu_read_sysfs(void)
{
	char path[PATH_MAX];
	DIR *dir;
	struct dirent *dent;
405
	const char *sysfs = sysfs__mountpoint();
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426

	if (!sysfs)
		return;

	snprintf(path, PATH_MAX,
		 "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);

	dir = opendir(path);
	if (!dir)
		return;

	while ((dent = readdir(dir))) {
		if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
			continue;
		/* add to static LIST_HEAD(pmus): */
		perf_pmu__find(dent->d_name);
	}

	closedir(dir);
}

427
static struct cpu_map *pmu_cpumask(const char *name)
Y
Yan, Zheng 已提交
428 429 430 431 432
{
	struct stat st;
	char path[PATH_MAX];
	FILE *file;
	struct cpu_map *cpus;
433
	const char *sysfs = sysfs__mountpoint();
Y
Yan, Zheng 已提交
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

	if (!sysfs)
		return NULL;

	snprintf(path, PATH_MAX,
		 "%s/bus/event_source/devices/%s/cpumask", sysfs, name);

	if (stat(path, &st) < 0)
		return NULL;

	file = fopen(path, "r");
	if (!file)
		return NULL;

	cpus = cpu_map__read(file);
	fclose(file);
	return cpus;
}

453
struct perf_event_attr * __weak
454 455 456 457 458
perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
{
	return NULL;
}

459
static struct perf_pmu *pmu_lookup(const char *name)
460 461 462
{
	struct perf_pmu *pmu;
	LIST_HEAD(format);
463
	LIST_HEAD(aliases);
464 465 466 467 468 469 470 471 472 473
	__u32 type;

	/*
	 * The pmu data we store & need consists of the pmu
	 * type value and format definitions. Load both right
	 * now.
	 */
	if (pmu_format(name, &format))
		return NULL;

474 475 476
	if (pmu_aliases(name, &aliases))
		return NULL;

477 478 479 480 481 482 483
	if (pmu_type(name, &type))
		return NULL;

	pmu = zalloc(sizeof(*pmu));
	if (!pmu)
		return NULL;

Y
Yan, Zheng 已提交
484 485
	pmu->cpus = pmu_cpumask(name);

486
	INIT_LIST_HEAD(&pmu->format);
487
	INIT_LIST_HEAD(&pmu->aliases);
488
	list_splice(&format, &pmu->format);
489
	list_splice(&aliases, &pmu->aliases);
490 491
	pmu->name = strdup(name);
	pmu->type = type;
492
	list_add_tail(&pmu->list, &pmus);
493 494 495

	pmu->default_config = perf_pmu__get_default_config(pmu);

496 497 498
	return pmu;
}

499
static struct perf_pmu *pmu_find(const char *name)
500 501 502 503 504 505 506 507 508 509
{
	struct perf_pmu *pmu;

	list_for_each_entry(pmu, &pmus, list)
		if (!strcmp(pmu->name, name))
			return pmu;

	return NULL;
}

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
{
	/*
	 * pmu iterator: If pmu is NULL, we start at the begin,
	 * otherwise return the next pmu. Returns NULL on end.
	 */
	if (!pmu) {
		pmu_read_sysfs();
		pmu = list_prepare_entry(pmu, &pmus, list);
	}
	list_for_each_entry_continue(pmu, &pmus, list)
		return pmu;
	return NULL;
}

525
struct perf_pmu *perf_pmu__find(const char *name)
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
{
	struct perf_pmu *pmu;

	/*
	 * Once PMU is loaded it stays in the list,
	 * so we keep us from multiple reading/parsing
	 * the pmu format definitions.
	 */
	pmu = pmu_find(name);
	if (pmu)
		return pmu;

	return pmu_lookup(name);
}

541
static struct perf_pmu_format *
542
pmu_find_format(struct list_head *formats, const char *name)
543
{
544
	struct perf_pmu_format *format;
545 546 547 548 549 550 551 552

	list_for_each_entry(format, formats, list)
		if (!strcmp(format->name, name))
			return format;

	return NULL;
}

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
__u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
{
	struct perf_pmu_format *format = pmu_find_format(formats, name);
	__u64 bits = 0;
	int fbit;

	if (!format)
		return 0;

	for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
		bits |= 1ULL << fbit;

	return bits;
}

568
/*
569
 * Sets value based on the format definition (format parameter)
570 571
 * and unformated value (value parameter).
 */
572 573
static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
			     bool zero)
574 575 576 577 578 579 580 581
{
	unsigned long fbit, vbit;

	for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {

		if (!test_bit(fbit, format))
			continue;

582 583 584 585
		if (value & (1llu << vbit++))
			*v |= (1llu << fbit);
		else if (zero)
			*v &= ~(1llu << fbit);
586 587 588
	}
}

589 590 591 592 593 594 595 596 597 598 599 600
static __u64 pmu_format_max_value(const unsigned long *format)
{
	int w;

	w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
	if (!w)
		return 0;
	if (w < 64)
		return (1ULL << w) - 1;
	return -1;
}

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
/*
 * Term is a string term, and might be a param-term. Try to look up it's value
 * in the remaining terms.
 * - We have a term like "base-or-format-term=param-term",
 * - We need to find the value supplied for "param-term" (with param-term named
 *   in a config string) later on in the term list.
 */
static int pmu_resolve_param_term(struct parse_events_term *term,
				  struct list_head *head_terms,
				  __u64 *value)
{
	struct parse_events_term *t;

	list_for_each_entry(t, head_terms, list) {
		if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
			if (!strcmp(t->config, term->config)) {
				t->used = true;
				*value = t->val.num;
				return 0;
			}
		}
	}

	if (verbose)
		printf("Required parameter '%s' not specified\n", term->config);

	return -1;
}

630
static char *pmu_formats_string(struct list_head *formats)
631 632
{
	struct perf_pmu_format *format;
633 634
	char *str;
	struct strbuf buf;
635 636
	unsigned i = 0;

637
	if (!formats)
638 639
		return NULL;

640
	strbuf_init(&buf, 0);
641
	/* sysfs exported terms */
642 643 644
	list_for_each_entry(format, formats, list)
		strbuf_addf(&buf, i++ ? ",%s" : "%s",
			    format->name);
645

646 647
	str = strbuf_detach(&buf, NULL);
	strbuf_release(&buf);
648 649 650 651

	return str;
}

652 653
/*
 * Setup one of config[12] attr members based on the
C
Cody P Schafer 已提交
654
 * user input data - term parameter.
655 656 657
 */
static int pmu_config_term(struct list_head *formats,
			   struct perf_event_attr *attr,
658
			   struct parse_events_term *term,
659
			   struct list_head *head_terms,
660
			   bool zero, struct parse_events_error *err)
661
{
662
	struct perf_pmu_format *format;
663
	__u64 *vp;
664
	__u64 val, max_val;
665 666 667 668 669 670 671

	/*
	 * If this is a parameter we've already used for parameterized-eval,
	 * skip it in normal eval.
	 */
	if (term->used)
		return 0;
672 673 674 675 676 677 678 679 680

	/*
	 * Hardcoded terms should be already in, so nothing
	 * to be done for them.
	 */
	if (parse_events__is_hardcoded_term(term))
		return 0;

	format = pmu_find_format(formats, term->config);
681 682 683
	if (!format) {
		if (verbose)
			printf("Invalid event/parameter '%s'\n", term->config);
684
		if (err) {
685 686
			char *pmu_term = pmu_formats_string(formats);

687 688
			err->idx  = term->err_term;
			err->str  = strdup("unknown term");
689 690
			err->help = parse_events_formats_error_string(pmu_term);
			free(pmu_term);
691
		}
692
		return -EINVAL;
693
	}
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

	switch (format->value) {
	case PERF_PMU_FORMAT_VALUE_CONFIG:
		vp = &attr->config;
		break;
	case PERF_PMU_FORMAT_VALUE_CONFIG1:
		vp = &attr->config1;
		break;
	case PERF_PMU_FORMAT_VALUE_CONFIG2:
		vp = &attr->config2;
		break;
	default:
		return -EINVAL;
	}

709
	/*
710 711
	 * Either directly use a numeric term, or try to translate string terms
	 * using event parameters.
712
	 */
713 714 715 716
	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
		val = term->val.num;
	else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
		if (strcmp(term->val.str, "?")) {
717
			if (verbose) {
718 719
				pr_info("Invalid sysfs entry %s=%s\n",
						term->config, term->val.str);
720 721 722 723 724
			}
			if (err) {
				err->idx = term->err_val;
				err->str = strdup("expected numeric value");
			}
725 726 727 728 729 730 731 732
			return -EINVAL;
		}

		if (pmu_resolve_param_term(term, head_terms, &val))
			return -EINVAL;
	} else
		return -EINVAL;

733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	max_val = pmu_format_max_value(format->bits);
	if (val > max_val) {
		if (err) {
			err->idx = term->err_val;
			if (asprintf(&err->str,
				     "value too big for format, maximum is %llu",
				     (unsigned long long)max_val) < 0)
				err->str = strdup("value too big for format");
			return -EINVAL;
		}
		/*
		 * Assume we don't care if !err, in which case the value will be
		 * silently truncated.
		 */
	}

749
	pmu_format_value(format->bits, val, vp, zero);
750 751 752
	return 0;
}

753 754
int perf_pmu__config_terms(struct list_head *formats,
			   struct perf_event_attr *attr,
755
			   struct list_head *head_terms,
756
			   bool zero, struct parse_events_error *err)
757
{
758
	struct parse_events_term *term;
759

760
	list_for_each_entry(term, head_terms, list) {
761 762
		if (pmu_config_term(formats, attr, term, head_terms,
				    zero, err))
763
			return -EINVAL;
764
	}
765 766 767 768 769 770 771 772 773 774

	return 0;
}

/*
 * Configures event's 'attr' parameter based on the:
 * 1) users input - specified in terms parameter
 * 2) pmu format definitions - specified by pmu parameter
 */
int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
775 776
		     struct list_head *head_terms,
		     struct parse_events_error *err)
777
{
778 779
	bool zero = !!pmu->default_config;

780
	attr->type = pmu->type;
781 782
	return perf_pmu__config_terms(&pmu->format, attr, head_terms,
				      zero, err);
783 784
}

785 786
static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
					     struct parse_events_term *term)
787
{
788
	struct perf_pmu_alias *alias;
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
	char *name;

	if (parse_events__is_hardcoded_term(term))
		return NULL;

	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
		if (term->val.num != 1)
			return NULL;
		if (pmu_find_format(&pmu->format, term->config))
			return NULL;
		name = term->config;
	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
		if (strcasecmp(term->config, "event"))
			return NULL;
		name = term->val.str;
	} else {
		return NULL;
	}

	list_for_each_entry(alias, &pmu->aliases, list) {
		if (!strcasecmp(alias->name, name))
			return alias;
	}
	return NULL;
}

815

816 817
static int check_info_data(struct perf_pmu_alias *alias,
			   struct perf_pmu_info *info)
818 819 820
{
	/*
	 * Only one term in event definition can
821 822
	 * define unit, scale and snapshot, fail
	 * if there's more than one.
823
	 */
824 825 826
	if ((info->unit && alias->unit) ||
	    (info->scale && alias->scale) ||
	    (info->snapshot && alias->snapshot))
827 828 829
		return -EINVAL;

	if (alias->unit)
830
		info->unit = alias->unit;
831 832

	if (alias->scale)
833 834 835 836
		info->scale = alias->scale;

	if (alias->snapshot)
		info->snapshot = alias->snapshot;
837 838 839 840

	return 0;
}

841 842 843 844
/*
 * Find alias in the terms list and replace it with the terms
 * defined for the alias
 */
845
int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
846
			  struct perf_pmu_info *info)
847
{
848
	struct parse_events_term *term, *h;
849
	struct perf_pmu_alias *alias;
850 851
	int ret;

852 853
	info->per_pkg = false;

854 855 856 857
	/*
	 * Mark unit and scale as not set
	 * (different from default values, see below)
	 */
858 859 860
	info->unit     = NULL;
	info->scale    = 0.0;
	info->snapshot = false;
861

862 863 864 865 866 867 868
	list_for_each_entry_safe(term, h, head_terms, list) {
		alias = pmu_find_alias(pmu, term);
		if (!alias)
			continue;
		ret = pmu_alias_terms(alias, &term->list);
		if (ret)
			return ret;
869

870
		ret = check_info_data(alias, info);
871 872 873
		if (ret)
			return ret;

874 875 876
		if (alias->per_pkg)
			info->per_pkg = true;

877 878 879
		list_del(&term->list);
		free(term);
	}
880 881 882 883 884 885

	/*
	 * if no unit or scale foundin aliases, then
	 * set defaults as for evsel
	 * unit cannot left to NULL
	 */
886 887
	if (info->unit == NULL)
		info->unit   = "";
888

889 890
	if (info->scale == 0.0)
		info->scale  = 1.0;
891

892 893 894
	return 0;
}

895 896 897
int perf_pmu__new_format(struct list_head *list, char *name,
			 int config, unsigned long *bits)
{
898
	struct perf_pmu_format *format;
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918

	format = zalloc(sizeof(*format));
	if (!format)
		return -ENOMEM;

	format->name = strdup(name);
	format->value = config;
	memcpy(format->bits, bits, sizeof(format->bits));

	list_add_tail(&format->list, list);
	return 0;
}

void perf_pmu__set_format(unsigned long *bits, long from, long to)
{
	long b;

	if (!to)
		to = from;

919
	memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
920 921 922
	for (b = from; b <= to; b++)
		set_bit(b, bits);
}
923

924 925 926 927 928 929 930
static int sub_non_neg(int a, int b)
{
	if (b > a)
		return 0;
	return a - b;
}

931 932 933
static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
			  struct perf_pmu_alias *alias)
{
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
	struct parse_events_term *term;
	int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);

	list_for_each_entry(term, &alias->terms, list) {
		if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
			used += snprintf(buf + used, sub_non_neg(len, used),
					",%s=%s", term->config,
					term->val.str);
	}

	if (sub_non_neg(len, used) > 0) {
		buf[used] = '/';
		used++;
	}
	if (sub_non_neg(len, used) > 0) {
		buf[used] = '\0';
		used++;
	} else
		buf[len - 1] = '\0';

954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
	return buf;
}

static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
			     struct perf_pmu_alias *alias)
{
	snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
	return buf;
}

static int cmp_string(const void *a, const void *b)
{
	const char * const *as = a;
	const char * const *bs = b;
	return strcmp(*as, *bs);
}

void print_pmu_events(const char *event_glob, bool name_only)
{
	struct perf_pmu *pmu;
	struct perf_pmu_alias *alias;
	char buf[1024];
	int printed = 0;
	int len, j;
	char **aliases;

	pmu = NULL;
	len = 0;
982
	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
983 984
		list_for_each_entry(alias, &pmu->aliases, list)
			len++;
985 986 987
		if (pmu->selectable)
			len++;
	}
988
	aliases = zalloc(sizeof(char *) * len);
989
	if (!aliases)
990
		goto out_enomem;
991 992
	pmu = NULL;
	j = 0;
993
	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
994 995 996 997 998 999 1000 1001 1002
		list_for_each_entry(alias, &pmu->aliases, list) {
			char *name = format_alias(buf, sizeof(buf), pmu, alias);
			bool is_cpu = !strcmp(pmu->name, "cpu");

			if (event_glob != NULL &&
			    !(strglobmatch(name, event_glob) ||
			      (!is_cpu && strglobmatch(alias->name,
						       event_glob))))
				continue;
1003

1004
			if (is_cpu && !name_only)
1005 1006 1007 1008 1009
				name = format_alias_or(buf, sizeof(buf), pmu, alias);

			aliases[j] = strdup(name);
			if (aliases[j] == NULL)
				goto out_enomem;
1010 1011
			j++;
		}
1012 1013
		if (pmu->selectable &&
		    (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1014 1015 1016 1017
			char *s;
			if (asprintf(&s, "%s//", pmu->name) < 0)
				goto out_enomem;
			aliases[j] = s;
1018 1019 1020
			j++;
		}
	}
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
	len = j;
	qsort(aliases, len, sizeof(char *), cmp_string);
	for (j = 0; j < len; j++) {
		if (name_only) {
			printf("%s ", aliases[j]);
			continue;
		}
		printf("  %-50s [Kernel PMU event]\n", aliases[j]);
		printed++;
	}
1031
	if (printed && pager_in_use())
1032
		printf("\n");
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
out_free:
	for (j = 0; j < len; j++)
		zfree(&aliases[j]);
	zfree(&aliases);
	return;

out_enomem:
	printf("FATAL: not enough memory to print PMU events\n");
	if (aliases)
		goto out_free;
1043
}
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059

bool pmu_have_event(const char *pname, const char *name)
{
	struct perf_pmu *pmu;
	struct perf_pmu_alias *alias;

	pmu = NULL;
	while ((pmu = perf_pmu__scan(pmu)) != NULL) {
		if (strcmp(pname, pmu->name))
			continue;
		list_for_each_entry(alias, &pmu->aliases, list)
			if (!strcmp(alias->name, name))
				return true;
	}
	return false;
}
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095

static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
{
	struct stat st;
	char path[PATH_MAX];
	const char *sysfs;

	sysfs = sysfs__mountpoint();
	if (!sysfs)
		return NULL;

	snprintf(path, PATH_MAX,
		 "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);

	if (stat(path, &st) < 0)
		return NULL;

	return fopen(path, "r");
}

int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
			...)
{
	va_list args;
	FILE *file;
	int ret = EOF;

	va_start(args, fmt);
	file = perf_pmu__open_file(pmu, name);
	if (file) {
		ret = vfscanf(file, fmt, args);
		fclose(file);
	}
	va_end(args);
	return ret;
}