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