tools/perf/util/pmu.c

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