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