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