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