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