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