probe-event.c 77.2 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 machine__findnew_module_map(host_machine, 0, 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 177 178 179 180 181
			return pos;
		}
	}
	return NULL;
}

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

static void put_target_map(struct map *map, bool user)
{
	if (map && user) {
		/* Only the user map needs to be released */
195
		map__put(map);
196 197 198 199
	}
}


200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
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;
	}

216 217 218 219 220 221 222
	for (ptr2 = ptr1; ptr2 != '\0'; ptr2++) {
		if (!isalnum(*ptr2) && *ptr2 != '_') {
			*ptr2 = '\0';
			break;
		}
	}

223 224 225 226 227 228 229 230 231 232 233 234
	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;
}

235 236 237 238 239 240 241
static void clear_perf_probe_point(struct perf_probe_point *pp)
{
	free(pp->file);
	free(pp->function);
	free(pp->lazy_line);
}

242 243 244 245 246 247 248 249
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);
}

250 251 252
static bool kprobe_blacklist__listed(unsigned long address);
static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
{
253 254
	u64 etext_addr = 0;
	int ret;
255

256
	/* Get the address of _etext for checking non-probable text symbol */
257 258
	ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
						false, false);
259

260
	if (ret == 0 && etext_addr < address)
261 262 263 264 265 266 267 268 269
		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;
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
/*
 * 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.
 */
#ifdef __LP64__
#define MOD_NAME_OFFSET 24
#else
#define MOD_NAME_OFFSET 12
#endif

/*
 * @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;

	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;

	mod_name = strdup((char *)data->d_buf + MOD_NAME_OFFSET);

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

329
#ifdef HAVE_DWARF_SUPPORT
330 331 332 333 334 335 336 337 338

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) {
339 340 341 342 343 344 345
		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;
346 347 348 349 350
		}
		pr_debug("Failed to find module %s.\n", module);
		return -ENOENT;
	}

351
	map = machine__kernel_map(host_machine);
352 353 354 355 356
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	dso->load_errno = 0;
	if (vmlinux_name)
357
		ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
358
	else
359
		ret = dso__load_vmlinux_path(dso, map);
360 361 362 363 364
found:
	*pdso = dso;
	return ret;
}

365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
/*
 * 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) {
390 391 392
		if (uprobes)
			address = sym->start;
		else
393
			address = map->unmap_ip(map, sym->start) - map->reloc;
394
		break;
395 396 397 398 399
	}
	if (!address) {
		ret = -ENOENT;
		goto out;
	}
W
Wang Nan 已提交
400 401
	pr_debug("Symbol %s address found : %" PRIx64 "\n",
			pp->function, address);
402 403 404 405 406 407 408 409

	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;
410
		result->retprobe = pp->retprobe;
411 412 413 414 415 416 417 418 419 420 421
		ret = 0;
	}

out:
	put_target_map(map, uprobes);
	return ret;

}

static int get_alternative_probe_event(struct debuginfo *dinfo,
				       struct perf_probe_event *pev,
422
				       struct perf_probe_point *tmp)
423 424 425 426 427 428
{
	int ret;

	memcpy(tmp, &pev->point, sizeof(*tmp));
	memset(&pev->point, 0, sizeof(pev->point));
	ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
429
					   pev->target, pev->uprobes);
430 431 432 433 434
	if (ret < 0)
		memcpy(&pev->point, tmp, sizeof(*tmp));

	return ret;
}
435

436 437 438 439
static int get_alternative_line_range(struct debuginfo *dinfo,
				      struct line_range *lr,
				      const char *target, bool user)
{
440 441 442 443
	struct perf_probe_point pp = { .function = lr->function,
				       .file = lr->file,
				       .line = lr->start };
	struct perf_probe_point result;
444 445
	int ret, len = 0;

446 447
	memset(&result, 0, sizeof(result));

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
	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;
}

463
/* Open new debuginfo of given module */
464
static struct debuginfo *open_debuginfo(const char *module, bool silent)
465
{
466
	const char *path = module;
467 468 469 470
	char reason[STRERR_BUFSIZE];
	struct debuginfo *ret = NULL;
	struct dso *dso = NULL;
	int err;
471

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

499 500 501 502 503 504
/* 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)
{
505 506 507 508 509 510 511
	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))
512 513 514 515
		goto out;

	/* Copy module path */
	free(debuginfo_cache_path);
516 517 518 519 520
	debuginfo_cache_path = strdup(path);
	if (!debuginfo_cache_path) {
		debuginfo__delete(debuginfo_cache);
		debuginfo_cache = NULL;
		goto out;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
	}

	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);
}

537

538 539 540 541 542 543 544 545 546 547 548 549
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);
550 551 552 553
	if (elf == NULL) {
		ret = -EINVAL;
		goto out_close;
	}
554 555 556 557 558 559 560 561 562 563 564

	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);
565 566 567
out_close:
	close(fd);

568 569 570
	return ret;
}

571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/*
 * 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;
593
	} else if (tp->symbol) {
594 595 596 597
		/* 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)
598 599 600 601 602 603 604
			goto error;
		addr += tp->offset;
	}

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

605 606
	dinfo = debuginfo_cache__open(tp->module, verbose == 0);
	if (dinfo)
607 608
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
609
	else
610 611 612 613 614 615 616 617 618 619 620
		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;
}

621 622 623 624
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
625
	unsigned long stext = 0;
626 627 628 629 630 631 632 633 634

	if (!exec)
		return 0;

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

	for (i = 0; i < ntevs && ret >= 0; i++) {
635
		/* point.address is the addres of point.symbol + point.offset */
636
		tevs[i].point.address -= stext;
637
		tevs[i].point.module = strdup(exec);
638
		if (!tevs[i].point.module) {
639 640 641 642 643 644 645 646 647
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

648 649 650
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
651
	int i, ret = 0;
652
	char *mod_name = NULL;
653 654 655 656

	if (!module)
		return 0;

657
	mod_name = find_module_name(module);
658

659
	for (i = 0; i < ntevs; i++) {
660 661
		tevs[i].point.module =
			strdup(mod_name ? mod_name : module);
662 663 664 665
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
666
	}
667

668
	free(mod_name);
669
	return ret;
670 671
}

672 673 674
static int
post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
				       int ntevs)
675 676 677
{
	struct ref_reloc_sym *reloc_sym;
	char *tmp;
678
	int i, skipped = 0;
679

680 681 682 683
	/* Skip post process if the target is an offline kernel */
	if (symbol_conf.ignore_vmlinux_buildid)
		return 0;

684
	reloc_sym = kernel_get_ref_reloc_sym();
685 686 687 688 689 690
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
691 692 693 694 695 696 697 698 699 700 701
		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;
702
		}
703 704 705 706 707 708 709 710
		/* 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;
711
	}
712
	return skipped;
713 714
}

715 716 717 718 719 720
void __weak
arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
				      int ntevs __maybe_unused)
{
}

721
/* Post processing the probe events */
722 723
static int post_process_probe_trace_events(struct perf_probe_event *pev,
					   struct probe_trace_event *tevs,
724 725 726
					   int ntevs, const char *module,
					   bool uprobe)
{
727
	int ret;
728

729 730 731
	if (uprobe)
		ret = add_exec_to_probe_trace_events(tevs, ntevs, module);
	else if (module)
732
		/* Currently ref_reloc_sym based probe is not for drivers */
733 734 735
		ret = add_module_to_probe_trace_events(tevs, ntevs, module);
	else
		ret = post_process_kernel_probe_trace_events(tevs, ntevs);
736

737 738 739 740
	if (ret >= 0)
		arch__post_process_probe_trace_events(pev, ntevs);

	return ret;
741 742
}

743
/* Try to find perf_probe_event with debuginfo */
744
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
745
					  struct probe_trace_event **tevs)
746 747
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
748
	struct perf_probe_point tmp;
749
	struct debuginfo *dinfo;
750
	int ntevs, ret = 0;
751

752
	dinfo = open_debuginfo(pev->target, !need_dwarf);
753
	if (!dinfo) {
754
		if (need_dwarf)
755 756
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
757 758 759
		return 0;
	}

760
	pr_debug("Try to find probe point from debuginfo.\n");
761
	/* Searching trace events corresponding to a probe event */
762
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
763

764
	if (ntevs == 0)	{  /* Not found, retry with an alternative */
765
		ret = get_alternative_probe_event(dinfo, pev, &tmp);
766
		if (!ret) {
767
			ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
768 769 770 771 772 773 774 775 776
			/*
			 * 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));
		}
	}

777
	debuginfo__delete(dinfo);
778

779
	if (ntevs > 0) {	/* Succeeded to find trace events */
780
		pr_debug("Found %d probe_trace_events.\n", ntevs);
781
		ret = post_process_probe_trace_events(pev, *tevs, ntevs,
782
						pev->target, pev->uprobes);
783
		if (ret < 0 || ret == ntevs) {
784 785 786
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
787 788 789 790
		if (ret != ntevs)
			return ret < 0 ? ret : ntevs;
		ntevs = 0;
		/* Fall through */
791
	}
792

793
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
794
		pr_warning("Probe point '%s' not found.\n",
795
			   synthesize_perf_probe_point(&pev->point));
796
		return -ENOENT;
797 798
	}
	/* Error path : ntevs < 0 */
799
	pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
800 801 802 803
	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");
804
		if (!need_dwarf) {
M
Masami Hiramatsu 已提交
805
			pr_debug("Trying to use symbols.\n");
806 807
			return 0;
		}
808
	}
809
	return ntevs;
810 811 812 813 814
}

#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

815
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
816
{
817
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
818 819
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
820

821
	do {
822 823
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
824 825 826 827 828
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
829
		}
830 831 832
		color_fprintf(stdout, color, "%s", buf);

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

834
	return 1;
835
error:
836
	if (ferror(fp)) {
837
		pr_warning("File read error: %s\n",
838
			   str_error_r(errno, sbuf, sizeof(sbuf)));
839 840 841 842
		return -1;
	}
	return 0;
}
843

844 845 846 847 848 849 850 851
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;
852 853
}

854 855 856 857 858
#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)

859 860 861 862
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
863 864
static int __show_line_range(struct line_range *lr, const char *module,
			     bool user)
865
{
866
	int l = 1;
867
	struct int_node *ln;
868
	struct debuginfo *dinfo;
869
	FILE *fp;
870
	int ret;
871
	char *tmp;
872
	char sbuf[STRERR_BUFSIZE];
873 874

	/* Search a line range */
875 876
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
877
		return -ENOENT;
878

879
	ret = debuginfo__find_line_range(dinfo, lr);
880 881 882 883 884
	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);
	}
885
	debuginfo__delete(dinfo);
886
	if (ret == 0 || ret == -ENOENT) {
887 888 889
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
890
		pr_warning("Debuginfo analysis failed.\n");
891 892
		return ret;
	}
893

894 895
	/* Convert source file path */
	tmp = lr->path;
896
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
897 898 899 900 901

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

902
	if (ret < 0) {
903
		pr_warning("Failed to find source file path.\n");
904 905 906
		return ret;
	}

907 908 909
	setup_pager();

	if (lr->function)
910
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
911 912
			lr->start - lr->offset);
	else
913
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
914 915

	fp = fopen(lr->path, "r");
916 917
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
918
			   str_error_r(errno, sbuf, sizeof(sbuf)));
919 920
		return -errno;
	}
921
	/* Skip to starting line number */
922
	while (l < lr->start) {
923
		ret = skip_one_line(fp, l++);
924 925 926
		if (ret < 0)
			goto end;
	}
927

928
	intlist__for_each_entry(ln, lr->line_list) {
929
		for (; ln->i > l; l++) {
930
			ret = show_one_line(fp, l - lr->offset);
931 932 933
			if (ret < 0)
				goto end;
		}
934
		ret = show_one_line_with_num(fp, l++ - lr->offset);
935 936
		if (ret < 0)
			goto end;
937 938 939 940
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
941 942 943
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
944 945
			break;
	}
946
end:
947
	fclose(fp);
948
	return ret;
949 950
}

951
int show_line_range(struct line_range *lr, const char *module, bool user)
952 953 954
{
	int ret;

955
	ret = init_probe_symbol_maps(user);
956 957
	if (ret < 0)
		return ret;
958
	ret = __show_line_range(lr, module, user);
959
	exit_probe_symbol_maps();
960 961 962 963

	return ret;
}

964 965
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
966
				  struct strfilter *_filter)
967 968
{
	char *buf;
969
	int ret, i, nvars;
970 971
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
972
	struct perf_probe_point tmp;
973
	const char *var;
974 975 976 977 978 979

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

980
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
981
	if (!ret) {  /* Not found, retry with an alternative */
982
		ret = get_alternative_probe_event(dinfo, pev, &tmp);
983 984
		if (!ret) {
			ret = debuginfo__find_available_vars_at(dinfo, pev,
985
								&vls);
986 987 988 989
			/* Release the old probe_point */
			clear_perf_probe_point(&tmp);
		}
	}
990
	if (ret <= 0) {
991 992 993 994 995
		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");
996 997
		goto end;
	}
998

999 1000 1001 1002 1003 1004 1005 1006 1007 1008
	/* 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);
1009
		zfree(&vl->point.symbol);
1010 1011
		nvars = 0;
		if (vl->vars) {
1012
			strlist__for_each_entry(node, vl->vars) {
1013 1014
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
1015
					fprintf(stdout, "\t\t%s\n", node->s);
1016 1017 1018 1019
					nvars++;
				}
			}
			strlist__delete(vl->vars);
1020
		}
1021 1022 1023 1024 1025
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
1026 1027 1028 1029 1030 1031
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
1032
			struct strfilter *_filter)
1033
{
1034 1035
	int i, ret = 0;
	struct debuginfo *dinfo;
1036

1037
	ret = init_probe_symbol_maps(pevs->uprobes);
1038 1039 1040
	if (ret < 0)
		return ret;

1041
	dinfo = open_debuginfo(pevs->target, false);
1042
	if (!dinfo) {
1043 1044
		ret = -ENOENT;
		goto out;
1045 1046
	}

1047 1048
	setup_pager();

1049
	for (i = 0; i < npevs && ret >= 0; i++)
1050
		ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1051 1052

	debuginfo__delete(dinfo);
1053
out:
1054
	exit_probe_symbol_maps();
1055 1056 1057
	return ret;
}

1058
#else	/* !HAVE_DWARF_SUPPORT */
1059

1060 1061 1062 1063
static void debuginfo_cache__exit(void)
{
}

1064 1065 1066 1067
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)
1068
{
1069
	return -ENOSYS;
1070 1071
}

1072
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1073
				struct probe_trace_event **tevs __maybe_unused)
1074
{
1075 1076 1077 1078
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
1079

1080 1081 1082
	return 0;
}

1083
int show_line_range(struct line_range *lr __maybe_unused,
1084 1085
		    const char *module __maybe_unused,
		    bool user __maybe_unused)
1086
{
1087 1088
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
1089 1090
}

1091
int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1092 1093
			int npevs __maybe_unused,
			struct strfilter *filter __maybe_unused)
1094 1095 1096 1097
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
1098 1099
#endif

1100 1101 1102 1103 1104 1105
void line_range__clear(struct line_range *lr)
{
	free(lr->function);
	free(lr->file);
	free(lr->path);
	free(lr->comp_dir);
1106
	intlist__delete(lr->line_list);
1107 1108 1109
	memset(lr, 0, sizeof(*lr));
}

1110
int line_range__init(struct line_range *lr)
1111 1112
{
	memset(lr, 0, sizeof(*lr));
1113 1114 1115 1116 1117
	lr->line_list = intlist__new(NULL);
	if (!lr->line_list)
		return -ENOMEM;
	else
		return 0;
1118 1119
}

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
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;
}

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
/* 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;
}

1145 1146 1147 1148 1149
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1150
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1151
 */
1152
int parse_line_range_desc(const char *arg, struct line_range *lr)
1153
{
1154
	char *range, *file, *name = strdup(arg);
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
	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--;
			}
		}
1189

1190
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1191 1192

		err = -EINVAL;
1193
		if (lr->start > lr->end) {
1194
			semantic_error("Start line must be smaller"
1195
				       " than end line.\n");
1196
			goto err;
1197
		}
1198 1199 1200
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
1201
		}
1202
	}
1203

1204 1205 1206 1207 1208 1209 1210 1211 1212
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
1213
	} else if (strchr(name, '/') || strchr(name, '.'))
1214
		lr->file = name;
1215
	else if (is_c_func_name(name))/* We reuse it for checking funcname */
1216
		lr->function = name;
1217 1218 1219 1220 1221
	else {	/* Invalid name */
		semantic_error("'%s' is not a valid function name.\n", name);
		err = -EINVAL;
		goto err;
	}
1222 1223

	return 0;
1224 1225 1226
err:
	free(name);
	return err;
1227 1228
}

1229 1230 1231 1232 1233 1234 1235
static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
{
	char *ptr;

	ptr = strchr(*arg, ':');
	if (ptr) {
		*ptr = '\0';
1236
		if (!pev->sdt && !is_c_func_name(*arg))
1237 1238 1239 1240 1241 1242 1243
			goto ng_name;
		pev->group = strdup(*arg);
		if (!pev->group)
			return -ENOMEM;
		*arg = ptr + 1;
	} else
		pev->group = NULL;
1244
	if (!pev->sdt && !is_c_func_name(*arg)) {
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
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;
}

1257
/* Parse probepoint definition. */
1258
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1259
{
1260
	struct perf_probe_point *pp = &pev->point;
1261 1262
	char *ptr, *tmp;
	char c, nc = 0;
1263
	bool file_spec = false;
1264 1265
	int ret;

1266 1267
	/*
	 * <Syntax>
1268 1269
	 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
	 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1270
	 * perf probe %[GRP:]SDT_EVENT
1271
	 */
1272 1273
	if (!arg)
		return -EINVAL;
1274

1275 1276 1277 1278 1279 1280 1281 1282
	/*
	 * 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, '='))) {
1283
		pev->sdt = true;
1284 1285
		if (arg[0] == '%')
			arg++;
1286 1287
	}

1288
	ptr = strpbrk(arg, ";=@+%");
1289
	if (pev->sdt) {
1290
		if (ptr) {
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
			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';
1306
		}
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
		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;

1322 1323 1324
		arg = tmp;
	}

1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
	/*
	 * 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;
	}

1342
	ptr = strpbrk(arg, ";:+@%");
1343 1344 1345 1346 1347
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1348 1349 1350 1351 1352 1353 1354
	if (arg[0] == '\0')
		tmp = NULL;
	else {
		tmp = strdup(arg);
		if (tmp == NULL)
			return -ENOMEM;
	}
1355

1356
	if (file_spec)
1357
		pp->file = tmp;
1358
	else {
1359
		pp->function = tmp;
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
		/*
		 * 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;
			}
		}
	}

1379 1380 1381 1382
	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1383
		if (c == ';') {	/* Lazy pattern must be the last part */
1384 1385 1386
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1387 1388 1389
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1390 1391 1392 1393 1394 1395 1396
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1397
			if (*tmp != '\0') {
1398
				semantic_error("There is non-digit char"
1399 1400 1401
					       " in line number.\n");
				return -EINVAL;
			}
1402 1403 1404
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1405
			if (*tmp != '\0') {
1406
				semantic_error("There is non-digit character"
1407 1408 1409
						" in offset.\n");
				return -EINVAL;
			}
1410 1411
			break;
		case '@':	/* File name */
1412 1413 1414 1415
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1416 1417 1418
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1419 1420 1421 1422
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1423 1424 1425 1426
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1427
			break;
1428 1429 1430 1431
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1432 1433 1434 1435 1436
			break;
		}
	}

	/* Exclusion check */
1437
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1438 1439
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1440 1441
		return -EINVAL;
	}
1442

1443
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
1444
		semantic_error("Lazy pattern can't be used with offset.\n");
1445 1446
		return -EINVAL;
	}
1447

1448
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1449
		semantic_error("Offset can't be used with line number.\n");
1450 1451
		return -EINVAL;
	}
1452

1453
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1454
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1455
			       "lazy pattern.\n");
1456 1457
		return -EINVAL;
	}
1458

1459
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1460
		semantic_error("Offset requires an entry function.\n");
1461 1462
		return -EINVAL;
	}
1463

1464
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1465
		semantic_error("Return probe requires an entry function.\n");
1466 1467
		return -EINVAL;
	}
1468

1469
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1470
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1471
			       "return probe.\n");
1472 1473
		return -EINVAL;
	}
1474

1475
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1476 1477
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1478
	return 0;
1479 1480
}

1481
/* Parse perf-probe event argument */
1482
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1483
{
1484
	char *tmp, *goodname;
1485 1486 1487 1488
	struct perf_probe_arg_field **fieldp;

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

1489 1490
	tmp = strchr(str, '=');
	if (tmp) {
1491 1492 1493
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1494
		pr_debug("name:%s ", arg->name);
1495 1496 1497
		str = tmp + 1;
	}

1498 1499 1500
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1501 1502 1503
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1504 1505 1506
		pr_debug("type:%s ", arg->type);
	}

1507
	tmp = strpbrk(str, "-.[");
1508 1509
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1510 1511 1512
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1513
		pr_debug("%s\n", arg->var);
1514
		return 0;
1515 1516
	}

1517
	/* Structure fields or array element */
1518 1519 1520
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1521
	goodname = arg->var;
1522
	pr_debug("%s, ", arg->var);
1523 1524 1525
	fieldp = &arg->field;

	do {
1526 1527 1528
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1529 1530 1531
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1532
			(*fieldp)->ref = true;
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
			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, "-.[");
1554
		}
1555
		if (tmp) {
1556 1557 1558
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1559 1560
			if (*str != '[')
				goodname = (*fieldp)->name;
1561 1562 1563 1564
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1565 1566 1567
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1568 1569
	if (*str != '[')
		goodname = (*fieldp)->name;
1570
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1571

1572
	/* If no name is specified, set the last field name (not array index)*/
1573
	if (!arg->name) {
1574
		arg->name = strdup(goodname);
1575 1576 1577
		if (arg->name == NULL)
			return -ENOMEM;
	}
1578
	return 0;
1579 1580
}

1581
/* Parse perf-probe event command */
1582
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1583
{
1584
	char **argv;
1585
	int argc, i, ret = 0;
1586

1587
	argv = argv_split(cmd, &argc);
1588 1589 1590 1591 1592 1593 1594 1595 1596
	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;
	}
1597
	/* Parse probe point */
1598 1599 1600
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1601

1602
	/* Copy arguments and ensure return probe has no C argument */
1603
	pev->nargs = argc - 1;
1604 1605 1606 1607 1608
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1609 1610 1611 1612
	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) {
1613
			semantic_error("You can't specify local variable for"
1614 1615 1616
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1617
	}
1618
out:
1619
	argv_free(argv);
1620 1621

	return ret;
1622 1623
}

1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
/* 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;
}

1637 1638 1639 1640 1641 1642
/* 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;

1643 1644
	if (perf_probe_with_var(pev))
		return true;
1645 1646 1647 1648

	return false;
}

1649
/* Parse probe_events event into struct probe_point */
1650
int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1651
{
1652
	struct probe_trace_point *tp = &tev->point;
1653 1654
	char pr;
	char *p;
1655
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1656 1657 1658
	int ret, i, argc;
	char **argv;

1659
	pr_debug("Parsing probe_events: %s\n", cmd);
1660
	argv = argv_split(cmd, &argc);
1661 1662 1663 1664 1665 1666 1667 1668 1669
	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;
	}
1670 1671

	/* Scan event and group name. */
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
	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) {
1682 1683 1684 1685
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1686 1687 1688 1689 1690 1691 1692
	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;
	}
1693
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1694

1695
	tp->retprobe = (pr == 'r');
1696

1697 1698 1699 1700
	/* Scan module name(if there), function name and offset */
	p = strchr(argv[1], ':');
	if (p) {
		tp->module = strndup(argv[1], p - argv[1]);
1701 1702 1703 1704
		if (!tp->module) {
			ret = -ENOMEM;
			goto out;
		}
1705
		tev->uprobes = (tp->module[0] == '/');
1706 1707 1708
		p++;
	} else
		p = argv[1];
1709
	fmt1_str = strtok_r(p, "+", &fmt);
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
	/* 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 {
1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
		/* 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);
1746
	}
1747

1748
	tev->nargs = argc - 2;
1749
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1750 1751 1752 1753
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1754
	for (i = 0; i < tev->nargs; i++) {
1755 1756
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1757 1758 1759
			*p++ = '\0';
		else
			p = argv[i + 2];
1760
		tev->args[i].name = strdup(argv[i + 2]);
1761
		/* TODO: parse regs and offset */
1762 1763 1764 1765 1766
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1767
	}
1768 1769
	ret = 0;
out:
1770
	free(argv0_str);
1771
	argv_free(argv);
1772
	return ret;
1773 1774
}

1775
/* Compose only probe arg */
1776
char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1777 1778
{
	struct perf_probe_arg_field *field = pa->field;
1779
	struct strbuf buf;
1780 1781 1782 1783 1784
	char *ret = NULL;
	int err;

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

1786
	if (pa->name && pa->var)
1787
		err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1788
	else
1789 1790 1791
		err = strbuf_addstr(&buf, pa->name ?: pa->var);
	if (err)
		goto out;
1792 1793

	while (field) {
1794
		if (field->name[0] == '[')
1795
			err = strbuf_addstr(&buf, field->name);
1796
		else
1797 1798
			err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
					  field->name);
1799
		field = field->next;
1800 1801
		if (err)
			goto out;
1802
	}
1803

1804
	if (pa->type)
1805 1806
		if (strbuf_addf(&buf, ":%s", pa->type) < 0)
			goto out;
1807 1808

	ret = strbuf_detach(&buf, NULL);
1809 1810
out:
	strbuf_release(&buf);
1811
	return ret;
1812 1813
}

1814
/* Compose only probe point (not argument) */
1815
char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1816
{
1817
	struct strbuf buf;
1818 1819 1820 1821 1822
	char *tmp, *ret = NULL;
	int len, err = 0;

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

	if (pp->function) {
1825 1826
		if (strbuf_addstr(&buf, pp->function) < 0)
			goto out;
1827
		if (pp->offset)
1828
			err = strbuf_addf(&buf, "+%lu", pp->offset);
1829
		else if (pp->line)
1830
			err = strbuf_addf(&buf, ":%d", pp->line);
1831
		else if (pp->retprobe)
1832 1833 1834
			err = strbuf_addstr(&buf, "%return");
		if (err)
			goto out;
1835 1836
	}
	if (pp->file) {
1837 1838 1839 1840 1841 1842
		tmp = pp->file;
		len = strlen(tmp);
		if (len > 30) {
			tmp = strchr(pp->file + len - 30, '/');
			tmp = tmp ? tmp + 1 : pp->file + len - 30;
		}
1843 1844 1845
		err = strbuf_addf(&buf, "@%s", tmp);
		if (!err && !pp->function && pp->line)
			err = strbuf_addf(&buf, ":%d", pp->line);
1846
	}
1847 1848 1849 1850 1851
	if (!err)
		ret = strbuf_detach(&buf, NULL);
out:
	strbuf_release(&buf);
	return ret;
1852 1853
}

1854
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1855
{
1856 1857 1858
	struct strbuf buf;
	char *tmp, *ret = NULL;
	int i;
1859

1860
	if (strbuf_init(&buf, 64))
1861
		return NULL;
1862 1863 1864 1865 1866 1867 1868 1869 1870
	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);
1871

1872
	for (i = 0; i < pev->nargs; i++) {
1873 1874 1875 1876
		tmp = synthesize_perf_probe_arg(pev->args + i);
		if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
			goto out;
		free(tmp);
1877 1878
	}

1879 1880 1881 1882
	ret = strbuf_detach(&buf, NULL);
out:
	strbuf_release(&buf);
	return ret;
1883 1884
}

1885
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1886
					    struct strbuf *buf, int depth)
1887
{
1888
	int err;
1889
	if (ref->next) {
1890
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1891
							 depth + 1);
1892
		if (depth < 0)
1893
			return depth;
1894
	}
1895 1896
	err = strbuf_addf(buf, "%+ld(", ref->offset);
	return (err < 0) ? err : depth;
1897 1898
}

1899
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1900
				      struct strbuf *buf)
1901
{
1902
	struct probe_trace_arg_ref *ref = arg->ref;
1903
	int depth = 0, err;
1904 1905 1906

	/* Argument name or separator */
	if (arg->name)
1907
		err = strbuf_addf(buf, " %s=", arg->name);
1908
	else
1909 1910 1911
		err = strbuf_addch(buf, ' ');
	if (err)
		return err;
1912

1913 1914 1915 1916
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1917
	/* Dereferencing arguments */
1918
	if (ref) {
1919
		depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
1920 1921 1922 1923 1924
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1925
	if (arg->value[0] == '@' && arg->ref)
1926
		err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
1927
	else
1928
		err = strbuf_addstr(buf, arg->value);
1929 1930

	/* Closing */
1931 1932 1933
	while (!err && depth--)
		err = strbuf_addch(buf, ')');

1934
	/* Print argument type */
1935 1936
	if (!err && arg->type)
		err = strbuf_addf(buf, ":%s", arg->type);
1937

1938
	return err;
1939 1940
}

1941
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1942
{
1943
	struct probe_trace_point *tp = &tev->point;
1944 1945
	struct strbuf buf;
	char *ret = NULL;
1946
	int i, err;
1947

1948 1949
	/* Uprobes must have tp->module */
	if (tev->uprobes && !tp->module)
1950 1951
		return NULL;

1952 1953 1954 1955 1956 1957
	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;
1958 1959 1960 1961 1962 1963 1964 1965 1966 1967
	/*
	 * 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;
	}
1968 1969

	/* Use the tp->address for uprobes */
1970
	if (tev->uprobes)
1971
		err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address);
1972 1973
	else if (!strncmp(tp->symbol, "0x", 2))
		/* Absolute address. See try_to_find_absolute_address() */
1974 1975
		err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
				  tp->module ? ":" : "", tp->address);
1976
	else
1977 1978 1979 1980
		err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
				tp->module ? ":" : "", tp->symbol, tp->offset);
	if (err)
		goto error;
1981

1982 1983
	for (i = 0; i < tev->nargs; i++)
		if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
1984 1985
			goto error;

1986
	ret = strbuf_detach(&buf, NULL);
1987
error:
1988 1989
	strbuf_release(&buf);
	return ret;
1990
}
1991

1992 1993 1994 1995 1996 1997
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;
1998
	u64 addr = tp->address;
1999 2000 2001 2002 2003 2004
	int ret = -ENOENT;

	if (!is_kprobe) {
		map = dso__new_map(tp->module);
		if (!map)
			goto out;
2005
		sym = map__find_symbol(map, addr);
2006
	} else {
2007
		if (tp->symbol && !addr) {
2008 2009
			if (kernel_get_symbol_address_by_name(tp->symbol,
						&addr, true, false) < 0)
2010 2011
				goto out;
		}
2012 2013 2014 2015 2016
		if (addr) {
			addr += tp->offset;
			sym = __find_kernel_function(addr, &map);
		}
	}
2017

2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
	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) {
2028
		map__put(map);
2029 2030 2031 2032 2033 2034
	}

	return ret;
}

static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2035 2036
				       struct perf_probe_point *pp,
				       bool is_kprobe)
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
{
	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;
2053
	} else {
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
		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;
}

2068
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2069
			       struct perf_probe_event *pev, bool is_kprobe)
2070
{
2071
	struct strbuf buf = STRBUF_INIT;
2072
	int i, ret;
2073

2074
	/* Convert event/group name */
2075 2076 2077 2078
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
2079

2080
	/* Convert trace_point to probe_point */
2081
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2082 2083
	if (ret < 0)
		return ret;
2084

2085 2086
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
2087 2088 2089
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
2090
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
2091
		if (tev->args[i].name)
2092
			pev->args[i].name = strdup(tev->args[i].name);
2093
		else {
2094 2095
			if ((ret = strbuf_init(&buf, 32)) < 0)
				goto error;
2096 2097
			ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
			pev->args[i].name = strbuf_detach(&buf, NULL);
2098
		}
2099 2100 2101
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
2102
error:
2103 2104 2105 2106
	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
2107 2108 2109 2110
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
2111
	struct perf_probe_arg_field *field, *next;
2112 2113
	int i;

2114 2115
	free(pev->event);
	free(pev->group);
2116
	free(pev->target);
2117
	clear_perf_probe_point(&pev->point);
2118

2119
	for (i = 0; i < pev->nargs; i++) {
2120 2121 2122
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
2123 2124 2125
		field = pev->args[i].field;
		while (field) {
			next = field->next;
2126
			zfree(&field->name);
2127 2128 2129 2130
			free(field);
			field = next;
		}
	}
2131
	free(pev->args);
2132 2133 2134
	memset(pev, 0, sizeof(*pev));
}

2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 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
#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;
}

2208
void clear_probe_trace_event(struct probe_trace_event *tev)
2209
{
2210
	struct probe_trace_arg_ref *ref, *next;
2211 2212
	int i;

2213 2214 2215
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
2216
	free(tev->point.realname);
2217
	free(tev->point.module);
2218
	for (i = 0; i < tev->nargs; i++) {
2219 2220 2221
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
2222 2223 2224 2225 2226 2227 2228
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
2229
	free(tev->args);
2230
	memset(tev, 0, sizeof(*tev));
2231 2232
}

2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255
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;
2256
	const char *__debugfs = debugfs__mountpoint();
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 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 2294 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
	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;
}

2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
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);
}

2343 2344
static int perf_probe_event__sprintf(const char *group, const char *event,
				     struct perf_probe_event *pev,
2345 2346
				     const char *module,
				     struct strbuf *result)
2347
{
2348
	int i, ret;
2349
	char *buf;
2350

2351 2352
	if (asprintf(&buf, "%s:%s", group, event) < 0)
		return -errno;
2353
	ret = strbuf_addf(result, "  %-20s (on ", buf);
2354
	free(buf);
2355 2356
	if (ret)
		return ret;
2357

2358 2359 2360 2361
	/* Synthesize only event probe point */
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return -ENOMEM;
2362
	ret = strbuf_addstr(result, buf);
2363
	free(buf);
2364

2365 2366
	if (!ret && module)
		ret = strbuf_addf(result, " in %s", module);
2367

2368 2369 2370
	if (!ret && pev->nargs > 0) {
		ret = strbuf_add(result, " with", 5);
		for (i = 0; !ret && i < pev->nargs; i++) {
2371 2372 2373
			buf = synthesize_perf_probe_arg(&pev->args[i]);
			if (!buf)
				return -ENOMEM;
2374
			ret = strbuf_addf(result, " %s", buf);
2375
			free(buf);
2376
		}
2377
	}
2378 2379
	if (!ret)
		ret = strbuf_addch(result, ')');
2380

2381
	return ret;
2382 2383
}

2384
/* Show an event */
2385 2386 2387
int show_perf_probe_event(const char *group, const char *event,
			  struct perf_probe_event *pev,
			  const char *module, bool use_stdout)
2388 2389 2390 2391
{
	struct strbuf buf = STRBUF_INIT;
	int ret;

2392
	ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403
	if (ret >= 0) {
		if (use_stdout)
			printf("%s\n", buf.buf);
		else
			pr_info("%s\n", buf.buf);
	}
	strbuf_release(&buf);

	return ret;
}

2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420
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)
2421
{
2422
	int ret = 0;
2423
	struct probe_trace_event tev;
2424
	struct perf_probe_event pev;
2425 2426 2427
	struct strlist *rawlist;
	struct str_node *ent;

2428 2429
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2430

2431
	rawlist = probe_file__get_rawlist(fd);
2432
	if (!rawlist)
2433
		return -ENOMEM;
2434

2435
	strlist__for_each_entry(ent, rawlist) {
2436
		ret = parse_probe_trace_command(ent->s, &tev);
2437
		if (ret >= 0) {
2438 2439
			if (!filter_probe_trace_event(&tev, filter))
				goto next;
2440 2441
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2442 2443
			if (ret < 0)
				goto next;
2444 2445
			ret = show_perf_probe_event(pev.group, pev.event,
						    &pev, tev.point.module,
2446
						    true);
2447
		}
2448
next:
2449
		clear_perf_probe_event(&pev);
2450
		clear_probe_trace_event(&tev);
2451 2452
		if (ret < 0)
			break;
2453 2454
	}
	strlist__delete(rawlist);
2455 2456
	/* Cleanup cached debuginfo if needed */
	debuginfo_cache__exit();
2457 2458

	return ret;
2459 2460
}

2461
/* List up current perf-probe events */
2462
int show_perf_probe_events(struct strfilter *filter)
2463
{
2464
	int kp_fd, up_fd, ret;
2465 2466 2467

	setup_pager();

2468 2469 2470
	if (probe_conf.cache)
		return probe_cache__show_all_caches(filter);

2471
	ret = init_probe_symbol_maps(false);
2472 2473 2474
	if (ret < 0)
		return ret;

2475 2476 2477
	ret = probe_file__open_both(&kp_fd, &up_fd, 0);
	if (ret < 0)
		return ret;
2478

2479 2480 2481
	if (kp_fd >= 0)
		ret = __show_perf_probe_events(kp_fd, true, filter);
	if (up_fd >= 0 && ret >= 0)
2482
		ret = __show_perf_probe_events(up_fd, false, filter);
2483 2484 2485
	if (kp_fd > 0)
		close(kp_fd);
	if (up_fd > 0)
2486
		close(up_fd);
2487
	exit_probe_symbol_maps();
2488

2489
	return ret;
2490 2491
}

2492 2493
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2494 2495
{
	int i, ret;
2496
	char *p, *nbase;
2497

2498 2499
	if (*base == '.')
		base++;
2500 2501 2502 2503 2504 2505 2506 2507
	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';
2508

2509 2510
	/* Try no suffix number */
	ret = e_snprintf(buf, len, "%s", nbase);
2511
	if (ret < 0) {
2512
		pr_debug("snprintf() failed: %d\n", ret);
2513
		goto out;
2514
	}
2515
	if (!strlist__has_entry(namelist, buf))
2516
		goto out;
2517

2518
	if (!allow_suffix) {
2519 2520 2521 2522 2523
		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);
2524 2525
		ret = -EEXIST;
		goto out;
2526 2527
	}

2528 2529
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2530
		ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2531
		if (ret < 0) {
2532
			pr_debug("snprintf() failed: %d\n", ret);
2533
			goto out;
2534
		}
2535 2536 2537
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2538 2539 2540 2541 2542
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

2543 2544
out:
	free(nbase);
2545
	return ret;
2546 2547
}

2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
/* 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);
}

2569 2570 2571 2572 2573 2574 2575 2576 2577 2578
/* 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;

2579
	/* If probe_event or trace_event already have the name, reuse it */
2580
	if (pev->event && !pev->sdt)
2581
		event = pev->event;
2582 2583 2584 2585
	else if (tev->event)
		event = tev->event;
	else {
		/* Or generate new one from probe point */
2586 2587 2588
		if (pev->point.function &&
			(strncmp(pev->point.function, "0x", 2) != 0) &&
			!strisglob(pev->point.function))
2589 2590 2591
			event = pev->point.function;
		else
			event = tev->point.realname;
2592
	}
2593
	if (pev->group && !pev->sdt)
2594
		group = pev->group;
2595 2596
	else if (tev->group)
		group = tev->group;
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
	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;
}

2618 2619
static int __open_probe_file_and_namelist(bool uprobe,
					  struct strlist **namelist)
2620
{
2621
	int fd;
2622

2623
	fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2624
	if (fd < 0)
2625
		return fd;
2626

2627
	/* Get current event names */
2628 2629
	*namelist = probe_file__get_namelist(fd);
	if (!(*namelist)) {
2630
		pr_debug("Failed to get current event list.\n");
2631 2632
		close(fd);
		return -ENOMEM;
2633
	}
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649
	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];
2650

2651
	ret = 0;
2652
	for (i = 0; i < ntevs; i++) {
2653
		tev = &tevs[i];
2654 2655 2656 2657 2658 2659 2660
		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;
		}
2661
		/* Skip if the symbol is out of .text or blacklisted */
2662
		if (!tev->point.symbol && !pev->uprobes)
2663
			continue;
2664

2665
		/* Set new name for tev (and update namelist) */
2666
		ret = probe_trace_event__set_name(tev, pev, namelist[up],
2667
						  allow_suffix);
2668 2669
		if (ret < 0)
			break;
2670

2671
		ret = probe_file__add_event(fd[up], tev);
2672 2673
		if (ret < 0)
			break;
2674 2675 2676 2677 2678 2679 2680 2681

		/*
		 * 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;
2682
	}
2683 2684
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2685 2686 2687 2688 2689 2690 2691 2692
	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);
	}
2693

2694
close_out:
2695 2696 2697 2698 2699
	for (up = 0; up < 2; up++) {
		strlist__delete(namelist[up]);
		if (fd[up] >= 0)
			close(fd[up]);
	}
2700
	return ret;
2701
}
2702

2703 2704
static int find_probe_functions(struct map *map, char *name,
				struct symbol **syms)
2705
{
2706
	int found = 0;
2707
	struct symbol *sym;
2708
	struct rb_node *tmp;
2709

2710
	if (map__load(map) < 0)
2711 2712
		return 0;

2713
	map__for_each_symbol(map, sym, tmp) {
2714
		if (strglobmatch(sym->name, name)) {
2715
			found++;
2716 2717 2718
			if (syms && found < probe_conf.max_probes)
				syms[found - 1] = sym;
		}
2719
	}
2720 2721

	return found;
2722 2723
}

2724 2725
void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
				struct probe_trace_event *tev __maybe_unused,
2726 2727
				struct map *map __maybe_unused,
				struct symbol *sym __maybe_unused) { }
2728

2729 2730 2731 2732 2733
/*
 * 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,
2734
					    struct probe_trace_event **tevs)
2735
{
2736 2737
	struct map *map = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2738
	struct symbol *sym;
2739
	struct symbol **syms = NULL;
2740
	struct probe_trace_event *tev;
2741 2742
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2743
	int num_matched_functions;
2744
	int ret, i, j, skipped = 0;
2745
	char *mod_name;
2746

2747
	map = get_target_map(pev->target, pev->uprobes);
2748 2749 2750
	if (!map) {
		ret = -EINVAL;
		goto out;
2751 2752
	}

2753 2754 2755 2756 2757 2758
	syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
	if (!syms) {
		ret = -ENOMEM;
		goto out;
	}

2759 2760 2761 2762
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2763
	num_matched_functions = find_probe_functions(map, pp->function, syms);
2764
	if (num_matched_functions == 0) {
2765
		pr_err("Failed to find symbol %s in %s\n", pp->function,
2766
			pev->target ? : "kernel");
2767 2768
		ret = -ENOENT;
		goto out;
2769
	} else if (num_matched_functions > probe_conf.max_probes) {
2770
		pr_err("Too many functions matched in %s\n",
2771
			pev->target ? : "kernel");
2772 2773
		ret = -E2BIG;
		goto out;
2774 2775
	}

2776 2777
	/* Note that the symbols in the kmodule are not relocated */
	if (!pev->uprobes && !pp->retprobe && !pev->target) {
2778
		reloc_sym = kernel_get_ref_reloc_sym();
2779 2780 2781 2782 2783 2784
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2785

2786 2787 2788
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2789
		ret = -ENOMEM;
2790
		goto out;
2791
	}
2792

2793
	ret = 0;
2794

2795 2796 2797
	for (j = 0; j < num_matched_functions; j++) {
		sym = syms[j];

2798 2799 2800 2801 2802
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2803
		}
2804
		ret++;
2805

2806 2807 2808 2809 2810 2811 2812 2813
		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;
2814 2815 2816

		/* Check the kprobe (not in module) is within .text  */
		if (!pev->uprobes && !pev->target &&
2817 2818 2819 2820
		    kprobe_warn_out_range(sym->name, tp->address)) {
			tp->symbol = NULL;	/* Skip it */
			skipped++;
		} else if (reloc_sym) {
2821 2822 2823 2824 2825 2826
			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;
		}
2827 2828
		tp->realname = strdup_or_goto(sym->name, nomem_out);

2829
		tp->retprobe = pp->retprobe;
2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842
		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;
			}
		}
2843 2844 2845 2846 2847 2848 2849
		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;
2850
		}
2851
		for (i = 0; i < tev->nargs; i++) {
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862
			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);
2863
		}
2864
		arch__fix_tev_from_maps(pev, tev, map, sym);
2865
	}
2866 2867 2868 2869
	if (ret == skipped) {
		ret = -ENOENT;
		goto err_out;
	}
2870

2871
out:
2872
	put_target_map(map, pev->uprobes);
2873
	free(syms);
2874
	return ret;
2875

2876 2877 2878 2879 2880 2881 2882
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2883

2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 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
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;
}

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 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
/* 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;
}

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 3108 3109 3110 3111
/* 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;
}

3112 3113 3114 3115 3116 3117 3118 3119 3120
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;

3121
	if (pev->sdt) {
3122
		/* For SDT/cached events, we use special search functions */
3123 3124 3125 3126 3127
		if (!pev->target)
			return find_cached_events_all(pev, tevs);
		else
			return find_cached_events(pev, tevs, pev->target);
	}
3128 3129 3130 3131 3132 3133
	cache = probe_cache__new(pev->target);
	if (!cache)
		return 0;

	entry = probe_cache__find(cache, pev);
	if (!entry) {
3134 3135
		/* SDT must be in the cache */
		ret = pev->sdt ? -ENOENT : 0;
3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168
		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;
}

3169
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3170
					 struct probe_trace_event **tevs)
3171 3172 3173
{
	int ret;

3174
	if (!pev->group && !pev->sdt) {
3175 3176 3177 3178 3179 3180
		/* 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);
3181 3182 3183 3184
		if (ret != 0) {
			pr_warning("Failed to make a group name.\n");
			return ret;
		}
3185
	}
3186

3187 3188 3189 3190
	ret = try_to_find_absolute_address(pev, tevs);
	if (ret > 0)
		return ret;

3191 3192
	/* At first, we need to lookup cache entry */
	ret = find_probe_trace_events_from_cache(pev, tevs);
3193 3194
	if (ret > 0 || pev->sdt)	/* SDT can be found only in the cache */
		return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3195

3196
	/* Convert perf_probe_event with debuginfo */
3197
	ret = try_to_find_probe_trace_events(pev, tevs);
3198 3199 3200
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

3201
	return find_probe_trace_events_from_map(pev, tevs);
3202 3203
}

3204
int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3205
{
3206
	int i, ret;
3207 3208 3209

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
3210
		/* Init kprobe blacklist if needed */
3211
		if (!pevs[i].uprobes)
3212
			kprobe_blacklist__init();
3213
		/* Convert with or without debuginfo */
3214
		ret  = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3215
		if (ret < 0)
3216
			return ret;
3217
		pevs[i].ntevs = ret;
3218
	}
3219 3220
	/* This just release blacklist only if allocated */
	kprobe_blacklist__release();
3221

3222 3223 3224
	return 0;
}

3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270
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;
}

3271
int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3272 3273 3274
{
	int i, ret = 0;

3275
	/* Loop 2: add all events */
3276
	for (i = 0; i < npevs; i++) {
3277 3278
		ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
					       pevs[i].ntevs,
3279
					       probe_conf.force_add);
3280 3281 3282
		if (ret < 0)
			break;
	}
3283 3284 3285
	return ret;
}

3286
void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3287 3288 3289
{
	int i, j;

3290 3291
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
3292 3293 3294 3295
		for (j = 0; j < pevs[i].ntevs; j++)
			clear_probe_trace_event(&pevs[i].tevs[j]);
		zfree(&pevs[i].tevs);
		pevs[i].ntevs = 0;
3296
		clear_perf_probe_event(&pevs[i]);
3297
	}
3298 3299 3300 3301 3302 3303
}

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

3304 3305 3306 3307
	ret = init_probe_symbol_maps(pevs->uprobes);
	if (ret < 0)
		return ret;

3308
	ret = convert_perf_probe_events(pevs, npevs);
3309
	if (ret == 0)
3310
		ret = apply_perf_probe_events(pevs, npevs);
3311

3312
	cleanup_perf_probe_events(pevs, npevs);
3313

3314
	exit_probe_symbol_maps();
3315
	return ret;
3316 3317
}

3318
int del_perf_probe_events(struct strfilter *filter)
3319
{
3320 3321 3322 3323 3324 3325
	int ret, ret2, ufd = -1, kfd = -1;
	char *str = strfilter__string(filter);

	if (!str)
		return -EINVAL;

3326
	/* Get current event names */
3327 3328 3329
	ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
	if (ret < 0)
		goto out;
3330

3331
	ret = probe_file__del_events(kfd, filter);
3332
	if (ret < 0 && ret != -ENOENT)
3333 3334
		goto error;

3335
	ret2 = probe_file__del_events(ufd, filter);
3336
	if (ret2 < 0 && ret2 != -ENOENT) {
3337
		ret = ret2;
3338 3339 3340
		goto error;
	}
	ret = 0;
3341 3342

error:
3343
	if (kfd >= 0)
3344
		close(kfd);
3345
	if (ufd >= 0)
3346
		close(ufd);
3347
out:
3348
	free(str);
3349 3350

	return ret;
3351
}
3352

3353 3354
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
3355
{
3356
        struct rb_node *nd;
3357 3358 3359
	struct map *map;
	int ret;

3360
	ret = init_probe_symbol_maps(user);
3361 3362 3363
	if (ret < 0)
		return ret;

3364 3365 3366 3367 3368
	/* Get a symbol map */
	if (user)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
3369
	if (!map) {
3370
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3371 3372
		return -EINVAL;
	}
3373

3374
	ret = map__load(map);
3375 3376 3377 3378 3379 3380 3381 3382 3383
	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");
3384 3385 3386 3387
		goto end;
	}
	if (!dso__sorted_by_name(map->dso, map->type))
		dso__sort_by_name(map->dso, map->type);
3388

3389 3390
	/* Show all (filtered) symbols */
	setup_pager();
3391 3392 3393 3394 3395 3396 3397 3398

        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);
        }

3399 3400
end:
	if (user) {
3401
		map__put(map);
3402
	}
3403
	exit_probe_symbol_maps();
3404

3405
	return ret;
3406 3407
}

3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
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;
}