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 <linux/ctype.h>
 
   7#include <sys/types.h>
 
   8#include <fcntl.h>
   9#include <sys/stat.h>
  10#include <unistd.h>
  11#include <stdio.h>
  12#include <stdbool.h>
 
  13#include <dirent.h>
  14#include <api/fs/fs.h>
  15#include <locale.h>
 
 
  16#include <fnmatch.h>
  17#include <math.h>
  18#include "debug.h"
  19#include "evsel.h"
  20#include "pmu.h"
  21#include "pmus.h"
  22#include <util/pmu-bison.h>
  23#include <util/pmu-flex.h>
  24#include "parse-events.h"
  25#include "print-events.h"
  26#include "header.h"
  27#include "string2.h"
  28#include "strbuf.h"
  29#include "fncache.h"
  30#include "util/evsel_config.h"
  31#include <regex.h>
  32
  33struct perf_pmu perf_pmu__fake = {
  34	.name = "fake",
  35};
  36
  37#define UNIT_MAX_LEN	31 /* max length for event unit name */
  38
  39enum event_source {
  40	/* An event loaded from /sys/devices/<pmu>/events. */
  41	EVENT_SRC_SYSFS,
  42	/* An event loaded from a CPUID matched json file. */
  43	EVENT_SRC_CPU_JSON,
  44	/*
  45	 * An event loaded from a /sys/devices/<pmu>/identifier matched json
  46	 * file.
  47	 */
  48	EVENT_SRC_SYS_JSON,
  49};
  50
  51/**
  52 * struct perf_pmu_alias - An event either read from sysfs or builtin in
  53 * pmu-events.c, created by parsing the pmu-events json files.
  54 */
  55struct perf_pmu_alias {
  56	/** @name: Name of the event like "mem-loads". */
  57	char *name;
  58	/** @desc: Optional short description of the event. */
  59	char *desc;
  60	/** @long_desc: Optional long description. */
  61	char *long_desc;
  62	/**
  63	 * @topic: Optional topic such as cache or pipeline, particularly for
  64	 * json events.
  65	 */
  66	char *topic;
  67	/** @terms: Owned list of the original parsed parameters. */
  68	struct parse_events_terms terms;
  69	/** @list: List element of struct perf_pmu aliases. */
  70	struct list_head list;
  71	/**
  72	 * @pmu_name: The name copied from the json struct pmu_event. This can
  73	 * differ from the PMU name as it won't have suffixes.
  74	 */
  75	char *pmu_name;
  76	/** @unit: Units for the event, such as bytes or cache lines. */
  77	char unit[UNIT_MAX_LEN+1];
  78	/** @scale: Value to scale read counter values by. */
  79	double scale;
  80	/**
  81	 * @per_pkg: Does the file
  82	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.per-pkg or
  83	 * equivalent json value exist and have the value 1.
  84	 */
  85	bool per_pkg;
  86	/**
  87	 * @snapshot: Does the file
  88	 * <sysfs>/bus/event_source/devices/<pmu_name>/events/<name>.snapshot
  89	 * exist and have the value 1.
  90	 */
  91	bool snapshot;
  92	/**
  93	 * @deprecated: Is the event hidden and so not shown in perf list by
  94	 * default.
  95	 */
  96	bool deprecated;
  97	/** @from_sysfs: Was the alias from sysfs or a json event? */
  98	bool from_sysfs;
  99	/** @info_loaded: Have the scale, unit and other values been read from disk? */
 100	bool info_loaded;
 101};
 102
 103/**
 104 * struct perf_pmu_format - Values from a format file read from
 105 * <sysfs>/devices/cpu/format/ held in struct perf_pmu.
 106 *
 107 * For example, the contents of <sysfs>/devices/cpu/format/event may be
 108 * "config:0-7" and will be represented here as name="event",
 109 * value=PERF_PMU_FORMAT_VALUE_CONFIG and bits 0 to 7 will be set.
 110 */
 111struct perf_pmu_format {
 112	/** @list: Element on list within struct perf_pmu. */
 113	struct list_head list;
 114	/** @bits: Which config bits are set by this format value. */
 115	DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
 116	/** @name: The modifier/file name. */
 117	char *name;
 118	/**
 119	 * @value : Which config value the format relates to. Supported values
 120	 * are from PERF_PMU_FORMAT_VALUE_CONFIG to
 121	 * PERF_PMU_FORMAT_VALUE_CONFIG_END.
 122	 */
 123	u16 value;
 124	/** @loaded: Has the contents been loaded/parsed. */
 125	bool loaded;
 126};
 127
 128static int pmu_aliases_parse(struct perf_pmu *pmu);
 129
 130static struct perf_pmu_format *perf_pmu__new_format(struct list_head *list, char *name)
 131{
 132	struct perf_pmu_format *format;
 133
 134	format = zalloc(sizeof(*format));
 135	if (!format)
 136		return NULL;
 137
 138	format->name = strdup(name);
 139	if (!format->name) {
 140		free(format);
 141		return NULL;
 142	}
 143	list_add_tail(&format->list, list);
 144	return format;
 145}
 146
 147/* Called at the end of parsing a format. */
 148void perf_pmu_format__set_value(void *vformat, int config, unsigned long *bits)
 149{
 150	struct perf_pmu_format *format = vformat;
 151
 152	format->value = config;
 153	memcpy(format->bits, bits, sizeof(format->bits));
 154}
 155
 156static void __perf_pmu_format__load(struct perf_pmu_format *format, FILE *file)
 157{
 158	void *scanner;
 159	int ret;
 160
 161	ret = perf_pmu_lex_init(&scanner);
 162	if (ret)
 163		return;
 164
 165	perf_pmu_set_in(file, scanner);
 166	ret = perf_pmu_parse(format, scanner);
 167	perf_pmu_lex_destroy(scanner);
 168	format->loaded = true;
 169}
 170
 171static void perf_pmu_format__load(const struct perf_pmu *pmu, struct perf_pmu_format *format)
 172{
 173	char path[PATH_MAX];
 174	FILE *file = NULL;
 175
 176	if (format->loaded)
 177		return;
 178
 179	if (!perf_pmu__pathname_scnprintf(path, sizeof(path), pmu->name, "format"))
 180		return;
 181
 182	assert(strlen(path) + strlen(format->name) + 2 < sizeof(path));
 183	strcat(path, "/");
 184	strcat(path, format->name);
 185
 186	file = fopen(path, "r");
 187	if (!file)
 188		return;
 189	__perf_pmu_format__load(format, file);
 190	fclose(file);
 191}
 192
 193/*
 194 * Parse & process all the sysfs attributes located under
 195 * the directory specified in 'dir' parameter.
 196 */
 197int perf_pmu__format_parse(struct perf_pmu *pmu, int dirfd, bool eager_load)
 198{
 199	struct dirent *evt_ent;
 200	DIR *format_dir;
 201	int ret = 0;
 202
 203	format_dir = fdopendir(dirfd);
 204	if (!format_dir)
 205		return -EINVAL;
 206
 207	while ((evt_ent = readdir(format_dir)) != NULL) {
 208		struct perf_pmu_format *format;
 209		char *name = evt_ent->d_name;
 
 210
 211		if (!strcmp(name, ".") || !strcmp(name, ".."))
 212			continue;
 213
 214		format = perf_pmu__new_format(&pmu->format, name);
 215		if (!format) {
 216			ret = -ENOMEM;
 217			break;
 218		}
 219
 220		if (eager_load) {
 221			FILE *file;
 222			int fd = openat(dirfd, name, O_RDONLY);
 
 223
 224			if (fd < 0) {
 225				ret = -errno;
 226				break;
 227			}
 228			file = fdopen(fd, "r");
 229			if (!file) {
 230				close(fd);
 231				break;
 232			}
 233			__perf_pmu_format__load(format, file);
 234			fclose(file);
 235		}
 236	}
 237
 238	closedir(format_dir);
 239	return ret;
 240}
 241
 242/*
 243 * Reading/parsing the default pmu format definition, which should be
 244 * located at:
 245 * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
 246 */
 247static int pmu_format(struct perf_pmu *pmu, int dirfd, const char *name)
 248{
 249	int fd;
 
 
 
 
 
 
 
 250
 251	fd = perf_pmu__pathname_fd(dirfd, name, "format", O_DIRECTORY);
 252	if (fd < 0)
 253		return 0;
 254
 255	/* it'll close the fd */
 256	if (perf_pmu__format_parse(pmu, fd, /*eager_load=*/false))
 257		return -1;
 258
 259	return 0;
 260}
 261
 262int perf_pmu__convert_scale(const char *scale, char **end, double *sval)
 263{
 264	char *lc;
 265	int ret = 0;
 266
 267	/*
 268	 * save current locale
 269	 */
 270	lc = setlocale(LC_NUMERIC, NULL);
 271
 272	/*
 273	 * The lc string may be allocated in static storage,
 274	 * so get a dynamic copy to make it survive setlocale
 275	 * call below.
 276	 */
 277	lc = strdup(lc);
 278	if (!lc) {
 279		ret = -ENOMEM;
 280		goto out;
 281	}
 282
 283	/*
 284	 * force to C locale to ensure kernel
 285	 * scale string is converted correctly.
 286	 * kernel uses default C locale.
 287	 */
 288	setlocale(LC_NUMERIC, "C");
 289
 290	*sval = strtod(scale, end);
 291
 292out:
 293	/* restore locale */
 294	setlocale(LC_NUMERIC, lc);
 295	free(lc);
 296	return ret;
 297}
 298
 299static int perf_pmu__parse_scale(struct perf_pmu *pmu, struct perf_pmu_alias *alias)
 300{
 301	struct stat st;
 302	ssize_t sret;
 303	size_t len;
 304	char scale[128];
 305	int fd, ret = -1;
 306	char path[PATH_MAX];
 307
 308	len = perf_pmu__event_source_devices_scnprintf(path, sizeof(path));
 309	if (!len)
 310		return 0;
 311	scnprintf(path + len, sizeof(path) - len, "%s/events/%s.scale", pmu->name, alias->name);
 312
 313	fd = open(path, O_RDONLY);
 314	if (fd == -1)
 315		return -1;
 316
 317	if (fstat(fd, &st) < 0)
 318		goto error;
 319
 320	sret = read(fd, scale, sizeof(scale)-1);
 321	if (sret < 0)
 322		goto error;
 323
 324	if (scale[sret - 1] == '\n')
 325		scale[sret - 1] = '\0';
 326	else
 327		scale[sret] = '\0';
 328
 329	ret = perf_pmu__convert_scale(scale, NULL, &alias->scale);
 330error:
 331	close(fd);
 332	return ret;
 333}
 334
 335static int perf_pmu__parse_unit(struct perf_pmu *pmu, struct perf_pmu_alias *alias)
 336{
 337	char path[PATH_MAX];
 338	size_t len;
 339	ssize_t sret;
 340	int fd;
 341
 342
 343	len = perf_pmu__event_source_devices_scnprintf(path, sizeof(path));
 344	if (!len)
 345		return 0;
 346	scnprintf(path + len, sizeof(path) - len, "%s/events/%s.unit", pmu->name, alias->name);
 347
 348	fd = open(path, O_RDONLY);
 349	if (fd == -1)
 350		return -1;
 351
 352	sret = read(fd, alias->unit, UNIT_MAX_LEN);
 353	if (sret < 0)
 354		goto error;
 355
 356	close(fd);
 357
 358	if (alias->unit[sret - 1] == '\n')
 359		alias->unit[sret - 1] = '\0';
 360	else
 361		alias->unit[sret] = '\0';
 362
 363	return 0;
 364error:
 365	close(fd);
 366	alias->unit[0] = '\0';
 367	return -1;
 368}
 369
 370static int
 371perf_pmu__parse_per_pkg(struct perf_pmu *pmu, struct perf_pmu_alias *alias)
 372{
 373	char path[PATH_MAX];
 374	size_t len;
 375	int fd;
 376
 377	len = perf_pmu__event_source_devices_scnprintf(path, sizeof(path));
 378	if (!len)
 379		return 0;
 380	scnprintf(path + len, sizeof(path) - len, "%s/events/%s.per-pkg", pmu->name, alias->name);
 381
 382	fd = open(path, O_RDONLY);
 383	if (fd == -1)
 384		return -1;
 385
 386	close(fd);
 387
 388	alias->per_pkg = true;
 389	return 0;
 390}
 391
 392static int perf_pmu__parse_snapshot(struct perf_pmu *pmu, struct perf_pmu_alias *alias)
 
 393{
 394	char path[PATH_MAX];
 395	size_t len;
 396	int fd;
 397
 398	len = perf_pmu__event_source_devices_scnprintf(path, sizeof(path));
 399	if (!len)
 400		return 0;
 401	scnprintf(path + len, sizeof(path) - len, "%s/events/%s.snapshot", pmu->name, alias->name);
 402
 403	fd = open(path, O_RDONLY);
 404	if (fd == -1)
 405		return -1;
 406
 407	alias->snapshot = true;
 408	close(fd);
 409	return 0;
 410}
 411
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 412/* Delete an alias entry. */
 413static void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
 414{
 415	zfree(&newalias->name);
 416	zfree(&newalias->desc);
 417	zfree(&newalias->long_desc);
 418	zfree(&newalias->topic);
 
 
 
 419	zfree(&newalias->pmu_name);
 420	parse_events_terms__exit(&newalias->terms);
 421	free(newalias);
 422}
 423
 424static void perf_pmu__del_aliases(struct perf_pmu *pmu)
 425{
 426	struct perf_pmu_alias *alias, *tmp;
 427
 428	list_for_each_entry_safe(alias, tmp, &pmu->aliases, list) {
 429		list_del(&alias->list);
 430		perf_pmu_free_alias(alias);
 431	}
 432}
 433
 434static struct perf_pmu_alias *perf_pmu__find_alias(struct perf_pmu *pmu,
 435						   const char *name,
 436						   bool load)
 437{
 438	struct perf_pmu_alias *alias;
 439
 440	if (load && !pmu->sysfs_aliases_loaded) {
 441		bool has_sysfs_event;
 442		char event_file_name[FILENAME_MAX + 8];
 443
 444		/*
 445		 * Test if alias/event 'name' exists in the PMU's sysfs/events
 446		 * directory. If not skip parsing the sysfs aliases. Sysfs event
 447		 * name must be all lower or all upper case.
 448		 */
 449		scnprintf(event_file_name, sizeof(event_file_name), "events/%s", name);
 450		for (size_t i = 7, n = 7 + strlen(name); i < n; i++)
 451			event_file_name[i] = tolower(event_file_name[i]);
 452
 453		has_sysfs_event = perf_pmu__file_exists(pmu, event_file_name);
 454		if (!has_sysfs_event) {
 455			for (size_t i = 7, n = 7 + strlen(name); i < n; i++)
 456				event_file_name[i] = toupper(event_file_name[i]);
 457
 458			has_sysfs_event = perf_pmu__file_exists(pmu, event_file_name);
 
 
 
 
 
 
 
 
 459		}
 460		if (has_sysfs_event)
 461			pmu_aliases_parse(pmu);
 462
 463	}
 464	list_for_each_entry(alias, &pmu->aliases, list) {
 465		if (!strcasecmp(alias->name, name))
 466			return alias;
 467	}
 468	return NULL;
 469}
 470
 471static bool assign_str(const char *name, const char *field, char **old_str,
 472				const char *new_str)
 473{
 474	if (!*old_str && new_str) {
 475		*old_str = strdup(new_str);
 476		return true;
 477	}
 478
 479	if (!new_str || !strcasecmp(*old_str, new_str))
 480		return false; /* Nothing to update. */
 481
 482	pr_debug("alias %s differs in field '%s' ('%s' != '%s')\n",
 483		name, field, *old_str, new_str);
 484	zfree(old_str);
 485	*old_str = strdup(new_str);
 486	return true;
 487}
 488
 489static void read_alias_info(struct perf_pmu *pmu, struct perf_pmu_alias *alias)
 490{
 491	if (!alias->from_sysfs || alias->info_loaded)
 492		return;
 493
 494	/*
 495	 * load unit name and scale if available
 496	 */
 497	perf_pmu__parse_unit(pmu, alias);
 498	perf_pmu__parse_scale(pmu, alias);
 499	perf_pmu__parse_per_pkg(pmu, alias);
 500	perf_pmu__parse_snapshot(pmu, alias);
 501}
 502
 503struct update_alias_data {
 504	struct perf_pmu *pmu;
 505	struct perf_pmu_alias *alias;
 506};
 507
 508static int update_alias(const struct pmu_event *pe,
 509			const struct pmu_events_table *table __maybe_unused,
 510			void *vdata)
 511{
 512	struct update_alias_data *data = vdata;
 513	int ret = 0;
 514
 515	read_alias_info(data->pmu, data->alias);
 516	assign_str(pe->name, "desc", &data->alias->desc, pe->desc);
 517	assign_str(pe->name, "long_desc", &data->alias->long_desc, pe->long_desc);
 518	assign_str(pe->name, "topic", &data->alias->topic, pe->topic);
 519	data->alias->per_pkg = pe->perpkg;
 520	if (pe->event) {
 521		parse_events_terms__exit(&data->alias->terms);
 522		ret = parse_events_terms(&data->alias->terms, pe->event, /*input=*/NULL);
 523	}
 524	if (!ret && pe->unit) {
 525		char *unit;
 526
 527		ret = perf_pmu__convert_scale(pe->unit, &unit, &data->alias->scale);
 528		if (!ret)
 529			snprintf(data->alias->unit, sizeof(data->alias->unit), "%s", unit);
 530	}
 531	return ret;
 532}
 533
 534static int perf_pmu__new_alias(struct perf_pmu *pmu, const char *name,
 535				const char *desc, const char *val, FILE *val_fd,
 536			        const struct pmu_event *pe, enum event_source src)
 537{
 
 538	struct perf_pmu_alias *alias;
 539	int ret;
 540	const char *long_desc = NULL, *topic = NULL, *unit = NULL, *pmu_name = NULL;
 541	bool deprecated = false, perpkg = false;
 542
 543	if (perf_pmu__find_alias(pmu, name, /*load=*/ false)) {
 544		/* Alias was already created/loaded. */
 545		return 0;
 546	}
 547
 548	if (pe) {
 549		long_desc = pe->long_desc;
 550		topic = pe->topic;
 551		unit = pe->unit;
 552		perpkg = pe->perpkg;
 553		deprecated = pe->deprecated;
 554		pmu_name = pe->pmu;
 
 
 555	}
 556
 557	alias = zalloc(sizeof(*alias));
 558	if (!alias)
 559		return -ENOMEM;
 560
 561	parse_events_terms__init(&alias->terms);
 562	alias->scale = 1.0;
 563	alias->unit[0] = '\0';
 564	alias->per_pkg = perpkg;
 565	alias->snapshot = false;
 566	alias->deprecated = deprecated;
 567
 568	ret = parse_events_terms(&alias->terms, val, val_fd);
 569	if (ret) {
 570		pr_err("Cannot parse alias %s: %d\n", val, ret);
 571		free(alias);
 572		return ret;
 573	}
 574
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 575	alias->name = strdup(name);
 
 
 
 
 
 
 
 
 
 
 
 
 576	alias->desc = desc ? strdup(desc) : NULL;
 577	alias->long_desc = long_desc ? strdup(long_desc) :
 578				desc ? strdup(desc) : NULL;
 579	alias->topic = topic ? strdup(topic) : NULL;
 580	alias->pmu_name = pmu_name ? strdup(pmu_name) : NULL;
 581	if (unit) {
 582		if (perf_pmu__convert_scale(unit, (char **)&unit, &alias->scale) < 0) {
 583			perf_pmu_free_alias(alias);
 584			return -1;
 585		}
 586		snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
 587	}
 588	switch (src) {
 589	default:
 590	case EVENT_SRC_SYSFS:
 591		alias->from_sysfs = true;
 592		if (pmu->events_table) {
 593			/* Update an event from sysfs with json data. */
 594			struct update_alias_data data = {
 595				.pmu = pmu,
 596				.alias = alias,
 597			};
 598			if (pmu_events_table__find_event(pmu->events_table, pmu, name,
 599							 update_alias, &data) == 0)
 600				pmu->cpu_json_aliases++;
 601		}
 602		pmu->sysfs_aliases++;
 603		break;
 604	case  EVENT_SRC_CPU_JSON:
 605		pmu->cpu_json_aliases++;
 606		break;
 607	case  EVENT_SRC_SYS_JSON:
 608		pmu->sys_json_aliases++;
 609		break;
 610
 611	}
 612	list_add_tail(&alias->list, &pmu->aliases);
 613	return 0;
 614}
 615
 616static inline bool pmu_alias_info_file(const char *name)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 617{
 618	size_t len;
 619
 620	len = strlen(name);
 621	if (len > 5 && !strcmp(name + len - 5, ".unit"))
 622		return true;
 623	if (len > 6 && !strcmp(name + len - 6, ".scale"))
 624		return true;
 625	if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
 626		return true;
 627	if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
 628		return true;
 629
 630	return false;
 631}
 632
 633/*
 634 * Reading the pmu event aliases definition, which should be located at:
 635 * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
 636 */
 637static int pmu_aliases_parse(struct perf_pmu *pmu)
 638{
 639	char path[PATH_MAX];
 640	struct dirent *evt_ent;
 641	DIR *event_dir;
 642	size_t len;
 643	int fd, dir_fd;
 644
 645	len = perf_pmu__event_source_devices_scnprintf(path, sizeof(path));
 646	if (!len)
 647		return 0;
 648	scnprintf(path + len, sizeof(path) - len, "%s/events", pmu->name);
 649
 650	dir_fd = open(path, O_DIRECTORY);
 651	if (dir_fd == -1) {
 652		pmu->sysfs_aliases_loaded = true;
 653		return 0;
 654	}
 655
 656	event_dir = fdopendir(dir_fd);
 657	if (!event_dir){
 658		close (dir_fd);
 659		return -EINVAL;
 660	}
 661
 662	while ((evt_ent = readdir(event_dir))) {
 
 663		char *name = evt_ent->d_name;
 664		FILE *file;
 665
 666		if (!strcmp(name, ".") || !strcmp(name, ".."))
 667			continue;
 668
 669		/*
 670		 * skip info files parsed in perf_pmu__new_alias()
 671		 */
 672		if (pmu_alias_info_file(name))
 673			continue;
 674
 675		fd = openat(dir_fd, name, O_RDONLY);
 676		if (fd == -1) {
 677			pr_debug("Cannot open %s\n", name);
 678			continue;
 679		}
 680		file = fdopen(fd, "r");
 681		if (!file) {
 682			close(fd);
 683			continue;
 684		}
 685
 686		if (perf_pmu__new_alias(pmu, name, /*desc=*/ NULL,
 687					/*val=*/ NULL, file, /*pe=*/ NULL,
 688					EVENT_SRC_SYSFS) < 0)
 689			pr_debug("Cannot set up %s\n", name);
 690		fclose(file);
 691	}
 692
 693	closedir(event_dir);
 694	close (dir_fd);
 695	pmu->sysfs_aliases_loaded = true;
 696	return 0;
 697}
 698
 699static int pmu_alias_terms(struct perf_pmu_alias *alias, int err_loc, struct list_head *terms)
 
 
 
 
 700{
 701	struct parse_events_term *term, *cloned;
 702	struct parse_events_terms clone_terms;
 
 
 
 
 
 
 
 
 
 
 
 
 703
 704	parse_events_terms__init(&clone_terms);
 705	list_for_each_entry(term, &alias->terms.terms, list) {
 706		int ret = parse_events_term__clone(&cloned, term);
 
 
 
 
 
 
 707
 
 
 708		if (ret) {
 709			parse_events_terms__exit(&clone_terms);
 710			return ret;
 711		}
 712		/*
 713		 * Weak terms don't override command line options,
 714		 * which we don't want for implicit terms in aliases.
 715		 */
 716		cloned->weak = true;
 717		cloned->err_term = cloned->err_val = err_loc;
 718		list_add_tail(&cloned->list, &clone_terms.terms);
 719	}
 720	list_splice_init(&clone_terms.terms, terms);
 721	parse_events_terms__exit(&clone_terms);
 722	return 0;
 723}
 724
 725/*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 726 * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
 727 * may have a "cpus" file.
 728 */
 729static struct perf_cpu_map *pmu_cpumask(int dirfd, const char *name, bool is_core)
 
 
 
 730{
 
 731	struct perf_cpu_map *cpus;
 
 732	const char *templates[] = {
 733		"cpumask",
 734		"cpus",
 735		NULL
 736	};
 737	const char **template;
 738	char pmu_name[PATH_MAX];
 739	struct perf_pmu pmu = {.name = pmu_name};
 740	FILE *file;
 741
 742	strlcpy(pmu_name, name, sizeof(pmu_name));
 
 
 743	for (template = templates; *template; template++) {
 744		file = perf_pmu__open_file_at(&pmu, dirfd, *template);
 745		if (!file)
 746			continue;
 747		cpus = perf_cpu_map__read(file);
 748		fclose(file);
 749		if (cpus)
 750			return cpus;
 751	}
 752
 753	/* Nothing found, for core PMUs assume this means all CPUs. */
 754	return is_core ? perf_cpu_map__get(cpu_map__online()) : NULL;
 755}
 756
 757static bool pmu_is_uncore(int dirfd, const char *name)
 758{
 759	int fd;
 
 760
 761	fd = perf_pmu__pathname_fd(dirfd, name, "cpumask", O_PATH);
 762	if (fd < 0)
 763		return false;
 764
 765	close(fd);
 766	return true;
 
 767}
 768
 769static char *pmu_id(const char *name)
 770{
 771	char path[PATH_MAX], *str;
 772	size_t len;
 773
 774	perf_pmu__pathname_scnprintf(path, sizeof(path), name, "identifier");
 775
 776	if (filename__read_str(path, &str, &len) < 0)
 777		return NULL;
 778
 779	str[len - 1] = 0; /* remove line feed */
 780
 781	return str;
 782}
 783
 784/**
 785 * is_sysfs_pmu_core() - PMU CORE devices have different name other than cpu in
 786 *         sysfs on some platforms like ARM or Intel hybrid. Looking for
 787 *         possible the cpus file in sysfs files to identify whether this is a
 788 *         core device.
 789 * @name: The PMU name such as "cpu_atom".
 790 */
 791static int is_sysfs_pmu_core(const char *name)
 792{
 793	char path[PATH_MAX];
 
 794
 795	if (!perf_pmu__pathname_scnprintf(path, sizeof(path), name, "cpus"))
 796		return 0;
 
 
 
 
 797	return file_available(path);
 798}
 799
 800char *perf_pmu__getcpuid(struct perf_pmu *pmu)
 801{
 802	char *cpuid;
 803	static bool printed;
 804
 805	cpuid = getenv("PERF_CPUID");
 806	if (cpuid)
 807		cpuid = strdup(cpuid);
 808	if (!cpuid)
 809		cpuid = get_cpuid_str(pmu);
 810	if (!cpuid)
 811		return NULL;
 812
 813	if (!printed) {
 814		pr_debug("Using CPUID %s\n", cpuid);
 815		printed = true;
 816	}
 817	return cpuid;
 818}
 819
 820__weak const struct pmu_metrics_table *pmu_metrics_table__find(void)
 821{
 822	return perf_pmu__find_metrics_table(NULL);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 823}
 824
 825/**
 826 * perf_pmu__match_ignoring_suffix - Does the pmu_name match tok ignoring any
 827 *                                   trailing suffix? The Suffix must be in form
 828 *                                   tok_{digits}, or tok{digits}.
 829 * @pmu_name: The pmu_name with possible suffix.
 830 * @tok: The possible match to pmu_name without suffix.
 831 */
 832static bool perf_pmu__match_ignoring_suffix(const char *pmu_name, const char *tok)
 833{
 834	const char *p;
 835
 836	if (strncmp(pmu_name, tok, strlen(tok)))
 837		return false;
 838
 839	p = pmu_name + strlen(tok);
 840	if (*p == 0)
 841		return true;
 842
 843	if (*p == '_')
 844		++p;
 845
 846	/* Ensure we end in a number */
 847	while (1) {
 848		if (!isdigit(*p))
 849			return false;
 850		if (*(++p) == 0)
 851			break;
 852	}
 853
 854	return true;
 855}
 856
 857/**
 858 * pmu_uncore_alias_match - does name match the PMU name?
 859 * @pmu_name: the json struct pmu_event name. This may lack a suffix (which
 860 *            matches) or be of the form "socket,pmuname" which will match
 861 *            "socketX_pmunameY".
 862 * @name: a real full PMU name as from sysfs.
 863 */
 864static bool pmu_uncore_alias_match(const char *pmu_name, const char *name)
 865{
 866	char *tmp = NULL, *tok, *str;
 867	bool res;
 868
 869	if (strchr(pmu_name, ',') == NULL)
 870		return perf_pmu__match_ignoring_suffix(name, pmu_name);
 871
 872	str = strdup(pmu_name);
 873	if (!str)
 874		return false;
 875
 876	/*
 877	 * uncore alias may be from different PMU with common prefix
 878	 */
 879	tok = strtok_r(str, ",", &tmp);
 880	if (strncmp(pmu_name, tok, strlen(tok))) {
 881		res = false;
 882		goto out;
 883	}
 884
 885	/*
 886	 * Match more complex aliases where the alias name is a comma-delimited
 887	 * list of tokens, orderly contained in the matching PMU name.
 888	 *
 889	 * Example: For alias "socket,pmuname" and PMU "socketX_pmunameY", we
 890	 *	    match "socket" in "socketX_pmunameY" and then "pmuname" in
 891	 *	    "pmunameY".
 892	 */
 893	while (1) {
 894		char *next_tok = strtok_r(NULL, ",", &tmp);
 895
 896		name = strstr(name, tok);
 897		if (!name ||
 898		    (!next_tok && !perf_pmu__match_ignoring_suffix(name, tok))) {
 899			res = false;
 900			goto out;
 901		}
 902		if (!next_tok)
 903			break;
 904		tok = next_tok;
 905		name += strlen(tok);
 906	}
 907
 908	res = true;
 909out:
 910	free(str);
 911	return res;
 912}
 913
 914bool pmu_uncore_identifier_match(const char *compat, const char *id)
 
 
 
 
 
 
 915{
 916	regex_t re;
 917	regmatch_t pmatch[1];
 918	int match;
 919
 920	if (regcomp(&re, compat, REG_EXTENDED) != 0) {
 921		/* Warn unable to generate match particular string. */
 922		pr_info("Invalid regular expression %s\n", compat);
 923		return false;
 924	}
 
 
 
 
 
 
 
 925
 926	match = !regexec(&re, id, 1, pmatch, 0);
 927	if (match) {
 928		/* Ensure a full match. */
 929		match = pmatch[0].rm_so == 0 && (size_t)pmatch[0].rm_eo == strlen(id);
 930	}
 931	regfree(&re);
 932
 933	return match;
 
 
 
 
 
 
 
 
 934}
 935
 936static int pmu_add_cpu_aliases_map_callback(const struct pmu_event *pe,
 937					const struct pmu_events_table *table __maybe_unused,
 938					void *vdata)
 939{
 940	struct perf_pmu *pmu = vdata;
 941
 942	perf_pmu__new_alias(pmu, pe->name, pe->desc, pe->event, /*val_fd=*/ NULL,
 943			    pe, EVENT_SRC_CPU_JSON);
 944	return 0;
 945}
 946
 947/*
 948 * From the pmu_events_table, find the events that correspond to the given
 949 * PMU and add them to the list 'head'.
 950 */
 951void pmu_add_cpu_aliases_table(struct perf_pmu *pmu, const struct pmu_events_table *table)
 952{
 953	pmu_events_table__for_each_event(table, pmu, pmu_add_cpu_aliases_map_callback, pmu);
 954}
 955
 956static void pmu_add_cpu_aliases(struct perf_pmu *pmu)
 957{
 958	if (!pmu->events_table)
 959		return;
 960
 961	if (pmu->cpu_aliases_added)
 962		return;
 
 
 
 
 
 
 963
 964	pmu_add_cpu_aliases_table(pmu, pmu->events_table);
 965	pmu->cpu_aliases_added = true;
 
 
 
 
 
 
 
 
 
 
 966}
 967
 968static int pmu_add_sys_aliases_iter_fn(const struct pmu_event *pe,
 969				       const struct pmu_events_table *table __maybe_unused,
 970				       void *vdata)
 
 
 
 971{
 972	struct perf_pmu *pmu = vdata;
 
 
 
 
 
 
 
 973
 974	if (!pe->compat || !pe->pmu)
 975		return 0;
 976
 977	if (pmu_uncore_alias_match(pe->pmu, pmu->name) &&
 978	    pmu_uncore_identifier_match(pe->compat, pmu->id)) {
 979		perf_pmu__new_alias(pmu,
 980				pe->name,
 981				pe->desc,
 982				pe->event,
 983				/*val_fd=*/ NULL,
 984				pe,
 985				EVENT_SRC_SYS_JSON);
 986	}
 987
 988	return 0;
 989}
 990
 991void pmu_add_sys_aliases(struct perf_pmu *pmu)
 992{
 
 
 
 
 
 993	if (!pmu->id)
 994		return;
 995
 996	pmu_for_each_sys_event(pmu_add_sys_aliases_iter_fn, pmu);
 997}
 998
 999static char *pmu_find_alias_name(struct perf_pmu *pmu, int dirfd)
 
1000{
1001	FILE *file = perf_pmu__open_file_at(pmu, dirfd, "alias");
1002	char *line = NULL;
1003	size_t line_len = 0;
1004	ssize_t ret;
1005
1006	if (!file)
1007		return NULL;
1008
1009	ret = getline(&line, &line_len, file);
1010	if (ret < 0) {
1011		fclose(file);
1012		return NULL;
1013	}
1014	/* Remove trailing newline. */
1015	if (ret > 0 && line[ret - 1] == '\n')
1016		line[--ret] = '\0';
1017
1018	fclose(file);
1019	return line;
1020}
1021
1022static int pmu_max_precise(int dirfd, struct perf_pmu *pmu)
1023{
 
1024	int max_precise = -1;
1025
1026	perf_pmu__scan_file_at(pmu, dirfd, "caps/max_precise", "%d", &max_precise);
1027	return max_precise;
1028}
1029
1030void __weak
1031perf_pmu__arch_init(struct perf_pmu *pmu)
1032{
1033	if (pmu->is_core)
1034		pmu->mem_events = perf_mem_events;
1035}
1036
1037struct perf_pmu *perf_pmu__lookup(struct list_head *pmus, int dirfd, const char *name)
1038{
1039	struct perf_pmu *pmu;
 
 
1040	__u32 type;
1041
1042	pmu = zalloc(sizeof(*pmu));
1043	if (!pmu)
1044		return NULL;
1045
1046	pmu->name = strdup(name);
1047	if (!pmu->name)
1048		goto err;
1049
1050	/*
1051	 * Read type early to fail fast if a lookup name isn't a PMU. Ensure
1052	 * that type value is successfully assigned (return 1).
1053	 */
1054	if (perf_pmu__scan_file_at(pmu, dirfd, "type", "%u", &type) != 1)
1055		goto err;
1056
1057	INIT_LIST_HEAD(&pmu->format);
1058	INIT_LIST_HEAD(&pmu->aliases);
1059	INIT_LIST_HEAD(&pmu->caps);
1060
1061	/*
1062	 * The pmu data we store & need consists of the pmu
1063	 * type value and format definitions. Load both right
1064	 * now.
1065	 */
1066	if (pmu_format(pmu, dirfd, name))
1067		goto err;
1068
1069	pmu->is_core = is_pmu_core(name);
1070	pmu->cpus = pmu_cpumask(dirfd, name, pmu->is_core);
1071
1072	pmu->type = type;
1073	pmu->is_uncore = pmu_is_uncore(dirfd, name);
1074	if (pmu->is_uncore)
1075		pmu->id = pmu_id(name);
1076	pmu->max_precise = pmu_max_precise(dirfd, pmu);
1077	pmu->alias_name = pmu_find_alias_name(pmu, dirfd);
1078	pmu->events_table = perf_pmu__find_events_table(pmu);
1079	/*
1080	 * Load the sys json events/aliases when loading the PMU as each event
1081	 * may have a different compat regular expression. We therefore can't
1082	 * know the number of sys json events/aliases without computing the
1083	 * regular expressions for them all.
1084	 */
1085	pmu_add_sys_aliases(pmu);
1086	list_add_tail(&pmu->list, pmus);
1087
1088	perf_pmu__arch_init(pmu);
1089
1090	return pmu;
1091err:
1092	zfree(&pmu->name);
1093	free(pmu);
1094	return NULL;
1095}
1096
1097/* Creates the PMU when sysfs scanning fails. */
1098struct perf_pmu *perf_pmu__create_placeholder_core_pmu(struct list_head *core_pmus)
1099{
1100	struct perf_pmu *pmu = zalloc(sizeof(*pmu));
1101
1102	if (!pmu)
1103		return NULL;
1104
1105	pmu->name = strdup("cpu");
1106	if (!pmu->name) {
1107		free(pmu);
1108		return NULL;
1109	}
1110
1111	pmu->is_core = true;
1112	pmu->type = PERF_TYPE_RAW;
1113	pmu->cpus = cpu_map__online();
 
 
 
 
 
 
 
1114
1115	INIT_LIST_HEAD(&pmu->format);
1116	INIT_LIST_HEAD(&pmu->aliases);
1117	INIT_LIST_HEAD(&pmu->caps);
1118	list_add_tail(&pmu->list, core_pmus);
 
 
 
 
 
 
 
 
1119	return pmu;
1120}
1121
1122void perf_pmu__warn_invalid_formats(struct perf_pmu *pmu)
1123{
1124	struct perf_pmu_format *format;
1125
1126	if (pmu->formats_checked)
1127		return;
 
1128
1129	pmu->formats_checked = true;
 
1130
1131	/* fake pmu doesn't have format list */
1132	if (pmu == &perf_pmu__fake)
1133		return;
1134
1135	list_for_each_entry(format, &pmu->format, list) {
1136		perf_pmu_format__load(pmu, format);
1137		if (format->value >= PERF_PMU_FORMAT_VALUE_CONFIG_END) {
1138			pr_warning("WARNING: '%s' format '%s' requires 'perf_event_attr::config%d'"
1139				   "which is not supported by this version of perf!\n",
1140				   pmu->name, format->name, format->value);
1141			return;
1142		}
 
 
 
 
 
 
 
 
1143	}
 
 
 
1144}
1145
1146bool evsel__is_aux_event(const struct evsel *evsel)
1147{
1148	struct perf_pmu *pmu = evsel__find_pmu(evsel);
1149
1150	return pmu && pmu->auxtrace;
 
 
 
 
 
1151}
1152
1153/*
1154 * Set @config_name to @val as long as the user hasn't already set or cleared it
1155 * by passing a config term on the command line.
1156 *
1157 * @val is the value to put into the bits specified by @config_name rather than
1158 * the bit pattern. It is shifted into position by this function, so to set
1159 * something to true, pass 1 for val rather than a pre shifted value.
1160 */
1161#define field_prep(_mask, _val) (((_val) << (ffsll(_mask) - 1)) & (_mask))
1162void evsel__set_config_if_unset(struct perf_pmu *pmu, struct evsel *evsel,
1163				const char *config_name, u64 val)
1164{
1165	u64 user_bits = 0, bits;
1166	struct evsel_config_term *term = evsel__get_config_term(evsel, CFG_CHG);
1167
1168	if (term)
1169		user_bits = term->val.cfg_chg;
1170
1171	bits = perf_pmu__format_bits(pmu, config_name);
 
 
1172
1173	/* Do nothing if the user changed the value */
1174	if (bits & user_bits)
1175		return;
 
 
 
 
 
1176
1177	/* Otherwise replace it */
1178	evsel->core.attr.config &= ~bits;
1179	evsel->core.attr.config |= field_prep(bits, val);
1180}
1181
1182static struct perf_pmu_format *
1183pmu_find_format(const struct list_head *formats, const char *name)
1184{
1185	struct perf_pmu_format *format;
1186
1187	list_for_each_entry(format, formats, list)
1188		if (!strcmp(format->name, name))
1189			return format;
1190
1191	return NULL;
1192}
1193
1194__u64 perf_pmu__format_bits(struct perf_pmu *pmu, const char *name)
1195{
1196	struct perf_pmu_format *format = pmu_find_format(&pmu->format, name);
1197	__u64 bits = 0;
1198	int fbit;
1199
1200	if (!format)
1201		return 0;
1202
1203	for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1204		bits |= 1ULL << fbit;
1205
1206	return bits;
1207}
1208
1209int perf_pmu__format_type(struct perf_pmu *pmu, const char *name)
1210{
1211	struct perf_pmu_format *format = pmu_find_format(&pmu->format, name);
1212
1213	if (!format)
1214		return -1;
1215
1216	perf_pmu_format__load(pmu, format);
1217	return format->value;
1218}
1219
1220/*
1221 * Sets value based on the format definition (format parameter)
1222 * and unformatted value (value parameter).
1223 */
1224static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1225			     bool zero)
1226{
1227	unsigned long fbit, vbit;
1228
1229	for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1230
1231		if (!test_bit(fbit, format))
1232			continue;
1233
1234		if (value & (1llu << vbit++))
1235			*v |= (1llu << fbit);
1236		else if (zero)
1237			*v &= ~(1llu << fbit);
1238	}
1239}
1240
1241static __u64 pmu_format_max_value(const unsigned long *format)
1242{
1243	int w;
1244
1245	w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1246	if (!w)
1247		return 0;
1248	if (w < 64)
1249		return (1ULL << w) - 1;
1250	return -1;
1251}
1252
1253/*
1254 * Term is a string term, and might be a param-term. Try to look up it's value
1255 * in the remaining terms.
1256 * - We have a term like "base-or-format-term=param-term",
1257 * - We need to find the value supplied for "param-term" (with param-term named
1258 *   in a config string) later on in the term list.
1259 */
1260static int pmu_resolve_param_term(struct parse_events_term *term,
1261				  struct parse_events_terms *head_terms,
1262				  __u64 *value)
1263{
1264	struct parse_events_term *t;
1265
1266	list_for_each_entry(t, &head_terms->terms, list) {
1267		if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1268		    t->config && !strcmp(t->config, term->config)) {
1269			t->used = true;
1270			*value = t->val.num;
1271			return 0;
1272		}
1273	}
1274
1275	if (verbose > 0)
1276		printf("Required parameter '%s' not specified\n", term->config);
1277
1278	return -1;
1279}
1280
1281static char *pmu_formats_string(const struct list_head *formats)
1282{
1283	struct perf_pmu_format *format;
1284	char *str = NULL;
1285	struct strbuf buf = STRBUF_INIT;
1286	unsigned int i = 0;
1287
1288	if (!formats)
1289		return NULL;
1290
1291	/* sysfs exported terms */
1292	list_for_each_entry(format, formats, list)
1293		if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1294			goto error;
1295
1296	str = strbuf_detach(&buf, NULL);
1297error:
1298	strbuf_release(&buf);
1299
1300	return str;
1301}
1302
1303/*
1304 * Setup one of config[12] attr members based on the
1305 * user input data - term parameter.
1306 */
1307static int pmu_config_term(const struct perf_pmu *pmu,
 
1308			   struct perf_event_attr *attr,
1309			   struct parse_events_term *term,
1310			   struct parse_events_terms *head_terms,
1311			   bool zero, struct parse_events_error *err)
1312{
1313	struct perf_pmu_format *format;
1314	__u64 *vp;
1315	__u64 val, max_val;
1316
1317	/*
1318	 * If this is a parameter we've already used for parameterized-eval,
1319	 * skip it in normal eval.
1320	 */
1321	if (term->used)
1322		return 0;
1323
1324	/*
1325	 * Hardcoded terms should be already in, so nothing
1326	 * to be done for them.
1327	 */
1328	if (parse_events__is_hardcoded_term(term))
1329		return 0;
1330
1331	format = pmu_find_format(&pmu->format, term->config);
1332	if (!format) {
1333		char *pmu_term = pmu_formats_string(&pmu->format);
1334		char *unknown_term;
1335		char *help_msg;
1336
1337		if (asprintf(&unknown_term,
1338				"unknown term '%s' for pmu '%s'",
1339				term->config, pmu->name) < 0)
1340			unknown_term = NULL;
1341		help_msg = parse_events_formats_error_string(pmu_term);
1342		if (err) {
1343			parse_events_error__handle(err, term->err_term,
1344						   unknown_term,
1345						   help_msg);
1346		} else {
1347			pr_debug("%s (%s)\n", unknown_term, help_msg);
1348			free(unknown_term);
1349		}
1350		free(pmu_term);
1351		return -EINVAL;
1352	}
1353	perf_pmu_format__load(pmu, format);
1354	switch (format->value) {
1355	case PERF_PMU_FORMAT_VALUE_CONFIG:
1356		vp = &attr->config;
1357		break;
1358	case PERF_PMU_FORMAT_VALUE_CONFIG1:
1359		vp = &attr->config1;
1360		break;
1361	case PERF_PMU_FORMAT_VALUE_CONFIG2:
1362		vp = &attr->config2;
1363		break;
1364	case PERF_PMU_FORMAT_VALUE_CONFIG3:
1365		vp = &attr->config3;
1366		break;
1367	default:
1368		return -EINVAL;
1369	}
1370
1371	/*
1372	 * Either directly use a numeric term, or try to translate string terms
1373	 * using event parameters.
1374	 */
1375	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1376		if (term->no_value &&
1377		    bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1378			if (err) {
1379				parse_events_error__handle(err, term->err_val,
1380					   strdup("no value assigned for term"),
1381					   NULL);
1382			}
1383			return -EINVAL;
1384		}
1385
1386		val = term->val.num;
1387	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1388		if (strcmp(term->val.str, "?")) {
1389			if (verbose > 0) {
1390				pr_info("Invalid sysfs entry %s=%s\n",
1391						term->config, term->val.str);
1392			}
1393			if (err) {
1394				parse_events_error__handle(err, term->err_val,
1395					strdup("expected numeric value"),
1396					NULL);
1397			}
1398			return -EINVAL;
1399		}
1400
1401		if (pmu_resolve_param_term(term, head_terms, &val))
1402			return -EINVAL;
1403	} else
1404		return -EINVAL;
1405
1406	max_val = pmu_format_max_value(format->bits);
1407	if (val > max_val) {
1408		if (err) {
1409			char *err_str;
1410
1411			parse_events_error__handle(err, term->err_val,
1412				asprintf(&err_str,
1413				    "value too big for format (%s), maximum is %llu",
1414				    format->name, (unsigned long long)max_val) < 0
1415				    ? strdup("value too big for format")
1416				    : err_str,
1417				    NULL);
1418			return -EINVAL;
1419		}
1420		/*
1421		 * Assume we don't care if !err, in which case the value will be
1422		 * silently truncated.
1423		 */
1424	}
1425
1426	pmu_format_value(format->bits, val, vp, zero);
1427	return 0;
1428}
1429
1430int perf_pmu__config_terms(const struct perf_pmu *pmu,
1431			   struct perf_event_attr *attr,
1432			   struct parse_events_terms *terms,
1433			   bool zero, struct parse_events_error *err)
1434{
1435	struct parse_events_term *term;
1436
1437	list_for_each_entry(term, &terms->terms, list) {
1438		if (pmu_config_term(pmu, attr, term, terms, zero, err))
 
1439			return -EINVAL;
1440	}
1441
1442	return 0;
1443}
1444
1445/*
1446 * Configures event's 'attr' parameter based on the:
1447 * 1) users input - specified in terms parameter
1448 * 2) pmu format definitions - specified by pmu parameter
1449 */
1450int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1451		     struct parse_events_terms *head_terms,
1452		     struct parse_events_error *err)
1453{
1454	bool zero = !!pmu->perf_event_attr_init_default;
1455
1456	return perf_pmu__config_terms(pmu, attr, head_terms, zero, err);
 
 
1457}
1458
1459static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1460					     struct parse_events_term *term)
1461{
1462	struct perf_pmu_alias *alias;
1463	const char *name;
1464
1465	if (parse_events__is_hardcoded_term(term))
1466		return NULL;
1467
1468	if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1469		if (!term->no_value)
1470			return NULL;
1471		if (pmu_find_format(&pmu->format, term->config))
1472			return NULL;
1473		name = term->config;
1474
1475	} else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1476		if (strcasecmp(term->config, "event"))
1477			return NULL;
1478		name = term->val.str;
1479	} else {
1480		return NULL;
1481	}
1482
1483	alias = perf_pmu__find_alias(pmu, name, /*load=*/ true);
1484	if (alias || pmu->cpu_aliases_added)
1485		return alias;
1486
1487	/* Alias doesn't exist, try to get it from the json events. */
1488	if (pmu->events_table &&
1489	    pmu_events_table__find_event(pmu->events_table, pmu, name,
1490				         pmu_add_cpu_aliases_map_callback,
1491				         pmu) == 0) {
1492		alias = perf_pmu__find_alias(pmu, name, /*load=*/ false);
1493	}
1494	return alias;
1495}
1496
1497
1498static int check_info_data(struct perf_pmu *pmu,
1499			   struct perf_pmu_alias *alias,
1500			   struct perf_pmu_info *info,
1501			   struct parse_events_error *err,
1502			   int column)
1503{
1504	read_alias_info(pmu, alias);
1505	/*
1506	 * Only one term in event definition can
1507	 * define unit, scale and snapshot, fail
1508	 * if there's more than one.
1509	 */
1510	if (info->unit && alias->unit[0]) {
1511		parse_events_error__handle(err, column,
1512					strdup("Attempt to set event's unit twice"),
1513					NULL);
1514		return -EINVAL;
1515	}
1516	if (info->scale && alias->scale) {
1517		parse_events_error__handle(err, column,
1518					strdup("Attempt to set event's scale twice"),
1519					NULL);
1520		return -EINVAL;
1521	}
1522	if (info->snapshot && alias->snapshot) {
1523		parse_events_error__handle(err, column,
1524					strdup("Attempt to set event snapshot twice"),
1525					NULL);
1526		return -EINVAL;
1527	}
1528
1529	if (alias->unit[0])
1530		info->unit = alias->unit;
1531
1532	if (alias->scale)
1533		info->scale = alias->scale;
1534
1535	if (alias->snapshot)
1536		info->snapshot = alias->snapshot;
1537
1538	return 0;
1539}
1540
1541/*
1542 * Find alias in the terms list and replace it with the terms
1543 * defined for the alias
1544 */
1545int perf_pmu__check_alias(struct perf_pmu *pmu, struct parse_events_terms *head_terms,
1546			  struct perf_pmu_info *info, bool *rewrote_terms,
1547			  struct parse_events_error *err)
1548{
1549	struct parse_events_term *term, *h;
1550	struct perf_pmu_alias *alias;
1551	int ret;
1552
1553	*rewrote_terms = false;
1554	info->per_pkg = false;
1555
1556	/*
1557	 * Mark unit and scale as not set
1558	 * (different from default values, see below)
1559	 */
1560	info->unit     = NULL;
1561	info->scale    = 0.0;
1562	info->snapshot = false;
 
 
1563
1564	list_for_each_entry_safe(term, h, &head_terms->terms, list) {
1565		alias = pmu_find_alias(pmu, term);
1566		if (!alias)
1567			continue;
1568		ret = pmu_alias_terms(alias, term->err_term, &term->list);
1569		if (ret) {
1570			parse_events_error__handle(err, term->err_term,
1571						strdup("Failure to duplicate terms"),
1572						NULL);
1573			return ret;
1574		}
1575		*rewrote_terms = true;
1576		ret = check_info_data(pmu, alias, info, err, term->err_term);
1577		if (ret)
1578			return ret;
1579
1580		if (alias->per_pkg)
1581			info->per_pkg = true;
 
 
1582
1583		list_del_init(&term->list);
1584		parse_events_term__delete(term);
1585	}
1586
1587	/*
1588	 * if no unit or scale found in aliases, then
1589	 * set defaults as for evsel
1590	 * unit cannot left to NULL
1591	 */
1592	if (info->unit == NULL)
1593		info->unit   = "";
1594
1595	if (info->scale == 0.0)
1596		info->scale  = 1.0;
1597
1598	return 0;
1599}
1600
1601struct find_event_args {
1602	const char *event;
1603	void *state;
1604	pmu_event_callback cb;
1605};
1606
1607static int find_event_callback(void *state, struct pmu_event_info *info)
1608{
1609	struct find_event_args *args = state;
 
 
 
 
1610
1611	if (!strcmp(args->event, info->name))
1612		return args->cb(args->state, info);
 
1613
 
1614	return 0;
1615}
1616
1617int perf_pmu__find_event(struct perf_pmu *pmu, const char *event, void *state, pmu_event_callback cb)
1618{
1619	struct find_event_args args = {
1620		.event = event,
1621		.state = state,
1622		.cb = cb,
1623	};
1624
1625	/* Sub-optimal, but function is only used by tests. */
1626	return perf_pmu__for_each_event(pmu, /*skip_duplicate_pmus=*/ false,
1627					&args, find_event_callback);
 
 
 
1628}
1629
1630static void perf_pmu__del_formats(struct list_head *formats)
1631{
1632	struct perf_pmu_format *fmt, *tmp;
1633
1634	list_for_each_entry_safe(fmt, tmp, formats, list) {
1635		list_del(&fmt->list);
1636		zfree(&fmt->name);
1637		free(fmt);
1638	}
1639}
1640
1641bool perf_pmu__has_format(const struct perf_pmu *pmu, const char *name)
1642{
1643	struct perf_pmu_format *format;
1644
1645	list_for_each_entry(format, &pmu->format, list) {
1646		if (!strcmp(format->name, name))
1647			return true;
1648	}
1649	return false;
1650}
1651
1652bool is_pmu_core(const char *name)
1653{
1654	return !strcmp(name, "cpu") || !strcmp(name, "cpum_cf") || is_sysfs_pmu_core(name);
1655}
1656
1657bool perf_pmu__supports_legacy_cache(const struct perf_pmu *pmu)
1658{
1659	return pmu->is_core;
1660}
1661
1662bool perf_pmu__auto_merge_stats(const struct perf_pmu *pmu)
1663{
1664	return !pmu->is_core || perf_pmus__num_core_pmus() == 1;
1665}
1666
1667bool perf_pmu__have_event(struct perf_pmu *pmu, const char *name)
1668{
1669	if (!name)
1670		return false;
1671	if (perf_pmu__find_alias(pmu, name, /*load=*/ true) != NULL)
1672		return true;
1673	if (pmu->cpu_aliases_added || !pmu->events_table)
1674		return false;
1675	return pmu_events_table__find_event(pmu->events_table, pmu, name, NULL, NULL) == 0;
1676}
1677
1678size_t perf_pmu__num_events(struct perf_pmu *pmu)
1679{
1680	size_t nr;
1681
1682	pmu_aliases_parse(pmu);
1683	nr = pmu->sysfs_aliases + pmu->sys_json_aliases;;
1684
1685	if (pmu->cpu_aliases_added)
1686		 nr += pmu->cpu_json_aliases;
1687	else if (pmu->events_table)
1688		nr += pmu_events_table__num_events(pmu->events_table, pmu) - pmu->cpu_json_aliases;
1689	else
1690		assert(pmu->cpu_json_aliases == 0);
1691
1692	return pmu->selectable ? nr + 1 : nr;
1693}
1694
1695static int sub_non_neg(int a, int b)
1696{
1697	if (b > a)
1698		return 0;
1699	return a - b;
1700}
1701
1702static char *format_alias(char *buf, int len, const struct perf_pmu *pmu,
1703			  const struct perf_pmu_alias *alias, bool skip_duplicate_pmus)
1704{
1705	struct parse_events_term *term;
1706	int pmu_name_len = skip_duplicate_pmus
1707		? pmu_name_len_no_suffix(pmu->name, /*num=*/NULL)
1708		: (int)strlen(pmu->name);
1709	int used = snprintf(buf, len, "%.*s/%s", pmu_name_len, pmu->name, alias->name);
1710
1711	list_for_each_entry(term, &alias->terms.terms, list) {
1712		if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1713			used += snprintf(buf + used, sub_non_neg(len, used),
1714					",%s=%s", term->config,
1715					term->val.str);
1716	}
1717
1718	if (sub_non_neg(len, used) > 0) {
1719		buf[used] = '/';
1720		used++;
1721	}
1722	if (sub_non_neg(len, used) > 0) {
1723		buf[used] = '\0';
1724		used++;
1725	} else
1726		buf[len - 1] = '\0';
1727
1728	return buf;
1729}
1730
1731int perf_pmu__for_each_event(struct perf_pmu *pmu, bool skip_duplicate_pmus,
1732			     void *state, pmu_event_callback cb)
1733{
1734	char buf[1024];
1735	struct perf_pmu_alias *event;
1736	struct pmu_event_info info = {
1737		.pmu = pmu,
1738	};
1739	int ret = 0;
1740	struct strbuf sb;
1741
1742	strbuf_init(&sb, /*hint=*/ 0);
1743	pmu_aliases_parse(pmu);
1744	pmu_add_cpu_aliases(pmu);
1745	list_for_each_entry(event, &pmu->aliases, list) {
1746		size_t buf_used;
1747
1748		info.pmu_name = event->pmu_name ?: pmu->name;
1749		info.alias = NULL;
1750		if (event->desc) {
1751			info.name = event->name;
1752			buf_used = 0;
1753		} else {
1754			info.name = format_alias(buf, sizeof(buf), pmu, event,
1755						 skip_duplicate_pmus);
1756			if (pmu->is_core) {
1757				info.alias = info.name;
1758				info.name = event->name;
1759			}
1760			buf_used = strlen(buf) + 1;
1761		}
1762		info.scale_unit = NULL;
1763		if (strlen(event->unit) || event->scale != 1.0) {
1764			info.scale_unit = buf + buf_used;
1765			buf_used += snprintf(buf + buf_used, sizeof(buf) - buf_used,
1766					"%G%s", event->scale, event->unit) + 1;
1767		}
1768		info.desc = event->desc;
1769		info.long_desc = event->long_desc;
1770		info.encoding_desc = buf + buf_used;
1771		parse_events_terms__to_strbuf(&event->terms, &sb);
1772		buf_used += snprintf(buf + buf_used, sizeof(buf) - buf_used,
1773				"%s/%s/", info.pmu_name, sb.buf) + 1;
1774		info.topic = event->topic;
1775		info.str = sb.buf;
1776		info.deprecated = event->deprecated;
1777		ret = cb(state, &info);
1778		if (ret)
1779			goto out;
1780		strbuf_setlen(&sb, /*len=*/ 0);
1781	}
1782	if (pmu->selectable) {
1783		info.name = buf;
1784		snprintf(buf, sizeof(buf), "%s//", pmu->name);
1785		info.alias = NULL;
1786		info.scale_unit = NULL;
1787		info.desc = NULL;
1788		info.long_desc = NULL;
1789		info.encoding_desc = NULL;
1790		info.topic = NULL;
1791		info.pmu_name = pmu->name;
1792		info.deprecated = false;
1793		ret = cb(state, &info);
1794	}
1795out:
1796	strbuf_release(&sb);
1797	return ret;
 
 
 
1798}
1799
1800bool pmu__name_match(const struct perf_pmu *pmu, const char *pmu_name)
1801{
1802	return !strcmp(pmu->name, pmu_name) ||
1803		(pmu->is_uncore && pmu_uncore_alias_match(pmu_name, pmu->name)) ||
1804		/*
1805		 * jevents and tests use default_core as a marker for any core
1806		 * PMU as the PMU name varies across architectures.
1807		 */
1808	        (pmu->is_core && !strcmp(pmu_name, "default_core"));
 
 
 
 
 
 
 
 
 
 
1809}
1810
1811bool perf_pmu__is_software(const struct perf_pmu *pmu)
1812{
1813	const char *known_sw_pmus[] = {
1814		"kprobe",
1815		"msr",
1816		"uprobe",
1817	};
1818
1819	if (pmu->is_core || pmu->is_uncore || pmu->auxtrace)
1820		return false;
1821	switch (pmu->type) {
1822	case PERF_TYPE_HARDWARE:	return false;
1823	case PERF_TYPE_SOFTWARE:	return true;
1824	case PERF_TYPE_TRACEPOINT:	return true;
1825	case PERF_TYPE_HW_CACHE:	return false;
1826	case PERF_TYPE_RAW:		return false;
1827	case PERF_TYPE_BREAKPOINT:	return true;
1828	default: break;
1829	}
1830	for (size_t i = 0; i < ARRAY_SIZE(known_sw_pmus); i++) {
1831		if (!strcmp(pmu->name, known_sw_pmus[i]))
1832			return true;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1833	}
1834	return false;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1835}
1836
1837FILE *perf_pmu__open_file(const struct perf_pmu *pmu, const char *name)
1838{
1839	char path[PATH_MAX];
1840
1841	if (!perf_pmu__pathname_scnprintf(path, sizeof(path), pmu->name, name) ||
1842	    !file_available(path))
1843		return NULL;
1844
1845	return fopen(path, "r");
 
 
 
 
 
 
 
 
1846}
1847
1848FILE *perf_pmu__open_file_at(const struct perf_pmu *pmu, int dirfd, const char *name)
1849{
1850	int fd;
 
1851
1852	fd = perf_pmu__pathname_fd(dirfd, pmu->name, name, O_RDONLY);
1853	if (fd < 0)
1854		return NULL;
1855
1856	return fdopen(fd, "r");
 
 
 
 
1857}
1858
1859int perf_pmu__scan_file(const struct perf_pmu *pmu, const char *name, const char *fmt,
1860			...)
1861{
1862	va_list args;
1863	FILE *file;
1864	int ret = EOF;
1865
1866	va_start(args, fmt);
1867	file = perf_pmu__open_file(pmu, name);
1868	if (file) {
1869		ret = vfscanf(file, fmt, args);
1870		fclose(file);
1871	}
1872	va_end(args);
1873	return ret;
1874}
1875
1876int perf_pmu__scan_file_at(const struct perf_pmu *pmu, int dirfd, const char *name,
1877			   const char *fmt, ...)
1878{
1879	va_list args;
1880	FILE *file;
1881	int ret = EOF;
1882
1883	va_start(args, fmt);
1884	file = perf_pmu__open_file_at(pmu, dirfd, name);
1885	if (file) {
1886		ret = vfscanf(file, fmt, args);
1887		fclose(file);
1888	}
1889	va_end(args);
1890	return ret;
1891}
1892
1893bool perf_pmu__file_exists(const struct perf_pmu *pmu, const char *name)
1894{
1895	char path[PATH_MAX];
1896
1897	if (!perf_pmu__pathname_scnprintf(path, sizeof(path), pmu->name, name))
1898		return false;
1899
1900	return file_available(path);
1901}
1902
1903static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1904{
1905	struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1906
1907	if (!caps)
1908		return -ENOMEM;
1909
1910	caps->name = strdup(name);
1911	if (!caps->name)
1912		goto free_caps;
1913	caps->value = strndup(value, strlen(value) - 1);
1914	if (!caps->value)
1915		goto free_name;
1916	list_add_tail(&caps->list, list);
1917	return 0;
1918
1919free_name:
1920	zfree(&caps->name);
1921free_caps:
1922	free(caps);
1923
1924	return -ENOMEM;
1925}
1926
1927static void perf_pmu__del_caps(struct perf_pmu *pmu)
1928{
1929	struct perf_pmu_caps *caps, *tmp;
1930
1931	list_for_each_entry_safe(caps, tmp, &pmu->caps, list) {
1932		list_del(&caps->list);
1933		zfree(&caps->name);
1934		zfree(&caps->value);
1935		free(caps);
1936	}
1937}
1938
1939/*
1940 * Reading/parsing the given pmu capabilities, which should be located at:
1941 * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1942 * Return the number of capabilities
1943 */
1944int perf_pmu__caps_parse(struct perf_pmu *pmu)
1945{
1946	struct stat st;
1947	char caps_path[PATH_MAX];
 
1948	DIR *caps_dir;
1949	struct dirent *evt_ent;
1950	int caps_fd;
1951
1952	if (pmu->caps_initialized)
1953		return pmu->nr_caps;
1954
1955	pmu->nr_caps = 0;
1956
1957	if (!perf_pmu__pathname_scnprintf(caps_path, sizeof(caps_path), pmu->name, "caps"))
1958		return -1;
1959
1960	if (stat(caps_path, &st) < 0) {
1961		pmu->caps_initialized = true;
 
 
1962		return 0;	/* no error if caps does not exist */
1963	}
1964
1965	caps_dir = opendir(caps_path);
1966	if (!caps_dir)
1967		return -EINVAL;
1968
1969	caps_fd = dirfd(caps_dir);
1970
1971	while ((evt_ent = readdir(caps_dir)) != NULL) {
 
1972		char *name = evt_ent->d_name;
1973		char value[128];
1974		FILE *file;
1975		int fd;
1976
1977		if (!strcmp(name, ".") || !strcmp(name, ".."))
1978			continue;
1979
1980		fd = openat(caps_fd, name, O_RDONLY);
1981		if (fd == -1)
1982			continue;
1983		file = fdopen(fd, "r");
1984		if (!file) {
1985			close(fd);
1986			continue;
1987		}
1988
1989		if (!fgets(value, sizeof(value), file) ||
1990		    (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1991			fclose(file);
1992			continue;
1993		}
1994
1995		pmu->nr_caps++;
1996		fclose(file);
1997	}
1998
1999	closedir(caps_dir);
2000
2001	pmu->caps_initialized = true;
2002	return pmu->nr_caps;
2003}
2004
2005static void perf_pmu__compute_config_masks(struct perf_pmu *pmu)
 
2006{
2007	struct perf_pmu_format *format;
2008
2009	if (pmu->config_masks_computed)
2010		return;
2011
2012	list_for_each_entry(format, &pmu->format, list)	{
2013		unsigned int i;
2014		__u64 *mask;
2015
2016		if (format->value >= PERF_PMU_FORMAT_VALUE_CONFIG_END)
2017			continue;
2018
2019		pmu->config_masks_present = true;
2020		mask = &pmu->config_masks[format->value];
2021
2022		for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
2023			*mask |= 1ULL << i;
2024	}
2025	pmu->config_masks_computed = true;
2026}
2027
2028void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
2029				   const char *name, int config_num,
2030				   const char *config_name)
2031{
2032	__u64 bits;
2033	char buf[100];
2034
2035	perf_pmu__compute_config_masks(pmu);
2036
2037	/*
2038	 * Kernel doesn't export any valid format bits.
2039	 */
2040	if (!pmu->config_masks_present)
2041		return;
2042
2043	bits = config & ~pmu->config_masks[config_num];
2044	if (bits == 0)
2045		return;
2046
2047	bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
2048
2049	pr_warning("WARNING: event '%s' not valid (bits %s of %s "
2050		   "'%llx' not supported by kernel)!\n",
2051		   name ?: "N/A", buf, config_name, config);
2052}
2053
2054int perf_pmu__match(const char *pattern, const char *name, const char *tok)
2055{
2056	if (!name)
2057		return -1;
2058
2059	if (fnmatch(pattern, name, 0))
2060		return -1;
2061
2062	if (tok && !perf_pmu__match_ignoring_suffix(name, tok))
2063		return -1;
2064
2065	return 0;
2066}
2067
2068double __weak perf_pmu__cpu_slots_per_cycle(void)
2069{
2070	return NAN;
2071}
2072
2073int perf_pmu__event_source_devices_scnprintf(char *pathname, size_t size)
2074{
2075	const char *sysfs = sysfs__mountpoint();
2076
2077	if (!sysfs)
2078		return 0;
2079	return scnprintf(pathname, size, "%s/bus/event_source/devices/", sysfs);
2080}
2081
2082int perf_pmu__event_source_devices_fd(void)
2083{
2084	char path[PATH_MAX];
2085	const char *sysfs = sysfs__mountpoint();
2086
2087	if (!sysfs)
2088		return -1;
2089
2090	scnprintf(path, sizeof(path), "%s/bus/event_source/devices/", sysfs);
2091	return open(path, O_DIRECTORY);
2092}
2093
2094/*
2095 * Fill 'buf' with the path to a file or folder in 'pmu_name' in
2096 * sysfs. For example if pmu_name = "cs_etm" and 'filename' = "format"
2097 * then pathname will be filled with
2098 * "/sys/bus/event_source/devices/cs_etm/format"
2099 *
2100 * Return 0 if the sysfs mountpoint couldn't be found, if no characters were
2101 * written or if the buffer size is exceeded.
2102 */
2103int perf_pmu__pathname_scnprintf(char *buf, size_t size,
2104				 const char *pmu_name, const char *filename)
2105{
2106	size_t len;
2107
2108	len = perf_pmu__event_source_devices_scnprintf(buf, size);
2109	if (!len || (len + strlen(pmu_name) + strlen(filename) + 1)  >= size)
2110		return 0;
2111
2112	return scnprintf(buf + len, size - len, "%s/%s", pmu_name, filename);
2113}
2114
2115int perf_pmu__pathname_fd(int dirfd, const char *pmu_name, const char *filename, int flags)
2116{
2117	char path[PATH_MAX];
2118
2119	scnprintf(path, sizeof(path), "%s/%s", pmu_name, filename);
2120	return openat(dirfd, path, flags);
2121}
2122
2123void perf_pmu__delete(struct perf_pmu *pmu)
2124{
2125	perf_pmu__del_formats(&pmu->format);
2126	perf_pmu__del_aliases(pmu);
2127	perf_pmu__del_caps(pmu);
2128
2129	perf_cpu_map__put(pmu->cpus);
2130
2131	zfree(&pmu->name);
2132	zfree(&pmu->alias_name);
2133	zfree(&pmu->id);
2134	free(pmu);
2135}
2136
2137const char *perf_pmu__name_from_config(struct perf_pmu *pmu, u64 config)
2138{
2139	struct perf_pmu_alias *event;
2140
2141	if (!pmu)
2142		return NULL;
2143
2144	pmu_aliases_parse(pmu);
2145	pmu_add_cpu_aliases(pmu);
2146	list_for_each_entry(event, &pmu->aliases, list) {
2147		struct perf_event_attr attr = {.config = 0,};
2148		int ret = perf_pmu__config(pmu, &attr, &event->terms, NULL);
2149
2150		if (ret == 0 && config == attr.config)
2151			return event->name;
2152	}
2153	return NULL;
2154}