tools/perf/util/pmu.c

   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
 954         /*
 955          * The pmu data we store & need consists of the pmu
 956          * type value and format definitions. Load both right
 957          * now.
 958          */
 959         if (pmu_format(name, &format))
 960                 return NULL;
 961
 962         /*
 963          * Check the type first to avoid unnecessary work.
 964          */
 965         if (pmu_type(name, &type))
 966                 return NULL;
 967
 968         if (pmu_aliases(name, &aliases))
 969                 return NULL;
 970
 971         pmu = zalloc(sizeof(*pmu));
 972         if (!pmu)
 973                 return NULL;
 974
 975         pmu->cpus = pmu_cpumask(name);
 976         pmu->name = strdup(name);
 977         pmu->type = type;
 978         pmu->is_uncore = pmu_is_uncore(name);
 979         if (pmu->is_uncore)
 980                 pmu->id = pmu_id(name);
 981         pmu->is_hybrid = perf_pmu__hybrid_mounted(name);
 982         pmu->max_precise = pmu_max_precise(name);
 983         pmu_add_cpu_aliases(&aliases, pmu);
 984         pmu_add_sys_aliases(&aliases, pmu);
 985
 986         INIT_LIST_HEAD(&pmu->format);
 987         INIT_LIST_HEAD(&pmu->aliases);
 988         INIT_LIST_HEAD(&pmu->caps);
 989         list_splice(&format, &pmu->format);
 990         list_splice(&aliases, &pmu->aliases);
 991         list_add_tail(&pmu->list, &pmus);
 992
 993         if (pmu->is_hybrid)
 994                 list_add_tail(&pmu->hybrid_list, &perf_pmu__hybrid_pmus);
 995
 996         pmu->default_config = perf_pmu__get_default_config(pmu);
 997
 998         return pmu;
 999 }
1000
1001 static struct perf_pmu *pmu_find(const char *name)
1002 {
1003         struct perf_pmu *pmu;
1004
1005         list_for_each_entry(pmu, &pmus, list)
1006                 if (!strcmp(pmu->name, name))
1007                         return pmu;
1008
1009         return NULL;
1010 }
1011
1012 struct perf_pmu *perf_pmu__find_by_type(unsigned int type)
1013 {
1014         struct perf_pmu *pmu;
1015
1016         list_for_each_entry(pmu, &pmus, list)
1017                 if (pmu->type == type)
1018                         return pmu;
1019
1020         return NULL;
1021 }
1022
1023 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
1024 {
1025         /*
1026          * pmu iterator: If pmu is NULL, we start at the begin,
1027          * otherwise return the next pmu. Returns NULL on end.
1028          */
1029         if (!pmu) {
1030                 pmu_read_sysfs();
1031                 pmu = list_prepare_entry(pmu, &pmus, list);
1032         }
1033         list_for_each_entry_continue(pmu, &pmus, list)
1034                 return pmu;
1035         return NULL;
1036 }
1037
1038 struct perf_pmu *evsel__find_pmu(struct evsel *evsel)
1039 {
1040         struct perf_pmu *pmu = NULL;
1041
1042         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1043                 if (pmu->type == evsel->core.attr.type)
1044                         break;
1045         }
1046
1047         return pmu;
1048 }
1049
1050 bool evsel__is_aux_event(struct evsel *evsel)
1051 {
1052         struct perf_pmu *pmu = evsel__find_pmu(evsel);
1053
1054         return pmu && pmu->auxtrace;
1055 }
1056
1057 struct perf_pmu *perf_pmu__find(const char *name)
1058 {
1059         struct perf_pmu *pmu;
1060
1061         /*
1062          * Once PMU is loaded it stays in the list,
1063          * so we keep us from multiple reading/parsing
1064          * the pmu format definitions.
1065          */
1066         pmu = pmu_find(name);
1067         if (pmu)
1068                 return pmu;
1069
1070         return pmu_lookup(name);
1071 }
1072
1073 static struct perf_pmu_format *
1074 pmu_find_format(struct list_head *formats, const char *name)
1075 {
1076         struct perf_pmu_format *format;
1077
1078         list_for_each_entry(format, formats, list)
1079                 if (!strcmp(format->name, name))
1080                         return format;
1081
1082         return NULL;
1083 }
1084
1085 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
1086 {
1087         struct perf_pmu_format *format = pmu_find_format(formats, name);
1088         __u64 bits = 0;
1089         int fbit;
1090
1091         if (!format)
1092                 return 0;
1093
1094         for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
1095                 bits |= 1ULL << fbit;
1096
1097         return bits;
1098 }
1099
1100 int perf_pmu__format_type(struct list_head *formats, const char *name)
1101 {
1102         struct perf_pmu_format *format = pmu_find_format(formats, name);
1103
1104         if (!format)
1105                 return -1;
1106
1107         return format->value;
1108 }
1109
1110 /*
1111  * Sets value based on the format definition (format parameter)
1112  * and unformatted value (value parameter).
1113  */
1114 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
1115                              bool zero)
1116 {
1117         unsigned long fbit, vbit;
1118
1119         for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
1120
1121                 if (!test_bit(fbit, format))
1122                         continue;
1123
1124                 if (value & (1llu << vbit++))
1125                         *v |= (1llu << fbit);
1126                 else if (zero)
1127                         *v &= ~(1llu << fbit);
1128         }
1129 }
1130
1131 static __u64 pmu_format_max_value(const unsigned long *format)
1132 {
1133         int w;
1134
1135         w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
1136         if (!w)
1137                 return 0;
1138         if (w < 64)
1139                 return (1ULL << w) - 1;
1140         return -1;
1141 }
1142
1143 /*
1144  * Term is a string term, and might be a param-term. Try to look up it's value
1145  * in the remaining terms.
1146  * - We have a term like "base-or-format-term=param-term",
1147  * - We need to find the value supplied for "param-term" (with param-term named
1148  *   in a config string) later on in the term list.
1149  */
1150 static int pmu_resolve_param_term(struct parse_events_term *term,
1151                                   struct list_head *head_terms,
1152                                   __u64 *value)
1153 {
1154         struct parse_events_term *t;
1155
1156         list_for_each_entry(t, head_terms, list) {
1157                 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM &&
1158                     t->config && !strcmp(t->config, term->config)) {
1159                         t->used = true;
1160                         *value = t->val.num;
1161                         return 0;
1162                 }
1163         }
1164
1165         if (verbose > 0)
1166                 printf("Required parameter '%s' not specified\n", term->config);
1167
1168         return -1;
1169 }
1170
1171 static char *pmu_formats_string(struct list_head *formats)
1172 {
1173         struct perf_pmu_format *format;
1174         char *str = NULL;
1175         struct strbuf buf = STRBUF_INIT;
1176         unsigned i = 0;
1177
1178         if (!formats)
1179                 return NULL;
1180
1181         /* sysfs exported terms */
1182         list_for_each_entry(format, formats, list)
1183                 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
1184                         goto error;
1185
1186         str = strbuf_detach(&buf, NULL);
1187 error:
1188         strbuf_release(&buf);
1189
1190         return str;
1191 }
1192
1193 /*
1194  * Setup one of config[12] attr members based on the
1195  * user input data - term parameter.
1196  */
1197 static int pmu_config_term(const char *pmu_name,
1198                            struct list_head *formats,
1199                            struct perf_event_attr *attr,
1200                            struct parse_events_term *term,
1201                            struct list_head *head_terms,
1202                            bool zero, struct parse_events_error *err)
1203 {
1204         struct perf_pmu_format *format;
1205         __u64 *vp;
1206         __u64 val, max_val;
1207
1208         /*
1209          * If this is a parameter we've already used for parameterized-eval,
1210          * skip it in normal eval.
1211          */
1212         if (term->used)
1213                 return 0;
1214
1215         /*
1216          * Hardcoded terms should be already in, so nothing
1217          * to be done for them.
1218          */
1219         if (parse_events__is_hardcoded_term(term))
1220                 return 0;
1221
1222         format = pmu_find_format(formats, term->config);
1223         if (!format) {
1224                 char *pmu_term = pmu_formats_string(formats);
1225                 char *unknown_term;
1226                 char *help_msg;
1227
1228                 if (asprintf(&unknown_term,
1229                                 "unknown term '%s' for pmu '%s'",
1230                                 term->config, pmu_name) < 0)
1231                         unknown_term = NULL;
1232                 help_msg = parse_events_formats_error_string(pmu_term);
1233                 if (err) {
1234                         parse_events__handle_error(err, term->err_term,
1235                                                    unknown_term,
1236                                                    help_msg);
1237                 } else {
1238                         pr_debug("%s (%s)\n", unknown_term, help_msg);
1239                         free(unknown_term);
1240                 }
1241                 free(pmu_term);
1242                 return -EINVAL;
1243         }
1244
1245         switch (format->value) {
1246         case PERF_PMU_FORMAT_VALUE_CONFIG:
1247                 vp = &attr->config;
1248                 break;
1249         case PERF_PMU_FORMAT_VALUE_CONFIG1:
1250                 vp = &attr->config1;
1251                 break;
1252         case PERF_PMU_FORMAT_VALUE_CONFIG2:
1253                 vp = &attr->config2;
1254                 break;
1255         default:
1256                 return -EINVAL;
1257         }
1258
1259         /*
1260          * Either directly use a numeric term, or try to translate string terms
1261          * using event parameters.
1262          */
1263         if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1264                 if (term->no_value &&
1265                     bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1266                         if (err) {
1267                                 parse_events__handle_error(err, term->err_val,
1268                                            strdup("no value assigned for term"),
1269                                            NULL);
1270                         }
1271                         return -EINVAL;
1272                 }
1273
1274                 val = term->val.num;
1275         } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1276                 if (strcmp(term->val.str, "?")) {
1277                         if (verbose > 0) {
1278                                 pr_info("Invalid sysfs entry %s=%s\n",
1279                                                 term->config, term->val.str);
1280                         }
1281                         if (err) {
1282                                 parse_events__handle_error(err, term->err_val,
1283                                         strdup("expected numeric value"),
1284                                         NULL);
1285                         }
1286                         return -EINVAL;
1287                 }
1288
1289                 if (pmu_resolve_param_term(term, head_terms, &val))
1290                         return -EINVAL;
1291         } else
1292                 return -EINVAL;
1293
1294         max_val = pmu_format_max_value(format->bits);
1295         if (val > max_val) {
1296                 if (err) {
1297                         char *err_str;
1298
1299                         parse_events__handle_error(err, term->err_val,
1300                                 asprintf(&err_str,
1301                                     "value too big for format, maximum is %llu",
1302                                     (unsigned long long)max_val) < 0
1303                                     ? strdup("value too big for format")
1304                                     : err_str,
1305                                     NULL);
1306                         return -EINVAL;
1307                 }
1308                 /*
1309                  * Assume we don't care if !err, in which case the value will be
1310                  * silently truncated.
1311                  */
1312         }
1313
1314         pmu_format_value(format->bits, val, vp, zero);
1315         return 0;
1316 }
1317
1318 int perf_pmu__config_terms(const char *pmu_name, struct list_head *formats,
1319                            struct perf_event_attr *attr,
1320                            struct list_head *head_terms,
1321                            bool zero, struct parse_events_error *err)
1322 {
1323         struct parse_events_term *term;
1324
1325         list_for_each_entry(term, head_terms, list) {
1326                 if (pmu_config_term(pmu_name, formats, attr, term, head_terms,
1327                                     zero, err))
1328                         return -EINVAL;
1329         }
1330
1331         return 0;
1332 }
1333
1334 /*
1335  * Configures event's 'attr' parameter based on the:
1336  * 1) users input - specified in terms parameter
1337  * 2) pmu format definitions - specified by pmu parameter
1338  */
1339 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1340                      struct list_head *head_terms,
1341                      struct parse_events_error *err)
1342 {
1343         bool zero = !!pmu->default_config;
1344
1345         attr->type = pmu->type;
1346         return perf_pmu__config_terms(pmu->name, &pmu->format, attr,
1347                                       head_terms, zero, err);
1348 }
1349
1350 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1351                                              struct parse_events_term *term)
1352 {
1353         struct perf_pmu_alias *alias;
1354         char *name;
1355
1356         if (parse_events__is_hardcoded_term(term))
1357                 return NULL;
1358
1359         if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1360                 if (term->val.num != 1)
1361                         return NULL;
1362                 if (pmu_find_format(&pmu->format, term->config))
1363                         return NULL;
1364                 name = term->config;
1365         } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1366                 if (strcasecmp(term->config, "event"))
1367                         return NULL;
1368                 name = term->val.str;
1369         } else {
1370                 return NULL;
1371         }
1372
1373         list_for_each_entry(alias, &pmu->aliases, list) {
1374                 if (!strcasecmp(alias->name, name))
1375                         return alias;
1376         }
1377         return NULL;
1378 }
1379
1380
1381 static int check_info_data(struct perf_pmu_alias *alias,
1382                            struct perf_pmu_info *info)
1383 {
1384         /*
1385          * Only one term in event definition can
1386          * define unit, scale and snapshot, fail
1387          * if there's more than one.
1388          */
1389         if ((info->unit && alias->unit[0]) ||
1390             (info->scale && alias->scale) ||
1391             (info->snapshot && alias->snapshot))
1392                 return -EINVAL;
1393
1394         if (alias->unit[0])
1395                 info->unit = alias->unit;
1396
1397         if (alias->scale)
1398                 info->scale = alias->scale;
1399
1400         if (alias->snapshot)
1401                 info->snapshot = alias->snapshot;
1402
1403         return 0;
1404 }
1405
1406 /*
1407  * Find alias in the terms list and replace it with the terms
1408  * defined for the alias
1409  */
1410 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1411                           struct perf_pmu_info *info)
1412 {
1413         struct parse_events_term *term, *h;
1414         struct perf_pmu_alias *alias;
1415         int ret;
1416
1417         info->per_pkg = false;
1418
1419         /*
1420          * Mark unit and scale as not set
1421          * (different from default values, see below)
1422          */
1423         info->unit     = NULL;
1424         info->scale    = 0.0;
1425         info->snapshot = false;
1426         info->metric_expr = NULL;
1427         info->metric_name = NULL;
1428
1429         list_for_each_entry_safe(term, h, head_terms, list) {
1430                 alias = pmu_find_alias(pmu, term);
1431                 if (!alias)
1432                         continue;
1433                 ret = pmu_alias_terms(alias, &term->list);
1434                 if (ret)
1435                         return ret;
1436
1437                 ret = check_info_data(alias, info);
1438                 if (ret)
1439                         return ret;
1440
1441                 if (alias->per_pkg)
1442                         info->per_pkg = true;
1443                 info->metric_expr = alias->metric_expr;
1444                 info->metric_name = alias->metric_name;
1445
1446                 list_del_init(&term->list);
1447                 parse_events_term__delete(term);
1448         }
1449
1450         /*
1451          * if no unit or scale found in aliases, then
1452          * set defaults as for evsel
1453          * unit cannot left to NULL
1454          */
1455         if (info->unit == NULL)
1456                 info->unit   = "";
1457
1458         if (info->scale == 0.0)
1459                 info->scale  = 1.0;
1460
1461         return 0;
1462 }
1463
1464 int perf_pmu__new_format(struct list_head *list, char *name,
1465                          int config, unsigned long *bits)
1466 {
1467         struct perf_pmu_format *format;
1468
1469         format = zalloc(sizeof(*format));
1470         if (!format)
1471                 return -ENOMEM;
1472
1473         format->name = strdup(name);
1474         format->value = config;
1475         memcpy(format->bits, bits, sizeof(format->bits));
1476
1477         list_add_tail(&format->list, list);
1478         return 0;
1479 }
1480
1481 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1482 {
1483         long b;
1484
1485         if (!to)
1486                 to = from;
1487
1488         memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1489         for (b = from; b <= to; b++)
1490                 set_bit(b, bits);
1491 }
1492
1493 void perf_pmu__del_formats(struct list_head *formats)
1494 {
1495         struct perf_pmu_format *fmt, *tmp;
1496
1497         list_for_each_entry_safe(fmt, tmp, formats, list) {
1498                 list_del(&fmt->list);
1499                 free(fmt->name);
1500                 free(fmt);
1501         }
1502 }
1503
1504 static int sub_non_neg(int a, int b)
1505 {
1506         if (b > a)
1507                 return 0;
1508         return a - b;
1509 }
1510
1511 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1512                           struct perf_pmu_alias *alias)
1513 {
1514         struct parse_events_term *term;
1515         int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1516
1517         list_for_each_entry(term, &alias->terms, list) {
1518                 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1519                         used += snprintf(buf + used, sub_non_neg(len, used),
1520                                         ",%s=%s", term->config,
1521                                         term->val.str);
1522         }
1523
1524         if (sub_non_neg(len, used) > 0) {
1525                 buf[used] = '/';
1526                 used++;
1527         }
1528         if (sub_non_neg(len, used) > 0) {
1529                 buf[used] = '\0';
1530                 used++;
1531         } else
1532                 buf[len - 1] = '\0';
1533
1534         return buf;
1535 }
1536
1537 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1538                              struct perf_pmu_alias *alias)
1539 {
1540         snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1541         return buf;
1542 }
1543
1544 struct sevent {
1545         char *name;
1546         char *desc;
1547         char *topic;
1548         char *str;
1549         char *pmu;
1550         char *metric_expr;
1551         char *metric_name;
1552         int is_cpu;
1553 };
1554
1555 static int cmp_sevent(const void *a, const void *b)
1556 {
1557         const struct sevent *as = a;
1558         const struct sevent *bs = b;
1559
1560         /* Put extra events last */
1561         if (!!as->desc != !!bs->desc)
1562                 return !!as->desc - !!bs->desc;
1563         if (as->topic && bs->topic) {
1564                 int n = strcmp(as->topic, bs->topic);
1565
1566                 if (n)
1567                         return n;
1568         }
1569
1570         /* Order CPU core events to be first */
1571         if (as->is_cpu != bs->is_cpu)
1572                 return bs->is_cpu - as->is_cpu;
1573
1574         return strcmp(as->name, bs->name);
1575 }
1576
1577 static void wordwrap(char *s, int start, int max, int corr)
1578 {
1579         int column = start;
1580         int n;
1581
1582         while (*s) {
1583                 int wlen = strcspn(s, " \t");
1584
1585                 if (column + wlen >= max && column > start) {
1586                         printf("\n%*s", start, "");
1587                         column = start + corr;
1588                 }
1589                 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1590                 if (n <= 0)
1591                         break;
1592                 s += wlen;
1593                 column += n;
1594                 s = skip_spaces(s);
1595         }
1596 }
1597
1598 bool is_pmu_core(const char *name)
1599 {
1600         return !strcmp(name, "cpu") || is_arm_pmu_core(name);
1601 }
1602
1603 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1604                         bool long_desc, bool details_flag, bool deprecated)
1605 {
1606         struct perf_pmu *pmu;
1607         struct perf_pmu_alias *alias;
1608         char buf[1024];
1609         int printed = 0;
1610         int len, j;
1611         struct sevent *aliases;
1612         int numdesc = 0;
1613         int columns = pager_get_columns();
1614         char *topic = NULL;
1615
1616         pmu = NULL;
1617         len = 0;
1618         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1619                 list_for_each_entry(alias, &pmu->aliases, list)
1620                         len++;
1621                 if (pmu->selectable)
1622                         len++;
1623         }
1624         aliases = zalloc(sizeof(struct sevent) * len);
1625         if (!aliases)
1626                 goto out_enomem;
1627         pmu = NULL;
1628         j = 0;
1629         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1630                 list_for_each_entry(alias, &pmu->aliases, list) {
1631                         char *name = alias->desc ? alias->name :
1632                                 format_alias(buf, sizeof(buf), pmu, alias);
1633                         bool is_cpu = is_pmu_core(pmu->name);
1634
1635                         if (alias->deprecated && !deprecated)
1636                                 continue;
1637
1638                         if (event_glob != NULL &&
1639                             !(strglobmatch_nocase(name, event_glob) ||
1640                               (!is_cpu && strglobmatch_nocase(alias->name,
1641                                                        event_glob)) ||
1642                               (alias->topic &&
1643                                strglobmatch_nocase(alias->topic, event_glob))))
1644                                 continue;
1645
1646                         if (is_cpu && !name_only && !alias->desc)
1647                                 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1648
1649                         aliases[j].name = name;
1650                         if (is_cpu && !name_only && !alias->desc)
1651                                 aliases[j].name = format_alias_or(buf,
1652                                                                   sizeof(buf),
1653                                                                   pmu, alias);
1654                         aliases[j].name = strdup(aliases[j].name);
1655                         if (!aliases[j].name)
1656                                 goto out_enomem;
1657
1658                         aliases[j].desc = long_desc ? alias->long_desc :
1659                                                 alias->desc;
1660                         aliases[j].topic = alias->topic;
1661                         aliases[j].str = alias->str;
1662                         aliases[j].pmu = pmu->name;
1663                         aliases[j].metric_expr = alias->metric_expr;
1664                         aliases[j].metric_name = alias->metric_name;
1665                         aliases[j].is_cpu = is_cpu;
1666                         j++;
1667                 }
1668                 if (pmu->selectable &&
1669                     (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1670                         char *s;
1671                         if (asprintf(&s, "%s//", pmu->name) < 0)
1672                                 goto out_enomem;
1673                         aliases[j].name = s;
1674                         j++;
1675                 }
1676         }
1677         len = j;
1678         qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1679         for (j = 0; j < len; j++) {
1680                 /* Skip duplicates */
1681                 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1682                         continue;
1683                 if (name_only) {
1684                         printf("%s ", aliases[j].name);
1685                         continue;
1686                 }
1687                 if (aliases[j].desc && !quiet_flag) {
1688                         if (numdesc++ == 0)
1689                                 printf("\n");
1690                         if (aliases[j].topic && (!topic ||
1691                                         strcmp(topic, aliases[j].topic))) {
1692                                 printf("%s%s:\n", topic ? "\n" : "",
1693                                                 aliases[j].topic);
1694                                 topic = aliases[j].topic;
1695                         }
1696                         printf("  %-50s\n", aliases[j].name);
1697                         printf("%*s", 8, "[");
1698                         wordwrap(aliases[j].desc, 8, columns, 0);
1699                         printf("]\n");
1700                         if (details_flag) {
1701                                 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1702                                 if (aliases[j].metric_name)
1703                                         printf(" MetricName: %s", aliases[j].metric_name);
1704                                 if (aliases[j].metric_expr)
1705                                         printf(" MetricExpr: %s", aliases[j].metric_expr);
1706                                 putchar('\n');
1707                         }
1708                 } else
1709                         printf("  %-50s [Kernel PMU event]\n", aliases[j].name);
1710                 printed++;
1711         }
1712         if (printed && pager_in_use())
1713                 printf("\n");
1714 out_free:
1715         for (j = 0; j < len; j++)
1716                 zfree(&aliases[j].name);
1717         zfree(&aliases);
1718         return;
1719
1720 out_enomem:
1721         printf("FATAL: not enough memory to print PMU events\n");
1722         if (aliases)
1723                 goto out_free;
1724 }
1725
1726 bool pmu_have_event(const char *pname, const char *name)
1727 {
1728         struct perf_pmu *pmu;
1729         struct perf_pmu_alias *alias;
1730
1731         pmu = NULL;
1732         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1733                 if (strcmp(pname, pmu->name))
1734                         continue;
1735                 list_for_each_entry(alias, &pmu->aliases, list)
1736                         if (!strcmp(alias->name, name))
1737                                 return true;
1738         }
1739         return false;
1740 }
1741
1742 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1743 {
1744         char path[PATH_MAX];
1745         const char *sysfs;
1746
1747         sysfs = sysfs__mountpoint();
1748         if (!sysfs)
1749                 return NULL;
1750
1751         snprintf(path, PATH_MAX,
1752                  "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1753         if (!file_available(path))
1754                 return NULL;
1755         return fopen(path, "r");
1756 }
1757
1758 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1759                         ...)
1760 {
1761         va_list args;
1762         FILE *file;
1763         int ret = EOF;
1764
1765         va_start(args, fmt);
1766         file = perf_pmu__open_file(pmu, name);
1767         if (file) {
1768                 ret = vfscanf(file, fmt, args);
1769                 fclose(file);
1770         }
1771         va_end(args);
1772         return ret;
1773 }
1774
1775 static int perf_pmu__new_caps(struct list_head *list, char *name, char *value)
1776 {
1777         struct perf_pmu_caps *caps = zalloc(sizeof(*caps));
1778
1779         if (!caps)
1780                 return -ENOMEM;
1781
1782         caps->name = strdup(name);
1783         if (!caps->name)
1784                 goto free_caps;
1785         caps->value = strndup(value, strlen(value) - 1);
1786         if (!caps->value)
1787                 goto free_name;
1788         list_add_tail(&caps->list, list);
1789         return 0;
1790
1791 free_name:
1792         zfree(caps->name);
1793 free_caps:
1794         free(caps);
1795
1796         return -ENOMEM;
1797 }
1798
1799 /*
1800  * Reading/parsing the given pmu capabilities, which should be located at:
1801  * /sys/bus/event_source/devices/<dev>/caps as sysfs group attributes.
1802  * Return the number of capabilities
1803  */
1804 int perf_pmu__caps_parse(struct perf_pmu *pmu)
1805 {
1806         struct stat st;
1807         char caps_path[PATH_MAX];
1808         const char *sysfs = sysfs__mountpoint();
1809         DIR *caps_dir;
1810         struct dirent *evt_ent;
1811         int nr_caps = 0;
1812
1813         if (!sysfs)
1814                 return -1;
1815
1816         snprintf(caps_path, PATH_MAX,
1817                  "%s" EVENT_SOURCE_DEVICE_PATH "%s/caps", sysfs, pmu->name);
1818
1819         if (stat(caps_path, &st) < 0)
1820                 return 0;       /* no error if caps does not exist */
1821
1822         caps_dir = opendir(caps_path);
1823         if (!caps_dir)
1824                 return -EINVAL;
1825
1826         while ((evt_ent = readdir(caps_dir)) != NULL) {
1827                 char path[PATH_MAX + NAME_MAX + 1];
1828                 char *name = evt_ent->d_name;
1829                 char value[128];
1830                 FILE *file;
1831
1832                 if (!strcmp(name, ".") || !strcmp(name, ".."))
1833                         continue;
1834
1835                 snprintf(path, sizeof(path), "%s/%s", caps_path, name);
1836
1837                 file = fopen(path, "r");
1838                 if (!file)
1839                         continue;
1840
1841                 if (!fgets(value, sizeof(value), file) ||
1842                     (perf_pmu__new_caps(&pmu->caps, name, value) < 0)) {
1843                         fclose(file);
1844                         continue;
1845                 }
1846
1847                 nr_caps++;
1848                 fclose(file);
1849         }
1850
1851         closedir(caps_dir);
1852
1853         return nr_caps;
1854 }
1855
1856 void perf_pmu__warn_invalid_config(struct perf_pmu *pmu, __u64 config,
1857                                    char *name)
1858 {
1859         struct perf_pmu_format *format;
1860         __u64 masks = 0, bits;
1861         char buf[100];
1862         unsigned int i;
1863
1864         list_for_each_entry(format, &pmu->format, list) {
1865                 if (format->value != PERF_PMU_FORMAT_VALUE_CONFIG)
1866                         continue;
1867
1868                 for_each_set_bit(i, format->bits, PERF_PMU_FORMAT_BITS)
1869                         masks |= 1ULL << i;
1870         }
1871
1872         /*
1873          * Kernel doesn't export any valid format bits.
1874          */
1875         if (masks == 0)
1876                 return;
1877
1878         bits = config & ~masks;
1879         if (bits == 0)
1880                 return;
1881
1882         bitmap_scnprintf((unsigned long *)&bits, sizeof(bits) * 8, buf, sizeof(buf));
1883
1884         pr_warning("WARNING: event '%s' not valid (bits %s of config "
1885                    "'%llx' not supported by kernel)!\n",
1886                    name ?: "N/A", buf, config);
1887 }
1888
1889 bool perf_pmu__has_hybrid(void)
1890 {
1891         if (!hybrid_scanned) {
1892                 hybrid_scanned = true;
1893                 perf_pmu__scan(NULL);
1894         }
1895
1896         return !list_empty(&perf_pmu__hybrid_pmus);
1897 }
1898
1899 int perf_pmu__match(char *pattern, char *name, char *tok)
1900 {
1901         if (fnmatch(pattern, name, 0))
1902                 return -1;
1903
1904         if (tok && !perf_pmu__valid_suffix(name, tok))
1905                 return -1;
1906
1907         return 0;
1908 }