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