tools/perf/util/parse-events.c

   1 #include <linux/hw_breakpoint.h>
   2 #include <linux/err.h>
   3 #include "util.h"
   4 #include "../perf.h"
   5 #include "evlist.h"
   6 #include "evsel.h"
   7 #include "parse-options.h"
   8 #include "parse-events.h"
   9 #include "exec_cmd.h"
  10 #include "string.h"
  11 #include "symbol.h"
  12 #include "cache.h"
  13 #include "header.h"
  14 #include "bpf-loader.h"
  15 #include "debug.h"
  16 #include <api/fs/tracing_path.h>
  17 #include "parse-events-bison.h"
  18 #define YY_EXTRA_TYPE int
  19 #include "parse-events-flex.h"
  20 #include "pmu.h"
  21 #include "thread_map.h"
  22 #include "cpumap.h"
  23 #include "asm/bug.h"
  24
  25 #define MAX_NAME_LEN 100
  26
  27 #ifdef PARSER_DEBUG
  28 extern int parse_events_debug;
  29 #endif
  30 int parse_events_parse(void *data, void *scanner);
  31 static int get_config_terms(struct list_head *head_config,
  32                             struct list_head *head_terms __maybe_unused);
  33
  34 static struct perf_pmu_event_symbol *perf_pmu_events_list;
  35 /*
  36  * The variable indicates the number of supported pmu event symbols.
  37  * 0 means not initialized and ready to init
  38  * -1 means failed to init, don't try anymore
  39  * >0 is the number of supported pmu event symbols
  40  */
  41 static int perf_pmu_events_list_num;
  42
  43 struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
  44         [PERF_COUNT_HW_CPU_CYCLES] = {
  45                 .symbol = "cpu-cycles",
  46                 .alias  = "cycles",
  47         },
  48         [PERF_COUNT_HW_INSTRUCTIONS] = {
  49                 .symbol = "instructions",
  50                 .alias  = "",
  51         },
  52         [PERF_COUNT_HW_CACHE_REFERENCES] = {
  53                 .symbol = "cache-references",
  54                 .alias  = "",
  55         },
  56         [PERF_COUNT_HW_CACHE_MISSES] = {
  57                 .symbol = "cache-misses",
  58                 .alias  = "",
  59         },
  60         [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
  61                 .symbol = "branch-instructions",
  62                 .alias  = "branches",
  63         },
  64         [PERF_COUNT_HW_BRANCH_MISSES] = {
  65                 .symbol = "branch-misses",
  66                 .alias  = "",
  67         },
  68         [PERF_COUNT_HW_BUS_CYCLES] = {
  69                 .symbol = "bus-cycles",
  70                 .alias  = "",
  71         },
  72         [PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
  73                 .symbol = "stalled-cycles-frontend",
  74                 .alias  = "idle-cycles-frontend",
  75         },
  76         [PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
  77                 .symbol = "stalled-cycles-backend",
  78                 .alias  = "idle-cycles-backend",
  79         },
  80         [PERF_COUNT_HW_REF_CPU_CYCLES] = {
  81                 .symbol = "ref-cycles",
  82                 .alias  = "",
  83         },
  84 };
  85
  86 struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
  87         [PERF_COUNT_SW_CPU_CLOCK] = {
  88                 .symbol = "cpu-clock",
  89                 .alias  = "",
  90         },
  91         [PERF_COUNT_SW_TASK_CLOCK] = {
  92                 .symbol = "task-clock",
  93                 .alias  = "",
  94         },
  95         [PERF_COUNT_SW_PAGE_FAULTS] = {
  96                 .symbol = "page-faults",
  97                 .alias  = "faults",
  98         },
  99         [PERF_COUNT_SW_CONTEXT_SWITCHES] = {
 100                 .symbol = "context-switches",
 101                 .alias  = "cs",
 102         },
 103         [PERF_COUNT_SW_CPU_MIGRATIONS] = {
 104                 .symbol = "cpu-migrations",
 105                 .alias  = "migrations",
 106         },
 107         [PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
 108                 .symbol = "minor-faults",
 109                 .alias  = "",
 110         },
 111         [PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
 112                 .symbol = "major-faults",
 113                 .alias  = "",
 114         },
 115         [PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
 116                 .symbol = "alignment-faults",
 117                 .alias  = "",
 118         },
 119         [PERF_COUNT_SW_EMULATION_FAULTS] = {
 120                 .symbol = "emulation-faults",
 121                 .alias  = "",
 122         },
 123         [PERF_COUNT_SW_DUMMY] = {
 124                 .symbol = "dummy",
 125                 .alias  = "",
 126         },
 127 };
 128
 129 #define __PERF_EVENT_FIELD(config, name) \
 130         ((config & PERF_EVENT_##name##_MASK) >> PERF_EVENT_##name##_SHIFT)
 131
 132 #define PERF_EVENT_RAW(config)          __PERF_EVENT_FIELD(config, RAW)
 133 #define PERF_EVENT_CONFIG(config)       __PERF_EVENT_FIELD(config, CONFIG)
 134 #define PERF_EVENT_TYPE(config)         __PERF_EVENT_FIELD(config, TYPE)
 135 #define PERF_EVENT_ID(config)           __PERF_EVENT_FIELD(config, EVENT)
 136
 137 #define for_each_subsystem(sys_dir, sys_dirent, sys_next)              \
 138         while (!readdir_r(sys_dir, &sys_dirent, &sys_next) && sys_next)        \
 139         if (sys_dirent.d_type == DT_DIR &&                                     \
 140            (strcmp(sys_dirent.d_name, ".")) &&                                 \
 141            (strcmp(sys_dirent.d_name, "..")))
 142
 143 static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
 144 {
 145         char evt_path[MAXPATHLEN];
 146         int fd;
 147
 148         snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
 149                         sys_dir->d_name, evt_dir->d_name);
 150         fd = open(evt_path, O_RDONLY);
 151         if (fd < 0)
 152                 return -EINVAL;
 153         close(fd);
 154
 155         return 0;
 156 }
 157
 158 #define for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next)              \
 159         while (!readdir_r(evt_dir, &evt_dirent, &evt_next) && evt_next)        \
 160         if (evt_dirent.d_type == DT_DIR &&                                     \
 161            (strcmp(evt_dirent.d_name, ".")) &&                                 \
 162            (strcmp(evt_dirent.d_name, "..")) &&                                \
 163            (!tp_event_has_id(&sys_dirent, &evt_dirent)))
 164
 165 #define MAX_EVENT_LENGTH 512
 166
 167
 168 struct tracepoint_path *tracepoint_id_to_path(u64 config)
 169 {
 170         struct tracepoint_path *path = NULL;
 171         DIR *sys_dir, *evt_dir;
 172         struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
 173         char id_buf[24];
 174         int fd;
 175         u64 id;
 176         char evt_path[MAXPATHLEN];
 177         char dir_path[MAXPATHLEN];
 178
 179         sys_dir = opendir(tracing_events_path);
 180         if (!sys_dir)
 181                 return NULL;
 182
 183         for_each_subsystem(sys_dir, sys_dirent, sys_next) {
 184
 185                 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
 186                          sys_dirent.d_name);
 187                 evt_dir = opendir(dir_path);
 188                 if (!evt_dir)
 189                         continue;
 190
 191                 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
 192
 193                         snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
 194                                  evt_dirent.d_name);
 195                         fd = open(evt_path, O_RDONLY);
 196                         if (fd < 0)
 197                                 continue;
 198                         if (read(fd, id_buf, sizeof(id_buf)) < 0) {
 199                                 close(fd);
 200                                 continue;
 201                         }
 202                         close(fd);
 203                         id = atoll(id_buf);
 204                         if (id == config) {
 205                                 closedir(evt_dir);
 206                                 closedir(sys_dir);
 207                                 path = zalloc(sizeof(*path));
 208                                 path->system = malloc(MAX_EVENT_LENGTH);
 209                                 if (!path->system) {
 210                                         free(path);
 211                                         return NULL;
 212                                 }
 213                                 path->name = malloc(MAX_EVENT_LENGTH);
 214                                 if (!path->name) {
 215                                         zfree(&path->system);
 216                                         free(path);
 217                                         return NULL;
 218                                 }
 219                                 strncpy(path->system, sys_dirent.d_name,
 220                                         MAX_EVENT_LENGTH);
 221                                 strncpy(path->name, evt_dirent.d_name,
 222                                         MAX_EVENT_LENGTH);
 223                                 return path;
 224                         }
 225                 }
 226                 closedir(evt_dir);
 227         }
 228
 229         closedir(sys_dir);
 230         return NULL;
 231 }
 232
 233 struct tracepoint_path *tracepoint_name_to_path(const char *name)
 234 {
 235         struct tracepoint_path *path = zalloc(sizeof(*path));
 236         char *str = strchr(name, ':');
 237
 238         if (path == NULL || str == NULL) {
 239                 free(path);
 240                 return NULL;
 241         }
 242
 243         path->system = strndup(name, str - name);
 244         path->name = strdup(str+1);
 245
 246         if (path->system == NULL || path->name == NULL) {
 247                 zfree(&path->system);
 248                 zfree(&path->name);
 249                 free(path);
 250                 path = NULL;
 251         }
 252
 253         return path;
 254 }
 255
 256 const char *event_type(int type)
 257 {
 258         switch (type) {
 259         case PERF_TYPE_HARDWARE:
 260                 return "hardware";
 261
 262         case PERF_TYPE_SOFTWARE:
 263                 return "software";
 264
 265         case PERF_TYPE_TRACEPOINT:
 266                 return "tracepoint";
 267
 268         case PERF_TYPE_HW_CACHE:
 269                 return "hardware-cache";
 270
 271         default:
 272                 break;
 273         }
 274
 275         return "unknown";
 276 }
 277
 278
 279
 280 static struct perf_evsel *
 281 __add_event(struct list_head *list, int *idx,
 282             struct perf_event_attr *attr,
 283             char *name, struct cpu_map *cpus,
 284             struct list_head *config_terms)
 285 {
 286         struct perf_evsel *evsel;
 287
 288         event_attr_init(attr);
 289
 290         evsel = perf_evsel__new_idx(attr, (*idx)++);
 291         if (!evsel)
 292                 return NULL;
 293
 294         evsel->cpus     = cpu_map__get(cpus);
 295         evsel->own_cpus = cpu_map__get(cpus);
 296
 297         if (name)
 298                 evsel->name = strdup(name);
 299
 300         if (config_terms)
 301                 list_splice(config_terms, &evsel->config_terms);
 302
 303         list_add_tail(&evsel->node, list);
 304         return evsel;
 305 }
 306
 307 static int add_event(struct list_head *list, int *idx,
 308                      struct perf_event_attr *attr, char *name,
 309                      struct list_head *config_terms)
 310 {
 311         return __add_event(list, idx, attr, name, NULL, config_terms) ? 0 : -ENOMEM;
 312 }
 313
 314 static int parse_aliases(char *str, const char *names[][PERF_EVSEL__MAX_ALIASES], int size)
 315 {
 316         int i, j;
 317         int n, longest = -1;
 318
 319         for (i = 0; i < size; i++) {
 320                 for (j = 0; j < PERF_EVSEL__MAX_ALIASES && names[i][j]; j++) {
 321                         n = strlen(names[i][j]);
 322                         if (n > longest && !strncasecmp(str, names[i][j], n))
 323                                 longest = n;
 324                 }
 325                 if (longest > 0)
 326                         return i;
 327         }
 328
 329         return -1;
 330 }
 331
 332 int parse_events_add_cache(struct list_head *list, int *idx,
 333                            char *type, char *op_result1, char *op_result2)
 334 {
 335         struct perf_event_attr attr;
 336         char name[MAX_NAME_LEN];
 337         int cache_type = -1, cache_op = -1, cache_result = -1;
 338         char *op_result[2] = { op_result1, op_result2 };
 339         int i, n;
 340
 341         /*
 342          * No fallback - if we cannot get a clear cache type
 343          * then bail out:
 344          */
 345         cache_type = parse_aliases(type, perf_evsel__hw_cache,
 346                                    PERF_COUNT_HW_CACHE_MAX);
 347         if (cache_type == -1)
 348                 return -EINVAL;
 349
 350         n = snprintf(name, MAX_NAME_LEN, "%s", type);
 351
 352         for (i = 0; (i < 2) && (op_result[i]); i++) {
 353                 char *str = op_result[i];
 354
 355                 n += snprintf(name + n, MAX_NAME_LEN - n, "-%s", str);
 356
 357                 if (cache_op == -1) {
 358                         cache_op = parse_aliases(str, perf_evsel__hw_cache_op,
 359                                                  PERF_COUNT_HW_CACHE_OP_MAX);
 360                         if (cache_op >= 0) {
 361                                 if (!perf_evsel__is_cache_op_valid(cache_type, cache_op))
 362                                         return -EINVAL;
 363                                 continue;
 364                         }
 365                 }
 366
 367                 if (cache_result == -1) {
 368                         cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
 369                                                      PERF_COUNT_HW_CACHE_RESULT_MAX);
 370                         if (cache_result >= 0)
 371                                 continue;
 372                 }
 373         }
 374
 375         /*
 376          * Fall back to reads:
 377          */
 378         if (cache_op == -1)
 379                 cache_op = PERF_COUNT_HW_CACHE_OP_READ;
 380
 381         /*
 382          * Fall back to accesses:
 383          */
 384         if (cache_result == -1)
 385                 cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;
 386
 387         memset(&attr, 0, sizeof(attr));
 388         attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
 389         attr.type = PERF_TYPE_HW_CACHE;
 390         return add_event(list, idx, &attr, name, NULL);
 391 }
 392
 393 static void tracepoint_error(struct parse_events_error *e, int err,
 394                              char *sys, char *name)
 395 {
 396         char help[BUFSIZ];
 397
 398         /*
 399          * We get error directly from syscall errno ( > 0),
 400          * or from encoded pointer's error ( < 0).
 401          */
 402         err = abs(err);
 403
 404         switch (err) {
 405         case EACCES:
 406                 e->str = strdup("can't access trace events");
 407                 break;
 408         case ENOENT:
 409                 e->str = strdup("unknown tracepoint");
 410                 break;
 411         default:
 412                 e->str = strdup("failed to add tracepoint");
 413                 break;
 414         }
 415
 416         tracing_path__strerror_open_tp(err, help, sizeof(help), sys, name);
 417         e->help = strdup(help);
 418 }
 419
 420 static int add_tracepoint(struct list_head *list, int *idx,
 421                           char *sys_name, char *evt_name,
 422                           struct parse_events_error *err,
 423                           struct list_head *head_config)
 424 {
 425         struct perf_evsel *evsel;
 426
 427         evsel = perf_evsel__newtp_idx(sys_name, evt_name, (*idx)++);
 428         if (IS_ERR(evsel)) {
 429                 tracepoint_error(err, PTR_ERR(evsel), sys_name, evt_name);
 430                 return PTR_ERR(evsel);
 431         }
 432
 433         if (head_config) {
 434                 LIST_HEAD(config_terms);
 435
 436                 if (get_config_terms(head_config, &config_terms))
 437                         return -ENOMEM;
 438                 list_splice(&config_terms, &evsel->config_terms);
 439         }
 440
 441         list_add_tail(&evsel->node, list);
 442         return 0;
 443 }
 444
 445 static int add_tracepoint_multi_event(struct list_head *list, int *idx,
 446                                       char *sys_name, char *evt_name,
 447                                       struct parse_events_error *err,
 448                                       struct list_head *head_config)
 449 {
 450         char evt_path[MAXPATHLEN];
 451         struct dirent *evt_ent;
 452         DIR *evt_dir;
 453         int ret = 0, found = 0;
 454
 455         snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
 456         evt_dir = opendir(evt_path);
 457         if (!evt_dir) {
 458                 tracepoint_error(err, errno, sys_name, evt_name);
 459                 return -1;
 460         }
 461
 462         while (!ret && (evt_ent = readdir(evt_dir))) {
 463                 if (!strcmp(evt_ent->d_name, ".")
 464                     || !strcmp(evt_ent->d_name, "..")
 465                     || !strcmp(evt_ent->d_name, "enable")
 466                     || !strcmp(evt_ent->d_name, "filter"))
 467                         continue;
 468
 469                 if (!strglobmatch(evt_ent->d_name, evt_name))
 470                         continue;
 471
 472                 found++;
 473
 474                 ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
 475                                      err, head_config);
 476         }
 477
 478         if (!found) {
 479                 tracepoint_error(err, ENOENT, sys_name, evt_name);
 480                 ret = -1;
 481         }
 482
 483         closedir(evt_dir);
 484         return ret;
 485 }
 486
 487 static int add_tracepoint_event(struct list_head *list, int *idx,
 488                                 char *sys_name, char *evt_name,
 489                                 struct parse_events_error *err,
 490                                 struct list_head *head_config)
 491 {
 492         return strpbrk(evt_name, "*?") ?
 493                add_tracepoint_multi_event(list, idx, sys_name, evt_name,
 494                                           err, head_config) :
 495                add_tracepoint(list, idx, sys_name, evt_name,
 496                               err, head_config);
 497 }
 498
 499 static int add_tracepoint_multi_sys(struct list_head *list, int *idx,
 500                                     char *sys_name, char *evt_name,
 501                                     struct parse_events_error *err,
 502                                     struct list_head *head_config)
 503 {
 504         struct dirent *events_ent;
 505         DIR *events_dir;
 506         int ret = 0;
 507
 508         events_dir = opendir(tracing_events_path);
 509         if (!events_dir) {
 510                 tracepoint_error(err, errno, sys_name, evt_name);
 511                 return -1;
 512         }
 513
 514         while (!ret && (events_ent = readdir(events_dir))) {
 515                 if (!strcmp(events_ent->d_name, ".")
 516                     || !strcmp(events_ent->d_name, "..")
 517                     || !strcmp(events_ent->d_name, "enable")
 518                     || !strcmp(events_ent->d_name, "header_event")
 519                     || !strcmp(events_ent->d_name, "header_page"))
 520                         continue;
 521
 522                 if (!strglobmatch(events_ent->d_name, sys_name))
 523                         continue;
 524
 525                 ret = add_tracepoint_event(list, idx, events_ent->d_name,
 526                                            evt_name, err, head_config);
 527         }
 528
 529         closedir(events_dir);
 530         return ret;
 531 }
 532
 533 struct __add_bpf_event_param {
 534         struct parse_events_evlist *data;
 535         struct list_head *list;
 536 };
 537
 538 static int add_bpf_event(struct probe_trace_event *tev, int fd,
 539                          void *_param)
 540 {
 541         LIST_HEAD(new_evsels);
 542         struct __add_bpf_event_param *param = _param;
 543         struct parse_events_evlist *evlist = param->data;
 544         struct list_head *list = param->list;
 545         struct perf_evsel *pos;
 546         int err;
 547
 548         pr_debug("add bpf event %s:%s and attach bpf program %d\n",
 549                  tev->group, tev->event, fd);
 550
 551         err = parse_events_add_tracepoint(&new_evsels, &evlist->idx, tev->group,
 552                                           tev->event, evlist->error, NULL);
 553         if (err) {
 554                 struct perf_evsel *evsel, *tmp;
 555
 556                 pr_debug("Failed to add BPF event %s:%s\n",
 557                          tev->group, tev->event);
 558                 list_for_each_entry_safe(evsel, tmp, &new_evsels, node) {
 559                         list_del(&evsel->node);
 560                         perf_evsel__delete(evsel);
 561                 }
 562                 return err;
 563         }
 564         pr_debug("adding %s:%s\n", tev->group, tev->event);
 565
 566         list_for_each_entry(pos, &new_evsels, node) {
 567                 pr_debug("adding %s:%s to %p\n",
 568                          tev->group, tev->event, pos);
 569                 pos->bpf_fd = fd;
 570         }
 571         list_splice(&new_evsels, list);
 572         return 0;
 573 }
 574
 575 int parse_events_load_bpf_obj(struct parse_events_evlist *data,
 576                               struct list_head *list,
 577                               struct bpf_object *obj)
 578 {
 579         int err;
 580         char errbuf[BUFSIZ];
 581         struct __add_bpf_event_param param = {data, list};
 582         static bool registered_unprobe_atexit = false;
 583
 584         if (IS_ERR(obj) || !obj) {
 585                 snprintf(errbuf, sizeof(errbuf),
 586                          "Internal error: load bpf obj with NULL");
 587                 err = -EINVAL;
 588                 goto errout;
 589         }
 590
 591         /*
 592          * Register atexit handler before calling bpf__probe() so
 593          * bpf__probe() don't need to unprobe probe points its already
 594          * created when failure.
 595          */
 596         if (!registered_unprobe_atexit) {
 597                 atexit(bpf__clear);
 598                 registered_unprobe_atexit = true;
 599         }
 600
 601         err = bpf__probe(obj);
 602         if (err) {
 603                 bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
 604                 goto errout;
 605         }
 606
 607         err = bpf__load(obj);
 608         if (err) {
 609                 bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
 610                 goto errout;
 611         }
 612
 613         err = bpf__foreach_tev(obj, add_bpf_event, &param);
 614         if (err) {
 615                 snprintf(errbuf, sizeof(errbuf),
 616                          "Attach events in BPF object failed");
 617                 goto errout;
 618         }
 619
 620         return 0;
 621 errout:
 622         data->error->help = strdup("(add -v to see detail)");
 623         data->error->str = strdup(errbuf);
 624         return err;
 625 }
 626
 627 int parse_events_load_bpf(struct parse_events_evlist *data,
 628                           struct list_head *list,
 629                           char *bpf_file_name,
 630                           bool source)
 631 {
 632         struct bpf_object *obj;
 633
 634         obj = bpf__prepare_load(bpf_file_name, source);
 635         if (IS_ERR(obj) || !obj) {
 636                 char errbuf[BUFSIZ];
 637                 int err;
 638
 639                 err = obj ? PTR_ERR(obj) : -EINVAL;
 640
 641                 if (err == -ENOTSUP)
 642                         snprintf(errbuf, sizeof(errbuf),
 643                                  "BPF support is not compiled");
 644                 else
 645                         snprintf(errbuf, sizeof(errbuf),
 646                                  "BPF object file '%s' is invalid",
 647                                  bpf_file_name);
 648
 649                 data->error->help = strdup("(add -v to see detail)");
 650                 data->error->str = strdup(errbuf);
 651                 return err;
 652         }
 653
 654         return parse_events_load_bpf_obj(data, list, obj);
 655 }
 656
 657 static int
 658 parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
 659 {
 660         int i;
 661
 662         for (i = 0; i < 3; i++) {
 663                 if (!type || !type[i])
 664                         break;
 665
 666 #define CHECK_SET_TYPE(bit)             \
 667 do {                                    \
 668         if (attr->bp_type & bit)        \
 669                 return -EINVAL;         \
 670         else                            \
 671                 attr->bp_type |= bit;   \
 672 } while (0)
 673
 674                 switch (type[i]) {
 675                 case 'r':
 676                         CHECK_SET_TYPE(HW_BREAKPOINT_R);
 677                         break;
 678                 case 'w':
 679                         CHECK_SET_TYPE(HW_BREAKPOINT_W);
 680                         break;
 681                 case 'x':
 682                         CHECK_SET_TYPE(HW_BREAKPOINT_X);
 683                         break;
 684                 default:
 685                         return -EINVAL;
 686                 }
 687         }
 688
 689 #undef CHECK_SET_TYPE
 690
 691         if (!attr->bp_type) /* Default */
 692                 attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;
 693
 694         return 0;
 695 }
 696
 697 int parse_events_add_breakpoint(struct list_head *list, int *idx,
 698                                 void *ptr, char *type, u64 len)
 699 {
 700         struct perf_event_attr attr;
 701
 702         memset(&attr, 0, sizeof(attr));
 703         attr.bp_addr = (unsigned long) ptr;
 704
 705         if (parse_breakpoint_type(type, &attr))
 706                 return -EINVAL;
 707
 708         /* Provide some defaults if len is not specified */
 709         if (!len) {
 710                 if (attr.bp_type == HW_BREAKPOINT_X)
 711                         len = sizeof(long);
 712                 else
 713                         len = HW_BREAKPOINT_LEN_4;
 714         }
 715
 716         attr.bp_len = len;
 717
 718         attr.type = PERF_TYPE_BREAKPOINT;
 719         attr.sample_period = 1;
 720
 721         return add_event(list, idx, &attr, NULL, NULL);
 722 }
 723
 724 static int check_type_val(struct parse_events_term *term,
 725                           struct parse_events_error *err,
 726                           int type)
 727 {
 728         if (type == term->type_val)
 729                 return 0;
 730
 731         if (err) {
 732                 err->idx = term->err_val;
 733                 if (type == PARSE_EVENTS__TERM_TYPE_NUM)
 734                         err->str = strdup("expected numeric value");
 735                 else
 736                         err->str = strdup("expected string value");
 737         }
 738         return -EINVAL;
 739 }
 740
 741 typedef int config_term_func_t(struct perf_event_attr *attr,
 742                                struct parse_events_term *term,
 743                                struct parse_events_error *err);
 744
 745 static int config_term_common(struct perf_event_attr *attr,
 746                               struct parse_events_term *term,
 747                               struct parse_events_error *err)
 748 {
 749 #define CHECK_TYPE_VAL(type)                                               \
 750 do {                                                                       \
 751         if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
 752                 return -EINVAL;                                            \
 753 } while (0)
 754
 755         switch (term->type_term) {
 756         case PARSE_EVENTS__TERM_TYPE_CONFIG:
 757                 CHECK_TYPE_VAL(NUM);
 758                 attr->config = term->val.num;
 759                 break;
 760         case PARSE_EVENTS__TERM_TYPE_CONFIG1:
 761                 CHECK_TYPE_VAL(NUM);
 762                 attr->config1 = term->val.num;
 763                 break;
 764         case PARSE_EVENTS__TERM_TYPE_CONFIG2:
 765                 CHECK_TYPE_VAL(NUM);
 766                 attr->config2 = term->val.num;
 767                 break;
 768         case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
 769                 CHECK_TYPE_VAL(NUM);
 770                 break;
 771         case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
 772                 CHECK_TYPE_VAL(NUM);
 773                 break;
 774         case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
 775                 /*
 776                  * TODO uncomment when the field is available
 777                  * attr->branch_sample_type = term->val.num;
 778                  */
 779                 break;
 780         case PARSE_EVENTS__TERM_TYPE_TIME:
 781                 CHECK_TYPE_VAL(NUM);
 782                 if (term->val.num > 1) {
 783                         err->str = strdup("expected 0 or 1");
 784                         err->idx = term->err_val;
 785                         return -EINVAL;
 786                 }
 787                 break;
 788         case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
 789                 CHECK_TYPE_VAL(STR);
 790                 break;
 791         case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
 792                 CHECK_TYPE_VAL(NUM);
 793                 break;
 794         case PARSE_EVENTS__TERM_TYPE_INHERIT:
 795                 CHECK_TYPE_VAL(NUM);
 796                 break;
 797         case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
 798                 CHECK_TYPE_VAL(NUM);
 799                 break;
 800         case PARSE_EVENTS__TERM_TYPE_NAME:
 801                 CHECK_TYPE_VAL(STR);
 802                 break;
 803         default:
 804                 err->str = strdup("unknown term");
 805                 err->idx = term->err_term;
 806                 err->help = parse_events_formats_error_string(NULL);
 807                 return -EINVAL;
 808         }
 809
 810         return 0;
 811 #undef CHECK_TYPE_VAL
 812 }
 813
 814 static int config_term_pmu(struct perf_event_attr *attr,
 815                            struct parse_events_term *term,
 816                            struct parse_events_error *err)
 817 {
 818         if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER)
 819                 /*
 820                  * Always succeed for sysfs terms, as we dont know
 821                  * at this point what type they need to have.
 822                  */
 823                 return 0;
 824         else
 825                 return config_term_common(attr, term, err);
 826 }
 827
 828 static int config_term_tracepoint(struct perf_event_attr *attr,
 829                                   struct parse_events_term *term,
 830                                   struct parse_events_error *err)
 831 {
 832         switch (term->type_term) {
 833         case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
 834         case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
 835         case PARSE_EVENTS__TERM_TYPE_INHERIT:
 836         case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
 837                 return config_term_common(attr, term, err);
 838         default:
 839                 if (err) {
 840                         err->idx = term->err_term;
 841                         err->str = strdup("unknown term");
 842                         err->help = strdup("valid terms: call-graph,stack-size\n");
 843                 }
 844                 return -EINVAL;
 845         }
 846
 847         return 0;
 848 }
 849
 850 static int config_attr(struct perf_event_attr *attr,
 851                        struct list_head *head,
 852                        struct parse_events_error *err,
 853                        config_term_func_t config_term)
 854 {
 855         struct parse_events_term *term;
 856
 857         list_for_each_entry(term, head, list)
 858                 if (config_term(attr, term, err))
 859                         return -EINVAL;
 860
 861         return 0;
 862 }
 863
 864 static int get_config_terms(struct list_head *head_config,
 865                             struct list_head *head_terms __maybe_unused)
 866 {
 867 #define ADD_CONFIG_TERM(__type, __name, __val)                  \
 868 do {                                                            \
 869         struct perf_evsel_config_term *__t;                     \
 870                                                                 \
 871         __t = zalloc(sizeof(*__t));                             \
 872         if (!__t)                                               \
 873                 return -ENOMEM;                                 \
 874                                                                 \
 875         INIT_LIST_HEAD(&__t->list);                             \
 876         __t->type       = PERF_EVSEL__CONFIG_TERM_ ## __type;   \
 877         __t->val.__name = __val;                                \
 878         list_add_tail(&__t->list, head_terms);                  \
 879 } while (0)
 880
 881         struct parse_events_term *term;
 882
 883         list_for_each_entry(term, head_config, list) {
 884                 switch (term->type_term) {
 885                 case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
 886                         ADD_CONFIG_TERM(PERIOD, period, term->val.num);
 887                         break;
 888                 case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
 889                         ADD_CONFIG_TERM(FREQ, freq, term->val.num);
 890                         break;
 891                 case PARSE_EVENTS__TERM_TYPE_TIME:
 892                         ADD_CONFIG_TERM(TIME, time, term->val.num);
 893                         break;
 894                 case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
 895                         ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
 896                         break;
 897                 case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
 898                         ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
 899                         break;
 900                 case PARSE_EVENTS__TERM_TYPE_INHERIT:
 901                         ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
 902                         break;
 903                 case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
 904                         ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
 905                         break;
 906                 default:
 907                         break;
 908                 }
 909         }
 910 #undef ADD_EVSEL_CONFIG
 911         return 0;
 912 }
 913
 914 int parse_events_add_tracepoint(struct list_head *list, int *idx,
 915                                 char *sys, char *event,
 916                                 struct parse_events_error *err,
 917                                 struct list_head *head_config)
 918 {
 919         if (head_config) {
 920                 struct perf_event_attr attr;
 921
 922                 if (config_attr(&attr, head_config, err,
 923                                 config_term_tracepoint))
 924                         return -EINVAL;
 925         }
 926
 927         if (strpbrk(sys, "*?"))
 928                 return add_tracepoint_multi_sys(list, idx, sys, event,
 929                                                 err, head_config);
 930         else
 931                 return add_tracepoint_event(list, idx, sys, event,
 932                                             err, head_config);
 933 }
 934
 935 int parse_events_add_numeric(struct parse_events_evlist *data,
 936                              struct list_head *list,
 937                              u32 type, u64 config,
 938                              struct list_head *head_config)
 939 {
 940         struct perf_event_attr attr;
 941         LIST_HEAD(config_terms);
 942
 943         memset(&attr, 0, sizeof(attr));
 944         attr.type = type;
 945         attr.config = config;
 946
 947         if (head_config) {
 948                 if (config_attr(&attr, head_config, data->error,
 949                                 config_term_common))
 950                         return -EINVAL;
 951
 952                 if (get_config_terms(head_config, &config_terms))
 953                         return -ENOMEM;
 954         }
 955
 956         return add_event(list, &data->idx, &attr, NULL, &config_terms);
 957 }
 958
 959 static int parse_events__is_name_term(struct parse_events_term *term)
 960 {
 961         return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
 962 }
 963
 964 static char *pmu_event_name(struct list_head *head_terms)
 965 {
 966         struct parse_events_term *term;
 967
 968         list_for_each_entry(term, head_terms, list)
 969                 if (parse_events__is_name_term(term))
 970                         return term->val.str;
 971
 972         return NULL;
 973 }
 974
 975 int parse_events_add_pmu(struct parse_events_evlist *data,
 976                          struct list_head *list, char *name,
 977                          struct list_head *head_config)
 978 {
 979         struct perf_event_attr attr;
 980         struct perf_pmu_info info;
 981         struct perf_pmu *pmu;
 982         struct perf_evsel *evsel;
 983         LIST_HEAD(config_terms);
 984
 985         pmu = perf_pmu__find(name);
 986         if (!pmu)
 987                 return -EINVAL;
 988
 989         if (pmu->default_config) {
 990                 memcpy(&attr, pmu->default_config,
 991                        sizeof(struct perf_event_attr));
 992         } else {
 993                 memset(&attr, 0, sizeof(attr));
 994         }
 995
 996         if (!head_config) {
 997                 attr.type = pmu->type;
 998                 evsel = __add_event(list, &data->idx, &attr, NULL, pmu->cpus, NULL);
 999                 return evsel ? 0 : -ENOMEM;
1000         }
1001
1002         if (perf_pmu__check_alias(pmu, head_config, &info))
1003                 return -EINVAL;
1004
1005         /*
1006          * Configure hardcoded terms first, no need to check
1007          * return value when called with fail == 0 ;)
1008          */
1009         if (config_attr(&attr, head_config, data->error, config_term_pmu))
1010                 return -EINVAL;
1011
1012         if (get_config_terms(head_config, &config_terms))
1013                 return -ENOMEM;
1014
1015         if (perf_pmu__config(pmu, &attr, head_config, data->error))
1016                 return -EINVAL;
1017
1018         evsel = __add_event(list, &data->idx, &attr,
1019                             pmu_event_name(head_config), pmu->cpus,
1020                             &config_terms);
1021         if (evsel) {
1022                 evsel->unit = info.unit;
1023                 evsel->scale = info.scale;
1024                 evsel->per_pkg = info.per_pkg;
1025                 evsel->snapshot = info.snapshot;
1026         }
1027
1028         return evsel ? 0 : -ENOMEM;
1029 }
1030
1031 int parse_events__modifier_group(struct list_head *list,
1032                                  char *event_mod)
1033 {
1034         return parse_events__modifier_event(list, event_mod, true);
1035 }
1036
1037 void parse_events__set_leader(char *name, struct list_head *list)
1038 {
1039         struct perf_evsel *leader;
1040
1041         if (list_empty(list)) {
1042                 WARN_ONCE(true, "WARNING: failed to set leader: empty list");
1043                 return;
1044         }
1045
1046         __perf_evlist__set_leader(list);
1047         leader = list_entry(list->next, struct perf_evsel, node);
1048         leader->group_name = name ? strdup(name) : NULL;
1049 }
1050
1051 /* list_event is assumed to point to malloc'ed memory */
1052 void parse_events_update_lists(struct list_head *list_event,
1053                                struct list_head *list_all)
1054 {
1055         /*
1056          * Called for single event definition. Update the
1057          * 'all event' list, and reinit the 'single event'
1058          * list, for next event definition.
1059          */
1060         list_splice_tail(list_event, list_all);
1061         free(list_event);
1062 }
1063
1064 struct event_modifier {
1065         int eu;
1066         int ek;
1067         int eh;
1068         int eH;
1069         int eG;
1070         int eI;
1071         int precise;
1072         int precise_max;
1073         int exclude_GH;
1074         int sample_read;
1075         int pinned;
1076 };
1077
1078 static int get_event_modifier(struct event_modifier *mod, char *str,
1079                                struct perf_evsel *evsel)
1080 {
1081         int eu = evsel ? evsel->attr.exclude_user : 0;
1082         int ek = evsel ? evsel->attr.exclude_kernel : 0;
1083         int eh = evsel ? evsel->attr.exclude_hv : 0;
1084         int eH = evsel ? evsel->attr.exclude_host : 0;
1085         int eG = evsel ? evsel->attr.exclude_guest : 0;
1086         int eI = evsel ? evsel->attr.exclude_idle : 0;
1087         int precise = evsel ? evsel->attr.precise_ip : 0;
1088         int precise_max = 0;
1089         int sample_read = 0;
1090         int pinned = evsel ? evsel->attr.pinned : 0;
1091
1092         int exclude = eu | ek | eh;
1093         int exclude_GH = evsel ? evsel->exclude_GH : 0;
1094
1095         memset(mod, 0, sizeof(*mod));
1096
1097         while (*str) {
1098                 if (*str == 'u') {
1099                         if (!exclude)
1100                                 exclude = eu = ek = eh = 1;
1101                         eu = 0;
1102                 } else if (*str == 'k') {
1103                         if (!exclude)
1104                                 exclude = eu = ek = eh = 1;
1105                         ek = 0;
1106                 } else if (*str == 'h') {
1107                         if (!exclude)
1108                                 exclude = eu = ek = eh = 1;
1109                         eh = 0;
1110                 } else if (*str == 'G') {
1111                         if (!exclude_GH)
1112                                 exclude_GH = eG = eH = 1;
1113                         eG = 0;
1114                 } else if (*str == 'H') {
1115                         if (!exclude_GH)
1116                                 exclude_GH = eG = eH = 1;
1117                         eH = 0;
1118                 } else if (*str == 'I') {
1119                         eI = 1;
1120                 } else if (*str == 'p') {
1121                         precise++;
1122                         /* use of precise requires exclude_guest */
1123                         if (!exclude_GH)
1124                                 eG = 1;
1125                 } else if (*str == 'P') {
1126                         precise_max = 1;
1127                 } else if (*str == 'S') {
1128                         sample_read = 1;
1129                 } else if (*str == 'D') {
1130                         pinned = 1;
1131                 } else
1132                         break;
1133
1134                 ++str;
1135         }
1136
1137         /*
1138          * precise ip:
1139          *
1140          *  0 - SAMPLE_IP can have arbitrary skid
1141          *  1 - SAMPLE_IP must have constant skid
1142          *  2 - SAMPLE_IP requested to have 0 skid
1143          *  3 - SAMPLE_IP must have 0 skid
1144          *
1145          *  See also PERF_RECORD_MISC_EXACT_IP
1146          */
1147         if (precise > 3)
1148                 return -EINVAL;
1149
1150         mod->eu = eu;
1151         mod->ek = ek;
1152         mod->eh = eh;
1153         mod->eH = eH;
1154         mod->eG = eG;
1155         mod->eI = eI;
1156         mod->precise = precise;
1157         mod->precise_max = precise_max;
1158         mod->exclude_GH = exclude_GH;
1159         mod->sample_read = sample_read;
1160         mod->pinned = pinned;
1161
1162         return 0;
1163 }
1164
1165 /*
1166  * Basic modifier sanity check to validate it contains only one
1167  * instance of any modifier (apart from 'p') present.
1168  */
1169 static int check_modifier(char *str)
1170 {
1171         char *p = str;
1172
1173         /* The sizeof includes 0 byte as well. */
1174         if (strlen(str) > (sizeof("ukhGHpppPSDI") - 1))
1175                 return -1;
1176
1177         while (*p) {
1178                 if (*p != 'p' && strchr(p + 1, *p))
1179                         return -1;
1180                 p++;
1181         }
1182
1183         return 0;
1184 }
1185
1186 int parse_events__modifier_event(struct list_head *list, char *str, bool add)
1187 {
1188         struct perf_evsel *evsel;
1189         struct event_modifier mod;
1190
1191         if (str == NULL)
1192                 return 0;
1193
1194         if (check_modifier(str))
1195                 return -EINVAL;
1196
1197         if (!add && get_event_modifier(&mod, str, NULL))
1198                 return -EINVAL;
1199
1200         __evlist__for_each(list, evsel) {
1201                 if (add && get_event_modifier(&mod, str, evsel))
1202                         return -EINVAL;
1203
1204                 evsel->attr.exclude_user   = mod.eu;
1205                 evsel->attr.exclude_kernel = mod.ek;
1206                 evsel->attr.exclude_hv     = mod.eh;
1207                 evsel->attr.precise_ip     = mod.precise;
1208                 evsel->attr.exclude_host   = mod.eH;
1209                 evsel->attr.exclude_guest  = mod.eG;
1210                 evsel->attr.exclude_idle   = mod.eI;
1211                 evsel->exclude_GH          = mod.exclude_GH;
1212                 evsel->sample_read         = mod.sample_read;
1213                 evsel->precise_max         = mod.precise_max;
1214
1215                 if (perf_evsel__is_group_leader(evsel))
1216                         evsel->attr.pinned = mod.pinned;
1217         }
1218
1219         return 0;
1220 }
1221
1222 int parse_events_name(struct list_head *list, char *name)
1223 {
1224         struct perf_evsel *evsel;
1225
1226         __evlist__for_each(list, evsel) {
1227                 if (!evsel->name)
1228                         evsel->name = strdup(name);
1229         }
1230
1231         return 0;
1232 }
1233
1234 static int
1235 comp_pmu(const void *p1, const void *p2)
1236 {
1237         struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
1238         struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;
1239
1240         return strcmp(pmu1->symbol, pmu2->symbol);
1241 }
1242
1243 static void perf_pmu__parse_cleanup(void)
1244 {
1245         if (perf_pmu_events_list_num > 0) {
1246                 struct perf_pmu_event_symbol *p;
1247                 int i;
1248
1249                 for (i = 0; i < perf_pmu_events_list_num; i++) {
1250                         p = perf_pmu_events_list + i;
1251                         free(p->symbol);
1252                 }
1253                 free(perf_pmu_events_list);
1254                 perf_pmu_events_list = NULL;
1255                 perf_pmu_events_list_num = 0;
1256         }
1257 }
1258
1259 #define SET_SYMBOL(str, stype)          \
1260 do {                                    \
1261         p->symbol = str;                \
1262         if (!p->symbol)                 \
1263                 goto err;               \
1264         p->type = stype;                \
1265 } while (0)
1266
1267 /*
1268  * Read the pmu events list from sysfs
1269  * Save it into perf_pmu_events_list
1270  */
1271 static void perf_pmu__parse_init(void)
1272 {
1273
1274         struct perf_pmu *pmu = NULL;
1275         struct perf_pmu_alias *alias;
1276         int len = 0;
1277
1278         pmu = perf_pmu__find("cpu");
1279         if ((pmu == NULL) || list_empty(&pmu->aliases)) {
1280                 perf_pmu_events_list_num = -1;
1281                 return;
1282         }
1283         list_for_each_entry(alias, &pmu->aliases, list) {
1284                 if (strchr(alias->name, '-'))
1285                         len++;
1286                 len++;
1287         }
1288         perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
1289         if (!perf_pmu_events_list)
1290                 return;
1291         perf_pmu_events_list_num = len;
1292
1293         len = 0;
1294         list_for_each_entry(alias, &pmu->aliases, list) {
1295                 struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
1296                 char *tmp = strchr(alias->name, '-');
1297
1298                 if (tmp != NULL) {
1299                         SET_SYMBOL(strndup(alias->name, tmp - alias->name),
1300                                         PMU_EVENT_SYMBOL_PREFIX);
1301                         p++;
1302                         SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
1303                         len += 2;
1304                 } else {
1305                         SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
1306                         len++;
1307                 }
1308         }
1309         qsort(perf_pmu_events_list, len,
1310                 sizeof(struct perf_pmu_event_symbol), comp_pmu);
1311
1312         return;
1313 err:
1314         perf_pmu__parse_cleanup();
1315 }
1316
1317 enum perf_pmu_event_symbol_type
1318 perf_pmu__parse_check(const char *name)
1319 {
1320         struct perf_pmu_event_symbol p, *r;
1321
1322         /* scan kernel pmu events from sysfs if needed */
1323         if (perf_pmu_events_list_num == 0)
1324                 perf_pmu__parse_init();
1325         /*
1326          * name "cpu" could be prefix of cpu-cycles or cpu// events.
1327          * cpu-cycles has been handled by hardcode.
1328          * So it must be cpu// events, not kernel pmu event.
1329          */
1330         if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
1331                 return PMU_EVENT_SYMBOL_ERR;
1332
1333         p.symbol = strdup(name);
1334         r = bsearch(&p, perf_pmu_events_list,
1335                         (size_t) perf_pmu_events_list_num,
1336                         sizeof(struct perf_pmu_event_symbol), comp_pmu);
1337         free(p.symbol);
1338         return r ? r->type : PMU_EVENT_SYMBOL_ERR;
1339 }
1340
1341 static int parse_events__scanner(const char *str, void *data, int start_token)
1342 {
1343         YY_BUFFER_STATE buffer;
1344         void *scanner;
1345         int ret;
1346
1347         ret = parse_events_lex_init_extra(start_token, &scanner);
1348         if (ret)
1349                 return ret;
1350
1351         buffer = parse_events__scan_string(str, scanner);
1352
1353 #ifdef PARSER_DEBUG
1354         parse_events_debug = 1;
1355 #endif
1356         ret = parse_events_parse(data, scanner);
1357
1358         parse_events__flush_buffer(buffer, scanner);
1359         parse_events__delete_buffer(buffer, scanner);
1360         parse_events_lex_destroy(scanner);
1361         return ret;
1362 }
1363
1364 /*
1365  * parse event config string, return a list of event terms.
1366  */
1367 int parse_events_terms(struct list_head *terms, const char *str)
1368 {
1369         struct parse_events_terms data = {
1370                 .terms = NULL,
1371         };
1372         int ret;
1373
1374         ret = parse_events__scanner(str, &data, PE_START_TERMS);
1375         if (!ret) {
1376                 list_splice(data.terms, terms);
1377                 zfree(&data.terms);
1378                 return 0;
1379         }
1380
1381         if (data.terms)
1382                 parse_events__free_terms(data.terms);
1383         return ret;
1384 }
1385
1386 int parse_events(struct perf_evlist *evlist, const char *str,
1387                  struct parse_events_error *err)
1388 {
1389         struct parse_events_evlist data = {
1390                 .list  = LIST_HEAD_INIT(data.list),
1391                 .idx   = evlist->nr_entries,
1392                 .error = err,
1393         };
1394         int ret;
1395
1396         ret = parse_events__scanner(str, &data, PE_START_EVENTS);
1397         perf_pmu__parse_cleanup();
1398         if (!ret) {
1399                 struct perf_evsel *last;
1400
1401                 if (list_empty(&data.list)) {
1402                         WARN_ONCE(true, "WARNING: event parser found nothing");
1403                         return -1;
1404                 }
1405
1406                 perf_evlist__splice_list_tail(evlist, &data.list);
1407                 evlist->nr_groups += data.nr_groups;
1408                 last = perf_evlist__last(evlist);
1409                 last->cmdline_group_boundary = true;
1410
1411                 return 0;
1412         }
1413
1414         /*
1415          * There are 2 users - builtin-record and builtin-test objects.
1416          * Both call perf_evlist__delete in case of error, so we dont
1417          * need to bother.
1418          */
1419         return ret;
1420 }
1421
1422 #define MAX_WIDTH 1000
1423 static int get_term_width(void)
1424 {
1425         struct winsize ws;
1426
1427         get_term_dimensions(&ws);
1428         return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
1429 }
1430
1431 static void parse_events_print_error(struct parse_events_error *err,
1432                                      const char *event)
1433 {
1434         const char *str = "invalid or unsupported event: ";
1435         char _buf[MAX_WIDTH];
1436         char *buf = (char *) event;
1437         int idx = 0;
1438
1439         if (err->str) {
1440                 /* -2 for extra '' in the final fprintf */
1441                 int width       = get_term_width() - 2;
1442                 int len_event   = strlen(event);
1443                 int len_str, max_len, cut = 0;
1444
1445                 /*
1446                  * Maximum error index indent, we will cut
1447                  * the event string if it's bigger.
1448                  */
1449                 int max_err_idx = 13;
1450
1451                 /*
1452                  * Let's be specific with the message when
1453                  * we have the precise error.
1454                  */
1455                 str     = "event syntax error: ";
1456                 len_str = strlen(str);
1457                 max_len = width - len_str;
1458
1459                 buf = _buf;
1460
1461                 /* We're cutting from the beggining. */
1462                 if (err->idx > max_err_idx)
1463                         cut = err->idx - max_err_idx;
1464
1465                 strncpy(buf, event + cut, max_len);
1466
1467                 /* Mark cut parts with '..' on both sides. */
1468                 if (cut)
1469                         buf[0] = buf[1] = '.';
1470
1471                 if ((len_event - cut) > max_len) {
1472                         buf[max_len - 1] = buf[max_len - 2] = '.';
1473                         buf[max_len] = 0;
1474                 }
1475
1476                 idx = len_str + err->idx - cut;
1477         }
1478
1479         fprintf(stderr, "%s'%s'\n", str, buf);
1480         if (idx) {
1481                 fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
1482                 if (err->help)
1483                         fprintf(stderr, "\n%s\n", err->help);
1484                 free(err->str);
1485                 free(err->help);
1486         }
1487
1488         fprintf(stderr, "Run 'perf list' for a list of valid events\n");
1489 }
1490
1491 #undef MAX_WIDTH
1492
1493 int parse_events_option(const struct option *opt, const char *str,
1494                         int unset __maybe_unused)
1495 {
1496         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1497         struct parse_events_error err = { .idx = 0, };
1498         int ret = parse_events(evlist, str, &err);
1499
1500         if (ret)
1501                 parse_events_print_error(&err, str);
1502
1503         return ret;
1504 }
1505
1506 static int
1507 foreach_evsel_in_last_glob(struct perf_evlist *evlist,
1508                            int (*func)(struct perf_evsel *evsel,
1509                                        const void *arg),
1510                            const void *arg)
1511 {
1512         struct perf_evsel *last = NULL;
1513         int err;
1514
1515         /*
1516          * Don't return when list_empty, give func a chance to report
1517          * error when it found last == NULL.
1518          *
1519          * So no need to WARN here, let *func do this.
1520          */
1521         if (evlist->nr_entries > 0)
1522                 last = perf_evlist__last(evlist);
1523
1524         do {
1525                 err = (*func)(last, arg);
1526                 if (err)
1527                         return -1;
1528                 if (!last)
1529                         return 0;
1530
1531                 if (last->node.prev == &evlist->entries)
1532                         return 0;
1533                 last = list_entry(last->node.prev, struct perf_evsel, node);
1534         } while (!last->cmdline_group_boundary);
1535
1536         return 0;
1537 }
1538
1539 static int set_filter(struct perf_evsel *evsel, const void *arg)
1540 {
1541         const char *str = arg;
1542
1543         if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
1544                 fprintf(stderr,
1545                         "--filter option should follow a -e tracepoint option\n");
1546                 return -1;
1547         }
1548
1549         if (perf_evsel__append_filter(evsel, "&&", str) < 0) {
1550                 fprintf(stderr,
1551                         "not enough memory to hold filter string\n");
1552                 return -1;
1553         }
1554
1555         return 0;
1556 }
1557
1558 int parse_filter(const struct option *opt, const char *str,
1559                  int unset __maybe_unused)
1560 {
1561         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1562
1563         return foreach_evsel_in_last_glob(evlist, set_filter,
1564                                           (const void *)str);
1565 }
1566
1567 static int add_exclude_perf_filter(struct perf_evsel *evsel,
1568                                    const void *arg __maybe_unused)
1569 {
1570         char new_filter[64];
1571
1572         if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
1573                 fprintf(stderr,
1574                         "--exclude-perf option should follow a -e tracepoint option\n");
1575                 return -1;
1576         }
1577
1578         snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());
1579
1580         if (perf_evsel__append_filter(evsel, "&&", new_filter) < 0) {
1581                 fprintf(stderr,
1582                         "not enough memory to hold filter string\n");
1583                 return -1;
1584         }
1585
1586         return 0;
1587 }
1588
1589 int exclude_perf(const struct option *opt,
1590                  const char *arg __maybe_unused,
1591                  int unset __maybe_unused)
1592 {
1593         struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1594
1595         return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
1596                                           NULL);
1597 }
1598
1599 static const char * const event_type_descriptors[] = {
1600         "Hardware event",
1601         "Software event",
1602         "Tracepoint event",
1603         "Hardware cache event",
1604         "Raw hardware event descriptor",
1605         "Hardware breakpoint",
1606 };
1607
1608 static int cmp_string(const void *a, const void *b)
1609 {
1610         const char * const *as = a;
1611         const char * const *bs = b;
1612
1613         return strcmp(*as, *bs);
1614 }
1615
1616 /*
1617  * Print the events from <debugfs_mount_point>/tracing/events
1618  */
1619
1620 void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
1621                              bool name_only)
1622 {
1623         DIR *sys_dir, *evt_dir;
1624         struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
1625         char evt_path[MAXPATHLEN];
1626         char dir_path[MAXPATHLEN];
1627         char **evt_list = NULL;
1628         unsigned int evt_i = 0, evt_num = 0;
1629         bool evt_num_known = false;
1630
1631 restart:
1632         sys_dir = opendir(tracing_events_path);
1633         if (!sys_dir)
1634                 return;
1635
1636         if (evt_num_known) {
1637                 evt_list = zalloc(sizeof(char *) * evt_num);
1638                 if (!evt_list)
1639                         goto out_close_sys_dir;
1640         }
1641
1642         for_each_subsystem(sys_dir, sys_dirent, sys_next) {
1643                 if (subsys_glob != NULL &&
1644                     !strglobmatch(sys_dirent.d_name, subsys_glob))
1645                         continue;
1646
1647                 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
1648                          sys_dirent.d_name);
1649                 evt_dir = opendir(dir_path);
1650                 if (!evt_dir)
1651                         continue;
1652
1653                 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
1654                         if (event_glob != NULL &&
1655                             !strglobmatch(evt_dirent.d_name, event_glob))
1656                                 continue;
1657
1658                         if (!evt_num_known) {
1659                                 evt_num++;
1660                                 continue;
1661                         }
1662
1663                         snprintf(evt_path, MAXPATHLEN, "%s:%s",
1664                                  sys_dirent.d_name, evt_dirent.d_name);
1665
1666                         evt_list[evt_i] = strdup(evt_path);
1667                         if (evt_list[evt_i] == NULL)
1668                                 goto out_close_evt_dir;
1669                         evt_i++;
1670                 }
1671                 closedir(evt_dir);
1672         }
1673         closedir(sys_dir);
1674
1675         if (!evt_num_known) {
1676                 evt_num_known = true;
1677                 goto restart;
1678         }
1679         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1680         evt_i = 0;
1681         while (evt_i < evt_num) {
1682                 if (name_only) {
1683                         printf("%s ", evt_list[evt_i++]);
1684                         continue;
1685                 }
1686                 printf("  %-50s [%s]\n", evt_list[evt_i++],
1687                                 event_type_descriptors[PERF_TYPE_TRACEPOINT]);
1688         }
1689         if (evt_num && pager_in_use())
1690                 printf("\n");
1691
1692 out_free:
1693         evt_num = evt_i;
1694         for (evt_i = 0; evt_i < evt_num; evt_i++)
1695                 zfree(&evt_list[evt_i]);
1696         zfree(&evt_list);
1697         return;
1698
1699 out_close_evt_dir:
1700         closedir(evt_dir);
1701 out_close_sys_dir:
1702         closedir(sys_dir);
1703
1704         printf("FATAL: not enough memory to print %s\n",
1705                         event_type_descriptors[PERF_TYPE_TRACEPOINT]);
1706         if (evt_list)
1707                 goto out_free;
1708 }
1709
1710 /*
1711  * Check whether event is in <debugfs_mount_point>/tracing/events
1712  */
1713
1714 int is_valid_tracepoint(const char *event_string)
1715 {
1716         DIR *sys_dir, *evt_dir;
1717         struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
1718         char evt_path[MAXPATHLEN];
1719         char dir_path[MAXPATHLEN];
1720
1721         sys_dir = opendir(tracing_events_path);
1722         if (!sys_dir)
1723                 return 0;
1724
1725         for_each_subsystem(sys_dir, sys_dirent, sys_next) {
1726
1727                 snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
1728                          sys_dirent.d_name);
1729                 evt_dir = opendir(dir_path);
1730                 if (!evt_dir)
1731                         continue;
1732
1733                 for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
1734                         snprintf(evt_path, MAXPATHLEN, "%s:%s",
1735                                  sys_dirent.d_name, evt_dirent.d_name);
1736                         if (!strcmp(evt_path, event_string)) {
1737                                 closedir(evt_dir);
1738                                 closedir(sys_dir);
1739                                 return 1;
1740                         }
1741                 }
1742                 closedir(evt_dir);
1743         }
1744         closedir(sys_dir);
1745         return 0;
1746 }
1747
1748 static bool is_event_supported(u8 type, unsigned config)
1749 {
1750         bool ret = true;
1751         int open_return;
1752         struct perf_evsel *evsel;
1753         struct perf_event_attr attr = {
1754                 .type = type,
1755                 .config = config,
1756                 .disabled = 1,
1757         };
1758         struct {
1759                 struct thread_map map;
1760                 int threads[1];
1761         } tmap = {
1762                 .map.nr  = 1,
1763                 .threads = { 0 },
1764         };
1765
1766         evsel = perf_evsel__new(&attr);
1767         if (evsel) {
1768                 open_return = perf_evsel__open(evsel, NULL, &tmap.map);
1769                 ret = open_return >= 0;
1770
1771                 if (open_return == -EACCES) {
1772                         /*
1773                          * This happens if the paranoid value
1774                          * /proc/sys/kernel/perf_event_paranoid is set to 2
1775                          * Re-run with exclude_kernel set; we don't do that
1776                          * by default as some ARM machines do not support it.
1777                          *
1778                          */
1779                         evsel->attr.exclude_kernel = 1;
1780                         ret = perf_evsel__open(evsel, NULL, &tmap.map) >= 0;
1781                 }
1782                 perf_evsel__delete(evsel);
1783         }
1784
1785         return ret;
1786 }
1787
1788 int print_hwcache_events(const char *event_glob, bool name_only)
1789 {
1790         unsigned int type, op, i, evt_i = 0, evt_num = 0;
1791         char name[64];
1792         char **evt_list = NULL;
1793         bool evt_num_known = false;
1794
1795 restart:
1796         if (evt_num_known) {
1797                 evt_list = zalloc(sizeof(char *) * evt_num);
1798                 if (!evt_list)
1799                         goto out_enomem;
1800         }
1801
1802         for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
1803                 for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
1804                         /* skip invalid cache type */
1805                         if (!perf_evsel__is_cache_op_valid(type, op))
1806                                 continue;
1807
1808                         for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
1809                                 __perf_evsel__hw_cache_type_op_res_name(type, op, i,
1810                                                                         name, sizeof(name));
1811                                 if (event_glob != NULL && !strglobmatch(name, event_glob))
1812                                         continue;
1813
1814                                 if (!is_event_supported(PERF_TYPE_HW_CACHE,
1815                                                         type | (op << 8) | (i << 16)))
1816                                         continue;
1817
1818                                 if (!evt_num_known) {
1819                                         evt_num++;
1820                                         continue;
1821                                 }
1822
1823                                 evt_list[evt_i] = strdup(name);
1824                                 if (evt_list[evt_i] == NULL)
1825                                         goto out_enomem;
1826                                 evt_i++;
1827                         }
1828                 }
1829         }
1830
1831         if (!evt_num_known) {
1832                 evt_num_known = true;
1833                 goto restart;
1834         }
1835         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1836         evt_i = 0;
1837         while (evt_i < evt_num) {
1838                 if (name_only) {
1839                         printf("%s ", evt_list[evt_i++]);
1840                         continue;
1841                 }
1842                 printf("  %-50s [%s]\n", evt_list[evt_i++],
1843                                 event_type_descriptors[PERF_TYPE_HW_CACHE]);
1844         }
1845         if (evt_num && pager_in_use())
1846                 printf("\n");
1847
1848 out_free:
1849         evt_num = evt_i;
1850         for (evt_i = 0; evt_i < evt_num; evt_i++)
1851                 zfree(&evt_list[evt_i]);
1852         zfree(&evt_list);
1853         return evt_num;
1854
1855 out_enomem:
1856         printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
1857         if (evt_list)
1858                 goto out_free;
1859         return evt_num;
1860 }
1861
1862 void print_symbol_events(const char *event_glob, unsigned type,
1863                                 struct event_symbol *syms, unsigned max,
1864                                 bool name_only)
1865 {
1866         unsigned int i, evt_i = 0, evt_num = 0;
1867         char name[MAX_NAME_LEN];
1868         char **evt_list = NULL;
1869         bool evt_num_known = false;
1870
1871 restart:
1872         if (evt_num_known) {
1873                 evt_list = zalloc(sizeof(char *) * evt_num);
1874                 if (!evt_list)
1875                         goto out_enomem;
1876                 syms -= max;
1877         }
1878
1879         for (i = 0; i < max; i++, syms++) {
1880
1881                 if (event_glob != NULL &&
1882                     !(strglobmatch(syms->symbol, event_glob) ||
1883                       (syms->alias && strglobmatch(syms->alias, event_glob))))
1884                         continue;
1885
1886                 if (!is_event_supported(type, i))
1887                         continue;
1888
1889                 if (!evt_num_known) {
1890                         evt_num++;
1891                         continue;
1892                 }
1893
1894                 if (!name_only && strlen(syms->alias))
1895                         snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
1896                 else
1897                         strncpy(name, syms->symbol, MAX_NAME_LEN);
1898
1899                 evt_list[evt_i] = strdup(name);
1900                 if (evt_list[evt_i] == NULL)
1901                         goto out_enomem;
1902                 evt_i++;
1903         }
1904
1905         if (!evt_num_known) {
1906                 evt_num_known = true;
1907                 goto restart;
1908         }
1909         qsort(evt_list, evt_num, sizeof(char *), cmp_string);
1910         evt_i = 0;
1911         while (evt_i < evt_num) {
1912                 if (name_only) {
1913                         printf("%s ", evt_list[evt_i++]);
1914                         continue;
1915                 }
1916                 printf("  %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
1917         }
1918         if (evt_num && pager_in_use())
1919                 printf("\n");
1920
1921 out_free:
1922         evt_num = evt_i;
1923         for (evt_i = 0; evt_i < evt_num; evt_i++)
1924                 zfree(&evt_list[evt_i]);
1925         zfree(&evt_list);
1926         return;
1927
1928 out_enomem:
1929         printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
1930         if (evt_list)
1931                 goto out_free;
1932 }
1933
1934 /*
1935  * Print the help text for the event symbols:
1936  */
1937 void print_events(const char *event_glob, bool name_only)
1938 {
1939         print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
1940                             event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
1941
1942         print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
1943                             event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
1944
1945         print_hwcache_events(event_glob, name_only);
1946
1947         print_pmu_events(event_glob, name_only);
1948
1949         if (event_glob != NULL)
1950                 return;
1951
1952         if (!name_only) {
1953                 printf("  %-50s [%s]\n",
1954                        "rNNN",
1955                        event_type_descriptors[PERF_TYPE_RAW]);
1956                 printf("  %-50s [%s]\n",
1957                        "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
1958                        event_type_descriptors[PERF_TYPE_RAW]);
1959                 if (pager_in_use())
1960                         printf("   (see 'man perf-list' on how to encode it)\n\n");
1961
1962                 printf("  %-50s [%s]\n",
1963                        "mem:<addr>[/len][:access]",
1964                         event_type_descriptors[PERF_TYPE_BREAKPOINT]);
1965                 if (pager_in_use())
1966                         printf("\n");
1967         }
1968
1969         print_tracepoint_events(NULL, NULL, name_only);
1970 }
1971
1972 int parse_events__is_hardcoded_term(struct parse_events_term *term)
1973 {
1974         return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
1975 }
1976
1977 static int new_term(struct parse_events_term **_term, int type_val,
1978                     int type_term, char *config,
1979                     char *str, u64 num, int err_term, int err_val)
1980 {
1981         struct parse_events_term *term;
1982
1983         term = zalloc(sizeof(*term));
1984         if (!term)
1985                 return -ENOMEM;
1986
1987         INIT_LIST_HEAD(&term->list);
1988         term->type_val  = type_val;
1989         term->type_term = type_term;
1990         term->config = config;
1991         term->err_term = err_term;
1992         term->err_val  = err_val;
1993
1994         switch (type_val) {
1995         case PARSE_EVENTS__TERM_TYPE_NUM:
1996                 term->val.num = num;
1997                 break;
1998         case PARSE_EVENTS__TERM_TYPE_STR:
1999                 term->val.str = str;
2000                 break;
2001         default:
2002                 free(term);
2003                 return -EINVAL;
2004         }
2005
2006         *_term = term;
2007         return 0;
2008 }
2009
2010 int parse_events_term__num(struct parse_events_term **term,
2011                            int type_term, char *config, u64 num,
2012                            void *loc_term_, void *loc_val_)
2013 {
2014         YYLTYPE *loc_term = loc_term_;
2015         YYLTYPE *loc_val = loc_val_;
2016
2017         return new_term(term, PARSE_EVENTS__TERM_TYPE_NUM, type_term,
2018                         config, NULL, num,
2019                         loc_term ? loc_term->first_column : 0,
2020                         loc_val ? loc_val->first_column : 0);
2021 }
2022
2023 int parse_events_term__str(struct parse_events_term **term,
2024                            int type_term, char *config, char *str,
2025                            void *loc_term_, void *loc_val_)
2026 {
2027         YYLTYPE *loc_term = loc_term_;
2028         YYLTYPE *loc_val = loc_val_;
2029
2030         return new_term(term, PARSE_EVENTS__TERM_TYPE_STR, type_term,
2031                         config, str, 0,
2032                         loc_term ? loc_term->first_column : 0,
2033                         loc_val ? loc_val->first_column : 0);
2034 }
2035
2036 int parse_events_term__sym_hw(struct parse_events_term **term,
2037                               char *config, unsigned idx)
2038 {
2039         struct event_symbol *sym;
2040
2041         BUG_ON(idx >= PERF_COUNT_HW_MAX);
2042         sym = &event_symbols_hw[idx];
2043
2044         if (config)
2045                 return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
2046                                 PARSE_EVENTS__TERM_TYPE_USER, config,
2047                                 (char *) sym->symbol, 0, 0, 0);
2048         else
2049                 return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
2050                                 PARSE_EVENTS__TERM_TYPE_USER,
2051                                 (char *) "event", (char *) sym->symbol,
2052                                 0, 0, 0);
2053 }
2054
2055 int parse_events_term__clone(struct parse_events_term **new,
2056                              struct parse_events_term *term)
2057 {
2058         return new_term(new, term->type_val, term->type_term, term->config,
2059                         term->val.str, term->val.num,
2060                         term->err_term, term->err_val);
2061 }
2062
2063 void parse_events__free_terms(struct list_head *terms)
2064 {
2065         struct parse_events_term *term, *h;
2066
2067         list_for_each_entry_safe(term, h, terms, list)
2068                 free(term);
2069 }
2070
2071 void parse_events_evlist_error(struct parse_events_evlist *data,
2072                                int idx, const char *str)
2073 {
2074         struct parse_events_error *err = data->error;
2075
2076         if (!err)
2077                 return;
2078         err->idx = idx;
2079         err->str = strdup(str);
2080         WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
2081 }
2082
2083 /*
2084  * Return string contains valid config terms of an event.
2085  * @additional_terms: For terms such as PMU sysfs terms.
2086  */
2087 char *parse_events_formats_error_string(char *additional_terms)
2088 {
2089         char *str;
2090         static const char *static_terms = "config,config1,config2,name,"
2091                                           "period,freq,branch_type,time,"
2092                                           "call-graph,stack-size\n";
2093
2094         /* valid terms */
2095         if (additional_terms) {
2096                 if (!asprintf(&str, "valid terms: %s,%s",
2097                               additional_terms, static_terms))
2098                         goto fail;
2099         } else {
2100                 if (!asprintf(&str, "valid terms: %s", static_terms))
2101                         goto fail;
2102         }
2103         return str;
2104
2105 fail:
2106         return NULL;
2107 }