probe-event.c 78.4 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/fs.h>
44
#include "trace-event.h"	/* For __maybe_unused */
45
#include "probe-event.h"
46
#include "probe-finder.h"
47
#include "probe-file.h"
48
#include "session.h"
49 50 51 52

#define MAX_CMDLEN 256
#define PERFPROBE_GROUP "probe"

53
bool probe_event_dry_run;	/* Dry run flag */
54
struct probe_conf probe_conf;
55

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

58
int e_snprintf(char *str, size_t size, const char *format, ...)
59 60 61 62 63 64 65 66 67 68 69
{
	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;
}

70
static struct machine *host_machine;
71

72
/* Initialize symbol maps and path of vmlinux/modules */
73
int init_probe_symbol_maps(bool user_only)
74
{
75 76
	int ret;

77
	symbol_conf.sort_by_name = true;
78
	symbol_conf.allow_aliases = true;
79
	ret = symbol__init(NULL);
80 81 82 83
	if (ret < 0) {
		pr_debug("Failed to init symbol map.\n");
		goto out;
	}
84

85 86
	if (host_machine || user_only)	/* already initialized */
		return 0;
87

88 89 90 91 92 93 94 95
	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;
96
	}
97 98 99 100
out:
	if (ret < 0)
		pr_warning("Failed to init vmlinux path.\n");
	return ret;
101 102
}

103
void exit_probe_symbol_maps(void)
104
{
105 106
	machine__delete(host_machine);
	host_machine = NULL;
107 108 109
	symbol__exit();
}

110 111 112
static struct symbol *__find_kernel_function_by_name(const char *name,
						     struct map **mapp)
{
113
	return machine__find_kernel_function_by_name(host_machine, name, mapp);
114 115
}

116 117
static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
{
118
	return machine__find_kernel_function(host_machine, addr, mapp);
119 120 121 122 123 124
}

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;
125
	struct map *map = machine__kernel_map(host_machine);
126

127
	if (map__load(map) < 0)
128 129
		return NULL;

130
	kmap = map__kmap(map);
131 132
	if (!kmap)
		return NULL;
133 134 135
	return kmap->ref_reloc_sym;
}

136 137
static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
					     bool reloc, bool reladdr)
138 139 140 141 142 143 144 145
{
	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)
146
		*addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
147 148
	else {
		sym = __find_kernel_function_by_name(name, &map);
149 150 151 152 153
		if (!sym)
			return -ENOENT;
		*addr = map->unmap_ip(map, sym->start) -
			((reloc) ? 0 : map->reloc) -
			((reladdr) ? map->start : 0);
154 155 156 157
	}
	return 0;
}

158 159
static struct map *kernel_get_module_map(const char *module)
{
160
	struct map_groups *grp = &host_machine->kmaps;
161
	struct maps *maps = &grp->maps[MAP__FUNCTION];
162
	struct map *pos;
163

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

168 169 170
	if (!module)
		module = "kernel";

171
	for (pos = maps__first(maps); pos; pos = map__next(pos)) {
172
		/* short_name is "[module]" */
173
		if (strncmp(pos->dso->short_name + 1, module,
174 175
			    pos->dso->short_name_len - 2) == 0 &&
		    module[pos->dso->short_name_len - 2] == '\0') {
176
			map__get(pos);
177 178 179 180 181 182
			return pos;
		}
	}
	return NULL;
}

183
struct map *get_target_map(const char *target, bool user)
184 185 186 187 188 189 190 191
{
	/* Init maps of given executable or kernel */
	if (user)
		return dso__new_map(target);
	else
		return kernel_get_module_map(target);
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
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;
	}

208
	for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
209 210 211 212 213 214
		if (!isalnum(*ptr2) && *ptr2 != '_') {
			*ptr2 = '\0';
			break;
		}
	}

215 216 217 218 219 220 221 222 223 224 225 226
	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;
}

227 228 229 230 231 232 233
static void clear_perf_probe_point(struct perf_probe_point *pp)
{
	free(pp->file);
	free(pp->function);
	free(pp->lazy_line);
}

234 235 236 237 238 239 240 241
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);
}

242 243 244
static bool kprobe_blacklist__listed(unsigned long address);
static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
{
245 246
	u64 etext_addr = 0;
	int ret;
247

248
	/* Get the address of _etext for checking non-probable text symbol */
249 250
	ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
						false, false);
251

252
	if (ret == 0 && etext_addr < address)
253 254 255 256 257 258 259 260 261
		pr_warning("%s is out of .text, skip it.\n", symbol);
	else if (kprobe_blacklist__listed(address))
		pr_warning("%s is blacklisted function, skip it.\n", symbol);
	else
		return false;

	return true;
}

262 263 264 265 266 267 268 269 270 271 272 273 274 275
/*
 * @module can be module name of module file path. In case of path,
 * inspect elf and find out what is actual module name.
 * Caller has to free mod_name after using it.
 */
static char *find_module_name(const char *module)
{
	int fd;
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;
	Elf_Data *data;
	Elf_Scn *sec;
	char *mod_name = NULL;
276
	int name_offset;
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297

	fd = open(module, O_RDONLY);
	if (fd < 0)
		return NULL;

	elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
	if (elf == NULL)
		goto elf_err;

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

	sec = elf_section_by_name(elf, &ehdr, &shdr,
			".gnu.linkonce.this_module", NULL);
	if (!sec)
		goto ret_err;

	data = elf_getdata(sec, NULL);
	if (!data || !data->d_buf)
		goto ret_err;

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	/*
	 * NOTE:
	 * '.gnu.linkonce.this_module' section of kernel module elf directly
	 * maps to 'struct module' from linux/module.h. This section contains
	 * actual module name which will be used by kernel after loading it.
	 * But, we cannot use 'struct module' here since linux/module.h is not
	 * exposed to user-space. Offset of 'name' has remained same from long
	 * time, so hardcoding it here.
	 */
	if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
		name_offset = 12;
	else	/* expect ELFCLASS64 by default */
		name_offset = 24;

	mod_name = strdup((char *)data->d_buf + name_offset);
313 314 315 316 317 318 319 320

ret_err:
	elf_end(elf);
elf_err:
	close(fd);
	return mod_name;
}

321
#ifdef HAVE_DWARF_SUPPORT
322 323 324 325 326 327 328 329 330

static int kernel_get_module_dso(const char *module, struct dso **pdso)
{
	struct dso *dso;
	struct map *map;
	const char *vmlinux_name;
	int ret = 0;

	if (module) {
331 332 333 334 335 336 337
		char module_name[128];

		snprintf(module_name, sizeof(module_name), "[%s]", module);
		map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
		if (map) {
			dso = map->dso;
			goto found;
338 339 340 341 342
		}
		pr_debug("Failed to find module %s.\n", module);
		return -ENOENT;
	}

343
	map = machine__kernel_map(host_machine);
344 345 346 347 348
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	dso->load_errno = 0;
	if (vmlinux_name)
349
		ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
350
	else
351
		ret = dso__load_vmlinux_path(dso, map);
352 353 354 355 356
found:
	*pdso = dso;
	return ret;
}

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
/*
 * Some binaries like glibc have special symbols which are on the symbol
 * table, but not in the debuginfo. If we can find the address of the
 * symbol from map, we can translate the address back to the probe point.
 */
static int find_alternative_probe_point(struct debuginfo *dinfo,
					struct perf_probe_point *pp,
					struct perf_probe_point *result,
					const char *target, bool uprobes)
{
	struct map *map = NULL;
	struct symbol *sym;
	u64 address = 0;
	int ret = -ENOENT;

	/* This can work only for function-name based one */
	if (!pp->function || pp->file)
		return -ENOTSUP;

	map = get_target_map(target, uprobes);
	if (!map)
		return -EINVAL;

	/* Find the address of given function */
	map__for_each_symbol_by_name(map, pp->function, sym) {
382 383 384
		if (uprobes)
			address = sym->start;
		else
385
			address = map->unmap_ip(map, sym->start) - map->reloc;
386
		break;
387 388 389 390 391
	}
	if (!address) {
		ret = -ENOENT;
		goto out;
	}
W
Wang Nan 已提交
392 393
	pr_debug("Symbol %s address found : %" PRIx64 "\n",
			pp->function, address);
394 395 396 397 398 399 400 401

	ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
					  result);
	if (ret <= 0)
		ret = (!ret) ? -ENOENT : ret;
	else {
		result->offset += pp->offset;
		result->line += pp->line;
402
		result->retprobe = pp->retprobe;
403 404 405 406
		ret = 0;
	}

out:
407
	map__put(map);
408 409 410 411 412 413
	return ret;

}

static int get_alternative_probe_event(struct debuginfo *dinfo,
				       struct perf_probe_event *pev,
414
				       struct perf_probe_point *tmp)
415 416 417 418 419 420
{
	int ret;

	memcpy(tmp, &pev->point, sizeof(*tmp));
	memset(&pev->point, 0, sizeof(pev->point));
	ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
421
					   pev->target, pev->uprobes);
422 423 424 425 426
	if (ret < 0)
		memcpy(&pev->point, tmp, sizeof(*tmp));

	return ret;
}
427

428 429 430 431
static int get_alternative_line_range(struct debuginfo *dinfo,
				      struct line_range *lr,
				      const char *target, bool user)
{
432 433 434 435
	struct perf_probe_point pp = { .function = lr->function,
				       .file = lr->file,
				       .line = lr->start };
	struct perf_probe_point result;
436 437
	int ret, len = 0;

438 439
	memset(&result, 0, sizeof(result));

440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
	if (lr->end != INT_MAX)
		len = lr->end - lr->start;
	ret = find_alternative_probe_point(dinfo, &pp, &result,
					   target, user);
	if (!ret) {
		lr->function = result.function;
		lr->file = result.file;
		lr->start = result.line;
		if (lr->end != INT_MAX)
			lr->end = lr->start + len;
		clear_perf_probe_point(&pp);
	}
	return ret;
}

455
/* Open new debuginfo of given module */
456
static struct debuginfo *open_debuginfo(const char *module, bool silent)
457
{
458
	const char *path = module;
459 460 461 462
	char reason[STRERR_BUFSIZE];
	struct debuginfo *ret = NULL;
	struct dso *dso = NULL;
	int err;
463

464
	if (!module || !strchr(module, '/')) {
465 466 467
		err = kernel_get_module_dso(module, &dso);
		if (err < 0) {
			if (!dso || dso->load_errno == 0) {
468
				if (!str_error_r(-err, reason, STRERR_BUFSIZE))
469 470 471
					strcpy(reason, "(unknown)");
			} else
				dso__strerror_load(dso, reason, STRERR_BUFSIZE);
472
			if (!silent)
473 474
				pr_err("Failed to find the path for %s: %s\n",
					module ?: "kernel", reason);
475 476
			return NULL;
		}
477
		path = dso->long_name;
478
	}
479 480 481 482 483 484 485 486 487 488
	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;
489
}
490

491 492 493 494 495 496
/* For caching the last debuginfo */
static struct debuginfo *debuginfo_cache;
static char *debuginfo_cache_path;

static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
{
497 498 499 500 501 502 503
	const char *path = module;

	/* If the module is NULL, it should be the kernel. */
	if (!module)
		path = "kernel";

	if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
504 505 506 507
		goto out;

	/* Copy module path */
	free(debuginfo_cache_path);
508 509 510 511 512
	debuginfo_cache_path = strdup(path);
	if (!debuginfo_cache_path) {
		debuginfo__delete(debuginfo_cache);
		debuginfo_cache = NULL;
		goto out;
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
	}

	debuginfo_cache = open_debuginfo(module, silent);
	if (!debuginfo_cache)
		zfree(&debuginfo_cache_path);
out:
	return debuginfo_cache;
}

static void debuginfo_cache__exit(void)
{
	debuginfo__delete(debuginfo_cache);
	debuginfo_cache = NULL;
	zfree(&debuginfo_cache_path);
}

529

530 531 532 533 534 535 536 537 538 539 540 541
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);
542 543 544 545
	if (elf == NULL) {
		ret = -EINVAL;
		goto out_close;
	}
546 547 548 549 550 551 552 553 554 555 556

	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);
557 558 559
out_close:
	close(fd);

560 561 562
	return ret;
}

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
/*
 * 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;
585
	} else if (tp->symbol) {
586 587 588 589
		/* If the module is given, this returns relative address */
		ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
							false, !!tp->module);
		if (ret != 0)
590 591 592 593 594 595 596
			goto error;
		addr += tp->offset;
	}

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

597 598
	dinfo = debuginfo_cache__open(tp->module, verbose == 0);
	if (dinfo)
599 600
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
601
	else
602 603 604 605 606 607 608 609 610 611 612
		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;
}

613 614 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 650 651 652 653 654 655 656 657
/*
 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
 * and generate new symbols with suffixes such as .constprop.N or .isra.N
 * etc. Since those symbols are not recorded in DWARF, we have to find
 * correct generated symbols from offline ELF binary.
 * For online kernel or uprobes we don't need this because those are
 * rebased on _text, or already a section relative address.
 */
static int
post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
					int ntevs, const char *pathname)
{
	struct symbol *sym;
	struct map *map;
	unsigned long stext = 0;
	u64 addr;
	int i;

	/* Prepare a map for offline binary */
	map = dso__new_map(pathname);
	if (!map || get_text_start_address(pathname, &stext) < 0) {
		pr_warning("Failed to get ELF symbols for %s\n", pathname);
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
		addr = tevs[i].point.address + tevs[i].point.offset - stext;
		sym = map__find_symbol(map, addr);
		if (!sym)
			continue;
		if (!strcmp(sym->name, tevs[i].point.symbol))
			continue;
		/* If we have no realname, use symbol for it */
		if (!tevs[i].point.realname)
			tevs[i].point.realname = tevs[i].point.symbol;
		else
			free(tevs[i].point.symbol);
		tevs[i].point.symbol = strdup(sym->name);
		tevs[i].point.offset = addr - sym->start;
	}
	map__put(map);

	return 0;
}

658 659 660 661
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
662
	unsigned long stext = 0;
663 664 665 666 667 668 669 670 671

	if (!exec)
		return 0;

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

	for (i = 0; i < ntevs && ret >= 0; i++) {
672
		/* point.address is the addres of point.symbol + point.offset */
673
		tevs[i].point.address -= stext;
674
		tevs[i].point.module = strdup(exec);
675
		if (!tevs[i].point.module) {
676 677 678 679 680 681 682 683 684
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

685 686 687
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
688
	int i, ret = 0;
689
	char *mod_name = NULL;
690 691 692 693

	if (!module)
		return 0;

694
	mod_name = find_module_name(module);
695

696
	for (i = 0; i < ntevs; i++) {
697 698
		tevs[i].point.module =
			strdup(mod_name ? mod_name : module);
699 700 701 702
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
703
	}
704

705
	free(mod_name);
706
	return ret;
707 708
}

709 710 711
static int
post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
				       int ntevs)
712 713 714
{
	struct ref_reloc_sym *reloc_sym;
	char *tmp;
715
	int i, skipped = 0;
716

717 718
	/* Skip post process if the target is an offline kernel */
	if (symbol_conf.ignore_vmlinux_buildid)
719 720
		return post_process_offline_probe_trace_events(tevs, ntevs,
						symbol_conf.vmlinux_name);
721

722
	reloc_sym = kernel_get_ref_reloc_sym();
723 724 725 726 727 728
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
729 730 731 732 733 734 735 736 737 738 739
		if (!tevs[i].point.address || tevs[i].point.retprobe)
			continue;
		/* If we found a wrong one, mark it by NULL symbol */
		if (kprobe_warn_out_range(tevs[i].point.symbol,
					  tevs[i].point.address)) {
			tmp = NULL;
			skipped++;
		} else {
			tmp = strdup(reloc_sym->name);
			if (!tmp)
				return -ENOMEM;
740
		}
741 742 743 744 745 746 747 748
		/* If we have no realname, use symbol for it */
		if (!tevs[i].point.realname)
			tevs[i].point.realname = tevs[i].point.symbol;
		else
			free(tevs[i].point.symbol);
		tevs[i].point.symbol = tmp;
		tevs[i].point.offset = tevs[i].point.address -
				       reloc_sym->unrelocated_addr;
749
	}
750
	return skipped;
751 752
}

753 754 755 756 757 758
void __weak
arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
				      int ntevs __maybe_unused)
{
}

759
/* Post processing the probe events */
760 761
static int post_process_probe_trace_events(struct perf_probe_event *pev,
					   struct probe_trace_event *tevs,
762 763 764
					   int ntevs, const char *module,
					   bool uprobe)
{
765
	int ret;
766

767 768 769
	if (uprobe)
		ret = add_exec_to_probe_trace_events(tevs, ntevs, module);
	else if (module)
770
		/* Currently ref_reloc_sym based probe is not for drivers */
771 772 773
		ret = add_module_to_probe_trace_events(tevs, ntevs, module);
	else
		ret = post_process_kernel_probe_trace_events(tevs, ntevs);
774

775 776 777 778
	if (ret >= 0)
		arch__post_process_probe_trace_events(pev, ntevs);

	return ret;
779 780
}

781
/* Try to find perf_probe_event with debuginfo */
782
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
783
					  struct probe_trace_event **tevs)
784 785
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
786
	struct perf_probe_point tmp;
787
	struct debuginfo *dinfo;
788
	int ntevs, ret = 0;
789

790
	dinfo = open_debuginfo(pev->target, !need_dwarf);
791
	if (!dinfo) {
792
		if (need_dwarf)
793 794
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
795 796 797
		return 0;
	}

798
	pr_debug("Try to find probe point from debuginfo.\n");
799
	/* Searching trace events corresponding to a probe event */
800
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
801

802
	if (ntevs == 0)	{  /* Not found, retry with an alternative */
803
		ret = get_alternative_probe_event(dinfo, pev, &tmp);
804
		if (!ret) {
805
			ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
806 807 808 809 810 811 812 813 814
			/*
			 * Write back to the original probe_event for
			 * setting appropriate (user given) event name
			 */
			clear_perf_probe_point(&pev->point);
			memcpy(&pev->point, &tmp, sizeof(tmp));
		}
	}

815
	debuginfo__delete(dinfo);
816

817
	if (ntevs > 0) {	/* Succeeded to find trace events */
818
		pr_debug("Found %d probe_trace_events.\n", ntevs);
819
		ret = post_process_probe_trace_events(pev, *tevs, ntevs,
820
						pev->target, pev->uprobes);
821
		if (ret < 0 || ret == ntevs) {
822 823 824
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
825 826 827 828
		if (ret != ntevs)
			return ret < 0 ? ret : ntevs;
		ntevs = 0;
		/* Fall through */
829
	}
830

831
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
832
		pr_warning("Probe point '%s' not found.\n",
833
			   synthesize_perf_probe_point(&pev->point));
834
		return -ENOENT;
835 836
	}
	/* Error path : ntevs < 0 */
837
	pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
838 839 840 841
	if (ntevs < 0) {
		if (ntevs == -EBADF)
			pr_warning("Warning: No dwarf info found in the vmlinux - "
				"please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
842
		if (!need_dwarf) {
M
Masami Hiramatsu 已提交
843
			pr_debug("Trying to use symbols.\n");
844 845
			return 0;
		}
846
	}
847
	return ntevs;
848 849 850 851 852
}

#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

853
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
854
{
855
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
856 857
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
858

859
	do {
860 861
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
862 863 864 865 866
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
867
		}
868 869 870
		color_fprintf(stdout, color, "%s", buf);

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

872
	return 1;
873
error:
874
	if (ferror(fp)) {
875
		pr_warning("File read error: %s\n",
876
			   str_error_r(errno, sbuf, sizeof(sbuf)));
877 878 879 880
		return -1;
	}
	return 0;
}
881

882 883 884 885 886 887 888 889
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;
890 891
}

892 893 894 895 896
#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)

897 898 899 900
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
901 902
static int __show_line_range(struct line_range *lr, const char *module,
			     bool user)
903
{
904
	int l = 1;
905
	struct int_node *ln;
906
	struct debuginfo *dinfo;
907
	FILE *fp;
908
	int ret;
909
	char *tmp;
910
	char sbuf[STRERR_BUFSIZE];
911 912

	/* Search a line range */
913 914
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
915
		return -ENOENT;
916

917
	ret = debuginfo__find_line_range(dinfo, lr);
918 919 920 921 922
	if (!ret) {	/* Not found, retry with an alternative */
		ret = get_alternative_line_range(dinfo, lr, module, user);
		if (!ret)
			ret = debuginfo__find_line_range(dinfo, lr);
	}
923
	debuginfo__delete(dinfo);
924
	if (ret == 0 || ret == -ENOENT) {
925 926 927
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
928
		pr_warning("Debuginfo analysis failed.\n");
929 930
		return ret;
	}
931

932 933
	/* Convert source file path */
	tmp = lr->path;
934
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
935 936 937 938 939

	/* Free old path when new path is assigned */
	if (tmp != lr->path)
		free(tmp);

940
	if (ret < 0) {
941
		pr_warning("Failed to find source file path.\n");
942 943 944
		return ret;
	}

945 946 947
	setup_pager();

	if (lr->function)
948
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
949 950
			lr->start - lr->offset);
	else
951
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
952 953

	fp = fopen(lr->path, "r");
954 955
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
956
			   str_error_r(errno, sbuf, sizeof(sbuf)));
957 958
		return -errno;
	}
959
	/* Skip to starting line number */
960
	while (l < lr->start) {
961
		ret = skip_one_line(fp, l++);
962 963 964
		if (ret < 0)
			goto end;
	}
965

966
	intlist__for_each_entry(ln, lr->line_list) {
967
		for (; ln->i > l; l++) {
968
			ret = show_one_line(fp, l - lr->offset);
969 970 971
			if (ret < 0)
				goto end;
		}
972
		ret = show_one_line_with_num(fp, l++ - lr->offset);
973 974
		if (ret < 0)
			goto end;
975 976 977 978
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
979 980 981
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
982 983
			break;
	}
984
end:
985
	fclose(fp);
986
	return ret;
987 988
}

989
int show_line_range(struct line_range *lr, const char *module, bool user)
990 991 992
{
	int ret;

993
	ret = init_probe_symbol_maps(user);
994 995
	if (ret < 0)
		return ret;
996
	ret = __show_line_range(lr, module, user);
997
	exit_probe_symbol_maps();
998 999 1000 1001

	return ret;
}

1002 1003
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
1004
				  struct strfilter *_filter)
1005 1006
{
	char *buf;
1007
	int ret, i, nvars;
1008 1009
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
1010
	struct perf_probe_point tmp;
1011
	const char *var;
1012 1013 1014 1015 1016 1017

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

1018
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
1019
	if (!ret) {  /* Not found, retry with an alternative */
1020
		ret = get_alternative_probe_event(dinfo, pev, &tmp);
1021 1022
		if (!ret) {
			ret = debuginfo__find_available_vars_at(dinfo, pev,
1023
								&vls);
1024 1025 1026 1027
			/* Release the old probe_point */
			clear_perf_probe_point(&tmp);
		}
	}
1028
	if (ret <= 0) {
1029 1030 1031 1032 1033
		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");
1034 1035
		goto end;
	}
1036

1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
	/* 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);
1047
		zfree(&vl->point.symbol);
1048 1049
		nvars = 0;
		if (vl->vars) {
1050
			strlist__for_each_entry(node, vl->vars) {
1051 1052
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
1053
					fprintf(stdout, "\t\t%s\n", node->s);
1054 1055 1056 1057
					nvars++;
				}
			}
			strlist__delete(vl->vars);
1058
		}
1059 1060 1061 1062 1063
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
1064 1065 1066 1067 1068 1069
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
1070
			struct strfilter *_filter)
1071
{
1072 1073
	int i, ret = 0;
	struct debuginfo *dinfo;
1074

1075
	ret = init_probe_symbol_maps(pevs->uprobes);
1076 1077 1078
	if (ret < 0)
		return ret;

1079
	dinfo = open_debuginfo(pevs->target, false);
1080
	if (!dinfo) {
1081 1082
		ret = -ENOENT;
		goto out;
1083 1084
	}

1085 1086
	setup_pager();

1087
	for (i = 0; i < npevs && ret >= 0; i++)
1088
		ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1089 1090

	debuginfo__delete(dinfo);
1091
out:
1092
	exit_probe_symbol_maps();
1093 1094 1095
	return ret;
}

1096
#else	/* !HAVE_DWARF_SUPPORT */
1097

1098 1099 1100 1101
static void debuginfo_cache__exit(void)
{
}

1102 1103 1104 1105
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)
1106
{
1107
	return -ENOSYS;
1108 1109
}

1110
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1111
				struct probe_trace_event **tevs __maybe_unused)
1112
{
1113 1114 1115 1116
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
1117

1118 1119 1120
	return 0;
}

1121
int show_line_range(struct line_range *lr __maybe_unused,
1122 1123
		    const char *module __maybe_unused,
		    bool user __maybe_unused)
1124
{
1125 1126
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
1127 1128
}

1129
int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1130 1131
			int npevs __maybe_unused,
			struct strfilter *filter __maybe_unused)
1132 1133 1134 1135
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
1136 1137
#endif

1138 1139 1140 1141 1142 1143
void line_range__clear(struct line_range *lr)
{
	free(lr->function);
	free(lr->file);
	free(lr->path);
	free(lr->comp_dir);
1144
	intlist__delete(lr->line_list);
1145 1146 1147
	memset(lr, 0, sizeof(*lr));
}

1148
int line_range__init(struct line_range *lr)
1149 1150
{
	memset(lr, 0, sizeof(*lr));
1151 1152 1153 1154 1155
	lr->line_list = intlist__new(NULL);
	if (!lr->line_list)
		return -ENOMEM;
	else
		return 0;
1156 1157
}

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
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;
}

1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
/* Check the name is good for event, group or function */
static bool is_c_func_name(const char *name)
{
	if (!isalpha(*name) && *name != '_')
		return false;
	while (*++name != '\0') {
		if (!isalpha(*name) && !isdigit(*name) && *name != '_')
			return false;
	}
	return true;
}

1183 1184 1185 1186 1187
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1188
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1189
 */
1190
int parse_line_range_desc(const char *arg, struct line_range *lr)
1191
{
1192
	char *range, *file, *name = strdup(arg);
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
	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--;
			}
		}
1227

1228
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1229 1230

		err = -EINVAL;
1231
		if (lr->start > lr->end) {
1232
			semantic_error("Start line must be smaller"
1233
				       " than end line.\n");
1234
			goto err;
1235
		}
1236 1237 1238
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
1239
		}
1240
	}
1241

1242 1243 1244 1245 1246 1247 1248 1249 1250
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
1251
	} else if (strchr(name, '/') || strchr(name, '.'))
1252
		lr->file = name;
1253
	else if (is_c_func_name(name))/* We reuse it for checking funcname */
1254
		lr->function = name;
1255 1256 1257 1258 1259
	else {	/* Invalid name */
		semantic_error("'%s' is not a valid function name.\n", name);
		err = -EINVAL;
		goto err;
	}
1260 1261

	return 0;
1262 1263 1264
err:
	free(name);
	return err;
1265 1266
}

1267 1268 1269 1270 1271 1272 1273
static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
{
	char *ptr;

	ptr = strchr(*arg, ':');
	if (ptr) {
		*ptr = '\0';
1274
		if (!pev->sdt && !is_c_func_name(*arg))
1275 1276 1277 1278 1279 1280 1281
			goto ng_name;
		pev->group = strdup(*arg);
		if (!pev->group)
			return -ENOMEM;
		*arg = ptr + 1;
	} else
		pev->group = NULL;
1282
	if (!pev->sdt && !is_c_func_name(*arg)) {
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
ng_name:
		semantic_error("%s is bad for event name -it must "
			       "follow C symbol-naming rule.\n", *arg);
		return -EINVAL;
	}
	pev->event = strdup(*arg);
	if (pev->event == NULL)
		return -ENOMEM;

	return 0;
}

1295
/* Parse probepoint definition. */
1296
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1297
{
1298
	struct perf_probe_point *pp = &pev->point;
1299 1300
	char *ptr, *tmp;
	char c, nc = 0;
1301
	bool file_spec = false;
1302 1303
	int ret;

1304 1305
	/*
	 * <Syntax>
1306 1307
	 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
	 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1308
	 * perf probe %[GRP:]SDT_EVENT
1309
	 */
1310 1311
	if (!arg)
		return -EINVAL;
1312

1313 1314 1315 1316 1317 1318 1319 1320
	/*
	 * If the probe point starts with '%',
	 * or starts with "sdt_" and has a ':' but no '=',
	 * then it should be a SDT/cached probe point.
	 */
	if (arg[0] == '%' ||
	    (!strncmp(arg, "sdt_", 4) &&
	     !!strchr(arg, ':') && !strchr(arg, '='))) {
1321
		pev->sdt = true;
1322 1323
		if (arg[0] == '%')
			arg++;
1324 1325
	}

1326
	ptr = strpbrk(arg, ";=@+%");
1327
	if (pev->sdt) {
1328
		if (ptr) {
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
			if (*ptr != '@') {
				semantic_error("%s must be an SDT name.\n",
					       arg);
				return -EINVAL;
			}
			/* This must be a target file name or build id */
			tmp = build_id_cache__complement(ptr + 1);
			if (tmp) {
				pev->target = build_id_cache__origname(tmp);
				free(tmp);
			} else
				pev->target = strdup(ptr + 1);
			if (!pev->target)
				return -ENOMEM;
			*ptr = '\0';
1344
		}
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
		ret = parse_perf_probe_event_name(&arg, pev);
		if (ret == 0) {
			if (asprintf(&pev->point.function, "%%%s", pev->event) < 0)
				ret = -errno;
		}
		return ret;
	}

	if (ptr && *ptr == '=') {	/* Event name */
		*ptr = '\0';
		tmp = ptr + 1;
		ret = parse_perf_probe_event_name(&arg, pev);
		if (ret < 0)
			return ret;

1360 1361 1362
		arg = tmp;
	}

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
	/*
	 * Check arg is function or file name and copy it.
	 *
	 * We consider arg to be a file spec if and only if it satisfies
	 * all of the below criteria::
	 * - it does not include any of "+@%",
	 * - it includes one of ":;", and
	 * - it has a period '.' in the name.
	 *
	 * Otherwise, we consider arg to be a function specification.
	 */
	if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
		/* This is a file spec if it includes a '.' before ; or : */
		if (memchr(arg, '.', ptr - arg))
			file_spec = true;
	}

1380
	ptr = strpbrk(arg, ";:+@%");
1381 1382 1383 1384 1385
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1386 1387 1388 1389 1390 1391 1392
	if (arg[0] == '\0')
		tmp = NULL;
	else {
		tmp = strdup(arg);
		if (tmp == NULL)
			return -ENOMEM;
	}
1393

1394
	if (file_spec)
1395
		pp->file = tmp;
1396
	else {
1397
		pp->function = tmp;
1398

1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
		/*
		 * Keep pp->function even if this is absolute address,
		 * so it can mark whether abs_address is valid.
		 * Which make 'perf probe lib.bin 0x0' possible.
		 *
		 * Note that checking length of tmp is not needed
		 * because when we access tmp[1] we know tmp[0] is '0',
		 * so tmp[1] should always valid (but could be '\0').
		 */
		if (tmp && !strncmp(tmp, "0x", 2)) {
			pp->abs_address = strtoul(pp->function, &tmp, 0);
			if (*tmp != '\0') {
				semantic_error("Invalid absolute address.\n");
				return -EINVAL;
			}
		}
	}

1417 1418 1419 1420
	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1421
		if (c == ';') {	/* Lazy pattern must be the last part */
1422 1423 1424
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1425 1426 1427
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1428 1429 1430 1431 1432 1433 1434
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1435
			if (*tmp != '\0') {
1436
				semantic_error("There is non-digit char"
1437 1438 1439
					       " in line number.\n");
				return -EINVAL;
			}
1440 1441 1442
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1443
			if (*tmp != '\0') {
1444
				semantic_error("There is non-digit character"
1445 1446 1447
						" in offset.\n");
				return -EINVAL;
			}
1448 1449
			break;
		case '@':	/* File name */
1450 1451 1452 1453
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1454 1455 1456
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1457 1458 1459 1460
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1461 1462 1463 1464
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1465
			break;
1466 1467 1468 1469
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1470 1471 1472 1473 1474
			break;
		}
	}

	/* Exclusion check */
1475
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1476 1477
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1478 1479
		return -EINVAL;
	}
1480

1481
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
1482
		semantic_error("Lazy pattern can't be used with offset.\n");
1483 1484
		return -EINVAL;
	}
1485

1486
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1487
		semantic_error("Offset can't be used with line number.\n");
1488 1489
		return -EINVAL;
	}
1490

1491
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1492
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1493
			       "lazy pattern.\n");
1494 1495
		return -EINVAL;
	}
1496

1497
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1498
		semantic_error("Offset requires an entry function.\n");
1499 1500
		return -EINVAL;
	}
1501

1502
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1503
		semantic_error("Return probe requires an entry function.\n");
1504 1505
		return -EINVAL;
	}
1506

1507
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1508
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1509
			       "return probe.\n");
1510 1511
		return -EINVAL;
	}
1512

1513
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1514 1515
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1516
	return 0;
1517 1518
}

1519
/* Parse perf-probe event argument */
1520
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1521
{
1522
	char *tmp, *goodname;
1523 1524 1525 1526
	struct perf_probe_arg_field **fieldp;

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

1527 1528
	tmp = strchr(str, '=');
	if (tmp) {
1529 1530 1531
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1532
		pr_debug("name:%s ", arg->name);
1533 1534 1535
		str = tmp + 1;
	}

1536 1537 1538
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1539 1540 1541
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1542 1543 1544
		pr_debug("type:%s ", arg->type);
	}

1545
	tmp = strpbrk(str, "-.[");
1546 1547
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1548 1549 1550
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1551
		pr_debug("%s\n", arg->var);
1552
		return 0;
1553 1554
	}

1555
	/* Structure fields or array element */
1556 1557 1558
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1559
	goodname = arg->var;
1560
	pr_debug("%s, ", arg->var);
1561 1562 1563
	fieldp = &arg->field;

	do {
1564 1565 1566
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1567 1568 1569
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1570
			(*fieldp)->ref = true;
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591
			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, "-.[");
1592
		}
1593
		if (tmp) {
1594 1595 1596
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1597 1598
			if (*str != '[')
				goodname = (*fieldp)->name;
1599 1600 1601 1602
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1603 1604 1605
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1606 1607
	if (*str != '[')
		goodname = (*fieldp)->name;
1608
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1609

1610
	/* If no name is specified, set the last field name (not array index)*/
1611
	if (!arg->name) {
1612
		arg->name = strdup(goodname);
1613 1614 1615
		if (arg->name == NULL)
			return -ENOMEM;
	}
1616
	return 0;
1617 1618
}

1619
/* Parse perf-probe event command */
1620
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1621
{
1622
	char **argv;
1623
	int argc, i, ret = 0;
1624

1625
	argv = argv_split(cmd, &argc);
1626 1627 1628 1629 1630 1631 1632 1633 1634
	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;
	}
1635
	/* Parse probe point */
1636 1637 1638
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1639

1640
	/* Copy arguments and ensure return probe has no C argument */
1641
	pev->nargs = argc - 1;
1642 1643 1644 1645 1646
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1647 1648 1649 1650
	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) {
1651
			semantic_error("You can't specify local variable for"
1652 1653 1654
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1655
	}
1656
out:
1657
	argv_free(argv);
1658 1659

	return ret;
1660 1661
}

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
/* Returns true if *any* ARG is either C variable, $params or $vars. */
bool perf_probe_with_var(struct perf_probe_event *pev)
{
	int i = 0;

	for (i = 0; i < pev->nargs; i++)
		if (is_c_varname(pev->args[i].var)              ||
		    !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) ||
		    !strcmp(pev->args[i].var, PROBE_ARG_VARS))
			return true;
	return false;
}

1675 1676 1677 1678 1679 1680
/* Return true if this perf_probe_event requires debuginfo */
bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
{
	if (pev->point.file || pev->point.line || pev->point.lazy_line)
		return true;

1681 1682
	if (perf_probe_with_var(pev))
		return true;
1683 1684 1685 1686

	return false;
}

1687
/* Parse probe_events event into struct probe_point */
1688
int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1689
{
1690
	struct probe_trace_point *tp = &tev->point;
1691 1692
	char pr;
	char *p;
1693
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1694 1695 1696
	int ret, i, argc;
	char **argv;

1697
	pr_debug("Parsing probe_events: %s\n", cmd);
1698
	argv = argv_split(cmd, &argc);
1699 1700 1701 1702 1703 1704 1705 1706 1707
	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;
	}
1708 1709

	/* Scan event and group name. */
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
	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) {
1720 1721 1722 1723
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1724 1725 1726 1727 1728 1729 1730
	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;
	}
1731
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1732

1733
	tp->retprobe = (pr == 'r');
1734

1735 1736 1737 1738
	/* Scan module name(if there), function name and offset */
	p = strchr(argv[1], ':');
	if (p) {
		tp->module = strndup(argv[1], p - argv[1]);
1739 1740 1741 1742
		if (!tp->module) {
			ret = -ENOMEM;
			goto out;
		}
1743
		tev->uprobes = (tp->module[0] == '/');
1744 1745 1746
		p++;
	} else
		p = argv[1];
1747
	fmt1_str = strtok_r(p, "+", &fmt);
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
	/* only the address started with 0x */
	if (fmt1_str[0] == '0')	{
		/*
		 * Fix a special case:
		 * if address == 0, kernel reports something like:
		 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x          (null) arg1=%ax
		 * Newer kernel may fix that, but we want to
		 * support old kernel also.
		 */
		if (strcmp(fmt1_str, "0x") == 0) {
			if (!argv[2] || strcmp(argv[2], "(null)")) {
				ret = -EINVAL;
				goto out;
			}
			tp->address = 0;

			free(argv[2]);
			for (i = 2; argv[i + 1] != NULL; i++)
				argv[i] = argv[i + 1];

			argv[i] = NULL;
			argc -= 1;
		} else
			tp->address = strtoul(fmt1_str, NULL, 0);
	} else {
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
		/* 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);
1784
	}
1785

1786
	tev->nargs = argc - 2;
1787
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1788 1789 1790 1791
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1792
	for (i = 0; i < tev->nargs; i++) {
1793 1794
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1795 1796 1797
			*p++ = '\0';
		else
			p = argv[i + 2];
1798
		tev->args[i].name = strdup(argv[i + 2]);
1799
		/* TODO: parse regs and offset */
1800 1801 1802 1803 1804
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1805
	}
1806 1807
	ret = 0;
out:
1808
	free(argv0_str);
1809
	argv_free(argv);
1810
	return ret;
1811 1812
}

1813
/* Compose only probe arg */
1814
char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1815 1816
{
	struct perf_probe_arg_field *field = pa->field;
1817
	struct strbuf buf;
1818 1819 1820 1821 1822
	char *ret = NULL;
	int err;

	if (strbuf_init(&buf, 64) < 0)
		return NULL;
1823

1824
	if (pa->name && pa->var)
1825
		err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1826
	else
1827 1828 1829
		err = strbuf_addstr(&buf, pa->name ?: pa->var);
	if (err)
		goto out;
1830 1831

	while (field) {
1832
		if (field->name[0] == '[')
1833
			err = strbuf_addstr(&buf, field->name);
1834
		else
1835 1836
			err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
					  field->name);
1837
		field = field->next;
1838 1839
		if (err)
			goto out;
1840
	}
1841

1842
	if (pa->type)
1843 1844
		if (strbuf_addf(&buf, ":%s", pa->type) < 0)
			goto out;
1845 1846

	ret = strbuf_detach(&buf, NULL);
1847 1848
out:
	strbuf_release(&buf);
1849
	return ret;
1850 1851
}

1852
/* Compose only probe point (not argument) */
1853
char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1854
{
1855
	struct strbuf buf;
1856 1857 1858 1859 1860
	char *tmp, *ret = NULL;
	int len, err = 0;

	if (strbuf_init(&buf, 64) < 0)
		return NULL;
1861 1862

	if (pp->function) {
1863 1864
		if (strbuf_addstr(&buf, pp->function) < 0)
			goto out;
1865
		if (pp->offset)
1866
			err = strbuf_addf(&buf, "+%lu", pp->offset);
1867
		else if (pp->line)
1868
			err = strbuf_addf(&buf, ":%d", pp->line);
1869
		else if (pp->retprobe)
1870 1871 1872
			err = strbuf_addstr(&buf, "%return");
		if (err)
			goto out;
1873 1874
	}
	if (pp->file) {
1875 1876 1877 1878 1879 1880
		tmp = pp->file;
		len = strlen(tmp);
		if (len > 30) {
			tmp = strchr(pp->file + len - 30, '/');
			tmp = tmp ? tmp + 1 : pp->file + len - 30;
		}
1881 1882 1883
		err = strbuf_addf(&buf, "@%s", tmp);
		if (!err && !pp->function && pp->line)
			err = strbuf_addf(&buf, ":%d", pp->line);
1884
	}
1885 1886 1887 1888 1889
	if (!err)
		ret = strbuf_detach(&buf, NULL);
out:
	strbuf_release(&buf);
	return ret;
1890 1891
}

1892
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1893
{
1894 1895 1896
	struct strbuf buf;
	char *tmp, *ret = NULL;
	int i;
1897

1898
	if (strbuf_init(&buf, 64))
1899
		return NULL;
1900 1901 1902 1903 1904 1905 1906 1907 1908
	if (pev->event)
		if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
				pev->event) < 0)
			goto out;

	tmp = synthesize_perf_probe_point(&pev->point);
	if (!tmp || strbuf_addstr(&buf, tmp) < 0)
		goto out;
	free(tmp);
1909

1910
	for (i = 0; i < pev->nargs; i++) {
1911 1912 1913 1914
		tmp = synthesize_perf_probe_arg(pev->args + i);
		if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
			goto out;
		free(tmp);
1915 1916
	}

1917 1918 1919 1920
	ret = strbuf_detach(&buf, NULL);
out:
	strbuf_release(&buf);
	return ret;
1921 1922
}

1923
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1924
					    struct strbuf *buf, int depth)
1925
{
1926
	int err;
1927
	if (ref->next) {
1928
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1929
							 depth + 1);
1930
		if (depth < 0)
1931
			return depth;
1932
	}
1933 1934
	err = strbuf_addf(buf, "%+ld(", ref->offset);
	return (err < 0) ? err : depth;
1935 1936
}

1937
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1938
				      struct strbuf *buf)
1939
{
1940
	struct probe_trace_arg_ref *ref = arg->ref;
1941
	int depth = 0, err;
1942 1943 1944

	/* Argument name or separator */
	if (arg->name)
1945
		err = strbuf_addf(buf, " %s=", arg->name);
1946
	else
1947 1948 1949
		err = strbuf_addch(buf, ' ');
	if (err)
		return err;
1950

1951 1952 1953 1954
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1955
	/* Dereferencing arguments */
1956
	if (ref) {
1957
		depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
1958 1959 1960 1961 1962
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1963
	if (arg->value[0] == '@' && arg->ref)
1964
		err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
1965
	else
1966
		err = strbuf_addstr(buf, arg->value);
1967 1968

	/* Closing */
1969 1970 1971
	while (!err && depth--)
		err = strbuf_addch(buf, ')');

1972
	/* Print argument type */
1973 1974
	if (!err && arg->type)
		err = strbuf_addf(buf, ":%s", arg->type);
1975

1976
	return err;
1977 1978
}

1979
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1980
{
1981
	struct probe_trace_point *tp = &tev->point;
1982 1983
	struct strbuf buf;
	char *ret = NULL;
1984
	int i, err;
1985

1986 1987
	/* Uprobes must have tp->module */
	if (tev->uprobes && !tp->module)
1988 1989
		return NULL;

1990 1991 1992 1993 1994 1995
	if (strbuf_init(&buf, 32) < 0)
		return NULL;

	if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
			tev->group, tev->event) < 0)
		goto error;
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
	/*
	 * If tp->address == 0, then this point must be a
	 * absolute address uprobe.
	 * try_to_find_absolute_address() should have made
	 * tp->symbol to "0x0".
	 */
	if (tev->uprobes && !tp->address) {
		if (!tp->symbol || strcmp(tp->symbol, "0x0"))
			goto error;
	}
2006 2007

	/* Use the tp->address for uprobes */
2008
	if (tev->uprobes)
2009
		err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address);
2010 2011
	else if (!strncmp(tp->symbol, "0x", 2))
		/* Absolute address. See try_to_find_absolute_address() */
2012 2013
		err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
				  tp->module ? ":" : "", tp->address);
2014
	else
2015 2016 2017 2018
		err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
				tp->module ? ":" : "", tp->symbol, tp->offset);
	if (err)
		goto error;
2019

2020 2021
	for (i = 0; i < tev->nargs; i++)
		if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
2022 2023
			goto error;

2024
	ret = strbuf_detach(&buf, NULL);
2025
error:
2026 2027
	strbuf_release(&buf);
	return ret;
2028
}
2029

2030 2031 2032 2033 2034 2035
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;
2036
	u64 addr = tp->address;
2037 2038 2039 2040 2041 2042
	int ret = -ENOENT;

	if (!is_kprobe) {
		map = dso__new_map(tp->module);
		if (!map)
			goto out;
2043
		sym = map__find_symbol(map, addr);
2044
	} else {
2045
		if (tp->symbol && !addr) {
2046 2047
			if (kernel_get_symbol_address_by_name(tp->symbol,
						&addr, true, false) < 0)
2048 2049
				goto out;
		}
2050 2051 2052 2053 2054
		if (addr) {
			addr += tp->offset;
			sym = __find_kernel_function(addr, &map);
		}
	}
2055

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
	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) {
2066
		map__put(map);
2067 2068 2069 2070 2071 2072
	}

	return ret;
}

static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2073 2074
				       struct perf_probe_point *pp,
				       bool is_kprobe)
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090
{
	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;
2091
	} else {
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
		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;
}

2106
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2107
			       struct perf_probe_event *pev, bool is_kprobe)
2108
{
2109
	struct strbuf buf = STRBUF_INIT;
2110
	int i, ret;
2111

2112
	/* Convert event/group name */
2113 2114 2115 2116
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
2117

2118
	/* Convert trace_point to probe_point */
2119
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2120 2121
	if (ret < 0)
		return ret;
2122

2123 2124
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
2125 2126 2127
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
2128
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
2129
		if (tev->args[i].name)
2130
			pev->args[i].name = strdup(tev->args[i].name);
2131
		else {
2132 2133
			if ((ret = strbuf_init(&buf, 32)) < 0)
				goto error;
2134 2135
			ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
			pev->args[i].name = strbuf_detach(&buf, NULL);
2136
		}
2137 2138 2139
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
2140
error:
2141 2142 2143 2144
	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
2145 2146 2147 2148
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
2149
	struct perf_probe_arg_field *field, *next;
2150 2151
	int i;

2152 2153
	free(pev->event);
	free(pev->group);
2154
	free(pev->target);
2155
	clear_perf_probe_point(&pev->point);
2156

2157
	for (i = 0; i < pev->nargs; i++) {
2158 2159 2160
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
2161 2162 2163
		field = pev->args[i].field;
		while (field) {
			next = field->next;
2164
			zfree(&field->name);
2165 2166 2167 2168
			free(field);
			field = next;
		}
	}
2169
	free(pev->args);
2170 2171 2172
	memset(pev, 0, sizeof(*pev));
}

2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
#define strdup_or_goto(str, label)	\
({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })

static int perf_probe_point__copy(struct perf_probe_point *dst,
				  struct perf_probe_point *src)
{
	dst->file = strdup_or_goto(src->file, out_err);
	dst->function = strdup_or_goto(src->function, out_err);
	dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
	dst->line = src->line;
	dst->retprobe = src->retprobe;
	dst->offset = src->offset;
	return 0;

out_err:
	clear_perf_probe_point(dst);
	return -ENOMEM;
}

static int perf_probe_arg__copy(struct perf_probe_arg *dst,
				struct perf_probe_arg *src)
{
	struct perf_probe_arg_field *field, **ppfield;

	dst->name = strdup_or_goto(src->name, out_err);
	dst->var = strdup_or_goto(src->var, out_err);
	dst->type = strdup_or_goto(src->type, out_err);

	field = src->field;
	ppfield = &(dst->field);
	while (field) {
		*ppfield = zalloc(sizeof(*field));
		if (!*ppfield)
			goto out_err;
		(*ppfield)->name = strdup_or_goto(field->name, out_err);
		(*ppfield)->index = field->index;
		(*ppfield)->ref = field->ref;
		field = field->next;
		ppfield = &((*ppfield)->next);
	}
	return 0;
out_err:
	return -ENOMEM;
}

int perf_probe_event__copy(struct perf_probe_event *dst,
			   struct perf_probe_event *src)
{
	int i;

	dst->event = strdup_or_goto(src->event, out_err);
	dst->group = strdup_or_goto(src->group, out_err);
	dst->target = strdup_or_goto(src->target, out_err);
	dst->uprobes = src->uprobes;

	if (perf_probe_point__copy(&dst->point, &src->point) < 0)
		goto out_err;

	dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
	if (!dst->args)
		goto out_err;
	dst->nargs = src->nargs;

	for (i = 0; i < src->nargs; i++)
		if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
			goto out_err;
	return 0;

out_err:
	clear_perf_probe_event(dst);
	return -ENOMEM;
}

2246
void clear_probe_trace_event(struct probe_trace_event *tev)
2247
{
2248
	struct probe_trace_arg_ref *ref, *next;
2249 2250
	int i;

2251 2252 2253
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
2254
	free(tev->point.realname);
2255
	free(tev->point.module);
2256
	for (i = 0; i < tev->nargs; i++) {
2257 2258 2259
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
2260 2261 2262 2263 2264 2265 2266
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
2267
	free(tev->args);
2268
	memset(tev, 0, sizeof(*tev));
2269 2270
}

2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
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;
2294
	const char *__debugfs = debugfs__mountpoint();
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359
	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;
}

2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
static LIST_HEAD(kprobe_blacklist);

static void kprobe_blacklist__init(void)
{
	if (!list_empty(&kprobe_blacklist))
		return;

	if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
		pr_debug("No kprobe blacklist support, ignored\n");
}

static void kprobe_blacklist__release(void)
{
	kprobe_blacklist__delete(&kprobe_blacklist);
}

static bool kprobe_blacklist__listed(unsigned long address)
{
	return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
}

2381 2382
static int perf_probe_event__sprintf(const char *group, const char *event,
				     struct perf_probe_event *pev,
2383 2384
				     const char *module,
				     struct strbuf *result)
2385
{
2386
	int i, ret;
2387
	char *buf;
2388

2389 2390
	if (asprintf(&buf, "%s:%s", group, event) < 0)
		return -errno;
2391
	ret = strbuf_addf(result, "  %-20s (on ", buf);
2392
	free(buf);
2393 2394
	if (ret)
		return ret;
2395

2396 2397 2398 2399
	/* Synthesize only event probe point */
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return -ENOMEM;
2400
	ret = strbuf_addstr(result, buf);
2401
	free(buf);
2402

2403 2404
	if (!ret && module)
		ret = strbuf_addf(result, " in %s", module);
2405

2406 2407 2408
	if (!ret && pev->nargs > 0) {
		ret = strbuf_add(result, " with", 5);
		for (i = 0; !ret && i < pev->nargs; i++) {
2409 2410 2411
			buf = synthesize_perf_probe_arg(&pev->args[i]);
			if (!buf)
				return -ENOMEM;
2412
			ret = strbuf_addf(result, " %s", buf);
2413
			free(buf);
2414
		}
2415
	}
2416 2417
	if (!ret)
		ret = strbuf_addch(result, ')');
2418

2419
	return ret;
2420 2421
}

2422
/* Show an event */
2423 2424 2425
int show_perf_probe_event(const char *group, const char *event,
			  struct perf_probe_event *pev,
			  const char *module, bool use_stdout)
2426 2427 2428 2429
{
	struct strbuf buf = STRBUF_INIT;
	int ret;

2430
	ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
	if (ret >= 0) {
		if (use_stdout)
			printf("%s\n", buf.buf);
		else
			pr_info("%s\n", buf.buf);
	}
	strbuf_release(&buf);

	return ret;
}

2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
static bool filter_probe_trace_event(struct probe_trace_event *tev,
				     struct strfilter *filter)
{
	char tmp[128];

	/* At first, check the event name itself */
	if (strfilter__compare(filter, tev->event))
		return true;

	/* Next, check the combination of name and group */
	if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
		return false;
	return strfilter__compare(filter, tmp);
}

static int __show_perf_probe_events(int fd, bool is_kprobe,
				    struct strfilter *filter)
2459
{
2460
	int ret = 0;
2461
	struct probe_trace_event tev;
2462
	struct perf_probe_event pev;
2463 2464 2465
	struct strlist *rawlist;
	struct str_node *ent;

2466 2467
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2468

2469
	rawlist = probe_file__get_rawlist(fd);
2470
	if (!rawlist)
2471
		return -ENOMEM;
2472

2473
	strlist__for_each_entry(ent, rawlist) {
2474
		ret = parse_probe_trace_command(ent->s, &tev);
2475
		if (ret >= 0) {
2476 2477
			if (!filter_probe_trace_event(&tev, filter))
				goto next;
2478 2479
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2480 2481
			if (ret < 0)
				goto next;
2482 2483
			ret = show_perf_probe_event(pev.group, pev.event,
						    &pev, tev.point.module,
2484
						    true);
2485
		}
2486
next:
2487
		clear_perf_probe_event(&pev);
2488
		clear_probe_trace_event(&tev);
2489 2490
		if (ret < 0)
			break;
2491 2492
	}
	strlist__delete(rawlist);
2493 2494
	/* Cleanup cached debuginfo if needed */
	debuginfo_cache__exit();
2495 2496

	return ret;
2497 2498
}

2499
/* List up current perf-probe events */
2500
int show_perf_probe_events(struct strfilter *filter)
2501
{
2502
	int kp_fd, up_fd, ret;
2503 2504 2505

	setup_pager();

2506 2507 2508
	if (probe_conf.cache)
		return probe_cache__show_all_caches(filter);

2509
	ret = init_probe_symbol_maps(false);
2510 2511 2512
	if (ret < 0)
		return ret;

2513 2514 2515
	ret = probe_file__open_both(&kp_fd, &up_fd, 0);
	if (ret < 0)
		return ret;
2516

2517 2518 2519
	if (kp_fd >= 0)
		ret = __show_perf_probe_events(kp_fd, true, filter);
	if (up_fd >= 0 && ret >= 0)
2520
		ret = __show_perf_probe_events(up_fd, false, filter);
2521 2522 2523
	if (kp_fd > 0)
		close(kp_fd);
	if (up_fd > 0)
2524
		close(up_fd);
2525
	exit_probe_symbol_maps();
2526

2527
	return ret;
2528 2529
}

2530 2531
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2532 2533
{
	int i, ret;
2534
	char *p, *nbase;
2535

2536 2537
	if (*base == '.')
		base++;
2538 2539 2540 2541 2542 2543 2544 2545
	nbase = strdup(base);
	if (!nbase)
		return -ENOMEM;

	/* Cut off the dot suffixes (e.g. .const, .isra)*/
	p = strchr(nbase, '.');
	if (p && p != nbase)
		*p = '\0';
2546

2547 2548
	/* Try no suffix number */
	ret = e_snprintf(buf, len, "%s", nbase);
2549
	if (ret < 0) {
2550
		pr_debug("snprintf() failed: %d\n", ret);
2551
		goto out;
2552
	}
2553
	if (!strlist__has_entry(namelist, buf))
2554
		goto out;
2555

2556
	if (!allow_suffix) {
2557 2558 2559 2560 2561
		pr_warning("Error: event \"%s\" already exists.\n"
			   " Hint: Remove existing event by 'perf probe -d'\n"
			   "       or force duplicates by 'perf probe -f'\n"
			   "       or set 'force=yes' in BPF source.\n",
			   buf);
2562 2563
		ret = -EEXIST;
		goto out;
2564 2565
	}

2566 2567
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2568
		ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2569
		if (ret < 0) {
2570
			pr_debug("snprintf() failed: %d\n", ret);
2571
			goto out;
2572
		}
2573 2574 2575
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2576 2577 2578 2579 2580
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

2581 2582
out:
	free(nbase);
2583
	return ret;
2584 2585
}

2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
/* 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);
}

2607 2608 2609 2610 2611 2612 2613 2614 2615 2616
/* Set new name from original perf_probe_event and namelist */
static int probe_trace_event__set_name(struct probe_trace_event *tev,
				       struct perf_probe_event *pev,
				       struct strlist *namelist,
				       bool allow_suffix)
{
	const char *event, *group;
	char buf[64];
	int ret;

2617
	/* If probe_event or trace_event already have the name, reuse it */
2618
	if (pev->event && !pev->sdt)
2619
		event = pev->event;
2620 2621 2622 2623
	else if (tev->event)
		event = tev->event;
	else {
		/* Or generate new one from probe point */
2624 2625 2626
		if (pev->point.function &&
			(strncmp(pev->point.function, "0x", 2) != 0) &&
			!strisglob(pev->point.function))
2627 2628 2629
			event = pev->point.function;
		else
			event = tev->point.realname;
2630
	}
2631
	if (pev->group && !pev->sdt)
2632
		group = pev->group;
2633 2634
	else if (tev->group)
		group = tev->group;
2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655
	else
		group = PERFPROBE_GROUP;

	/* Get an unused new event name */
	ret = get_new_event_name(buf, 64, event,
				 namelist, allow_suffix);
	if (ret < 0)
		return ret;

	event = buf;

	tev->event = strdup(event);
	tev->group = strdup(group);
	if (tev->event == NULL || tev->group == NULL)
		return -ENOMEM;

	/* Add added event name to namelist */
	strlist__add(namelist, event);
	return 0;
}

2656 2657
static int __open_probe_file_and_namelist(bool uprobe,
					  struct strlist **namelist)
2658
{
2659
	int fd;
2660

2661
	fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2662
	if (fd < 0)
2663
		return fd;
2664

2665
	/* Get current event names */
2666 2667
	*namelist = probe_file__get_namelist(fd);
	if (!(*namelist)) {
2668
		pr_debug("Failed to get current event list.\n");
2669 2670
		close(fd);
		return -ENOMEM;
2671
	}
2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
	return fd;
}

static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
				     int ntevs, bool allow_suffix)
{
	int i, fd[2] = {-1, -1}, up, ret;
	struct probe_trace_event *tev = NULL;
	struct probe_cache *cache = NULL;
	struct strlist *namelist[2] = {NULL, NULL};

	up = pev->uprobes ? 1 : 0;
	fd[up] = __open_probe_file_and_namelist(up, &namelist[up]);
	if (fd[up] < 0)
		return fd[up];
2688

2689
	ret = 0;
2690
	for (i = 0; i < ntevs; i++) {
2691
		tev = &tevs[i];
2692 2693 2694 2695 2696 2697 2698
		up = tev->uprobes ? 1 : 0;
		if (fd[up] == -1) {	/* Open the kprobe/uprobe_events */
			fd[up] = __open_probe_file_and_namelist(up,
								&namelist[up]);
			if (fd[up] < 0)
				goto close_out;
		}
2699
		/* Skip if the symbol is out of .text or blacklisted */
2700
		if (!tev->point.symbol && !pev->uprobes)
2701
			continue;
2702

2703
		/* Set new name for tev (and update namelist) */
2704
		ret = probe_trace_event__set_name(tev, pev, namelist[up],
2705
						  allow_suffix);
2706 2707
		if (ret < 0)
			break;
2708

2709
		ret = probe_file__add_event(fd[up], tev);
2710 2711
		if (ret < 0)
			break;
2712 2713 2714 2715 2716 2717 2718 2719

		/*
		 * 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;
2720
	}
2721 2722
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2723 2724 2725 2726 2727 2728 2729 2730
	if (ret == 0 && probe_conf.cache) {
		cache = probe_cache__new(pev->target);
		if (!cache ||
		    probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
		    probe_cache__commit(cache) < 0)
			pr_warning("Failed to add event to probe cache\n");
		probe_cache__delete(cache);
	}
2731

2732
close_out:
2733 2734 2735 2736 2737
	for (up = 0; up < 2; up++) {
		strlist__delete(namelist[up]);
		if (fd[up] >= 0)
			close(fd[up]);
	}
2738
	return ret;
2739
}
2740

2741 2742
static int find_probe_functions(struct map *map, char *name,
				struct symbol **syms)
2743
{
2744
	int found = 0;
2745
	struct symbol *sym;
2746
	struct rb_node *tmp;
2747

2748
	if (map__load(map) < 0)
2749 2750
		return 0;

2751
	map__for_each_symbol(map, sym, tmp) {
2752
		if (strglobmatch(sym->name, name)) {
2753
			found++;
2754 2755 2756
			if (syms && found < probe_conf.max_probes)
				syms[found - 1] = sym;
		}
2757
	}
2758 2759

	return found;
2760 2761
}

2762 2763
void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
				struct probe_trace_event *tev __maybe_unused,
2764 2765
				struct map *map __maybe_unused,
				struct symbol *sym __maybe_unused) { }
2766

2767 2768 2769 2770 2771
/*
 * 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,
2772
					    struct probe_trace_event **tevs)
2773
{
2774 2775
	struct map *map = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2776
	struct symbol *sym;
2777
	struct symbol **syms = NULL;
2778
	struct probe_trace_event *tev;
2779 2780
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2781
	int num_matched_functions;
2782
	int ret, i, j, skipped = 0;
2783
	char *mod_name;
2784

2785
	map = get_target_map(pev->target, pev->uprobes);
2786 2787 2788
	if (!map) {
		ret = -EINVAL;
		goto out;
2789 2790
	}

2791 2792 2793 2794 2795 2796
	syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
	if (!syms) {
		ret = -ENOMEM;
		goto out;
	}

2797 2798 2799 2800
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2801
	num_matched_functions = find_probe_functions(map, pp->function, syms);
2802
	if (num_matched_functions == 0) {
2803
		pr_err("Failed to find symbol %s in %s\n", pp->function,
2804
			pev->target ? : "kernel");
2805 2806
		ret = -ENOENT;
		goto out;
2807
	} else if (num_matched_functions > probe_conf.max_probes) {
2808
		pr_err("Too many functions matched in %s\n",
2809
			pev->target ? : "kernel");
2810 2811
		ret = -E2BIG;
		goto out;
2812 2813
	}

2814 2815
	/* Note that the symbols in the kmodule are not relocated */
	if (!pev->uprobes && !pp->retprobe && !pev->target) {
2816
		reloc_sym = kernel_get_ref_reloc_sym();
2817 2818 2819 2820 2821 2822
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2823

2824 2825 2826
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2827
		ret = -ENOMEM;
2828
		goto out;
2829
	}
2830

2831
	ret = 0;
2832

2833 2834 2835
	for (j = 0; j < num_matched_functions; j++) {
		sym = syms[j];

2836 2837 2838 2839 2840
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2841
		}
2842
		ret++;
2843

2844 2845 2846 2847 2848 2849 2850 2851
		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;
2852 2853 2854

		/* Check the kprobe (not in module) is within .text  */
		if (!pev->uprobes && !pev->target &&
2855 2856 2857 2858
		    kprobe_warn_out_range(sym->name, tp->address)) {
			tp->symbol = NULL;	/* Skip it */
			skipped++;
		} else if (reloc_sym) {
2859 2860 2861 2862 2863 2864
			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;
		}
2865 2866
		tp->realname = strdup_or_goto(sym->name, nomem_out);

2867
		tp->retprobe = pp->retprobe;
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880
		if (pev->target) {
			if (pev->uprobes) {
				tev->point.module = strdup_or_goto(pev->target,
								   nomem_out);
			} else {
				mod_name = find_module_name(pev->target);
				tev->point.module =
					strdup(mod_name ? mod_name : pev->target);
				free(mod_name);
				if (!tev->point.module)
					goto nomem_out;
			}
		}
2881 2882 2883 2884 2885 2886 2887
		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;
2888
		}
2889
		for (i = 0; i < tev->nargs; i++) {
2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900
			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);
2901
		}
2902
		arch__fix_tev_from_maps(pev, tev, map, sym);
2903
	}
2904 2905 2906 2907
	if (ret == skipped) {
		ret = -ENOENT;
		goto err_out;
	}
2908

2909
out:
2910
	map__put(map);
2911
	free(syms);
2912
	return ret;
2913

2914 2915 2916 2917 2918 2919 2920
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2921

2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013
static int try_to_find_absolute_address(struct perf_probe_event *pev,
					struct probe_trace_event **tevs)
{
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_event *tev;
	struct probe_trace_point *tp;
	int i, err;

	if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
		return -EINVAL;
	if (perf_probe_event_need_dwarf(pev))
		return -EINVAL;

	/*
	 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
	 * absolute address.
	 *
	 * Only one tev can be generated by this.
	 */
	*tevs = zalloc(sizeof(*tev));
	if (!*tevs)
		return -ENOMEM;

	tev = *tevs;
	tp = &tev->point;

	/*
	 * Don't use tp->offset, use address directly, because
	 * in synthesize_probe_trace_command() address cannot be
	 * zero.
	 */
	tp->address = pev->point.abs_address;
	tp->retprobe = pp->retprobe;
	tev->uprobes = pev->uprobes;

	err = -ENOMEM;
	/*
	 * Give it a '0x' leading symbol name.
	 * In __add_probe_trace_events, a NULL symbol is interpreted as
	 * invalud.
	 */
	if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
		goto errout;

	/* For kprobe, check range */
	if ((!tev->uprobes) &&
	    (kprobe_warn_out_range(tev->point.symbol,
				   tev->point.address))) {
		err = -EACCES;
		goto errout;
	}

	if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
		goto errout;

	if (pev->target) {
		tp->module = strdup(pev->target);
		if (!tp->module)
			goto errout;
	}

	if (tev->group) {
		tev->group = strdup(pev->group);
		if (!tev->group)
			goto errout;
	}

	if (pev->event) {
		tev->event = strdup(pev->event);
		if (!tev->event)
			goto errout;
	}

	tev->nargs = pev->nargs;
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
	if (!tev->args) {
		err = -ENOMEM;
		goto errout;
	}
	for (i = 0; i < tev->nargs; i++)
		copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);

	return 1;

errout:
	if (*tevs) {
		clear_probe_trace_events(*tevs, 1);
		*tevs = NULL;
	}
	return err;
}

3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107
/* Concatinate two arrays */
static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
{
	void *ret;

	ret = malloc(sz_a + sz_b);
	if (ret) {
		memcpy(ret, a, sz_a);
		memcpy(ret + sz_a, b, sz_b);
	}
	return ret;
}

static int
concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
			  struct probe_trace_event **tevs2, int ntevs2)
{
	struct probe_trace_event *new_tevs;
	int ret = 0;

	if (ntevs == 0) {
		*tevs = *tevs2;
		*ntevs = ntevs2;
		*tevs2 = NULL;
		return 0;
	}

	if (*ntevs + ntevs2 > probe_conf.max_probes)
		ret = -E2BIG;
	else {
		/* Concatinate the array of probe_trace_event */
		new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs),
				  *tevs2, ntevs2 * sizeof(**tevs2));
		if (!new_tevs)
			ret = -ENOMEM;
		else {
			free(*tevs);
			*tevs = new_tevs;
			*ntevs += ntevs2;
		}
	}
	if (ret < 0)
		clear_probe_trace_events(*tevs2, ntevs2);
	zfree(tevs2);

	return ret;
}

/*
 * Try to find probe_trace_event from given probe caches. Return the number
 * of cached events found, if an error occurs return the error.
 */
static int find_cached_events(struct perf_probe_event *pev,
			      struct probe_trace_event **tevs,
			      const char *target)
{
	struct probe_cache *cache;
	struct probe_cache_entry *entry;
	struct probe_trace_event *tmp_tevs = NULL;
	int ntevs = 0;
	int ret = 0;

	cache = probe_cache__new(target);
	/* Return 0 ("not found") if the target has no probe cache. */
	if (!cache)
		return 0;

	for_each_probe_cache_entry(entry, cache) {
		/* Skip the cache entry which has no name */
		if (!entry->pev.event || !entry->pev.group)
			continue;
		if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) &&
		    strglobmatch(entry->pev.event, pev->event)) {
			ret = probe_cache_entry__get_event(entry, &tmp_tevs);
			if (ret > 0)
				ret = concat_probe_trace_events(tevs, &ntevs,
								&tmp_tevs, ret);
			if (ret < 0)
				break;
		}
	}
	probe_cache__delete(cache);
	if (ret < 0) {
		clear_probe_trace_events(*tevs, ntevs);
		zfree(tevs);
	} else {
		ret = ntevs;
		if (ntevs > 0 && target && target[0] == '/')
			pev->uprobes = true;
	}

	return ret;
}

3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149
/* Try to find probe_trace_event from all probe caches */
static int find_cached_events_all(struct perf_probe_event *pev,
				   struct probe_trace_event **tevs)
{
	struct probe_trace_event *tmp_tevs = NULL;
	struct strlist *bidlist;
	struct str_node *nd;
	char *pathname;
	int ntevs = 0;
	int ret;

	/* Get the buildid list of all valid caches */
	bidlist = build_id_cache__list_all(true);
	if (!bidlist) {
		ret = -errno;
		pr_debug("Failed to get buildids: %d\n", ret);
		return ret;
	}

	ret = 0;
	strlist__for_each_entry(nd, bidlist) {
		pathname = build_id_cache__origname(nd->s);
		ret = find_cached_events(pev, &tmp_tevs, pathname);
		/* In the case of cnt == 0, we just skip it */
		if (ret > 0)
			ret = concat_probe_trace_events(tevs, &ntevs,
							&tmp_tevs, ret);
		free(pathname);
		if (ret < 0)
			break;
	}
	strlist__delete(bidlist);

	if (ret < 0) {
		clear_probe_trace_events(*tevs, ntevs);
		zfree(tevs);
	} else
		ret = ntevs;

	return ret;
}

3150 3151 3152 3153 3154 3155 3156 3157 3158
static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
					      struct probe_trace_event **tevs)
{
	struct probe_cache *cache;
	struct probe_cache_entry *entry;
	struct probe_trace_event *tev;
	struct str_node *node;
	int ret, i;

3159
	if (pev->sdt) {
3160
		/* For SDT/cached events, we use special search functions */
3161 3162 3163 3164 3165
		if (!pev->target)
			return find_cached_events_all(pev, tevs);
		else
			return find_cached_events(pev, tevs, pev->target);
	}
3166 3167 3168 3169 3170 3171
	cache = probe_cache__new(pev->target);
	if (!cache)
		return 0;

	entry = probe_cache__find(cache, pev);
	if (!entry) {
3172 3173
		/* SDT must be in the cache */
		ret = pev->sdt ? -ENOENT : 0;
3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206
		goto out;
	}

	ret = strlist__nr_entries(entry->tevlist);
	if (ret > probe_conf.max_probes) {
		pr_debug("Too many entries matched in the cache of %s\n",
			 pev->target ? : "kernel");
		ret = -E2BIG;
		goto out;
	}

	*tevs = zalloc(ret * sizeof(*tev));
	if (!*tevs) {
		ret = -ENOMEM;
		goto out;
	}

	i = 0;
	strlist__for_each_entry(node, entry->tevlist) {
		tev = &(*tevs)[i++];
		ret = parse_probe_trace_command(node->s, tev);
		if (ret < 0)
			goto out;
		/* Set the uprobes attribute as same as original */
		tev->uprobes = pev->uprobes;
	}
	ret = i;

out:
	probe_cache__delete(cache);
	return ret;
}

3207
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3208
					 struct probe_trace_event **tevs)
3209 3210 3211
{
	int ret;

3212
	if (!pev->group && !pev->sdt) {
3213 3214 3215 3216 3217 3218
		/* Set group name if not given */
		if (!pev->uprobes) {
			pev->group = strdup(PERFPROBE_GROUP);
			ret = pev->group ? 0 : -ENOMEM;
		} else
			ret = convert_exec_to_group(pev->target, &pev->group);
3219 3220 3221 3222
		if (ret != 0) {
			pr_warning("Failed to make a group name.\n");
			return ret;
		}
3223
	}
3224

3225 3226 3227 3228
	ret = try_to_find_absolute_address(pev, tevs);
	if (ret > 0)
		return ret;

3229 3230
	/* At first, we need to lookup cache entry */
	ret = find_probe_trace_events_from_cache(pev, tevs);
3231 3232
	if (ret > 0 || pev->sdt)	/* SDT can be found only in the cache */
		return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3233

3234
	/* Convert perf_probe_event with debuginfo */
3235
	ret = try_to_find_probe_trace_events(pev, tevs);
3236 3237 3238
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

3239
	return find_probe_trace_events_from_map(pev, tevs);
3240 3241
}

3242
int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3243
{
3244
	int i, ret;
3245 3246 3247

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
3248
		/* Init kprobe blacklist if needed */
3249
		if (!pevs[i].uprobes)
3250
			kprobe_blacklist__init();
3251
		/* Convert with or without debuginfo */
3252
		ret  = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3253
		if (ret < 0)
3254
			return ret;
3255
		pevs[i].ntevs = ret;
3256
	}
3257 3258
	/* This just release blacklist only if allocated */
	kprobe_blacklist__release();
3259

3260 3261 3262
	return 0;
}

3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308
static int show_probe_trace_event(struct probe_trace_event *tev)
{
	char *buf = synthesize_probe_trace_command(tev);

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

	/* Showing definition always go stdout */
	printf("%s\n", buf);
	free(buf);

	return 0;
}

int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
{
	struct strlist *namelist = strlist__new(NULL, NULL);
	struct probe_trace_event *tev;
	struct perf_probe_event *pev;
	int i, j, ret = 0;

	if (!namelist)
		return -ENOMEM;

	for (j = 0; j < npevs && !ret; j++) {
		pev = &pevs[j];
		for (i = 0; i < pev->ntevs && !ret; i++) {
			tev = &pev->tevs[i];
			/* Skip if the symbol is out of .text or blacklisted */
			if (!tev->point.symbol && !pev->uprobes)
				continue;

			/* Set new name for tev (and update namelist) */
			ret = probe_trace_event__set_name(tev, pev,
							  namelist, true);
			if (!ret)
				ret = show_probe_trace_event(tev);
		}
	}
	strlist__delete(namelist);

	return ret;
}

3309
int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3310 3311 3312
{
	int i, ret = 0;

3313
	/* Loop 2: add all events */
3314
	for (i = 0; i < npevs; i++) {
3315 3316
		ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
					       pevs[i].ntevs,
3317
					       probe_conf.force_add);
3318 3319 3320
		if (ret < 0)
			break;
	}
3321 3322 3323
	return ret;
}

3324
void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3325 3326 3327
{
	int i, j;

3328 3329
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
3330 3331 3332 3333
		for (j = 0; j < pevs[i].ntevs; j++)
			clear_probe_trace_event(&pevs[i].tevs[j]);
		zfree(&pevs[i].tevs);
		pevs[i].ntevs = 0;
3334
		clear_perf_probe_event(&pevs[i]);
3335
	}
3336 3337 3338 3339 3340 3341
}

int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
{
	int ret;

3342 3343 3344 3345
	ret = init_probe_symbol_maps(pevs->uprobes);
	if (ret < 0)
		return ret;

3346
	ret = convert_perf_probe_events(pevs, npevs);
3347
	if (ret == 0)
3348
		ret = apply_perf_probe_events(pevs, npevs);
3349

3350
	cleanup_perf_probe_events(pevs, npevs);
3351

3352
	exit_probe_symbol_maps();
3353
	return ret;
3354 3355
}

3356
int del_perf_probe_events(struct strfilter *filter)
3357
{
3358 3359 3360 3361 3362 3363
	int ret, ret2, ufd = -1, kfd = -1;
	char *str = strfilter__string(filter);

	if (!str)
		return -EINVAL;

3364
	/* Get current event names */
3365 3366 3367
	ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
	if (ret < 0)
		goto out;
3368

3369
	ret = probe_file__del_events(kfd, filter);
3370
	if (ret < 0 && ret != -ENOENT)
3371 3372
		goto error;

3373
	ret2 = probe_file__del_events(ufd, filter);
3374
	if (ret2 < 0 && ret2 != -ENOENT) {
3375
		ret = ret2;
3376 3377 3378
		goto error;
	}
	ret = 0;
3379 3380

error:
3381
	if (kfd >= 0)
3382
		close(kfd);
3383
	if (ufd >= 0)
3384
		close(ufd);
3385
out:
3386
	free(str);
3387 3388

	return ret;
3389
}
3390

3391 3392
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
3393
{
3394
        struct rb_node *nd;
3395 3396 3397
	struct map *map;
	int ret;

3398
	ret = init_probe_symbol_maps(user);
3399 3400 3401
	if (ret < 0)
		return ret;

3402
	/* Get a symbol map */
3403
	map = get_target_map(target, user);
3404
	if (!map) {
3405
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3406 3407
		return -EINVAL;
	}
3408

3409
	ret = map__load(map);
3410 3411 3412 3413 3414 3415 3416 3417 3418
	if (ret) {
		if (ret == -2) {
			char *str = strfilter__string(_filter);
			pr_err("Failed to find symbols matched to \"%s\"\n",
			       str);
			free(str);
		} else
			pr_err("Failed to load symbols in %s\n",
			       (target) ? : "kernel");
3419 3420 3421 3422
		goto end;
	}
	if (!dso__sorted_by_name(map->dso, map->type))
		dso__sort_by_name(map->dso, map->type);
3423

3424 3425
	/* Show all (filtered) symbols */
	setup_pager();
3426 3427 3428 3429 3430 3431 3432 3433

        for (nd = rb_first(&map->dso->symbol_names[map->type]); nd; nd = rb_next(nd)) {
		struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);

		if (strfilter__compare(_filter, pos->sym.name))
			printf("%s\n", pos->sym.name);
        }

3434
end:
3435
	map__put(map);
3436
	exit_probe_symbol_maps();
3437

3438
	return ret;
3439 3440
}

3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459
int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
			    struct perf_probe_arg *pvar)
{
	tvar->value = strdup(pvar->var);
	if (tvar->value == NULL)
		return -ENOMEM;
	if (pvar->type) {
		tvar->type = strdup(pvar->type);
		if (tvar->type == NULL)
			return -ENOMEM;
	}
	if (pvar->name) {
		tvar->name = strdup(pvar->name);
		if (tvar->name == NULL)
			return -ENOMEM;
	} else
		tvar->name = NULL;
	return 0;
}