probe-event.c 60.8 KB
Newer Older
1
/*
2
 * probe-event.c : perf-probe definition to probe_events format converter
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

#include <sys/utsname.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
31 32
#include <stdarg.h>
#include <limits.h>
33
#include <elf.h>
34

35
#include "util.h"
36
#include "event.h"
37
#include "strlist.h"
38
#include "debug.h"
39
#include "cache.h"
40
#include "color.h"
41 42
#include "symbol.h"
#include "thread.h"
43
#include <api/fs/debugfs.h>
44
#include <api/fs/tracefs.h>
45
#include "trace-event.h"	/* For __maybe_unused */
46
#include "probe-event.h"
47
#include "probe-finder.h"
48
#include "session.h"
49 50 51 52

#define MAX_CMDLEN 256
#define PERFPROBE_GROUP "probe"

53 54
bool probe_event_dry_run;	/* Dry run flag */

55
#define semantic_error(msg ...) pr_err("Semantic error :" msg)
56

57
/* If there is no space to write, returns -E2BIG. */
58 59 60
static int e_snprintf(char *str, size_t size, const char *format, ...)
	__attribute__((format(printf, 3, 4)));

61 62 63 64 65 66 67 68 69 70 71 72
static int e_snprintf(char *str, size_t size, const char *format, ...)
{
	int ret;
	va_list ap;
	va_start(ap, format);
	ret = vsnprintf(str, size, format, ap);
	va_end(ap);
	if (ret >= (int)size)
		ret = -E2BIG;
	return ret;
}

73
static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
74
static void clear_probe_trace_event(struct probe_trace_event *tev);
75
static struct machine *host_machine;
76

77
/* Initialize symbol maps and path of vmlinux/modules */
78
static int init_symbol_maps(bool user_only)
79
{
80 81
	int ret;

82
	symbol_conf.sort_by_name = true;
83
	ret = symbol__init(NULL);
84 85 86 87
	if (ret < 0) {
		pr_debug("Failed to init symbol map.\n");
		goto out;
	}
88

89 90
	if (host_machine || user_only)	/* already initialized */
		return 0;
91

92 93 94 95 96 97 98 99
	if (symbol_conf.vmlinux_name)
		pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);

	host_machine = machine__new_host();
	if (!host_machine) {
		pr_debug("machine__new_host() failed.\n");
		symbol__exit();
		ret = -1;
100
	}
101 102 103 104
out:
	if (ret < 0)
		pr_warning("Failed to init vmlinux path.\n");
	return ret;
105 106
}

107 108 109 110 111 112 113 114 115
static void exit_symbol_maps(void)
{
	if (host_machine) {
		machine__delete(host_machine);
		host_machine = NULL;
	}
	symbol__exit();
}

116 117 118
static struct symbol *__find_kernel_function_by_name(const char *name,
						     struct map **mapp)
{
119
	return machine__find_kernel_function_by_name(host_machine, name, mapp,
120 121 122
						     NULL);
}

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
{
	return machine__find_kernel_function(host_machine, addr, mapp, NULL);
}

static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
{
	/* kmap->ref_reloc_sym should be set if host_machine is initialized */
	struct kmap *kmap;

	if (map__load(host_machine->vmlinux_maps[MAP__FUNCTION], NULL) < 0)
		return NULL;

	kmap = map__kmap(host_machine->vmlinux_maps[MAP__FUNCTION]);
	return kmap->ref_reloc_sym;
}

static u64 kernel_get_symbol_address_by_name(const char *name, bool reloc)
{
	struct ref_reloc_sym *reloc_sym;
	struct symbol *sym;
	struct map *map;

	/* ref_reloc_sym is just a label. Need a special fix*/
	reloc_sym = kernel_get_ref_reloc_sym();
	if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
		return (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
	else {
		sym = __find_kernel_function_by_name(name, &map);
		if (sym)
			return map->unmap_ip(map, sym->start) -
H
He Kuang 已提交
154
				((reloc) ? 0 : map->reloc);
155 156 157 158
	}
	return 0;
}

159 160 161
static struct map *kernel_get_module_map(const char *module)
{
	struct rb_node *nd;
162
	struct map_groups *grp = &host_machine->kmaps;
163

164 165
	/* A file path -- this is an offline module */
	if (module && strchr(module, '/'))
166
		return machine__new_module(host_machine, 0, module);
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181
	if (!module)
		module = "kernel";

	for (nd = rb_first(&grp->maps[MAP__FUNCTION]); nd; nd = rb_next(nd)) {
		struct map *pos = rb_entry(nd, struct map, rb_node);
		if (strncmp(pos->dso->short_name + 1, module,
			    pos->dso->short_name_len - 2) == 0) {
			return pos;
		}
	}
	return NULL;
}

static struct dso *kernel_get_module_dso(const char *module)
182 183
{
	struct dso *dso;
184 185
	struct map *map;
	const char *vmlinux_name;
186 187

	if (module) {
188 189
		list_for_each_entry(dso, &host_machine->kernel_dsos.head,
				    node) {
190 191 192 193 194 195
			if (strncmp(dso->short_name + 1, module,
				    dso->short_name_len - 2) == 0)
				goto found;
		}
		pr_debug("Failed to find module %s.\n", module);
		return NULL;
196 197
	}

198
	map = host_machine->vmlinux_maps[MAP__FUNCTION];
199 200 201 202
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	if (vmlinux_name) {
203
		if (dso__load_vmlinux(dso, map, vmlinux_name, false, NULL) <= 0)
204
			return NULL;
205
	} else {
206
		if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
207 208 209 210 211
			pr_debug("Failed to load kernel map.\n");
			return NULL;
		}
	}
found:
212 213 214 215 216 217 218
	return dso;
}

const char *kernel_get_module_path(const char *module)
{
	struct dso *dso = kernel_get_module_dso(module);
	return (dso) ? dso->long_name : NULL;
219 220
}

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
static int convert_exec_to_group(const char *exec, char **result)
{
	char *ptr1, *ptr2, *exec_copy;
	char buf[64];
	int ret;

	exec_copy = strdup(exec);
	if (!exec_copy)
		return -ENOMEM;

	ptr1 = basename(exec_copy);
	if (!ptr1) {
		ret = -EINVAL;
		goto out;
	}

	ptr2 = strpbrk(ptr1, "-._");
	if (ptr2)
		*ptr2 = '\0';
	ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
	if (ret < 0)
		goto out;

	*result = strdup(buf);
	ret = *result ? 0 : -ENOMEM;

out:
	free(exec_copy);
	return ret;
}

252 253 254 255 256 257 258 259
static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
{
	int i;

	for (i = 0; i < ntevs; i++)
		clear_probe_trace_event(tevs + i);
}

260
#ifdef HAVE_DWARF_SUPPORT
261

262
/* Open new debuginfo of given module */
263
static struct debuginfo *open_debuginfo(const char *module, bool silent)
264
{
265
	const char *path = module;
266
	struct debuginfo *ret;
267

268
	if (!module || !strchr(module, '/')) {
269 270
		path = kernel_get_module_path(module);
		if (!path) {
271 272 273
			if (!silent)
				pr_err("Failed to find path of %s module.\n",
				       module ?: "kernel");
274 275
			return NULL;
		}
276
	}
277 278 279 280 281 282 283 284 285 286
	ret = debuginfo__new(path);
	if (!ret && !silent) {
		pr_warning("The %s file has no debug information.\n", path);
		if (!module || !strtailcmp(path, ".ko"))
			pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
		else
			pr_warning("Rebuild with -g, ");
		pr_warning("or install an appropriate debuginfo package.\n");
	}
	return ret;
287
}
288

289

290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
static int get_text_start_address(const char *exec, unsigned long *address)
{
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;
	int fd, ret = -ENOENT;

	fd = open(exec, O_RDONLY);
	if (fd < 0)
		return -errno;

	elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
	if (elf == NULL)
		return -EINVAL;

	if (gelf_getehdr(elf, &ehdr) == NULL)
		goto out;

	if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
		goto out;

	*address = shdr.sh_addr - shdr.sh_offset;
	ret = 0;
out:
	elf_end(elf);
	return ret;
}

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
/*
 * Convert trace point to probe point with debuginfo
 */
static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
					    struct perf_probe_point *pp,
					    bool is_kprobe)
{
	struct debuginfo *dinfo = NULL;
	unsigned long stext = 0;
	u64 addr = tp->address;
	int ret = -ENOENT;

	/* convert the address to dwarf address */
	if (!is_kprobe) {
		if (!addr) {
			ret = -EINVAL;
			goto error;
		}
		ret = get_text_start_address(tp->module, &stext);
		if (ret < 0)
			goto error;
		addr += stext;
	} else {
		addr = kernel_get_symbol_address_by_name(tp->symbol, false);
		if (addr == 0)
			goto error;
		addr += tp->offset;
	}

	pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
		 tp->module ? : "kernel");

350
	dinfo = open_debuginfo(tp->module, verbose == 0);
351 352 353 354
	if (dinfo) {
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
		debuginfo__delete(dinfo);
355
	} else
356 357 358 359 360 361 362 363 364 365 366
		ret = -ENOENT;

	if (ret > 0) {
		pp->retprobe = tp->retprobe;
		return 0;
	}
error:
	pr_debug("Failed to find corresponding probes from debuginfo.\n");
	return ret ? : -ENOENT;
}

367 368 369 370
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
371
	unsigned long stext = 0;
372 373 374 375 376 377 378 379 380

	if (!exec)
		return 0;

	ret = get_text_start_address(exec, &stext);
	if (ret < 0)
		return ret;

	for (i = 0; i < ntevs && ret >= 0; i++) {
381
		/* point.address is the addres of point.symbol + point.offset */
382
		tevs[i].point.address -= stext;
383
		tevs[i].point.module = strdup(exec);
384
		if (!tevs[i].point.module) {
385 386 387 388 389 390 391 392 393
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

394 395 396
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
	int i, ret = 0;
	char *tmp;

	if (!module)
		return 0;

	tmp = strrchr(module, '/');
	if (tmp) {
		/* This is a module path -- get the module name */
		module = strdup(tmp + 1);
		if (!module)
			return -ENOMEM;
		tmp = strchr(module, '.');
		if (tmp)
			*tmp = '\0';
		tmp = (char *)module;	/* For free() */
	}

415 416
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
417 418 419 420
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
421
	}
422

423
	free(tmp);
424
	return ret;
425 426
}

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
/* Post processing the probe events */
static int post_process_probe_trace_events(struct probe_trace_event *tevs,
					   int ntevs, const char *module,
					   bool uprobe)
{
	struct ref_reloc_sym *reloc_sym;
	char *tmp;
	int i;

	if (uprobe)
		return add_exec_to_probe_trace_events(tevs, ntevs, module);

	/* Note that currently ref_reloc_sym based probe is not for drivers */
	if (module)
		return add_module_to_probe_trace_events(tevs, ntevs, module);

443
	reloc_sym = kernel_get_ref_reloc_sym();
444 445 446 447 448 449
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
450
		if (tevs[i].point.address && !tevs[i].point.retprobe) {
451 452 453 454 455 456 457 458 459 460 461 462
			tmp = strdup(reloc_sym->name);
			if (!tmp)
				return -ENOMEM;
			free(tevs[i].point.symbol);
			tevs[i].point.symbol = tmp;
			tevs[i].point.offset = tevs[i].point.address -
					       reloc_sym->unrelocated_addr;
		}
	}
	return 0;
}

463
/* Try to find perf_probe_event with debuginfo */
464
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
465
					  struct probe_trace_event **tevs,
466
					  int max_tevs, const char *target)
467 468
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
469
	struct debuginfo *dinfo;
470
	int ntevs, ret = 0;
471

472
	dinfo = open_debuginfo(target, !need_dwarf);
473

474
	if (!dinfo) {
475
		if (need_dwarf)
476 477
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
478 479 480
		return 0;
	}

481
	pr_debug("Try to find probe point from debuginfo.\n");
482 483 484 485
	/* Searching trace events corresponding to a probe event */
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);

	debuginfo__delete(dinfo);
486

487
	if (ntevs > 0) {	/* Succeeded to find trace events */
488 489 490
		pr_debug("Found %d probe_trace_events.\n", ntevs);
		ret = post_process_probe_trace_events(*tevs, ntevs,
							target, pev->uprobes);
491 492 493 494
		if (ret < 0) {
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
495
		return ret < 0 ? ret : ntevs;
496
	}
497

498
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
499
		pr_warning("Probe point '%s' not found in debuginfo.\n",
500
			   synthesize_perf_probe_point(&pev->point));
501 502 503
		if (need_dwarf)
			return -ENOENT;
		return 0;
504 505
	}
	/* Error path : ntevs < 0 */
506 507 508 509 510
	pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
	if (ntevs == -EBADF) {
		pr_warning("Warning: No dwarf info found in the vmlinux - "
			"please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
		if (!need_dwarf) {
M
Masami Hiramatsu 已提交
511
			pr_debug("Trying to use symbols.\n");
512 513
			return 0;
		}
514
	}
515
	return ntevs;
516 517
}

518 519 520 521 522 523
/*
 * Find a src file from a DWARF tag path. Prepend optional source path prefix
 * and chop off leading directories that do not exist. Result is passed back as
 * a newly allocated path on success.
 * Return 0 if file was found and readable, -errno otherwise.
 */
524 525
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
526
{
527 528 529 530 531 532 533 534 535
	const char *prefix = symbol_conf.source_prefix;

	if (!prefix) {
		if (raw_path[0] != '/' && comp_dir)
			/* If not an absolute path, try to use comp_dir */
			prefix = comp_dir;
		else {
			if (access(raw_path, R_OK) == 0) {
				*new_path = strdup(raw_path);
536
				return *new_path ? 0 : -ENOMEM;
537 538 539
			} else
				return -errno;
		}
540 541
	}

542
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
543 544 545 546
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
547
		sprintf(*new_path, "%s/%s", prefix, raw_path);
548 549 550 551

		if (access(*new_path, R_OK) == 0)
			return 0;

552
		if (!symbol_conf.source_prefix) {
553
			/* In case of searching comp_dir, don't retry */
554
			zfree(new_path);
555
			return -errno;
556
		}
557

558 559 560 561 562 563 564
		switch (errno) {
		case ENAMETOOLONG:
		case ENOENT:
		case EROFS:
		case EFAULT:
			raw_path = strchr(++raw_path, '/');
			if (!raw_path) {
565
				zfree(new_path);
566 567 568 569 570
				return -ENOENT;
			}
			continue;

		default:
571
			zfree(new_path);
572 573 574 575 576
			return -errno;
		}
	}
}

577 578 579
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

580
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
581
{
582
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
583 584
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
585

586
	do {
587 588
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
589 590 591 592 593
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
594
		}
595 596 597
		color_fprintf(stdout, color, "%s", buf);

	} while (strchr(buf, '\n') == NULL);
598

599
	return 1;
600
error:
601
	if (ferror(fp)) {
602 603
		pr_warning("File read error: %s\n",
			   strerror_r(errno, sbuf, sizeof(sbuf)));
604 605 606 607
		return -1;
	}
	return 0;
}
608

609 610 611 612 613 614 615 616
static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
{
	int rv = __show_one_line(fp, l, skip, show_num);
	if (rv == 0) {
		pr_warning("Source file is shorter than expected.\n");
		rv = -1;
	}
	return rv;
617 618
}

619 620 621 622 623
#define show_one_line_with_num(f,l)	_show_one_line(f,l,false,true)
#define show_one_line(f,l)		_show_one_line(f,l,false,false)
#define skip_one_line(f,l)		_show_one_line(f,l,true,false)
#define show_one_line_or_eof(f,l)	__show_one_line(f,l,false,false)

624 625 626 627
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
628
static int __show_line_range(struct line_range *lr, const char *module)
629
{
630
	int l = 1;
631
	struct int_node *ln;
632
	struct debuginfo *dinfo;
633
	FILE *fp;
634
	int ret;
635
	char *tmp;
636
	char sbuf[STRERR_BUFSIZE];
637 638

	/* Search a line range */
639 640
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
641
		return -ENOENT;
642

643 644
	ret = debuginfo__find_line_range(dinfo, lr);
	debuginfo__delete(dinfo);
645
	if (ret == 0 || ret == -ENOENT) {
646 647 648
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
649
		pr_warning("Debuginfo analysis failed.\n");
650 651
		return ret;
	}
652

653 654
	/* Convert source file path */
	tmp = lr->path;
655
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
656 657
	free(tmp);	/* Free old path */
	if (ret < 0) {
658
		pr_warning("Failed to find source file path.\n");
659 660 661
		return ret;
	}

662 663 664
	setup_pager();

	if (lr->function)
665
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
666 667
			lr->start - lr->offset);
	else
668
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
669 670

	fp = fopen(lr->path, "r");
671 672
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
673
			   strerror_r(errno, sbuf, sizeof(sbuf)));
674 675
		return -errno;
	}
676
	/* Skip to starting line number */
677
	while (l < lr->start) {
678
		ret = skip_one_line(fp, l++);
679 680 681
		if (ret < 0)
			goto end;
	}
682

683 684
	intlist__for_each(ln, lr->line_list) {
		for (; ln->i > l; l++) {
685
			ret = show_one_line(fp, l - lr->offset);
686 687 688
			if (ret < 0)
				goto end;
		}
689
		ret = show_one_line_with_num(fp, l++ - lr->offset);
690 691
		if (ret < 0)
			goto end;
692 693 694 695
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
696 697 698
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
699 700
			break;
	}
701
end:
702
	fclose(fp);
703
	return ret;
704 705
}

706
int show_line_range(struct line_range *lr, const char *module, bool user)
707 708 709
{
	int ret;

710
	ret = init_symbol_maps(user);
711 712 713 714 715 716 717 718
	if (ret < 0)
		return ret;
	ret = __show_line_range(lr, module);
	exit_symbol_maps();

	return ret;
}

719 720
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
721 722
				  int max_vls, struct strfilter *_filter,
				  bool externs)
723 724
{
	char *buf;
725
	int ret, i, nvars;
726 727
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
728
	const char *var;
729 730 731 732 733 734

	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return -EINVAL;
	pr_debug("Searching variables at %s\n", buf);

735 736
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
						max_vls, externs);
737
	if (ret <= 0) {
738 739 740 741 742
		if (ret == 0 || ret == -ENOENT) {
			pr_err("Failed to find the address of %s\n", buf);
			ret = -ENOENT;
		} else
			pr_warning("Debuginfo analysis failed.\n");
743 744
		goto end;
	}
745

746 747 748 749 750 751 752 753 754 755
	/* Some variables are found */
	fprintf(stdout, "Available variables at %s\n", buf);
	for (i = 0; i < ret; i++) {
		vl = &vls[i];
		/*
		 * A probe point might be converted to
		 * several trace points.
		 */
		fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
			vl->point.offset);
756
		zfree(&vl->point.symbol);
757 758 759 760 761
		nvars = 0;
		if (vl->vars) {
			strlist__for_each(node, vl->vars) {
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
762
					fprintf(stdout, "\t\t%s\n", node->s);
763 764 765 766
					nvars++;
				}
			}
			strlist__delete(vl->vars);
767
		}
768 769 770 771 772
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
773 774 775 776 777 778
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
779 780
			int max_vls, const char *module,
			struct strfilter *_filter, bool externs)
781
{
782 783
	int i, ret = 0;
	struct debuginfo *dinfo;
784

785
	ret = init_symbol_maps(pevs->uprobes);
786 787 788
	if (ret < 0)
		return ret;

789
	dinfo = open_debuginfo(module, false);
790
	if (!dinfo) {
791 792
		ret = -ENOENT;
		goto out;
793 794
	}

795 796
	setup_pager();

797 798
	for (i = 0; i < npevs && ret >= 0; i++)
		ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
799
					     externs);
800 801

	debuginfo__delete(dinfo);
802 803
out:
	exit_symbol_maps();
804 805 806
	return ret;
}

807
#else	/* !HAVE_DWARF_SUPPORT */
808

809 810 811 812
static int
find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
				 struct perf_probe_point *pp __maybe_unused,
				 bool is_kprobe __maybe_unused)
813
{
814
	return -ENOSYS;
815 816
}

817
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
818
				struct probe_trace_event **tevs __maybe_unused,
819 820
				int max_tevs __maybe_unused,
				const char *target __maybe_unused)
821
{
822 823 824 825
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
826

827 828 829
	return 0;
}

830
int show_line_range(struct line_range *lr __maybe_unused,
831 832
		    const char *module __maybe_unused,
		    bool user __maybe_unused)
833
{
834 835
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
836 837
}

838 839 840 841 842
int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
			int npevs __maybe_unused, int max_vls __maybe_unused,
			const char *module __maybe_unused,
			struct strfilter *filter __maybe_unused,
			bool externs __maybe_unused)
843 844 845 846
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
847 848
#endif

849 850 851 852 853 854
void line_range__clear(struct line_range *lr)
{
	free(lr->function);
	free(lr->file);
	free(lr->path);
	free(lr->comp_dir);
855
	intlist__delete(lr->line_list);
856 857 858
	memset(lr, 0, sizeof(*lr));
}

859
int line_range__init(struct line_range *lr)
860 861
{
	memset(lr, 0, sizeof(*lr));
862 863 864 865 866
	lr->line_list = intlist__new(NULL);
	if (!lr->line_list)
		return -ENOMEM;
	else
		return 0;
867 868
}

869 870 871 872 873 874 875 876 877 878 879 880 881
static int parse_line_num(char **ptr, int *val, const char *what)
{
	const char *start = *ptr;

	errno = 0;
	*val = strtol(*ptr, ptr, 0);
	if (errno || *ptr == start) {
		semantic_error("'%s' is not a valid number.\n", what);
		return -EINVAL;
	}
	return 0;
}

882 883 884 885 886
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
887
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
888
 */
889
int parse_line_range_desc(const char *arg, struct line_range *lr)
890
{
891
	char *range, *file, *name = strdup(arg);
892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
	int err;

	if (!name)
		return -ENOMEM;

	lr->start = 0;
	lr->end = INT_MAX;

	range = strchr(name, ':');
	if (range) {
		*range++ = '\0';

		err = parse_line_num(&range, &lr->start, "start line");
		if (err)
			goto err;

		if (*range == '+' || *range == '-') {
			const char c = *range++;

			err = parse_line_num(&range, &lr->end, "end line");
			if (err)
				goto err;

			if (c == '+') {
				lr->end += lr->start;
				/*
				 * Adjust the number of lines here.
				 * If the number of lines == 1, the
				 * the end of line should be equal to
				 * the start of line.
				 */
				lr->end--;
			}
		}
926

927
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
928 929

		err = -EINVAL;
930
		if (lr->start > lr->end) {
931
			semantic_error("Start line must be smaller"
932
				       " than end line.\n");
933
			goto err;
934
		}
935 936 937
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
938
		}
939
	}
940

941 942 943 944 945 946 947 948 949 950
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
	} else if (strchr(name, '.'))
951
		lr->file = name;
952
	else
953
		lr->function = name;
954 955

	return 0;
956 957 958
err:
	free(name);
	return err;
959 960
}

961 962 963 964 965 966 967 968 969 970 971 972
/* Check the name is good for event/group */
static bool check_event_name(const char *name)
{
	if (!isalpha(*name) && *name != '_')
		return false;
	while (*++name != '\0') {
		if (!isalpha(*name) && !isdigit(*name) && *name != '_')
			return false;
	}
	return true;
}

973
/* Parse probepoint definition. */
974
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
975
{
976
	struct perf_probe_point *pp = &pev->point;
977 978 979 980
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
981 982
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
983 984
	 *
	 * TODO:Group name support
985 986
	 */

987 988
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
989 990
		*ptr = '\0';
		tmp = ptr + 1;
991 992 993 994 995
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
996
			semantic_error("%s is bad for event name -it must "
997 998 999
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
1000 1001 1002
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
1003
		pev->group = NULL;
1004 1005 1006
		arg = tmp;
	}

1007
	ptr = strpbrk(arg, ";:+@%");
1008 1009 1010 1011 1012
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1013 1014 1015 1016
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

1017
	/* Check arg is function or file and copy it */
1018 1019
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
1020
	else			/* Function */
1021
		pp->function = tmp;
1022 1023 1024 1025 1026

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1027
		if (c == ';') {	/* Lazy pattern must be the last part */
1028 1029 1030
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1031 1032 1033
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1034 1035 1036 1037 1038 1039 1040
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1041
			if (*tmp != '\0') {
1042
				semantic_error("There is non-digit char"
1043 1044 1045
					       " in line number.\n");
				return -EINVAL;
			}
1046 1047 1048
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1049
			if (*tmp != '\0') {
1050
				semantic_error("There is non-digit character"
1051 1052 1053
						" in offset.\n");
				return -EINVAL;
			}
1054 1055
			break;
		case '@':	/* File name */
1056 1057 1058 1059
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1060 1061 1062
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1063 1064 1065 1066
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1067 1068 1069 1070
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1071
			break;
1072 1073 1074 1075
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1076 1077 1078 1079 1080
			break;
		}
	}

	/* Exclusion check */
1081
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1082 1083
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1084 1085
		return -EINVAL;
	}
1086

1087
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
1088
		semantic_error("Lazy pattern can't be used with offset.\n");
1089 1090
		return -EINVAL;
	}
1091

1092
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1093
		semantic_error("Offset can't be used with line number.\n");
1094 1095
		return -EINVAL;
	}
1096

1097
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1098
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1099
			       "lazy pattern.\n");
1100 1101
		return -EINVAL;
	}
1102

1103
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1104
		semantic_error("Offset requires an entry function.\n");
1105 1106
		return -EINVAL;
	}
1107

1108
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1109
		semantic_error("Return probe requires an entry function.\n");
1110 1111
		return -EINVAL;
	}
1112

1113
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1114
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1115
			       "return probe.\n");
1116 1117
		return -EINVAL;
	}
1118

1119
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1120 1121
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1122
	return 0;
1123 1124
}

1125
/* Parse perf-probe event argument */
1126
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1127
{
1128
	char *tmp, *goodname;
1129 1130 1131 1132
	struct perf_probe_arg_field **fieldp;

	pr_debug("parsing arg: %s into ", str);

1133 1134
	tmp = strchr(str, '=');
	if (tmp) {
1135 1136 1137
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1138
		pr_debug("name:%s ", arg->name);
1139 1140 1141
		str = tmp + 1;
	}

1142 1143 1144
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1145 1146 1147
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1148 1149 1150
		pr_debug("type:%s ", arg->type);
	}

1151
	tmp = strpbrk(str, "-.[");
1152 1153
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1154 1155 1156
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1157
		pr_debug("%s\n", arg->var);
1158
		return 0;
1159 1160
	}

1161
	/* Structure fields or array element */
1162 1163 1164
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1165
	goodname = arg->var;
1166
	pr_debug("%s, ", arg->var);
1167 1168 1169
	fieldp = &arg->field;

	do {
1170 1171 1172
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1173 1174 1175
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1176
			(*fieldp)->ref = true;
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
			if (*tmp != ']' || tmp == str + 1) {
				semantic_error("Array index must be a"
						" number.\n");
				return -EINVAL;
			}
			tmp++;
			if (*tmp == '\0')
				tmp = NULL;
		} else {		/* Structure */
			if (*tmp == '.') {
				str = tmp + 1;
				(*fieldp)->ref = false;
			} else if (tmp[1] == '>') {
				str = tmp + 2;
				(*fieldp)->ref = true;
			} else {
				semantic_error("Argument parse error: %s\n",
					       str);
				return -EINVAL;
			}
			tmp = strpbrk(str, "-.[");
1198
		}
1199
		if (tmp) {
1200 1201 1202
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1203 1204
			if (*str != '[')
				goodname = (*fieldp)->name;
1205 1206 1207 1208
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1209 1210 1211
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1212 1213
	if (*str != '[')
		goodname = (*fieldp)->name;
1214
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1215

1216
	/* If no name is specified, set the last field name (not array index)*/
1217
	if (!arg->name) {
1218
		arg->name = strdup(goodname);
1219 1220 1221
		if (arg->name == NULL)
			return -ENOMEM;
	}
1222
	return 0;
1223 1224
}

1225
/* Parse perf-probe event command */
1226
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1227
{
1228
	char **argv;
1229
	int argc, i, ret = 0;
1230

1231
	argv = argv_split(cmd, &argc);
1232 1233 1234 1235 1236 1237 1238 1239 1240
	if (!argv) {
		pr_debug("Failed to split arguments.\n");
		return -ENOMEM;
	}
	if (argc - 1 > MAX_PROBE_ARGS) {
		semantic_error("Too many probe arguments (%d).\n", argc - 1);
		ret = -ERANGE;
		goto out;
	}
1241
	/* Parse probe point */
1242 1243 1244
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1245

1246
	/* Copy arguments and ensure return probe has no C argument */
1247
	pev->nargs = argc - 1;
1248 1249 1250 1251 1252
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1253 1254 1255 1256
	for (i = 0; i < pev->nargs && ret >= 0; i++) {
		ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
		if (ret >= 0 &&
		    is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1257
			semantic_error("You can't specify local variable for"
1258 1259 1260
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1261
	}
1262
out:
1263
	argv_free(argv);
1264 1265

	return ret;
1266 1267
}

1268 1269 1270 1271 1272 1273 1274 1275 1276
/* Return true if this perf_probe_event requires debuginfo */
bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
{
	int i;

	if (pev->point.file || pev->point.line || pev->point.lazy_line)
		return true;

	for (i = 0; i < pev->nargs; i++)
1277
		if (is_c_varname(pev->args[i].var))
1278 1279 1280 1281 1282
			return true;

	return false;
}

1283 1284
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
1285
				     struct probe_trace_event *tev)
1286
{
1287
	struct probe_trace_point *tp = &tev->point;
1288 1289
	char pr;
	char *p;
1290
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1291 1292 1293
	int ret, i, argc;
	char **argv;

1294
	pr_debug("Parsing probe_events: %s\n", cmd);
1295
	argv = argv_split(cmd, &argc);
1296 1297 1298 1299 1300 1301 1302 1303 1304
	if (!argv) {
		pr_debug("Failed to split arguments.\n");
		return -ENOMEM;
	}
	if (argc < 2) {
		semantic_error("Too few probe arguments.\n");
		ret = -ERANGE;
		goto out;
	}
1305 1306

	/* Scan event and group name. */
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
	argv0_str = strdup(argv[0]);
	if (argv0_str == NULL) {
		ret = -ENOMEM;
		goto out;
	}
	fmt1_str = strtok_r(argv0_str, ":", &fmt);
	fmt2_str = strtok_r(NULL, "/", &fmt);
	fmt3_str = strtok_r(NULL, " \t", &fmt);
	if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
	    || fmt3_str == NULL) {
1317 1318 1319 1320
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1321 1322 1323 1324 1325 1326 1327
	pr = fmt1_str[0];
	tev->group = strdup(fmt2_str);
	tev->event = strdup(fmt3_str);
	if (tev->group == NULL || tev->event == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1328
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1329

1330
	tp->retprobe = (pr == 'r');
1331

1332 1333 1334 1335 1336 1337 1338
	/* Scan module name(if there), function name and offset */
	p = strchr(argv[1], ':');
	if (p) {
		tp->module = strndup(argv[1], p - argv[1]);
		p++;
	} else
		p = argv[1];
1339
	fmt1_str = strtok_r(p, "+", &fmt);
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
	if (fmt1_str[0] == '0')	/* only the address started with 0x */
		tp->address = strtoul(fmt1_str, NULL, 0);
	else {
		/* Only the symbol-based probe has offset */
		tp->symbol = strdup(fmt1_str);
		if (tp->symbol == NULL) {
			ret = -ENOMEM;
			goto out;
		}
		fmt2_str = strtok_r(NULL, "", &fmt);
		if (fmt2_str == NULL)
			tp->offset = 0;
		else
			tp->offset = strtoul(fmt2_str, NULL, 10);
1354
	}
1355

1356
	tev->nargs = argc - 2;
1357
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1358 1359 1360 1361
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1362
	for (i = 0; i < tev->nargs; i++) {
1363 1364
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1365 1366 1367
			*p++ = '\0';
		else
			p = argv[i + 2];
1368
		tev->args[i].name = strdup(argv[i + 2]);
1369
		/* TODO: parse regs and offset */
1370 1371 1372 1373 1374
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1375
	}
1376 1377
	ret = 0;
out:
1378
	free(argv0_str);
1379
	argv_free(argv);
1380
	return ret;
1381 1382
}

1383 1384 1385 1386 1387 1388 1389
/* Compose only probe arg */
int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
{
	struct perf_probe_arg_field *field = pa->field;
	int ret;
	char *tmp = buf;

1390 1391 1392 1393
	if (pa->name && pa->var)
		ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
	else
		ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1394 1395 1396 1397 1398 1399
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1400 1401 1402 1403 1404
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1405 1406 1407 1408 1409 1410
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1411 1412 1413 1414 1415 1416 1417 1418 1419

	if (pa->type) {
		ret = e_snprintf(tmp, len, ":%s", pa->type);
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
	}

1420 1421
	return tmp - buf;
error:
1422
	pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1423
	return ret;
1424 1425
}

1426 1427
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1428
{
1429 1430 1431
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1432

1433 1434 1435 1436 1437
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1438
	if (pp->offset) {
1439
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1440 1441 1442 1443
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1444 1445 1446 1447 1448
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1449 1450 1451 1452 1453 1454 1455
		tmp = pp->file;
		len = strlen(tmp);
		if (len > 30) {
			tmp = strchr(pp->file + len - 30, '/');
			tmp = tmp ? tmp + 1 : pp->file + len - 30;
		}
		ret = e_snprintf(file, 32, "@%s", tmp);
1456 1457 1458 1459 1460
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1461 1462 1463
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1464
	else
1465
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1466 1467 1468 1469
	if (ret <= 0)
		goto error;

	return buf;
1470
error:
1471
	pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1472
	free(buf);
1473
	return NULL;
1474 1475
}

1476 1477
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1478 1479 1480 1481
{
	char *buf;
	int i, len, ret;

1482 1483 1484
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1485

1486 1487
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1488
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1489 1490 1491 1492 1493
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1494 1495 1496
		len += ret;
	}

1497 1498 1499 1500
	return buf;
}
#endif

1501
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1502 1503 1504 1505 1506
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1507
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
							 buflen, depth + 1);
		if (depth < 0)
			goto out;
	}

	ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
	if (ret < 0)
		depth = ret;
	else {
		*buf += ret;
		*buflen -= ret;
	}
out:
	return depth;
1522 1523 1524

}

1525
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1526
				       char *buf, size_t buflen)
1527
{
1528
	struct probe_trace_arg_ref *ref = arg->ref;
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
	int ret, depth = 0;
	char *tmp = buf;

	/* Argument name or separator */
	if (arg->name)
		ret = e_snprintf(buf, buflen, " %s=", arg->name);
	else
		ret = e_snprintf(buf, buflen, " ");
	if (ret < 0)
		return ret;
	buf += ret;
	buflen -= ret;

1542 1543 1544 1545
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1546
	/* Dereferencing arguments */
1547
	if (ref) {
1548
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1549 1550 1551 1552 1553 1554
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1555 1556 1557 1558 1559
	if (arg->value[0] == '@' && arg->ref)
		ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
				 arg->ref->offset);
	else
		ret = e_snprintf(buf, buflen, "%s", arg->value);
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
	if (ret < 0)
		return ret;
	buf += ret;
	buflen -= ret;

	/* Closing */
	while (depth--) {
		ret = e_snprintf(buf, buflen, ")");
		if (ret < 0)
			return ret;
		buf += ret;
		buflen -= ret;
	}
1573 1574 1575 1576 1577 1578 1579
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1580 1581 1582 1583

	return buf - tmp;
}

1584
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1585
{
1586
	struct probe_trace_point *tp = &tev->point;
1587 1588 1589
	char *buf;
	int i, len, ret;

1590 1591 1592 1593
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
	len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
			 tev->group, tev->event);
	if (len <= 0)
		goto error;

	/* Uprobes must have tp->address and tp->module */
	if (tev->uprobes && (!tp->address || !tp->module))
		goto error;

	/* Use the tp->address for uprobes */
1604
	if (tev->uprobes)
1605 1606
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
				 tp->module, tp->address);
1607
	else
1608
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1609 1610 1611
				 tp->module ?: "", tp->module ? ":" : "",
				 tp->symbol, tp->offset);

1612
	if (ret <= 0)
1613
		goto error;
1614
	len += ret;
1615

1616
	for (i = 0; i < tev->nargs; i++) {
1617
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1618
						  MAX_CMDLEN - len);
1619
		if (ret <= 0)
1620 1621 1622 1623
			goto error;
		len += ret;
	}

1624
	return buf;
1625
error:
1626 1627 1628
	free(buf);
	return NULL;
}
1629

1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
					  struct perf_probe_point *pp,
					  bool is_kprobe)
{
	struct symbol *sym = NULL;
	struct map *map;
	u64 addr;
	int ret = -ENOENT;

	if (!is_kprobe) {
		map = dso__new_map(tp->module);
		if (!map)
			goto out;
		addr = tp->address;
		sym = map__find_symbol(map, addr, NULL);
	} else {
		addr = kernel_get_symbol_address_by_name(tp->symbol, true);
		if (addr) {
			addr += tp->offset;
			sym = __find_kernel_function(addr, &map);
		}
	}
	if (!sym)
		goto out;

	pp->retprobe = tp->retprobe;
	pp->offset = addr - map->unmap_ip(map, sym->start);
	pp->function = strdup(sym->name);
	ret = pp->function ? 0 : -ENOMEM;

out:
	if (map && !is_kprobe) {
		dso__delete(map->dso);
		map__delete(map);
	}

	return ret;
}

static int convert_to_perf_probe_point(struct probe_trace_point *tp,
					struct perf_probe_point *pp,
					bool is_kprobe)
{
	char buf[128];
	int ret;

	ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
	if (!ret)
		return 0;
	ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
	if (!ret)
		return 0;

	pr_debug("Failed to find probe point from both of dwarf and map.\n");

	if (tp->symbol) {
		pp->function = strdup(tp->symbol);
		pp->offset = tp->offset;
	} else if (!tp->module && !is_kprobe) {
		ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
		if (ret < 0)
			return ret;
		pp->function = strdup(buf);
		pp->offset = 0;
	}
	if (pp->function == NULL)
		return -ENOMEM;

	pp->retprobe = tp->retprobe;

	return 0;
}

1703
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1704
			       struct perf_probe_event *pev, bool is_kprobe)
1705
{
1706
	char buf[64] = "";
1707
	int i, ret;
1708

1709
	/* Convert event/group name */
1710 1711 1712 1713
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1714

1715
	/* Convert trace_point to probe_point */
1716
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1717 1718
	if (ret < 0)
		return ret;
1719

1720 1721
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1722 1723 1724
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1725
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1726
		if (tev->args[i].name)
1727
			pev->args[i].name = strdup(tev->args[i].name);
1728
		else {
1729
			ret = synthesize_probe_trace_arg(&tev->args[i],
1730
							  buf, 64);
1731
			pev->args[i].name = strdup(buf);
1732
		}
1733 1734 1735
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1736 1737 1738 1739 1740

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1741 1742 1743 1744 1745
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
	struct perf_probe_point *pp = &pev->point;
1746
	struct perf_probe_arg_field *field, *next;
1747 1748
	int i;

1749 1750 1751 1752 1753 1754
	free(pev->event);
	free(pev->group);
	free(pp->file);
	free(pp->function);
	free(pp->lazy_line);

1755
	for (i = 0; i < pev->nargs; i++) {
1756 1757 1758
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
1759 1760 1761
		field = pev->args[i].field;
		while (field) {
			next = field->next;
1762
			zfree(&field->name);
1763 1764 1765 1766
			free(field);
			field = next;
		}
	}
1767
	free(pev->args);
1768 1769 1770
	memset(pev, 0, sizeof(*pev));
}

1771
static void clear_probe_trace_event(struct probe_trace_event *tev)
1772
{
1773
	struct probe_trace_arg_ref *ref, *next;
1774 1775
	int i;

1776 1777 1778 1779
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
	free(tev->point.module);
1780
	for (i = 0; i < tev->nargs; i++) {
1781 1782 1783
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
1784 1785 1786 1787 1788 1789 1790
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
1791
	free(tev->args);
1792
	memset(tev, 0, sizeof(*tev));
1793 1794
}

1795
static void print_open_warning(int err, bool is_kprobe)
1796
{
1797
	char sbuf[STRERR_BUFSIZE];
1798

1799
	if (err == -ENOENT) {
1800 1801 1802 1803 1804 1805 1806
		const char *config;

		if (!is_kprobe)
			config = "CONFIG_UPROBE_EVENTS";
		else
			config = "CONFIG_KPROBE_EVENTS";

1807 1808 1809 1810
		pr_warning("%cprobe_events file does not exist"
			   " - please rebuild kernel with %s.\n",
			   is_kprobe ? 'k' : 'u', config);
	} else if (err == -ENOTSUP)
1811
		pr_warning("Tracefs or debugfs is not mounted.\n");
1812 1813 1814 1815
	else
		pr_warning("Failed to open %cprobe_events: %s\n",
			   is_kprobe ? 'k' : 'u',
			   strerror_r(-err, sbuf, sizeof(sbuf)));
1816 1817
}

1818 1819 1820 1821
static void print_both_open_warning(int kerr, int uerr)
{
	/* Both kprobes and uprobes are disabled, warn it. */
	if (kerr == -ENOTSUP && uerr == -ENOTSUP)
1822
		pr_warning("Tracefs or debugfs is not mounted.\n");
1823 1824 1825 1826
	else if (kerr == -ENOENT && uerr == -ENOENT)
		pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
			   "or/and CONFIG_UPROBE_EVENTS.\n");
	else {
1827
		char sbuf[STRERR_BUFSIZE];
1828 1829 1830 1831 1832 1833 1834
		pr_warning("Failed to open kprobe events: %s.\n",
			   strerror_r(-kerr, sbuf, sizeof(sbuf)));
		pr_warning("Failed to open uprobe events: %s.\n",
			   strerror_r(-uerr, sbuf, sizeof(sbuf)));
	}
}

1835
static int open_probe_events(const char *trace_file, bool readwrite)
1836 1837
{
	char buf[PATH_MAX];
1838
	const char *__debugfs;
1839
	const char *tracing_dir = "";
1840 1841
	int ret;

1842 1843 1844
	__debugfs = tracefs_find_mountpoint();
	if (__debugfs == NULL) {
		tracing_dir = "tracing/";
1845

1846 1847 1848 1849 1850 1851 1852
		__debugfs = debugfs_find_mountpoint();
		if (__debugfs == NULL)
			return -ENOTSUP;
	}

	ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
			 __debugfs, tracing_dir, trace_file);
1853
	if (ret >= 0) {
1854
		pr_debug("Opening %s write=%d\n", buf, readwrite);
1855 1856 1857 1858
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
1859

1860
		if (ret < 0)
1861
			ret = -errno;
1862 1863 1864 1865
	}
	return ret;
}

1866 1867
static int open_kprobe_events(bool readwrite)
{
1868
	return open_probe_events("kprobe_events", readwrite);
1869 1870 1871 1872
}

static int open_uprobe_events(bool readwrite)
{
1873
	return open_probe_events("uprobe_events", readwrite);
1874 1875 1876
}

/* Get raw string list of current kprobe_events  or uprobe_events */
1877
static struct strlist *get_probe_trace_command_rawlist(int fd)
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
{
	int ret, idx;
	FILE *fp;
	char buf[MAX_CMDLEN];
	char *p;
	struct strlist *sl;

	sl = strlist__new(true, NULL);

	fp = fdopen(dup(fd), "r");
	while (!feof(fp)) {
		p = fgets(buf, MAX_CMDLEN, fp);
		if (!p)
			break;

		idx = strlen(p) - 1;
		if (p[idx] == '\n')
			p[idx] = '\0';
		ret = strlist__add(sl, buf);
1897
		if (ret < 0) {
1898
			pr_debug("strlist__add failed (%d)\n", ret);
1899 1900 1901
			strlist__delete(sl);
			return NULL;
		}
1902 1903 1904 1905 1906 1907
	}
	fclose(fp);

	return sl;
}

1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
struct kprobe_blacklist_node {
	struct list_head list;
	unsigned long start;
	unsigned long end;
	char *symbol;
};

static void kprobe_blacklist__delete(struct list_head *blacklist)
{
	struct kprobe_blacklist_node *node;

	while (!list_empty(blacklist)) {
		node = list_first_entry(blacklist,
					struct kprobe_blacklist_node, list);
		list_del(&node->list);
		free(node->symbol);
		free(node);
	}
}

static int kprobe_blacklist__load(struct list_head *blacklist)
{
	struct kprobe_blacklist_node *node;
	const char *__debugfs = debugfs_find_mountpoint();
	char buf[PATH_MAX], *p;
	FILE *fp;
	int ret;

	if (__debugfs == NULL)
		return -ENOTSUP;

	ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
	if (ret < 0)
		return ret;

	fp = fopen(buf, "r");
	if (!fp)
		return -errno;

	ret = 0;
	while (fgets(buf, PATH_MAX, fp)) {
		node = zalloc(sizeof(*node));
		if (!node) {
			ret = -ENOMEM;
			break;
		}
		INIT_LIST_HEAD(&node->list);
		list_add_tail(&node->list, blacklist);
		if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
			ret = -EINVAL;
			break;
		}
		p = strchr(buf, '\t');
		if (p) {
			p++;
			if (p[strlen(p) - 1] == '\n')
				p[strlen(p) - 1] = '\0';
		} else
			p = (char *)"unknown";
		node->symbol = strdup(p);
		if (!node->symbol) {
			ret = -ENOMEM;
			break;
		}
		pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
			  node->start, node->end, node->symbol);
		ret++;
	}
	if (ret < 0)
		kprobe_blacklist__delete(blacklist);
	fclose(fp);

	return ret;
}

static struct kprobe_blacklist_node *
kprobe_blacklist__find_by_address(struct list_head *blacklist,
				  unsigned long address)
{
	struct kprobe_blacklist_node *node;

	list_for_each_entry(node, blacklist, list) {
		if (node->start <= address && address <= node->end)
			return node;
	}

	return NULL;
}

1997
/* Show an event */
1998 1999
static int show_perf_probe_event(struct perf_probe_event *pev,
				 const char *module)
2000
{
2001
	int i, ret;
2002
	char buf[128];
2003
	char *place;
2004

2005 2006
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
2007 2008
	if (!place)
		return -EINVAL;
2009 2010

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
2011
	if (ret < 0)
2012 2013
		return ret;

2014
	pr_info("  %-20s (on %s", buf, place);
2015
	if (module)
2016
		pr_info(" in %s", module);
2017

2018
	if (pev->nargs > 0) {
2019
		pr_info(" with");
2020
		for (i = 0; i < pev->nargs; i++) {
2021 2022 2023 2024
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
2025
			pr_info(" %s", buf);
2026
		}
2027
	}
2028
	pr_info(")\n");
2029
	free(place);
2030
	return ret;
2031 2032
}

2033
static int __show_perf_probe_events(int fd, bool is_kprobe)
2034
{
2035
	int ret = 0;
2036
	struct probe_trace_event tev;
2037
	struct perf_probe_event pev;
2038 2039 2040
	struct strlist *rawlist;
	struct str_node *ent;

2041 2042
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2043

2044
	rawlist = get_probe_trace_command_rawlist(fd);
2045
	if (!rawlist)
2046
		return -ENOMEM;
2047

2048
	strlist__for_each(ent, rawlist) {
2049
		ret = parse_probe_trace_command(ent->s, &tev);
2050
		if (ret >= 0) {
2051 2052
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2053
			if (ret >= 0)
2054 2055
				ret = show_perf_probe_event(&pev,
							    tev.point.module);
2056
		}
2057
		clear_perf_probe_event(&pev);
2058
		clear_probe_trace_event(&tev);
2059 2060
		if (ret < 0)
			break;
2061 2062
	}
	strlist__delete(rawlist);
2063 2064

	return ret;
2065 2066
}

2067 2068 2069
/* List up current perf-probe events */
int show_perf_probe_events(void)
{
2070
	int kp_fd, up_fd, ret;
2071 2072 2073

	setup_pager();

2074
	ret = init_symbol_maps(false);
2075 2076 2077
	if (ret < 0)
		return ret;

2078 2079 2080 2081 2082 2083 2084
	kp_fd = open_kprobe_events(false);
	if (kp_fd >= 0) {
		ret = __show_perf_probe_events(kp_fd, true);
		close(kp_fd);
		if (ret < 0)
			goto out;
	}
2085

2086 2087
	up_fd = open_uprobe_events(false);
	if (kp_fd < 0 && up_fd < 0) {
2088
		print_both_open_warning(kp_fd, up_fd);
2089 2090
		ret = kp_fd;
		goto out;
2091 2092
	}

2093 2094 2095 2096 2097
	if (up_fd >= 0) {
		ret = __show_perf_probe_events(up_fd, false);
		close(up_fd);
	}
out:
2098
	exit_symbol_maps();
2099 2100 2101
	return ret;
}

2102
/* Get current perf-probe event names */
2103
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
2104
{
2105
	char buf[128];
2106 2107
	struct strlist *sl, *rawlist;
	struct str_node *ent;
2108
	struct probe_trace_event tev;
2109
	int ret = 0;
2110

2111
	memset(&tev, 0, sizeof(tev));
2112
	rawlist = get_probe_trace_command_rawlist(fd);
2113 2114
	if (!rawlist)
		return NULL;
2115
	sl = strlist__new(true, NULL);
2116
	strlist__for_each(ent, rawlist) {
2117
		ret = parse_probe_trace_command(ent->s, &tev);
2118 2119
		if (ret < 0)
			break;
2120
		if (include_group) {
2121 2122 2123 2124
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
2125
		} else
2126
			ret = strlist__add(sl, tev.event);
2127
		clear_probe_trace_event(&tev);
2128 2129
		if (ret < 0)
			break;
2130 2131 2132
	}
	strlist__delete(rawlist);

2133 2134 2135 2136
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
2137 2138 2139
	return sl;
}

2140
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
2141
{
2142
	int ret = 0;
2143
	char *buf = synthesize_probe_trace_command(tev);
2144
	char sbuf[STRERR_BUFSIZE];
2145

2146
	if (!buf) {
2147
		pr_debug("Failed to synthesize probe trace event.\n");
2148 2149 2150
		return -EINVAL;
	}

2151
	pr_debug("Writing event: %s\n", buf);
2152 2153
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
2154 2155
		if (ret <= 0) {
			ret = -errno;
2156
			pr_warning("Failed to write event: %s\n",
2157
				   strerror_r(errno, sbuf, sizeof(sbuf)));
2158
		}
2159
	}
2160
	free(buf);
2161
	return ret;
2162 2163
}

2164 2165
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2166 2167
{
	int i, ret;
2168 2169 2170

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
2171
	if (ret < 0) {
2172
		pr_debug("snprintf() failed: %d\n", ret);
2173 2174
		return ret;
	}
2175
	if (!strlist__has_entry(namelist, buf))
2176
		return 0;
2177

2178 2179 2180
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
2181
		return -EEXIST;
2182 2183
	}

2184 2185
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2186
		ret = e_snprintf(buf, len, "%s_%d", base, i);
2187
		if (ret < 0) {
2188
			pr_debug("snprintf() failed: %d\n", ret);
2189 2190
			return ret;
		}
2191 2192 2193
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2194 2195 2196 2197 2198 2199
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
2200 2201
}

2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
/* Warn if the current kernel's uprobe implementation is old */
static void warn_uprobe_event_compat(struct probe_trace_event *tev)
{
	int i;
	char *buf = synthesize_probe_trace_command(tev);

	/* Old uprobe event doesn't support memory dereference */
	if (!tev->uprobes || tev->nargs == 0 || !buf)
		goto out;

	for (i = 0; i < tev->nargs; i++)
		if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
			pr_warning("Please upgrade your kernel to at least "
				   "3.14 to have access to feature %s\n",
				   tev->args[i].value);
			break;
		}
out:
	free(buf);
}

2223 2224
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
2225
				     int ntevs, bool allow_suffix)
2226
{
2227
	int i, fd, ret;
2228
	struct probe_trace_event *tev = NULL;
2229 2230
	char buf[64];
	const char *event, *group;
2231
	struct strlist *namelist;
2232 2233
	LIST_HEAD(blacklist);
	struct kprobe_blacklist_node *node;
2234

2235 2236 2237 2238 2239
	if (pev->uprobes)
		fd = open_uprobe_events(true);
	else
		fd = open_kprobe_events(true);

2240 2241
	if (fd < 0) {
		print_open_warning(fd, !pev->uprobes);
2242
		return fd;
2243 2244
	}

2245
	/* Get current event names */
2246
	namelist = get_probe_trace_event_names(fd, false);
2247 2248 2249 2250
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
2251 2252 2253 2254 2255 2256
	/* Get kprobe blacklist if exists */
	if (!pev->uprobes) {
		ret = kprobe_blacklist__load(&blacklist);
		if (ret < 0)
			pr_debug("No kprobe blacklist support, ignored\n");
	}
2257

2258
	ret = 0;
2259
	pr_info("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2260
	for (i = 0; i < ntevs; i++) {
2261
		tev = &tevs[i];
2262 2263 2264 2265 2266 2267 2268 2269
		/* Ensure that the address is NOT blacklisted */
		node = kprobe_blacklist__find_by_address(&blacklist,
							 tev->point.address);
		if (node) {
			pr_warning("Warning: Skipped probing on blacklisted function: %s\n", node->symbol);
			continue;
		}

2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282
		if (pev->event)
			event = pev->event;
		else
			if (pev->point.function)
				event = pev->point.function;
			else
				event = tev->point.symbol;
		if (pev->group)
			group = pev->group;
		else
			group = PERFPROBE_GROUP;

		/* Get an unused new event name */
2283 2284 2285 2286
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
2287 2288
		event = buf;

2289 2290 2291 2292 2293 2294
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
2295
		ret = write_probe_trace_event(fd, tev);
2296 2297
		if (ret < 0)
			break;
2298 2299 2300 2301 2302 2303 2304 2305
		/* Add added event name to namelist */
		strlist__add(namelist, event);

		/* Trick here - save current event/group */
		event = pev->event;
		group = pev->group;
		pev->event = tev->event;
		pev->group = tev->group;
2306
		show_perf_probe_event(pev, tev->point.module);
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
		/* Trick here - restore current event/group */
		pev->event = (char *)event;
		pev->group = (char *)group;

		/*
		 * Probes after the first probe which comes from same
		 * user input are always allowed to add suffix, because
		 * there might be several addresses corresponding to
		 * one code line.
		 */
		allow_suffix = true;
2318
	}
2319 2320
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2321

2322 2323
	/* Note that it is possible to skip all events because of blacklist */
	if (ret >= 0 && tev->event) {
2324
		/* Show how to use the event. */
2325 2326
		pr_info("\nYou can now use it in all perf tools, such as:\n\n");
		pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
2327 2328
			 tev->event);
	}
2329

2330
	kprobe_blacklist__delete(&blacklist);
2331
	strlist__delete(namelist);
2332
	close(fd);
2333
	return ret;
2334
}
2335

2336
static int find_probe_functions(struct map *map, char *name)
2337
{
2338
	int found = 0;
2339
	struct symbol *sym;
2340

2341
	map__for_each_symbol_by_name(map, name, sym) {
2342 2343
		if (sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL)
			found++;
2344
	}
2345 2346

	return found;
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
}

#define strdup_or_goto(str, label)	\
	({ char *__p = strdup(str); if (!__p) goto label; __p; })

/*
 * Find probe function addresses from map.
 * Return an error or the number of found probe_trace_event
 */
static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
					    struct probe_trace_event **tevs,
					    int max_tevs, const char *target)
2359
{
2360 2361 2362
	struct map *map = NULL;
	struct kmap *kmap = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2363
	struct symbol *sym;
2364
	struct probe_trace_event *tev;
2365 2366
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2367
	int num_matched_functions;
2368
	int ret, i;
2369

2370 2371 2372 2373 2374 2375 2376 2377
	/* Init maps of given executable or kernel */
	if (pev->uprobes)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
	if (!map) {
		ret = -EINVAL;
		goto out;
2378 2379
	}

2380 2381 2382 2383
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2384 2385
	num_matched_functions = find_probe_functions(map, pp->function);
	if (num_matched_functions == 0) {
2386 2387 2388 2389 2390 2391 2392 2393 2394
		pr_err("Failed to find symbol %s in %s\n", pp->function,
			target ? : "kernel");
		ret = -ENOENT;
		goto out;
	} else if (num_matched_functions > max_tevs) {
		pr_err("Too many functions matched in %s\n",
			target ? : "kernel");
		ret = -E2BIG;
		goto out;
2395 2396
	}

2397
	if (!pev->uprobes && !pp->retprobe) {
2398 2399 2400 2401 2402 2403 2404 2405
		kmap = map__kmap(map);
		reloc_sym = kmap->ref_reloc_sym;
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2406

2407 2408 2409
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2410
		ret = -ENOMEM;
2411
		goto out;
2412
	}
2413

2414
	ret = 0;
2415

2416
	map__for_each_symbol_by_name(map, pp->function, sym) {
2417 2418 2419 2420 2421
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2422
		}
2423
		ret++;
2424

2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449
		if (pp->offset > sym->end - sym->start) {
			pr_warning("Offset %ld is bigger than the size of %s\n",
				   pp->offset, sym->name);
			ret = -ENOENT;
			goto err_out;
		}
		/* Add one probe point */
		tp->address = map->unmap_ip(map, sym->start) + pp->offset;
		if (reloc_sym) {
			tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
			tp->offset = tp->address - reloc_sym->addr;
		} else {
			tp->symbol = strdup_or_goto(sym->name, nomem_out);
			tp->offset = pp->offset;
		}
		tp->retprobe = pp->retprobe;
		if (target)
			tev->point.module = strdup_or_goto(target, nomem_out);
		tev->uprobes = pev->uprobes;
		tev->nargs = pev->nargs;
		if (tev->nargs) {
			tev->args = zalloc(sizeof(struct probe_trace_arg) *
					   tev->nargs);
			if (tev->args == NULL)
				goto nomem_out;
2450
		}
2451
		for (i = 0; i < tev->nargs; i++) {
2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
			if (pev->args[i].name)
				tev->args[i].name =
					strdup_or_goto(pev->args[i].name,
							nomem_out);

			tev->args[i].value = strdup_or_goto(pev->args[i].var,
							    nomem_out);
			if (pev->args[i].type)
				tev->args[i].type =
					strdup_or_goto(pev->args[i].type,
							nomem_out);
2463
		}
2464 2465
	}

2466 2467 2468 2469 2470 2471 2472
out:
	if (map && pev->uprobes) {
		/* Only when using uprobe(exec) map needs to be released */
		dso__delete(map->dso);
		map__delete(map);
	}
	return ret;
2473

2474 2475 2476 2477 2478 2479 2480
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2481

2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
					  struct probe_trace_event **tevs,
					  int max_tevs, const char *target)
{
	int ret;

	if (pev->uprobes && !pev->group) {
		/* Replace group name if not given */
		ret = convert_exec_to_group(target, &pev->group);
		if (ret != 0) {
			pr_warning("Failed to make a group name.\n");
			return ret;
		}
2495
	}
2496

2497 2498 2499 2500 2501 2502
	/* Convert perf_probe_event with debuginfo */
	ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

	return find_probe_trace_events_from_map(pev, tevs, max_tevs, target);
2503 2504 2505 2506
}

struct __event_package {
	struct perf_probe_event		*pev;
2507
	struct probe_trace_event	*tevs;
2508 2509 2510
	int				ntevs;
};

2511
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2512
			  int max_tevs, const char *target, bool force_add)
2513
{
2514
	int i, j, ret;
2515 2516
	struct __event_package *pkgs;

2517
	ret = 0;
2518
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
2519

2520 2521
	if (pkgs == NULL)
		return -ENOMEM;
2522

2523
	ret = init_symbol_maps(pevs->uprobes);
2524 2525
	if (ret < 0) {
		free(pkgs);
2526
		return ret;
2527
	}
2528 2529 2530 2531 2532

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
2533
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
2534 2535
						     &pkgs[i].tevs,
						     max_tevs,
2536
						     target);
2537 2538 2539
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
2540 2541
	}

2542
	/* Loop 2: add all events */
2543
	for (i = 0; i < npevs; i++) {
2544
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2545
						pkgs[i].ntevs, force_add);
2546 2547 2548
		if (ret < 0)
			break;
	}
2549
end:
2550 2551
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
2552
		for (j = 0; j < pkgs[i].ntevs; j++)
2553
			clear_probe_trace_event(&pkgs[i].tevs[j]);
2554
		zfree(&pkgs[i].tevs);
2555 2556
	}
	free(pkgs);
2557
	exit_symbol_maps();
2558 2559

	return ret;
2560 2561
}

2562
static int __del_trace_probe_event(int fd, struct str_node *ent)
2563 2564 2565
{
	char *p;
	char buf[128];
2566
	int ret;
2567

2568
	/* Convert from perf-probe event to trace-probe event */
2569 2570 2571 2572
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

2573
	p = strchr(buf + 2, ':');
2574 2575 2576 2577 2578 2579
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
2580 2581
	*p = '/';

2582 2583
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
2584 2585
	if (ret < 0) {
		ret = -errno;
2586
		goto error;
2587
	}
2588

2589
	pr_info("Removed event: %s\n", ent->s);
2590 2591
	return 0;
error:
2592 2593
	pr_warning("Failed to delete event: %s\n",
		   strerror_r(-ret, buf, sizeof(buf)));
2594
	return ret;
2595 2596
}

2597 2598
static int del_trace_probe_event(int fd, const char *buf,
						  struct strlist *namelist)
2599
{
2600
	struct str_node *ent, *n;
2601
	int ret = -1;
2602

2603 2604 2605
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
2606
				ret = __del_trace_probe_event(fd, ent);
2607 2608
				if (ret < 0)
					break;
2609 2610 2611 2612 2613
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
2614
			ret = __del_trace_probe_event(fd, ent);
2615 2616
			if (ret >= 0)
				strlist__remove(namelist, ent);
2617 2618
		}
	}
2619 2620

	return ret;
2621 2622
}

2623
int del_perf_probe_events(struct strlist *dellist)
2624
{
2625 2626
	int ret = -1, ufd = -1, kfd = -1;
	char buf[128];
2627 2628 2629
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
2630
	struct strlist *namelist = NULL, *unamelist = NULL;
2631

2632
	/* Get current event names */
2633
	kfd = open_kprobe_events(true);
2634 2635
	if (kfd >= 0)
		namelist = get_probe_trace_event_names(kfd, true);
2636 2637

	ufd = open_uprobe_events(true);
2638
	if (ufd >= 0)
2639 2640
		unamelist = get_probe_trace_event_names(ufd, true);

2641 2642 2643 2644 2645
	if (kfd < 0 && ufd < 0) {
		print_both_open_warning(kfd, ufd);
		goto error;
	}

2646 2647
	if (namelist == NULL && unamelist == NULL)
		goto error;
2648

2649
	strlist__for_each(ent, dellist) {
2650 2651 2652
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
2653
			goto error;
2654
		}
2655
		pr_debug("Parsing: %s\n", str);
2656 2657 2658 2659 2660 2661
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
2662
			group = "*";
2663 2664
			event = str;
		}
2665 2666 2667 2668 2669 2670 2671 2672

		ret = e_snprintf(buf, 128, "%s:%s", group, event);
		if (ret < 0) {
			pr_err("Failed to copy event.");
			free(str);
			goto error;
		}

2673
		pr_debug("Group: %s, Event: %s\n", group, event);
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683

		if (namelist)
			ret = del_trace_probe_event(kfd, buf, namelist);

		if (unamelist && ret != 0)
			ret = del_trace_probe_event(ufd, buf, unamelist);

		if (ret != 0)
			pr_info("Info: Event \"%s\" does not exist.\n", buf);

2684 2685
		free(str);
	}
2686 2687 2688

error:
	if (kfd >= 0) {
2689
		strlist__delete(namelist);
2690 2691 2692 2693
		close(kfd);
	}

	if (ufd >= 0) {
2694
		strlist__delete(unamelist);
2695 2696
		close(ufd);
	}
2697 2698

	return ret;
2699
}
2700

2701 2702
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2703

2704
/*
2705 2706
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2707
 */
2708
static int filter_available_functions(struct map *map __maybe_unused,
2709
				      struct symbol *sym)
2710
{
2711
	if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2712 2713 2714
	    strfilter__compare(available_func_filter, sym->name))
		return 0;
	return 1;
2715 2716
}

2717 2718
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
2719 2720 2721 2722
{
	struct map *map;
	int ret;

2723
	ret = init_symbol_maps(user);
2724 2725 2726
	if (ret < 0)
		return ret;

2727 2728 2729 2730 2731
	/* Get a symbol map */
	if (user)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
2732
	if (!map) {
2733
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2734 2735
		return -EINVAL;
	}
2736

2737
	/* Load symbols with given filter */
2738
	available_func_filter = _filter;
2739 2740 2741 2742 2743 2744
	if (map__load(map, filter_available_functions)) {
		pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
		goto end;
	}
	if (!dso__sorted_by_name(map->dso, map->type))
		dso__sort_by_name(map->dso, map->type);
2745

2746 2747 2748 2749 2750 2751 2752 2753 2754
	/* Show all (filtered) symbols */
	setup_pager();
	dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
end:
	if (user) {
		dso__delete(map->dso);
		map__delete(map);
	}
	exit_symbol_maps();
2755

2756
	return ret;
2757 2758
}