tools/perf/util/pmu.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/list.h>
   3 #include <linux/compiler.h>
   4 #include <sys/types.h>
   5 #include <errno.h>
   6 #include <fcntl.h>
   7 #include <sys/stat.h>
   8 #include <unistd.h>
   9 #include <stdio.h>
  10 #include <stdbool.h>
  11 #include <stdarg.h>
  12 #include <dirent.h>
  13 #include <api/fs/fs.h>
  14 #include <locale.h>
  15 #include <regex.h>
  16 #include "util.h"
  17 #include "pmu.h"
  18 #include "parse-events.h"
  19 #include "cpumap.h"
  20 #include "header.h"
  21 #include "pmu-events/pmu-events.h"
  22 #include "cache.h"
  23 #include "string2.h"
  24
  25 struct perf_pmu_format {
  26         char *name;
  27         int value;
  28         DECLARE_BITMAP(bits, PERF_PMU_FORMAT_BITS);
  29         struct list_head list;
  30 };
  31
  32 int perf_pmu_parse(struct list_head *list, char *name);
  33 extern FILE *perf_pmu_in;
  34
  35 static LIST_HEAD(pmus);
  36
  37 /*
  38  * Parse & process all the sysfs attributes located under
  39  * the directory specified in 'dir' parameter.
  40  */
  41 int perf_pmu__format_parse(char *dir, struct list_head *head)
  42 {
  43         struct dirent *evt_ent;
  44         DIR *format_dir;
  45         int ret = 0;
  46
  47         format_dir = opendir(dir);
  48         if (!format_dir)
  49                 return -EINVAL;
  50
  51         while (!ret && (evt_ent = readdir(format_dir))) {
  52                 char path[PATH_MAX];
  53                 char *name = evt_ent->d_name;
  54                 FILE *file;
  55
  56                 if (!strcmp(name, ".") || !strcmp(name, ".."))
  57                         continue;
  58
  59                 snprintf(path, PATH_MAX, "%s/%s", dir, name);
  60
  61                 ret = -EINVAL;
  62                 file = fopen(path, "r");
  63                 if (!file)
  64                         break;
  65
  66                 perf_pmu_in = file;
  67                 ret = perf_pmu_parse(head, name);
  68                 fclose(file);
  69         }
  70
  71         closedir(format_dir);
  72         return ret;
  73 }
  74
  75 /*
  76  * Reading/parsing the default pmu format definition, which should be
  77  * located at:
  78  * /sys/bus/event_source/devices/<dev>/format as sysfs group attributes.
  79  */
  80 static int pmu_format(const char *name, struct list_head *format)
  81 {
  82         struct stat st;
  83         char path[PATH_MAX];
  84         const char *sysfs = sysfs__mountpoint();
  85
  86         if (!sysfs)
  87                 return -1;
  88
  89         snprintf(path, PATH_MAX,
  90                  "%s" EVENT_SOURCE_DEVICE_PATH "%s/format", sysfs, name);
  91
  92         if (stat(path, &st) < 0)
  93                 return 0;       /* no error if format does not exist */
  94
  95         if (perf_pmu__format_parse(path, format))
  96                 return -1;
  97
  98         return 0;
  99 }
 100
 101 static int convert_scale(const char *scale, char **end, double *sval)
 102 {
 103         char *lc;
 104         int ret = 0;
 105
 106         /*
 107          * save current locale
 108          */
 109         lc = setlocale(LC_NUMERIC, NULL);
 110
 111         /*
 112          * The lc string may be allocated in static storage,
 113          * so get a dynamic copy to make it survive setlocale
 114          * call below.
 115          */
 116         lc = strdup(lc);
 117         if (!lc) {
 118                 ret = -ENOMEM;
 119                 goto out;
 120         }
 121
 122         /*
 123          * force to C locale to ensure kernel
 124          * scale string is converted correctly.
 125          * kernel uses default C locale.
 126          */
 127         setlocale(LC_NUMERIC, "C");
 128
 129         *sval = strtod(scale, end);
 130
 131 out:
 132         /* restore locale */
 133         setlocale(LC_NUMERIC, lc);
 134         free(lc);
 135         return ret;
 136 }
 137
 138 static int perf_pmu__parse_scale(struct perf_pmu_alias *alias, char *dir, char *name)
 139 {
 140         struct stat st;
 141         ssize_t sret;
 142         char scale[128];
 143         int fd, ret = -1;
 144         char path[PATH_MAX];
 145
 146         scnprintf(path, PATH_MAX, "%s/%s.scale", dir, name);
 147
 148         fd = open(path, O_RDONLY);
 149         if (fd == -1)
 150                 return -1;
 151
 152         if (fstat(fd, &st) < 0)
 153                 goto error;
 154
 155         sret = read(fd, scale, sizeof(scale)-1);
 156         if (sret < 0)
 157                 goto error;
 158
 159         if (scale[sret - 1] == '\n')
 160                 scale[sret - 1] = '\0';
 161         else
 162                 scale[sret] = '\0';
 163
 164         ret = convert_scale(scale, NULL, &alias->scale);
 165 error:
 166         close(fd);
 167         return ret;
 168 }
 169
 170 static int perf_pmu__parse_unit(struct perf_pmu_alias *alias, char *dir, char *name)
 171 {
 172         char path[PATH_MAX];
 173         ssize_t sret;
 174         int fd;
 175
 176         scnprintf(path, PATH_MAX, "%s/%s.unit", dir, name);
 177
 178         fd = open(path, O_RDONLY);
 179         if (fd == -1)
 180                 return -1;
 181
 182         sret = read(fd, alias->unit, UNIT_MAX_LEN);
 183         if (sret < 0)
 184                 goto error;
 185
 186         close(fd);
 187
 188         if (alias->unit[sret - 1] == '\n')
 189                 alias->unit[sret - 1] = '\0';
 190         else
 191                 alias->unit[sret] = '\0';
 192
 193         return 0;
 194 error:
 195         close(fd);
 196         alias->unit[0] = '\0';
 197         return -1;
 198 }
 199
 200 static int
 201 perf_pmu__parse_per_pkg(struct perf_pmu_alias *alias, char *dir, char *name)
 202 {
 203         char path[PATH_MAX];
 204         int fd;
 205
 206         scnprintf(path, PATH_MAX, "%s/%s.per-pkg", dir, name);
 207
 208         fd = open(path, O_RDONLY);
 209         if (fd == -1)
 210                 return -1;
 211
 212         close(fd);
 213
 214         alias->per_pkg = true;
 215         return 0;
 216 }
 217
 218 static int perf_pmu__parse_snapshot(struct perf_pmu_alias *alias,
 219                                     char *dir, char *name)
 220 {
 221         char path[PATH_MAX];
 222         int fd;
 223
 224         scnprintf(path, PATH_MAX, "%s/%s.snapshot", dir, name);
 225
 226         fd = open(path, O_RDONLY);
 227         if (fd == -1)
 228                 return -1;
 229
 230         alias->snapshot = true;
 231         close(fd);
 232         return 0;
 233 }
 234
 235 static void perf_pmu_assign_str(char *name, const char *field, char **old_str,
 236                                 char **new_str)
 237 {
 238         if (!*old_str)
 239                 goto set_new;
 240
 241         if (*new_str) { /* Have new string, check with old */
 242                 if (strcasecmp(*old_str, *new_str))
 243                         pr_debug("alias %s differs in field '%s'\n",
 244                                  name, field);
 245                 zfree(old_str);
 246         } else          /* Nothing new --> keep old string */
 247                 return;
 248 set_new:
 249         *old_str = *new_str;
 250         *new_str = NULL;
 251 }
 252
 253 static void perf_pmu_update_alias(struct perf_pmu_alias *old,
 254                                   struct perf_pmu_alias *newalias)
 255 {
 256         perf_pmu_assign_str(old->name, "desc", &old->desc, &newalias->desc);
 257         perf_pmu_assign_str(old->name, "long_desc", &old->long_desc,
 258                             &newalias->long_desc);
 259         perf_pmu_assign_str(old->name, "topic", &old->topic, &newalias->topic);
 260         perf_pmu_assign_str(old->name, "metric_expr", &old->metric_expr,
 261                             &newalias->metric_expr);
 262         perf_pmu_assign_str(old->name, "metric_name", &old->metric_name,
 263                             &newalias->metric_name);
 264         perf_pmu_assign_str(old->name, "value", &old->str, &newalias->str);
 265         old->scale = newalias->scale;
 266         old->per_pkg = newalias->per_pkg;
 267         old->snapshot = newalias->snapshot;
 268         memcpy(old->unit, newalias->unit, sizeof(old->unit));
 269 }
 270
 271 /* Delete an alias entry. */
 272 static void perf_pmu_free_alias(struct perf_pmu_alias *newalias)
 273 {
 274         zfree(&newalias->name);
 275         zfree(&newalias->desc);
 276         zfree(&newalias->long_desc);
 277         zfree(&newalias->topic);
 278         zfree(&newalias->str);
 279         zfree(&newalias->metric_expr);
 280         zfree(&newalias->metric_name);
 281         parse_events_terms__purge(&newalias->terms);
 282         free(newalias);
 283 }
 284
 285 /* Merge an alias, search in alias list. If this name is already
 286  * present merge both of them to combine all information.
 287  */
 288 static bool perf_pmu_merge_alias(struct perf_pmu_alias *newalias,
 289                                  struct list_head *alist)
 290 {
 291         struct perf_pmu_alias *a;
 292
 293         list_for_each_entry(a, alist, list) {
 294                 if (!strcasecmp(newalias->name, a->name)) {
 295                         perf_pmu_update_alias(a, newalias);
 296                         perf_pmu_free_alias(newalias);
 297                         return true;
 298                 }
 299         }
 300         return false;
 301 }
 302
 303 static int __perf_pmu__new_alias(struct list_head *list, char *dir, char *name,
 304                                  char *desc, char *val,
 305                                  char *long_desc, char *topic,
 306                                  char *unit, char *perpkg,
 307                                  char *metric_expr,
 308                                  char *metric_name)
 309 {
 310         struct parse_events_term *term;
 311         struct perf_pmu_alias *alias;
 312         int ret;
 313         int num;
 314         char newval[256];
 315
 316         alias = malloc(sizeof(*alias));
 317         if (!alias)
 318                 return -ENOMEM;
 319
 320         INIT_LIST_HEAD(&alias->terms);
 321         alias->scale = 1.0;
 322         alias->unit[0] = '\0';
 323         alias->per_pkg = false;
 324         alias->snapshot = false;
 325
 326         ret = parse_events_terms(&alias->terms, val);
 327         if (ret) {
 328                 pr_err("Cannot parse alias %s: %d\n", val, ret);
 329                 free(alias);
 330                 return ret;
 331         }
 332
 333         /* Scan event and remove leading zeroes, spaces, newlines, some
 334          * platforms have terms specified as
 335          * event=0x0091 (read from files ../<PMU>/events/<FILE>
 336          * and terms specified as event=0x91 (read from JSON files).
 337          *
 338          * Rebuild string to make alias->str member comparable.
 339          */
 340         memset(newval, 0, sizeof(newval));
 341         ret = 0;
 342         list_for_each_entry(term, &alias->terms, list) {
 343                 if (ret)
 344                         ret += scnprintf(newval + ret, sizeof(newval) - ret,
 345                                          ",");
 346                 if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM)
 347                         ret += scnprintf(newval + ret, sizeof(newval) - ret,
 348                                          "%s=%#x", term->config, term->val.num);
 349                 else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
 350                         ret += scnprintf(newval + ret, sizeof(newval) - ret,
 351                                          "%s=%s", term->config, term->val.str);
 352         }
 353
 354         alias->name = strdup(name);
 355         if (dir) {
 356                 /*
 357                  * load unit name and scale if available
 358                  */
 359                 perf_pmu__parse_unit(alias, dir, name);
 360                 perf_pmu__parse_scale(alias, dir, name);
 361                 perf_pmu__parse_per_pkg(alias, dir, name);
 362                 perf_pmu__parse_snapshot(alias, dir, name);
 363         }
 364
 365         alias->metric_expr = metric_expr ? strdup(metric_expr) : NULL;
 366         alias->metric_name = metric_name ? strdup(metric_name): NULL;
 367         alias->desc = desc ? strdup(desc) : NULL;
 368         alias->long_desc = long_desc ? strdup(long_desc) :
 369                                 desc ? strdup(desc) : NULL;
 370         alias->topic = topic ? strdup(topic) : NULL;
 371         if (unit) {
 372                 if (convert_scale(unit, &unit, &alias->scale) < 0)
 373                         return -1;
 374                 snprintf(alias->unit, sizeof(alias->unit), "%s", unit);
 375         }
 376         alias->per_pkg = perpkg && sscanf(perpkg, "%d", &num) == 1 && num == 1;
 377         alias->str = strdup(newval);
 378
 379         if (!perf_pmu_merge_alias(alias, list))
 380                 list_add_tail(&alias->list, list);
 381
 382         return 0;
 383 }
 384
 385 static int perf_pmu__new_alias(struct list_head *list, char *dir, char *name, FILE *file)
 386 {
 387         char buf[256];
 388         int ret;
 389
 390         ret = fread(buf, 1, sizeof(buf), file);
 391         if (ret == 0)
 392                 return -EINVAL;
 393
 394         buf[ret] = 0;
 395
 396         /* Remove trailing newline from sysfs file */
 397         rtrim(buf);
 398
 399         return __perf_pmu__new_alias(list, dir, name, NULL, buf, NULL, NULL, NULL,
 400                                      NULL, NULL, NULL);
 401 }
 402
 403 static inline bool pmu_alias_info_file(char *name)
 404 {
 405         size_t len;
 406
 407         len = strlen(name);
 408         if (len > 5 && !strcmp(name + len - 5, ".unit"))
 409                 return true;
 410         if (len > 6 && !strcmp(name + len - 6, ".scale"))
 411                 return true;
 412         if (len > 8 && !strcmp(name + len - 8, ".per-pkg"))
 413                 return true;
 414         if (len > 9 && !strcmp(name + len - 9, ".snapshot"))
 415                 return true;
 416
 417         return false;
 418 }
 419
 420 /*
 421  * Process all the sysfs attributes located under the directory
 422  * specified in 'dir' parameter.
 423  */
 424 static int pmu_aliases_parse(char *dir, struct list_head *head)
 425 {
 426         struct dirent *evt_ent;
 427         DIR *event_dir;
 428
 429         event_dir = opendir(dir);
 430         if (!event_dir)
 431                 return -EINVAL;
 432
 433         while ((evt_ent = readdir(event_dir))) {
 434                 char path[PATH_MAX];
 435                 char *name = evt_ent->d_name;
 436                 FILE *file;
 437
 438                 if (!strcmp(name, ".") || !strcmp(name, ".."))
 439                         continue;
 440
 441                 /*
 442                  * skip info files parsed in perf_pmu__new_alias()
 443                  */
 444                 if (pmu_alias_info_file(name))
 445                         continue;
 446
 447                 scnprintf(path, PATH_MAX, "%s/%s", dir, name);
 448
 449                 file = fopen(path, "r");
 450                 if (!file) {
 451                         pr_debug("Cannot open %s\n", path);
 452                         continue;
 453                 }
 454
 455                 if (perf_pmu__new_alias(head, dir, name, file) < 0)
 456                         pr_debug("Cannot set up %s\n", name);
 457                 fclose(file);
 458         }
 459
 460         closedir(event_dir);
 461         return 0;
 462 }
 463
 464 /*
 465  * Reading the pmu event aliases definition, which should be located at:
 466  * /sys/bus/event_source/devices/<dev>/events as sysfs group attributes.
 467  */
 468 static int pmu_aliases(const char *name, struct list_head *head)
 469 {
 470         struct stat st;
 471         char path[PATH_MAX];
 472         const char *sysfs = sysfs__mountpoint();
 473
 474         if (!sysfs)
 475                 return -1;
 476
 477         snprintf(path, PATH_MAX,
 478                  "%s/bus/event_source/devices/%s/events", sysfs, name);
 479
 480         if (stat(path, &st) < 0)
 481                 return 0;        /* no error if 'events' does not exist */
 482
 483         if (pmu_aliases_parse(path, head))
 484                 return -1;
 485
 486         return 0;
 487 }
 488
 489 static int pmu_alias_terms(struct perf_pmu_alias *alias,
 490                            struct list_head *terms)
 491 {
 492         struct parse_events_term *term, *cloned;
 493         LIST_HEAD(list);
 494         int ret;
 495
 496         list_for_each_entry(term, &alias->terms, list) {
 497                 ret = parse_events_term__clone(&cloned, term);
 498                 if (ret) {
 499                         parse_events_terms__purge(&list);
 500                         return ret;
 501                 }
 502                 /*
 503                  * Weak terms don't override command line options,
 504                  * which we don't want for implicit terms in aliases.
 505                  */
 506                 cloned->weak = true;
 507                 list_add_tail(&cloned->list, &list);
 508         }
 509         list_splice(&list, terms);
 510         return 0;
 511 }
 512
 513 /*
 514  * Reading/parsing the default pmu type value, which should be
 515  * located at:
 516  * /sys/bus/event_source/devices/<dev>/type as sysfs attribute.
 517  */
 518 static int pmu_type(const char *name, __u32 *type)
 519 {
 520         struct stat st;
 521         char path[PATH_MAX];
 522         FILE *file;
 523         int ret = 0;
 524         const char *sysfs = sysfs__mountpoint();
 525
 526         if (!sysfs)
 527                 return -1;
 528
 529         snprintf(path, PATH_MAX,
 530                  "%s" EVENT_SOURCE_DEVICE_PATH "%s/type", sysfs, name);
 531
 532         if (stat(path, &st) < 0)
 533                 return -1;
 534
 535         file = fopen(path, "r");
 536         if (!file)
 537                 return -EINVAL;
 538
 539         if (1 != fscanf(file, "%u", type))
 540                 ret = -1;
 541
 542         fclose(file);
 543         return ret;
 544 }
 545
 546 /* Add all pmus in sysfs to pmu list: */
 547 static void pmu_read_sysfs(void)
 548 {
 549         char path[PATH_MAX];
 550         DIR *dir;
 551         struct dirent *dent;
 552         const char *sysfs = sysfs__mountpoint();
 553
 554         if (!sysfs)
 555                 return;
 556
 557         snprintf(path, PATH_MAX,
 558                  "%s" EVENT_SOURCE_DEVICE_PATH, sysfs);
 559
 560         dir = opendir(path);
 561         if (!dir)
 562                 return;
 563
 564         while ((dent = readdir(dir))) {
 565                 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
 566                         continue;
 567                 /* add to static LIST_HEAD(pmus): */
 568                 perf_pmu__find(dent->d_name);
 569         }
 570
 571         closedir(dir);
 572 }
 573
 574 static struct cpu_map *__pmu_cpumask(const char *path)
 575 {
 576         FILE *file;
 577         struct cpu_map *cpus;
 578
 579         file = fopen(path, "r");
 580         if (!file)
 581                 return NULL;
 582
 583         cpus = cpu_map__read(file);
 584         fclose(file);
 585         return cpus;
 586 }
 587
 588 /*
 589  * Uncore PMUs have a "cpumask" file under sysfs. CPU PMUs (e.g. on arm/arm64)
 590  * may have a "cpus" file.
 591  */
 592 #define CPUS_TEMPLATE_UNCORE    "%s/bus/event_source/devices/%s/cpumask"
 593 #define CPUS_TEMPLATE_CPU       "%s/bus/event_source/devices/%s/cpus"
 594
 595 static struct cpu_map *pmu_cpumask(const char *name)
 596 {
 597         char path[PATH_MAX];
 598         struct cpu_map *cpus;
 599         const char *sysfs = sysfs__mountpoint();
 600         const char *templates[] = {
 601                 CPUS_TEMPLATE_UNCORE,
 602                 CPUS_TEMPLATE_CPU,
 603                 NULL
 604         };
 605         const char **template;
 606
 607         if (!sysfs)
 608                 return NULL;
 609
 610         for (template = templates; *template; template++) {
 611                 snprintf(path, PATH_MAX, *template, sysfs, name);
 612                 cpus = __pmu_cpumask(path);
 613                 if (cpus)
 614                         return cpus;
 615         }
 616
 617         return NULL;
 618 }
 619
 620 static bool pmu_is_uncore(const char *name)
 621 {
 622         char path[PATH_MAX];
 623         struct cpu_map *cpus;
 624         const char *sysfs = sysfs__mountpoint();
 625
 626         snprintf(path, PATH_MAX, CPUS_TEMPLATE_UNCORE, sysfs, name);
 627         cpus = __pmu_cpumask(path);
 628         cpu_map__put(cpus);
 629
 630         return !!cpus;
 631 }
 632
 633 /*
 634  *  PMU CORE devices have different name other than cpu in sysfs on some
 635  *  platforms.
 636  *  Looking for possible sysfs files to identify the arm core device.
 637  */
 638 static int is_arm_pmu_core(const char *name)
 639 {
 640         struct stat st;
 641         char path[PATH_MAX];
 642         const char *sysfs = sysfs__mountpoint();
 643
 644         if (!sysfs)
 645                 return 0;
 646
 647         /* Look for cpu sysfs (specific to arm) */
 648         scnprintf(path, PATH_MAX, "%s/bus/event_source/devices/%s/cpus",
 649                                 sysfs, name);
 650         if (stat(path, &st) == 0)
 651                 return 1;
 652
 653         return 0;
 654 }
 655
 656 static char *perf_pmu__getcpuid(struct perf_pmu *pmu)
 657 {
 658         char *cpuid;
 659         static bool printed;
 660
 661         cpuid = getenv("PERF_CPUID");
 662         if (cpuid)
 663                 cpuid = strdup(cpuid);
 664         if (!cpuid)
 665                 cpuid = get_cpuid_str(pmu);
 666         if (!cpuid)
 667                 return NULL;
 668
 669         if (!printed) {
 670                 pr_debug("Using CPUID %s\n", cpuid);
 671                 printed = true;
 672         }
 673         return cpuid;
 674 }
 675
 676 struct pmu_events_map *perf_pmu__find_map(struct perf_pmu *pmu)
 677 {
 678         struct pmu_events_map *map;
 679         char *cpuid = perf_pmu__getcpuid(pmu);
 680         int i;
 681
 682         /* on some platforms which uses cpus map, cpuid can be NULL for
 683          * PMUs other than CORE PMUs.
 684          */
 685         if (!cpuid)
 686                 return NULL;
 687
 688         i = 0;
 689         for (;;) {
 690                 map = &pmu_events_map[i++];
 691                 if (!map->table) {
 692                         map = NULL;
 693                         break;
 694                 }
 695
 696                 if (!strcmp_cpuid_str(map->cpuid, cpuid))
 697                         break;
 698         }
 699         free(cpuid);
 700         return map;
 701 }
 702
 703 /*
 704  * From the pmu_events_map, find the table of PMU events that corresponds
 705  * to the current running CPU. Then, add all PMU events from that table
 706  * as aliases.
 707  */
 708 static void pmu_add_cpu_aliases(struct list_head *head, struct perf_pmu *pmu)
 709 {
 710         int i;
 711         struct pmu_events_map *map;
 712         struct pmu_event *pe;
 713         const char *name = pmu->name;
 714         const char *pname;
 715
 716         map = perf_pmu__find_map(pmu);
 717         if (!map)
 718                 return;
 719
 720         /*
 721          * Found a matching PMU events table. Create aliases
 722          */
 723         i = 0;
 724         while (1) {
 725
 726                 pe = &map->table[i++];
 727                 if (!pe->name) {
 728                         if (pe->metric_group || pe->metric_name)
 729                                 continue;
 730                         break;
 731                 }
 732
 733                 if (!is_arm_pmu_core(name)) {
 734                         pname = pe->pmu ? pe->pmu : "cpu";
 735                         if (strcmp(pname, name))
 736                                 continue;
 737                 }
 738
 739                 /* need type casts to override 'const' */
 740                 __perf_pmu__new_alias(head, NULL, (char *)pe->name,
 741                                 (char *)pe->desc, (char *)pe->event,
 742                                 (char *)pe->long_desc, (char *)pe->topic,
 743                                 (char *)pe->unit, (char *)pe->perpkg,
 744                                 (char *)pe->metric_expr,
 745                                 (char *)pe->metric_name);
 746         }
 747 }
 748
 749 struct perf_event_attr * __weak
 750 perf_pmu__get_default_config(struct perf_pmu *pmu __maybe_unused)
 751 {
 752         return NULL;
 753 }
 754
 755 static struct perf_pmu *pmu_lookup(const char *name)
 756 {
 757         struct perf_pmu *pmu;
 758         LIST_HEAD(format);
 759         LIST_HEAD(aliases);
 760         __u32 type;
 761
 762         /*
 763          * The pmu data we store & need consists of the pmu
 764          * type value and format definitions. Load both right
 765          * now.
 766          */
 767         if (pmu_format(name, &format))
 768                 return NULL;
 769
 770         /*
 771          * Check the type first to avoid unnecessary work.
 772          */
 773         if (pmu_type(name, &type))
 774                 return NULL;
 775
 776         if (pmu_aliases(name, &aliases))
 777                 return NULL;
 778
 779         pmu = zalloc(sizeof(*pmu));
 780         if (!pmu)
 781                 return NULL;
 782
 783         pmu->cpus = pmu_cpumask(name);
 784         pmu->name = strdup(name);
 785         pmu->type = type;
 786         pmu->is_uncore = pmu_is_uncore(name);
 787         pmu_add_cpu_aliases(&aliases, pmu);
 788
 789         INIT_LIST_HEAD(&pmu->format);
 790         INIT_LIST_HEAD(&pmu->aliases);
 791         list_splice(&format, &pmu->format);
 792         list_splice(&aliases, &pmu->aliases);
 793         list_add_tail(&pmu->list, &pmus);
 794
 795         pmu->default_config = perf_pmu__get_default_config(pmu);
 796
 797         return pmu;
 798 }
 799
 800 static struct perf_pmu *pmu_find(const char *name)
 801 {
 802         struct perf_pmu *pmu;
 803
 804         list_for_each_entry(pmu, &pmus, list)
 805                 if (!strcmp(pmu->name, name))
 806                         return pmu;
 807
 808         return NULL;
 809 }
 810
 811 struct perf_pmu *perf_pmu__scan(struct perf_pmu *pmu)
 812 {
 813         /*
 814          * pmu iterator: If pmu is NULL, we start at the begin,
 815          * otherwise return the next pmu. Returns NULL on end.
 816          */
 817         if (!pmu) {
 818                 pmu_read_sysfs();
 819                 pmu = list_prepare_entry(pmu, &pmus, list);
 820         }
 821         list_for_each_entry_continue(pmu, &pmus, list)
 822                 return pmu;
 823         return NULL;
 824 }
 825
 826 struct perf_pmu *perf_pmu__find(const char *name)
 827 {
 828         struct perf_pmu *pmu;
 829
 830         /*
 831          * Once PMU is loaded it stays in the list,
 832          * so we keep us from multiple reading/parsing
 833          * the pmu format definitions.
 834          */
 835         pmu = pmu_find(name);
 836         if (pmu)
 837                 return pmu;
 838
 839         return pmu_lookup(name);
 840 }
 841
 842 static struct perf_pmu_format *
 843 pmu_find_format(struct list_head *formats, const char *name)
 844 {
 845         struct perf_pmu_format *format;
 846
 847         list_for_each_entry(format, formats, list)
 848                 if (!strcmp(format->name, name))
 849                         return format;
 850
 851         return NULL;
 852 }
 853
 854 __u64 perf_pmu__format_bits(struct list_head *formats, const char *name)
 855 {
 856         struct perf_pmu_format *format = pmu_find_format(formats, name);
 857         __u64 bits = 0;
 858         int fbit;
 859
 860         if (!format)
 861                 return 0;
 862
 863         for_each_set_bit(fbit, format->bits, PERF_PMU_FORMAT_BITS)
 864                 bits |= 1ULL << fbit;
 865
 866         return bits;
 867 }
 868
 869 /*
 870  * Sets value based on the format definition (format parameter)
 871  * and unformated value (value parameter).
 872  */
 873 static void pmu_format_value(unsigned long *format, __u64 value, __u64 *v,
 874                              bool zero)
 875 {
 876         unsigned long fbit, vbit;
 877
 878         for (fbit = 0, vbit = 0; fbit < PERF_PMU_FORMAT_BITS; fbit++) {
 879
 880                 if (!test_bit(fbit, format))
 881                         continue;
 882
 883                 if (value & (1llu << vbit++))
 884                         *v |= (1llu << fbit);
 885                 else if (zero)
 886                         *v &= ~(1llu << fbit);
 887         }
 888 }
 889
 890 static __u64 pmu_format_max_value(const unsigned long *format)
 891 {
 892         int w;
 893
 894         w = bitmap_weight(format, PERF_PMU_FORMAT_BITS);
 895         if (!w)
 896                 return 0;
 897         if (w < 64)
 898                 return (1ULL << w) - 1;
 899         return -1;
 900 }
 901
 902 /*
 903  * Term is a string term, and might be a param-term. Try to look up it's value
 904  * in the remaining terms.
 905  * - We have a term like "base-or-format-term=param-term",
 906  * - We need to find the value supplied for "param-term" (with param-term named
 907  *   in a config string) later on in the term list.
 908  */
 909 static int pmu_resolve_param_term(struct parse_events_term *term,
 910                                   struct list_head *head_terms,
 911                                   __u64 *value)
 912 {
 913         struct parse_events_term *t;
 914
 915         list_for_each_entry(t, head_terms, list) {
 916                 if (t->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
 917                         if (!strcmp(t->config, term->config)) {
 918                                 t->used = true;
 919                                 *value = t->val.num;
 920                                 return 0;
 921                         }
 922                 }
 923         }
 924
 925         if (verbose > 0)
 926                 printf("Required parameter '%s' not specified\n", term->config);
 927
 928         return -1;
 929 }
 930
 931 static char *pmu_formats_string(struct list_head *formats)
 932 {
 933         struct perf_pmu_format *format;
 934         char *str = NULL;
 935         struct strbuf buf = STRBUF_INIT;
 936         unsigned i = 0;
 937
 938         if (!formats)
 939                 return NULL;
 940
 941         /* sysfs exported terms */
 942         list_for_each_entry(format, formats, list)
 943                 if (strbuf_addf(&buf, i++ ? ",%s" : "%s", format->name) < 0)
 944                         goto error;
 945
 946         str = strbuf_detach(&buf, NULL);
 947 error:
 948         strbuf_release(&buf);
 949
 950         return str;
 951 }
 952
 953 /*
 954  * Setup one of config[12] attr members based on the
 955  * user input data - term parameter.
 956  */
 957 static int pmu_config_term(struct list_head *formats,
 958                            struct perf_event_attr *attr,
 959                            struct parse_events_term *term,
 960                            struct list_head *head_terms,
 961                            bool zero, struct parse_events_error *err)
 962 {
 963         struct perf_pmu_format *format;
 964         __u64 *vp;
 965         __u64 val, max_val;
 966
 967         /*
 968          * If this is a parameter we've already used for parameterized-eval,
 969          * skip it in normal eval.
 970          */
 971         if (term->used)
 972                 return 0;
 973
 974         /*
 975          * Hardcoded terms should be already in, so nothing
 976          * to be done for them.
 977          */
 978         if (parse_events__is_hardcoded_term(term))
 979                 return 0;
 980
 981         format = pmu_find_format(formats, term->config);
 982         if (!format) {
 983                 if (verbose > 0)
 984                         printf("Invalid event/parameter '%s'\n", term->config);
 985                 if (err) {
 986                         char *pmu_term = pmu_formats_string(formats);
 987
 988                         err->idx  = term->err_term;
 989                         err->str  = strdup("unknown term");
 990                         err->help = parse_events_formats_error_string(pmu_term);
 991                         free(pmu_term);
 992                 }
 993                 return -EINVAL;
 994         }
 995
 996         switch (format->value) {
 997         case PERF_PMU_FORMAT_VALUE_CONFIG:
 998                 vp = &attr->config;
 999                 break;
1000         case PERF_PMU_FORMAT_VALUE_CONFIG1:
1001                 vp = &attr->config1;
1002                 break;
1003         case PERF_PMU_FORMAT_VALUE_CONFIG2:
1004                 vp = &attr->config2;
1005                 break;
1006         default:
1007                 return -EINVAL;
1008         }
1009
1010         /*
1011          * Either directly use a numeric term, or try to translate string terms
1012          * using event parameters.
1013          */
1014         if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1015                 if (term->no_value &&
1016                     bitmap_weight(format->bits, PERF_PMU_FORMAT_BITS) > 1) {
1017                         if (err) {
1018                                 err->idx = term->err_val;
1019                                 err->str = strdup("no value assigned for term");
1020                         }
1021                         return -EINVAL;
1022                 }
1023
1024                 val = term->val.num;
1025         } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1026                 if (strcmp(term->val.str, "?")) {
1027                         if (verbose > 0) {
1028                                 pr_info("Invalid sysfs entry %s=%s\n",
1029                                                 term->config, term->val.str);
1030                         }
1031                         if (err) {
1032                                 err->idx = term->err_val;
1033                                 err->str = strdup("expected numeric value");
1034                         }
1035                         return -EINVAL;
1036                 }
1037
1038                 if (pmu_resolve_param_term(term, head_terms, &val))
1039                         return -EINVAL;
1040         } else
1041                 return -EINVAL;
1042
1043         max_val = pmu_format_max_value(format->bits);
1044         if (val > max_val) {
1045                 if (err) {
1046                         err->idx = term->err_val;
1047                         if (asprintf(&err->str,
1048                                      "value too big for format, maximum is %llu",
1049                                      (unsigned long long)max_val) < 0)
1050                                 err->str = strdup("value too big for format");
1051                         return -EINVAL;
1052                 }
1053                 /*
1054                  * Assume we don't care if !err, in which case the value will be
1055                  * silently truncated.
1056                  */
1057         }
1058
1059         pmu_format_value(format->bits, val, vp, zero);
1060         return 0;
1061 }
1062
1063 int perf_pmu__config_terms(struct list_head *formats,
1064                            struct perf_event_attr *attr,
1065                            struct list_head *head_terms,
1066                            bool zero, struct parse_events_error *err)
1067 {
1068         struct parse_events_term *term;
1069
1070         list_for_each_entry(term, head_terms, list) {
1071                 if (pmu_config_term(formats, attr, term, head_terms,
1072                                     zero, err))
1073                         return -EINVAL;
1074         }
1075
1076         return 0;
1077 }
1078
1079 /*
1080  * Configures event's 'attr' parameter based on the:
1081  * 1) users input - specified in terms parameter
1082  * 2) pmu format definitions - specified by pmu parameter
1083  */
1084 int perf_pmu__config(struct perf_pmu *pmu, struct perf_event_attr *attr,
1085                      struct list_head *head_terms,
1086                      struct parse_events_error *err)
1087 {
1088         bool zero = !!pmu->default_config;
1089
1090         attr->type = pmu->type;
1091         return perf_pmu__config_terms(&pmu->format, attr, head_terms,
1092                                       zero, err);
1093 }
1094
1095 static struct perf_pmu_alias *pmu_find_alias(struct perf_pmu *pmu,
1096                                              struct parse_events_term *term)
1097 {
1098         struct perf_pmu_alias *alias;
1099         char *name;
1100
1101         if (parse_events__is_hardcoded_term(term))
1102                 return NULL;
1103
1104         if (term->type_val == PARSE_EVENTS__TERM_TYPE_NUM) {
1105                 if (term->val.num != 1)
1106                         return NULL;
1107                 if (pmu_find_format(&pmu->format, term->config))
1108                         return NULL;
1109                 name = term->config;
1110         } else if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR) {
1111                 if (strcasecmp(term->config, "event"))
1112                         return NULL;
1113                 name = term->val.str;
1114         } else {
1115                 return NULL;
1116         }
1117
1118         list_for_each_entry(alias, &pmu->aliases, list) {
1119                 if (!strcasecmp(alias->name, name))
1120                         return alias;
1121         }
1122         return NULL;
1123 }
1124
1125
1126 static int check_info_data(struct perf_pmu_alias *alias,
1127                            struct perf_pmu_info *info)
1128 {
1129         /*
1130          * Only one term in event definition can
1131          * define unit, scale and snapshot, fail
1132          * if there's more than one.
1133          */
1134         if ((info->unit && alias->unit[0]) ||
1135             (info->scale && alias->scale) ||
1136             (info->snapshot && alias->snapshot))
1137                 return -EINVAL;
1138
1139         if (alias->unit[0])
1140                 info->unit = alias->unit;
1141
1142         if (alias->scale)
1143                 info->scale = alias->scale;
1144
1145         if (alias->snapshot)
1146                 info->snapshot = alias->snapshot;
1147
1148         return 0;
1149 }
1150
1151 /*
1152  * Find alias in the terms list and replace it with the terms
1153  * defined for the alias
1154  */
1155 int perf_pmu__check_alias(struct perf_pmu *pmu, struct list_head *head_terms,
1156                           struct perf_pmu_info *info)
1157 {
1158         struct parse_events_term *term, *h;
1159         struct perf_pmu_alias *alias;
1160         int ret;
1161
1162         info->per_pkg = false;
1163
1164         /*
1165          * Mark unit and scale as not set
1166          * (different from default values, see below)
1167          */
1168         info->unit     = NULL;
1169         info->scale    = 0.0;
1170         info->snapshot = false;
1171         info->metric_expr = NULL;
1172         info->metric_name = NULL;
1173
1174         list_for_each_entry_safe(term, h, head_terms, list) {
1175                 alias = pmu_find_alias(pmu, term);
1176                 if (!alias)
1177                         continue;
1178                 ret = pmu_alias_terms(alias, &term->list);
1179                 if (ret)
1180                         return ret;
1181
1182                 ret = check_info_data(alias, info);
1183                 if (ret)
1184                         return ret;
1185
1186                 if (alias->per_pkg)
1187                         info->per_pkg = true;
1188                 info->metric_expr = alias->metric_expr;
1189                 info->metric_name = alias->metric_name;
1190
1191                 list_del(&term->list);
1192                 free(term);
1193         }
1194
1195         /*
1196          * if no unit or scale foundin aliases, then
1197          * set defaults as for evsel
1198          * unit cannot left to NULL
1199          */
1200         if (info->unit == NULL)
1201                 info->unit   = "";
1202
1203         if (info->scale == 0.0)
1204                 info->scale  = 1.0;
1205
1206         return 0;
1207 }
1208
1209 int perf_pmu__new_format(struct list_head *list, char *name,
1210                          int config, unsigned long *bits)
1211 {
1212         struct perf_pmu_format *format;
1213
1214         format = zalloc(sizeof(*format));
1215         if (!format)
1216                 return -ENOMEM;
1217
1218         format->name = strdup(name);
1219         format->value = config;
1220         memcpy(format->bits, bits, sizeof(format->bits));
1221
1222         list_add_tail(&format->list, list);
1223         return 0;
1224 }
1225
1226 void perf_pmu__set_format(unsigned long *bits, long from, long to)
1227 {
1228         long b;
1229
1230         if (!to)
1231                 to = from;
1232
1233         memset(bits, 0, BITS_TO_BYTES(PERF_PMU_FORMAT_BITS));
1234         for (b = from; b <= to; b++)
1235                 set_bit(b, bits);
1236 }
1237
1238 static int sub_non_neg(int a, int b)
1239 {
1240         if (b > a)
1241                 return 0;
1242         return a - b;
1243 }
1244
1245 static char *format_alias(char *buf, int len, struct perf_pmu *pmu,
1246                           struct perf_pmu_alias *alias)
1247 {
1248         struct parse_events_term *term;
1249         int used = snprintf(buf, len, "%s/%s", pmu->name, alias->name);
1250
1251         list_for_each_entry(term, &alias->terms, list) {
1252                 if (term->type_val == PARSE_EVENTS__TERM_TYPE_STR)
1253                         used += snprintf(buf + used, sub_non_neg(len, used),
1254                                         ",%s=%s", term->config,
1255                                         term->val.str);
1256         }
1257
1258         if (sub_non_neg(len, used) > 0) {
1259                 buf[used] = '/';
1260                 used++;
1261         }
1262         if (sub_non_neg(len, used) > 0) {
1263                 buf[used] = '\0';
1264                 used++;
1265         } else
1266                 buf[len - 1] = '\0';
1267
1268         return buf;
1269 }
1270
1271 static char *format_alias_or(char *buf, int len, struct perf_pmu *pmu,
1272                              struct perf_pmu_alias *alias)
1273 {
1274         snprintf(buf, len, "%s OR %s/%s/", alias->name, pmu->name, alias->name);
1275         return buf;
1276 }
1277
1278 struct sevent {
1279         char *name;
1280         char *desc;
1281         char *topic;
1282         char *str;
1283         char *pmu;
1284         char *metric_expr;
1285         char *metric_name;
1286 };
1287
1288 static int cmp_sevent(const void *a, const void *b)
1289 {
1290         const struct sevent *as = a;
1291         const struct sevent *bs = b;
1292
1293         /* Put extra events last */
1294         if (!!as->desc != !!bs->desc)
1295                 return !!as->desc - !!bs->desc;
1296         if (as->topic && bs->topic) {
1297                 int n = strcmp(as->topic, bs->topic);
1298
1299                 if (n)
1300                         return n;
1301         }
1302         return strcmp(as->name, bs->name);
1303 }
1304
1305 static void wordwrap(char *s, int start, int max, int corr)
1306 {
1307         int column = start;
1308         int n;
1309
1310         while (*s) {
1311                 int wlen = strcspn(s, " \t");
1312
1313                 if (column + wlen >= max && column > start) {
1314                         printf("\n%*s", start, "");
1315                         column = start + corr;
1316                 }
1317                 n = printf("%s%.*s", column > start ? " " : "", wlen, s);
1318                 if (n <= 0)
1319                         break;
1320                 s += wlen;
1321                 column += n;
1322                 s = ltrim(s);
1323         }
1324 }
1325
1326 void print_pmu_events(const char *event_glob, bool name_only, bool quiet_flag,
1327                         bool long_desc, bool details_flag)
1328 {
1329         struct perf_pmu *pmu;
1330         struct perf_pmu_alias *alias;
1331         char buf[1024];
1332         int printed = 0;
1333         int len, j;
1334         struct sevent *aliases;
1335         int numdesc = 0;
1336         int columns = pager_get_columns();
1337         char *topic = NULL;
1338
1339         pmu = NULL;
1340         len = 0;
1341         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1342                 list_for_each_entry(alias, &pmu->aliases, list)
1343                         len++;
1344                 if (pmu->selectable)
1345                         len++;
1346         }
1347         aliases = zalloc(sizeof(struct sevent) * len);
1348         if (!aliases)
1349                 goto out_enomem;
1350         pmu = NULL;
1351         j = 0;
1352         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1353                 list_for_each_entry(alias, &pmu->aliases, list) {
1354                         char *name = alias->desc ? alias->name :
1355                                 format_alias(buf, sizeof(buf), pmu, alias);
1356                         bool is_cpu = !strcmp(pmu->name, "cpu");
1357
1358                         if (event_glob != NULL &&
1359                             !(strglobmatch_nocase(name, event_glob) ||
1360                               (!is_cpu && strglobmatch_nocase(alias->name,
1361                                                        event_glob)) ||
1362                               (alias->topic &&
1363                                strglobmatch_nocase(alias->topic, event_glob))))
1364                                 continue;
1365
1366                         if (is_cpu && !name_only && !alias->desc)
1367                                 name = format_alias_or(buf, sizeof(buf), pmu, alias);
1368
1369                         aliases[j].name = name;
1370                         if (is_cpu && !name_only && !alias->desc)
1371                                 aliases[j].name = format_alias_or(buf,
1372                                                                   sizeof(buf),
1373                                                                   pmu, alias);
1374                         aliases[j].name = strdup(aliases[j].name);
1375                         if (!aliases[j].name)
1376                                 goto out_enomem;
1377
1378                         aliases[j].desc = long_desc ? alias->long_desc :
1379                                                 alias->desc;
1380                         aliases[j].topic = alias->topic;
1381                         aliases[j].str = alias->str;
1382                         aliases[j].pmu = pmu->name;
1383                         aliases[j].metric_expr = alias->metric_expr;
1384                         aliases[j].metric_name = alias->metric_name;
1385                         j++;
1386                 }
1387                 if (pmu->selectable &&
1388                     (event_glob == NULL || strglobmatch(pmu->name, event_glob))) {
1389                         char *s;
1390                         if (asprintf(&s, "%s//", pmu->name) < 0)
1391                                 goto out_enomem;
1392                         aliases[j].name = s;
1393                         j++;
1394                 }
1395         }
1396         len = j;
1397         qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
1398         for (j = 0; j < len; j++) {
1399                 /* Skip duplicates */
1400                 if (j > 0 && !strcmp(aliases[j].name, aliases[j - 1].name))
1401                         continue;
1402                 if (name_only) {
1403                         printf("%s ", aliases[j].name);
1404                         continue;
1405                 }
1406                 if (aliases[j].desc && !quiet_flag) {
1407                         if (numdesc++ == 0)
1408                                 printf("\n");
1409                         if (aliases[j].topic && (!topic ||
1410                                         strcmp(topic, aliases[j].topic))) {
1411                                 printf("%s%s:\n", topic ? "\n" : "",
1412                                                 aliases[j].topic);
1413                                 topic = aliases[j].topic;
1414                         }
1415                         printf("  %-50s\n", aliases[j].name);
1416                         printf("%*s", 8, "[");
1417                         wordwrap(aliases[j].desc, 8, columns, 0);
1418                         printf("]\n");
1419                         if (details_flag) {
1420                                 printf("%*s%s/%s/ ", 8, "", aliases[j].pmu, aliases[j].str);
1421                                 if (aliases[j].metric_name)
1422                                         printf(" MetricName: %s", aliases[j].metric_name);
1423                                 if (aliases[j].metric_expr)
1424                                         printf(" MetricExpr: %s", aliases[j].metric_expr);
1425                                 putchar('\n');
1426                         }
1427                 } else
1428                         printf("  %-50s [Kernel PMU event]\n", aliases[j].name);
1429                 printed++;
1430         }
1431         if (printed && pager_in_use())
1432                 printf("\n");
1433 out_free:
1434         for (j = 0; j < len; j++)
1435                 zfree(&aliases[j].name);
1436         zfree(&aliases);
1437         return;
1438
1439 out_enomem:
1440         printf("FATAL: not enough memory to print PMU events\n");
1441         if (aliases)
1442                 goto out_free;
1443 }
1444
1445 bool pmu_have_event(const char *pname, const char *name)
1446 {
1447         struct perf_pmu *pmu;
1448         struct perf_pmu_alias *alias;
1449
1450         pmu = NULL;
1451         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1452                 if (strcmp(pname, pmu->name))
1453                         continue;
1454                 list_for_each_entry(alias, &pmu->aliases, list)
1455                         if (!strcmp(alias->name, name))
1456                                 return true;
1457         }
1458         return false;
1459 }
1460
1461 static FILE *perf_pmu__open_file(struct perf_pmu *pmu, const char *name)
1462 {
1463         struct stat st;
1464         char path[PATH_MAX];
1465         const char *sysfs;
1466
1467         sysfs = sysfs__mountpoint();
1468         if (!sysfs)
1469                 return NULL;
1470
1471         snprintf(path, PATH_MAX,
1472                  "%s" EVENT_SOURCE_DEVICE_PATH "%s/%s", sysfs, pmu->name, name);
1473
1474         if (stat(path, &st) < 0)
1475                 return NULL;
1476
1477         return fopen(path, "r");
1478 }
1479
1480 int perf_pmu__scan_file(struct perf_pmu *pmu, const char *name, const char *fmt,
1481                         ...)
1482 {
1483         va_list args;
1484         FILE *file;
1485         int ret = EOF;
1486
1487         va_start(args, fmt);
1488         file = perf_pmu__open_file(pmu, name);
1489         if (file) {
1490                 ret = vfscanf(file, fmt, args);
1491                 fclose(file);
1492         }
1493         va_end(args);
1494         return ret;
1495 }