tools/perf/util/parse-events.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/hw_breakpoint.h>
   3 #include <linux/err.h>
   4 #include <dirent.h>
   5 #include <errno.h>
   6 #include <sys/ioctl.h>
   7 #include <sys/types.h>
   8 #include <sys/stat.h>
   9 #include <fcntl.h>
  10 #include <sys/param.h>
  11 #include "term.h"
  12 #include "../perf.h"
  13 #include "evlist.h"
  14 #include "evsel.h"
  15 #include <subcmd/parse-options.h>
  16 #include "parse-events.h"
  17 #include <subcmd/exec-cmd.h>
  18 #include "string2.h"
  19 #include "strlist.h"
  20 #include "symbol.h"
  21 #include "cache.h"
  22 #include "header.h"
  23 #include "bpf-loader.h"
  24 #include "debug.h"
  25 #include <api/fs/tracing_path.h>
  26 #include "parse-events-bison.h"
  27 #define YY_EXTRA_TYPE int
  28 #include "parse-events-flex.h"
  29 #include "pmu.h"
  30 #include "thread_map.h"
  31 #include "cpumap.h"
  32 #include "probe-file.h"
  33 #include "asm/bug.h"
  34 #include "util/parse-branch-options.h"
  35 #include "metricgroup.h"
  36
  37 #define MAX_NAME_LEN 100
  38
  39 #ifdef PARSER_DEBUG
  40 extern int parse_events_debug;
  41 #endif
  42 int parse_events_parse(void *parse_state, void *scanner);
  43 static int get_config_terms(struct list_head *head_config,
  44                             struct list_head *head_terms __maybe_unused);
  45
  46 static struct perf_pmu_event_symbol *perf_pmu_events_list;
  47 /*
  48  * The variable indicates the number of supported pmu event symbols.
  49  * 0 means not initialized and ready to init
  50  * -1 means failed to init, don't try anymore
  51  * >0 is the number of supported pmu event symbols
  52  */
  53 static int perf_pmu_events_list_num;
  54
  55 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
  56         [PERF_COUNT_HW_CPU_CYCLES] = {
  57                 .symbol = "cpu-cycles",
  58                 .alias  = "cycles",
  59         },
  60         [PERF_COUNT_HW_INSTRUCTIONS] = {
  61                 .symbol = "instructions",
  62                 .alias  = "",
  63         },
  64         [PERF_COUNT_HW_CACHE_REFERENCES] = {
  65                 .symbol = "cache-references",
  66                 .alias  = "",
  67         },
  68         [PERF_COUNT_HW_CACHE_MISSES] = {
  69                 .symbol = "cache-misses",
  70                 .alias  = "",
  71         },
  72         [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
  73                 .symbol = "branch-instructions",
  74                 .alias  = "branches",
  75         },
  76         [PERF_COUNT_HW_BRANCH_MISSES] = {
  77                 .symbol = "branch-misses",
  78                 .alias  = "",
  79         },
  80         [PERF_COUNT_HW_BUS_CYCLES] = {
  81                 .symbol = "bus-cycles",
  82                 .alias  = "",
  83         },
  84         [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
  85                 .symbol = "stalled-cycles-frontend",
  86                 .alias  = "idle-cycles-frontend",
  87         },
  88         [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
  89                 .symbol = "stalled-cycles-backend",
  90                 .alias  = "idle-cycles-backend",
  91         },
  92         [PERF_COUNT_HW_REF_CPU_CYCLES] = {
  93                 .symbol = "ref-cycles",
  94                 .alias  = "",
  95         },
  96 };
  97
  98 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
  99         [PERF_COUNT_SW_CPU_CLOCK] = {
 100                 .symbol = "cpu-clock",
 101                 .alias  = "",
 102         },
 103         [PERF_COUNT_SW_TASK_CLOCK] = {
 104                 .symbol = "task-clock",
 105                 .alias  = "",
 106         },
 107         [PERF_COUNT_SW_PAGE_FAULTS] = {
 108                 .symbol = "page-faults",
 109                 .alias  = "faults",
 110         },
 111         [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
 112                 .symbol = "context-switches",
 113                 .alias  = "cs",
 114         },
 115         [PERF_COUNT_SW_CPU_MIGRATIONS] = {
 116                 .symbol = "cpu-migrations",
 117                 .alias  = "migrations",
 118         },
 119         [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
 120                 .symbol = "minor-faults",
 121                 .alias  = "",
 122         },
 123         [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
 124                 .symbol = "major-faults",
 125                 .alias  = "",
 126         },
 127         [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
 128                 .symbol = "alignment-faults",
 129                 .alias  = "",
 130         },
 131         [PERF_COUNT_SW_EMULATION_FAULTS] = {
 132                 .symbol = "emulation-faults",
 133                 .alias  = "",
 134         },
 135         [PERF_COUNT_SW_DUMMY] = {
 136                 .symbol = "dummy",
 137                 .alias  = "",
 138         },
 139         [PERF_COUNT_SW_BPF_OUTPUT] = {
 140                 .symbol = "bpf-output",
 141                 .alias  = "",
 142         },
 143 };
 144
 145 #define __PERF_EVENT_FIELD(config, name) \
 146         ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
 147
 148 #define PERF_EVENT_RAW(config)          __PERF_EVENT_FIELD(config, RAW)
 149 #define PERF_EVENT_CONFIG(config)       __PERF_EVENT_FIELD(config, CONFIG)
 150 #define PERF_EVENT_TYPE(config)         __PERF_EVENT_FIELD(config, TYPE)
 151 #define PERF_EVENT_ID(config)           __PERF_EVENT_FIELD(config, EVENT)
 152
 153 #define for_each_subsystem(sys_dir, sys_dirent)                 \
 154         while ((sys_dirent = readdir(sys_dir)) != NULL)         \
 155                 if (sys_dirent->d_type == DT_DIR &&             \
 156                     (strcmp(sys_dirent->d_name, ".")) &&        \
 157                     (strcmp(sys_dirent->d_name, "..")))
 158
 159 static int tp_event_has_id(const char *dir_path, struct dirent *evt_dir)
 160 {
 161         char evt_path[MAXPATHLEN];
 162         int fd;
 163
 164         snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path, evt_dir->d_name);
 165         fd = open(evt_path, O_RDONLY);
 166         if (fd < 0)
 167                 return -EINVAL;
 168         close(fd);
 169
 170         return 0;
 171 }
 172
 173 #define for_each_event(dir_path, evt_dir, evt_dirent)           \
 174         while ((evt_dirent = readdir(evt_dir)) != NULL)         \
 175                 if (evt_dirent->d_type == DT_DIR &&             \
 176                     (strcmp(evt_dirent->d_name, ".")) &&        \
 177                     (strcmp(evt_dirent->d_name, "..")) &&       \
 178                     (!tp_event_has_id(dir_path, evt_dirent)))
 179
 180 #define MAX_EVENT_LENGTH 512
 181
 182
 183 struct tracepoint_path *tracepoint_id_to_path(u64 config)
 184 {
 185         struct tracepoint_path *path = NULL;
 186         DIR *sys_dir, *evt_dir;
 187         struct dirent *sys_dirent, *evt_dirent;
 188         char id_buf[24];
 189         int fd;
 190         u64 id;
 191         char evt_path[MAXPATHLEN];
 192         char *dir_path;
 193
 194         sys_dir = tracing_events__opendir();
 195         if (!sys_dir)
 196                 return NULL;
 197
 198         for_each_subsystem(sys_dir, sys_dirent) {
 199                 dir_path = get_events_file(sys_dirent->d_name);
 200                 if (!dir_path)
 201                         continue;
 202                 evt_dir = opendir(dir_path);
 203                 if (!evt_dir)
 204                         goto next;
 205
 206                 for_each_event(dir_path, evt_dir, evt_dirent) {
 207
 208                         scnprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
 209                                   evt_dirent->d_name);
 210                         fd = open(evt_path, O_RDONLY);
 211                         if (fd < 0)
 212                                 continue;
 213                         if (read(fd, id_buf, sizeof(id_buf)) < 0) {
 214                                 close(fd);
 215                                 continue;
 216                         }
 217                         close(fd);
 218                         id = atoll(id_buf);
 219                         if (id == config) {
 220                                 put_events_file(dir_path);
 221                                 closedir(evt_dir);
 222                                 closedir(sys_dir);
 223                                 path = zalloc(sizeof(*path));
 224                                 if (!path)
 225                                         return NULL;
 226                                 path->system = malloc(MAX_EVENT_LENGTH);
 227                                 if (!path->system) {
 228                                         free(path);
 229                                         return NULL;
 230                                 }
 231                                 path->name = malloc(MAX_EVENT_LENGTH);
 232                                 if (!path->name) {
 233                                         zfree(&path->system);
 234                                         free(path);
 235                                         return NULL;
 236                                 }
 237                                 strncpy(path->system, sys_dirent->d_name,
 238                                         MAX_EVENT_LENGTH);
 239                                 strncpy(path->name, evt_dirent->d_name,
 240                                         MAX_EVENT_LENGTH);
 241                                 return path;
 242                         }
 243                 }
 244                 closedir(evt_dir);
 245 next:
 246                 put_events_file(dir_path);
 247         }
 248
 249         closedir(sys_dir);
 250         return NULL;
 251 }
 252
 253 struct tracepoint_path *tracepoint_name_to_path(const char *name)
 254 {
 255         struct tracepoint_path *path = zalloc(sizeof(*path));
 256         char *str = strchr(name, ':');
 257
 258         if (path == NULL || str == NULL) {
 259                 free(path);
 260                 return NULL;
 261         }
 262
 263         path->system = strndup(name, str - name);
 264         path->name = strdup(str+1);
 265
 266         if (path->system == NULL || path->name == NULL) {
 267                 zfree(&path->system);
 268                 zfree(&path->name);
 269                 zfree(&path);
 270         }
 271
 272         return path;
 273 }
 274
 275 const char *event_type(int type)
 276 {
 277         switch (type) {
 278         case PERF_TYPE_HARDWARE:
 279                 return "hardware";
 280
 281         case PERF_TYPE_SOFTWARE:
 282                 return "software";
 283
 284         case PERF_TYPE_TRACEPOINT:
 285                 return "tracepoint";
 286
 287         case PERF_TYPE_HW_CACHE:
 288                 return "hardware-cache";
 289
 290         default:
 291                 break;
 292         }
 293
 294         return "unknown";
 295 }
 296
 297 static int parse_events__is_name_term(struct parse_events_term *term)
 298 {
 299         return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
 300 }
 301
 302 static char *get_config_name(struct list_head *head_terms)
 303 {
 304         struct parse_events_term *term;
 305
 306         if (!head_terms)
 307                 return NULL;
 308
 309         list_for_each_entry(term, head_terms, list)
 310                 if (parse_events__is_name_term(term))
 311                         return term->val.str;
 312
 313         return NULL;
 314 }
 315
 316 static struct perf_evsel *
 317 __add_event(struct list_head *list, int *idx,
 318             struct perf_event_attr *attr,
 319             char *name, struct perf_pmu *pmu,
 320             struct list_head *config_terms, bool auto_merge_stats)
 321 {
 322         struct perf_evsel *evsel;
 323         struct cpu_map *cpus = pmu ? pmu->cpus : NULL;
 324
 325         event_attr_init(attr);
 326
 327         evsel = perf_evsel__new_idx(attr, *idx);
 328         if (!evsel)
 329                 return NULL;
 330
 331         (*idx)++;
 332         evsel->cpus        = cpu_map__get(cpus);
 333         evsel->own_cpus    = cpu_map__get(cpus);
 334         evsel->system_wide = pmu ? pmu->is_uncore : false;
 335         evsel->auto_merge_stats = auto_merge_stats;
 336
 337         if (name)
 338                 evsel->name = strdup(name);
 339
 340         if (config_terms)
 341                 list_splice(config_terms, &evsel->config_terms);
 342
 343         list_add_tail(&evsel->node, list);
 344         return evsel;
 345 }
 346
 347 static int add_event(struct list_head *list, int *idx,
 348                      struct perf_event_attr *attr, char *name,
 349                      struct list_head *config_terms)
 350 {
 351         return __add_event(list, idx, attr, name, NULL, config_terms, false) ? 0 : -ENOMEM;
 352 }
 353
 354 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
 355 {
 356         int i, j;
 357         int n, longest = -1;
 358
 359         for (i = 0; i < size; i++) {
 360                 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
 361                         n = strlen(names[i][j]);
 362                         if (n > longest && !strncasecmp(str, names[i][j], n))
 363                                 longest = n;
 364                 }
 365                 if (longest > 0)
 366                         return i;
 367         }
 368
 369         return -1;
 370 }
 371
 372 typedef int config_term_func_t(struct perf_event_attr *attr,
 373                                struct parse_events_term *term,
 374                                struct parse_events_error *err);
 375 static int config_term_common(struct perf_event_attr *attr,
 376                               struct parse_events_term *term,
 377                               struct parse_events_error *err);
 378 static int config_attr(struct perf_event_attr *attr,
 379                        struct list_head *head,
 380                        struct parse_events_error *err,
 381                        config_term_func_t config_term);
 382
 383 int parse_events_add_cache(struct list_head *list, int *idx,
 384                            char *type, char *op_result1, char *op_result2,
 385                            struct parse_events_error *err,
 386                            struct list_head *head_config)
 387 {
 388         struct perf_event_attr attr;
 389         LIST_HEAD(config_terms);
 390         char name[MAX_NAME_LEN], *config_name;
 391         int cache_type = -1, cache_op = -1, cache_result = -1;
 392         char *op_result[2] = { op_result1, op_result2 };
 393         int i, n;
 394
 395         /*
 396          * No fallback - if we cannot get a clear cache type
 397          * then bail out:
 398          */
 399         cache_type = parse_aliases(type, perf_evsel__hw_cache,
 400                                    PERF_COUNT_HW_CACHE_MAX);
 401         if (cache_type == -1)
 402                 return -EINVAL;
 403
 404         config_name = get_config_name(head_config);
 405         n = snprintf(name, MAX_NAME_LEN, "%s", type);
 406
 407         for (i = 0; (i < 2) && (op_result[i]); i++) {
 408                 char *str = op_result[i];
 409
 410                 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
 411
 412                 if (cache_op == -1) {
 413                         cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
 414                                                  PERF_COUNT_HW_CACHE_OP_MAX);
 415                         if (cache_op >= 0) {
 416                                 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
 417                                         return -EINVAL;
 418                                 continue;
 419                         }
 420                 }
 421
 422                 if (cache_result == -1) {
 423                         cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
 424                                                      PERF_COUNT_HW_CACHE_RESULT_MAX);
 425                         if (cache_result >= 0)
 426                                 continue;
 427                 }
 428         }
 429
 430         /*
 431          * Fall back to reads:
 432          */
 433         if (cache_op == -1)
 434                 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
 435
 436         /*
 437          * Fall back to accesses:
 438          */
 439         if (cache_result == -1)
 440                 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
 441
 442         memset(&attr, 0, sizeof(attr));
 443         attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
 444         attr.type = PERF_TYPE_HW_CACHE;
 445
 446         if (head_config) {
 447                 if (config_attr(&attr, head_config, err,
 448                                 config_term_common))
 449                         return -EINVAL;
 450
 451                 if (get_config_terms(head_config, &config_terms))
 452                         return -ENOMEM;
 453         }
 454         return add_event(list, idx, &attr, config_name ? : name, &config_terms);
 455 }
 456
 457 static void tracepoint_error(struct parse_events_error *e, int err,
 458                              const char *sys, const char *name)
 459 {
 460         char help[BUFSIZ];
 461
 462         if (!e)
 463                 return;
 464
 465         /*
 466          * We get error directly from syscall errno ( > 0),
 467          * or from encoded pointer's error ( < 0).
 468          */
 469         err = abs(err);
 470
 471         switch (err) {
 472         case EACCES:
 473                 e->str = strdup("can't access trace events");
 474                 break;
 475         case ENOENT:
 476                 e->str = strdup("unknown tracepoint");
 477                 break;
 478         default:
 479                 e->str = strdup("failed to add tracepoint");
 480                 break;
 481         }
 482
 483         tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
 484         e->help = strdup(help);
 485 }
 486
 487 static int add_tracepoint(struct list_head *list, int *idx,
 488                           const char *sys_name, const char *evt_name,
 489                           struct parse_events_error *err,
 490                           struct list_head *head_config)
 491 {
 492         struct perf_evsel *evsel;
 493
 494         evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
 495         if (IS_ERR(evsel)) {
 496                 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
 497                 return PTR_ERR(evsel);
 498         }
 499
 500         if (head_config) {
 501                 LIST_HEAD(config_terms);
 502
 503                 if (get_config_terms(head_config, &config_terms))
 504                         return -ENOMEM;
 505                 list_splice(&config_terms, &evsel->config_terms);
 506         }
 507
 508         list_add_tail(&evsel->node, list);
 509         return 0;
 510 }
 511
 512 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
 513                                       const char *sys_name, const char *evt_name,
 514                                       struct parse_events_error *err,
 515                                       struct list_head *head_config)
 516 {
 517         char *evt_path;
 518         struct dirent *evt_ent;
 519         DIR *evt_dir;
 520         int ret = 0, found = 0;
 521
 522         evt_path = get_events_file(sys_name);
 523         if (!evt_path) {
 524                 tracepoint_error(err, errno, sys_name, evt_name);
 525                 return -1;
 526         }
 527         evt_dir = opendir(evt_path);
 528         if (!evt_dir) {
 529                 put_events_file(evt_path);
 530                 tracepoint_error(err, errno, sys_name, evt_name);
 531                 return -1;
 532         }
 533
 534         while (!ret && (evt_ent = readdir(evt_dir))) {
 535                 if (!strcmp(evt_ent->d_name, ".")
 536                     || !strcmp(evt_ent->d_name, "..")
 537                     || !strcmp(evt_ent->d_name, "enable")
 538                     || !strcmp(evt_ent->d_name, "filter"))
 539                         continue;
 540
 541                 if (!strglobmatch(evt_ent->d_name, evt_name))
 542                         continue;
 543
 544                 found++;
 545
 546                 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
 547                                      err, head_config);
 548         }
 549
 550         if (!found) {
 551                 tracepoint_error(err, ENOENT, sys_name, evt_name);
 552                 ret = -1;
 553         }
 554
 555         put_events_file(evt_path);
 556         closedir(evt_dir);
 557         return ret;
 558 }
 559
 560 static int add_tracepoint_event(struct list_head *list, int *idx,
 561                                 const char *sys_name, const char *evt_name,
 562                                 struct parse_events_error *err,
 563                                 struct list_head *head_config)
 564 {
 565         return strpbrk(evt_name, "*?") ?
 566                add_tracepoint_multi_event(list, idx, sys_name, evt_name,
 567                                           err, head_config) :
 568                add_tracepoint(list, idx, sys_name, evt_name,
 569                               err, head_config);
 570 }
 571
 572 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
 573                                     const char *sys_name, const char *evt_name,
 574                                     struct parse_events_error *err,
 575                                     struct list_head *head_config)
 576 {
 577         struct dirent *events_ent;
 578         DIR *events_dir;
 579         int ret = 0;
 580
 581         events_dir = tracing_events__opendir();
 582         if (!events_dir) {
 583                 tracepoint_error(err, errno, sys_name, evt_name);
 584                 return -1;
 585         }
 586
 587         while (!ret && (events_ent = readdir(events_dir))) {
 588                 if (!strcmp(events_ent->d_name, ".")
 589                     || !strcmp(events_ent->d_name, "..")
 590                     || !strcmp(events_ent->d_name, "enable")
 591                     || !strcmp(events_ent->d_name, "header_event")
 592                     || !strcmp(events_ent->d_name, "header_page"))
 593                         continue;
 594
 595                 if (!strglobmatch(events_ent->d_name, sys_name))
 596                         continue;
 597
 598                 ret = add_tracepoint_event(list, idx, events_ent->d_name,
 599                                            evt_name, err, head_config);
 600         }
 601
 602         closedir(events_dir);
 603         return ret;
 604 }
 605
 606 struct __add_bpf_event_param {
 607         struct parse_events_state *parse_state;
 608         struct list_head *list;
 609         struct list_head *head_config;
 610 };
 611
 612 static int add_bpf_event(const char *group, const char *event, int fd,
 613                          void *_param)
 614 {
 615         LIST_HEAD(new_evsels);
 616         struct __add_bpf_event_param *param = _param;
 617         struct parse_events_state *parse_state = param->parse_state;
 618         struct list_head *list = param->list;
 619         struct perf_evsel *pos;
 620         int err;
 621
 622         pr_debug("add bpf event %s:%s and attach bpf program %d\n",
 623                  group, event, fd);
 624
 625         err = parse_events_add_tracepoint(&new_evsels, &parse_state->idx, group,
 626                                           event, parse_state->error,
 627                                           param->head_config);
 628         if (err) {
 629                 struct perf_evsel *evsel, *tmp;
 630
 631                 pr_debug("Failed to add BPF event %s:%s\n",
 632                          group, event);
 633                 list_for_each_entry_safe(evsel, tmp, &new_evsels, node) {
 634                         list_del(&evsel->node);
 635                         perf_evsel__delete(evsel);
 636                 }
 637                 return err;
 638         }
 639         pr_debug("adding %s:%s\n", group, event);
 640
 641         list_for_each_entry(pos, &new_evsels, node) {
 642                 pr_debug("adding %s:%s to %p\n",
 643                          group, event, pos);
 644                 pos->bpf_fd = fd;
 645         }
 646         list_splice(&new_evsels, list);
 647         return 0;
 648 }
 649
 650 int parse_events_load_bpf_obj(struct parse_events_state *parse_state,
 651                               struct list_head *list,
 652                               struct bpf_object *obj,
 653                               struct list_head *head_config)
 654 {
 655         int err;
 656         char errbuf[BUFSIZ];
 657         struct __add_bpf_event_param param = {parse_state, list, head_config};
 658         static bool registered_unprobe_atexit = false;
 659
 660         if (IS_ERR(obj) || !obj) {
 661                 snprintf(errbuf, sizeof(errbuf),
 662                          "Internal error: load bpf obj with NULL");
 663                 err = -EINVAL;
 664                 goto errout;
 665         }
 666
 667         /*
 668          * Register atexit handler before calling bpf__probe() so
 669          * bpf__probe() don't need to unprobe probe points its already
 670          * created when failure.
 671          */
 672         if (!registered_unprobe_atexit) {
 673                 atexit(bpf__clear);
 674                 registered_unprobe_atexit = true;
 675         }
 676
 677         err = bpf__probe(obj);
 678         if (err) {
 679                 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
 680                 goto errout;
 681         }
 682
 683         err = bpf__load(obj);
 684         if (err) {
 685                 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
 686                 goto errout;
 687         }
 688
 689         err = bpf__foreach_event(obj, add_bpf_event, &param);
 690         if (err) {
 691                 snprintf(errbuf, sizeof(errbuf),
 692                          "Attach events in BPF object failed");
 693                 goto errout;
 694         }
 695
 696         return 0;
 697 errout:
 698         parse_state->error->help = strdup("(add -v to see detail)");
 699         parse_state->error->str = strdup(errbuf);
 700         return err;
 701 }
 702
 703 static int
 704 parse_events_config_bpf(struct parse_events_state *parse_state,
 705                         struct bpf_object *obj,
 706                         struct list_head *head_config)
 707 {
 708         struct parse_events_term *term;
 709         int error_pos;
 710
 711         if (!head_config || list_empty(head_config))
 712                 return 0;
 713
 714         list_for_each_entry(term, head_config, list) {
 715                 char errbuf[BUFSIZ];
 716                 int err;
 717
 718                 if (term->type_term != PARSE_EVENTS__TERM_TYPE_USER) {
 719                         snprintf(errbuf, sizeof(errbuf),
 720                                  "Invalid config term for BPF object");
 721                         errbuf[BUFSIZ - 1] = '\0';
 722
 723                         parse_state->error->idx = term->err_term;
 724                         parse_state->error->str = strdup(errbuf);
 725                         return -EINVAL;
 726                 }
 727
 728                 err = bpf__config_obj(obj, term, parse_state->evlist, &error_pos);
 729                 if (err) {
 730                         bpf__strerror_config_obj(obj, term, parse_state->evlist,
 731                                                  &error_pos, err, errbuf,
 732                                                  sizeof(errbuf));
 733                         parse_state->error->help = strdup(
 734 "Hint:\tValid config terms:\n"
 735 "     \tmap:[<arraymap>].value<indices>=[value]\n"
 736 "     \tmap:[<eventmap>].event<indices>=[event]\n"
 737 "\n"
 738 "     \twhere <indices> is something like [0,3...5] or [all]\n"
 739 "     \t(add -v to see detail)");
 740                         parse_state->error->str = strdup(errbuf);
 741                         if (err == -BPF_LOADER_ERRNO__OBJCONF_MAP_VALUE)
 742                                 parse_state->error->idx = term->err_val;
 743                         else
 744                                 parse_state->error->idx = term->err_term + error_pos;
 745                         return err;
 746                 }
 747         }
 748         return 0;
 749 }
 750
 751 /*
 752  * Split config terms:
 753  * perf record -e bpf.c/call-graph=fp,map:array.value[0]=1/ ...
 754  *  'call-graph=fp' is 'evt config', should be applied to each
 755  *  events in bpf.c.
 756  * 'map:array.value[0]=1' is 'obj config', should be processed
 757  * with parse_events_config_bpf.
 758  *
 759  * Move object config terms from the first list to obj_head_config.
 760  */
 761 static void
 762 split_bpf_config_terms(struct list_head *evt_head_config,
 763                        struct list_head *obj_head_config)
 764 {
 765         struct parse_events_term *term, *temp;
 766
 767         /*
 768          * Currectly, all possible user config term
 769          * belong to bpf object. parse_events__is_hardcoded_term()
 770          * happends to be a good flag.
 771          *
 772          * See parse_events_config_bpf() and
 773          * config_term_tracepoint().
 774          */
 775         list_for_each_entry_safe(term, temp, evt_head_config, list)
 776                 if (!parse_events__is_hardcoded_term(term))
 777                         list_move_tail(&term->list, obj_head_config);
 778 }
 779
 780 int parse_events_load_bpf(struct parse_events_state *parse_state,
 781                           struct list_head *list,
 782                           char *bpf_file_name,
 783                           bool source,
 784                           struct list_head *head_config)
 785 {
 786         int err;
 787         struct bpf_object *obj;
 788         LIST_HEAD(obj_head_config);
 789
 790         if (head_config)
 791                 split_bpf_config_terms(head_config, &obj_head_config);
 792
 793         obj = bpf__prepare_load(bpf_file_name, source);
 794         if (IS_ERR(obj)) {
 795                 char errbuf[BUFSIZ];
 796
 797                 err = PTR_ERR(obj);
 798
 799                 if (err == -ENOTSUP)
 800                         snprintf(errbuf, sizeof(errbuf),
 801                                  "BPF support is not compiled");
 802                 else
 803                         bpf__strerror_prepare_load(bpf_file_name,
 804                                                    source,
 805                                                    -err, errbuf,
 806                                                    sizeof(errbuf));
 807
 808                 parse_state->error->help = strdup("(add -v to see detail)");
 809                 parse_state->error->str = strdup(errbuf);
 810                 return err;
 811         }
 812
 813         err = parse_events_load_bpf_obj(parse_state, list, obj, head_config);
 814         if (err)
 815                 return err;
 816         err = parse_events_config_bpf(parse_state, obj, &obj_head_config);
 817
 818         /*
 819          * Caller doesn't know anything about obj_head_config,
 820          * so combine them together again before returnning.
 821          */
 822         if (head_config)
 823                 list_splice_tail(&obj_head_config, head_config);
 824         return err;
 825 }
 826
 827 static int
 828 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
 829 {
 830         int i;
 831
 832         for (i = 0; i < 3; i++) {
 833                 if (!type || !type[i])
 834                         break;
 835
 836 #define CHECK_SET_TYPE(bit)             \
 837 do {                                    \
 838         if (attr->bp_type & bit)        \
 839                 return -EINVAL;         \
 840         else                            \
 841                 attr->bp_type |= bit;   \
 842 } while (0)
 843
 844                 switch (type[i]) {
 845                 case 'r':
 846                         CHECK_SET_TYPE(HW_BREAKPOINT_R);
 847                         break;
 848                 case 'w':
 849                         CHECK_SET_TYPE(HW_BREAKPOINT_W);
 850                         break;
 851                 case 'x':
 852                         CHECK_SET_TYPE(HW_BREAKPOINT_X);
 853                         break;
 854                 default:
 855                         return -EINVAL;
 856                 }
 857         }
 858
 859 #undef CHECK_SET_TYPE
 860
 861         if (!attr->bp_type) /* Default */
 862                 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
 863
 864         return 0;
 865 }
 866
 867 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 868                                 void *ptr, char *type, u64 len)
 869 {
 870         struct perf_event_attr attr;
 871
 872         memset(&attr, 0, sizeof(attr));
 873         attr.bp_addr = (unsigned long) ptr;
 874
 875         if (parse_breakpoint_type(type, &attr))
 876                 return -EINVAL;
 877
 878         /* Provide some defaults if len is not specified */
 879         if (!len) {
 880                 if (attr.bp_type == HW_BREAKPOINT_X)
 881                         len = sizeof(long);
 882                 else
 883                         len = HW_BREAKPOINT_LEN_4;
 884         }
 885
 886         attr.bp_len = len;
 887
 888         attr.type = PERF_TYPE_BREAKPOINT;
 889         attr.sample_period = 1;
 890
 891         return add_event(list, idx, &attr, NULL, NULL);
 892 }
 893
 894 static int check_type_val(struct parse_events_term *term,
 895                           struct parse_events_error *err,
 896                           int type)
 897 {
 898         if (type == term->type_val)
 899                 return 0;
 900
 901         if (err) {
 902                 err->idx = term->err_val;
 903                 if (type == PARSE_EVENTS__TERM_TYPE_NUM)
 904                         err->str = strdup("expected numeric value");
 905                 else
 906                         err->str = strdup("expected string value");
 907         }
 908         return -EINVAL;
 909 }
 910
 911 /*
 912  * Update according to parse-events.l
 913  */
 914 static const char *config_term_names[__PARSE_EVENTS__TERM_TYPE_NR] = {
 915         [PARSE_EVENTS__TERM_TYPE_USER]                  = "<sysfs term>",
 916         [PARSE_EVENTS__TERM_TYPE_CONFIG]                = "config",
 917         [PARSE_EVENTS__TERM_TYPE_CONFIG1]               = "config1",
 918         [PARSE_EVENTS__TERM_TYPE_CONFIG2]               = "config2",
 919         [PARSE_EVENTS__TERM_TYPE_NAME]                  = "name",
 920         [PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD]         = "period",
 921         [PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ]           = "freq",
 922         [PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE]    = "branch_type",
 923         [PARSE_EVENTS__TERM_TYPE_TIME]                  = "time",
 924         [PARSE_EVENTS__TERM_TYPE_CALLGRAPH]             = "call-graph",
 925         [PARSE_EVENTS__TERM_TYPE_STACKSIZE]             = "stack-size",
 926         [PARSE_EVENTS__TERM_TYPE_NOINHERIT]             = "no-inherit",
 927         [PARSE_EVENTS__TERM_TYPE_INHERIT]               = "inherit",
 928         [PARSE_EVENTS__TERM_TYPE_MAX_STACK]             = "max-stack",
 929         [PARSE_EVENTS__TERM_TYPE_OVERWRITE]             = "overwrite",
 930         [PARSE_EVENTS__TERM_TYPE_NOOVERWRITE]           = "no-overwrite",
 931         [PARSE_EVENTS__TERM_TYPE_DRV_CFG]               = "driver-config",
 932 };
 933
 934 static bool config_term_shrinked;
 935
 936 static bool
 937 config_term_avail(int term_type, struct parse_events_error *err)
 938 {
 939         if (term_type < 0 || term_type >= __PARSE_EVENTS__TERM_TYPE_NR) {
 940                 err->str = strdup("Invalid term_type");
 941                 return false;
 942         }
 943         if (!config_term_shrinked)
 944                 return true;
 945
 946         switch (term_type) {
 947         case PARSE_EVENTS__TERM_TYPE_CONFIG:
 948         case PARSE_EVENTS__TERM_TYPE_CONFIG1:
 949         case PARSE_EVENTS__TERM_TYPE_CONFIG2:
 950         case PARSE_EVENTS__TERM_TYPE_NAME:
 951         case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
 952                 return true;
 953         default:
 954                 if (!err)
 955                         return false;
 956
 957                 /* term_type is validated so indexing is safe */
 958                 if (asprintf(&err->str, "'%s' is not usable in 'perf stat'",
 959                              config_term_names[term_type]) < 0)
 960                         err->str = NULL;
 961                 return false;
 962         }
 963 }
 964
 965 void parse_events__shrink_config_terms(void)
 966 {
 967         config_term_shrinked = true;
 968 }
 969
 970 static int config_term_common(struct perf_event_attr *attr,
 971                               struct parse_events_term *term,
 972                               struct parse_events_error *err)
 973 {
 974 #define CHECK_TYPE_VAL(type)                                               \
 975 do {                                                                       \
 976         if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
 977                 return -EINVAL;                                            \
 978 } while (0)
 979
 980         switch (term->type_term) {
 981         case PARSE_EVENTS__TERM_TYPE_CONFIG:
 982                 CHECK_TYPE_VAL(NUM);
 983                 attr->config = term->val.num;
 984                 break;
 985         case PARSE_EVENTS__TERM_TYPE_CONFIG1:
 986                 CHECK_TYPE_VAL(NUM);
 987                 attr->config1 = term->val.num;
 988                 break;
 989         case PARSE_EVENTS__TERM_TYPE_CONFIG2:
 990                 CHECK_TYPE_VAL(NUM);
 991                 attr->config2 = term->val.num;
 992                 break;
 993         case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
 994                 CHECK_TYPE_VAL(NUM);
 995                 break;
 996         case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
 997                 CHECK_TYPE_VAL(NUM);
 998                 break;
 999         case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1000                 CHECK_TYPE_VAL(STR);
1001                 if (strcmp(term->val.str, "no") &&
1002                     parse_branch_str(term->val.str, &attr->branch_sample_type)) {
1003                         err->str = strdup("invalid branch sample type");
1004                         err->idx = term->err_val;
1005                         return -EINVAL;
1006                 }
1007                 break;
1008         case PARSE_EVENTS__TERM_TYPE_TIME:
1009                 CHECK_TYPE_VAL(NUM);
1010                 if (term->val.num > 1) {
1011                         err->str = strdup("expected 0 or 1");
1012                         err->idx = term->err_val;
1013                         return -EINVAL;
1014                 }
1015                 break;
1016         case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1017                 CHECK_TYPE_VAL(STR);
1018                 break;
1019         case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1020                 CHECK_TYPE_VAL(NUM);
1021                 break;
1022         case PARSE_EVENTS__TERM_TYPE_INHERIT:
1023                 CHECK_TYPE_VAL(NUM);
1024                 break;
1025         case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1026                 CHECK_TYPE_VAL(NUM);
1027                 break;
1028         case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1029                 CHECK_TYPE_VAL(NUM);
1030                 break;
1031         case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1032                 CHECK_TYPE_VAL(NUM);
1033                 break;
1034         case PARSE_EVENTS__TERM_TYPE_NAME:
1035                 CHECK_TYPE_VAL(STR);
1036                 break;
1037         case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1038                 CHECK_TYPE_VAL(NUM);
1039                 break;
1040         default:
1041                 err->str = strdup("unknown term");
1042                 err->idx = term->err_term;
1043                 err->help = parse_events_formats_error_string(NULL);
1044                 return -EINVAL;
1045         }
1046
1047         /*
1048          * Check term availbility after basic checking so
1049          * PARSE_EVENTS__TERM_TYPE_USER can be found and filtered.
1050          *
1051          * If check availbility at the entry of this function,
1052          * user will see "'<sysfs term>' is not usable in 'perf stat'"
1053          * if an invalid config term is provided for legacy events
1054          * (for example, instructions/badterm/...), which is confusing.
1055          */
1056         if (!config_term_avail(term->type_term, err))
1057                 return -EINVAL;
1058         return 0;
1059 #undef CHECK_TYPE_VAL
1060 }
1061
1062 static int config_term_pmu(struct perf_event_attr *attr,
1063                            struct parse_events_term *term,
1064                            struct parse_events_error *err)
1065 {
1066         if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER ||
1067             term->type_term == PARSE_EVENTS__TERM_TYPE_DRV_CFG)
1068                 /*
1069                  * Always succeed for sysfs terms, as we dont know
1070                  * at this point what type they need to have.
1071                  */
1072                 return 0;
1073         else
1074                 return config_term_common(attr, term, err);
1075 }
1076
1077 static int config_term_tracepoint(struct perf_event_attr *attr,
1078                                   struct parse_events_term *term,
1079                                   struct parse_events_error *err)
1080 {
1081         switch (term->type_term) {
1082         case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1083         case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1084         case PARSE_EVENTS__TERM_TYPE_INHERIT:
1085         case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1086         case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1087         case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1088         case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1089                 return config_term_common(attr, term, err);
1090         default:
1091                 if (err) {
1092                         err->idx = term->err_term;
1093                         err->str = strdup("unknown term");
1094                         err->help = strdup("valid terms: call-graph,stack-size\n");
1095                 }
1096                 return -EINVAL;
1097         }
1098
1099         return 0;
1100 }
1101
1102 static int config_attr(struct perf_event_attr *attr,
1103                        struct list_head *head,
1104                        struct parse_events_error *err,
1105                        config_term_func_t config_term)
1106 {
1107         struct parse_events_term *term;
1108
1109         list_for_each_entry(term, head, list)
1110                 if (config_term(attr, term, err))
1111                         return -EINVAL;
1112
1113         return 0;
1114 }
1115
1116 static int get_config_terms(struct list_head *head_config,
1117                             struct list_head *head_terms __maybe_unused)
1118 {
1119 #define ADD_CONFIG_TERM(__type, __name, __val)                  \
1120 do {                                                            \
1121         struct perf_evsel_config_term *__t;                     \
1122                                                                 \
1123         __t = zalloc(sizeof(*__t));                             \
1124         if (!__t)                                               \
1125                 return -ENOMEM;                                 \
1126                                                                 \
1127         INIT_LIST_HEAD(&__t->list);                             \
1128         __t->type       = PERF_EVSEL__CONFIG_TERM_ ## __type;   \
1129         __t->val.__name = __val;                                \
1130         __t->weak       = term->weak;                           \
1131         list_add_tail(&__t->list, head_terms);                  \
1132 } while (0)
1133
1134         struct parse_events_term *term;
1135
1136         list_for_each_entry(term, head_config, list) {
1137                 switch (term->type_term) {
1138                 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
1139                         ADD_CONFIG_TERM(PERIOD, period, term->val.num);
1140                         break;
1141                 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
1142                         ADD_CONFIG_TERM(FREQ, freq, term->val.num);
1143                         break;
1144                 case PARSE_EVENTS__TERM_TYPE_TIME:
1145                         ADD_CONFIG_TERM(TIME, time, term->val.num);
1146                         break;
1147                 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
1148                         ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
1149                         break;
1150                 case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
1151                         ADD_CONFIG_TERM(BRANCH, branch, term->val.str);
1152                         break;
1153                 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
1154                         ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
1155                         break;
1156                 case PARSE_EVENTS__TERM_TYPE_INHERIT:
1157                         ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
1158                         break;
1159                 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
1160                         ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
1161                         break;
1162                 case PARSE_EVENTS__TERM_TYPE_MAX_STACK:
1163                         ADD_CONFIG_TERM(MAX_STACK, max_stack, term->val.num);
1164                         break;
1165                 case PARSE_EVENTS__TERM_TYPE_OVERWRITE:
1166                         ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 1 : 0);
1167                         break;
1168                 case PARSE_EVENTS__TERM_TYPE_NOOVERWRITE:
1169                         ADD_CONFIG_TERM(OVERWRITE, overwrite, term->val.num ? 0 : 1);
1170                         break;
1171                 case PARSE_EVENTS__TERM_TYPE_DRV_CFG:
1172                         ADD_CONFIG_TERM(DRV_CFG, drv_cfg, term->val.str);
1173                         break;
1174                 default:
1175                         break;
1176                 }
1177         }
1178 #undef ADD_EVSEL_CONFIG
1179         return 0;
1180 }
1181
1182 int parse_events_add_tracepoint(struct list_head *list, int *idx,
1183                                 const char *sys, const char *event,
1184                                 struct parse_events_error *err,
1185                                 struct list_head *head_config)
1186 {
1187         if (head_config) {
1188                 struct perf_event_attr attr;
1189
1190                 if (config_attr(&attr, head_config, err,
1191                                 config_term_tracepoint))
1192                         return -EINVAL;
1193         }
1194
1195         if (strpbrk(sys, "*?"))
1196                 return add_tracepoint_multi_sys(list, idx, sys, event,
1197                                                 err, head_config);
1198         else
1199                 return add_tracepoint_event(list, idx, sys, event,
1200                                             err, head_config);
1201 }
1202
1203 int parse_events_add_numeric(struct parse_events_state *parse_state,
1204                              struct list_head *list,
1205                              u32 type, u64 config,
1206                              struct list_head *head_config)
1207 {
1208         struct perf_event_attr attr;
1209         LIST_HEAD(config_terms);
1210
1211         memset(&attr, 0, sizeof(attr));
1212         attr.type = type;
1213         attr.config = config;
1214
1215         if (head_config) {
1216                 if (config_attr(&attr, head_config, parse_state->error,
1217                                 config_term_common))
1218                         return -EINVAL;
1219
1220                 if (get_config_terms(head_config, &config_terms))
1221                         return -ENOMEM;
1222         }
1223
1224         return add_event(list, &parse_state->idx, &attr,
1225                          get_config_name(head_config), &config_terms);
1226 }
1227
1228 int parse_events_add_pmu(struct parse_events_state *parse_state,
1229                          struct list_head *list, char *name,
1230                          struct list_head *head_config,
1231                          bool auto_merge_stats,
1232                          bool use_alias)
1233 {
1234         struct perf_event_attr attr;
1235         struct perf_pmu_info info;
1236         struct perf_pmu *pmu;
1237         struct perf_evsel *evsel;
1238         struct parse_events_error *err = parse_state->error;
1239         bool use_uncore_alias;
1240         LIST_HEAD(config_terms);
1241
1242         pmu = perf_pmu__find(name);
1243         if (!pmu) {
1244                 if (asprintf(&err->str,
1245                                 "Cannot find PMU `%s'. Missing kernel support?",
1246                                 name) < 0)
1247                         err->str = NULL;
1248                 return -EINVAL;
1249         }
1250
1251         if (pmu->default_config) {
1252                 memcpy(&attr, pmu->default_config,
1253                        sizeof(struct perf_event_attr));
1254         } else {
1255                 memset(&attr, 0, sizeof(attr));
1256         }
1257
1258         use_uncore_alias = (pmu->is_uncore && use_alias);
1259
1260         if (!head_config) {
1261                 attr.type = pmu->type;
1262                 evsel = __add_event(list, &parse_state->idx, &attr, NULL, pmu, NULL, auto_merge_stats);
1263                 if (evsel) {
1264                         evsel->pmu_name = name;
1265                         evsel->use_uncore_alias = use_uncore_alias;
1266                         return 0;
1267                 } else {
1268                         return -ENOMEM;
1269                 }
1270         }
1271
1272         if (perf_pmu__check_alias(pmu, head_config, &info))
1273                 return -EINVAL;
1274
1275         /*
1276          * Configure hardcoded terms first, no need to check
1277          * return value when called with fail == 0 ;)
1278          */
1279         if (config_attr(&attr, head_config, parse_state->error, config_term_pmu))
1280                 return -EINVAL;
1281
1282         if (get_config_terms(head_config, &config_terms))
1283                 return -ENOMEM;
1284
1285         if (perf_pmu__config(pmu, &attr, head_config, parse_state->error))
1286                 return -EINVAL;
1287
1288         evsel = __add_event(list, &parse_state->idx, &attr,
1289                             get_config_name(head_config), pmu,
1290                             &config_terms, auto_merge_stats);
1291         if (evsel) {
1292                 evsel->unit = info.unit;
1293                 evsel->scale = info.scale;
1294                 evsel->per_pkg = info.per_pkg;
1295                 evsel->snapshot = info.snapshot;
1296                 evsel->metric_expr = info.metric_expr;
1297                 evsel->metric_name = info.metric_name;
1298                 evsel->pmu_name = name;
1299                 evsel->use_uncore_alias = use_uncore_alias;
1300         }
1301
1302         return evsel ? 0 : -ENOMEM;
1303 }
1304
1305 int parse_events_multi_pmu_add(struct parse_events_state *parse_state,
1306                                char *str, struct list_head **listp)
1307 {
1308         struct list_head *head;
1309         struct parse_events_term *term;
1310         struct list_head *list;
1311         struct perf_pmu *pmu = NULL;
1312         int ok = 0;
1313
1314         *listp = NULL;
1315         /* Add it for all PMUs that support the alias */
1316         list = malloc(sizeof(struct list_head));
1317         if (!list)
1318                 return -1;
1319         INIT_LIST_HEAD(list);
1320         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1321                 struct perf_pmu_alias *alias;
1322
1323                 list_for_each_entry(alias, &pmu->aliases, list) {
1324                         if (!strcasecmp(alias->name, str)) {
1325                                 head = malloc(sizeof(struct list_head));
1326                                 if (!head)
1327                                         return -1;
1328                                 INIT_LIST_HEAD(head);
1329                                 if (parse_events_term__num(&term, PARSE_EVENTS__TERM_TYPE_USER,
1330                                                            str, 1, false, &str, NULL) < 0)
1331                                         return -1;
1332                                 list_add_tail(&term->list, head);
1333
1334                                 if (!parse_events_add_pmu(parse_state, list,
1335                                                           pmu->name, head,
1336                                                           true, true)) {
1337                                         pr_debug("%s -> %s/%s/\n", str,
1338                                                  pmu->name, alias->str);
1339                                         ok++;
1340                                 }
1341
1342                                 parse_events_terms__delete(head);
1343                         }
1344                 }
1345         }
1346         if (!ok)
1347                 return -1;
1348         *listp = list;
1349         return 0;
1350 }
1351
1352 int parse_events__modifier_group(struct list_head *list,
1353                                  char *event_mod)
1354 {
1355         return parse_events__modifier_event(list, event_mod, true);
1356 }
1357
1358 /*
1359  * Check if the two uncore PMUs are from the same uncore block
1360  * The format of the uncore PMU name is uncore_#blockname_#pmuidx
1361  */
1362 static bool is_same_uncore_block(const char *pmu_name_a, const char *pmu_name_b)
1363 {
1364         char *end_a, *end_b;
1365
1366         end_a = strrchr(pmu_name_a, '_');
1367         end_b = strrchr(pmu_name_b, '_');
1368
1369         if (!end_a || !end_b)
1370                 return false;
1371
1372         if ((end_a - pmu_name_a) != (end_b - pmu_name_b))
1373                 return false;
1374
1375         return (strncmp(pmu_name_a, pmu_name_b, end_a - pmu_name_a) == 0);
1376 }
1377
1378 static int
1379 parse_events__set_leader_for_uncore_aliase(char *name, struct list_head *list,
1380                                            struct parse_events_state *parse_state)
1381 {
1382         struct perf_evsel *evsel, *leader;
1383         uintptr_t *leaders;
1384         bool is_leader = true;
1385         int i, nr_pmu = 0, total_members, ret = 0;
1386
1387         leader = list_first_entry(list, struct perf_evsel, node);
1388         evsel = list_last_entry(list, struct perf_evsel, node);
1389         total_members = evsel->idx - leader->idx + 1;
1390
1391         leaders = calloc(total_members, sizeof(uintptr_t));
1392         if (WARN_ON(!leaders))
1393                 return 0;
1394
1395         /*
1396          * Going through the whole group and doing sanity check.
1397          * All members must use alias, and be from the same uncore block.
1398          * Also, storing the leader events in an array.
1399          */
1400         __evlist__for_each_entry(list, evsel) {
1401
1402                 /* Only split the uncore group which members use alias */
1403                 if (!evsel->use_uncore_alias)
1404                         goto out;
1405
1406                 /* The events must be from the same uncore block */
1407                 if (!is_same_uncore_block(leader->pmu_name, evsel->pmu_name))
1408                         goto out;
1409
1410                 if (!is_leader)
1411                         continue;
1412                 /*
1413                  * If the event's PMU name starts to repeat, it must be a new
1414                  * event. That can be used to distinguish the leader from
1415                  * other members, even they have the same event name.
1416                  */
1417                 if ((leader != evsel) && (leader->pmu_name == evsel->pmu_name)) {
1418                         is_leader = false;
1419                         continue;
1420                 }
1421                 /* The name is always alias name */
1422                 WARN_ON(strcmp(leader->name, evsel->name));
1423
1424                 /* Store the leader event for each PMU */
1425                 leaders[nr_pmu++] = (uintptr_t) evsel;
1426         }
1427
1428         /* only one event alias */
1429         if (nr_pmu == total_members) {
1430                 parse_state->nr_groups--;
1431                 goto handled;
1432         }
1433
1434         /*
1435          * An uncore event alias is a joint name which means the same event
1436          * runs on all PMUs of a block.
1437          * Perf doesn't support mixed events from different PMUs in the same
1438          * group. The big group has to be split into multiple small groups
1439          * which only include the events from the same PMU.
1440          *
1441          * Here the uncore event aliases must be from the same uncore block.
1442          * The number of PMUs must be same for each alias. The number of new
1443          * small groups equals to the number of PMUs.
1444          * Setting the leader event for corresponding members in each group.
1445          */
1446         i = 0;
1447         __evlist__for_each_entry(list, evsel) {
1448                 if (i >= nr_pmu)
1449                         i = 0;
1450                 evsel->leader = (struct perf_evsel *) leaders[i++];
1451         }
1452
1453         /* The number of members and group name are same for each group */
1454         for (i = 0; i < nr_pmu; i++) {
1455                 evsel = (struct perf_evsel *) leaders[i];
1456                 evsel->nr_members = total_members / nr_pmu;
1457                 evsel->group_name = name ? strdup(name) : NULL;
1458         }
1459
1460         /* Take the new small groups into account */
1461         parse_state->nr_groups += nr_pmu - 1;
1462
1463 handled:
1464         ret = 1;
1465 out:
1466         free(leaders);
1467         return ret;
1468 }
1469
1470 void parse_events__set_leader(char *name, struct list_head *list,
1471                               struct parse_events_state *parse_state)
1472 {
1473         struct perf_evsel *leader;
1474
1475         if (list_empty(list)) {
1476                 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1477                 return;
1478         }
1479
1480         if (parse_events__set_leader_for_uncore_aliase(name, list, parse_state))
1481                 return;
1482
1483         __perf_evlist__set_leader(list);
1484         leader = list_entry(list->next, struct perf_evsel, node);
1485         leader->group_name = name ? strdup(name) : NULL;
1486 }
1487
1488 /* list_event is assumed to point to malloc'ed memory */
1489 void parse_events_update_lists(struct list_head *list_event,
1490                                struct list_head *list_all)
1491 {
1492         /*
1493          * Called for single event definition. Update the
1494          * 'all event' list, and reinit the 'single event'
1495          * list, for next event definition.
1496          */
1497         list_splice_tail(list_event, list_all);
1498         free(list_event);
1499 }
1500
1501 struct event_modifier {
1502         int eu;
1503         int ek;
1504         int eh;
1505         int eH;
1506         int eG;
1507         int eI;
1508         int precise;
1509         int precise_max;
1510         int exclude_GH;
1511         int sample_read;
1512         int pinned;
1513         int weak;
1514 };
1515
1516 static int get_event_modifier(struct event_modifier *mod, char *str,
1517                                struct perf_evsel *evsel)
1518 {
1519         int eu = evsel ? evsel->attr.exclude_user : 0;
1520         int ek = evsel ? evsel->attr.exclude_kernel : 0;
1521         int eh = evsel ? evsel->attr.exclude_hv : 0;
1522         int eH = evsel ? evsel->attr.exclude_host : 0;
1523         int eG = evsel ? evsel->attr.exclude_guest : 0;
1524         int eI = evsel ? evsel->attr.exclude_idle : 0;
1525         int precise = evsel ? evsel->attr.precise_ip : 0;
1526         int precise_max = 0;
1527         int sample_read = 0;
1528         int pinned = evsel ? evsel->attr.pinned : 0;
1529
1530         int exclude = eu | ek | eh;
1531         int exclude_GH = evsel ? evsel->exclude_GH : 0;
1532         int weak = 0;
1533
1534         memset(mod, 0, sizeof(*mod));
1535
1536         while (*str) {
1537                 if (*str == 'u') {
1538                         if (!exclude)
1539                                 exclude = eu = ek = eh = 1;
1540                         eu = 0;
1541                 } else if (*str == 'k') {
1542                         if (!exclude)
1543                                 exclude = eu = ek = eh = 1;
1544                         ek = 0;
1545                 } else if (*str == 'h') {
1546                         if (!exclude)
1547                                 exclude = eu = ek = eh = 1;
1548                         eh = 0;
1549                 } else if (*str == 'G') {
1550                         if (!exclude_GH)
1551                                 exclude_GH = eG = eH = 1;
1552                         eG = 0;
1553                 } else if (*str == 'H') {
1554                         if (!exclude_GH)
1555                                 exclude_GH = eG = eH = 1;
1556                         eH = 0;
1557                 } else if (*str == 'I') {
1558                         eI = 1;
1559                 } else if (*str == 'p') {
1560                         precise++;
1561                         /* use of precise requires exclude_guest */
1562                         if (!exclude_GH)
1563                                 eG = 1;
1564                 } else if (*str == 'P') {
1565                         precise_max = 1;
1566                 } else if (*str == 'S') {
1567                         sample_read = 1;
1568                 } else if (*str == 'D') {
1569                         pinned = 1;
1570                 } else if (*str == 'W') {
1571                         weak = 1;
1572                 } else
1573                         break;
1574
1575                 ++str;
1576         }
1577
1578         /*
1579          * precise ip:
1580          *
1581          *  0 - SAMPLE_IP can have arbitrary skid
1582          *  1 - SAMPLE_IP must have constant skid
1583          *  2 - SAMPLE_IP requested to have 0 skid
1584          *  3 - SAMPLE_IP must have 0 skid
1585          *
1586          *  See also PERF_RECORD_MISC_EXACT_IP
1587          */
1588         if (precise > 3)
1589                 return -EINVAL;
1590
1591         mod->eu = eu;
1592         mod->ek = ek;
1593         mod->eh = eh;
1594         mod->eH = eH;
1595         mod->eG = eG;
1596         mod->eI = eI;
1597         mod->precise = precise;
1598         mod->precise_max = precise_max;
1599         mod->exclude_GH = exclude_GH;
1600         mod->sample_read = sample_read;
1601         mod->pinned = pinned;
1602         mod->weak = weak;
1603
1604         return 0;
1605 }
1606
1607 /*
1608  * Basic modifier sanity check to validate it contains only one
1609  * instance of any modifier (apart from 'p') present.
1610  */
1611 static int check_modifier(char *str)
1612 {
1613         char *p = str;
1614
1615         /* The sizeof includes 0 byte as well. */
1616         if (strlen(str) > (sizeof("ukhGHpppPSDIW") - 1))
1617                 return -1;
1618
1619         while (*p) {
1620                 if (*p != 'p' && strchr(p + 1, *p))
1621                         return -1;
1622                 p++;
1623         }
1624
1625         return 0;
1626 }
1627
1628 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1629 {
1630         struct perf_evsel *evsel;
1631         struct event_modifier mod;
1632
1633         if (str == NULL)
1634                 return 0;
1635
1636         if (check_modifier(str))
1637                 return -EINVAL;
1638
1639         if (!add && get_event_modifier(&mod, str, NULL))
1640                 return -EINVAL;
1641
1642         __evlist__for_each_entry(list, evsel) {
1643                 if (add && get_event_modifier(&mod, str, evsel))
1644                         return -EINVAL;
1645
1646                 evsel->attr.exclude_user   = mod.eu;
1647                 evsel->attr.exclude_kernel = mod.ek;
1648                 evsel->attr.exclude_hv     = mod.eh;
1649                 evsel->attr.precise_ip     = mod.precise;
1650                 evsel->attr.exclude_host   = mod.eH;
1651                 evsel->attr.exclude_guest  = mod.eG;
1652                 evsel->attr.exclude_idle   = mod.eI;
1653                 evsel->exclude_GH          = mod.exclude_GH;
1654                 evsel->sample_read         = mod.sample_read;
1655                 evsel->precise_max         = mod.precise_max;
1656                 evsel->weak_group          = mod.weak;
1657
1658                 if (perf_evsel__is_group_leader(evsel))
1659                         evsel->attr.pinned = mod.pinned;
1660         }
1661
1662         return 0;
1663 }
1664
1665 int parse_events_name(struct list_head *list, char *name)
1666 {
1667         struct perf_evsel *evsel;
1668
1669         __evlist__for_each_entry(list, evsel) {
1670                 if (!evsel->name)
1671                         evsel->name = strdup(name);
1672         }
1673
1674         return 0;
1675 }
1676
1677 static int
1678 comp_pmu(const void *p1, const void *p2)
1679 {
1680         struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1681         struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1682
1683         return strcasecmp(pmu1->symbol, pmu2->symbol);
1684 }
1685
1686 static void perf_pmu__parse_cleanup(void)
1687 {
1688         if (perf_pmu_events_list_num > 0) {
1689                 struct perf_pmu_event_symbol *p;
1690                 int i;
1691
1692                 for (i = 0; i < perf_pmu_events_list_num; i++) {
1693                         p = perf_pmu_events_list + i;
1694                         zfree(&p->symbol);
1695                 }
1696                 zfree(&perf_pmu_events_list);
1697                 perf_pmu_events_list_num = 0;
1698         }
1699 }
1700
1701 #define SET_SYMBOL(str, stype)          \
1702 do {                                    \
1703         p->symbol = str;                \
1704         if (!p->symbol)                 \
1705                 goto err;               \
1706         p->type = stype;                \
1707 } while (0)
1708
1709 /*
1710  * Read the pmu events list from sysfs
1711  * Save it into perf_pmu_events_list
1712  */
1713 static void perf_pmu__parse_init(void)
1714 {
1715
1716         struct perf_pmu *pmu = NULL;
1717         struct perf_pmu_alias *alias;
1718         int len = 0;
1719
1720         pmu = NULL;
1721         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1722                 list_for_each_entry(alias, &pmu->aliases, list) {
1723                         if (strchr(alias->name, '-'))
1724                                 len++;
1725                         len++;
1726                 }
1727         }
1728
1729         if (len == 0) {
1730                 perf_pmu_events_list_num = -1;
1731                 return;
1732         }
1733         perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1734         if (!perf_pmu_events_list)
1735                 return;
1736         perf_pmu_events_list_num = len;
1737
1738         len = 0;
1739         pmu = NULL;
1740         while ((pmu = perf_pmu__scan(pmu)) != NULL) {
1741                 list_for_each_entry(alias, &pmu->aliases, list) {
1742                         struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1743                         char *tmp = strchr(alias->name, '-');
1744
1745                         if (tmp != NULL) {
1746                                 SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1747                                                 PMU_EVENT_SYMBOL_PREFIX);
1748                                 p++;
1749                                 SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1750                                 len += 2;
1751                         } else {
1752                                 SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1753                                 len++;
1754                         }
1755                 }
1756         }
1757         qsort(perf_pmu_events_list, len,
1758                 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1759
1760         return;
1761 err:
1762         perf_pmu__parse_cleanup();
1763 }
1764
1765 enum perf_pmu_event_symbol_type
1766 perf_pmu__parse_check(const char *name)
1767 {
1768         struct perf_pmu_event_symbol p, *r;
1769
1770         /* scan kernel pmu events from sysfs if needed */
1771         if (perf_pmu_events_list_num == 0)
1772                 perf_pmu__parse_init();
1773         /*
1774          * name "cpu" could be prefix of cpu-cycles or cpu// events.
1775          * cpu-cycles has been handled by hardcode.
1776          * So it must be cpu// events, not kernel pmu event.
1777          */
1778         if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1779                 return PMU_EVENT_SYMBOL_ERR;
1780
1781         p.symbol = strdup(name);
1782         r = bsearch(&p, perf_pmu_events_list,
1783                         (size_t) perf_pmu_events_list_num,
1784                         sizeof(struct perf_pmu_event_symbol), comp_pmu);
1785         zfree(&p.symbol);
1786         return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1787 }
1788
1789 static int parse_events__scanner(const char *str, void *parse_state, int start_token)
1790 {
1791         YY_BUFFER_STATE buffer;
1792         void *scanner;
1793         int ret;
1794
1795         ret = parse_events_lex_init_extra(start_token, &scanner);
1796         if (ret)
1797                 return ret;
1798
1799         buffer = parse_events__scan_string(str, scanner);
1800
1801 #ifdef PARSER_DEBUG
1802         parse_events_debug = 1;
1803 #endif
1804         ret = parse_events_parse(parse_state, scanner);
1805
1806         parse_events__flush_buffer(buffer, scanner);
1807         parse_events__delete_buffer(buffer, scanner);
1808         parse_events_lex_destroy(scanner);
1809         return ret;
1810 }
1811
1812 /*
1813  * parse event config string, return a list of event terms.
1814  */
1815 int parse_events_terms(struct list_head *terms, const char *str)
1816 {
1817         struct parse_events_state parse_state = {
1818                 .terms = NULL,
1819         };
1820         int ret;
1821
1822         ret = parse_events__scanner(str, &parse_state, PE_START_TERMS);
1823         if (!ret) {
1824                 list_splice(parse_state.terms, terms);
1825                 zfree(&parse_state.terms);
1826                 return 0;
1827         }
1828
1829         parse_events_terms__delete(parse_state.terms);
1830         return ret;
1831 }
1832
1833 int parse_events(struct perf_evlist *evlist, const char *str,
1834                  struct parse_events_error *err)
1835 {
1836         struct parse_events_state parse_state = {
1837                 .list   = LIST_HEAD_INIT(parse_state.list),
1838                 .idx    = evlist->nr_entries,
1839                 .error  = err,
1840                 .evlist = evlist,
1841         };
1842         int ret;
1843
1844         ret = parse_events__scanner(str, &parse_state, PE_START_EVENTS);
1845         perf_pmu__parse_cleanup();
1846
1847         if (!ret && list_empty(&parse_state.list)) {
1848                 WARN_ONCE(true, "WARNING: event parser found nothing\n");
1849                 return -1;
1850         }
1851
1852         /*
1853          * Add list to the evlist even with errors to allow callers to clean up.
1854          */
1855         perf_evlist__splice_list_tail(evlist, &parse_state.list);
1856
1857         if (!ret) {
1858                 struct perf_evsel *last;
1859
1860                 evlist->nr_groups += parse_state.nr_groups;
1861                 last = perf_evlist__last(evlist);
1862                 last->cmdline_group_boundary = true;
1863
1864                 return 0;
1865         }
1866
1867         /*
1868          * There are 2 users - builtin-record and builtin-test objects.
1869          * Both call perf_evlist__delete in case of error, so we dont
1870          * need to bother.
1871          */
1872         return ret;
1873 }
1874
1875 #define MAX_WIDTH 1000
1876 static int get_term_width(void)
1877 {
1878         struct winsize ws;
1879
1880         get_term_dimensions(&ws);
1881         return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1882 }
1883
1884 void parse_events_print_error(struct parse_events_error *err,
1885                               const char *event)
1886 {
1887         const char *str = "invalid or unsupported event: ";
1888         char _buf[MAX_WIDTH];
1889         char *buf = (char *) event;
1890         int idx = 0;
1891
1892         if (err->str) {
1893                 /* -2 for extra '' in the final fprintf */
1894                 int width       = get_term_width() - 2;
1895                 int len_event   = strlen(event);
1896                 int len_str, max_len, cut = 0;
1897
1898                 /*
1899                  * Maximum error index indent, we will cut
1900                  * the event string if it's bigger.
1901                  */
1902                 int max_err_idx = 13;
1903
1904                 /*
1905                  * Let's be specific with the message when
1906                  * we have the precise error.
1907                  */
1908                 str     = "event syntax error: ";
1909                 len_str = strlen(str);
1910                 max_len = width - len_str;
1911
1912                 buf = _buf;
1913
1914                 /* We're cutting from the beginning. */
1915                 if (err->idx > max_err_idx)
1916                         cut = err->idx - max_err_idx;
1917
1918                 strncpy(buf, event + cut, max_len);
1919
1920                 /* Mark cut parts with '..' on both sides. */
1921                 if (cut)
1922                         buf[0] = buf[1] = '.';
1923
1924                 if ((len_event - cut) > max_len) {
1925                         buf[max_len - 1] = buf[max_len - 2] = '.';
1926                         buf[max_len] = 0;
1927                 }
1928
1929                 idx = len_str + err->idx - cut;
1930         }
1931
1932         fprintf(stderr, "%s'%s'\n", str, buf);
1933         if (idx) {
1934                 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
1935                 if (err->help)
1936                         fprintf(stderr, "\n%s\n", err->help);
1937                 zfree(&err->str);
1938                 zfree(&err->help);
1939         }
1940 }
1941
1942 #undef MAX_WIDTH
1943
1944 int parse_events_option(const struct option *opt, const char *str,
1945                         int unset __maybe_unused)
1946 {
1947         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1948         struct parse_events_error err = { .idx = 0, };
1949         int ret = parse_events(evlist, str, &err);
1950
1951         if (ret) {
1952                 parse_events_print_error(&err, str);
1953                 fprintf(stderr, "Run 'perf list' for a list of valid events\n");
1954         }
1955
1956         return ret;
1957 }
1958
1959 static int
1960 foreach_evsel_in_last_glob(struct perf_evlist *evlist,
1961                            int (*func)(struct perf_evsel *evsel,
1962                                        const void *arg),
1963                            const void *arg)
1964 {
1965         struct perf_evsel *last = NULL;
1966         int err;
1967
1968         /*
1969          * Don't return when list_empty, give func a chance to report
1970          * error when it found last == NULL.
1971          *
1972          * So no need to WARN here, let *func do this.
1973          */
1974         if (evlist->nr_entries > 0)
1975                 last = perf_evlist__last(evlist);
1976
1977         do {
1978                 err = (*func)(last, arg);
1979                 if (err)
1980                         return -1;
1981                 if (!last)
1982                         return 0;
1983
1984                 if (last->node.prev == &evlist->entries)
1985                         return 0;
1986                 last = list_entry(last->node.prev, struct perf_evsel, node);
1987         } while (!last->cmdline_group_boundary);
1988
1989         return 0;
1990 }
1991
1992 static int set_filter(struct perf_evsel *evsel, const void *arg)
1993 {
1994         const char *str = arg;
1995         bool found = false;
1996         int nr_addr_filters = 0;
1997         struct perf_pmu *pmu = NULL;
1998
1999         if (evsel == NULL) {
2000                 fprintf(stderr,
2001                         "--filter option should follow a -e tracepoint or HW tracer option\n");
2002                 return -1;
2003         }
2004
2005         if (evsel->attr.type == PERF_TYPE_TRACEPOINT) {
2006                 if (perf_evsel__append_tp_filter(evsel, str) < 0) {
2007                         fprintf(stderr,
2008                                 "not enough memory to hold filter string\n");
2009                         return -1;
2010                 }
2011
2012                 return 0;
2013         }
2014
2015         while ((pmu = perf_pmu__scan(pmu)) != NULL)
2016                 if (pmu->type == evsel->attr.type) {
2017                         found = true;
2018                         break;
2019                 }
2020
2021         if (found)
2022                 perf_pmu__scan_file(pmu, "nr_addr_filters",
2023                                     "%d", &nr_addr_filters);
2024
2025         if (!nr_addr_filters) {
2026                 fprintf(stderr,
2027                         "This CPU does not support address filtering\n");
2028                 return -1;
2029         }
2030
2031         if (perf_evsel__append_addr_filter(evsel, str) < 0) {
2032                 fprintf(stderr,
2033                         "not enough memory to hold filter string\n");
2034                 return -1;
2035         }
2036
2037         return 0;
2038 }
2039
2040 int parse_filter(const struct option *opt, const char *str,
2041                  int unset __maybe_unused)
2042 {
2043         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
2044
2045         return foreach_evsel_in_last_glob(evlist, set_filter,
2046                                           (const void *)str);
2047 }
2048
2049 static int add_exclude_perf_filter(struct perf_evsel *evsel,
2050                                    const void *arg __maybe_unused)
2051 {
2052         char new_filter[64];
2053
2054         if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
2055                 fprintf(stderr,
2056                         "--exclude-perf option should follow a -e tracepoint option\n");
2057                 return -1;
2058         }
2059
2060         snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
2061
2062         if (perf_evsel__append_tp_filter(evsel, new_filter) < 0) {
2063                 fprintf(stderr,
2064                         "not enough memory to hold filter string\n");
2065                 return -1;
2066         }
2067
2068         return 0;
2069 }
2070
2071 int exclude_perf(const struct option *opt,
2072                  const char *arg __maybe_unused,
2073                  int unset __maybe_unused)
2074 {
2075         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
2076
2077         return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
2078                                           NULL);
2079 }
2080
2081 static const char * const event_type_descriptors[] = {
2082         "Hardware event",
2083         "Software event",
2084         "Tracepoint event",
2085         "Hardware cache event",
2086         "Raw hardware event descriptor",
2087         "Hardware breakpoint",
2088 };
2089
2090 static int cmp_string(const void *a, const void *b)
2091 {
2092         const char * const *as = a;
2093         const char * const *bs = b;
2094
2095         return strcmp(*as, *bs);
2096 }
2097
2098 /*
2099  * Print the events from <debugfs_mount_point>/tracing/events
2100  */
2101
2102 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
2103                              bool name_only)
2104 {
2105         DIR *sys_dir, *evt_dir;
2106         struct dirent *sys_dirent, *evt_dirent;
2107         char evt_path[MAXPATHLEN];
2108         char *dir_path;
2109         char **evt_list = NULL;
2110         unsigned int evt_i = 0, evt_num = 0;
2111         bool evt_num_known = false;
2112
2113 restart:
2114         sys_dir = tracing_events__opendir();
2115         if (!sys_dir)
2116                 return;
2117
2118         if (evt_num_known) {
2119                 evt_list = zalloc(sizeof(char *) * evt_num);
2120                 if (!evt_list)
2121                         goto out_close_sys_dir;
2122         }
2123
2124         for_each_subsystem(sys_dir, sys_dirent) {
2125                 if (subsys_glob != NULL &&
2126                     !strglobmatch(sys_dirent->d_name, subsys_glob))
2127                         continue;
2128
2129                 dir_path = get_events_file(sys_dirent->d_name);
2130                 if (!dir_path)
2131                         continue;
2132                 evt_dir = opendir(dir_path);
2133                 if (!evt_dir)
2134                         goto next;
2135
2136                 for_each_event(dir_path, evt_dir, evt_dirent) {
2137                         if (event_glob != NULL &&
2138                             !strglobmatch(evt_dirent->d_name, event_glob))
2139                                 continue;
2140
2141                         if (!evt_num_known) {
2142                                 evt_num++;
2143                                 continue;
2144                         }
2145
2146                         snprintf(evt_path, MAXPATHLEN, "%s:%s",
2147                                  sys_dirent->d_name, evt_dirent->d_name);
2148
2149                         evt_list[evt_i] = strdup(evt_path);
2150                         if (evt_list[evt_i] == NULL) {
2151                                 put_events_file(dir_path);
2152                                 goto out_close_evt_dir;
2153                         }
2154                         evt_i++;
2155                 }
2156                 closedir(evt_dir);
2157 next:
2158                 put_events_file(dir_path);
2159         }
2160         closedir(sys_dir);
2161
2162         if (!evt_num_known) {
2163                 evt_num_known = true;
2164                 goto restart;
2165         }
2166         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2167         evt_i = 0;
2168         while (evt_i < evt_num) {
2169                 if (name_only) {
2170                         printf("%s ", evt_list[evt_i++]);
2171                         continue;
2172                 }
2173                 printf("  %-50s [%s]\n", evt_list[evt_i++],
2174                                 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2175         }
2176         if (evt_num && pager_in_use())
2177                 printf("\n");
2178
2179 out_free:
2180         evt_num = evt_i;
2181         for (evt_i = 0; evt_i < evt_num; evt_i++)
2182                 zfree(&evt_list[evt_i]);
2183         zfree(&evt_list);
2184         return;
2185
2186 out_close_evt_dir:
2187         closedir(evt_dir);
2188 out_close_sys_dir:
2189         closedir(sys_dir);
2190
2191         printf("FATAL: not enough memory to print %s\n",
2192                         event_type_descriptors[PERF_TYPE_TRACEPOINT]);
2193         if (evt_list)
2194                 goto out_free;
2195 }
2196
2197 /*
2198  * Check whether event is in <debugfs_mount_point>/tracing/events
2199  */
2200
2201 int is_valid_tracepoint(const char *event_string)
2202 {
2203         DIR *sys_dir, *evt_dir;
2204         struct dirent *sys_dirent, *evt_dirent;
2205         char evt_path[MAXPATHLEN];
2206         char *dir_path;
2207
2208         sys_dir = tracing_events__opendir();
2209         if (!sys_dir)
2210                 return 0;
2211
2212         for_each_subsystem(sys_dir, sys_dirent) {
2213                 dir_path = get_events_file(sys_dirent->d_name);
2214                 if (!dir_path)
2215                         continue;
2216                 evt_dir = opendir(dir_path);
2217                 if (!evt_dir)
2218                         goto next;
2219
2220                 for_each_event(dir_path, evt_dir, evt_dirent) {
2221                         snprintf(evt_path, MAXPATHLEN, "%s:%s",
2222                                  sys_dirent->d_name, evt_dirent->d_name);
2223                         if (!strcmp(evt_path, event_string)) {
2224                                 closedir(evt_dir);
2225                                 closedir(sys_dir);
2226                                 return 1;
2227                         }
2228                 }
2229                 closedir(evt_dir);
2230 next:
2231                 put_events_file(dir_path);
2232         }
2233         closedir(sys_dir);
2234         return 0;
2235 }
2236
2237 static bool is_event_supported(u8 type, unsigned config)
2238 {
2239         bool ret = true;
2240         int open_return;
2241         struct perf_evsel *evsel;
2242         struct perf_event_attr attr = {
2243                 .type = type,
2244                 .config = config,
2245                 .disabled = 1,
2246         };
2247         struct thread_map *tmap = thread_map__new_by_tid(0);
2248
2249         if (tmap == NULL)
2250                 return false;
2251
2252         evsel = perf_evsel__new(&attr);
2253         if (evsel) {
2254                 open_return = perf_evsel__open(evsel, NULL, tmap);
2255                 ret = open_return >= 0;
2256
2257                 if (open_return == -EACCES) {
2258                         /*
2259                          * This happens if the paranoid value
2260                          * /proc/sys/kernel/perf_event_paranoid is set to 2
2261                          * Re-run with exclude_kernel set; we don't do that
2262                          * by default as some ARM machines do not support it.
2263                          *
2264                          */
2265                         evsel->attr.exclude_kernel = 1;
2266                         ret = perf_evsel__open(evsel, NULL, tmap) >= 0;
2267                 }
2268                 perf_evsel__delete(evsel);
2269         }
2270
2271         thread_map__put(tmap);
2272         return ret;
2273 }
2274
2275 void print_sdt_events(const char *subsys_glob, const char *event_glob,
2276                       bool name_only)
2277 {
2278         struct probe_cache *pcache;
2279         struct probe_cache_entry *ent;
2280         struct strlist *bidlist, *sdtlist;
2281         struct strlist_config cfg = {.dont_dupstr = true};
2282         struct str_node *nd, *nd2;
2283         char *buf, *path, *ptr = NULL;
2284         bool show_detail = false;
2285         int ret;
2286
2287         sdtlist = strlist__new(NULL, &cfg);
2288         if (!sdtlist) {
2289                 pr_debug("Failed to allocate new strlist for SDT\n");
2290                 return;
2291         }
2292         bidlist = build_id_cache__list_all(true);
2293         if (!bidlist) {
2294                 pr_debug("Failed to get buildids: %d\n", errno);
2295                 return;
2296         }
2297         strlist__for_each_entry(nd, bidlist) {
2298                 pcache = probe_cache__new(nd->s, NULL);
2299                 if (!pcache)
2300                         continue;
2301                 list_for_each_entry(ent, &pcache->entries, node) {
2302                         if (!ent->sdt)
2303                                 continue;
2304                         if (subsys_glob &&
2305                             !strglobmatch(ent->pev.group, subsys_glob))
2306                                 continue;
2307                         if (event_glob &&
2308                             !strglobmatch(ent->pev.event, event_glob))
2309                                 continue;
2310                         ret = asprintf(&buf, "%s:%s@%s", ent->pev.group,
2311                                         ent->pev.event, nd->s);
2312                         if (ret > 0)
2313                                 strlist__add(sdtlist, buf);
2314                 }
2315                 probe_cache__delete(pcache);
2316         }
2317         strlist__delete(bidlist);
2318
2319         strlist__for_each_entry(nd, sdtlist) {
2320                 buf = strchr(nd->s, '@');
2321                 if (buf)
2322                         *(buf++) = '\0';
2323                 if (name_only) {
2324                         printf("%s ", nd->s);
2325                         continue;
2326                 }
2327                 nd2 = strlist__next(nd);
2328                 if (nd2) {
2329                         ptr = strchr(nd2->s, '@');
2330                         if (ptr)
2331                                 *ptr = '\0';
2332                         if (strcmp(nd->s, nd2->s) == 0)
2333                                 show_detail = true;
2334                 }
2335                 if (show_detail) {
2336                         path = build_id_cache__origname(buf);
2337                         ret = asprintf(&buf, "%s@%s(%.12s)", nd->s, path, buf);
2338                         if (ret > 0) {
2339                                 printf("  %-50s [%s]\n", buf, "SDT event");
2340                                 free(buf);
2341                         }
2342                         free(path);
2343                 } else
2344                         printf("  %-50s [%s]\n", nd->s, "SDT event");
2345                 if (nd2) {
2346                         if (strcmp(nd->s, nd2->s) != 0)
2347                                 show_detail = false;
2348                         if (ptr)
2349                                 *ptr = '@';
2350                 }
2351         }
2352         strlist__delete(sdtlist);
2353 }
2354
2355 int print_hwcache_events(const char *event_glob, bool name_only)
2356 {
2357         unsigned int type, op, i, evt_i = 0, evt_num = 0;
2358         char name[64];
2359         char **evt_list = NULL;
2360         bool evt_num_known = false;
2361
2362 restart:
2363         if (evt_num_known) {
2364                 evt_list = zalloc(sizeof(char *) * evt_num);
2365                 if (!evt_list)
2366                         goto out_enomem;
2367         }
2368
2369         for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
2370                 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
2371                         /* skip invalid cache type */
2372                         if (!perf_evsel__is_cache_op_valid(type, op))
2373                                 continue;
2374
2375                         for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
2376                                 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
2377                                                                         name, sizeof(name));
2378                                 if (event_glob != NULL && !strglobmatch(name, event_glob))
2379                                         continue;
2380
2381                                 if (!is_event_supported(PERF_TYPE_HW_CACHE,
2382                                                         type | (op << 8) | (i << 16)))
2383                                         continue;
2384
2385                                 if (!evt_num_known) {
2386                                         evt_num++;
2387                                         continue;
2388                                 }
2389
2390                                 evt_list[evt_i] = strdup(name);
2391                                 if (evt_list[evt_i] == NULL)
2392                                         goto out_enomem;
2393                                 evt_i++;
2394                         }
2395                 }
2396         }
2397
2398         if (!evt_num_known) {
2399                 evt_num_known = true;
2400                 goto restart;
2401         }
2402         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2403         evt_i = 0;
2404         while (evt_i < evt_num) {
2405                 if (name_only) {
2406                         printf("%s ", evt_list[evt_i++]);
2407                         continue;
2408                 }
2409                 printf("  %-50s [%s]\n", evt_list[evt_i++],
2410                                 event_type_descriptors[PERF_TYPE_HW_CACHE]);
2411         }
2412         if (evt_num && pager_in_use())
2413                 printf("\n");
2414
2415 out_free:
2416         evt_num = evt_i;
2417         for (evt_i = 0; evt_i < evt_num; evt_i++)
2418                 zfree(&evt_list[evt_i]);
2419         zfree(&evt_list);
2420         return evt_num;
2421
2422 out_enomem:
2423         printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
2424         if (evt_list)
2425                 goto out_free;
2426         return evt_num;
2427 }
2428
2429 void print_symbol_events(const char *event_glob, unsigned type,
2430                                 struct event_symbol *syms, unsigned max,
2431                                 bool name_only)
2432 {
2433         unsigned int i, evt_i = 0, evt_num = 0;
2434         char name[MAX_NAME_LEN];
2435         char **evt_list = NULL;
2436         bool evt_num_known = false;
2437
2438 restart:
2439         if (evt_num_known) {
2440                 evt_list = zalloc(sizeof(char *) * evt_num);
2441                 if (!evt_list)
2442                         goto out_enomem;
2443                 syms -= max;
2444         }
2445
2446         for (i = 0; i < max; i++, syms++) {
2447
2448                 if (event_glob != NULL && syms->symbol != NULL &&
2449                     !(strglobmatch(syms->symbol, event_glob) ||
2450                       (syms->alias && strglobmatch(syms->alias, event_glob))))
2451                         continue;
2452
2453                 if (!is_event_supported(type, i))
2454                         continue;
2455
2456                 if (!evt_num_known) {
2457                         evt_num++;
2458                         continue;
2459                 }
2460
2461                 if (!name_only && strlen(syms->alias))
2462                         snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
2463                 else
2464                         strlcpy(name, syms->symbol, MAX_NAME_LEN);
2465
2466                 evt_list[evt_i] = strdup(name);
2467                 if (evt_list[evt_i] == NULL)
2468                         goto out_enomem;
2469                 evt_i++;
2470         }
2471
2472         if (!evt_num_known) {
2473                 evt_num_known = true;
2474                 goto restart;
2475         }
2476         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
2477         evt_i = 0;
2478         while (evt_i < evt_num) {
2479                 if (name_only) {
2480                         printf("%s ", evt_list[evt_i++]);
2481                         continue;
2482                 }
2483                 printf("  %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
2484         }
2485         if (evt_num && pager_in_use())
2486                 printf("\n");
2487
2488 out_free:
2489         evt_num = evt_i;
2490         for (evt_i = 0; evt_i < evt_num; evt_i++)
2491                 zfree(&evt_list[evt_i]);
2492         zfree(&evt_list);
2493         return;
2494
2495 out_enomem:
2496         printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
2497         if (evt_list)
2498                 goto out_free;
2499 }
2500
2501 /*
2502  * Print the help text for the event symbols:
2503  */
2504 void print_events(const char *event_glob, bool name_only, bool quiet_flag,
2505                         bool long_desc, bool details_flag)
2506 {
2507         print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
2508                             event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
2509
2510         print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
2511                             event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
2512
2513         print_hwcache_events(event_glob, name_only);
2514
2515         print_pmu_events(event_glob, name_only, quiet_flag, long_desc,
2516                         details_flag);
2517
2518         if (event_glob != NULL)
2519                 return;
2520
2521         if (!name_only) {
2522                 printf("  %-50s [%s]\n",
2523                        "rNNN",
2524                        event_type_descriptors[PERF_TYPE_RAW]);
2525                 printf("  %-50s [%s]\n",
2526                        "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
2527                        event_type_descriptors[PERF_TYPE_RAW]);
2528                 if (pager_in_use())
2529                         printf("   (see 'man perf-list' on how to encode it)\n\n");
2530
2531                 printf("  %-50s [%s]\n",
2532                        "mem:<addr>[/len][:access]",
2533                         event_type_descriptors[PERF_TYPE_BREAKPOINT]);
2534                 if (pager_in_use())
2535                         printf("\n");
2536         }
2537
2538         print_tracepoint_events(NULL, NULL, name_only);
2539
2540         print_sdt_events(NULL, NULL, name_only);
2541
2542         metricgroup__print(true, true, NULL, name_only);
2543 }
2544
2545 int parse_events__is_hardcoded_term(struct parse_events_term *term)
2546 {
2547         return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
2548 }
2549
2550 static int new_term(struct parse_events_term **_term,
2551                     struct parse_events_term *temp,
2552                     char *str, u64 num)
2553 {
2554         struct parse_events_term *term;
2555
2556         term = malloc(sizeof(*term));
2557         if (!term)
2558                 return -ENOMEM;
2559
2560         *term = *temp;
2561         INIT_LIST_HEAD(&term->list);
2562         term->weak = false;
2563
2564         switch (term->type_val) {
2565         case PARSE_EVENTS__TERM_TYPE_NUM:
2566                 term->val.num = num;
2567                 break;
2568         case PARSE_EVENTS__TERM_TYPE_STR:
2569                 term->val.str = str;
2570                 break;
2571         default:
2572                 free(term);
2573                 return -EINVAL;
2574         }
2575
2576         *_term = term;
2577         return 0;
2578 }
2579
2580 int parse_events_term__num(struct parse_events_term **term,
2581                            int type_term, char *config, u64 num,
2582                            bool no_value,
2583                            void *loc_term_, void *loc_val_)
2584 {
2585         YYLTYPE *loc_term = loc_term_;
2586         YYLTYPE *loc_val = loc_val_;
2587
2588         struct parse_events_term temp = {
2589                 .type_val  = PARSE_EVENTS__TERM_TYPE_NUM,
2590                 .type_term = type_term,
2591                 .config    = config,
2592                 .no_value  = no_value,
2593                 .err_term  = loc_term ? loc_term->first_column : 0,
2594                 .err_val   = loc_val  ? loc_val->first_column  : 0,
2595         };
2596
2597         return new_term(term, &temp, NULL, num);
2598 }
2599
2600 int parse_events_term__str(struct parse_events_term **term,
2601                            int type_term, char *config, char *str,
2602                            void *loc_term_, void *loc_val_)
2603 {
2604         YYLTYPE *loc_term = loc_term_;
2605         YYLTYPE *loc_val = loc_val_;
2606
2607         struct parse_events_term temp = {
2608                 .type_val  = PARSE_EVENTS__TERM_TYPE_STR,
2609                 .type_term = type_term,
2610                 .config    = config,
2611                 .err_term  = loc_term ? loc_term->first_column : 0,
2612                 .err_val   = loc_val  ? loc_val->first_column  : 0,
2613         };
2614
2615         return new_term(term, &temp, str, 0);
2616 }
2617
2618 int parse_events_term__sym_hw(struct parse_events_term **term,
2619                               char *config, unsigned idx)
2620 {
2621         struct event_symbol *sym;
2622         struct parse_events_term temp = {
2623                 .type_val  = PARSE_EVENTS__TERM_TYPE_STR,
2624                 .type_term = PARSE_EVENTS__TERM_TYPE_USER,
2625                 .config    = config ?: (char *) "event",
2626         };
2627
2628         BUG_ON(idx >= PERF_COUNT_HW_MAX);
2629         sym = &event_symbols_hw[idx];
2630
2631         return new_term(term, &temp, (char *) sym->symbol, 0);
2632 }
2633
2634 int parse_events_term__clone(struct parse_events_term **new,
2635                              struct parse_events_term *term)
2636 {
2637         struct parse_events_term temp = {
2638                 .type_val  = term->type_val,
2639                 .type_term = term->type_term,
2640                 .config    = term->config,
2641                 .err_term  = term->err_term,
2642                 .err_val   = term->err_val,
2643         };
2644
2645         return new_term(new, &temp, term->val.str, term->val.num);
2646 }
2647
2648 int parse_events_copy_term_list(struct list_head *old,
2649                                  struct list_head **new)
2650 {
2651         struct parse_events_term *term, *n;
2652         int ret;
2653
2654         if (!old) {
2655                 *new = NULL;
2656                 return 0;
2657         }
2658
2659         *new = malloc(sizeof(struct list_head));
2660         if (!*new)
2661                 return -ENOMEM;
2662         INIT_LIST_HEAD(*new);
2663
2664         list_for_each_entry (term, old, list) {
2665                 ret = parse_events_term__clone(&n, term);
2666                 if (ret)
2667                         return ret;
2668                 list_add_tail(&n->list, *new);
2669         }
2670         return 0;
2671 }
2672
2673 void parse_events_terms__purge(struct list_head *terms)
2674 {
2675         struct parse_events_term *term, *h;
2676
2677         list_for_each_entry_safe(term, h, terms, list) {
2678                 if (term->array.nr_ranges)
2679                         zfree(&term->array.ranges);
2680                 list_del_init(&term->list);
2681                 free(term);
2682         }
2683 }
2684
2685 void parse_events_terms__delete(struct list_head *terms)
2686 {
2687         if (!terms)
2688                 return;
2689         parse_events_terms__purge(terms);
2690         free(terms);
2691 }
2692
2693 void parse_events__clear_array(struct parse_events_array *a)
2694 {
2695         zfree(&a->ranges);
2696 }
2697
2698 void parse_events_evlist_error(struct parse_events_state *parse_state,
2699                                int idx, const char *str)
2700 {
2701         struct parse_events_error *err = parse_state->error;
2702
2703         if (!err)
2704                 return;
2705         err->idx = idx;
2706         err->str = strdup(str);
2707         WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
2708 }
2709
2710 static void config_terms_list(char *buf, size_t buf_sz)
2711 {
2712         int i;
2713         bool first = true;
2714
2715         buf[0] = '\0';
2716         for (i = 0; i < __PARSE_EVENTS__TERM_TYPE_NR; i++) {
2717                 const char *name = config_term_names[i];
2718
2719                 if (!config_term_avail(i, NULL))
2720                         continue;
2721                 if (!name)
2722                         continue;
2723                 if (name[0] == '<')
2724                         continue;
2725
2726                 if (strlen(buf) + strlen(name) + 2 >= buf_sz)
2727                         return;
2728
2729                 if (!first)
2730                         strcat(buf, ",");
2731                 else
2732                         first = false;
2733                 strcat(buf, name);
2734         }
2735 }
2736
2737 /*
2738  * Return string contains valid config terms of an event.
2739  * @additional_terms: For terms such as PMU sysfs terms.
2740  */
2741 char *parse_events_formats_error_string(char *additional_terms)
2742 {
2743         char *str;
2744         /* "no-overwrite" is the longest name */
2745         char static_terms[__PARSE_EVENTS__TERM_TYPE_NR *
2746                           (sizeof("no-overwrite") - 1)];
2747
2748         config_terms_list(static_terms, sizeof(static_terms));
2749         /* valid terms */
2750         if (additional_terms) {
2751                 if (asprintf(&str, "valid terms: %s,%s",
2752                              additional_terms, static_terms) < 0)
2753                         goto fail;
2754         } else {
2755                 if (asprintf(&str, "valid terms: %s", static_terms) < 0)
2756                         goto fail;
2757         }
2758         return str;
2759
2760 fail:
2761         return NULL;
2762 }