probe-event.c 45.2 KB
Newer Older
1
/*
2
 * probe-event.c : perf-probe definition to probe_events format converter
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * 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.
 *
 */

#define _GNU_SOURCE
#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>
32 33
#include <stdarg.h>
#include <limits.h>
34
#include <elf.h>
35 36

#undef _GNU_SOURCE
37
#include "util.h"
38
#include "event.h"
39
#include "string.h"
40
#include "strlist.h"
41
#include "debug.h"
42
#include "cache.h"
43
#include "color.h"
44 45
#include "symbol.h"
#include "thread.h"
46
#include "debugfs.h"
47
#include "trace-event.h"	/* For __unused */
48
#include "probe-event.h"
49
#include "probe-finder.h"
50 51 52 53 54

#define MAX_CMDLEN 256
#define MAX_PROBE_ARGS 128
#define PERFPROBE_GROUP "probe"

55 56
bool probe_event_dry_run;	/* Dry run flag */

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

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

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

75
static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
76
static struct machine machine;
77

78
/* Initialize symbol maps and path of vmlinux/modules */
79
static int init_vmlinux(void)
80
{
81 82
	int ret;

83 84 85 86 87
	symbol_conf.sort_by_name = true;
	if (symbol_conf.vmlinux_name == NULL)
		symbol_conf.try_vmlinux_path = true;
	else
		pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
88 89 90 91 92
	ret = symbol__init();
	if (ret < 0) {
		pr_debug("Failed to init symbol map.\n");
		goto out;
	}
93

94
	ret = machine__init(&machine, "", HOST_KERNEL_ID);
95 96 97
	if (ret < 0)
		goto out;

98
	if (machine__create_kernel_maps(&machine) < 0) {
M
Masami Hiramatsu 已提交
99
		pr_debug("machine__create_kernel_maps() failed.\n");
100 101
		goto out;
	}
102 103 104 105
out:
	if (ret < 0)
		pr_warning("Failed to init vmlinux path.\n");
	return ret;
106 107
}

108 109 110 111 112 113 114
static struct symbol *__find_kernel_function_by_name(const char *name,
						     struct map **mapp)
{
	return machine__find_kernel_function_by_name(&machine, name, mapp,
						     NULL);
}

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
static struct map *kernel_get_module_map(const char *module)
{
	struct rb_node *nd;
	struct map_groups *grp = &machine.kmaps;

	if (!module)
		module = "kernel";

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

static struct dso *kernel_get_module_dso(const char *module)
134 135
{
	struct dso *dso;
136 137
	struct map *map;
	const char *vmlinux_name;
138 139 140 141 142 143 144 145 146

	if (module) {
		list_for_each_entry(dso, &machine.kernel_dsos, node) {
			if (strncmp(dso->short_name + 1, module,
				    dso->short_name_len - 2) == 0)
				goto found;
		}
		pr_debug("Failed to find module %s.\n", module);
		return NULL;
147 148 149 150 151 152 153 154 155
	}

	map = machine.vmlinux_maps[MAP__FUNCTION];
	dso = map->dso;

	vmlinux_name = symbol_conf.vmlinux_name;
	if (vmlinux_name) {
		if (dso__load_vmlinux(dso, map, vmlinux_name, NULL) <= 0)
			return NULL;
156
	} else {
157
		if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
158 159 160 161 162
			pr_debug("Failed to load kernel map.\n");
			return NULL;
		}
	}
found:
163 164 165 166 167 168 169
	return dso;
}

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

172
#ifdef DWARF_SUPPORT
173 174
/* Open new debuginfo of given module */
static struct debuginfo *open_debuginfo(const char *module)
175
{
176
	const char *path = kernel_get_module_path(module);
177

178
	if (!path) {
M
Masami Hiramatsu 已提交
179 180
		pr_err("Failed to find path of %s module.\n",
		       module ?: "kernel");
181
		return NULL;
182
	}
183
	return debuginfo__new(path);
184
}
185

186 187 188 189 190
/*
 * Convert trace point to probe point with debuginfo
 * Currently only handles kprobes.
 */
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
191
					struct perf_probe_point *pp)
192 193
{
	struct symbol *sym;
194 195 196
	struct map *map;
	u64 addr;
	int ret = -ENOENT;
197
	struct debuginfo *dinfo;
198

199
	sym = __find_kernel_function_by_name(tp->symbol, &map);
200
	if (sym) {
201
		addr = map->unmap_ip(map, sym->start + tp->offset);
202
		pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
203
			 tp->offset, addr);
204 205 206 207 208 209 210 211 212 213 214

		dinfo = debuginfo__new_online_kernel(addr);
		if (dinfo) {
			ret = debuginfo__find_probe_point(dinfo,
						 (unsigned long)addr, pp);
			debuginfo__delete(dinfo);
		} else {
			pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n",
				 addr);
			ret = -ENOENT;
		}
215 216
	}
	if (ret <= 0) {
217 218
		pr_debug("Failed to find corresponding probes from "
			 "debuginfo. Use kprobe event information.\n");
219 220 221
		pp->function = strdup(tp->symbol);
		if (pp->function == NULL)
			return -ENOMEM;
222 223 224
		pp->offset = tp->offset;
	}
	pp->retprobe = tp->retprobe;
225 226

	return 0;
227 228
}

229 230 231 232 233 234 235 236 237 238 239 240
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
	int i;
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
		if (!tevs[i].point.module)
			return -ENOMEM;
	}
	return 0;
}

241
/* Try to find perf_probe_event with debuginfo */
242
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
243 244
					  struct probe_trace_event **tevs,
					  int max_tevs, const char *module)
245 246
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
247
	struct debuginfo *dinfo = open_debuginfo(module);
248
	int ntevs, ret = 0;
249

250
	if (!dinfo) {
251 252
		if (need_dwarf) {
			pr_warning("Failed to open debuginfo file.\n");
253
			return -ENOENT;
254
		}
255
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
256 257 258
		return 0;
	}

259 260 261 262
	/* Searching trace events corresponding to a probe event */
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);

	debuginfo__delete(dinfo);
263

264
	if (ntevs > 0) {	/* Succeeded to find trace events */
265
		pr_debug("find %d probe_trace_events.\n", ntevs);
266 267 268 269
		if (module)
			ret = add_module_to_probe_trace_events(*tevs, ntevs,
							       module);
		return ret < 0 ? ret : ntevs;
270
	}
271

272 273 274 275 276 277
	if (ntevs == 0)	{	/* No error but failed to find probe point. */
		pr_warning("Probe point '%s' not found.\n",
			   synthesize_perf_probe_point(&pev->point));
		return -ENOENT;
	}
	/* Error path : ntevs < 0 */
278 279 280 281 282
	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 已提交
283
			pr_debug("Trying to use symbols.\n");
284 285
			return 0;
		}
286
	}
287
	return ntevs;
288 289
}

290 291 292 293 294 295
/*
 * Find a src file from a DWARF tag path. Prepend optional source path prefix
 * and chop off leading directories that do not exist. Result is passed back as
 * a newly allocated path on success.
 * Return 0 if file was found and readable, -errno otherwise.
 */
296 297
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
298
{
299 300 301 302 303 304 305 306 307 308 309 310 311
	const char *prefix = symbol_conf.source_prefix;

	if (!prefix) {
		if (raw_path[0] != '/' && comp_dir)
			/* If not an absolute path, try to use comp_dir */
			prefix = comp_dir;
		else {
			if (access(raw_path, R_OK) == 0) {
				*new_path = strdup(raw_path);
				return 0;
			} else
				return -errno;
		}
312 313
	}

314
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
315 316 317 318
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
319
		sprintf(*new_path, "%s/%s", prefix, raw_path);
320 321 322 323

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

324 325 326 327
		if (!symbol_conf.source_prefix)
			/* In case of searching comp_dir, don't retry */
			return -errno;

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
		switch (errno) {
		case ENAMETOOLONG:
		case ENOENT:
		case EROFS:
		case EFAULT:
			raw_path = strchr(++raw_path, '/');
			if (!raw_path) {
				free(*new_path);
				*new_path = NULL;
				return -ENOENT;
			}
			continue;

		default:
			free(*new_path);
			*new_path = NULL;
			return -errno;
		}
	}
}

349 350 351
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

352
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
353 354
{
	char buf[LINEBUF_SIZE];
355 356
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
357

358
	do {
359 360
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
361 362 363 364 365
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
366
		}
367 368 369
		color_fprintf(stdout, color, "%s", buf);

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

371
	return 1;
372
error:
373
	if (ferror(fp)) {
374
		pr_warning("File read error: %s\n", strerror(errno));
375 376 377 378
		return -1;
	}
	return 0;
}
379

380 381 382 383 384 385 386 387
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;
388 389
}

390 391 392 393 394
#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)

395 396 397 398
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
399
int show_line_range(struct line_range *lr, const char *module)
400
{
401
	int l = 1;
402
	struct line_node *ln;
403
	struct debuginfo *dinfo;
404
	FILE *fp;
405
	int ret;
406
	char *tmp;
407 408

	/* Search a line range */
409 410 411 412
	ret = init_vmlinux();
	if (ret < 0)
		return ret;

413 414
	dinfo = open_debuginfo(module);
	if (!dinfo) {
415
		pr_warning("Failed to open debuginfo file.\n");
416
		return -ENOENT;
417 418
	}

419 420
	ret = debuginfo__find_line_range(dinfo, lr);
	debuginfo__delete(dinfo);
421 422 423 424 425 426 427
	if (ret == 0) {
		pr_warning("Specified source line is not found.\n");
		return -ENOENT;
	} else if (ret < 0) {
		pr_warning("Debuginfo analysis failed. (%d)\n", ret);
		return ret;
	}
428

429 430
	/* Convert source file path */
	tmp = lr->path;
431
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
432 433 434 435 436 437
	free(tmp);	/* Free old path */
	if (ret < 0) {
		pr_warning("Failed to find source file. (%d)\n", ret);
		return ret;
	}

438 439 440
	setup_pager();

	if (lr->function)
441
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
442 443
			lr->start - lr->offset);
	else
444
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
445 446

	fp = fopen(lr->path, "r");
447 448 449 450 451
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
			   strerror(errno));
		return -errno;
	}
452
	/* Skip to starting line number */
453
	while (l < lr->start) {
454
		ret = skip_one_line(fp, l++);
455 456 457
		if (ret < 0)
			goto end;
	}
458 459

	list_for_each_entry(ln, &lr->line_list, list) {
460
		for (; ln->line > l; l++) {
461
			ret = show_one_line(fp, l - lr->offset);
462 463 464
			if (ret < 0)
				goto end;
		}
465
		ret = show_one_line_with_num(fp, l++ - lr->offset);
466 467
		if (ret < 0)
			goto end;
468 469 470 471
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
472 473 474
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
475 476
			break;
	}
477
end:
478
	fclose(fp);
479
	return ret;
480 481
}

482 483
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
484 485
				  int max_vls, struct strfilter *_filter,
				  bool externs)
486 487
{
	char *buf;
488
	int ret, i, nvars;
489 490
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
491
	const char *var;
492 493 494 495 496 497

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

498 499
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
						max_vls, externs);
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
	if (ret <= 0) {
		pr_err("Failed to find variables at %s (%d)\n", buf, ret);
		goto end;
	}
	/* 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);
		free(vl->point.symbol);
		nvars = 0;
		if (vl->vars) {
			strlist__for_each(node, vl->vars) {
				var = strchr(node->s, '\t') + 1;
				if (strfilter__compare(_filter, var)) {
520
					fprintf(stdout, "\t\t%s\n", node->s);
521 522 523 524
					nvars++;
				}
			}
			strlist__delete(vl->vars);
525
		}
526 527 528 529 530
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
531 532 533 534 535 536
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
537 538
			int max_vls, const char *module,
			struct strfilter *_filter, bool externs)
539
{
540 541
	int i, ret = 0;
	struct debuginfo *dinfo;
542 543 544 545 546

	ret = init_vmlinux();
	if (ret < 0)
		return ret;

547 548 549 550 551 552
	dinfo = open_debuginfo(module);
	if (!dinfo) {
		pr_warning("Failed to open debuginfo file.\n");
		return -ENOENT;
	}

553 554
	setup_pager();

555 556
	for (i = 0; i < npevs && ret >= 0; i++)
		ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
557
					     externs);
558 559

	debuginfo__delete(dinfo);
560 561 562
	return ret;
}

563 564
#else	/* !DWARF_SUPPORT */

565
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
566
					struct perf_probe_point *pp)
567
{
568 569 570 571 572 573 574
	struct symbol *sym;

	sym = __find_kernel_function_by_name(tp->symbol, NULL);
	if (!sym) {
		pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
		return -ENOENT;
	}
575 576 577
	pp->function = strdup(tp->symbol);
	if (pp->function == NULL)
		return -ENOMEM;
578 579
	pp->offset = tp->offset;
	pp->retprobe = tp->retprobe;
580 581

	return 0;
582 583
}

584 585
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
				struct probe_trace_event **tevs __unused,
586
				int max_tevs __unused, const char *mod __unused)
587
{
588 589 590 591
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
592 593 594
	return 0;
}

595
int show_line_range(struct line_range *lr __unused, const char *module __unused)
596
{
597 598
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
599 600
}

601
int show_available_vars(struct perf_probe_event *pevs __unused,
602
			int npevs __unused, int max_vls __unused,
603 604 605
			const char *module __unused,
			struct strfilter *filter __unused,
			bool externs __unused)
606 607 608 609
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
610 611
#endif

612 613 614 615 616 617 618 619 620 621 622 623 624
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;
}

625 626 627 628 629
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
630
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
631
 */
632
int parse_line_range_desc(const char *arg, struct line_range *lr)
633
{
634
	char *range, *file, *name = strdup(arg);
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	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--;
			}
		}
669

670
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
671 672

		err = -EINVAL;
673
		if (lr->start > lr->end) {
674
			semantic_error("Start line must be smaller"
675
				       " than end line.\n");
676
			goto err;
677
		}
678 679 680
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
681
		}
682
	}
683

684 685 686 687 688 689 690 691 692 693
	file = strchr(name, '@');
	if (file) {
		*file = '\0';
		lr->file = strdup(++file);
		if (lr->file == NULL) {
			err = -ENOMEM;
			goto err;
		}
		lr->function = name;
	} else if (strchr(name, '.'))
694
		lr->file = name;
695
	else
696
		lr->function = name;
697 698

	return 0;
699 700 701
err:
	free(name);
	return err;
702 703
}

704 705 706 707 708 709 710 711 712 713 714 715
/* Check the name is good for event/group */
static bool check_event_name(const char *name)
{
	if (!isalpha(*name) && *name != '_')
		return false;
	while (*++name != '\0') {
		if (!isalpha(*name) && !isdigit(*name) && *name != '_')
			return false;
	}
	return true;
}

716
/* Parse probepoint definition. */
717
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
718
{
719
	struct perf_probe_point *pp = &pev->point;
720 721 722 723
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
724 725
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
726 727
	 *
	 * TODO:Group name support
728 729
	 */

730 731
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
732 733
		*ptr = '\0';
		tmp = ptr + 1;
734 735 736 737 738
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
739
			semantic_error("%s is bad for event name -it must "
740 741 742
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
743 744 745
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
746
		pev->group = NULL;
747 748 749
		arg = tmp;
	}

750
	ptr = strpbrk(arg, ";:+@%");
751 752 753 754 755
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

756 757 758 759
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

760
	/* Check arg is function or file and copy it */
761 762
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
763
	else			/* Function */
764
		pp->function = tmp;
765 766 767 768 769

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
770
		if (c == ';') {	/* Lazy pattern must be the last part */
771 772 773
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
774 775 776
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
777 778 779 780 781 782 783
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
784
			if (*tmp != '\0') {
785
				semantic_error("There is non-digit char"
786 787 788
					       " in line number.\n");
				return -EINVAL;
			}
789 790 791
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
792
			if (*tmp != '\0') {
793
				semantic_error("There is non-digit character"
794 795 796
						" in offset.\n");
				return -EINVAL;
			}
797 798
			break;
		case '@':	/* File name */
799 800 801 802
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
803 804 805
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
806 807 808 809
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
810 811 812 813
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
814
			break;
815 816 817 818
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
819 820 821 822 823
			break;
		}
	}

	/* Exclusion check */
824
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
825 826
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
827 828
		return -EINVAL;
	}
829

830
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
831
		semantic_error("Lazy pattern can't be used with offset.\n");
832 833
		return -EINVAL;
	}
834

835
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
836
		semantic_error("Offset can't be used with line number.\n");
837 838
		return -EINVAL;
	}
839

840
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
841
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
842
			       "lazy pattern.\n");
843 844
		return -EINVAL;
	}
845

846
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
847
		semantic_error("Offset requires an entry function.\n");
848 849
		return -EINVAL;
	}
850

851
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
852
		semantic_error("Return probe requires an entry function.\n");
853 854
		return -EINVAL;
	}
855

856
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
857
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
858
			       "return probe.\n");
859 860
		return -EINVAL;
	}
861

862
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
863 864
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
865
	return 0;
866 867
}

868
/* Parse perf-probe event argument */
869
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
870
{
871
	char *tmp, *goodname;
872 873 874 875
	struct perf_probe_arg_field **fieldp;

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

876 877
	tmp = strchr(str, '=');
	if (tmp) {
878 879 880
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
881
		pr_debug("name:%s ", arg->name);
882 883 884
		str = tmp + 1;
	}

885 886 887
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
888 889 890
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
891 892 893
		pr_debug("type:%s ", arg->type);
	}

894
	tmp = strpbrk(str, "-.[");
895 896
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
897 898 899
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
900
		pr_debug("%s\n", arg->var);
901
		return 0;
902 903
	}

904
	/* Structure fields or array element */
905 906 907
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
908
	goodname = arg->var;
909
	pr_debug("%s, ", arg->var);
910 911 912
	fieldp = &arg->field;

	do {
913 914 915
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
916 917 918
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
919
			(*fieldp)->ref = true;
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
			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, "-.[");
941
		}
942
		if (tmp) {
943 944 945
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
946 947
			if (*str != '[')
				goodname = (*fieldp)->name;
948 949 950 951
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
952 953 954
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
955 956
	if (*str != '[')
		goodname = (*fieldp)->name;
957
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
958

959
	/* If no name is specified, set the last field name (not array index)*/
960
	if (!arg->name) {
961
		arg->name = strdup(goodname);
962 963 964
		if (arg->name == NULL)
			return -ENOMEM;
	}
965
	return 0;
966 967
}

968
/* Parse perf-probe event command */
969
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
970
{
971
	char **argv;
972
	int argc, i, ret = 0;
973

974
	argv = argv_split(cmd, &argc);
975 976 977 978 979 980 981 982 983
	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;
	}
984
	/* Parse probe point */
985 986 987
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
988

989
	/* Copy arguments and ensure return probe has no C argument */
990
	pev->nargs = argc - 1;
991 992 993 994 995
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
996 997 998 999
	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) {
1000
			semantic_error("You can't specify local variable for"
1001 1002 1003
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1004
	}
1005
out:
1006
	argv_free(argv);
1007 1008

	return ret;
1009 1010
}

1011 1012 1013 1014 1015 1016 1017 1018 1019
/* 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++)
1020
		if (is_c_varname(pev->args[i].var))
1021 1022 1023 1024 1025
			return true;

	return false;
}

1026 1027
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
1028
				     struct probe_trace_event *tev)
1029
{
1030
	struct probe_trace_point *tp = &tev->point;
1031 1032 1033 1034 1035
	char pr;
	char *p;
	int ret, i, argc;
	char **argv;

1036
	pr_debug("Parsing probe_events: %s\n", cmd);
1037
	argv = argv_split(cmd, &argc);
1038 1039 1040 1041 1042 1043 1044 1045 1046
	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;
	}
1047 1048

	/* Scan event and group name. */
1049
	ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
1050 1051
		     &pr, (float *)(void *)&tev->group,
		     (float *)(void *)&tev->event);
1052 1053 1054 1055 1056
	if (ret != 3) {
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1057
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1058

1059
	tp->retprobe = (pr == 'r');
1060

1061 1062 1063 1064 1065 1066 1067 1068
	/* 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];
	ret = sscanf(p, "%a[^+]+%lu", (float *)(void *)&tp->symbol,
1069
		     &tp->offset);
1070
	if (ret == 1)
1071
		tp->offset = 0;
1072

1073
	tev->nargs = argc - 2;
1074
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1075 1076 1077 1078
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1079
	for (i = 0; i < tev->nargs; i++) {
1080 1081
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1082 1083 1084
			*p++ = '\0';
		else
			p = argv[i + 2];
1085
		tev->args[i].name = strdup(argv[i + 2]);
1086
		/* TODO: parse regs and offset */
1087 1088 1089 1090 1091
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1092
	}
1093 1094
	ret = 0;
out:
1095
	argv_free(argv);
1096
	return ret;
1097 1098
}

1099 1100 1101 1102 1103 1104 1105
/* 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;

1106 1107 1108 1109
	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);
1110 1111 1112 1113 1114 1115
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1116 1117 1118 1119 1120
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1121 1122 1123 1124 1125 1126
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1127 1128 1129 1130 1131 1132 1133 1134 1135

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

1136 1137
	return tmp - buf;
error:
M
Masami Hiramatsu 已提交
1138
	pr_debug("Failed to synthesize perf probe argument: %s\n",
1139 1140
		 strerror(-ret));
	return ret;
1141 1142
}

1143 1144
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1145
{
1146 1147 1148
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1149

1150 1151 1152 1153 1154
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1155
	if (pp->offset) {
1156
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1157 1158 1159 1160
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1161 1162 1163 1164 1165
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1166 1167 1168 1169 1170 1171 1172
		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);
1173 1174 1175 1176 1177
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1178 1179 1180
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1181
	else
1182
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1183 1184 1185 1186
	if (ret <= 0)
		goto error;

	return buf;
1187
error:
M
Masami Hiramatsu 已提交
1188
	pr_debug("Failed to synthesize perf probe point: %s\n",
1189
		 strerror(-ret));
1190 1191
	if (buf)
		free(buf);
1192
	return NULL;
1193 1194
}

1195 1196
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1197 1198 1199 1200
{
	char *buf;
	int i, len, ret;

1201 1202 1203
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1204

1205 1206
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1207
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1208 1209 1210 1211 1212
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1213 1214 1215
		len += ret;
	}

1216 1217 1218 1219
	return buf;
}
#endif

1220
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1221 1222 1223 1224 1225
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1226
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
							 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;
1241 1242 1243

}

1244
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1245
				       char *buf, size_t buflen)
1246
{
1247
	struct probe_trace_arg_ref *ref = arg->ref;
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
	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;

1261 1262 1263 1264
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1265
	/* Dereferencing arguments */
1266
	if (ref) {
1267
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1268 1269 1270 1271 1272 1273
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1274 1275 1276 1277 1278
	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);
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
	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;
	}
1292 1293 1294 1295 1296 1297 1298
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1299 1300 1301 1302

	return buf - tmp;
}

1303
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1304
{
1305
	struct probe_trace_point *tp = &tev->point;
1306 1307 1308
	char *buf;
	int i, len, ret;

1309 1310 1311 1312
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1313
	len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1314 1315
			 tp->retprobe ? 'r' : 'p',
			 tev->group, tev->event,
1316
			 tp->module ?: "", tp->module ? ":" : "",
1317 1318
			 tp->symbol, tp->offset);
	if (len <= 0)
1319 1320
		goto error;

1321
	for (i = 0; i < tev->nargs; i++) {
1322
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1323
						  MAX_CMDLEN - len);
1324
		if (ret <= 0)
1325 1326 1327 1328
			goto error;
		len += ret;
	}

1329
	return buf;
1330
error:
1331 1332 1333
	free(buf);
	return NULL;
}
1334

1335
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1336
				       struct perf_probe_event *pev)
1337
{
1338
	char buf[64] = "";
1339
	int i, ret;
1340

1341
	/* Convert event/group name */
1342 1343 1344 1345
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1346

1347
	/* Convert trace_point to probe_point */
1348
	ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1349 1350
	if (ret < 0)
		return ret;
1351

1352 1353
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1354 1355 1356
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1357
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1358
		if (tev->args[i].name)
1359
			pev->args[i].name = strdup(tev->args[i].name);
1360
		else {
1361
			ret = synthesize_probe_trace_arg(&tev->args[i],
1362
							  buf, 64);
1363
			pev->args[i].name = strdup(buf);
1364
		}
1365 1366 1367
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1368 1369 1370 1371 1372

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1373 1374 1375 1376 1377
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
	struct perf_probe_point *pp = &pev->point;
1378
	struct perf_probe_arg_field *field, *next;
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
	int i;

	if (pev->event)
		free(pev->event);
	if (pev->group)
		free(pev->group);
	if (pp->file)
		free(pp->file);
	if (pp->function)
		free(pp->function);
	if (pp->lazy_line)
		free(pp->lazy_line);
1391
	for (i = 0; i < pev->nargs; i++) {
1392 1393
		if (pev->args[i].name)
			free(pev->args[i].name);
1394 1395
		if (pev->args[i].var)
			free(pev->args[i].var);
1396 1397
		if (pev->args[i].type)
			free(pev->args[i].type);
1398 1399 1400 1401 1402 1403 1404 1405 1406
		field = pev->args[i].field;
		while (field) {
			next = field->next;
			if (field->name)
				free(field->name);
			free(field);
			field = next;
		}
	}
1407 1408 1409 1410 1411
	if (pev->args)
		free(pev->args);
	memset(pev, 0, sizeof(*pev));
}

1412
static void clear_probe_trace_event(struct probe_trace_event *tev)
1413
{
1414
	struct probe_trace_arg_ref *ref, *next;
1415 1416 1417 1418 1419 1420 1421 1422
	int i;

	if (tev->event)
		free(tev->event);
	if (tev->group)
		free(tev->group);
	if (tev->point.symbol)
		free(tev->point.symbol);
1423 1424
	if (tev->point.module)
		free(tev->point.module);
1425 1426 1427 1428 1429
	for (i = 0; i < tev->nargs; i++) {
		if (tev->args[i].name)
			free(tev->args[i].name);
		if (tev->args[i].value)
			free(tev->args[i].value);
1430 1431
		if (tev->args[i].type)
			free(tev->args[i].type);
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
		ref = tev->args[i].ref;
		while (ref) {
			next = ref->next;
			free(ref);
			ref = next;
		}
	}
	if (tev->args)
		free(tev->args);
	memset(tev, 0, sizeof(*tev));
1442 1443
}

1444
static int open_kprobe_events(bool readwrite)
1445 1446
{
	char buf[PATH_MAX];
1447
	const char *__debugfs;
1448 1449
	int ret;

1450 1451 1452 1453 1454 1455 1456
	__debugfs = debugfs_find_mountpoint();
	if (__debugfs == NULL) {
		pr_warning("Debugfs is not mounted.\n");
		return -ENOENT;
	}

	ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
1457
	if (ret >= 0) {
1458
		pr_debug("Opening %s write=%d\n", buf, readwrite);
1459 1460 1461 1462 1463
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
	}
1464

1465 1466
	if (ret < 0) {
		if (errno == ENOENT)
1467 1468
			pr_warning("kprobe_events file does not exist - please"
				 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1469
		else
1470 1471
			pr_warning("Failed to open kprobe_events file: %s\n",
				   strerror(errno));
1472 1473 1474 1475 1476
	}
	return ret;
}

/* Get raw string list of current kprobe_events */
1477
static struct strlist *get_probe_trace_command_rawlist(int fd)
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
{
	int ret, idx;
	FILE *fp;
	char buf[MAX_CMDLEN];
	char *p;
	struct strlist *sl;

	sl = strlist__new(true, NULL);

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

		idx = strlen(p) - 1;
		if (p[idx] == '\n')
			p[idx] = '\0';
		ret = strlist__add(sl, buf);
1497 1498 1499 1500 1501
		if (ret < 0) {
			pr_debug("strlist__add failed: %s\n", strerror(-ret));
			strlist__delete(sl);
			return NULL;
		}
1502 1503 1504 1505 1506 1507
	}
	fclose(fp);

	return sl;
}

1508
/* Show an event */
1509
static int show_perf_probe_event(struct perf_probe_event *pev)
1510
{
1511
	int i, ret;
1512
	char buf[128];
1513
	char *place;
1514

1515 1516
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
1517 1518
	if (!place)
		return -EINVAL;
1519 1520

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1521
	if (ret < 0)
1522 1523
		return ret;

1524
	printf("  %-20s (on %s", buf, place);
1525

1526
	if (pev->nargs > 0) {
1527
		printf(" with");
1528
		for (i = 0; i < pev->nargs; i++) {
1529 1530 1531 1532
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
1533 1534
			printf(" %s", buf);
		}
1535 1536
	}
	printf(")\n");
1537
	free(place);
1538
	return ret;
1539 1540
}

1541
/* List up current perf-probe events */
1542
int show_perf_probe_events(void)
1543
{
1544
	int fd, ret;
1545
	struct probe_trace_event tev;
1546
	struct perf_probe_event pev;
1547 1548 1549
	struct strlist *rawlist;
	struct str_node *ent;

1550
	setup_pager();
1551 1552 1553
	ret = init_vmlinux();
	if (ret < 0)
		return ret;
1554 1555 1556

	memset(&tev, 0, sizeof(tev));
	memset(&pev, 0, sizeof(pev));
1557

1558
	fd = open_kprobe_events(false);
1559 1560 1561
	if (fd < 0)
		return fd;

1562
	rawlist = get_probe_trace_command_rawlist(fd);
1563
	close(fd);
1564 1565
	if (!rawlist)
		return -ENOENT;
1566

1567
	strlist__for_each(ent, rawlist) {
1568
		ret = parse_probe_trace_command(ent->s, &tev);
1569 1570 1571 1572 1573
		if (ret >= 0) {
			ret = convert_to_perf_probe_event(&tev, &pev);
			if (ret >= 0)
				ret = show_perf_probe_event(&pev);
		}
1574
		clear_perf_probe_event(&pev);
1575
		clear_probe_trace_event(&tev);
1576 1577
		if (ret < 0)
			break;
1578 1579
	}
	strlist__delete(rawlist);
1580 1581

	return ret;
1582 1583
}

1584
/* Get current perf-probe event names */
1585
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1586
{
1587
	char buf[128];
1588 1589
	struct strlist *sl, *rawlist;
	struct str_node *ent;
1590
	struct probe_trace_event tev;
1591
	int ret = 0;
1592

1593
	memset(&tev, 0, sizeof(tev));
1594
	rawlist = get_probe_trace_command_rawlist(fd);
1595
	sl = strlist__new(true, NULL);
1596
	strlist__for_each(ent, rawlist) {
1597
		ret = parse_probe_trace_command(ent->s, &tev);
1598 1599
		if (ret < 0)
			break;
1600
		if (include_group) {
1601 1602 1603 1604
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
1605
		} else
1606
			ret = strlist__add(sl, tev.event);
1607
		clear_probe_trace_event(&tev);
1608 1609
		if (ret < 0)
			break;
1610 1611 1612
	}
	strlist__delete(rawlist);

1613 1614 1615 1616
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
1617 1618 1619
	return sl;
}

1620
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1621
{
1622
	int ret = 0;
1623
	char *buf = synthesize_probe_trace_command(tev);
1624

1625
	if (!buf) {
1626
		pr_debug("Failed to synthesize probe trace event.\n");
1627 1628 1629
		return -EINVAL;
	}

1630
	pr_debug("Writing event: %s\n", buf);
1631 1632 1633
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
		if (ret <= 0)
1634 1635
			pr_warning("Failed to write event: %s\n",
				   strerror(errno));
1636
	}
1637
	free(buf);
1638
	return ret;
1639 1640
}

1641 1642
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
1643 1644
{
	int i, ret;
1645 1646 1647

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
1648 1649 1650 1651
	if (ret < 0) {
		pr_debug("snprintf() failed: %s\n", strerror(-ret));
		return ret;
	}
1652
	if (!strlist__has_entry(namelist, buf))
1653
		return 0;
1654

1655 1656 1657
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
1658
		return -EEXIST;
1659 1660
	}

1661 1662
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
1663
		ret = e_snprintf(buf, len, "%s_%d", base, i);
1664 1665 1666 1667
		if (ret < 0) {
			pr_debug("snprintf() failed: %s\n", strerror(-ret));
			return ret;
		}
1668 1669 1670
		if (!strlist__has_entry(namelist, buf))
			break;
	}
1671 1672 1673 1674 1675 1676
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
1677 1678
}

1679 1680
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
1681
				     int ntevs, bool allow_suffix)
1682
{
1683
	int i, fd, ret;
1684
	struct probe_trace_event *tev = NULL;
1685 1686
	char buf[64];
	const char *event, *group;
1687
	struct strlist *namelist;
1688

1689
	fd = open_kprobe_events(true);
1690 1691
	if (fd < 0)
		return fd;
1692
	/* Get current event names */
1693
	namelist = get_probe_trace_event_names(fd, false);
1694 1695 1696 1697
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
1698

1699
	ret = 0;
1700
	printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1701
	for (i = 0; i < ntevs; i++) {
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
		tev = &tevs[i];
		if (pev->event)
			event = pev->event;
		else
			if (pev->point.function)
				event = pev->point.function;
			else
				event = tev->point.symbol;
		if (pev->group)
			group = pev->group;
		else
			group = PERFPROBE_GROUP;

		/* Get an unused new event name */
1716 1717 1718 1719
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
1720 1721
		event = buf;

1722 1723 1724 1725 1726 1727
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
1728
		ret = write_probe_trace_event(fd, tev);
1729 1730
		if (ret < 0)
			break;
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
		/* Add added event name to namelist */
		strlist__add(namelist, event);

		/* Trick here - save current event/group */
		event = pev->event;
		group = pev->group;
		pev->event = tev->event;
		pev->group = tev->group;
		show_perf_probe_event(pev);
		/* Trick here - restore current event/group */
		pev->event = (char *)event;
		pev->group = (char *)group;

		/*
		 * Probes after the first probe which comes from same
		 * user input are always allowed to add suffix, because
		 * there might be several addresses corresponding to
		 * one code line.
		 */
		allow_suffix = true;
1751
	}
1752 1753 1754 1755 1756 1757 1758

	if (ret >= 0) {
		/* Show how to use the event. */
		printf("\nYou can now use it on all perf tools, such as:\n\n");
		printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
			 tev->event);
	}
1759

1760
	strlist__delete(namelist);
1761
	close(fd);
1762
	return ret;
1763
}
1764

1765 1766
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
					  struct probe_trace_event **tevs,
1767
					  int max_tevs, const char *module)
1768 1769
{
	struct symbol *sym;
1770
	int ret = 0, i;
1771
	struct probe_trace_event *tev;
1772

1773
	/* Convert perf_probe_event with debuginfo */
1774
	ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
1775
	if (ret != 0)
1776
		return ret;	/* Found in debuginfo or got an error */
1777

1778
	/* Allocate trace event buffer */
1779
	tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1780 1781
	if (tev == NULL)
		return -ENOMEM;
1782 1783

	/* Copy parameters */
1784 1785 1786 1787 1788
	tev->point.symbol = strdup(pev->point.function);
	if (tev->point.symbol == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1789 1790 1791 1792 1793
	tev->point.module = strdup(module);
	if (tev->point.module == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1794
	tev->point.offset = pev->point.offset;
1795
	tev->point.retprobe = pev->point.retprobe;
1796 1797
	tev->nargs = pev->nargs;
	if (tev->nargs) {
1798
		tev->args = zalloc(sizeof(struct probe_trace_arg)
1799 1800
				   * tev->nargs);
		if (tev->args == NULL) {
1801 1802
			ret = -ENOMEM;
			goto error;
1803
		}
1804
		for (i = 0; i < tev->nargs; i++) {
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
			if (pev->args[i].name) {
				tev->args[i].name = strdup(pev->args[i].name);
				if (tev->args[i].name == NULL) {
					ret = -ENOMEM;
					goto error;
				}
			}
			tev->args[i].value = strdup(pev->args[i].var);
			if (tev->args[i].value == NULL) {
				ret = -ENOMEM;
				goto error;
			}
			if (pev->args[i].type) {
				tev->args[i].type = strdup(pev->args[i].type);
				if (tev->args[i].type == NULL) {
					ret = -ENOMEM;
					goto error;
				}
			}
1824
		}
1825 1826 1827
	}

	/* Currently just checking function name from symbol map */
1828
	sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1829 1830 1831
	if (!sym) {
		pr_warning("Kernel symbol \'%s\' not found.\n",
			   tev->point.symbol);
1832 1833 1834
		ret = -ENOENT;
		goto error;
	}
1835

1836 1837
	return 1;
error:
1838
	clear_probe_trace_event(tev);
1839 1840
	free(tev);
	*tevs = NULL;
1841
	return ret;
1842 1843 1844 1845
}

struct __event_package {
	struct perf_probe_event		*pev;
1846
	struct probe_trace_event	*tevs;
1847 1848 1849
	int				ntevs;
};

1850
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1851
			  int max_tevs, const char *module, bool force_add)
1852
{
1853
	int i, j, ret;
1854 1855
	struct __event_package *pkgs;

1856 1857 1858
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
	if (pkgs == NULL)
		return -ENOMEM;
1859 1860

	/* Init vmlinux path */
1861
	ret = init_vmlinux();
1862 1863
	if (ret < 0) {
		free(pkgs);
1864
		return ret;
1865
	}
1866 1867 1868 1869 1870

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
1871
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
1872 1873 1874
						     &pkgs[i].tevs,
						     max_tevs,
						     module);
1875 1876 1877
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
1878 1879
	}

1880
	/* Loop 2: add all events */
1881
	for (i = 0; i < npevs; i++) {
1882
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1883
						pkgs[i].ntevs, force_add);
1884 1885 1886
		if (ret < 0)
			break;
	}
1887
end:
1888 1889
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
1890
		for (j = 0; j < pkgs[i].ntevs; j++)
1891
			clear_probe_trace_event(&pkgs[i].tevs[j]);
1892 1893 1894
		free(pkgs[i].tevs);
	}
	free(pkgs);
1895 1896

	return ret;
1897 1898
}

1899
static int __del_trace_probe_event(int fd, struct str_node *ent)
1900 1901 1902
{
	char *p;
	char buf[128];
1903
	int ret;
1904

1905
	/* Convert from perf-probe event to trace-probe event */
1906 1907 1908 1909
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

1910
	p = strchr(buf + 2, ':');
1911 1912 1913 1914 1915 1916
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
1917 1918
	*p = '/';

1919 1920
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
1921 1922 1923
	if (ret < 0)
		goto error;

1924
	printf("Remove event: %s\n", ent->s);
1925 1926 1927 1928
	return 0;
error:
	pr_warning("Failed to delete event: %s\n", strerror(-ret));
	return ret;
1929 1930
}

1931
static int del_trace_probe_event(int fd, const char *group,
1932
				  const char *event, struct strlist *namelist)
1933 1934
{
	char buf[128];
1935
	struct str_node *ent, *n;
1936
	int found = 0, ret = 0;
1937

1938 1939
	ret = e_snprintf(buf, 128, "%s:%s", group, event);
	if (ret < 0) {
M
Masami Hiramatsu 已提交
1940
		pr_err("Failed to copy event.\n");
1941 1942
		return ret;
	}
1943

1944 1945 1946 1947
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
				found++;
1948
				ret = __del_trace_probe_event(fd, ent);
1949 1950
				if (ret < 0)
					break;
1951 1952 1953 1954 1955 1956
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
			found++;
1957
			ret = __del_trace_probe_event(fd, ent);
1958 1959
			if (ret >= 0)
				strlist__remove(namelist, ent);
1960 1961
		}
	}
1962 1963 1964 1965
	if (found == 0 && ret >= 0)
		pr_info("Info: Event \"%s\" does not exist.\n", buf);

	return ret;
1966 1967
}

1968
int del_perf_probe_events(struct strlist *dellist)
1969
{
1970
	int fd, ret = 0;
1971 1972 1973 1974 1975
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
	struct strlist *namelist;

1976
	fd = open_kprobe_events(true);
1977 1978 1979
	if (fd < 0)
		return fd;

1980
	/* Get current event names */
1981
	namelist = get_probe_trace_event_names(fd, true);
1982 1983
	if (namelist == NULL)
		return -EINVAL;
1984

1985
	strlist__for_each(ent, dellist) {
1986 1987 1988 1989 1990
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
			break;
		}
1991
		pr_debug("Parsing: %s\n", str);
1992 1993 1994 1995 1996 1997
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
1998
			group = "*";
1999 2000
			event = str;
		}
2001
		pr_debug("Group: %s, Event: %s\n", group, event);
2002
		ret = del_trace_probe_event(fd, group, event, namelist);
2003
		free(str);
2004 2005
		if (ret < 0)
			break;
2006 2007 2008
	}
	strlist__delete(namelist);
	close(fd);
2009 2010

	return ret;
2011
}
2012 2013
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2014

2015
/*
2016 2017
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2018
 */
2019 2020
static int filter_available_functions(struct map *map __unused,
				      struct symbol *sym)
2021
{
2022 2023 2024 2025
	if (sym->binding == STB_GLOBAL &&
	    strfilter__compare(available_func_filter, sym->name))
		return 0;
	return 1;
2026 2027
}

2028
int show_available_funcs(const char *module, struct strfilter *_filter)
2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
{
	struct map *map;
	int ret;

	setup_pager();

	ret = init_vmlinux();
	if (ret < 0)
		return ret;

	map = kernel_get_module_map(module);
	if (!map) {
		pr_err("Failed to find %s map.\n", (module) ? : "kernel");
		return -EINVAL;
	}
2044 2045
	available_func_filter = _filter;
	if (map__load(map, filter_available_functions)) {
2046 2047 2048 2049 2050 2051 2052 2053 2054
		pr_err("Failed to load map.\n");
		return -EINVAL;
	}
	if (!dso__sorted_by_name(map->dso, map->type))
		dso__sort_by_name(map->dso, map->type);

	dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
	return 0;
}