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

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

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

#define MAX_CMDLEN 256
#define PERFPROBE_GROUP "probe"

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

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

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

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

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

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

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

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

93 94 95 96 97 98 99 100
	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;
101
	}
102 103 104 105
out:
	if (ret < 0)
		pr_warning("Failed to init vmlinux path.\n");
	return ret;
106 107
}

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

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

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

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

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

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

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

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

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

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

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

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

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
static struct map *get_target_map(const char *target, bool user)
{
	/* 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 */
		dso__delete(map->dso);
		map__delete(map);
	}
}


201
static struct dso *kernel_get_module_dso(const char *module)
202 203
{
	struct dso *dso;
204 205
	struct map *map;
	const char *vmlinux_name;
206 207

	if (module) {
208 209
		list_for_each_entry(dso, &host_machine->kernel_dsos.head,
				    node) {
210 211 212 213 214 215
			if (strncmp(dso->short_name + 1, module,
				    dso->short_name_len - 2) == 0)
				goto found;
		}
		pr_debug("Failed to find module %s.\n", module);
		return NULL;
216 217
	}

218
	map = host_machine->vmlinux_maps[MAP__FUNCTION];
219 220 221 222
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	if (vmlinux_name) {
223
		if (dso__load_vmlinux(dso, map, vmlinux_name, false, NULL) <= 0)
224
			return NULL;
225
	} else {
226
		if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
227 228 229 230 231
			pr_debug("Failed to load kernel map.\n");
			return NULL;
		}
	}
found:
232 233 234 235 236 237 238
	return dso;
}

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

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
static int convert_exec_to_group(const char *exec, char **result)
{
	char *ptr1, *ptr2, *exec_copy;
	char buf[64];
	int ret;

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

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

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

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

out:
	free(exec_copy);
	return ret;
}

272 273 274 275 276 277 278
static void clear_perf_probe_point(struct perf_probe_point *pp)
{
	free(pp->file);
	free(pp->function);
	free(pp->lazy_line);
}

279 280 281 282 283 284 285 286
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);
}

287
#ifdef HAVE_DWARF_SUPPORT
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
/*
 * 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) {
313 314 315 316
		if (uprobes)
			address = sym->start;
		else
			address = map->unmap_ip(map, sym->start);
317
		break;
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
	}
	if (!address) {
		ret = -ENOENT;
		goto out;
	}
	pr_debug("Symbol %s address found : %lx\n", pp->function, address);

	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;
		ret = 0;
	}

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

}

static int get_alternative_probe_event(struct debuginfo *dinfo,
				       struct perf_probe_event *pev,
				       struct perf_probe_point *tmp,
				       const char *target)
{
	int ret;

	memcpy(tmp, &pev->point, sizeof(*tmp));
	memset(&pev->point, 0, sizeof(pev->point));
	ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
					   target, pev->uprobes);
	if (ret < 0)
		memcpy(&pev->point, tmp, sizeof(*tmp));

	return ret;
}
357

358 359 360 361
static int get_alternative_line_range(struct debuginfo *dinfo,
				      struct line_range *lr,
				      const char *target, bool user)
{
362 363 364 365
	struct perf_probe_point pp = { .function = lr->function,
				       .file = lr->file,
				       .line = lr->start };
	struct perf_probe_point result;
366 367
	int ret, len = 0;

368 369
	memset(&result, 0, sizeof(result));

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	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;
}

385
/* Open new debuginfo of given module */
386
static struct debuginfo *open_debuginfo(const char *module, bool silent)
387
{
388
	const char *path = module;
389
	struct debuginfo *ret;
390

391
	if (!module || !strchr(module, '/')) {
392 393
		path = kernel_get_module_path(module);
		if (!path) {
394 395 396
			if (!silent)
				pr_err("Failed to find path of %s module.\n",
				       module ?: "kernel");
397 398
			return NULL;
		}
399
	}
400 401 402 403 404 405 406 407 408 409
	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;
410
}
411

412

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
static int get_text_start_address(const char *exec, unsigned long *address)
{
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;
	int fd, ret = -ENOENT;

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

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

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

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

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

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
/*
 * Convert trace point to probe point with debuginfo
 */
static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
					    struct perf_probe_point *pp,
					    bool is_kprobe)
{
	struct debuginfo *dinfo = NULL;
	unsigned long stext = 0;
	u64 addr = tp->address;
	int ret = -ENOENT;

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

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

473
	dinfo = open_debuginfo(tp->module, verbose == 0);
474 475 476 477
	if (dinfo) {
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
		debuginfo__delete(dinfo);
478
	} else
479 480 481 482 483 484 485 486 487 488 489
		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;
}

490 491 492 493
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
494
	unsigned long stext = 0;
495 496 497 498 499 500 501 502 503

	if (!exec)
		return 0;

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

	for (i = 0; i < ntevs && ret >= 0; i++) {
504
		/* point.address is the addres of point.symbol + point.offset */
505
		tevs[i].point.address -= stext;
506
		tevs[i].point.module = strdup(exec);
507
		if (!tevs[i].point.module) {
508 509 510 511 512 513 514 515 516
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

517 518 519
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
	int i, ret = 0;
	char *tmp;

	if (!module)
		return 0;

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

538 539
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
540 541 542 543
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
544
	}
545

546
	free(tmp);
547
	return ret;
548 549
}

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/* Post processing the probe events */
static int post_process_probe_trace_events(struct probe_trace_event *tevs,
					   int ntevs, const char *module,
					   bool uprobe)
{
	struct ref_reloc_sym *reloc_sym;
	char *tmp;
	int i;

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

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

566
	reloc_sym = kernel_get_ref_reloc_sym();
567 568 569 570 571 572
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
573
		if (tevs[i].point.address && !tevs[i].point.retprobe) {
574 575 576 577 578 579 580 581 582 583 584 585
			tmp = strdup(reloc_sym->name);
			if (!tmp)
				return -ENOMEM;
			free(tevs[i].point.symbol);
			tevs[i].point.symbol = tmp;
			tevs[i].point.offset = tevs[i].point.address -
					       reloc_sym->unrelocated_addr;
		}
	}
	return 0;
}

586
/* Try to find perf_probe_event with debuginfo */
587
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
588
					  struct probe_trace_event **tevs,
589
					  int max_tevs, const char *target)
590 591
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
592
	struct perf_probe_point tmp;
593
	struct debuginfo *dinfo;
594
	int ntevs, ret = 0;
595

596
	dinfo = open_debuginfo(target, !need_dwarf);
597

598
	if (!dinfo) {
599
		if (need_dwarf)
600 601
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
602 603 604
		return 0;
	}

605
	pr_debug("Try to find probe point from debuginfo.\n");
606 607 608
	/* Searching trace events corresponding to a probe event */
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);

609 610 611 612 613 614 615 616 617 618 619 620 621 622
	if (ntevs == 0)	{  /* Not found, retry with an alternative */
		ret = get_alternative_probe_event(dinfo, pev, &tmp, target);
		if (!ret) {
			ntevs = debuginfo__find_trace_events(dinfo, pev,
							     tevs, max_tevs);
			/*
			 * 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));
		}
	}

623
	debuginfo__delete(dinfo);
624

625
	if (ntevs > 0) {	/* Succeeded to find trace events */
626 627 628
		pr_debug("Found %d probe_trace_events.\n", ntevs);
		ret = post_process_probe_trace_events(*tevs, ntevs,
							target, pev->uprobes);
629 630 631 632
		if (ret < 0) {
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
633
		return ret < 0 ? ret : ntevs;
634
	}
635

636
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
637
		pr_warning("Probe point '%s' not found.\n",
638
			   synthesize_perf_probe_point(&pev->point));
639
		return -ENOENT;
640 641
	}
	/* Error path : ntevs < 0 */
642 643 644 645 646
	pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
	if (ntevs == -EBADF) {
		pr_warning("Warning: No dwarf info found in the vmlinux - "
			"please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
		if (!need_dwarf) {
M
Masami Hiramatsu 已提交
647
			pr_debug("Trying to use symbols.\n");
648 649
			return 0;
		}
650
	}
651
	return ntevs;
652 653
}

654 655 656 657 658 659
/*
 * Find a src file from a DWARF tag path. Prepend optional source path prefix
 * and chop off leading directories that do not exist. Result is passed back as
 * a newly allocated path on success.
 * Return 0 if file was found and readable, -errno otherwise.
 */
660 661
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
662
{
663 664 665 666 667 668 669 670 671
	const char *prefix = symbol_conf.source_prefix;

	if (!prefix) {
		if (raw_path[0] != '/' && comp_dir)
			/* If not an absolute path, try to use comp_dir */
			prefix = comp_dir;
		else {
			if (access(raw_path, R_OK) == 0) {
				*new_path = strdup(raw_path);
672
				return *new_path ? 0 : -ENOMEM;
673 674 675
			} else
				return -errno;
		}
676 677
	}

678
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
679 680 681 682
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
683
		sprintf(*new_path, "%s/%s", prefix, raw_path);
684 685 686 687

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

688
		if (!symbol_conf.source_prefix) {
689
			/* In case of searching comp_dir, don't retry */
690
			zfree(new_path);
691
			return -errno;
692
		}
693

694 695 696 697 698 699 700
		switch (errno) {
		case ENAMETOOLONG:
		case ENOENT:
		case EROFS:
		case EFAULT:
			raw_path = strchr(++raw_path, '/');
			if (!raw_path) {
701
				zfree(new_path);
702 703 704 705 706
				return -ENOENT;
			}
			continue;

		default:
707
			zfree(new_path);
708 709 710 711 712
			return -errno;
		}
	}
}

713 714 715
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

716
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
717
{
718
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
719 720
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
721

722
	do {
723 724
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
725 726 727 728 729
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
730
		}
731 732 733
		color_fprintf(stdout, color, "%s", buf);

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

735
	return 1;
736
error:
737
	if (ferror(fp)) {
738 739
		pr_warning("File read error: %s\n",
			   strerror_r(errno, sbuf, sizeof(sbuf)));
740 741 742 743
		return -1;
	}
	return 0;
}
744

745 746 747 748 749 750 751 752
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;
753 754
}

755 756 757 758 759
#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)

760 761 762 763
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
764 765
static int __show_line_range(struct line_range *lr, const char *module,
			     bool user)
766
{
767
	int l = 1;
768
	struct int_node *ln;
769
	struct debuginfo *dinfo;
770
	FILE *fp;
771
	int ret;
772
	char *tmp;
773
	char sbuf[STRERR_BUFSIZE];
774 775

	/* Search a line range */
776 777
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
778
		return -ENOENT;
779

780
	ret = debuginfo__find_line_range(dinfo, lr);
781 782 783 784 785
	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);
	}
786
	debuginfo__delete(dinfo);
787
	if (ret == 0 || ret == -ENOENT) {
788 789 790
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
791
		pr_warning("Debuginfo analysis failed.\n");
792 793
		return ret;
	}
794

795 796
	/* Convert source file path */
	tmp = lr->path;
797
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
798 799 800 801 802

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

803
	if (ret < 0) {
804
		pr_warning("Failed to find source file path.\n");
805 806 807
		return ret;
	}

808 809 810
	setup_pager();

	if (lr->function)
811
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
812 813
			lr->start - lr->offset);
	else
814
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
815 816

	fp = fopen(lr->path, "r");
817 818
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
819
			   strerror_r(errno, sbuf, sizeof(sbuf)));
820 821
		return -errno;
	}
822
	/* Skip to starting line number */
823
	while (l < lr->start) {
824
		ret = skip_one_line(fp, l++);
825 826 827
		if (ret < 0)
			goto end;
	}
828

829 830
	intlist__for_each(ln, lr->line_list) {
		for (; ln->i > l; l++) {
831
			ret = show_one_line(fp, l - lr->offset);
832 833 834
			if (ret < 0)
				goto end;
		}
835
		ret = show_one_line_with_num(fp, l++ - lr->offset);
836 837
		if (ret < 0)
			goto end;
838 839 840 841
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
842 843 844
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
845 846
			break;
	}
847
end:
848
	fclose(fp);
849
	return ret;
850 851
}

852
int show_line_range(struct line_range *lr, const char *module, bool user)
853 854 855
{
	int ret;

856
	ret = init_symbol_maps(user);
857 858
	if (ret < 0)
		return ret;
859
	ret = __show_line_range(lr, module, user);
860 861 862 863 864
	exit_symbol_maps();

	return ret;
}

865 866
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
867
				  int max_vls, struct strfilter *_filter,
868
				  bool externs, const char *target)
869 870
{
	char *buf;
871
	int ret, i, nvars;
872 873
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
874
	struct perf_probe_point tmp;
875
	const char *var;
876 877 878 879 880 881

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

882 883
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
						max_vls, externs);
884 885 886 887 888 889 890 891 892
	if (!ret) {  /* Not found, retry with an alternative */
		ret = get_alternative_probe_event(dinfo, pev, &tmp, target);
		if (!ret) {
			ret = debuginfo__find_available_vars_at(dinfo, pev,
						&vls, max_vls, externs);
			/* Release the old probe_point */
			clear_perf_probe_point(&tmp);
		}
	}
893
	if (ret <= 0) {
894 895 896 897 898
		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");
899 900
		goto end;
	}
901

902 903 904 905 906 907 908 909 910 911
	/* 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);
912
		zfree(&vl->point.symbol);
913 914 915 916 917
		nvars = 0;
		if (vl->vars) {
			strlist__for_each(node, vl->vars) {
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
918
					fprintf(stdout, "\t\t%s\n", node->s);
919 920 921 922
					nvars++;
				}
			}
			strlist__delete(vl->vars);
923
		}
924 925 926 927 928
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
929 930 931 932 933 934
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
935 936
			int max_vls, const char *module,
			struct strfilter *_filter, bool externs)
937
{
938 939
	int i, ret = 0;
	struct debuginfo *dinfo;
940

941
	ret = init_symbol_maps(pevs->uprobes);
942 943 944
	if (ret < 0)
		return ret;

945
	dinfo = open_debuginfo(module, false);
946
	if (!dinfo) {
947 948
		ret = -ENOENT;
		goto out;
949 950
	}

951 952
	setup_pager();

953 954
	for (i = 0; i < npevs && ret >= 0; i++)
		ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
955
					     externs, module);
956 957

	debuginfo__delete(dinfo);
958 959
out:
	exit_symbol_maps();
960 961 962
	return ret;
}

963
#else	/* !HAVE_DWARF_SUPPORT */
964

965 966 967 968
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)
969
{
970
	return -ENOSYS;
971 972
}

973
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
974
				struct probe_trace_event **tevs __maybe_unused,
975 976
				int max_tevs __maybe_unused,
				const char *target __maybe_unused)
977
{
978 979 980 981
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
982

983 984 985
	return 0;
}

986
int show_line_range(struct line_range *lr __maybe_unused,
987 988
		    const char *module __maybe_unused,
		    bool user __maybe_unused)
989
{
990 991
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
992 993
}

994 995 996 997 998
int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
			int npevs __maybe_unused, int max_vls __maybe_unused,
			const char *module __maybe_unused,
			struct strfilter *filter __maybe_unused,
			bool externs __maybe_unused)
999 1000 1001 1002
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
1003 1004
#endif

1005 1006 1007 1008 1009 1010
void line_range__clear(struct line_range *lr)
{
	free(lr->function);
	free(lr->file);
	free(lr->path);
	free(lr->comp_dir);
1011
	intlist__delete(lr->line_list);
1012 1013 1014
	memset(lr, 0, sizeof(*lr));
}

1015
int line_range__init(struct line_range *lr)
1016 1017
{
	memset(lr, 0, sizeof(*lr));
1018 1019 1020 1021 1022
	lr->line_list = intlist__new(NULL);
	if (!lr->line_list)
		return -ENOMEM;
	else
		return 0;
1023 1024
}

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
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;
}

1038 1039 1040 1041 1042
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1043
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1044
 */
1045
int parse_line_range_desc(const char *arg, struct line_range *lr)
1046
{
1047
	char *range, *file, *name = strdup(arg);
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
	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--;
			}
		}
1082

1083
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1084 1085

		err = -EINVAL;
1086
		if (lr->start > lr->end) {
1087
			semantic_error("Start line must be smaller"
1088
				       " than end line.\n");
1089
			goto err;
1090
		}
1091 1092 1093
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
1094
		}
1095
	}
1096

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
	} else if (strchr(name, '.'))
1107
		lr->file = name;
1108
	else
1109
		lr->function = name;
1110 1111

	return 0;
1112 1113 1114
err:
	free(name);
	return err;
1115 1116
}

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
/* Check the name is good for event/group */
static bool check_event_name(const char *name)
{
	if (!isalpha(*name) && *name != '_')
		return false;
	while (*++name != '\0') {
		if (!isalpha(*name) && !isdigit(*name) && *name != '_')
			return false;
	}
	return true;
}

1129
/* Parse probepoint definition. */
1130
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1131
{
1132
	struct perf_probe_point *pp = &pev->point;
1133 1134 1135 1136
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
1137 1138
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1139 1140
	 *
	 * TODO:Group name support
1141 1142
	 */

1143 1144
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
1145 1146
		*ptr = '\0';
		tmp = ptr + 1;
1147 1148 1149 1150 1151
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
1152
			semantic_error("%s is bad for event name -it must "
1153 1154 1155
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
1156 1157 1158
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
1159
		pev->group = NULL;
1160 1161 1162
		arg = tmp;
	}

1163
	ptr = strpbrk(arg, ";:+@%");
1164 1165 1166 1167 1168
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1169 1170 1171 1172
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

1173
	/* Check arg is function or file and copy it */
1174 1175
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
1176
	else			/* Function */
1177
		pp->function = tmp;
1178 1179 1180 1181 1182

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1183
		if (c == ';') {	/* Lazy pattern must be the last part */
1184 1185 1186
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1187 1188 1189
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1190 1191 1192 1193 1194 1195 1196
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1197
			if (*tmp != '\0') {
1198
				semantic_error("There is non-digit char"
1199 1200 1201
					       " in line number.\n");
				return -EINVAL;
			}
1202 1203 1204
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1205
			if (*tmp != '\0') {
1206
				semantic_error("There is non-digit character"
1207 1208 1209
						" in offset.\n");
				return -EINVAL;
			}
1210 1211
			break;
		case '@':	/* File name */
1212 1213 1214 1215
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1216 1217 1218
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1219 1220 1221 1222
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1223 1224 1225 1226
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1227
			break;
1228 1229 1230 1231
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1232 1233 1234 1235 1236
			break;
		}
	}

	/* Exclusion check */
1237
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1238 1239
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1240 1241
		return -EINVAL;
	}
1242

1243
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
1244
		semantic_error("Lazy pattern can't be used with offset.\n");
1245 1246
		return -EINVAL;
	}
1247

1248
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1249
		semantic_error("Offset can't be used with line number.\n");
1250 1251
		return -EINVAL;
	}
1252

1253
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1254
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1255
			       "lazy pattern.\n");
1256 1257
		return -EINVAL;
	}
1258

1259
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1260
		semantic_error("Offset requires an entry function.\n");
1261 1262
		return -EINVAL;
	}
1263

1264
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1265
		semantic_error("Return probe requires an entry function.\n");
1266 1267
		return -EINVAL;
	}
1268

1269
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1270
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1271
			       "return probe.\n");
1272 1273
		return -EINVAL;
	}
1274

1275
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1276 1277
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1278
	return 0;
1279 1280
}

1281
/* Parse perf-probe event argument */
1282
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1283
{
1284
	char *tmp, *goodname;
1285 1286 1287 1288
	struct perf_probe_arg_field **fieldp;

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

1289 1290
	tmp = strchr(str, '=');
	if (tmp) {
1291 1292 1293
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1294
		pr_debug("name:%s ", arg->name);
1295 1296 1297
		str = tmp + 1;
	}

1298 1299 1300
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1301 1302 1303
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1304 1305 1306
		pr_debug("type:%s ", arg->type);
	}

1307
	tmp = strpbrk(str, "-.[");
1308 1309
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1310 1311 1312
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1313
		pr_debug("%s\n", arg->var);
1314
		return 0;
1315 1316
	}

1317
	/* Structure fields or array element */
1318 1319 1320
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1321
	goodname = arg->var;
1322
	pr_debug("%s, ", arg->var);
1323 1324 1325
	fieldp = &arg->field;

	do {
1326 1327 1328
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1329 1330 1331
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1332
			(*fieldp)->ref = true;
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
			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, "-.[");
1354
		}
1355
		if (tmp) {
1356 1357 1358
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1359 1360
			if (*str != '[')
				goodname = (*fieldp)->name;
1361 1362 1363 1364
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1365 1366 1367
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1368 1369
	if (*str != '[')
		goodname = (*fieldp)->name;
1370
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1371

1372
	/* If no name is specified, set the last field name (not array index)*/
1373
	if (!arg->name) {
1374
		arg->name = strdup(goodname);
1375 1376 1377
		if (arg->name == NULL)
			return -ENOMEM;
	}
1378
	return 0;
1379 1380
}

1381
/* Parse perf-probe event command */
1382
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1383
{
1384
	char **argv;
1385
	int argc, i, ret = 0;
1386

1387
	argv = argv_split(cmd, &argc);
1388 1389 1390 1391 1392 1393 1394 1395 1396
	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;
	}
1397
	/* Parse probe point */
1398 1399 1400
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1401

1402
	/* Copy arguments and ensure return probe has no C argument */
1403
	pev->nargs = argc - 1;
1404 1405 1406 1407 1408
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1409 1410 1411 1412
	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) {
1413
			semantic_error("You can't specify local variable for"
1414 1415 1416
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1417
	}
1418
out:
1419
	argv_free(argv);
1420 1421

	return ret;
1422 1423
}

1424 1425 1426 1427 1428 1429 1430 1431 1432
/* Return true if this perf_probe_event requires debuginfo */
bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
{
	int i;

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

	for (i = 0; i < pev->nargs; i++)
1433
		if (is_c_varname(pev->args[i].var))
1434 1435 1436 1437 1438
			return true;

	return false;
}

1439 1440
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
1441
				     struct probe_trace_event *tev)
1442
{
1443
	struct probe_trace_point *tp = &tev->point;
1444 1445
	char pr;
	char *p;
1446
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1447 1448 1449
	int ret, i, argc;
	char **argv;

1450
	pr_debug("Parsing probe_events: %s\n", cmd);
1451
	argv = argv_split(cmd, &argc);
1452 1453 1454 1455 1456 1457 1458 1459 1460
	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;
	}
1461 1462

	/* Scan event and group name. */
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	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) {
1473 1474 1475 1476
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1477 1478 1479 1480 1481 1482 1483
	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;
	}
1484
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1485

1486
	tp->retprobe = (pr == 'r');
1487

1488 1489 1490 1491 1492 1493 1494
	/* Scan module name(if there), function name and offset */
	p = strchr(argv[1], ':');
	if (p) {
		tp->module = strndup(argv[1], p - argv[1]);
		p++;
	} else
		p = argv[1];
1495
	fmt1_str = strtok_r(p, "+", &fmt);
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
	if (fmt1_str[0] == '0')	/* only the address started with 0x */
		tp->address = strtoul(fmt1_str, NULL, 0);
	else {
		/* Only the symbol-based probe has offset */
		tp->symbol = strdup(fmt1_str);
		if (tp->symbol == NULL) {
			ret = -ENOMEM;
			goto out;
		}
		fmt2_str = strtok_r(NULL, "", &fmt);
		if (fmt2_str == NULL)
			tp->offset = 0;
		else
			tp->offset = strtoul(fmt2_str, NULL, 10);
1510
	}
1511

1512
	tev->nargs = argc - 2;
1513
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1514 1515 1516 1517
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1518
	for (i = 0; i < tev->nargs; i++) {
1519 1520
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1521 1522 1523
			*p++ = '\0';
		else
			p = argv[i + 2];
1524
		tev->args[i].name = strdup(argv[i + 2]);
1525
		/* TODO: parse regs and offset */
1526 1527 1528 1529 1530
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1531
	}
1532 1533
	ret = 0;
out:
1534
	free(argv0_str);
1535
	argv_free(argv);
1536
	return ret;
1537 1538
}

1539 1540 1541 1542 1543 1544 1545
/* Compose only probe arg */
int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
{
	struct perf_probe_arg_field *field = pa->field;
	int ret;
	char *tmp = buf;

1546 1547 1548 1549
	if (pa->name && pa->var)
		ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
	else
		ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1550 1551 1552 1553 1554 1555
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1556 1557 1558 1559 1560
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1561 1562 1563 1564 1565 1566
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1567 1568 1569 1570 1571 1572 1573 1574 1575

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

1576 1577
	return tmp - buf;
error:
1578
	pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1579
	return ret;
1580 1581
}

1582 1583
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1584
{
1585 1586 1587
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1588

1589 1590 1591 1592 1593
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1594
	if (pp->offset) {
1595
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1596 1597 1598 1599
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1600 1601 1602 1603 1604
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1605 1606 1607 1608 1609 1610 1611
		tmp = pp->file;
		len = strlen(tmp);
		if (len > 30) {
			tmp = strchr(pp->file + len - 30, '/');
			tmp = tmp ? tmp + 1 : pp->file + len - 30;
		}
		ret = e_snprintf(file, 32, "@%s", tmp);
1612 1613 1614 1615 1616
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1617 1618 1619
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1620
	else
1621
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1622 1623 1624 1625
	if (ret <= 0)
		goto error;

	return buf;
1626
error:
1627
	pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1628
	free(buf);
1629
	return NULL;
1630 1631
}

1632 1633
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1634 1635 1636 1637
{
	char *buf;
	int i, len, ret;

1638 1639 1640
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1641

1642 1643
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1644
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1645 1646 1647 1648 1649
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1650 1651 1652
		len += ret;
	}

1653 1654 1655 1656
	return buf;
}
#endif

1657
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1658 1659 1660 1661 1662
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1663
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
							 buflen, depth + 1);
		if (depth < 0)
			goto out;
	}

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

}

1681
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1682
				       char *buf, size_t buflen)
1683
{
1684
	struct probe_trace_arg_ref *ref = arg->ref;
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
	int ret, depth = 0;
	char *tmp = buf;

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

1698 1699 1700 1701
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1702
	/* Dereferencing arguments */
1703
	if (ref) {
1704
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1705 1706 1707 1708 1709 1710
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1711 1712 1713 1714 1715
	if (arg->value[0] == '@' && arg->ref)
		ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
				 arg->ref->offset);
	else
		ret = e_snprintf(buf, buflen, "%s", arg->value);
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
	if (ret < 0)
		return ret;
	buf += ret;
	buflen -= ret;

	/* Closing */
	while (depth--) {
		ret = e_snprintf(buf, buflen, ")");
		if (ret < 0)
			return ret;
		buf += ret;
		buflen -= ret;
	}
1729 1730 1731 1732 1733 1734 1735
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1736 1737 1738 1739

	return buf - tmp;
}

1740
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1741
{
1742
	struct probe_trace_point *tp = &tev->point;
1743 1744 1745
	char *buf;
	int i, len, ret;

1746 1747 1748 1749
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
	len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
			 tev->group, tev->event);
	if (len <= 0)
		goto error;

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

	/* Use the tp->address for uprobes */
1760
	if (tev->uprobes)
1761 1762
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
				 tp->module, tp->address);
1763
	else
1764
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1765 1766 1767
				 tp->module ?: "", tp->module ? ":" : "",
				 tp->symbol, tp->offset);

1768
	if (ret <= 0)
1769
		goto error;
1770
	len += ret;
1771

1772
	for (i = 0; i < tev->nargs; i++) {
1773
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1774
						  MAX_CMDLEN - len);
1775
		if (ret <= 0)
1776 1777 1778 1779
			goto error;
		len += ret;
	}

1780
	return buf;
1781
error:
1782 1783 1784
	free(buf);
	return NULL;
}
1785

1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
					  struct perf_probe_point *pp,
					  bool is_kprobe)
{
	struct symbol *sym = NULL;
	struct map *map;
	u64 addr;
	int ret = -ENOENT;

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

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

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

	return ret;
}

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

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

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

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

	pp->retprobe = tp->retprobe;

	return 0;
}

1859
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1860
			       struct perf_probe_event *pev, bool is_kprobe)
1861
{
1862
	char buf[64] = "";
1863
	int i, ret;
1864

1865
	/* Convert event/group name */
1866 1867 1868 1869
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1870

1871
	/* Convert trace_point to probe_point */
1872
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1873 1874
	if (ret < 0)
		return ret;
1875

1876 1877
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1878 1879 1880
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1881
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1882
		if (tev->args[i].name)
1883
			pev->args[i].name = strdup(tev->args[i].name);
1884
		else {
1885
			ret = synthesize_probe_trace_arg(&tev->args[i],
1886
							  buf, 64);
1887
			pev->args[i].name = strdup(buf);
1888
		}
1889 1890 1891
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1892 1893 1894 1895 1896

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1897 1898 1899 1900
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
1901
	struct perf_probe_arg_field *field, *next;
1902 1903
	int i;

1904 1905
	free(pev->event);
	free(pev->group);
1906
	clear_perf_probe_point(&pev->point);
1907

1908
	for (i = 0; i < pev->nargs; i++) {
1909 1910 1911
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
1912 1913 1914
		field = pev->args[i].field;
		while (field) {
			next = field->next;
1915
			zfree(&field->name);
1916 1917 1918 1919
			free(field);
			field = next;
		}
	}
1920
	free(pev->args);
1921 1922 1923
	memset(pev, 0, sizeof(*pev));
}

1924
static void clear_probe_trace_event(struct probe_trace_event *tev)
1925
{
1926
	struct probe_trace_arg_ref *ref, *next;
1927 1928
	int i;

1929 1930 1931 1932
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
	free(tev->point.module);
1933
	for (i = 0; i < tev->nargs; i++) {
1934 1935 1936
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
1937 1938 1939 1940 1941 1942 1943
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
1944
	free(tev->args);
1945
	memset(tev, 0, sizeof(*tev));
1946 1947
}

1948
static void print_open_warning(int err, bool is_kprobe)
1949
{
1950
	char sbuf[STRERR_BUFSIZE];
1951

1952
	if (err == -ENOENT) {
1953 1954 1955 1956 1957 1958 1959
		const char *config;

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

1960 1961 1962 1963
		pr_warning("%cprobe_events file does not exist"
			   " - please rebuild kernel with %s.\n",
			   is_kprobe ? 'k' : 'u', config);
	} else if (err == -ENOTSUP)
1964
		pr_warning("Tracefs or debugfs is not mounted.\n");
1965 1966 1967 1968
	else
		pr_warning("Failed to open %cprobe_events: %s\n",
			   is_kprobe ? 'k' : 'u',
			   strerror_r(-err, sbuf, sizeof(sbuf)));
1969 1970
}

1971 1972 1973 1974
static void print_both_open_warning(int kerr, int uerr)
{
	/* Both kprobes and uprobes are disabled, warn it. */
	if (kerr == -ENOTSUP && uerr == -ENOTSUP)
1975
		pr_warning("Tracefs or debugfs is not mounted.\n");
1976 1977 1978 1979
	else if (kerr == -ENOENT && uerr == -ENOENT)
		pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
			   "or/and CONFIG_UPROBE_EVENTS.\n");
	else {
1980
		char sbuf[STRERR_BUFSIZE];
1981 1982 1983 1984 1985 1986 1987
		pr_warning("Failed to open kprobe events: %s.\n",
			   strerror_r(-kerr, sbuf, sizeof(sbuf)));
		pr_warning("Failed to open uprobe events: %s.\n",
			   strerror_r(-uerr, sbuf, sizeof(sbuf)));
	}
}

1988
static int open_probe_events(const char *trace_file, bool readwrite)
1989 1990
{
	char buf[PATH_MAX];
1991
	const char *__debugfs;
1992
	const char *tracing_dir = "";
1993 1994
	int ret;

1995 1996 1997
	__debugfs = tracefs_find_mountpoint();
	if (__debugfs == NULL) {
		tracing_dir = "tracing/";
1998

1999 2000 2001 2002 2003 2004 2005
		__debugfs = debugfs_find_mountpoint();
		if (__debugfs == NULL)
			return -ENOTSUP;
	}

	ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
			 __debugfs, tracing_dir, trace_file);
2006
	if (ret >= 0) {
2007
		pr_debug("Opening %s write=%d\n", buf, readwrite);
2008 2009 2010 2011
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
2012

2013
		if (ret < 0)
2014
			ret = -errno;
2015 2016 2017 2018
	}
	return ret;
}

2019 2020
static int open_kprobe_events(bool readwrite)
{
2021
	return open_probe_events("kprobe_events", readwrite);
2022 2023 2024 2025
}

static int open_uprobe_events(bool readwrite)
{
2026
	return open_probe_events("uprobe_events", readwrite);
2027 2028 2029
}

/* Get raw string list of current kprobe_events  or uprobe_events */
2030
static struct strlist *get_probe_trace_command_rawlist(int fd)
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
{
	int ret, idx;
	FILE *fp;
	char buf[MAX_CMDLEN];
	char *p;
	struct strlist *sl;

	sl = strlist__new(true, NULL);

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

		idx = strlen(p) - 1;
		if (p[idx] == '\n')
			p[idx] = '\0';
		ret = strlist__add(sl, buf);
2050
		if (ret < 0) {
2051
			pr_debug("strlist__add failed (%d)\n", ret);
2052 2053 2054
			strlist__delete(sl);
			return NULL;
		}
2055 2056 2057 2058 2059 2060
	}
	fclose(fp);

	return sl;
}

2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149
struct kprobe_blacklist_node {
	struct list_head list;
	unsigned long start;
	unsigned long end;
	char *symbol;
};

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

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

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

	if (__debugfs == NULL)
		return -ENOTSUP;

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

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

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

	return ret;
}

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

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

	return NULL;
}

2150
/* Show an event */
2151 2152
static int show_perf_probe_event(struct perf_probe_event *pev,
				 const char *module)
2153
{
2154
	int i, ret;
2155
	char buf[128];
2156
	char *place;
2157

2158 2159
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
2160 2161
	if (!place)
		return -EINVAL;
2162 2163

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
2164
	if (ret < 0)
2165 2166
		return ret;

2167
	pr_info("  %-20s (on %s", buf, place);
2168
	if (module)
2169
		pr_info(" in %s", module);
2170

2171
	if (pev->nargs > 0) {
2172
		pr_info(" with");
2173
		for (i = 0; i < pev->nargs; i++) {
2174 2175 2176 2177
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
2178
			pr_info(" %s", buf);
2179
		}
2180
	}
2181
	pr_info(")\n");
2182
	free(place);
2183
	return ret;
2184 2185
}

2186
static int __show_perf_probe_events(int fd, bool is_kprobe)
2187
{
2188
	int ret = 0;
2189
	struct probe_trace_event tev;
2190
	struct perf_probe_event pev;
2191 2192 2193
	struct strlist *rawlist;
	struct str_node *ent;

2194 2195
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2196

2197
	rawlist = get_probe_trace_command_rawlist(fd);
2198
	if (!rawlist)
2199
		return -ENOMEM;
2200

2201
	strlist__for_each(ent, rawlist) {
2202
		ret = parse_probe_trace_command(ent->s, &tev);
2203
		if (ret >= 0) {
2204 2205
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2206
			if (ret >= 0)
2207 2208
				ret = show_perf_probe_event(&pev,
							    tev.point.module);
2209
		}
2210
		clear_perf_probe_event(&pev);
2211
		clear_probe_trace_event(&tev);
2212 2213
		if (ret < 0)
			break;
2214 2215
	}
	strlist__delete(rawlist);
2216 2217

	return ret;
2218 2219
}

2220 2221 2222
/* List up current perf-probe events */
int show_perf_probe_events(void)
{
2223
	int kp_fd, up_fd, ret;
2224 2225 2226

	setup_pager();

2227
	ret = init_symbol_maps(false);
2228 2229 2230
	if (ret < 0)
		return ret;

2231 2232 2233 2234 2235 2236 2237
	kp_fd = open_kprobe_events(false);
	if (kp_fd >= 0) {
		ret = __show_perf_probe_events(kp_fd, true);
		close(kp_fd);
		if (ret < 0)
			goto out;
	}
2238

2239 2240
	up_fd = open_uprobe_events(false);
	if (kp_fd < 0 && up_fd < 0) {
2241
		print_both_open_warning(kp_fd, up_fd);
2242 2243
		ret = kp_fd;
		goto out;
2244 2245
	}

2246 2247 2248 2249 2250
	if (up_fd >= 0) {
		ret = __show_perf_probe_events(up_fd, false);
		close(up_fd);
	}
out:
2251
	exit_symbol_maps();
2252 2253 2254
	return ret;
}

2255
/* Get current perf-probe event names */
2256
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
2257
{
2258
	char buf[128];
2259 2260
	struct strlist *sl, *rawlist;
	struct str_node *ent;
2261
	struct probe_trace_event tev;
2262
	int ret = 0;
2263

2264
	memset(&tev, 0, sizeof(tev));
2265
	rawlist = get_probe_trace_command_rawlist(fd);
2266 2267
	if (!rawlist)
		return NULL;
2268
	sl = strlist__new(true, NULL);
2269
	strlist__for_each(ent, rawlist) {
2270
		ret = parse_probe_trace_command(ent->s, &tev);
2271 2272
		if (ret < 0)
			break;
2273
		if (include_group) {
2274 2275 2276 2277
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
2278
		} else
2279
			ret = strlist__add(sl, tev.event);
2280
		clear_probe_trace_event(&tev);
2281 2282
		if (ret < 0)
			break;
2283 2284 2285
	}
	strlist__delete(rawlist);

2286 2287 2288 2289
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
2290 2291 2292
	return sl;
}

2293
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
2294
{
2295
	int ret = 0;
2296
	char *buf = synthesize_probe_trace_command(tev);
2297
	char sbuf[STRERR_BUFSIZE];
2298

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

2304
	pr_debug("Writing event: %s\n", buf);
2305 2306
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
2307 2308
		if (ret <= 0) {
			ret = -errno;
2309
			pr_warning("Failed to write event: %s\n",
2310
				   strerror_r(errno, sbuf, sizeof(sbuf)));
2311
		}
2312
	}
2313
	free(buf);
2314
	return ret;
2315 2316
}

2317 2318
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2319 2320
{
	int i, ret;
2321 2322 2323

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
2324
	if (ret < 0) {
2325
		pr_debug("snprintf() failed: %d\n", ret);
2326 2327
		return ret;
	}
2328
	if (!strlist__has_entry(namelist, buf))
2329
		return 0;
2330

2331 2332 2333
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
2334
		return -EEXIST;
2335 2336
	}

2337 2338
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2339
		ret = e_snprintf(buf, len, "%s_%d", base, i);
2340
		if (ret < 0) {
2341
			pr_debug("snprintf() failed: %d\n", ret);
2342 2343
			return ret;
		}
2344 2345 2346
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2347 2348 2349 2350 2351 2352
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
2353 2354
}

2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
/* 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);
}

2376 2377
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
2378
				     int ntevs, bool allow_suffix)
2379
{
2380
	int i, fd, ret;
2381
	struct probe_trace_event *tev = NULL;
2382 2383
	char buf[64];
	const char *event, *group;
2384
	struct strlist *namelist;
2385 2386
	LIST_HEAD(blacklist);
	struct kprobe_blacklist_node *node;
2387

2388 2389 2390 2391 2392
	if (pev->uprobes)
		fd = open_uprobe_events(true);
	else
		fd = open_kprobe_events(true);

2393 2394
	if (fd < 0) {
		print_open_warning(fd, !pev->uprobes);
2395
		return fd;
2396 2397
	}

2398
	/* Get current event names */
2399
	namelist = get_probe_trace_event_names(fd, false);
2400 2401 2402 2403
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
2404 2405 2406 2407 2408 2409
	/* Get kprobe blacklist if exists */
	if (!pev->uprobes) {
		ret = kprobe_blacklist__load(&blacklist);
		if (ret < 0)
			pr_debug("No kprobe blacklist support, ignored\n");
	}
2410

2411
	ret = 0;
2412
	pr_info("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2413
	for (i = 0; i < ntevs; i++) {
2414
		tev = &tevs[i];
2415 2416 2417 2418 2419 2420 2421 2422
		/* Ensure that the address is NOT blacklisted */
		node = kprobe_blacklist__find_by_address(&blacklist,
							 tev->point.address);
		if (node) {
			pr_warning("Warning: Skipped probing on blacklisted function: %s\n", node->symbol);
			continue;
		}

2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435
		if (pev->event)
			event = pev->event;
		else
			if (pev->point.function)
				event = pev->point.function;
			else
				event = tev->point.symbol;
		if (pev->group)
			group = pev->group;
		else
			group = PERFPROBE_GROUP;

		/* Get an unused new event name */
2436 2437 2438 2439
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
2440 2441
		event = buf;

2442 2443 2444 2445 2446 2447
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
2448
		ret = write_probe_trace_event(fd, tev);
2449 2450
		if (ret < 0)
			break;
2451 2452 2453 2454 2455 2456 2457 2458
		/* Add added event name to namelist */
		strlist__add(namelist, event);

		/* Trick here - save current event/group */
		event = pev->event;
		group = pev->group;
		pev->event = tev->event;
		pev->group = tev->group;
2459
		show_perf_probe_event(pev, tev->point.module);
2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
		/* Trick here - restore current event/group */
		pev->event = (char *)event;
		pev->group = (char *)group;

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

2475 2476
	/* Note that it is possible to skip all events because of blacklist */
	if (ret >= 0 && tev->event) {
2477
		/* Show how to use the event. */
2478 2479
		pr_info("\nYou can now use it in all perf tools, such as:\n\n");
		pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
2480 2481
			 tev->event);
	}
2482

2483
	kprobe_blacklist__delete(&blacklist);
2484
	strlist__delete(namelist);
2485
	close(fd);
2486
	return ret;
2487
}
2488

2489
static int find_probe_functions(struct map *map, char *name)
2490
{
2491
	int found = 0;
2492
	struct symbol *sym;
2493

2494
	map__for_each_symbol_by_name(map, name, sym) {
2495
		found++;
2496
	}
2497 2498

	return found;
2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
}

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

/*
 * Find probe function addresses from map.
 * Return an error or the number of found probe_trace_event
 */
static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
					    struct probe_trace_event **tevs,
					    int max_tevs, const char *target)
2511
{
2512 2513
	struct map *map = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2514
	struct symbol *sym;
2515
	struct probe_trace_event *tev;
2516 2517
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2518
	int num_matched_functions;
2519
	int ret, i;
2520

2521
	map = get_target_map(target, pev->uprobes);
2522 2523 2524
	if (!map) {
		ret = -EINVAL;
		goto out;
2525 2526
	}

2527 2528 2529 2530
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2531 2532
	num_matched_functions = find_probe_functions(map, pp->function);
	if (num_matched_functions == 0) {
2533 2534 2535 2536 2537 2538 2539 2540 2541
		pr_err("Failed to find symbol %s in %s\n", pp->function,
			target ? : "kernel");
		ret = -ENOENT;
		goto out;
	} else if (num_matched_functions > max_tevs) {
		pr_err("Too many functions matched in %s\n",
			target ? : "kernel");
		ret = -E2BIG;
		goto out;
2542 2543
	}

2544
	if (!pev->uprobes && !pp->retprobe) {
2545
		reloc_sym = kernel_get_ref_reloc_sym();
2546 2547 2548 2549 2550 2551
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2552

2553 2554 2555
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2556
		ret = -ENOMEM;
2557
		goto out;
2558
	}
2559

2560
	ret = 0;
2561

2562
	map__for_each_symbol_by_name(map, pp->function, sym) {
2563 2564 2565 2566 2567
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2568
		}
2569
		ret++;
2570

2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
		if (pp->offset > sym->end - sym->start) {
			pr_warning("Offset %ld is bigger than the size of %s\n",
				   pp->offset, sym->name);
			ret = -ENOENT;
			goto err_out;
		}
		/* Add one probe point */
		tp->address = map->unmap_ip(map, sym->start) + pp->offset;
		if (reloc_sym) {
			tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
			tp->offset = tp->address - reloc_sym->addr;
		} else {
			tp->symbol = strdup_or_goto(sym->name, nomem_out);
			tp->offset = pp->offset;
		}
		tp->retprobe = pp->retprobe;
		if (target)
			tev->point.module = strdup_or_goto(target, nomem_out);
		tev->uprobes = pev->uprobes;
		tev->nargs = pev->nargs;
		if (tev->nargs) {
			tev->args = zalloc(sizeof(struct probe_trace_arg) *
					   tev->nargs);
			if (tev->args == NULL)
				goto nomem_out;
2596
		}
2597
		for (i = 0; i < tev->nargs; i++) {
2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
			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);
2609
		}
2610 2611
	}

2612
out:
2613
	put_target_map(map, pev->uprobes);
2614
	return ret;
2615

2616 2617 2618 2619 2620 2621 2622
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2623

2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
					  struct probe_trace_event **tevs,
					  int max_tevs, const char *target)
{
	int ret;

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

2639 2640 2641 2642 2643 2644
	/* Convert perf_probe_event with debuginfo */
	ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

	return find_probe_trace_events_from_map(pev, tevs, max_tevs, target);
2645 2646 2647 2648
}

struct __event_package {
	struct perf_probe_event		*pev;
2649
	struct probe_trace_event	*tevs;
2650 2651 2652
	int				ntevs;
};

2653
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2654
			  int max_tevs, const char *target, bool force_add)
2655
{
2656
	int i, j, ret;
2657 2658
	struct __event_package *pkgs;

2659
	ret = 0;
2660
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
2661

2662 2663
	if (pkgs == NULL)
		return -ENOMEM;
2664

2665
	ret = init_symbol_maps(pevs->uprobes);
2666 2667
	if (ret < 0) {
		free(pkgs);
2668
		return ret;
2669
	}
2670 2671 2672 2673 2674

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
2675
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
2676 2677
						     &pkgs[i].tevs,
						     max_tevs,
2678
						     target);
2679 2680 2681
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
2682 2683
	}

2684
	/* Loop 2: add all events */
2685
	for (i = 0; i < npevs; i++) {
2686
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2687
						pkgs[i].ntevs, force_add);
2688 2689 2690
		if (ret < 0)
			break;
	}
2691
end:
2692 2693
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
2694
		for (j = 0; j < pkgs[i].ntevs; j++)
2695
			clear_probe_trace_event(&pkgs[i].tevs[j]);
2696
		zfree(&pkgs[i].tevs);
2697 2698
	}
	free(pkgs);
2699
	exit_symbol_maps();
2700 2701

	return ret;
2702 2703
}

2704
static int __del_trace_probe_event(int fd, struct str_node *ent)
2705 2706 2707
{
	char *p;
	char buf[128];
2708
	int ret;
2709

2710
	/* Convert from perf-probe event to trace-probe event */
2711 2712 2713 2714
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

2715
	p = strchr(buf + 2, ':');
2716 2717 2718 2719 2720 2721
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
2722 2723
	*p = '/';

2724 2725
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
2726 2727
	if (ret < 0) {
		ret = -errno;
2728
		goto error;
2729
	}
2730

2731
	pr_info("Removed event: %s\n", ent->s);
2732 2733
	return 0;
error:
2734 2735
	pr_warning("Failed to delete event: %s\n",
		   strerror_r(-ret, buf, sizeof(buf)));
2736
	return ret;
2737 2738
}

2739 2740
static int del_trace_probe_event(int fd, const char *buf,
						  struct strlist *namelist)
2741
{
2742
	struct str_node *ent, *n;
2743
	int ret = -1;
2744

2745 2746 2747
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
2748
				ret = __del_trace_probe_event(fd, ent);
2749 2750
				if (ret < 0)
					break;
2751 2752 2753 2754 2755
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
2756
			ret = __del_trace_probe_event(fd, ent);
2757 2758
			if (ret >= 0)
				strlist__remove(namelist, ent);
2759 2760
		}
	}
2761 2762

	return ret;
2763 2764
}

2765
int del_perf_probe_events(struct strlist *dellist)
2766
{
2767 2768
	int ret = -1, ufd = -1, kfd = -1;
	char buf[128];
2769 2770 2771
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
2772
	struct strlist *namelist = NULL, *unamelist = NULL;
2773

2774
	/* Get current event names */
2775
	kfd = open_kprobe_events(true);
2776 2777
	if (kfd >= 0)
		namelist = get_probe_trace_event_names(kfd, true);
2778 2779

	ufd = open_uprobe_events(true);
2780
	if (ufd >= 0)
2781 2782
		unamelist = get_probe_trace_event_names(ufd, true);

2783 2784 2785 2786 2787
	if (kfd < 0 && ufd < 0) {
		print_both_open_warning(kfd, ufd);
		goto error;
	}

2788 2789
	if (namelist == NULL && unamelist == NULL)
		goto error;
2790

2791
	strlist__for_each(ent, dellist) {
2792 2793 2794
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
2795
			goto error;
2796
		}
2797
		pr_debug("Parsing: %s\n", str);
2798 2799 2800 2801 2802 2803
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
2804
			group = "*";
2805 2806
			event = str;
		}
2807 2808 2809 2810 2811 2812 2813 2814

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

2815
		pr_debug("Group: %s, Event: %s\n", group, event);
2816 2817 2818 2819 2820 2821 2822 2823 2824 2825

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

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

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

2826 2827
		free(str);
	}
2828 2829 2830

error:
	if (kfd >= 0) {
2831
		strlist__delete(namelist);
2832 2833 2834 2835
		close(kfd);
	}

	if (ufd >= 0) {
2836
		strlist__delete(unamelist);
2837 2838
		close(ufd);
	}
2839 2840

	return ret;
2841
}
2842

2843 2844
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2845

2846
/*
2847 2848
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2849
 */
2850
static int filter_available_functions(struct map *map __maybe_unused,
2851
				      struct symbol *sym)
2852
{
2853
	if (strfilter__compare(available_func_filter, sym->name))
2854 2855
		return 0;
	return 1;
2856 2857
}

2858 2859
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
2860 2861 2862 2863
{
	struct map *map;
	int ret;

2864
	ret = init_symbol_maps(user);
2865 2866 2867
	if (ret < 0)
		return ret;

2868 2869 2870 2871 2872
	/* Get a symbol map */
	if (user)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
2873
	if (!map) {
2874
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2875 2876
		return -EINVAL;
	}
2877

2878
	/* Load symbols with given filter */
2879
	available_func_filter = _filter;
2880 2881 2882 2883 2884 2885
	if (map__load(map, filter_available_functions)) {
		pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
		goto end;
	}
	if (!dso__sorted_by_name(map->dso, map->type))
		dso__sort_by_name(map->dso, map->type);
2886

2887 2888 2889 2890 2891 2892 2893 2894 2895
	/* Show all (filtered) symbols */
	setup_pager();
	dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
end:
	if (user) {
		dso__delete(map->dso);
		map__delete(map);
	}
	exit_symbol_maps();
2896

2897
	return ret;
2898 2899
}