probe-event.c 61.9 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 "probe-file.h"
49
#include "session.h"
50 51 52 53

#define MAX_CMDLEN 256
#define PERFPROBE_GROUP "probe"

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

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

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

71
static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
72
static struct machine *host_machine;
73

74
/* Initialize symbol maps and path of vmlinux/modules */
75
static int init_symbol_maps(bool user_only)
76
{
77 78
	int ret;

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

87 88
	if (host_machine || user_only)	/* already initialized */
		return 0;
89

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

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

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

121 122 123 124 125 126 127 128 129 130 131 132 133 134
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]);
135 136
	if (!kmap)
		return NULL;
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
	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
static struct map *kernel_get_module_map(const char *module)
{
161
	struct map_groups *grp = &host_machine->kmaps;
162
	struct maps *maps = &grp->maps[MAP__FUNCTION];
163
	struct map *pos;
164

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

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

172
	for (pos = maps__first(maps); pos; pos = map__next(pos)) {
173 174 175 176 177 178 179 180
		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
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 */
194
		map__put(map);
195 196 197 198
	}
}


199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
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;
}

230 231 232 233 234 235 236
static void clear_perf_probe_point(struct perf_probe_point *pp)
{
	free(pp->file);
	free(pp->function);
	free(pp->lazy_line);
}

237 238 239 240 241 242 243 244
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);
}

245 246 247
static bool kprobe_blacklist__listed(unsigned long address);
static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
{
248 249
	u64 etext_addr;

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

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

	return true;
}

263
#ifdef HAVE_DWARF_SUPPORT
264 265 266 267 268 269 270 271 272

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

	if (module) {
273 274 275
		list_for_each_entry(dso, &host_machine->dsos.head, node) {
			if (!dso->kernel)
				continue;
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
			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 -ENOENT;
	}

	map = host_machine->vmlinux_maps[MAP__FUNCTION];
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	dso->load_errno = 0;
	if (vmlinux_name)
		ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
	else
		ret = dso__load_vmlinux_path(dso, map, NULL);
found:
	*pdso = dso;
	return ret;
}

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
/*
 * 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) {
323 324 325 326
		if (uprobes)
			address = sym->start;
		else
			address = map->unmap_ip(map, sym->start);
327
		break;
328 329 330 331 332
	}
	if (!address) {
		ret = -ENOENT;
		goto out;
	}
W
Wang Nan 已提交
333 334
	pr_debug("Symbol %s address found : %" PRIx64 "\n",
			pp->function, address);
335 336 337 338 339 340 341 342

	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;
343
		result->retprobe = pp->retprobe;
344 345 346 347 348 349 350 351 352 353 354
		ret = 0;
	}

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

}

static int get_alternative_probe_event(struct debuginfo *dinfo,
				       struct perf_probe_event *pev,
355
				       struct perf_probe_point *tmp)
356 357 358 359 360 361
{
	int ret;

	memcpy(tmp, &pev->point, sizeof(*tmp));
	memset(&pev->point, 0, sizeof(pev->point));
	ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
362
					   pev->target, pev->uprobes);
363 364 365 366 367
	if (ret < 0)
		memcpy(&pev->point, tmp, sizeof(*tmp));

	return ret;
}
368

369 370 371 372
static int get_alternative_line_range(struct debuginfo *dinfo,
				      struct line_range *lr,
				      const char *target, bool user)
{
373 374 375 376
	struct perf_probe_point pp = { .function = lr->function,
				       .file = lr->file,
				       .line = lr->start };
	struct perf_probe_point result;
377 378
	int ret, len = 0;

379 380
	memset(&result, 0, sizeof(result));

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
	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;
}

396
/* Open new debuginfo of given module */
397
static struct debuginfo *open_debuginfo(const char *module, bool silent)
398
{
399
	const char *path = module;
400 401 402 403
	char reason[STRERR_BUFSIZE];
	struct debuginfo *ret = NULL;
	struct dso *dso = NULL;
	int err;
404

405
	if (!module || !strchr(module, '/')) {
406 407 408 409 410 411 412
		err = kernel_get_module_dso(module, &dso);
		if (err < 0) {
			if (!dso || dso->load_errno == 0) {
				if (!strerror_r(-err, reason, STRERR_BUFSIZE))
					strcpy(reason, "(unknown)");
			} else
				dso__strerror_load(dso, reason, STRERR_BUFSIZE);
413
			if (!silent)
414 415
				pr_err("Failed to find the path for %s: %s\n",
					module ?: "kernel", reason);
416 417
			return NULL;
		}
418
		path = dso->long_name;
419
	}
420 421 422 423 424 425 426 427 428 429
	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;
430
}
431

432 433 434 435 436 437 438 439 440 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
/* For caching the last debuginfo */
static struct debuginfo *debuginfo_cache;
static char *debuginfo_cache_path;

static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
{
	if ((debuginfo_cache_path && !strcmp(debuginfo_cache_path, module)) ||
	    (!debuginfo_cache_path && !module && debuginfo_cache))
		goto out;

	/* Copy module path */
	free(debuginfo_cache_path);
	if (module) {
		debuginfo_cache_path = strdup(module);
		if (!debuginfo_cache_path) {
			debuginfo__delete(debuginfo_cache);
			debuginfo_cache = NULL;
			goto out;
		}
	}

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

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

467

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
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;
}

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
/*
 * 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");

528 529
	dinfo = debuginfo_cache__open(tp->module, verbose == 0);
	if (dinfo)
530 531
		ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
532
	else
533 534 535 536 537 538 539 540 541 542 543
		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;
}

544 545 546 547
static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
					  int ntevs, const char *exec)
{
	int i, ret = 0;
548
	unsigned long stext = 0;
549 550 551 552 553 554 555 556 557

	if (!exec)
		return 0;

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

	for (i = 0; i < ntevs && ret >= 0; i++) {
558
		/* point.address is the addres of point.symbol + point.offset */
559
		tevs[i].point.address -= stext;
560
		tevs[i].point.module = strdup(exec);
561
		if (!tevs[i].point.module) {
562 563 564 565 566 567 568 569 570
			ret = -ENOMEM;
			break;
		}
		tevs[i].uprobes = true;
	}

	return ret;
}

571 572 573
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	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() */
	}

592 593
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
594 595 596 597
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
598
	}
599

600
	free(tmp);
601
	return ret;
602 603
}

604 605 606 607 608 609 610
/* 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;
611
	int i, skipped = 0;
612 613 614 615 616 617 618 619

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

620
	reloc_sym = kernel_get_ref_reloc_sym();
621 622 623 624 625 626
	if (!reloc_sym) {
		pr_warning("Relocated base symbol is not found!\n");
		return -EINVAL;
	}

	for (i = 0; i < ntevs; i++) {
627 628 629 630 631 632 633 634 635 636 637
		if (!tevs[i].point.address || tevs[i].point.retprobe)
			continue;
		/* If we found a wrong one, mark it by NULL symbol */
		if (kprobe_warn_out_range(tevs[i].point.symbol,
					  tevs[i].point.address)) {
			tmp = NULL;
			skipped++;
		} else {
			tmp = strdup(reloc_sym->name);
			if (!tmp)
				return -ENOMEM;
638
		}
639 640 641 642 643 644 645 646
		/* If we have no realname, use symbol for it */
		if (!tevs[i].point.realname)
			tevs[i].point.realname = tevs[i].point.symbol;
		else
			free(tevs[i].point.symbol);
		tevs[i].point.symbol = tmp;
		tevs[i].point.offset = tevs[i].point.address -
				       reloc_sym->unrelocated_addr;
647
	}
648
	return skipped;
649 650
}

651
/* Try to find perf_probe_event with debuginfo */
652
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
653
					  struct probe_trace_event **tevs)
654 655
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
656
	struct perf_probe_point tmp;
657
	struct debuginfo *dinfo;
658
	int ntevs, ret = 0;
659

660
	dinfo = open_debuginfo(pev->target, !need_dwarf);
661
	if (!dinfo) {
662
		if (need_dwarf)
663 664
			return -ENOENT;
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
665 666 667
		return 0;
	}

668
	pr_debug("Try to find probe point from debuginfo.\n");
669
	/* Searching trace events corresponding to a probe event */
670
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
671

672
	if (ntevs == 0)	{  /* Not found, retry with an alternative */
673
		ret = get_alternative_probe_event(dinfo, pev, &tmp);
674
		if (!ret) {
675
			ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
676 677 678 679 680 681 682 683 684
			/*
			 * 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));
		}
	}

685
	debuginfo__delete(dinfo);
686

687
	if (ntevs > 0) {	/* Succeeded to find trace events */
688 689
		pr_debug("Found %d probe_trace_events.\n", ntevs);
		ret = post_process_probe_trace_events(*tevs, ntevs,
690
						pev->target, pev->uprobes);
691
		if (ret < 0 || ret == ntevs) {
692 693 694
			clear_probe_trace_events(*tevs, ntevs);
			zfree(tevs);
		}
695 696 697 698
		if (ret != ntevs)
			return ret < 0 ? ret : ntevs;
		ntevs = 0;
		/* Fall through */
699
	}
700

701
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
702
		pr_warning("Probe point '%s' not found.\n",
703
			   synthesize_perf_probe_point(&pev->point));
704
		return -ENOENT;
705 706
	}
	/* Error path : ntevs < 0 */
707 708 709 710 711
	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 已提交
712
			pr_debug("Trying to use symbols.\n");
713 714
			return 0;
		}
715
	}
716
	return ntevs;
717 718 719 720 721
}

#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

722
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
723
{
724
	char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
725 726
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
727

728
	do {
729 730
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
731 732 733 734 735
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
736
		}
737 738 739
		color_fprintf(stdout, color, "%s", buf);

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

741
	return 1;
742
error:
743
	if (ferror(fp)) {
744 745
		pr_warning("File read error: %s\n",
			   strerror_r(errno, sbuf, sizeof(sbuf)));
746 747 748 749
		return -1;
	}
	return 0;
}
750

751 752 753 754 755 756 757 758
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;
759 760
}

761 762 763 764 765
#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)

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

	/* Search a line range */
782 783
	dinfo = open_debuginfo(module, false);
	if (!dinfo)
784
		return -ENOENT;
785

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

801 802
	/* Convert source file path */
	tmp = lr->path;
803
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
804 805 806 807 808

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

809
	if (ret < 0) {
810
		pr_warning("Failed to find source file path.\n");
811 812 813
		return ret;
	}

814 815 816
	setup_pager();

	if (lr->function)
817
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
818 819
			lr->start - lr->offset);
	else
820
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
821 822

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

835 836
	intlist__for_each(ln, lr->line_list) {
		for (; ln->i > l; l++) {
837
			ret = show_one_line(fp, l - lr->offset);
838 839 840
			if (ret < 0)
				goto end;
		}
841
		ret = show_one_line_with_num(fp, l++ - lr->offset);
842 843
		if (ret < 0)
			goto end;
844 845 846 847
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
848 849 850
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
851 852
			break;
	}
853
end:
854
	fclose(fp);
855
	return ret;
856 857
}

858
int show_line_range(struct line_range *lr, const char *module, bool user)
859 860 861
{
	int ret;

862
	ret = init_symbol_maps(user);
863 864
	if (ret < 0)
		return ret;
865
	ret = __show_line_range(lr, module, user);
866 867 868 869 870
	exit_symbol_maps();

	return ret;
}

871 872
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
873
				  struct strfilter *_filter)
874 875
{
	char *buf;
876
	int ret, i, nvars;
877 878
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
879
	struct perf_probe_point tmp;
880
	const char *var;
881 882 883 884 885 886

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

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

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

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
939
			struct strfilter *_filter)
940
{
941 942
	int i, ret = 0;
	struct debuginfo *dinfo;
943

944
	ret = init_symbol_maps(pevs->uprobes);
945 946 947
	if (ret < 0)
		return ret;

948
	dinfo = open_debuginfo(pevs->target, false);
949
	if (!dinfo) {
950 951
		ret = -ENOENT;
		goto out;
952 953
	}

954 955
	setup_pager();

956
	for (i = 0; i < npevs && ret >= 0; i++)
957
		ret = show_available_vars_at(dinfo, &pevs[i], _filter);
958 959

	debuginfo__delete(dinfo);
960 961
out:
	exit_symbol_maps();
962 963 964
	return ret;
}

965
#else	/* !HAVE_DWARF_SUPPORT */
966

967 968 969 970
static void debuginfo_cache__exit(void)
{
}

971 972 973 974
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)
975
{
976
	return -ENOSYS;
977 978
}

979
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
980
				struct probe_trace_event **tevs __maybe_unused)
981
{
982 983 984 985
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
986

987 988 989
	return 0;
}

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

998
int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
999 1000
			int npevs __maybe_unused,
			struct strfilter *filter __maybe_unused)
1001 1002 1003 1004
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
1005 1006
#endif

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

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

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

1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
/* Check the name is good for event, group or function */
static bool is_c_func_name(const char *name)
{
	if (!isalpha(*name) && *name != '_')
		return false;
	while (*++name != '\0') {
		if (!isalpha(*name) && !isdigit(*name) && *name != '_')
			return false;
	}
	return true;
}

1052 1053 1054 1055 1056
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1057
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1058
 */
1059
int parse_line_range_desc(const char *arg, struct line_range *lr)
1060
{
1061
	char *range, *file, *name = strdup(arg);
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	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--;
			}
		}
1096

1097
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1098 1099

		err = -EINVAL;
1100
		if (lr->start > lr->end) {
1101
			semantic_error("Start line must be smaller"
1102
				       " than end line.\n");
1103
			goto err;
1104
		}
1105 1106 1107
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
1108
		}
1109
	}
1110

1111 1112 1113 1114 1115 1116 1117 1118 1119
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
1120
	} else if (strchr(name, '/') || strchr(name, '.'))
1121
		lr->file = name;
1122
	else if (is_c_func_name(name))/* We reuse it for checking funcname */
1123
		lr->function = name;
1124 1125 1126 1127 1128
	else {	/* Invalid name */
		semantic_error("'%s' is not a valid function name.\n", name);
		err = -EINVAL;
		goto err;
	}
1129 1130

	return 0;
1131 1132 1133
err:
	free(name);
	return err;
1134 1135
}

1136
/* Parse probepoint definition. */
1137
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1138
{
1139
	struct perf_probe_point *pp = &pev->point;
1140 1141
	char *ptr, *tmp;
	char c, nc = 0;
1142
	bool file_spec = false;
1143 1144
	/*
	 * <Syntax>
1145 1146
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1147 1148
	 *
	 * TODO:Group name support
1149
	 */
1150 1151
	if (!arg)
		return -EINVAL;
1152

1153 1154
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
1155 1156
		*ptr = '\0';
		tmp = ptr + 1;
1157 1158 1159 1160
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
1161
		if (!is_c_func_name(arg)) {
1162
			semantic_error("%s is bad for event name -it must "
1163 1164 1165
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
1166 1167 1168
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
1169
		pev->group = NULL;
1170 1171 1172
		arg = tmp;
	}

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
	/*
	 * Check arg is function or file name and copy it.
	 *
	 * We consider arg to be a file spec if and only if it satisfies
	 * all of the below criteria::
	 * - it does not include any of "+@%",
	 * - it includes one of ":;", and
	 * - it has a period '.' in the name.
	 *
	 * Otherwise, we consider arg to be a function specification.
	 */
	if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
		/* This is a file spec if it includes a '.' before ; or : */
		if (memchr(arg, '.', ptr - arg))
			file_spec = true;
	}

1190
	ptr = strpbrk(arg, ";:+@%");
1191 1192 1193 1194 1195
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

1196 1197 1198 1199
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

1200
	if (file_spec)
1201
		pp->file = tmp;
1202
	else
1203
		pp->function = tmp;
1204 1205 1206 1207 1208

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
1209
		if (c == ';') {	/* Lazy pattern must be the last part */
1210 1211 1212
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
1213 1214 1215
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
1216 1217 1218 1219 1220 1221 1222
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
1223
			if (*tmp != '\0') {
1224
				semantic_error("There is non-digit char"
1225 1226 1227
					       " in line number.\n");
				return -EINVAL;
			}
1228 1229 1230
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
1231
			if (*tmp != '\0') {
1232
				semantic_error("There is non-digit character"
1233 1234 1235
						" in offset.\n");
				return -EINVAL;
			}
1236 1237
			break;
		case '@':	/* File name */
1238 1239 1240 1241
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
1242 1243 1244
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
1245 1246 1247 1248
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
1249 1250 1251 1252
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
1253
			break;
1254 1255 1256 1257
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
1258 1259 1260 1261 1262
			break;
		}
	}

	/* Exclusion check */
1263
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
1264 1265
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
1266 1267
		return -EINVAL;
	}
1268

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

1274
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
1275
		semantic_error("Offset can't be used with line number.\n");
1276 1277
		return -EINVAL;
	}
1278

1279
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1280
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
1281
			       "lazy pattern.\n");
1282 1283
		return -EINVAL;
	}
1284

1285
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
1286
		semantic_error("Offset requires an entry function.\n");
1287 1288
		return -EINVAL;
	}
1289

1290
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
1291
		semantic_error("Return probe requires an entry function.\n");
1292 1293
		return -EINVAL;
	}
1294

1295
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1296
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
1297
			       "return probe.\n");
1298 1299
		return -EINVAL;
	}
1300

1301
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1302 1303
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
1304
	return 0;
1305 1306
}

1307
/* Parse perf-probe event argument */
1308
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1309
{
1310
	char *tmp, *goodname;
1311 1312 1313 1314
	struct perf_probe_arg_field **fieldp;

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

1315 1316
	tmp = strchr(str, '=');
	if (tmp) {
1317 1318 1319
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
1320
		pr_debug("name:%s ", arg->name);
1321 1322 1323
		str = tmp + 1;
	}

1324 1325 1326
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
1327 1328 1329
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
1330 1331 1332
		pr_debug("type:%s ", arg->type);
	}

1333
	tmp = strpbrk(str, "-.[");
1334 1335
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
1336 1337 1338
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
1339
		pr_debug("%s\n", arg->var);
1340
		return 0;
1341 1342
	}

1343
	/* Structure fields or array element */
1344 1345 1346
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
1347
	goodname = arg->var;
1348
	pr_debug("%s, ", arg->var);
1349 1350 1351
	fieldp = &arg->field;

	do {
1352 1353 1354
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
1355 1356 1357
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
1358
			(*fieldp)->ref = true;
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
			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, "-.[");
1380
		}
1381
		if (tmp) {
1382 1383 1384
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
1385 1386
			if (*str != '[')
				goodname = (*fieldp)->name;
1387 1388 1389 1390
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
1391 1392 1393
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
1394 1395
	if (*str != '[')
		goodname = (*fieldp)->name;
1396
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1397

1398
	/* If no name is specified, set the last field name (not array index)*/
1399
	if (!arg->name) {
1400
		arg->name = strdup(goodname);
1401 1402 1403
		if (arg->name == NULL)
			return -ENOMEM;
	}
1404
	return 0;
1405 1406
}

1407
/* Parse perf-probe event command */
1408
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1409
{
1410
	char **argv;
1411
	int argc, i, ret = 0;
1412

1413
	argv = argv_split(cmd, &argc);
1414 1415 1416 1417 1418 1419 1420 1421 1422
	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;
	}
1423
	/* Parse probe point */
1424 1425 1426
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1427

1428
	/* Copy arguments and ensure return probe has no C argument */
1429
	pev->nargs = argc - 1;
1430 1431 1432 1433 1434
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1435 1436 1437 1438
	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) {
1439
			semantic_error("You can't specify local variable for"
1440 1441 1442
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1443
	}
1444
out:
1445
	argv_free(argv);
1446 1447

	return ret;
1448 1449
}

1450 1451 1452 1453 1454 1455 1456 1457 1458
/* 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++)
1459
		if (is_c_varname(pev->args[i].var))
1460 1461 1462 1463 1464
			return true;

	return false;
}

1465
/* Parse probe_events event into struct probe_point */
1466
int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1467
{
1468
	struct probe_trace_point *tp = &tev->point;
1469 1470
	char pr;
	char *p;
1471
	char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1472 1473 1474
	int ret, i, argc;
	char **argv;

1475
	pr_debug("Parsing probe_events: %s\n", cmd);
1476
	argv = argv_split(cmd, &argc);
1477 1478 1479 1480 1481 1482 1483 1484 1485
	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;
	}
1486 1487

	/* Scan event and group name. */
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
	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) {
1498 1499 1500 1501
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1502 1503 1504 1505 1506 1507 1508
	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;
	}
1509
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1510

1511
	tp->retprobe = (pr == 'r');
1512

1513 1514 1515 1516 1517 1518 1519
	/* 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];
1520
	fmt1_str = strtok_r(p, "+", &fmt);
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
	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);
1535
	}
1536

1537
	tev->nargs = argc - 2;
1538
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1539 1540 1541 1542
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1543
	for (i = 0; i < tev->nargs; i++) {
1544 1545
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1546 1547 1548
			*p++ = '\0';
		else
			p = argv[i + 2];
1549
		tev->args[i].name = strdup(argv[i + 2]);
1550
		/* TODO: parse regs and offset */
1551 1552 1553 1554 1555
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1556
	}
1557 1558
	ret = 0;
out:
1559
	free(argv0_str);
1560
	argv_free(argv);
1561
	return ret;
1562 1563
}

1564 1565 1566 1567 1568 1569 1570
/* 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;

1571 1572 1573 1574
	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);
1575 1576 1577 1578 1579 1580
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1581 1582 1583 1584 1585
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1586 1587 1588 1589 1590 1591
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1592 1593 1594 1595 1596 1597 1598 1599 1600

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

1601 1602
	return tmp - buf;
error:
1603
	pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1604
	return ret;
1605 1606
}

1607 1608
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1609
{
1610 1611 1612
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1613

1614 1615 1616 1617 1618
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1619
	if (pp->offset) {
1620
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1621 1622 1623 1624
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1625 1626 1627 1628 1629
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1630 1631 1632 1633 1634 1635 1636
		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);
1637 1638 1639 1640 1641
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1642 1643 1644
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1645
	else
1646
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1647 1648 1649 1650
	if (ret <= 0)
		goto error;

	return buf;
1651
error:
1652
	pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1653
	free(buf);
1654
	return NULL;
1655 1656
}

1657 1658
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1659 1660 1661 1662
{
	char *buf;
	int i, len, ret;

1663 1664 1665
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1666

1667 1668
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1669
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1670 1671 1672 1673 1674
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1675 1676 1677
		len += ret;
	}

1678 1679 1680 1681
	return buf;
}
#endif

1682
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1683 1684 1685 1686 1687
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1688
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
							 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;
1703 1704 1705

}

1706
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1707
				       char *buf, size_t buflen)
1708
{
1709
	struct probe_trace_arg_ref *ref = arg->ref;
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722
	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;

1723 1724 1725 1726
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1727
	/* Dereferencing arguments */
1728
	if (ref) {
1729
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1730 1731 1732 1733 1734 1735
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1736 1737 1738 1739 1740
	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);
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
	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;
	}
1754 1755 1756 1757 1758 1759 1760
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1761 1762 1763 1764

	return buf - tmp;
}

1765
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1766
{
1767
	struct probe_trace_point *tp = &tev->point;
1768 1769 1770
	char *buf;
	int i, len, ret;

1771 1772 1773 1774
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
	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 */
1785
	if (tev->uprobes)
1786 1787
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
				 tp->module, tp->address);
1788
	else
1789
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1790 1791 1792
				 tp->module ?: "", tp->module ? ":" : "",
				 tp->symbol, tp->offset);

1793
	if (ret <= 0)
1794
		goto error;
1795
	len += ret;
1796

1797
	for (i = 0; i < tev->nargs; i++) {
1798
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1799
						  MAX_CMDLEN - len);
1800
		if (ret <= 0)
1801 1802 1803 1804
			goto error;
		len += ret;
	}

1805
	return buf;
1806
error:
1807 1808 1809
	free(buf);
	return NULL;
}
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
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) {
1843
		map__put(map);
1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
	}

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

1883
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1884
			       struct perf_probe_event *pev, bool is_kprobe)
1885
{
1886
	char buf[64] = "";
1887
	int i, ret;
1888

1889
	/* Convert event/group name */
1890 1891 1892 1893
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1894

1895
	/* Convert trace_point to probe_point */
1896
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1897 1898
	if (ret < 0)
		return ret;
1899

1900 1901
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1902 1903 1904
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1905
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1906
		if (tev->args[i].name)
1907
			pev->args[i].name = strdup(tev->args[i].name);
1908
		else {
1909
			ret = synthesize_probe_trace_arg(&tev->args[i],
1910
							  buf, 64);
1911
			pev->args[i].name = strdup(buf);
1912
		}
1913 1914 1915
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1916 1917 1918 1919 1920

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1921 1922 1923 1924
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
1925
	struct perf_probe_arg_field *field, *next;
1926 1927
	int i;

1928 1929
	free(pev->event);
	free(pev->group);
1930
	free(pev->target);
1931
	clear_perf_probe_point(&pev->point);
1932

1933
	for (i = 0; i < pev->nargs; i++) {
1934 1935 1936
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
1937 1938 1939
		field = pev->args[i].field;
		while (field) {
			next = field->next;
1940
			zfree(&field->name);
1941 1942 1943 1944
			free(field);
			field = next;
		}
	}
1945
	free(pev->args);
1946 1947 1948
	memset(pev, 0, sizeof(*pev));
}

1949
void clear_probe_trace_event(struct probe_trace_event *tev)
1950
{
1951
	struct probe_trace_arg_ref *ref, *next;
1952 1953
	int i;

1954 1955 1956
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
1957
	free(tev->point.realname);
1958
	free(tev->point.module);
1959
	for (i = 0; i < tev->nargs; i++) {
1960 1961 1962
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
1963 1964 1965 1966 1967 1968 1969
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
1970
	free(tev->args);
1971
	memset(tev, 0, sizeof(*tev));
1972 1973
}

1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 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
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;
}

2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083
static LIST_HEAD(kprobe_blacklist);

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

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

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

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

2084 2085
static int perf_probe_event__sprintf(const char *group, const char *event,
				     struct perf_probe_event *pev,
2086 2087
				     const char *module,
				     struct strbuf *result)
2088
{
2089
	int i, ret;
2090
	char buf[128];
2091
	char *place;
2092

2093 2094
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
2095 2096
	if (!place)
		return -EINVAL;
2097

2098
	ret = e_snprintf(buf, 128, "%s:%s", group, event);
2099
	if (ret < 0)
2100
		goto out;
2101

2102
	strbuf_addf(result, "  %-20s (on %s", buf, place);
2103
	if (module)
2104
		strbuf_addf(result, " in %s", module);
2105

2106
	if (pev->nargs > 0) {
2107
		strbuf_addstr(result, " with");
2108
		for (i = 0; i < pev->nargs; i++) {
2109 2110 2111
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
2112 2113
				goto out;
			strbuf_addf(result, " %s", buf);
2114
		}
2115
	}
2116 2117
	strbuf_addch(result, ')');
out:
2118
	free(place);
2119
	return ret;
2120 2121
}

2122
/* Show an event */
2123 2124
static int show_perf_probe_event(const char *group, const char *event,
				 struct perf_probe_event *pev,
2125 2126 2127 2128 2129
				 const char *module, bool use_stdout)
{
	struct strbuf buf = STRBUF_INIT;
	int ret;

2130
	ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141
	if (ret >= 0) {
		if (use_stdout)
			printf("%s\n", buf.buf);
		else
			pr_info("%s\n", buf.buf);
	}
	strbuf_release(&buf);

	return ret;
}

2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
static bool filter_probe_trace_event(struct probe_trace_event *tev,
				     struct strfilter *filter)
{
	char tmp[128];

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

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

static int __show_perf_probe_events(int fd, bool is_kprobe,
				    struct strfilter *filter)
2159
{
2160
	int ret = 0;
2161
	struct probe_trace_event tev;
2162
	struct perf_probe_event pev;
2163 2164 2165
	struct strlist *rawlist;
	struct str_node *ent;

2166 2167
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2168

2169
	rawlist = probe_file__get_rawlist(fd);
2170
	if (!rawlist)
2171
		return -ENOMEM;
2172

2173
	strlist__for_each(ent, rawlist) {
2174
		ret = parse_probe_trace_command(ent->s, &tev);
2175
		if (ret >= 0) {
2176 2177
			if (!filter_probe_trace_event(&tev, filter))
				goto next;
2178 2179
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2180 2181
			if (ret < 0)
				goto next;
2182 2183
			ret = show_perf_probe_event(pev.group, pev.event,
						    &pev, tev.point.module,
2184
						    true);
2185
		}
2186
next:
2187
		clear_perf_probe_event(&pev);
2188
		clear_probe_trace_event(&tev);
2189 2190
		if (ret < 0)
			break;
2191 2192
	}
	strlist__delete(rawlist);
2193 2194
	/* Cleanup cached debuginfo if needed */
	debuginfo_cache__exit();
2195 2196

	return ret;
2197 2198
}

2199
/* List up current perf-probe events */
2200
int show_perf_probe_events(struct strfilter *filter)
2201
{
2202
	int kp_fd, up_fd, ret;
2203 2204 2205

	setup_pager();

2206
	ret = init_symbol_maps(false);
2207 2208 2209
	if (ret < 0)
		return ret;

2210 2211 2212
	ret = probe_file__open_both(&kp_fd, &up_fd, 0);
	if (ret < 0)
		return ret;
2213

2214 2215 2216
	if (kp_fd >= 0)
		ret = __show_perf_probe_events(kp_fd, true, filter);
	if (up_fd >= 0 && ret >= 0)
2217
		ret = __show_perf_probe_events(up_fd, false, filter);
2218 2219 2220
	if (kp_fd > 0)
		close(kp_fd);
	if (up_fd > 0)
2221
		close(up_fd);
2222
	exit_symbol_maps();
2223

2224
	return ret;
2225 2226
}

2227 2228
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2229 2230
{
	int i, ret;
2231
	char *p;
2232

2233 2234 2235
	if (*base == '.')
		base++;

2236 2237
	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
2238
	if (ret < 0) {
2239
		pr_debug("snprintf() failed: %d\n", ret);
2240 2241
		return ret;
	}
2242 2243 2244 2245
	/* Cut off the postfixes (e.g. .const, .isra)*/
	p = strchr(buf, '.');
	if (p && p != buf)
		*p = '\0';
2246
	if (!strlist__has_entry(namelist, buf))
2247
		return 0;
2248

2249 2250 2251
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
2252
		return -EEXIST;
2253 2254
	}

2255 2256
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2257
		ret = e_snprintf(buf, len, "%s_%d", base, i);
2258
		if (ret < 0) {
2259
			pr_debug("snprintf() failed: %d\n", ret);
2260 2261
			return ret;
		}
2262 2263 2264
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2265 2266 2267 2268 2269 2270
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
2271 2272
}

2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
/* 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);
}

2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
/* Set new name from original perf_probe_event and namelist */
static int probe_trace_event__set_name(struct probe_trace_event *tev,
				       struct perf_probe_event *pev,
				       struct strlist *namelist,
				       bool allow_suffix)
{
	const char *event, *group;
	char buf[64];
	int ret;

	if (pev->event)
		event = pev->event;
	else
		if (pev->point.function && !strisglob(pev->point.function))
			event = pev->point.function;
		else
			event = tev->point.realname;
	if (pev->group)
		group = pev->group;
	else
		group = PERFPROBE_GROUP;

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

	event = buf;

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

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

2334 2335
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
2336
				     int ntevs, bool allow_suffix)
2337
{
2338
	int i, fd, ret;
2339
	struct probe_trace_event *tev = NULL;
2340
	const char *event = NULL, *group = NULL;
2341
	struct strlist *namelist;
2342

2343 2344
	fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
	if (fd < 0)
2345
		return fd;
2346

2347
	/* Get current event names */
2348
	namelist = probe_file__get_namelist(fd);
2349 2350
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
2351 2352
		ret = -ENOMEM;
		goto close_out;
2353
	}
2354

2355
	ret = 0;
2356
	pr_info("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2357
	for (i = 0; i < ntevs; i++) {
2358
		tev = &tevs[i];
2359
		/* Skip if the symbol is out of .text or blacklisted */
2360 2361
		if (!tev->point.symbol)
			continue;
2362

2363 2364 2365
		/* Set new name for tev (and update namelist) */
		ret = probe_trace_event__set_name(tev, pev, namelist,
						  allow_suffix);
2366 2367
		if (ret < 0)
			break;
2368

2369
		ret = probe_file__add_event(fd, tev);
2370 2371
		if (ret < 0)
			break;
2372

2373 2374 2375 2376 2377 2378
		/* We use tev's name for showing new events */
		show_perf_probe_event(tev->group, tev->event, pev,
				      tev->point.module, false);
		/* Save the last valid name */
		event = tev->event;
		group = tev->group;
2379 2380 2381 2382 2383 2384 2385 2386

		/*
		 * 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;
2387
	}
2388 2389
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2390

2391
	/* Note that it is possible to skip all events because of blacklist */
2392
	if (ret >= 0 && event) {
2393
		/* Show how to use the event. */
2394
		pr_info("\nYou can now use it in all perf tools, such as:\n\n");
2395
		pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
2396
	}
2397

2398
	strlist__delete(namelist);
2399
close_out:
2400
	close(fd);
2401
	return ret;
2402
}
2403

2404 2405
static int find_probe_functions(struct map *map, char *name,
				struct symbol **syms)
2406
{
2407
	int found = 0;
2408
	struct symbol *sym;
2409
	struct rb_node *tmp;
2410

2411 2412 2413
	if (map__load(map, NULL) < 0)
		return 0;

2414
	map__for_each_symbol(map, sym, tmp) {
2415
		if (strglobmatch(sym->name, name)) {
2416
			found++;
2417 2418 2419
			if (syms && found < probe_conf.max_probes)
				syms[found - 1] = sym;
		}
2420
	}
2421 2422

	return found;
2423 2424 2425 2426 2427
}

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

2428 2429 2430 2431
void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
				struct probe_trace_event *tev __maybe_unused,
				struct map *map __maybe_unused) { }

2432 2433 2434 2435 2436
/*
 * 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,
2437
					    struct probe_trace_event **tevs)
2438
{
2439 2440
	struct map *map = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2441
	struct symbol *sym;
2442
	struct symbol **syms = NULL;
2443
	struct probe_trace_event *tev;
2444 2445
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2446
	int num_matched_functions;
2447
	int ret, i, j, skipped = 0;
2448

2449
	map = get_target_map(pev->target, pev->uprobes);
2450 2451 2452
	if (!map) {
		ret = -EINVAL;
		goto out;
2453 2454
	}

2455 2456 2457 2458 2459 2460
	syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
	if (!syms) {
		ret = -ENOMEM;
		goto out;
	}

2461 2462 2463 2464
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2465
	num_matched_functions = find_probe_functions(map, pp->function, syms);
2466
	if (num_matched_functions == 0) {
2467
		pr_err("Failed to find symbol %s in %s\n", pp->function,
2468
			pev->target ? : "kernel");
2469 2470
		ret = -ENOENT;
		goto out;
2471
	} else if (num_matched_functions > probe_conf.max_probes) {
2472
		pr_err("Too many functions matched in %s\n",
2473
			pev->target ? : "kernel");
2474 2475
		ret = -E2BIG;
		goto out;
2476 2477
	}

2478
	if (!pev->uprobes && !pp->retprobe) {
2479
		reloc_sym = kernel_get_ref_reloc_sym();
2480 2481 2482 2483 2484 2485
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2486

2487 2488 2489
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2490
		ret = -ENOMEM;
2491
		goto out;
2492
	}
2493

2494
	ret = 0;
2495

2496 2497 2498
	for (j = 0; j < num_matched_functions; j++) {
		sym = syms[j];

2499 2500 2501 2502 2503
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2504
		}
2505
		ret++;
2506

2507 2508 2509 2510 2511 2512 2513 2514
		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;
2515 2516 2517 2518 2519 2520
		/* If we found a wrong one, mark it by NULL symbol */
		if (!pev->uprobes &&
		    kprobe_warn_out_range(sym->name, tp->address)) {
			tp->symbol = NULL;	/* Skip it */
			skipped++;
		} else if (reloc_sym) {
2521 2522 2523 2524 2525 2526
			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;
		}
2527 2528
		tp->realname = strdup_or_goto(sym->name, nomem_out);

2529
		tp->retprobe = pp->retprobe;
2530 2531 2532
		if (pev->target)
			tev->point.module = strdup_or_goto(pev->target,
							   nomem_out);
2533 2534 2535 2536 2537 2538 2539
		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;
2540
		}
2541
		for (i = 0; i < tev->nargs; i++) {
2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552
			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);
2553
		}
2554
		arch__fix_tev_from_maps(pev, tev, map);
2555
	}
2556 2557 2558 2559
	if (ret == skipped) {
		ret = -ENOENT;
		goto err_out;
	}
2560

2561
out:
2562
	put_target_map(map, pev->uprobes);
2563
	free(syms);
2564
	return ret;
2565

2566 2567 2568 2569 2570 2571 2572
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2573

2574 2575
bool __weak arch__prefers_symtab(void) { return false; }

2576
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2577
					 struct probe_trace_event **tevs)
2578 2579 2580 2581 2582
{
	int ret;

	if (pev->uprobes && !pev->group) {
		/* Replace group name if not given */
2583
		ret = convert_exec_to_group(pev->target, &pev->group);
2584 2585 2586 2587
		if (ret != 0) {
			pr_warning("Failed to make a group name.\n");
			return ret;
		}
2588
	}
2589

2590
	if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2591
		ret = find_probe_trace_events_from_map(pev, tevs);
2592 2593 2594 2595
		if (ret > 0)
			return ret; /* Found in symbol table */
	}

2596
	/* Convert perf_probe_event with debuginfo */
2597
	ret = try_to_find_probe_trace_events(pev, tevs);
2598 2599 2600
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

2601
	return find_probe_trace_events_from_map(pev, tevs);
2602 2603 2604 2605
}

struct __event_package {
	struct perf_probe_event		*pev;
2606
	struct probe_trace_event	*tevs;
2607 2608 2609
	int				ntevs;
};

2610
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2611
{
2612
	int i, j, ret;
2613 2614
	struct __event_package *pkgs;

2615
	ret = 0;
2616
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
2617

2618 2619
	if (pkgs == NULL)
		return -ENOMEM;
2620

2621
	ret = init_symbol_maps(pevs->uprobes);
2622 2623
	if (ret < 0) {
		free(pkgs);
2624
		return ret;
2625
	}
2626 2627 2628 2629

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
2630 2631 2632
		/* Init kprobe blacklist if needed */
		if (!pkgs[i].pev->uprobes)
			kprobe_blacklist__init();
2633
		/* Convert with or without debuginfo */
2634
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
2635
						     &pkgs[i].tevs);
2636 2637 2638
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
2639
	}
2640 2641
	/* This just release blacklist only if allocated */
	kprobe_blacklist__release();
2642

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

	return ret;
2662 2663
}

2664
int del_perf_probe_events(struct strfilter *filter)
2665
{
2666 2667 2668 2669 2670 2671 2672
	int ret, ret2, ufd = -1, kfd = -1;
	char *str = strfilter__string(filter);

	if (!str)
		return -EINVAL;

	pr_debug("Delete filter: \'%s\'\n", str);
2673

2674
	/* Get current event names */
2675 2676 2677
	ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
	if (ret < 0)
		goto out;
2678

2679
	ret = probe_file__del_events(kfd, filter);
2680
	if (ret < 0 && ret != -ENOENT)
2681 2682
		goto error;

2683
	ret2 = probe_file__del_events(ufd, filter);
2684
	if (ret2 < 0 && ret2 != -ENOENT) {
2685
		ret = ret2;
2686 2687 2688
		goto error;
	}
	if (ret == -ENOENT && ret2 == -ENOENT)
2689 2690
		pr_debug("\"%s\" does not hit any event.\n", str);
		/* Note that this is silently ignored */
2691
	ret = 0;
2692 2693

error:
2694
	if (kfd >= 0)
2695
		close(kfd);
2696
	if (ufd >= 0)
2697
		close(ufd);
2698
out:
2699
	free(str);
2700 2701

	return ret;
2702
}
2703

2704 2705
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2706

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

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

2725
	ret = init_symbol_maps(user);
2726 2727 2728
	if (ret < 0)
		return ret;

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

2739
	/* Load symbols with given filter */
2740
	available_func_filter = _filter;
2741 2742 2743 2744 2745 2746
	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);
2747

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

2757
	return ret;
2758 2759
}