parse-events.c 47.7 KB
Newer Older
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 8 9
#include "parse-options.h"
#include "parse-events.h"
#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 28 29
#ifdef PARSER_DEBUG
extern int parse_events_debug;
#endif
30
int parse_events_parse(void *data, void *scanner);
31 32
static int get_config_terms(struct list_head *head_config,
			    struct list_head *head_terms __maybe_unused);
33

34 35 36 37 38 39 40 41 42
static struct perf_pmu_event_symbol *perf_pmu_events_list;
/*
 * The variable indicates the number of supported pmu event symbols.
 * 0 means not initialized and ready to init
 * -1 means failed to init, don't try anymore
 * >0 is the number of supported pmu event symbols
 */
static int perf_pmu_events_list_num;

43
struct event_symbol event_symbols_hw[PERF_COUNT_HW_MAX] = {
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
	[PERF_COUNT_HW_CPU_CYCLES] = {
		.symbol = "cpu-cycles",
		.alias  = "cycles",
	},
	[PERF_COUNT_HW_INSTRUCTIONS] = {
		.symbol = "instructions",
		.alias  = "",
	},
	[PERF_COUNT_HW_CACHE_REFERENCES] = {
		.symbol = "cache-references",
		.alias  = "",
	},
	[PERF_COUNT_HW_CACHE_MISSES] = {
		.symbol = "cache-misses",
		.alias  = "",
	},
	[PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = {
		.symbol = "branch-instructions",
		.alias  = "branches",
	},
	[PERF_COUNT_HW_BRANCH_MISSES] = {
		.symbol = "branch-misses",
		.alias  = "",
	},
	[PERF_COUNT_HW_BUS_CYCLES] = {
		.symbol = "bus-cycles",
		.alias  = "",
	},
	[PERF_COUNT_HW_STALLED_CYCLES_FRONTEND] = {
		.symbol = "stalled-cycles-frontend",
		.alias  = "idle-cycles-frontend",
	},
	[PERF_COUNT_HW_STALLED_CYCLES_BACKEND] = {
		.symbol = "stalled-cycles-backend",
		.alias  = "idle-cycles-backend",
	},
	[PERF_COUNT_HW_REF_CPU_CYCLES] = {
		.symbol = "ref-cycles",
		.alias  = "",
	},
};

86
struct event_symbol event_symbols_sw[PERF_COUNT_SW_MAX] = {
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
	[PERF_COUNT_SW_CPU_CLOCK] = {
		.symbol = "cpu-clock",
		.alias  = "",
	},
	[PERF_COUNT_SW_TASK_CLOCK] = {
		.symbol = "task-clock",
		.alias  = "",
	},
	[PERF_COUNT_SW_PAGE_FAULTS] = {
		.symbol = "page-faults",
		.alias  = "faults",
	},
	[PERF_COUNT_SW_CONTEXT_SWITCHES] = {
		.symbol = "context-switches",
		.alias  = "cs",
	},
	[PERF_COUNT_SW_CPU_MIGRATIONS] = {
		.symbol = "cpu-migrations",
		.alias  = "migrations",
	},
	[PERF_COUNT_SW_PAGE_FAULTS_MIN] = {
		.symbol = "minor-faults",
		.alias  = "",
	},
	[PERF_COUNT_SW_PAGE_FAULTS_MAJ] = {
		.symbol = "major-faults",
		.alias  = "",
	},
	[PERF_COUNT_SW_ALIGNMENT_FAULTS] = {
		.symbol = "alignment-faults",
		.alias  = "",
	},
	[PERF_COUNT_SW_EMULATION_FAULTS] = {
		.symbol = "emulation-faults",
		.alias  = "",
	},
123 124 125 126
	[PERF_COUNT_SW_DUMMY] = {
		.symbol = "dummy",
		.alias  = "",
	},
127 128
};

129 130
#define __PERF_EVENT_FIELD(config, name) \
	((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 141 142
	   (strcmp(sys_dirent.d_name, ".")) &&				       \
	   (strcmp(sys_dirent.d_name, "..")))

143 144 145 146 147
static int tp_event_has_id(struct dirent *sys_dir, struct dirent *evt_dir)
{
	char evt_path[MAXPATHLEN];
	int fd;

148
	snprintf(evt_path, MAXPATHLEN, "%s/%s/%s/id", tracing_events_path,
149 150 151 152 153 154 155 156 157
			sys_dir->d_name, evt_dir->d_name);
	fd = open(evt_path, O_RDONLY);
	if (fd < 0)
		return -EINVAL;
	close(fd);

	return 0;
}

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 163
	   (strcmp(evt_dirent.d_name, "..")) &&				       \
	   (!tp_event_has_id(&sys_dirent, &evt_dirent)))
164

L
Li Zefan 已提交
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 172
	DIR *sys_dir, *evt_dir;
	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
173
	char id_buf[24];
E
Eric Dumazet 已提交
174
	int fd;
175 176
	u64 id;
	char evt_path[MAXPATHLEN];
E
Eric Dumazet 已提交
177
	char dir_path[MAXPATHLEN];
178

179
	sys_dir = opendir(tracing_events_path);
180
	if (!sys_dir)
E
Eric Dumazet 已提交
181
		return NULL;
182 183

	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
E
Eric Dumazet 已提交
184

185
		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
E
Eric Dumazet 已提交
186 187 188
			 sys_dirent.d_name);
		evt_dir = opendir(dir_path);
		if (!evt_dir)
189
			continue;
E
Eric Dumazet 已提交
190

191
		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
E
Eric Dumazet 已提交
192 193

			snprintf(evt_path, MAXPATHLEN, "%s/%s/id", dir_path,
194
				 evt_dirent.d_name);
E
Eric Dumazet 已提交
195
			fd = open(evt_path, O_RDONLY);
196 197 198 199 200 201 202 203 204 205 206
			if (fd < 0)
				continue;
			if (read(fd, id_buf, sizeof(id_buf)) < 0) {
				close(fd);
				continue;
			}
			close(fd);
			id = atoll(id_buf);
			if (id == config) {
				closedir(evt_dir);
				closedir(sys_dir);
207
				path = zalloc(sizeof(*path));
208 209 210 211 212 213 214
				path->system = malloc(MAX_EVENT_LENGTH);
				if (!path->system) {
					free(path);
					return NULL;
				}
				path->name = malloc(MAX_EVENT_LENGTH);
				if (!path->name) {
215
					zfree(&path->system);
216 217 218 219 220 221 222 223
					free(path);
					return NULL;
				}
				strncpy(path->system, sys_dirent.d_name,
					MAX_EVENT_LENGTH);
				strncpy(path->name, evt_dirent.d_name,
					MAX_EVENT_LENGTH);
				return path;
224 225 226 227 228 229
			}
		}
		closedir(evt_dir);
	}

	closedir(sys_dir);
230 231 232
	return NULL;
}

233 234 235 236 237 238 239 240 241 242 243 244 245 246
struct tracepoint_path *tracepoint_name_to_path(const char *name)
{
	struct tracepoint_path *path = zalloc(sizeof(*path));
	char *str = strchr(name, ':');

	if (path == NULL || str == NULL) {
		free(path);
		return NULL;
	}

	path->system = strndup(name, str - name);
	path->name = strdup(str+1);

	if (path->system == NULL || path->name == NULL) {
247 248
		zfree(&path->system);
		zfree(&path->name);
249 250 251 252 253 254 255
		free(path);
		path = NULL;
	}

	return path;
}

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
const char *event_type(int type)
{
	switch (type) {
	case PERF_TYPE_HARDWARE:
		return "hardware";

	case PERF_TYPE_SOFTWARE:
		return "software";

	case PERF_TYPE_TRACEPOINT:
		return "tracepoint";

	case PERF_TYPE_HW_CACHE:
		return "hardware-cache";

	default:
		break;
	}

	return "unknown";
}

Y
Yan, Zheng 已提交
278 279


280 281 282
static struct perf_evsel *
__add_event(struct list_head *list, int *idx,
	    struct perf_event_attr *attr,
283 284
	    char *name, struct cpu_map *cpus,
	    struct list_head *config_terms)
285 286 287 288 289
{
	struct perf_evsel *evsel;

	event_attr_init(attr);

290
	evsel = perf_evsel__new_idx(attr, (*idx)++);
291
	if (!evsel)
292
		return NULL;
293

A
Adrian Hunter 已提交
294 295
	evsel->cpus     = cpu_map__get(cpus);
	evsel->own_cpus = cpu_map__get(cpus);
296

297 298
	if (name)
		evsel->name = strdup(name);
299 300 301 302

	if (config_terms)
		list_splice(config_terms, &evsel->config_terms);

303
	list_add_tail(&evsel->node, list);
304
	return evsel;
305 306
}

307
static int add_event(struct list_head *list, int *idx,
308 309
		     struct perf_event_attr *attr, char *name,
		     struct list_head *config_terms)
Y
Yan, Zheng 已提交
310
{
311
	return __add_event(list, idx, attr, name, NULL, config_terms) ? 0 : -ENOMEM;
Y
Yan, Zheng 已提交
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 324
				longest = n;
		}
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 336
	struct perf_event_attr attr;
	char name[MAX_NAME_LEN];
337
	int cache_type = -1, cache_op = -1, cache_result = -1;
338 339
	char *op_result[2] = { op_result1, op_result2 };
	int i, n;
340 341 342 343 344

	/*
	 * No fallback - if we cannot get a clear cache type
	 * then bail out:
	 */
345
	cache_type = parse_aliases(type, perf_evsel__hw_cache,
346
				   PERF_COUNT_HW_CACHE_MAX);
347
	if (cache_type == -1)
348 349 350
		return -EINVAL;

	n = snprintf(name, MAX_NAME_LEN, "%s", type);
351

352 353 354
	for (i = 0; (i < 2) && (op_result[i]); i++) {
		char *str = op_result[i];

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 364 365 366 367
				continue;
			}
		}

		if (cache_result == -1) {
368 369
			cache_result = parse_aliases(str, perf_evsel__hw_cache_result,
						     PERF_COUNT_HW_CACHE_RESULT_MAX);
370 371 372 373
			if (cache_result >= 0)
				continue;
		}
	}
374 375 376 377

	/*
	 * Fall back to reads:
	 */
378 379
	if (cache_op == -1)
		cache_op = PERF_COUNT_HW_CACHE_OP_READ;
380 381 382 383 384 385 386

	/*
	 * Fall back to accesses:
	 */
	if (cache_result == -1)
		cache_result = PERF_COUNT_HW_CACHE_RESULT_ACCESS;

387 388 389
	memset(&attr, 0, sizeof(attr));
	attr.config = cache_type | (cache_op << 8) | (cache_result << 16);
	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 395 396 397 398 399 400 401 402 403 404 405
			     char *sys, char *name)
{
	char help[BUFSIZ];

	/*
	 * We get error directly from syscall errno ( > 0),
	 * or from encoded pointer's error ( < 0).
	 */
	err = abs(err);

	switch (err) {
	case EACCES:
406
		e->str = strdup("can't access trace events");
407 408
		break;
	case ENOENT:
409
		e->str = strdup("unknown tracepoint");
410 411
		break;
	default:
412
		e->str = strdup("failed to add tracepoint");
413 414 415 416
		break;
	}

	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 434 435 436 437 438 439 440
	if (head_config) {
		LIST_HEAD(config_terms);

		if (get_config_terms(head_config, &config_terms))
			return -ENOMEM;
		list_splice(&config_terms, &evsel->config_terms);
	}

441 442
	list_add_tail(&evsel->node, list);
	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 451 452
{
	char evt_path[MAXPATHLEN];
	struct dirent *evt_ent;
	DIR *evt_dir;
453
	int ret = 0, found = 0;
454

455
	snprintf(evt_path, MAXPATHLEN, "%s/%s", tracing_events_path, sys_name);
456 457
	evt_dir = opendir(evt_path);
	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 464 465 466 467 468
		if (!strcmp(evt_ent->d_name, ".")
		    || !strcmp(evt_ent->d_name, "..")
		    || !strcmp(evt_ent->d_name, "enable")
		    || !strcmp(evt_ent->d_name, "filter"))
			continue;

469
		if (!strglobmatch(evt_ent->d_name, evt_name))
470 471
			continue;

472 473
		found++;

474
		ret = add_tracepoint(list, idx, sys_name, evt_ent->d_name,
475
				     err, head_config);
476 477
	}

478 479 480 481 482
	if (!found) {
		tracepoint_error(err, ENOENT, sys_name, evt_name);
		ret = -1;
	}

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 505 506 507 508 509
{
	struct dirent *events_ent;
	DIR *events_dir;
	int ret = 0;

	events_dir = opendir(tracing_events_path);
	if (!events_dir) {
510
		tracepoint_error(err, errno, sys_name, evt_name);
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
		return -1;
	}

	while (!ret && (events_ent = readdir(events_dir))) {
		if (!strcmp(events_ent->d_name, ".")
		    || !strcmp(events_ent->d_name, "..")
		    || !strcmp(events_ent->d_name, "enable")
		    || !strcmp(events_ent->d_name, "header_event")
		    || !strcmp(events_ent->d_name, "header_page"))
			continue;

		if (!strglobmatch(events_ent->d_name, sys_name))
			continue;

		ret = add_tracepoint_event(list, idx, events_ent->d_name,
526
					   evt_name, err, head_config);
527 528 529 530 531 532
	}

	closedir(events_dir);
	return ret;
}

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
struct __add_bpf_event_param {
	struct parse_events_evlist *data;
	struct list_head *list;
};

static int add_bpf_event(struct probe_trace_event *tev, int fd,
			 void *_param)
{
	LIST_HEAD(new_evsels);
	struct __add_bpf_event_param *param = _param;
	struct parse_events_evlist *evlist = param->data;
	struct list_head *list = param->list;
	int err;

	pr_debug("add bpf event %s:%s and attach bpf program %d\n",
		 tev->group, tev->event, fd);

	err = parse_events_add_tracepoint(&new_evsels, &evlist->idx, tev->group,
					  tev->event, evlist->error, NULL);
	if (err) {
		struct perf_evsel *evsel, *tmp;

		pr_debug("Failed to add BPF event %s:%s\n",
			 tev->group, tev->event);
		list_for_each_entry_safe(evsel, tmp, &new_evsels, node) {
			list_del(&evsel->node);
			perf_evsel__delete(evsel);
		}
		return err;
	}
	pr_debug("adding %s:%s\n", tev->group, tev->event);

	list_splice(&new_evsels, list);
	return 0;
}

569 570 571 572 573 574
int parse_events_load_bpf_obj(struct parse_events_evlist *data,
			      struct list_head *list,
			      struct bpf_object *obj)
{
	int err;
	char errbuf[BUFSIZ];
575
	struct __add_bpf_event_param param = {data, list};
576
	static bool registered_unprobe_atexit = false;
577 578 579 580 581 582 583 584

	if (IS_ERR(obj) || !obj) {
		snprintf(errbuf, sizeof(errbuf),
			 "Internal error: load bpf obj with NULL");
		err = -EINVAL;
		goto errout;
	}

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
	/*
	 * Register atexit handler before calling bpf__probe() so
	 * bpf__probe() don't need to unprobe probe points its already
	 * created when failure.
	 */
	if (!registered_unprobe_atexit) {
		atexit(bpf__clear);
		registered_unprobe_atexit = true;
	}

	err = bpf__probe(obj);
	if (err) {
		bpf__strerror_probe(obj, err, errbuf, sizeof(errbuf));
		goto errout;
	}

601 602 603 604 605 606
	err = bpf__load(obj);
	if (err) {
		bpf__strerror_load(obj, err, errbuf, sizeof(errbuf));
		goto errout;
	}

607 608 609 610 611 612 613 614
	err = bpf__foreach_tev(obj, add_bpf_event, &param);
	if (err) {
		snprintf(errbuf, sizeof(errbuf),
			 "Attach events in BPF object failed");
		goto errout;
	}

	return 0;
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
errout:
	data->error->help = strdup("(add -v to see detail)");
	data->error->str = strdup(errbuf);
	return err;
}

int parse_events_load_bpf(struct parse_events_evlist *data,
			  struct list_head *list,
			  char *bpf_file_name)
{
	struct bpf_object *obj;

	obj = bpf__prepare_load(bpf_file_name);
	if (IS_ERR(obj) || !obj) {
		char errbuf[BUFSIZ];
		int err;

		err = obj ? PTR_ERR(obj) : -EINVAL;

		if (err == -ENOTSUP)
			snprintf(errbuf, sizeof(errbuf),
				 "BPF support is not compiled");
		else
			snprintf(errbuf, sizeof(errbuf),
				 "BPF object file '%s' is invalid",
				 bpf_file_name);

		data->error->help = strdup("(add -v to see detail)");
		data->error->str = strdup(errbuf);
		return err;
	}

	return parse_events_load_bpf_obj(data, list, obj);
}

650 651
static int
parse_breakpoint_type(const char *type, struct perf_event_attr *attr)
652 653 654 655
{
	int i;

	for (i = 0; i < 3; i++) {
656
		if (!type || !type[i])
657 658
			break;

659 660 661 662 663 664 665 666
#define CHECK_SET_TYPE(bit)		\
do {					\
	if (attr->bp_type & bit)	\
		return -EINVAL;		\
	else				\
		attr->bp_type |= bit;	\
} while (0)

667 668
		switch (type[i]) {
		case 'r':
669
			CHECK_SET_TYPE(HW_BREAKPOINT_R);
670 671
			break;
		case 'w':
672
			CHECK_SET_TYPE(HW_BREAKPOINT_W);
673 674
			break;
		case 'x':
675
			CHECK_SET_TYPE(HW_BREAKPOINT_X);
676 677
			break;
		default:
678
			return -EINVAL;
679 680
		}
	}
681

682 683
#undef CHECK_SET_TYPE

684 685 686
	if (!attr->bp_type) /* Default */
		attr->bp_type = HW_BREAKPOINT_R | HW_BREAKPOINT_W;

687
	return 0;
688 689
}

690
int parse_events_add_breakpoint(struct list_head *list, int *idx,
691
				void *ptr, char *type, u64 len)
692
{
693
	struct perf_event_attr attr;
694

695
	memset(&attr, 0, sizeof(attr));
696
	attr.bp_addr = (unsigned long) ptr;
697

698 699
	if (parse_breakpoint_type(type, &attr))
		return -EINVAL;
700

701 702 703 704 705 706 707 708 709
	/* Provide some defaults if len is not specified */
	if (!len) {
		if (attr.bp_type == HW_BREAKPOINT_X)
			len = sizeof(long);
		else
			len = HW_BREAKPOINT_LEN_4;
	}

	attr.bp_len = len;
710

711
	attr.type = PERF_TYPE_BREAKPOINT;
712
	attr.sample_period = 1;
713

714
	return add_event(list, idx, &attr, NULL, NULL);
715 716
}

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
static int check_type_val(struct parse_events_term *term,
			  struct parse_events_error *err,
			  int type)
{
	if (type == term->type_val)
		return 0;

	if (err) {
		err->idx = term->err_val;
		if (type == PARSE_EVENTS__TERM_TYPE_NUM)
			err->str = strdup("expected numeric value");
		else
			err->str = strdup("expected string value");
	}
	return -EINVAL;
}

734 735 736 737 738 739 740
typedef int config_term_func_t(struct perf_event_attr *attr,
			       struct parse_events_term *term,
			       struct parse_events_error *err);

static int config_term_common(struct perf_event_attr *attr,
			      struct parse_events_term *term,
			      struct parse_events_error *err)
741
{
742 743 744 745
#define CHECK_TYPE_VAL(type)						   \
do {									   \
	if (check_type_val(term, err, PARSE_EVENTS__TERM_TYPE_ ## type)) \
		return -EINVAL;						   \
746 747 748
} while (0)

	switch (term->type_term) {
749
	case PARSE_EVENTS__TERM_TYPE_CONFIG:
750
		CHECK_TYPE_VAL(NUM);
751 752 753
		attr->config = term->val.num;
		break;
	case PARSE_EVENTS__TERM_TYPE_CONFIG1:
754
		CHECK_TYPE_VAL(NUM);
755 756 757
		attr->config1 = term->val.num;
		break;
	case PARSE_EVENTS__TERM_TYPE_CONFIG2:
758
		CHECK_TYPE_VAL(NUM);
759 760 761
		attr->config2 = term->val.num;
		break;
	case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
762
		CHECK_TYPE_VAL(NUM);
763
		break;
764 765 766
	case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
		CHECK_TYPE_VAL(NUM);
		break;
767 768 769 770 771 772
	case PARSE_EVENTS__TERM_TYPE_BRANCH_SAMPLE_TYPE:
		/*
		 * TODO uncomment when the field is available
		 * attr->branch_sample_type = term->val.num;
		 */
		break;
K
Kan Liang 已提交
773 774 775 776 777 778 779 780
	case PARSE_EVENTS__TERM_TYPE_TIME:
		CHECK_TYPE_VAL(NUM);
		if (term->val.num > 1) {
			err->str = strdup("expected 0 or 1");
			err->idx = term->err_val;
			return -EINVAL;
		}
		break;
781 782 783 784 785 786
	case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
		CHECK_TYPE_VAL(STR);
		break;
	case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
		CHECK_TYPE_VAL(NUM);
		break;
787 788 789 790 791 792
	case PARSE_EVENTS__TERM_TYPE_INHERIT:
		CHECK_TYPE_VAL(NUM);
		break;
	case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
		CHECK_TYPE_VAL(NUM);
		break;
793 794 795
	case PARSE_EVENTS__TERM_TYPE_NAME:
		CHECK_TYPE_VAL(STR);
		break;
796
	default:
797 798 799
		err->str = strdup("unknown term");
		err->idx = term->err_term;
		err->help = parse_events_formats_error_string(NULL);
800 801
		return -EINVAL;
	}
802

803
	return 0;
804
#undef CHECK_TYPE_VAL
805 806
}

807 808 809 810 811 812 813 814 815 816 817 818 819 820
static int config_term_pmu(struct perf_event_attr *attr,
			   struct parse_events_term *term,
			   struct parse_events_error *err)
{
	if (term->type_term == PARSE_EVENTS__TERM_TYPE_USER)
		/*
		 * Always succeed for sysfs terms, as we dont know
		 * at this point what type they need to have.
		 */
		return 0;
	else
		return config_term_common(attr, term, err);
}

821 822 823 824 825 826 827
static int config_term_tracepoint(struct perf_event_attr *attr,
				  struct parse_events_term *term,
				  struct parse_events_error *err)
{
	switch (term->type_term) {
	case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
	case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
828 829
	case PARSE_EVENTS__TERM_TYPE_INHERIT:
	case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
830 831 832 833 834 835 836 837 838 839 840 841 842
		return config_term_common(attr, term, err);
	default:
		if (err) {
			err->idx = term->err_term;
			err->str = strdup("unknown term");
			err->help = strdup("valid terms: call-graph,stack-size\n");
		}
		return -EINVAL;
	}

	return 0;
}

843
static int config_attr(struct perf_event_attr *attr,
844
		       struct list_head *head,
845 846
		       struct parse_events_error *err,
		       config_term_func_t config_term)
847
{
848
	struct parse_events_term *term;
849 850

	list_for_each_entry(term, head, list)
851
		if (config_term(attr, term, err))
852 853 854 855 856
			return -EINVAL;

	return 0;
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
static int get_config_terms(struct list_head *head_config,
			    struct list_head *head_terms __maybe_unused)
{
#define ADD_CONFIG_TERM(__type, __name, __val)			\
do {								\
	struct perf_evsel_config_term *__t;			\
								\
	__t = zalloc(sizeof(*__t));				\
	if (!__t)						\
		return -ENOMEM;					\
								\
	INIT_LIST_HEAD(&__t->list);				\
	__t->type       = PERF_EVSEL__CONFIG_TERM_ ## __type;	\
	__t->val.__name = __val;				\
	list_add_tail(&__t->list, head_terms);			\
} while (0)

	struct parse_events_term *term;

	list_for_each_entry(term, head_config, list) {
		switch (term->type_term) {
878 879
		case PARSE_EVENTS__TERM_TYPE_SAMPLE_PERIOD:
			ADD_CONFIG_TERM(PERIOD, period, term->val.num);
K
Kan Liang 已提交
880
			break;
881 882 883
		case PARSE_EVENTS__TERM_TYPE_SAMPLE_FREQ:
			ADD_CONFIG_TERM(FREQ, freq, term->val.num);
			break;
K
Kan Liang 已提交
884 885 886
		case PARSE_EVENTS__TERM_TYPE_TIME:
			ADD_CONFIG_TERM(TIME, time, term->val.num);
			break;
887 888 889 890 891 892
		case PARSE_EVENTS__TERM_TYPE_CALLGRAPH:
			ADD_CONFIG_TERM(CALLGRAPH, callgraph, term->val.str);
			break;
		case PARSE_EVENTS__TERM_TYPE_STACKSIZE:
			ADD_CONFIG_TERM(STACK_USER, stack_user, term->val.num);
			break;
893 894 895 896 897 898
		case PARSE_EVENTS__TERM_TYPE_INHERIT:
			ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 1 : 0);
			break;
		case PARSE_EVENTS__TERM_TYPE_NOINHERIT:
			ADD_CONFIG_TERM(INHERIT, inherit, term->val.num ? 0 : 1);
			break;
899 900 901 902 903 904 905 906
		default:
			break;
		}
	}
#undef ADD_EVSEL_CONFIG
	return 0;
}

907 908
int parse_events_add_tracepoint(struct list_head *list, int *idx,
				char *sys, char *event,
909
				struct parse_events_error *err,
910 911 912 913 914
				struct list_head *head_config)
{
	if (head_config) {
		struct perf_event_attr attr;

915
		if (config_attr(&attr, head_config, err,
916 917 918 919 920 921
				config_term_tracepoint))
			return -EINVAL;
	}

	if (strpbrk(sys, "*?"))
		return add_tracepoint_multi_sys(list, idx, sys, event,
922
						err, head_config);
923 924
	else
		return add_tracepoint_event(list, idx, sys, event,
925
					    err, head_config);
926 927
}

928 929
int parse_events_add_numeric(struct parse_events_evlist *data,
			     struct list_head *list,
930
			     u32 type, u64 config,
931
			     struct list_head *head_config)
932
{
933
	struct perf_event_attr attr;
934
	LIST_HEAD(config_terms);
935

936 937 938
	memset(&attr, 0, sizeof(attr));
	attr.type = type;
	attr.config = config;
939

940
	if (head_config) {
941 942
		if (config_attr(&attr, head_config, data->error,
				config_term_common))
943 944 945 946 947
			return -EINVAL;

		if (get_config_terms(head_config, &config_terms))
			return -ENOMEM;
	}
948

949
	return add_event(list, &data->idx, &attr, NULL, &config_terms);
950
}
951

952
static int parse_events__is_name_term(struct parse_events_term *term)
953 954 955 956
{
	return term->type_term == PARSE_EVENTS__TERM_TYPE_NAME;
}

957
static char *pmu_event_name(struct list_head *head_terms)
958
{
959
	struct parse_events_term *term;
960 961 962 963 964

	list_for_each_entry(term, head_terms, list)
		if (parse_events__is_name_term(term))
			return term->val.str;

965
	return NULL;
966 967
}

968 969 970
int parse_events_add_pmu(struct parse_events_evlist *data,
			 struct list_head *list, char *name,
			 struct list_head *head_config)
971 972
{
	struct perf_event_attr attr;
973
	struct perf_pmu_info info;
974
	struct perf_pmu *pmu;
975
	struct perf_evsel *evsel;
976
	LIST_HEAD(config_terms);
977 978 979 980 981

	pmu = perf_pmu__find(name);
	if (!pmu)
		return -EINVAL;

982 983 984 985 986 987
	if (pmu->default_config) {
		memcpy(&attr, pmu->default_config,
		       sizeof(struct perf_event_attr));
	} else {
		memset(&attr, 0, sizeof(attr));
	}
988

989 990
	if (!head_config) {
		attr.type = pmu->type;
991
		evsel = __add_event(list, &data->idx, &attr, NULL, pmu->cpus, NULL);
992 993 994
		return evsel ? 0 : -ENOMEM;
	}

995
	if (perf_pmu__check_alias(pmu, head_config, &info))
996 997
		return -EINVAL;

998 999 1000 1001
	/*
	 * Configure hardcoded terms first, no need to check
	 * return value when called with fail == 0 ;)
	 */
1002
	if (config_attr(&attr, head_config, data->error, config_term_pmu))
1003
		return -EINVAL;
1004

1005 1006 1007
	if (get_config_terms(head_config, &config_terms))
		return -ENOMEM;

1008
	if (perf_pmu__config(pmu, &attr, head_config, data->error))
1009 1010
		return -EINVAL;

1011
	evsel = __add_event(list, &data->idx, &attr,
1012 1013
			    pmu_event_name(head_config), pmu->cpus,
			    &config_terms);
1014
	if (evsel) {
1015 1016
		evsel->unit = info.unit;
		evsel->scale = info.scale;
1017
		evsel->per_pkg = info.per_pkg;
1018
		evsel->snapshot = info.snapshot;
1019 1020 1021
	}

	return evsel ? 0 : -ENOMEM;
1022 1023
}

1024 1025
int parse_events__modifier_group(struct list_head *list,
				 char *event_mod)
1026
{
1027 1028 1029
	return parse_events__modifier_event(list, event_mod, true);
}

1030
void parse_events__set_leader(char *name, struct list_head *list)
1031 1032 1033
{
	struct perf_evsel *leader;

1034 1035 1036 1037 1038
	if (list_empty(list)) {
		WARN_ONCE(true, "WARNING: failed to set leader: empty list");
		return;
	}

1039 1040
	__perf_evlist__set_leader(list);
	leader = list_entry(list->next, struct perf_evsel, node);
1041
	leader->group_name = name ? strdup(name) : NULL;
1042 1043
}

1044
/* list_event is assumed to point to malloc'ed memory */
1045 1046 1047 1048 1049
void parse_events_update_lists(struct list_head *list_event,
			       struct list_head *list_all)
{
	/*
	 * Called for single event definition. Update the
1050
	 * 'all event' list, and reinit the 'single event'
1051 1052 1053
	 * list, for next event definition.
	 */
	list_splice_tail(list_event, list_all);
1054
	free(list_event);
1055 1056
}

1057 1058 1059 1060 1061 1062
struct event_modifier {
	int eu;
	int ek;
	int eh;
	int eH;
	int eG;
1063
	int eI;
1064
	int precise;
1065
	int precise_max;
1066
	int exclude_GH;
1067
	int sample_read;
1068
	int pinned;
1069 1070 1071 1072
};

static int get_event_modifier(struct event_modifier *mod, char *str,
			       struct perf_evsel *evsel)
1073
{
1074 1075 1076 1077 1078
	int eu = evsel ? evsel->attr.exclude_user : 0;
	int ek = evsel ? evsel->attr.exclude_kernel : 0;
	int eh = evsel ? evsel->attr.exclude_hv : 0;
	int eH = evsel ? evsel->attr.exclude_host : 0;
	int eG = evsel ? evsel->attr.exclude_guest : 0;
1079
	int eI = evsel ? evsel->attr.exclude_idle : 0;
1080
	int precise = evsel ? evsel->attr.precise_ip : 0;
1081
	int precise_max = 0;
1082
	int sample_read = 0;
1083
	int pinned = evsel ? evsel->attr.pinned : 0;
1084

1085 1086 1087 1088
	int exclude = eu | ek | eh;
	int exclude_GH = evsel ? evsel->exclude_GH : 0;

	memset(mod, 0, sizeof(*mod));
1089

1090
	while (*str) {
P
Peter Zijlstra 已提交
1091 1092 1093
		if (*str == 'u') {
			if (!exclude)
				exclude = eu = ek = eh = 1;
1094
			eu = 0;
P
Peter Zijlstra 已提交
1095 1096 1097
		} else if (*str == 'k') {
			if (!exclude)
				exclude = eu = ek = eh = 1;
1098
			ek = 0;
P
Peter Zijlstra 已提交
1099 1100 1101
		} else if (*str == 'h') {
			if (!exclude)
				exclude = eu = ek = eh = 1;
1102
			eh = 0;
1103 1104 1105 1106 1107 1108 1109 1110
		} else if (*str == 'G') {
			if (!exclude_GH)
				exclude_GH = eG = eH = 1;
			eG = 0;
		} else if (*str == 'H') {
			if (!exclude_GH)
				exclude_GH = eG = eH = 1;
			eH = 0;
1111 1112
		} else if (*str == 'I') {
			eI = 1;
P
Peter Zijlstra 已提交
1113 1114
		} else if (*str == 'p') {
			precise++;
1115 1116 1117
			/* use of precise requires exclude_guest */
			if (!exclude_GH)
				eG = 1;
1118 1119
		} else if (*str == 'P') {
			precise_max = 1;
1120 1121
		} else if (*str == 'S') {
			sample_read = 1;
1122 1123
		} else if (*str == 'D') {
			pinned = 1;
P
Peter Zijlstra 已提交
1124
		} else
1125
			break;
P
Peter Zijlstra 已提交
1126

1127
		++str;
1128
	}
1129

1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
	/*
	 * precise ip:
	 *
	 *  0 - SAMPLE_IP can have arbitrary skid
	 *  1 - SAMPLE_IP must have constant skid
	 *  2 - SAMPLE_IP requested to have 0 skid
	 *  3 - SAMPLE_IP must have 0 skid
	 *
	 *  See also PERF_RECORD_MISC_EXACT_IP
	 */
	if (precise > 3)
		return -EINVAL;
1142

1143 1144 1145 1146 1147
	mod->eu = eu;
	mod->ek = ek;
	mod->eh = eh;
	mod->eH = eH;
	mod->eG = eG;
1148
	mod->eI = eI;
1149
	mod->precise = precise;
1150
	mod->precise_max = precise_max;
1151
	mod->exclude_GH = exclude_GH;
1152
	mod->sample_read = sample_read;
1153 1154
	mod->pinned = pinned;

1155 1156 1157
	return 0;
}

1158 1159 1160 1161 1162 1163 1164 1165 1166
/*
 * Basic modifier sanity check to validate it contains only one
 * instance of any modifier (apart from 'p') present.
 */
static int check_modifier(char *str)
{
	char *p = str;

	/* The sizeof includes 0 byte as well. */
1167
	if (strlen(str) > (sizeof("ukhGHpppPSDI") - 1))
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
		return -1;

	while (*p) {
		if (*p != 'p' && strchr(p + 1, *p))
			return -1;
		p++;
	}

	return 0;
}

1179 1180 1181 1182 1183 1184 1185 1186
int parse_events__modifier_event(struct list_head *list, char *str, bool add)
{
	struct perf_evsel *evsel;
	struct event_modifier mod;

	if (str == NULL)
		return 0;

1187 1188 1189
	if (check_modifier(str))
		return -EINVAL;

1190 1191 1192
	if (!add && get_event_modifier(&mod, str, NULL))
		return -EINVAL;

1193
	__evlist__for_each(list, evsel) {
1194 1195 1196 1197 1198 1199 1200 1201 1202
		if (add && get_event_modifier(&mod, str, evsel))
			return -EINVAL;

		evsel->attr.exclude_user   = mod.eu;
		evsel->attr.exclude_kernel = mod.ek;
		evsel->attr.exclude_hv     = mod.eh;
		evsel->attr.precise_ip     = mod.precise;
		evsel->attr.exclude_host   = mod.eH;
		evsel->attr.exclude_guest  = mod.eG;
1203
		evsel->attr.exclude_idle   = mod.eI;
1204
		evsel->exclude_GH          = mod.exclude_GH;
1205
		evsel->sample_read         = mod.sample_read;
1206
		evsel->precise_max         = mod.precise_max;
1207 1208 1209

		if (perf_evsel__is_group_leader(evsel))
			evsel->attr.pinned = mod.pinned;
1210
	}
1211

1212 1213
	return 0;
}
1214

1215 1216 1217 1218
int parse_events_name(struct list_head *list, char *name)
{
	struct perf_evsel *evsel;

1219
	__evlist__for_each(list, evsel) {
1220 1221 1222 1223 1224 1225 1226
		if (!evsel->name)
			evsel->name = strdup(name);
	}

	return 0;
}

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
static int
comp_pmu(const void *p1, const void *p2)
{
	struct perf_pmu_event_symbol *pmu1 = (struct perf_pmu_event_symbol *) p1;
	struct perf_pmu_event_symbol *pmu2 = (struct perf_pmu_event_symbol *) p2;

	return strcmp(pmu1->symbol, pmu2->symbol);
}

static void perf_pmu__parse_cleanup(void)
{
	if (perf_pmu_events_list_num > 0) {
		struct perf_pmu_event_symbol *p;
		int i;

		for (i = 0; i < perf_pmu_events_list_num; i++) {
			p = perf_pmu_events_list + i;
			free(p->symbol);
		}
		free(perf_pmu_events_list);
		perf_pmu_events_list = NULL;
		perf_pmu_events_list_num = 0;
	}
}

#define SET_SYMBOL(str, stype)		\
do {					\
	p->symbol = str;		\
	if (!p->symbol)			\
		goto err;		\
	p->type = stype;		\
} while (0)

/*
 * Read the pmu events list from sysfs
 * Save it into perf_pmu_events_list
 */
static void perf_pmu__parse_init(void)
{

	struct perf_pmu *pmu = NULL;
	struct perf_pmu_alias *alias;
	int len = 0;

	pmu = perf_pmu__find("cpu");
	if ((pmu == NULL) || list_empty(&pmu->aliases)) {
		perf_pmu_events_list_num = -1;
		return;
	}
	list_for_each_entry(alias, &pmu->aliases, list) {
		if (strchr(alias->name, '-'))
			len++;
		len++;
	}
	perf_pmu_events_list = malloc(sizeof(struct perf_pmu_event_symbol) * len);
	if (!perf_pmu_events_list)
		return;
	perf_pmu_events_list_num = len;

	len = 0;
	list_for_each_entry(alias, &pmu->aliases, list) {
		struct perf_pmu_event_symbol *p = perf_pmu_events_list + len;
		char *tmp = strchr(alias->name, '-');

		if (tmp != NULL) {
			SET_SYMBOL(strndup(alias->name, tmp - alias->name),
					PMU_EVENT_SYMBOL_PREFIX);
			p++;
			SET_SYMBOL(strdup(++tmp), PMU_EVENT_SYMBOL_SUFFIX);
			len += 2;
		} else {
			SET_SYMBOL(strdup(alias->name), PMU_EVENT_SYMBOL);
			len++;
		}
	}
	qsort(perf_pmu_events_list, len,
		sizeof(struct perf_pmu_event_symbol), comp_pmu);

	return;
err:
	perf_pmu__parse_cleanup();
}

enum perf_pmu_event_symbol_type
perf_pmu__parse_check(const char *name)
{
	struct perf_pmu_event_symbol p, *r;

	/* scan kernel pmu events from sysfs if needed */
	if (perf_pmu_events_list_num == 0)
		perf_pmu__parse_init();
	/*
	 * name "cpu" could be prefix of cpu-cycles or cpu// events.
	 * cpu-cycles has been handled by hardcode.
	 * So it must be cpu// events, not kernel pmu event.
	 */
	if ((perf_pmu_events_list_num <= 0) || !strcmp(name, "cpu"))
		return PMU_EVENT_SYMBOL_ERR;

	p.symbol = strdup(name);
	r = bsearch(&p, perf_pmu_events_list,
			(size_t) perf_pmu_events_list_num,
			sizeof(struct perf_pmu_event_symbol), comp_pmu);
	free(p.symbol);
	return r ? r->type : PMU_EVENT_SYMBOL_ERR;
}

1334
static int parse_events__scanner(const char *str, void *data, int start_token)
1335
{
1336
	YY_BUFFER_STATE buffer;
1337
	void *scanner;
1338
	int ret;
1339

1340
	ret = parse_events_lex_init_extra(start_token, &scanner);
1341 1342 1343 1344
	if (ret)
		return ret;

	buffer = parse_events__scan_string(str, scanner);
1345

1346 1347 1348
#ifdef PARSER_DEBUG
	parse_events_debug = 1;
#endif
1349 1350 1351 1352 1353 1354 1355
	ret = parse_events_parse(data, scanner);

	parse_events__flush_buffer(buffer, scanner);
	parse_events__delete_buffer(buffer, scanner);
	parse_events_lex_destroy(scanner);
	return ret;
}
1356

1357 1358 1359 1360 1361
/*
 * parse event config string, return a list of event terms.
 */
int parse_events_terms(struct list_head *terms, const char *str)
{
1362
	struct parse_events_terms data = {
1363 1364 1365 1366 1367 1368 1369
		.terms = NULL,
	};
	int ret;

	ret = parse_events__scanner(str, &data, PE_START_TERMS);
	if (!ret) {
		list_splice(data.terms, terms);
1370
		zfree(&data.terms);
1371 1372 1373
		return 0;
	}

1374 1375
	if (data.terms)
		parse_events__free_terms(data.terms);
1376 1377 1378
	return ret;
}

1379 1380
int parse_events(struct perf_evlist *evlist, const char *str,
		 struct parse_events_error *err)
1381
{
1382
	struct parse_events_evlist data = {
1383 1384 1385
		.list  = LIST_HEAD_INIT(data.list),
		.idx   = evlist->nr_entries,
		.error = err,
1386 1387
	};
	int ret;
1388

1389
	ret = parse_events__scanner(str, &data, PE_START_EVENTS);
1390
	perf_pmu__parse_cleanup();
1391
	if (!ret) {
1392 1393
		struct perf_evsel *last;

1394 1395 1396 1397 1398
		if (list_empty(&data.list)) {
			WARN_ONCE(true, "WARNING: event parser found nothing");
			return -1;
		}

1399
		perf_evlist__splice_list_tail(evlist, &data.list);
1400
		evlist->nr_groups += data.nr_groups;
1401 1402 1403
		last = perf_evlist__last(evlist);
		last->cmdline_group_boundary = true;

1404 1405
		return 0;
	}
1406

1407 1408 1409 1410 1411
	/*
	 * There are 2 users - builtin-record and builtin-test objects.
	 * Both call perf_evlist__delete in case of error, so we dont
	 * need to bother.
	 */
1412
	return ret;
1413 1414
}

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
#define MAX_WIDTH 1000
static int get_term_width(void)
{
	struct winsize ws;

	get_term_dimensions(&ws);
	return ws.ws_col > MAX_WIDTH ? MAX_WIDTH : ws.ws_col;
}

static void parse_events_print_error(struct parse_events_error *err,
				     const char *event)
{
	const char *str = "invalid or unsupported event: ";
	char _buf[MAX_WIDTH];
	char *buf = (char *) event;
	int idx = 0;

	if (err->str) {
		/* -2 for extra '' in the final fprintf */
		int width       = get_term_width() - 2;
		int len_event   = strlen(event);
		int len_str, max_len, cut = 0;

		/*
		 * Maximum error index indent, we will cut
		 * the event string if it's bigger.
		 */
1442
		int max_err_idx = 13;
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485

		/*
		 * Let's be specific with the message when
		 * we have the precise error.
		 */
		str     = "event syntax error: ";
		len_str = strlen(str);
		max_len = width - len_str;

		buf = _buf;

		/* We're cutting from the beggining. */
		if (err->idx > max_err_idx)
			cut = err->idx - max_err_idx;

		strncpy(buf, event + cut, max_len);

		/* Mark cut parts with '..' on both sides. */
		if (cut)
			buf[0] = buf[1] = '.';

		if ((len_event - cut) > max_len) {
			buf[max_len - 1] = buf[max_len - 2] = '.';
			buf[max_len] = 0;
		}

		idx = len_str + err->idx - cut;
	}

	fprintf(stderr, "%s'%s'\n", str, buf);
	if (idx) {
		fprintf(stderr, "%*s\\___ %s\n", idx + 1, "", err->str);
		if (err->help)
			fprintf(stderr, "\n%s\n", err->help);
		free(err->str);
		free(err->help);
	}

	fprintf(stderr, "Run 'perf list' for a list of valid events\n");
}

#undef MAX_WIDTH

1486
int parse_events_option(const struct option *opt, const char *str,
1487
			int unset __maybe_unused)
1488 1489
{
	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;
1490 1491 1492 1493 1494
	struct parse_events_error err = { .idx = 0, };
	int ret = parse_events(evlist, str, &err);

	if (ret)
		parse_events_print_error(&err, str);
1495 1496

	return ret;
1497 1498
}

1499 1500 1501 1502 1503
static int
foreach_evsel_in_last_glob(struct perf_evlist *evlist,
			   int (*func)(struct perf_evsel *evsel,
				       const void *arg),
			   const void *arg)
L
Li Zefan 已提交
1504
{
1505
	struct perf_evsel *last = NULL;
1506
	int err;
L
Li Zefan 已提交
1507

1508 1509 1510 1511 1512 1513
	/*
	 * Don't return when list_empty, give func a chance to report
	 * error when it found last == NULL.
	 *
	 * So no need to WARN here, let *func do this.
	 */
1514
	if (evlist->nr_entries > 0)
1515
		last = perf_evlist__last(evlist);
1516

1517
	do {
1518 1519
		err = (*func)(last, arg);
		if (err)
1520
			return -1;
1521 1522
		if (!last)
			return 0;
1523 1524 1525 1526 1527

		if (last->node.prev == &evlist->entries)
			return 0;
		last = list_entry(last->node.prev, struct perf_evsel, node);
	} while (!last->cmdline_group_boundary);
L
Li Zefan 已提交
1528 1529 1530 1531

	return 0;
}

1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
static int set_filter(struct perf_evsel *evsel, const void *arg)
{
	const char *str = arg;

	if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
		fprintf(stderr,
			"--filter option should follow a -e tracepoint option\n");
		return -1;
	}

	if (perf_evsel__append_filter(evsel, "&&", str) < 0) {
		fprintf(stderr,
			"not enough memory to hold filter string\n");
		return -1;
	}

	return 0;
}

int parse_filter(const struct option *opt, const char *str,
		 int unset __maybe_unused)
{
	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;

	return foreach_evsel_in_last_glob(evlist, set_filter,
					  (const void *)str);
}

static int add_exclude_perf_filter(struct perf_evsel *evsel,
				   const void *arg __maybe_unused)
{
	char new_filter[64];

	if (evsel == NULL || evsel->attr.type != PERF_TYPE_TRACEPOINT) {
		fprintf(stderr,
			"--exclude-perf option should follow a -e tracepoint option\n");
		return -1;
	}

	snprintf(new_filter, sizeof(new_filter), "common_pid != %d", getpid());

	if (perf_evsel__append_filter(evsel, "&&", new_filter) < 0) {
		fprintf(stderr,
			"not enough memory to hold filter string\n");
		return -1;
	}

	return 0;
}

int exclude_perf(const struct option *opt,
		 const char *arg __maybe_unused,
		 int unset __maybe_unused)
{
	struct perf_evlist *evlist = *(struct perf_evlist **)opt->value;

	return foreach_evsel_in_last_glob(evlist, add_exclude_perf_filter,
					  NULL);
}

1592 1593 1594 1595 1596
static const char * const event_type_descriptors[] = {
	"Hardware event",
	"Software event",
	"Tracepoint event",
	"Hardware cache event",
1597 1598
	"Raw hardware event descriptor",
	"Hardware breakpoint",
1599 1600
};

1601 1602 1603 1604 1605 1606 1607 1608
static int cmp_string(const void *a, const void *b)
{
	const char * const *as = a;
	const char * const *bs = b;

	return strcmp(*as, *bs);
}

1609 1610 1611 1612
/*
 * Print the events from <debugfs_mount_point>/tracing/events
 */

1613 1614
void print_tracepoint_events(const char *subsys_glob, const char *event_glob,
			     bool name_only)
1615 1616 1617 1618
{
	DIR *sys_dir, *evt_dir;
	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
	char evt_path[MAXPATHLEN];
E
Eric Dumazet 已提交
1619
	char dir_path[MAXPATHLEN];
1620 1621 1622
	char **evt_list = NULL;
	unsigned int evt_i = 0, evt_num = 0;
	bool evt_num_known = false;
1623

1624
restart:
1625
	sys_dir = opendir(tracing_events_path);
1626
	if (!sys_dir)
E
Eric Dumazet 已提交
1627
		return;
1628

1629 1630 1631 1632 1633 1634
	if (evt_num_known) {
		evt_list = zalloc(sizeof(char *) * evt_num);
		if (!evt_list)
			goto out_close_sys_dir;
	}

1635
	for_each_subsystem(sys_dir, sys_dirent, sys_next) {
1636
		if (subsys_glob != NULL &&
1637 1638
		    !strglobmatch(sys_dirent.d_name, subsys_glob))
			continue;
E
Eric Dumazet 已提交
1639

1640
		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
E
Eric Dumazet 已提交
1641 1642 1643
			 sys_dirent.d_name);
		evt_dir = opendir(dir_path);
		if (!evt_dir)
1644
			continue;
E
Eric Dumazet 已提交
1645

1646
		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
1647
			if (event_glob != NULL &&
1648 1649 1650
			    !strglobmatch(evt_dirent.d_name, event_glob))
				continue;

1651 1652
			if (!evt_num_known) {
				evt_num++;
1653 1654 1655
				continue;
			}

1656 1657
			snprintf(evt_path, MAXPATHLEN, "%s:%s",
				 sys_dirent.d_name, evt_dirent.d_name);
1658 1659 1660 1661 1662

			evt_list[evt_i] = strdup(evt_path);
			if (evt_list[evt_i] == NULL)
				goto out_close_evt_dir;
			evt_i++;
1663 1664 1665 1666
		}
		closedir(evt_dir);
	}
	closedir(sys_dir);
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

	if (!evt_num_known) {
		evt_num_known = true;
		goto restart;
	}
	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
	evt_i = 0;
	while (evt_i < evt_num) {
		if (name_only) {
			printf("%s ", evt_list[evt_i++]);
			continue;
		}
		printf("  %-50s [%s]\n", evt_list[evt_i++],
				event_type_descriptors[PERF_TYPE_TRACEPOINT]);
	}
1682
	if (evt_num && pager_in_use())
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
		printf("\n");

out_free:
	evt_num = evt_i;
	for (evt_i = 0; evt_i < evt_num; evt_i++)
		zfree(&evt_list[evt_i]);
	zfree(&evt_list);
	return;

out_close_evt_dir:
	closedir(evt_dir);
out_close_sys_dir:
	closedir(sys_dir);

	printf("FATAL: not enough memory to print %s\n",
			event_type_descriptors[PERF_TYPE_TRACEPOINT]);
	if (evt_list)
		goto out_free;
1701 1702
}

1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
/*
 * Check whether event is in <debugfs_mount_point>/tracing/events
 */

int is_valid_tracepoint(const char *event_string)
{
	DIR *sys_dir, *evt_dir;
	struct dirent *sys_next, *evt_next, sys_dirent, evt_dirent;
	char evt_path[MAXPATHLEN];
	char dir_path[MAXPATHLEN];

1714
	sys_dir = opendir(tracing_events_path);
1715 1716 1717 1718 1719
	if (!sys_dir)
		return 0;

	for_each_subsystem(sys_dir, sys_dirent, sys_next) {

1720
		snprintf(dir_path, MAXPATHLEN, "%s/%s", tracing_events_path,
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
			 sys_dirent.d_name);
		evt_dir = opendir(dir_path);
		if (!evt_dir)
			continue;

		for_each_event(sys_dirent, evt_dir, evt_dirent, evt_next) {
			snprintf(evt_path, MAXPATHLEN, "%s:%s",
				 sys_dirent.d_name, evt_dirent.d_name);
			if (!strcmp(evt_path, event_string)) {
				closedir(evt_dir);
				closedir(sys_dir);
				return 1;
			}
		}
		closedir(evt_dir);
	}
	closedir(sys_dir);
	return 0;
}

1741 1742 1743
static bool is_event_supported(u8 type, unsigned config)
{
	bool ret = true;
1744
	int open_return;
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
	struct perf_evsel *evsel;
	struct perf_event_attr attr = {
		.type = type,
		.config = config,
		.disabled = 1,
	};
	struct {
		struct thread_map map;
		int threads[1];
	} tmap = {
		.map.nr	 = 1,
		.threads = { 0 },
	};

1759
	evsel = perf_evsel__new(&attr);
1760
	if (evsel) {
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
		open_return = perf_evsel__open(evsel, NULL, &tmap.map);
		ret = open_return >= 0;

		if (open_return == -EACCES) {
			/*
			 * This happens if the paranoid value
			 * /proc/sys/kernel/perf_event_paranoid is set to 2
			 * Re-run with exclude_kernel set; we don't do that
			 * by default as some ARM machines do not support it.
			 *
			 */
			evsel->attr.exclude_kernel = 1;
			ret = perf_evsel__open(evsel, NULL, &tmap.map) >= 0;
		}
1775 1776 1777 1778 1779 1780
		perf_evsel__delete(evsel);
	}

	return ret;
}

1781
int print_hwcache_events(const char *event_glob, bool name_only)
1782
{
1783
	unsigned int type, op, i, evt_i = 0, evt_num = 0;
1784
	char name[64];
1785 1786 1787 1788 1789 1790 1791 1792 1793
	char **evt_list = NULL;
	bool evt_num_known = false;

restart:
	if (evt_num_known) {
		evt_list = zalloc(sizeof(char *) * evt_num);
		if (!evt_list)
			goto out_enomem;
	}
1794 1795 1796 1797

	for (type = 0; type < PERF_COUNT_HW_CACHE_MAX; type++) {
		for (op = 0; op < PERF_COUNT_HW_CACHE_OP_MAX; op++) {
			/* skip invalid cache type */
1798
			if (!perf_evsel__is_cache_op_valid(type, op))
1799 1800 1801
				continue;

			for (i = 0; i < PERF_COUNT_HW_CACHE_RESULT_MAX; i++) {
1802 1803
				__perf_evsel__hw_cache_type_op_res_name(type, op, i,
									name, sizeof(name));
1804
				if (event_glob != NULL && !strglobmatch(name, event_glob))
1805 1806
					continue;

1807 1808 1809 1810
				if (!is_event_supported(PERF_TYPE_HW_CACHE,
							type | (op << 8) | (i << 16)))
					continue;

1811 1812 1813 1814 1815 1816 1817 1818 1819
				if (!evt_num_known) {
					evt_num++;
					continue;
				}

				evt_list[evt_i] = strdup(name);
				if (evt_list[evt_i] == NULL)
					goto out_enomem;
				evt_i++;
1820 1821 1822 1823
			}
		}
	}

1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
	if (!evt_num_known) {
		evt_num_known = true;
		goto restart;
	}
	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
	evt_i = 0;
	while (evt_i < evt_num) {
		if (name_only) {
			printf("%s ", evt_list[evt_i++]);
			continue;
		}
		printf("  %-50s [%s]\n", evt_list[evt_i++],
				event_type_descriptors[PERF_TYPE_HW_CACHE]);
	}
1838
	if (evt_num && pager_in_use())
1839
		printf("\n");
1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852

out_free:
	evt_num = evt_i;
	for (evt_i = 0; evt_i < evt_num; evt_i++)
		zfree(&evt_list[evt_i]);
	zfree(&evt_list);
	return evt_num;

out_enomem:
	printf("FATAL: not enough memory to print %s\n", event_type_descriptors[PERF_TYPE_HW_CACHE]);
	if (evt_list)
		goto out_free;
	return evt_num;
1853 1854
}

1855
void print_symbol_events(const char *event_glob, unsigned type,
1856 1857
				struct event_symbol *syms, unsigned max,
				bool name_only)
1858
{
1859
	unsigned int i, evt_i = 0, evt_num = 0;
1860
	char name[MAX_NAME_LEN];
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
	char **evt_list = NULL;
	bool evt_num_known = false;

restart:
	if (evt_num_known) {
		evt_list = zalloc(sizeof(char *) * evt_num);
		if (!evt_list)
			goto out_enomem;
		syms -= max;
	}
1871

1872
	for (i = 0; i < max; i++, syms++) {
1873

1874
		if (event_glob != NULL &&
1875 1876 1877
		    !(strglobmatch(syms->symbol, event_glob) ||
		      (syms->alias && strglobmatch(syms->alias, event_glob))))
			continue;
1878

1879 1880 1881
		if (!is_event_supported(type, i))
			continue;

1882 1883
		if (!evt_num_known) {
			evt_num++;
1884 1885 1886
			continue;
		}

1887
		if (!name_only && strlen(syms->alias))
1888
			snprintf(name, MAX_NAME_LEN, "%s OR %s", syms->symbol, syms->alias);
1889
		else
1890
			strncpy(name, syms->symbol, MAX_NAME_LEN);
1891

1892 1893 1894 1895
		evt_list[evt_i] = strdup(name);
		if (evt_list[evt_i] == NULL)
			goto out_enomem;
		evt_i++;
1896 1897
	}

1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
	if (!evt_num_known) {
		evt_num_known = true;
		goto restart;
	}
	qsort(evt_list, evt_num, sizeof(char *), cmp_string);
	evt_i = 0;
	while (evt_i < evt_num) {
		if (name_only) {
			printf("%s ", evt_list[evt_i++]);
			continue;
		}
		printf("  %-50s [%s]\n", evt_list[evt_i++], event_type_descriptors[type]);
	}
1911
	if (evt_num && pager_in_use())
1912
		printf("\n");
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924

out_free:
	evt_num = evt_i;
	for (evt_i = 0; evt_i < evt_num; evt_i++)
		zfree(&evt_list[evt_i]);
	zfree(&evt_list);
	return;

out_enomem:
	printf("FATAL: not enough memory to print %s\n", event_type_descriptors[type]);
	if (evt_list)
		goto out_free;
1925 1926 1927 1928 1929
}

/*
 * Print the help text for the event symbols:
 */
1930
void print_events(const char *event_glob, bool name_only)
1931 1932
{
	print_symbol_events(event_glob, PERF_TYPE_HARDWARE,
1933
			    event_symbols_hw, PERF_COUNT_HW_MAX, name_only);
1934 1935

	print_symbol_events(event_glob, PERF_TYPE_SOFTWARE,
1936
			    event_symbols_sw, PERF_COUNT_SW_MAX, name_only);
1937

1938
	print_hwcache_events(event_glob, name_only);
1939

1940 1941
	print_pmu_events(event_glob, name_only);

1942 1943
	if (event_glob != NULL)
		return;
1944

1945 1946 1947 1948 1949 1950 1951
	if (!name_only) {
		printf("  %-50s [%s]\n",
		       "rNNN",
		       event_type_descriptors[PERF_TYPE_RAW]);
		printf("  %-50s [%s]\n",
		       "cpu/t1=v1[,t2=v2,t3 ...]/modifier",
		       event_type_descriptors[PERF_TYPE_RAW]);
1952 1953
		if (pager_in_use())
			printf("   (see 'man perf-list' on how to encode it)\n\n");
1954 1955

		printf("  %-50s [%s]\n",
1956
		       "mem:<addr>[/len][:access]",
1957
			event_type_descriptors[PERF_TYPE_BREAKPOINT]);
1958 1959
		if (pager_in_use())
			printf("\n");
1960
	}
1961

1962
	print_tracepoint_events(NULL, NULL, name_only);
1963
}
1964

1965
int parse_events__is_hardcoded_term(struct parse_events_term *term)
1966
{
1967
	return term->type_term != PARSE_EVENTS__TERM_TYPE_USER;
1968 1969
}

1970
static int new_term(struct parse_events_term **_term, int type_val,
1971
		    int type_term, char *config,
1972
		    char *str, u64 num, int err_term, int err_val)
1973
{
1974
	struct parse_events_term *term;
1975 1976 1977 1978 1979 1980

	term = zalloc(sizeof(*term));
	if (!term)
		return -ENOMEM;

	INIT_LIST_HEAD(&term->list);
1981 1982
	term->type_val  = type_val;
	term->type_term = type_term;
1983
	term->config = config;
1984 1985
	term->err_term = err_term;
	term->err_val  = err_val;
1986

1987
	switch (type_val) {
1988 1989 1990 1991 1992 1993 1994
	case PARSE_EVENTS__TERM_TYPE_NUM:
		term->val.num = num;
		break;
	case PARSE_EVENTS__TERM_TYPE_STR:
		term->val.str = str;
		break;
	default:
1995
		free(term);
1996 1997 1998 1999 2000 2001 2002
		return -EINVAL;
	}

	*_term = term;
	return 0;
}

2003
int parse_events_term__num(struct parse_events_term **term,
2004
			   int type_term, char *config, u64 num,
2005
			   void *loc_term_, void *loc_val_)
2006
{
2007 2008 2009
	YYLTYPE *loc_term = loc_term_;
	YYLTYPE *loc_val = loc_val_;

2010
	return new_term(term, PARSE_EVENTS__TERM_TYPE_NUM, type_term,
2011 2012 2013
			config, NULL, num,
			loc_term ? loc_term->first_column : 0,
			loc_val ? loc_val->first_column : 0);
2014 2015
}

2016
int parse_events_term__str(struct parse_events_term **term,
2017
			   int type_term, char *config, char *str,
2018
			   void *loc_term_, void *loc_val_)
2019
{
2020 2021 2022
	YYLTYPE *loc_term = loc_term_;
	YYLTYPE *loc_val = loc_val_;

2023
	return new_term(term, PARSE_EVENTS__TERM_TYPE_STR, type_term,
2024 2025 2026
			config, str, 0,
			loc_term ? loc_term->first_column : 0,
			loc_val ? loc_val->first_column : 0);
2027 2028
}

2029
int parse_events_term__sym_hw(struct parse_events_term **term,
2030 2031 2032 2033 2034 2035 2036 2037 2038 2039
			      char *config, unsigned idx)
{
	struct event_symbol *sym;

	BUG_ON(idx >= PERF_COUNT_HW_MAX);
	sym = &event_symbols_hw[idx];

	if (config)
		return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
				PARSE_EVENTS__TERM_TYPE_USER, config,
2040
				(char *) sym->symbol, 0, 0, 0);
2041 2042 2043
	else
		return new_term(term, PARSE_EVENTS__TERM_TYPE_STR,
				PARSE_EVENTS__TERM_TYPE_USER,
2044 2045
				(char *) "event", (char *) sym->symbol,
				0, 0, 0);
2046 2047
}

2048 2049
int parse_events_term__clone(struct parse_events_term **new,
			     struct parse_events_term *term)
2050 2051
{
	return new_term(new, term->type_val, term->type_term, term->config,
2052 2053
			term->val.str, term->val.num,
			term->err_term, term->err_val);
2054 2055
}

2056 2057
void parse_events__free_terms(struct list_head *terms)
{
2058
	struct parse_events_term *term, *h;
2059 2060 2061 2062

	list_for_each_entry_safe(term, h, terms, list)
		free(term);
}
2063 2064 2065 2066 2067 2068

void parse_events_evlist_error(struct parse_events_evlist *data,
			       int idx, const char *str)
{
	struct parse_events_error *err = data->error;

2069 2070
	if (!err)
		return;
2071 2072 2073 2074
	err->idx = idx;
	err->str = strdup(str);
	WARN_ONCE(!err->str, "WARNING: failed to allocate error string");
}
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

/*
 * Return string contains valid config terms of an event.
 * @additional_terms: For terms such as PMU sysfs terms.
 */
char *parse_events_formats_error_string(char *additional_terms)
{
	char *str;
	static const char *static_terms = "config,config1,config2,name,"
					  "period,freq,branch_type,time,"
					  "call-graph,stack-size\n";

	/* valid terms */
	if (additional_terms) {
		if (!asprintf(&str, "valid terms: %s,%s",
			      additional_terms, static_terms))
			goto fail;
	} else {
		if (!asprintf(&str, "valid terms: %s", static_terms))
			goto fail;
	}
	return str;

fail:
	return NULL;
}