tools/perf/util/pmu.c

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