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

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

35
#include "util.h"
36
#include "event.h"
37
#include "strlist.h"
38
#include "debug.h"
39
#include "cache.h"
40
#include "color.h"
41 42
#include "symbol.h"
#include "thread.h"
43
#include <api/fs/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
/*
 * 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;
518
	} else if (tp->symbol) {
519 520 521 522 523 524 525 526 527
		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
	pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
708 709 710 711
	if (ntevs < 0) {
		if (ntevs == -EBADF)
			pr_warning("Warning: No dwarf info found in the vmlinux - "
				"please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
712
		if (!need_dwarf) {
M
Masami Hiramatsu 已提交
713
			pr_debug("Trying to use symbols.\n");
714 715
			return 0;
		}
716
	}
717
	return ntevs;
718 719 720 721 722
}

#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

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

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

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

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

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

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

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

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

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

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

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

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

815 816 817
	setup_pager();

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

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

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

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

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

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

	return ret;
}

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

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

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

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

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

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

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

955 956
	setup_pager();

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

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

966
#else	/* !HAVE_DWARF_SUPPORT */
967

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

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

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

988 989 990
	return 0;
}

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

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

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

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

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

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
/* 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;
}

1053 1054 1055 1056 1057
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
1058
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
1059
 */
1060
int parse_line_range_desc(const char *arg, struct line_range *lr)
1061
{
1062
	char *range, *file, *name = strdup(arg);
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 1096
	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--;
			}
		}
1097

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

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

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

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

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

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

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
	/*
	 * 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;
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 - 1 > MAX_PROBE_ARGS) {
		semantic_error("Too many probe arguments (%d).\n", argc - 1);
		ret = -ERANGE;
		goto out;
	}
1424
	/* Parse probe point */
1425 1426 1427
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1428

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

	return ret;
1449 1450
}

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

	return false;
}

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

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

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

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

1514 1515 1516 1517 1518 1519 1520
	/* 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];
1521
	fmt1_str = strtok_r(p, "+", &fmt);
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
	/* only the address started with 0x */
	if (fmt1_str[0] == '0')	{
		/*
		 * Fix a special case:
		 * if address == 0, kernel reports something like:
		 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x          (null) arg1=%ax
		 * Newer kernel may fix that, but we want to
		 * support old kernel also.
		 */
		if (strcmp(fmt1_str, "0x") == 0) {
			if (!argv[2] || strcmp(argv[2], "(null)")) {
				ret = -EINVAL;
				goto out;
			}
			tp->address = 0;

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

			argv[i] = NULL;
			argc -= 1;
		} else
			tp->address = strtoul(fmt1_str, NULL, 0);
	} else {
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
		/* 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);
1558
	}
1559

1560
	tev->nargs = argc - 2;
1561
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1562 1563 1564 1565
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1566
	for (i = 0; i < tev->nargs; i++) {
1567 1568
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1569 1570 1571
			*p++ = '\0';
		else
			p = argv[i + 2];
1572
		tev->args[i].name = strdup(argv[i + 2]);
1573
		/* TODO: parse regs and offset */
1574 1575 1576 1577 1578
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1579
	}
1580 1581
	ret = 0;
out:
1582
	free(argv0_str);
1583
	argv_free(argv);
1584
	return ret;
1585 1586
}

1587 1588 1589 1590 1591 1592 1593
/* 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;

1594 1595 1596 1597
	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);
1598 1599 1600 1601 1602 1603
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1604 1605 1606 1607 1608
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1609 1610 1611 1612 1613 1614
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1615 1616 1617 1618 1619 1620 1621 1622 1623

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

1624 1625
	return tmp - buf;
error:
1626
	pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1627
	return ret;
1628 1629
}

1630 1631
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1632
{
1633 1634 1635
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1636

1637 1638 1639 1640 1641
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1642
	if (pp->offset) {
1643
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1644 1645 1646 1647
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1648 1649 1650 1651 1652
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1653 1654 1655 1656 1657 1658 1659
		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);
1660 1661 1662 1663 1664
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1665 1666 1667
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1668
	else
1669
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1670 1671 1672 1673
	if (ret <= 0)
		goto error;

	return buf;
1674
error:
1675
	pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1676
	free(buf);
1677
	return NULL;
1678 1679
}

1680 1681
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1682 1683 1684 1685
{
	char *buf;
	int i, len, ret;

1686 1687 1688
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1689

1690 1691
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1692
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1693 1694 1695 1696 1697
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1698 1699 1700
		len += ret;
	}

1701 1702 1703 1704
	return buf;
}
#endif

1705
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1706 1707 1708 1709 1710
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1711
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
							 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;
1726 1727 1728

}

1729
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1730
				       char *buf, size_t buflen)
1731
{
1732
	struct probe_trace_arg_ref *ref = arg->ref;
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
	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;

1746 1747 1748 1749
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1750
	/* Dereferencing arguments */
1751
	if (ref) {
1752
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1753 1754 1755 1756 1757 1758
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1759 1760 1761 1762 1763
	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);
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
	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;
	}
1777 1778 1779 1780 1781 1782 1783
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1784 1785 1786 1787

	return buf - tmp;
}

1788
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1789
{
1790
	struct probe_trace_point *tp = &tev->point;
1791 1792 1793
	char *buf;
	int i, len, ret;

1794 1795 1796 1797
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
	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 */
1808
	if (tev->uprobes)
1809 1810
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
				 tp->module, tp->address);
1811
	else
1812
		ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1813 1814 1815
				 tp->module ?: "", tp->module ? ":" : "",
				 tp->symbol, tp->offset);

1816
	if (ret <= 0)
1817
		goto error;
1818
	len += ret;
1819

1820
	for (i = 0; i < tev->nargs; i++) {
1821
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1822
						  MAX_CMDLEN - len);
1823
		if (ret <= 0)
1824 1825 1826 1827
			goto error;
		len += ret;
	}

1828
	return buf;
1829
error:
1830 1831 1832
	free(buf);
	return NULL;
}
1833

1834 1835 1836 1837 1838 1839
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;
1840
	u64 addr = tp->address;
1841 1842 1843 1844 1845 1846 1847 1848
	int ret = -ENOENT;

	if (!is_kprobe) {
		map = dso__new_map(tp->module);
		if (!map)
			goto out;
		sym = map__find_symbol(map, addr, NULL);
	} else {
1849 1850
		if (tp->symbol)
			addr = kernel_get_symbol_address_by_name(tp->symbol, true);
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865
		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) {
1866
		map__put(map);
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
	}

	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;
1891
	} else {
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
		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;
}

1906
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1907
			       struct perf_probe_event *pev, bool is_kprobe)
1908
{
1909
	char buf[64] = "";
1910
	int i, ret;
1911

1912
	/* Convert event/group name */
1913 1914 1915 1916
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1917

1918
	/* Convert trace_point to probe_point */
1919
	ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1920 1921
	if (ret < 0)
		return ret;
1922

1923 1924
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1925 1926 1927
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1928
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1929
		if (tev->args[i].name)
1930
			pev->args[i].name = strdup(tev->args[i].name);
1931
		else {
1932
			ret = synthesize_probe_trace_arg(&tev->args[i],
1933
							  buf, 64);
1934
			pev->args[i].name = strdup(buf);
1935
		}
1936 1937 1938
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1939 1940 1941 1942 1943

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1944 1945 1946 1947
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
1948
	struct perf_probe_arg_field *field, *next;
1949 1950
	int i;

1951 1952
	free(pev->event);
	free(pev->group);
1953
	free(pev->target);
1954
	clear_perf_probe_point(&pev->point);
1955

1956
	for (i = 0; i < pev->nargs; i++) {
1957 1958 1959
		free(pev->args[i].name);
		free(pev->args[i].var);
		free(pev->args[i].type);
1960 1961 1962
		field = pev->args[i].field;
		while (field) {
			next = field->next;
1963
			zfree(&field->name);
1964 1965 1966 1967
			free(field);
			field = next;
		}
	}
1968
	free(pev->args);
1969 1970 1971
	memset(pev, 0, sizeof(*pev));
}

1972
void clear_probe_trace_event(struct probe_trace_event *tev)
1973
{
1974
	struct probe_trace_arg_ref *ref, *next;
1975 1976
	int i;

1977 1978 1979
	free(tev->event);
	free(tev->group);
	free(tev->point.symbol);
1980
	free(tev->point.realname);
1981
	free(tev->point.module);
1982
	for (i = 0; i < tev->nargs; i++) {
1983 1984 1985
		free(tev->args[i].name);
		free(tev->args[i].value);
		free(tev->args[i].type);
1986 1987 1988 1989 1990 1991 1992
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
1993
	free(tev->args);
1994
	memset(tev, 0, sizeof(*tev));
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 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
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;
}

2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
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);
}

2107 2108
static int perf_probe_event__sprintf(const char *group, const char *event,
				     struct perf_probe_event *pev,
2109 2110
				     const char *module,
				     struct strbuf *result)
2111
{
2112
	int i, ret;
2113
	char buf[128];
2114
	char *place;
2115

2116 2117
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
2118 2119
	if (!place)
		return -EINVAL;
2120

2121
	ret = e_snprintf(buf, 128, "%s:%s", group, event);
2122
	if (ret < 0)
2123
		goto out;
2124

2125
	strbuf_addf(result, "  %-20s (on %s", buf, place);
2126
	if (module)
2127
		strbuf_addf(result, " in %s", module);
2128

2129
	if (pev->nargs > 0) {
2130
		strbuf_addstr(result, " with");
2131
		for (i = 0; i < pev->nargs; i++) {
2132 2133 2134
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
2135 2136
				goto out;
			strbuf_addf(result, " %s", buf);
2137
		}
2138
	}
2139 2140
	strbuf_addch(result, ')');
out:
2141
	free(place);
2142
	return ret;
2143 2144
}

2145
/* Show an event */
2146 2147
static int show_perf_probe_event(const char *group, const char *event,
				 struct perf_probe_event *pev,
2148 2149 2150 2151 2152
				 const char *module, bool use_stdout)
{
	struct strbuf buf = STRBUF_INIT;
	int ret;

2153
	ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
	if (ret >= 0) {
		if (use_stdout)
			printf("%s\n", buf.buf);
		else
			pr_info("%s\n", buf.buf);
	}
	strbuf_release(&buf);

	return ret;
}

2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
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)
2182
{
2183
	int ret = 0;
2184
	struct probe_trace_event tev;
2185
	struct perf_probe_event pev;
2186 2187 2188
	struct strlist *rawlist;
	struct str_node *ent;

2189 2190
	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
2191

2192
	rawlist = probe_file__get_rawlist(fd);
2193
	if (!rawlist)
2194
		return -ENOMEM;
2195

2196
	strlist__for_each(ent, rawlist) {
2197
		ret = parse_probe_trace_command(ent->s, &tev);
2198
		if (ret >= 0) {
2199 2200
			if (!filter_probe_trace_event(&tev, filter))
				goto next;
2201 2202
			ret = convert_to_perf_probe_event(&tev, &pev,
								is_kprobe);
2203 2204
			if (ret < 0)
				goto next;
2205 2206
			ret = show_perf_probe_event(pev.group, pev.event,
						    &pev, tev.point.module,
2207
						    true);
2208
		}
2209
next:
2210
		clear_perf_probe_event(&pev);
2211
		clear_probe_trace_event(&tev);
2212 2213
		if (ret < 0)
			break;
2214 2215
	}
	strlist__delete(rawlist);
2216 2217
	/* Cleanup cached debuginfo if needed */
	debuginfo_cache__exit();
2218 2219

	return ret;
2220 2221
}

2222
/* List up current perf-probe events */
2223
int show_perf_probe_events(struct strfilter *filter)
2224
{
2225
	int kp_fd, up_fd, ret;
2226 2227 2228

	setup_pager();

2229
	ret = init_symbol_maps(false);
2230 2231 2232
	if (ret < 0)
		return ret;

2233 2234 2235
	ret = probe_file__open_both(&kp_fd, &up_fd, 0);
	if (ret < 0)
		return ret;
2236

2237 2238 2239
	if (kp_fd >= 0)
		ret = __show_perf_probe_events(kp_fd, true, filter);
	if (up_fd >= 0 && ret >= 0)
2240
		ret = __show_perf_probe_events(up_fd, false, filter);
2241 2242 2243
	if (kp_fd > 0)
		close(kp_fd);
	if (up_fd > 0)
2244
		close(up_fd);
2245
	exit_symbol_maps();
2246

2247
	return ret;
2248 2249
}

2250 2251
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
2252 2253
{
	int i, ret;
2254
	char *p;
2255

2256 2257 2258
	if (*base == '.')
		base++;

2259 2260
	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
2261
	if (ret < 0) {
2262
		pr_debug("snprintf() failed: %d\n", ret);
2263 2264
		return ret;
	}
2265 2266 2267 2268
	/* Cut off the postfixes (e.g. .const, .isra)*/
	p = strchr(buf, '.');
	if (p && p != buf)
		*p = '\0';
2269
	if (!strlist__has_entry(namelist, buf))
2270
		return 0;
2271

2272 2273 2274
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
2275
		return -EEXIST;
2276 2277
	}

2278 2279
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
2280
		ret = e_snprintf(buf, len, "%s_%d", base, i);
2281
		if (ret < 0) {
2282
			pr_debug("snprintf() failed: %d\n", ret);
2283 2284
			return ret;
		}
2285 2286 2287
		if (!strlist__has_entry(namelist, buf))
			break;
	}
2288 2289 2290 2291 2292 2293
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
2294 2295
}

2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316
/* 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);
}

2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
/* 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;
}

2357 2358
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
2359
				     int ntevs, bool allow_suffix)
2360
{
2361
	int i, fd, ret;
2362
	struct probe_trace_event *tev = NULL;
2363
	const char *event = NULL, *group = NULL;
2364
	struct strlist *namelist;
2365

2366 2367
	fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
	if (fd < 0)
2368
		return fd;
2369

2370
	/* Get current event names */
2371
	namelist = probe_file__get_namelist(fd);
2372 2373
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
2374 2375
		ret = -ENOMEM;
		goto close_out;
2376
	}
2377

2378
	ret = 0;
2379
	pr_info("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
2380
	for (i = 0; i < ntevs; i++) {
2381
		tev = &tevs[i];
2382
		/* Skip if the symbol is out of .text or blacklisted */
2383 2384
		if (!tev->point.symbol)
			continue;
2385

2386 2387 2388
		/* Set new name for tev (and update namelist) */
		ret = probe_trace_event__set_name(tev, pev, namelist,
						  allow_suffix);
2389 2390
		if (ret < 0)
			break;
2391

2392
		ret = probe_file__add_event(fd, tev);
2393 2394
		if (ret < 0)
			break;
2395

2396 2397 2398 2399 2400 2401
		/* 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;
2402 2403 2404 2405 2406 2407 2408 2409

		/*
		 * 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;
2410
	}
2411 2412
	if (ret == -EINVAL && pev->uprobes)
		warn_uprobe_event_compat(tev);
2413

2414
	/* Note that it is possible to skip all events because of blacklist */
2415
	if (ret >= 0 && event) {
2416
		/* Show how to use the event. */
2417
		pr_info("\nYou can now use it in all perf tools, such as:\n\n");
2418
		pr_info("\tperf record -e %s:%s -aR sleep 1\n\n", group, event);
2419
	}
2420

2421
	strlist__delete(namelist);
2422
close_out:
2423
	close(fd);
2424
	return ret;
2425
}
2426

2427 2428
static int find_probe_functions(struct map *map, char *name,
				struct symbol **syms)
2429
{
2430
	int found = 0;
2431
	struct symbol *sym;
2432
	struct rb_node *tmp;
2433

2434 2435 2436
	if (map__load(map, NULL) < 0)
		return 0;

2437
	map__for_each_symbol(map, sym, tmp) {
2438
		if (strglobmatch(sym->name, name)) {
2439
			found++;
2440 2441 2442
			if (syms && found < probe_conf.max_probes)
				syms[found - 1] = sym;
		}
2443
	}
2444 2445

	return found;
2446 2447 2448 2449 2450
}

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

2451 2452 2453 2454
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) { }

2455 2456 2457 2458 2459
/*
 * 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,
2460
					    struct probe_trace_event **tevs)
2461
{
2462 2463
	struct map *map = NULL;
	struct ref_reloc_sym *reloc_sym = NULL;
2464
	struct symbol *sym;
2465
	struct symbol **syms = NULL;
2466
	struct probe_trace_event *tev;
2467 2468
	struct perf_probe_point *pp = &pev->point;
	struct probe_trace_point *tp;
2469
	int num_matched_functions;
2470
	int ret, i, j, skipped = 0;
2471

2472
	map = get_target_map(pev->target, pev->uprobes);
2473 2474 2475
	if (!map) {
		ret = -EINVAL;
		goto out;
2476 2477
	}

2478 2479 2480 2481 2482 2483
	syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
	if (!syms) {
		ret = -ENOMEM;
		goto out;
	}

2484 2485 2486 2487
	/*
	 * Load matched symbols: Since the different local symbols may have
	 * same name but different addresses, this lists all the symbols.
	 */
2488
	num_matched_functions = find_probe_functions(map, pp->function, syms);
2489
	if (num_matched_functions == 0) {
2490
		pr_err("Failed to find symbol %s in %s\n", pp->function,
2491
			pev->target ? : "kernel");
2492 2493
		ret = -ENOENT;
		goto out;
2494
	} else if (num_matched_functions > probe_conf.max_probes) {
2495
		pr_err("Too many functions matched in %s\n",
2496
			pev->target ? : "kernel");
2497 2498
		ret = -E2BIG;
		goto out;
2499 2500
	}

2501
	if (!pev->uprobes && !pp->retprobe) {
2502
		reloc_sym = kernel_get_ref_reloc_sym();
2503 2504 2505 2506 2507 2508
		if (!reloc_sym) {
			pr_warning("Relocated base symbol is not found!\n");
			ret = -EINVAL;
			goto out;
		}
	}
2509

2510 2511 2512
	/* Setup result trace-probe-events */
	*tevs = zalloc(sizeof(*tev) * num_matched_functions);
	if (!*tevs) {
2513
		ret = -ENOMEM;
2514
		goto out;
2515
	}
2516

2517
	ret = 0;
2518

2519 2520 2521
	for (j = 0; j < num_matched_functions; j++) {
		sym = syms[j];

2522 2523 2524 2525 2526
		tev = (*tevs) + ret;
		tp = &tev->point;
		if (ret == num_matched_functions) {
			pr_warning("Too many symbols are listed. Skip it.\n");
			break;
2527
		}
2528
		ret++;
2529

2530 2531 2532 2533 2534 2535 2536 2537
		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;
2538 2539 2540 2541 2542 2543
		/* 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) {
2544 2545 2546 2547 2548 2549
			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;
		}
2550 2551
		tp->realname = strdup_or_goto(sym->name, nomem_out);

2552
		tp->retprobe = pp->retprobe;
2553 2554 2555
		if (pev->target)
			tev->point.module = strdup_or_goto(pev->target,
							   nomem_out);
2556 2557 2558 2559 2560 2561 2562
		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;
2563
		}
2564
		for (i = 0; i < tev->nargs; i++) {
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575
			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);
2576
		}
2577
		arch__fix_tev_from_maps(pev, tev, map);
2578
	}
2579 2580 2581 2582
	if (ret == skipped) {
		ret = -ENOENT;
		goto err_out;
	}
2583

2584
out:
2585
	put_target_map(map, pev->uprobes);
2586
	free(syms);
2587
	return ret;
2588

2589 2590 2591 2592 2593 2594 2595
nomem_out:
	ret = -ENOMEM;
err_out:
	clear_probe_trace_events(*tevs, num_matched_functions);
	zfree(tevs);
	goto out;
}
2596

2597 2598
bool __weak arch__prefers_symtab(void) { return false; }

2599
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2600
					 struct probe_trace_event **tevs)
2601 2602 2603 2604 2605
{
	int ret;

	if (pev->uprobes && !pev->group) {
		/* Replace group name if not given */
2606
		ret = convert_exec_to_group(pev->target, &pev->group);
2607 2608 2609 2610
		if (ret != 0) {
			pr_warning("Failed to make a group name.\n");
			return ret;
		}
2611
	}
2612

2613
	if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2614
		ret = find_probe_trace_events_from_map(pev, tevs);
2615 2616 2617 2618
		if (ret > 0)
			return ret; /* Found in symbol table */
	}

2619
	/* Convert perf_probe_event with debuginfo */
2620
	ret = try_to_find_probe_trace_events(pev, tevs);
2621 2622 2623
	if (ret != 0)
		return ret;	/* Found in debuginfo or got an error */

2624
	return find_probe_trace_events_from_map(pev, tevs);
2625 2626 2627 2628
}

struct __event_package {
	struct perf_probe_event		*pev;
2629
	struct probe_trace_event	*tevs;
2630 2631 2632
	int				ntevs;
};

2633
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2634
{
2635
	int i, j, ret;
2636 2637
	struct __event_package *pkgs;

2638
	ret = 0;
2639
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
2640

2641 2642
	if (pkgs == NULL)
		return -ENOMEM;
2643

2644
	ret = init_symbol_maps(pevs->uprobes);
2645 2646
	if (ret < 0) {
		free(pkgs);
2647
		return ret;
2648
	}
2649 2650 2651 2652

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
2653 2654 2655
		/* Init kprobe blacklist if needed */
		if (!pkgs[i].pev->uprobes)
			kprobe_blacklist__init();
2656
		/* Convert with or without debuginfo */
2657
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
2658
						     &pkgs[i].tevs);
2659 2660 2661
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
2662
	}
2663 2664
	/* This just release blacklist only if allocated */
	kprobe_blacklist__release();
2665

2666
	/* Loop 2: add all events */
2667
	for (i = 0; i < npevs; i++) {
2668
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2669 2670
					       pkgs[i].ntevs,
					       probe_conf.force_add);
2671 2672 2673
		if (ret < 0)
			break;
	}
2674
end:
2675 2676
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
2677
		for (j = 0; j < pkgs[i].ntevs; j++)
2678
			clear_probe_trace_event(&pkgs[i].tevs[j]);
2679
		zfree(&pkgs[i].tevs);
2680 2681
	}
	free(pkgs);
2682
	exit_symbol_maps();
2683 2684

	return ret;
2685 2686
}

2687
int del_perf_probe_events(struct strfilter *filter)
2688
{
2689 2690 2691 2692 2693 2694 2695
	int ret, ret2, ufd = -1, kfd = -1;
	char *str = strfilter__string(filter);

	if (!str)
		return -EINVAL;

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

2697
	/* Get current event names */
2698 2699 2700
	ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
	if (ret < 0)
		goto out;
2701

2702
	ret = probe_file__del_events(kfd, filter);
2703
	if (ret < 0 && ret != -ENOENT)
2704 2705
		goto error;

2706
	ret2 = probe_file__del_events(ufd, filter);
2707
	if (ret2 < 0 && ret2 != -ENOENT) {
2708
		ret = ret2;
2709 2710 2711
		goto error;
	}
	if (ret == -ENOENT && ret2 == -ENOENT)
2712 2713
		pr_debug("\"%s\" does not hit any event.\n", str);
		/* Note that this is silently ignored */
2714
	ret = 0;
2715 2716

error:
2717
	if (kfd >= 0)
2718
		close(kfd);
2719
	if (ufd >= 0)
2720
		close(ufd);
2721
out:
2722
	free(str);
2723 2724

	return ret;
2725
}
2726

2727 2728
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2729

2730
/*
2731 2732
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2733
 */
2734
static int filter_available_functions(struct map *map __maybe_unused,
2735
				      struct symbol *sym)
2736
{
2737
	if (strfilter__compare(available_func_filter, sym->name))
2738 2739
		return 0;
	return 1;
2740 2741
}

2742 2743
int show_available_funcs(const char *target, struct strfilter *_filter,
					bool user)
2744 2745 2746 2747
{
	struct map *map;
	int ret;

2748
	ret = init_symbol_maps(user);
2749 2750 2751
	if (ret < 0)
		return ret;

2752 2753 2754 2755 2756
	/* Get a symbol map */
	if (user)
		map = dso__new_map(target);
	else
		map = kernel_get_module_map(target);
2757
	if (!map) {
2758
		pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2759 2760
		return -EINVAL;
	}
2761

2762
	/* Load symbols with given filter */
2763
	available_func_filter = _filter;
2764 2765 2766 2767 2768 2769
	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);
2770

2771 2772 2773 2774 2775
	/* Show all (filtered) symbols */
	setup_pager();
	dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
end:
	if (user) {
2776
		map__put(map);
2777 2778
	}
	exit_symbol_maps();
2779

2780
	return ret;
2781 2782
}