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

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

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

#define MAX_CMDLEN 256
#define PERFPROBE_GROUP "probe"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

168 169 170 171 172 173 174 175 176 177 178 179 180
	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;
}

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
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);
	}
}


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

	if (module) {
207 208
		list_for_each_entry(dso, &host_machine->kernel_dsos.head,
				    node) {
209 210 211 212 213 214
			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;
215 216
	}

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

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

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

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

286
#ifdef HAVE_DWARF_SUPPORT
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 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
/*
 * 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) {
		if (sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) {
			address = sym->start;
			break;
		}
	}
	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;
}
355

356
/* Open new debuginfo of given module */
357
static struct debuginfo *open_debuginfo(const char *module, bool silent)
358
{
359
	const char *path = module;
360
	struct debuginfo *ret;
361

362
	if (!module || !strchr(module, '/')) {
363 364
		path = kernel_get_module_path(module);
		if (!path) {
365 366 367
			if (!silent)
				pr_err("Failed to find path of %s module.\n",
				       module ?: "kernel");
368 369
			return NULL;
		}
370
	}
371 372 373 374 375 376 377 378 379 380
	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;
381
}
382

383

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
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;
}

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 441 442 443
/*
 * 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");

444
	dinfo = open_debuginfo(tp->module, verbose == 0);
445 446 447 448
	if (dinfo) {
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
		debuginfo__delete(dinfo);
449
	} else
450 451 452 453 454 455 456 457 458 459 460
		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;
}

461 462 463 464
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
465
	unsigned long stext = 0;
466 467 468 469 470 471 472 473 474

	if (!exec)
		return 0;

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

	for (i = 0; i < ntevs && ret >= 0; i++) {
475
		/* point.address is the addres of point.symbol + point.offset */
476
		tevs[i].point.address -= stext;
477
		tevs[i].point.module = strdup(exec);
478
		if (!tevs[i].point.module) {
479 480 481 482 483 484 485 486 487
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

488 489 490
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	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() */
	}

509 510
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
511 512 513 514
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
515
	}
516

517
	free(tmp);
518
	return ret;
519 520
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
/* 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);

537
	reloc_sym = kernel_get_ref_reloc_sym();
538 539 540 541 542 543
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
544
		if (tevs[i].point.address && !tevs[i].point.retprobe) {
545 546 547 548 549 550 551 552 553 554 555 556
			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;
}

557
/* Try to find perf_probe_event with debuginfo */
558
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
559
					  struct probe_trace_event **tevs,
560
					  int max_tevs, const char *target)
561 562
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
563
	struct perf_probe_point tmp;
564
	struct debuginfo *dinfo;
565
	int ntevs, ret = 0;
566

567
	dinfo = open_debuginfo(target, !need_dwarf);
568

569
	if (!dinfo) {
570
		if (need_dwarf)
571 572
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
573 574 575
		return 0;
	}

576
	pr_debug("Try to find probe point from debuginfo.\n");
577 578 579
	/* Searching trace events corresponding to a probe event */
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);

580 581 582 583 584 585 586 587 588 589 590 591 592 593
	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));
		}
	}

594
	debuginfo__delete(dinfo);
595

596
	if (ntevs > 0) {	/* Succeeded to find trace events */
597 598 599
		pr_debug("Found %d probe_trace_events.\n", ntevs);
		ret = post_process_probe_trace_events(*tevs, ntevs,
							target, pev->uprobes);
600 601 602 603
		if (ret < 0) {
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
604
		return ret < 0 ? ret : ntevs;
605
	}
606

607
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
608
		pr_warning("Probe point '%s' not found in debuginfo.\n",
609
			   synthesize_perf_probe_point(&pev->point));
610 611 612
		if (need_dwarf)
			return -ENOENT;
		return 0;
613 614
	}
	/* Error path : ntevs < 0 */
615 616 617 618 619
	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 已提交
620
			pr_debug("Trying to use symbols.\n");
621 622
			return 0;
		}
623
	}
624
	return ntevs;
625 626
}

627 628 629 630 631 632
/*
 * 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.
 */
633 634
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
635
{
636 637 638 639 640 641 642 643 644
	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);
645
				return *new_path ? 0 : -ENOMEM;
646 647 648
			} else
				return -errno;
		}
649 650
	}

651
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
652 653 654 655
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
656
		sprintf(*new_path, "%s/%s", prefix, raw_path);
657 658 659 660

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

661
		if (!symbol_conf.source_prefix) {
662
			/* In case of searching comp_dir, don't retry */
663
			zfree(new_path);
664
			return -errno;
665
		}
666

667 668 669 670 671 672 673
		switch (errno) {
		case ENAMETOOLONG:
		case ENOENT:
		case EROFS:
		case EFAULT:
			raw_path = strchr(++raw_path, '/');
			if (!raw_path) {
674
				zfree(new_path);
675 676 677 678 679
				return -ENOENT;
			}
			continue;

		default:
680
			zfree(new_path);
681 682 683 684 685
			return -errno;
		}
	}
}

686 687 688
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

689
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
690
{
691
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
692 693
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
694

695
	do {
696 697
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
698 699 700 701 702
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
703
		}
704 705 706
		color_fprintf(stdout, color, "%s", buf);

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

708
	return 1;
709
error:
710
	if (ferror(fp)) {
711 712
		pr_warning("File read error: %s\n",
			   strerror_r(errno, sbuf, sizeof(sbuf)));
713 714 715 716
		return -1;
	}
	return 0;
}
717

718 719 720 721 722 723 724 725
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;
726 727
}

728 729 730 731 732
#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)

733 734 735 736
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
737
static int __show_line_range(struct line_range *lr, const char *module)
738
{
739
	int l = 1;
740
	struct int_node *ln;
741
	struct debuginfo *dinfo;
742
	FILE *fp;
743
	int ret;
744
	char *tmp;
745
	char sbuf[STRERR_BUFSIZE];
746 747

	/* Search a line range */
748 749
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
750
		return -ENOENT;
751

752 753
	ret = debuginfo__find_line_range(dinfo, lr);
	debuginfo__delete(dinfo);
754
	if (ret == 0 || ret == -ENOENT) {
755 756 757
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
758
		pr_warning("Debuginfo analysis failed.\n");
759 760
		return ret;
	}
761

762 763
	/* Convert source file path */
	tmp = lr->path;
764
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
765 766
	free(tmp);	/* Free old path */
	if (ret < 0) {
767
		pr_warning("Failed to find source file path.\n");
768 769 770
		return ret;
	}

771 772 773
	setup_pager();

	if (lr->function)
774
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
775 776
			lr->start - lr->offset);
	else
777
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
778 779

	fp = fopen(lr->path, "r");
780 781
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
782
			   strerror_r(errno, sbuf, sizeof(sbuf)));
783 784
		return -errno;
	}
785
	/* Skip to starting line number */
786
	while (l < lr->start) {
787
		ret = skip_one_line(fp, l++);
788 789 790
		if (ret < 0)
			goto end;
	}
791

792 793
	intlist__for_each(ln, lr->line_list) {
		for (; ln->i > l; l++) {
794
			ret = show_one_line(fp, l - lr->offset);
795 796 797
			if (ret < 0)
				goto end;
		}
798
		ret = show_one_line_with_num(fp, l++ - lr->offset);
799 800
		if (ret < 0)
			goto end;
801 802 803 804
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
805 806 807
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
808 809
			break;
	}
810
end:
811
	fclose(fp);
812
	return ret;
813 814
}

815
int show_line_range(struct line_range *lr, const char *module, bool user)
816 817 818
{
	int ret;

819
	ret = init_symbol_maps(user);
820 821 822 823 824 825 826 827
	if (ret < 0)
		return ret;
	ret = __show_line_range(lr, module);
	exit_symbol_maps();

	return ret;
}

828 829
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
830
				  int max_vls, struct strfilter *_filter,
831
				  bool externs, const char *target)
832 833
{
	char *buf;
834
	int ret, i, nvars;
835 836
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
837
	struct perf_probe_point tmp;
838
	const char *var;
839 840 841 842 843 844

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

845 846
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
						max_vls, externs);
847 848 849 850 851 852 853 854 855
	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);
		}
	}
856
	if (ret <= 0) {
857 858 859 860 861
		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");
862 863
		goto end;
	}
864

865 866 867 868 869 870 871 872 873 874
	/* 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);
875
		zfree(&vl->point.symbol);
876 877 878 879 880
		nvars = 0;
		if (vl->vars) {
			strlist__for_each(node, vl->vars) {
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
881
					fprintf(stdout, "\t\t%s\n", node->s);
882 883 884 885
					nvars++;
				}
			}
			strlist__delete(vl->vars);
886
		}
887 888 889 890 891
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
892 893 894 895 896 897
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
898 899
			int max_vls, const char *module,
			struct strfilter *_filter, bool externs)
900
{
901 902
	int i, ret = 0;
	struct debuginfo *dinfo;
903

904
	ret = init_symbol_maps(pevs->uprobes);
905 906 907
	if (ret < 0)
		return ret;

908
	dinfo = open_debuginfo(module, false);
909
	if (!dinfo) {
910 911
		ret = -ENOENT;
		goto out;
912 913
	}

914 915
	setup_pager();

916 917
	for (i = 0; i < npevs && ret >= 0; i++)
		ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
918
					     externs, module);
919 920

	debuginfo__delete(dinfo);
921 922
out:
	exit_symbol_maps();
923 924 925
	return ret;
}

926
#else	/* !HAVE_DWARF_SUPPORT */
927

928 929 930 931
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)
932
{
933
	return -ENOSYS;
934 935
}

936
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
937
				struct probe_trace_event **tevs __maybe_unused,
938 939
				int max_tevs __maybe_unused,
				const char *target __maybe_unused)
940
{
941 942 943 944
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
945

946 947 948
	return 0;
}

949
int show_line_range(struct line_range *lr __maybe_unused,
950 951
		    const char *module __maybe_unused,
		    bool user __maybe_unused)
952
{
953 954
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
955 956
}

957 958 959 960 961
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)
962 963 964 965
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
966 967
#endif

968 969 970 971 972 973
void line_range__clear(struct line_range *lr)
{
	free(lr->function);
	free(lr->file);
	free(lr->path);
	free(lr->comp_dir);
974
	intlist__delete(lr->line_list);
975 976 977
	memset(lr, 0, sizeof(*lr));
}

978
int line_range__init(struct line_range *lr)
979 980
{
	memset(lr, 0, sizeof(*lr));
981 982 983 984 985
	lr->line_list = intlist__new(NULL);
	if (!lr->line_list)
		return -ENOMEM;
	else
		return 0;
986 987
}

988 989 990 991 992 993 994 995 996 997 998 999 1000
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;
}

1001 1002 1003 1004 1005
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1006
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1007
 */
1008
int parse_line_range_desc(const char *arg, struct line_range *lr)
1009
{
1010
	char *range, *file, *name = strdup(arg);
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
	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--;
			}
		}
1045

1046
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1047 1048

		err = -EINVAL;
1049
		if (lr->start > lr->end) {
1050
			semantic_error("Start line must be smaller"
1051
				       " than end line.\n");
1052
			goto err;
1053
		}
1054 1055 1056
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
1057
		}
1058
	}
1059

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	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, '.'))
1070
		lr->file = name;
1071
	else
1072
		lr->function = name;
1073 1074

	return 0;
1075 1076 1077
err:
	free(name);
	return err;
1078 1079
}

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
/* 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;
}

1092
/* Parse probepoint definition. */
1093
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1094
{
1095
	struct perf_probe_point *pp = &pev->point;
1096 1097 1098 1099
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
1100 1101
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1102 1103
	 *
	 * TODO:Group name support
1104 1105
	 */

1106 1107
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
1108 1109
		*ptr = '\0';
		tmp = ptr + 1;
1110 1111 1112 1113 1114
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
1115
			semantic_error("%s is bad for event name -it must "
1116 1117 1118
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
1119 1120 1121
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
1122
		pev->group = NULL;
1123 1124 1125
		arg = tmp;
	}

1126
	ptr = strpbrk(arg, ";:+@%");
1127 1128 1129 1130 1131
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1132 1133 1134 1135
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

1136
	/* Check arg is function or file and copy it */
1137 1138
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
1139
	else			/* Function */
1140
		pp->function = tmp;
1141 1142 1143 1144 1145

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1146
		if (c == ';') {	/* Lazy pattern must be the last part */
1147 1148 1149
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1150 1151 1152
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1153 1154 1155 1156 1157 1158 1159
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1160
			if (*tmp != '\0') {
1161
				semantic_error("There is non-digit char"
1162 1163 1164
					       " in line number.\n");
				return -EINVAL;
			}
1165 1166 1167
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1168
			if (*tmp != '\0') {
1169
				semantic_error("There is non-digit character"
1170 1171 1172
						" in offset.\n");
				return -EINVAL;
			}
1173 1174
			break;
		case '@':	/* File name */
1175 1176 1177 1178
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1179 1180 1181
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1182 1183 1184 1185
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1186 1187 1188 1189
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1190
			break;
1191 1192 1193 1194
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1195 1196 1197 1198 1199
			break;
		}
	}

	/* Exclusion check */
1200
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1201 1202
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1203 1204
		return -EINVAL;
	}
1205

1206
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
1207
		semantic_error("Lazy pattern can't be used with offset.\n");
1208 1209
		return -EINVAL;
	}
1210

1211
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1212
		semantic_error("Offset can't be used with line number.\n");
1213 1214
		return -EINVAL;
	}
1215

1216
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1217
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1218
			       "lazy pattern.\n");
1219 1220
		return -EINVAL;
	}
1221

1222
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1223
		semantic_error("Offset requires an entry function.\n");
1224 1225
		return -EINVAL;
	}
1226

1227
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1228
		semantic_error("Return probe requires an entry function.\n");
1229 1230
		return -EINVAL;
	}
1231

1232
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1233
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1234
			       "return probe.\n");
1235 1236
		return -EINVAL;
	}
1237

1238
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1239 1240
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1241
	return 0;
1242 1243
}

1244
/* Parse perf-probe event argument */
1245
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1246
{
1247
	char *tmp, *goodname;
1248 1249 1250 1251
	struct perf_probe_arg_field **fieldp;

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

1252 1253
	tmp = strchr(str, '=');
	if (tmp) {
1254 1255 1256
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1257
		pr_debug("name:%s ", arg->name);
1258 1259 1260
		str = tmp + 1;
	}

1261 1262 1263
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1264 1265 1266
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1267 1268 1269
		pr_debug("type:%s ", arg->type);
	}

1270
	tmp = strpbrk(str, "-.[");
1271 1272
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1273 1274 1275
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1276
		pr_debug("%s\n", arg->var);
1277
		return 0;
1278 1279
	}

1280
	/* Structure fields or array element */
1281 1282 1283
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1284
	goodname = arg->var;
1285
	pr_debug("%s, ", arg->var);
1286 1287 1288
	fieldp = &arg->field;

	do {
1289 1290 1291
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1292 1293 1294
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1295
			(*fieldp)->ref = true;
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
			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, "-.[");
1317
		}
1318
		if (tmp) {
1319 1320 1321
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1322 1323
			if (*str != '[')
				goodname = (*fieldp)->name;
1324 1325 1326 1327
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1328 1329 1330
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1331 1332
	if (*str != '[')
		goodname = (*fieldp)->name;
1333
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1334

1335
	/* If no name is specified, set the last field name (not array index)*/
1336
	if (!arg->name) {
1337
		arg->name = strdup(goodname);
1338 1339 1340
		if (arg->name == NULL)
			return -ENOMEM;
	}
1341
	return 0;
1342 1343
}

1344
/* Parse perf-probe event command */
1345
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1346
{
1347
	char **argv;
1348
	int argc, i, ret = 0;
1349

1350
	argv = argv_split(cmd, &argc);
1351 1352 1353 1354 1355 1356 1357 1358 1359
	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;
	}
1360
	/* Parse probe point */
1361 1362 1363
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1364

1365
	/* Copy arguments and ensure return probe has no C argument */
1366
	pev->nargs = argc - 1;
1367 1368 1369 1370 1371
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1372 1373 1374 1375
	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) {
1376
			semantic_error("You can't specify local variable for"
1377 1378 1379
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1380
	}
1381
out:
1382
	argv_free(argv);
1383 1384

	return ret;
1385 1386
}

1387 1388 1389 1390 1391 1392 1393 1394 1395
/* 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++)
1396
		if (is_c_varname(pev->args[i].var))
1397 1398 1399 1400 1401
			return true;

	return false;
}

1402 1403
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
1404
				     struct probe_trace_event *tev)
1405
{
1406
	struct probe_trace_point *tp = &tev->point;
1407 1408
	char pr;
	char *p;
1409
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1410 1411 1412
	int ret, i, argc;
	char **argv;

1413
	pr_debug("Parsing probe_events: %s\n", cmd);
1414
	argv = argv_split(cmd, &argc);
1415 1416 1417 1418 1419 1420 1421 1422 1423
	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;
	}
1424 1425

	/* Scan event and group name. */
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
	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) {
1436 1437 1438 1439
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1440 1441 1442 1443 1444 1445 1446
	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;
	}
1447
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1448

1449
	tp->retprobe = (pr == 'r');
1450

1451 1452 1453 1454 1455 1456 1457
	/* 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];
1458
	fmt1_str = strtok_r(p, "+", &fmt);
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	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);
1473
	}
1474

1475
	tev->nargs = argc - 2;
1476
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1477 1478 1479 1480
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1481
	for (i = 0; i < tev->nargs; i++) {
1482 1483
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1484 1485 1486
			*p++ = '\0';
		else
			p = argv[i + 2];
1487
		tev->args[i].name = strdup(argv[i + 2]);
1488
		/* TODO: parse regs and offset */
1489 1490 1491 1492 1493
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1494
	}
1495 1496
	ret = 0;
out:
1497
	free(argv0_str);
1498
	argv_free(argv);
1499
	return ret;
1500 1501
}

1502 1503 1504 1505 1506 1507 1508
/* 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;

1509 1510 1511 1512
	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);
1513 1514 1515 1516 1517 1518
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1519 1520 1521 1522 1523
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1524 1525 1526 1527 1528 1529
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1530 1531 1532 1533 1534 1535 1536 1537 1538

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

1539 1540
	return tmp - buf;
error:
1541
	pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1542
	return ret;
1543 1544
}

1545 1546
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1547
{
1548 1549 1550
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1551

1552 1553 1554 1555 1556
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1557
	if (pp->offset) {
1558
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1559 1560 1561 1562
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1563 1564 1565 1566 1567
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1568 1569 1570 1571 1572 1573 1574
		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);
1575 1576 1577 1578 1579
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1580 1581 1582
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1583
	else
1584
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1585 1586 1587 1588
	if (ret <= 0)
		goto error;

	return buf;
1589
error:
1590
	pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1591
	free(buf);
1592
	return NULL;
1593 1594
}

1595 1596
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1597 1598 1599 1600
{
	char *buf;
	int i, len, ret;

1601 1602 1603
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1604

1605 1606
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1607
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1608 1609 1610 1611 1612
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1613 1614 1615
		len += ret;
	}

1616 1617 1618 1619
	return buf;
}
#endif

1620
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1621 1622 1623 1624 1625
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1626
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
							 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;
1641 1642 1643

}

1644
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1645
				       char *buf, size_t buflen)
1646
{
1647
	struct probe_trace_arg_ref *ref = arg->ref;
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
	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;

1661 1662 1663 1664
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1665
	/* Dereferencing arguments */
1666
	if (ref) {
1667
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1668 1669 1670 1671 1672 1673
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1674 1675 1676 1677 1678
	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);
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	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;
	}
1692 1693 1694 1695 1696 1697 1698
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1699 1700 1701 1702

	return buf - tmp;
}

1703
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1704
{
1705
	struct probe_trace_point *tp = &tev->point;
1706 1707 1708
	char *buf;
	int i, len, ret;

1709 1710 1711 1712
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
	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 */
1723
	if (tev->uprobes)
1724 1725
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
				 tp->module, tp->address);
1726
	else
1727
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1728 1729 1730
				 tp->module ?: "", tp->module ? ":" : "",
				 tp->symbol, tp->offset);

1731
	if (ret <= 0)
1732
		goto error;
1733
	len += ret;
1734

1735
	for (i = 0; i < tev->nargs; i++) {
1736
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1737
						  MAX_CMDLEN - len);
1738
		if (ret <= 0)
1739 1740 1741 1742
			goto error;
		len += ret;
	}

1743
	return buf;
1744
error:
1745 1746 1747
	free(buf);
	return NULL;
}
1748

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 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
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;
}

1822
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1823
			       struct perf_probe_event *pev, bool is_kprobe)
1824
{
1825
	char buf[64] = "";
1826
	int i, ret;
1827

1828
	/* Convert event/group name */
1829 1830 1831 1832
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1833

1834
	/* Convert trace_point to probe_point */
1835
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1836 1837
	if (ret < 0)
		return ret;
1838

1839 1840
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1841 1842 1843
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1844
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1845
		if (tev->args[i].name)
1846
			pev->args[i].name = strdup(tev->args[i].name);
1847
		else {
1848
			ret = synthesize_probe_trace_arg(&tev->args[i],
1849
							  buf, 64);
1850
			pev->args[i].name = strdup(buf);
1851
		}
1852 1853 1854
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1855 1856 1857 1858 1859

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1860 1861 1862 1863
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
1864
	struct perf_probe_arg_field *field, *next;
1865 1866
	int i;

1867 1868
	free(pev->event);
	free(pev->group);
1869
	clear_perf_probe_point(&pev->point);
1870

1871
	for (i = 0; i < pev->nargs; i++) {
1872 1873 1874
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
1875 1876 1877
		field = pev->args[i].field;
		while (field) {
			next = field->next;
1878
			zfree(&field->name);
1879 1880 1881 1882
			free(field);
			field = next;
		}
	}
1883
	free(pev->args);
1884 1885 1886
	memset(pev, 0, sizeof(*pev));
}

1887
static void clear_probe_trace_event(struct probe_trace_event *tev)
1888
{
1889
	struct probe_trace_arg_ref *ref, *next;
1890 1891
	int i;

1892 1893 1894 1895
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
	free(tev->point.module);
1896
	for (i = 0; i < tev->nargs; i++) {
1897 1898 1899
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
1900 1901 1902 1903 1904 1905 1906
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
1907
	free(tev->args);
1908
	memset(tev, 0, sizeof(*tev));
1909 1910
}

1911
static void print_open_warning(int err, bool is_kprobe)
1912
{
1913
	char sbuf[STRERR_BUFSIZE];
1914

1915
	if (err == -ENOENT) {
1916 1917 1918 1919 1920 1921 1922
		const char *config;

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

1923 1924 1925 1926
		pr_warning("%cprobe_events file does not exist"
			   " - please rebuild kernel with %s.\n",
			   is_kprobe ? 'k' : 'u', config);
	} else if (err == -ENOTSUP)
1927
		pr_warning("Tracefs or debugfs is not mounted.\n");
1928 1929 1930 1931
	else
		pr_warning("Failed to open %cprobe_events: %s\n",
			   is_kprobe ? 'k' : 'u',
			   strerror_r(-err, sbuf, sizeof(sbuf)));
1932 1933
}

1934 1935 1936 1937
static void print_both_open_warning(int kerr, int uerr)
{
	/* Both kprobes and uprobes are disabled, warn it. */
	if (kerr == -ENOTSUP && uerr == -ENOTSUP)
1938
		pr_warning("Tracefs or debugfs is not mounted.\n");
1939 1940 1941 1942
	else if (kerr == -ENOENT && uerr == -ENOENT)
		pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
			   "or/and CONFIG_UPROBE_EVENTS.\n");
	else {
1943
		char sbuf[STRERR_BUFSIZE];
1944 1945 1946 1947 1948 1949 1950
		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)));
	}
}

1951
static int open_probe_events(const char *trace_file, bool readwrite)
1952 1953
{
	char buf[PATH_MAX];
1954
	const char *__debugfs;
1955
	const char *tracing_dir = "";
1956 1957
	int ret;

1958 1959 1960
	__debugfs = tracefs_find_mountpoint();
	if (__debugfs == NULL) {
		tracing_dir = "tracing/";
1961

1962 1963 1964 1965 1966 1967 1968
		__debugfs = debugfs_find_mountpoint();
		if (__debugfs == NULL)
			return -ENOTSUP;
	}

	ret = e_snprintf(buf, PATH_MAX, "%s/%s%s",
			 __debugfs, tracing_dir, trace_file);
1969
	if (ret >= 0) {
1970
		pr_debug("Opening %s write=%d\n", buf, readwrite);
1971 1972 1973 1974
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
1975

1976
		if (ret < 0)
1977
			ret = -errno;
1978 1979 1980 1981
	}
	return ret;
}

1982 1983
static int open_kprobe_events(bool readwrite)
{
1984
	return open_probe_events("kprobe_events", readwrite);
1985 1986 1987 1988
}

static int open_uprobe_events(bool readwrite)
{
1989
	return open_probe_events("uprobe_events", readwrite);
1990 1991 1992
}

/* Get raw string list of current kprobe_events  or uprobe_events */
1993
static struct strlist *get_probe_trace_command_rawlist(int fd)
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
{
	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);
2013
		if (ret < 0) {
2014
			pr_debug("strlist__add failed (%d)\n", ret);
2015 2016 2017
			strlist__delete(sl);
			return NULL;
		}
2018 2019 2020 2021 2022 2023
	}
	fclose(fp);

	return sl;
}

2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 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
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;
}

2113
/* Show an event */
2114 2115
static int show_perf_probe_event(struct perf_probe_event *pev,
				 const char *module)
2116
{
2117
	int i, ret;
2118
	char buf[128];
2119
	char *place;
2120

2121 2122
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
2123 2124
	if (!place)
		return -EINVAL;
2125 2126

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
2127
	if (ret < 0)
2128 2129
		return ret;

2130
	pr_info("  %-20s (on %s", buf, place);
2131
	if (module)
2132
		pr_info(" in %s", module);
2133

2134
	if (pev->nargs > 0) {
2135
		pr_info(" with");
2136
		for (i = 0; i < pev->nargs; i++) {
2137 2138 2139 2140
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
2141
			pr_info(" %s", buf);
2142
		}
2143
	}
2144
	pr_info(")\n");
2145
	free(place);
2146
	return ret;
2147 2148
}

2149
static int __show_perf_probe_events(int fd, bool is_kprobe)
2150
{
2151
	int ret = 0;
2152
	struct probe_trace_event tev;
2153
	struct perf_probe_event pev;
2154 2155 2156
	struct strlist *rawlist;
	struct str_node *ent;

2157 2158
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2159

2160
	rawlist = get_probe_trace_command_rawlist(fd);
2161
	if (!rawlist)
2162
		return -ENOMEM;
2163

2164
	strlist__for_each(ent, rawlist) {
2165
		ret = parse_probe_trace_command(ent->s, &tev);
2166
		if (ret >= 0) {
2167 2168
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2169
			if (ret >= 0)
2170 2171
				ret = show_perf_probe_event(&pev,
							    tev.point.module);
2172
		}
2173
		clear_perf_probe_event(&pev);
2174
		clear_probe_trace_event(&tev);
2175 2176
		if (ret < 0)
			break;
2177 2178
	}
	strlist__delete(rawlist);
2179 2180

	return ret;
2181 2182
}

2183 2184 2185
/* List up current perf-probe events */
int show_perf_probe_events(void)
{
2186
	int kp_fd, up_fd, ret;
2187 2188 2189

	setup_pager();

2190
	ret = init_symbol_maps(false);
2191 2192 2193
	if (ret < 0)
		return ret;

2194 2195 2196 2197 2198 2199 2200
	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;
	}
2201

2202 2203
	up_fd = open_uprobe_events(false);
	if (kp_fd < 0 && up_fd < 0) {
2204
		print_both_open_warning(kp_fd, up_fd);
2205 2206
		ret = kp_fd;
		goto out;
2207 2208
	}

2209 2210 2211 2212 2213
	if (up_fd >= 0) {
		ret = __show_perf_probe_events(up_fd, false);
		close(up_fd);
	}
out:
2214
	exit_symbol_maps();
2215 2216 2217
	return ret;
}

2218
/* Get current perf-probe event names */
2219
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
2220
{
2221
	char buf[128];
2222 2223
	struct strlist *sl, *rawlist;
	struct str_node *ent;
2224
	struct probe_trace_event tev;
2225
	int ret = 0;
2226

2227
	memset(&tev, 0, sizeof(tev));
2228
	rawlist = get_probe_trace_command_rawlist(fd);
2229 2230
	if (!rawlist)
		return NULL;
2231
	sl = strlist__new(true, NULL);
2232
	strlist__for_each(ent, rawlist) {
2233
		ret = parse_probe_trace_command(ent->s, &tev);
2234 2235
		if (ret < 0)
			break;
2236
		if (include_group) {
2237 2238 2239 2240
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
2241
		} else
2242
			ret = strlist__add(sl, tev.event);
2243
		clear_probe_trace_event(&tev);
2244 2245
		if (ret < 0)
			break;
2246 2247 2248
	}
	strlist__delete(rawlist);

2249 2250 2251 2252
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
2253 2254 2255
	return sl;
}

2256
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
2257
{
2258
	int ret = 0;
2259
	char *buf = synthesize_probe_trace_command(tev);
2260
	char sbuf[STRERR_BUFSIZE];
2261

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

2267
	pr_debug("Writing event: %s\n", buf);
2268 2269
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
2270 2271
		if (ret <= 0) {
			ret = -errno;
2272
			pr_warning("Failed to write event: %s\n",
2273
				   strerror_r(errno, sbuf, sizeof(sbuf)));
2274
		}
2275
	}
2276
	free(buf);
2277
	return ret;
2278 2279
}

2280 2281
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2282 2283
{
	int i, ret;
2284 2285 2286

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
2287
	if (ret < 0) {
2288
		pr_debug("snprintf() failed: %d\n", ret);
2289 2290
		return ret;
	}
2291
	if (!strlist__has_entry(namelist, buf))
2292
		return 0;
2293

2294 2295 2296
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
2297
		return -EEXIST;
2298 2299
	}

2300 2301
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2302
		ret = e_snprintf(buf, len, "%s_%d", base, i);
2303
		if (ret < 0) {
2304
			pr_debug("snprintf() failed: %d\n", ret);
2305 2306
			return ret;
		}
2307 2308 2309
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2310 2311 2312 2313 2314 2315
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
2316 2317
}

2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
/* 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);
}

2339 2340
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
2341
				     int ntevs, bool allow_suffix)
2342
{
2343
	int i, fd, ret;
2344
	struct probe_trace_event *tev = NULL;
2345 2346
	char buf[64];
	const char *event, *group;
2347
	struct strlist *namelist;
2348 2349
	LIST_HEAD(blacklist);
	struct kprobe_blacklist_node *node;
2350

2351 2352 2353 2354 2355
	if (pev->uprobes)
		fd = open_uprobe_events(true);
	else
		fd = open_kprobe_events(true);

2356 2357
	if (fd < 0) {
		print_open_warning(fd, !pev->uprobes);
2358
		return fd;
2359 2360
	}

2361
	/* Get current event names */
2362
	namelist = get_probe_trace_event_names(fd, false);
2363 2364 2365 2366
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
2367 2368 2369 2370 2371 2372
	/* Get kprobe blacklist if exists */
	if (!pev->uprobes) {
		ret = kprobe_blacklist__load(&blacklist);
		if (ret < 0)
			pr_debug("No kprobe blacklist support, ignored\n");
	}
2373

2374
	ret = 0;
2375
	pr_info("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2376
	for (i = 0; i < ntevs; i++) {
2377
		tev = &tevs[i];
2378 2379 2380 2381 2382 2383 2384 2385
		/* 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;
		}

2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
		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 */
2399 2400 2401 2402
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
2403 2404
		event = buf;

2405 2406 2407 2408 2409 2410
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
2411
		ret = write_probe_trace_event(fd, tev);
2412 2413
		if (ret < 0)
			break;
2414 2415 2416 2417 2418 2419 2420 2421
		/* 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;
2422
		show_perf_probe_event(pev, tev->point.module);
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
		/* 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;
2434
	}
2435 2436
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2437

2438 2439
	/* Note that it is possible to skip all events because of blacklist */
	if (ret >= 0 && tev->event) {
2440
		/* Show how to use the event. */
2441 2442
		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,
2443 2444
			 tev->event);
	}
2445

2446
	kprobe_blacklist__delete(&blacklist);
2447
	strlist__delete(namelist);
2448
	close(fd);
2449
	return ret;
2450
}
2451

2452
static int find_probe_functions(struct map *map, char *name)
2453
{
2454
	int found = 0;
2455
	struct symbol *sym;
2456

2457
	map__for_each_symbol_by_name(map, name, sym) {
2458 2459
		if (sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL)
			found++;
2460
	}
2461 2462

	return found;
2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474
}

#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)
2475
{
2476 2477 2478
	struct map *map = NULL;
	struct kmap *kmap = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2479
	struct symbol *sym;
2480
	struct probe_trace_event *tev;
2481 2482
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2483
	int num_matched_functions;
2484
	int ret, i;
2485

2486
	map = get_target_map(target, pev->uprobes);
2487 2488 2489
	if (!map) {
		ret = -EINVAL;
		goto out;
2490 2491
	}

2492 2493 2494 2495
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2496 2497
	num_matched_functions = find_probe_functions(map, pp->function);
	if (num_matched_functions == 0) {
2498 2499 2500 2501 2502 2503 2504 2505 2506
		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;
2507 2508
	}

2509
	if (!pev->uprobes && !pp->retprobe) {
2510 2511 2512 2513 2514 2515 2516 2517
		kmap = map__kmap(map);
		reloc_sym = kmap->ref_reloc_sym;
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2518

2519 2520 2521
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2522
		ret = -ENOMEM;
2523
		goto out;
2524
	}
2525

2526
	ret = 0;
2527

2528
	map__for_each_symbol_by_name(map, pp->function, sym) {
2529 2530 2531 2532 2533
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2534
		}
2535
		ret++;
2536

2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561
		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;
2562
		}
2563
		for (i = 0; i < tev->nargs; i++) {
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574
			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);
2575
		}
2576 2577
	}

2578
out:
2579
	put_target_map(map, pev->uprobes);
2580
	return ret;
2581

2582 2583 2584 2585 2586 2587 2588
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2589

2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602
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;
		}
2603
	}
2604

2605 2606 2607 2608 2609 2610
	/* 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);
2611 2612 2613 2614
}

struct __event_package {
	struct perf_probe_event		*pev;
2615
	struct probe_trace_event	*tevs;
2616 2617 2618
	int				ntevs;
};

2619
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2620
			  int max_tevs, const char *target, bool force_add)
2621
{
2622
	int i, j, ret;
2623 2624
	struct __event_package *pkgs;

2625
	ret = 0;
2626
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
2627

2628 2629
	if (pkgs == NULL)
		return -ENOMEM;
2630

2631
	ret = init_symbol_maps(pevs->uprobes);
2632 2633
	if (ret < 0) {
		free(pkgs);
2634
		return ret;
2635
	}
2636 2637 2638 2639 2640

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
2641
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
2642 2643
						     &pkgs[i].tevs,
						     max_tevs,
2644
						     target);
2645 2646 2647
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
2648 2649
	}

2650
	/* Loop 2: add all events */
2651
	for (i = 0; i < npevs; i++) {
2652
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2653
						pkgs[i].ntevs, force_add);
2654 2655 2656
		if (ret < 0)
			break;
	}
2657
end:
2658 2659
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
2660
		for (j = 0; j < pkgs[i].ntevs; j++)
2661
			clear_probe_trace_event(&pkgs[i].tevs[j]);
2662
		zfree(&pkgs[i].tevs);
2663 2664
	}
	free(pkgs);
2665
	exit_symbol_maps();
2666 2667

	return ret;
2668 2669
}

2670
static int __del_trace_probe_event(int fd, struct str_node *ent)
2671 2672 2673
{
	char *p;
	char buf[128];
2674
	int ret;
2675

2676
	/* Convert from perf-probe event to trace-probe event */
2677 2678 2679 2680
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

2681
	p = strchr(buf + 2, ':');
2682 2683 2684 2685 2686 2687
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
2688 2689
	*p = '/';

2690 2691
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
2692 2693
	if (ret < 0) {
		ret = -errno;
2694
		goto error;
2695
	}
2696

2697
	pr_info("Removed event: %s\n", ent->s);
2698 2699
	return 0;
error:
2700 2701
	pr_warning("Failed to delete event: %s\n",
		   strerror_r(-ret, buf, sizeof(buf)));
2702
	return ret;
2703 2704
}

2705 2706
static int del_trace_probe_event(int fd, const char *buf,
						  struct strlist *namelist)
2707
{
2708
	struct str_node *ent, *n;
2709
	int ret = -1;
2710

2711 2712 2713
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
2714
				ret = __del_trace_probe_event(fd, ent);
2715 2716
				if (ret < 0)
					break;
2717 2718 2719 2720 2721
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
2722
			ret = __del_trace_probe_event(fd, ent);
2723 2724
			if (ret >= 0)
				strlist__remove(namelist, ent);
2725 2726
		}
	}
2727 2728

	return ret;
2729 2730
}

2731
int del_perf_probe_events(struct strlist *dellist)
2732
{
2733 2734
	int ret = -1, ufd = -1, kfd = -1;
	char buf[128];
2735 2736 2737
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
2738
	struct strlist *namelist = NULL, *unamelist = NULL;
2739

2740
	/* Get current event names */
2741
	kfd = open_kprobe_events(true);
2742 2743
	if (kfd >= 0)
		namelist = get_probe_trace_event_names(kfd, true);
2744 2745

	ufd = open_uprobe_events(true);
2746
	if (ufd >= 0)
2747 2748
		unamelist = get_probe_trace_event_names(ufd, true);

2749 2750 2751 2752 2753
	if (kfd < 0 && ufd < 0) {
		print_both_open_warning(kfd, ufd);
		goto error;
	}

2754 2755
	if (namelist == NULL && unamelist == NULL)
		goto error;
2756

2757
	strlist__for_each(ent, dellist) {
2758 2759 2760
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
2761
			goto error;
2762
		}
2763
		pr_debug("Parsing: %s\n", str);
2764 2765 2766 2767 2768 2769
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
2770
			group = "*";
2771 2772
			event = str;
		}
2773 2774 2775 2776 2777 2778 2779 2780

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

2781
		pr_debug("Group: %s, Event: %s\n", group, event);
2782 2783 2784 2785 2786 2787 2788 2789 2790 2791

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

2792 2793
		free(str);
	}
2794 2795 2796

error:
	if (kfd >= 0) {
2797
		strlist__delete(namelist);
2798 2799 2800 2801
		close(kfd);
	}

	if (ufd >= 0) {
2802
		strlist__delete(unamelist);
2803 2804
		close(ufd);
	}
2805 2806

	return ret;
2807
}
2808

2809 2810
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2811

2812
/*
2813 2814
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2815
 */
2816
static int filter_available_functions(struct map *map __maybe_unused,
2817
				      struct symbol *sym)
2818
{
2819
	if ((sym->binding == STB_GLOBAL || sym->binding == STB_LOCAL) &&
2820 2821 2822
	    strfilter__compare(available_func_filter, sym->name))
		return 0;
	return 1;
2823 2824
}

2825 2826
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
2827 2828 2829 2830
{
	struct map *map;
	int ret;

2831
	ret = init_symbol_maps(user);
2832 2833 2834
	if (ret < 0)
		return ret;

2835 2836 2837 2838 2839
	/* Get a symbol map */
	if (user)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
2840
	if (!map) {
2841
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2842 2843
		return -EINVAL;
	}
2844

2845
	/* Load symbols with given filter */
2846
	available_func_filter = _filter;
2847 2848 2849 2850 2851 2852
	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);
2853

2854 2855 2856 2857 2858 2859 2860 2861 2862
	/* 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();
2863

2864
	return ret;
2865 2866
}