probe-event.c 45.8 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
static struct map *kernel_get_module_map(const char *module)
{
	struct rb_node *nd;
	struct map_groups *grp = &machine.kmaps;

120 121 122 123
	/* A file path -- this is an offline module */
	if (module && strchr(module, '/'))
		return machine__new_module(&machine, 0, module);

124 125 126 127 128 129 130 131 132 133 134 135 136 137
	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)
138 139
{
	struct dso *dso;
140 141
	struct map *map;
	const char *vmlinux_name;
142 143 144 145 146 147 148 149 150

	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;
151 152 153 154 155 156 157 158 159
	}

	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;
160
	} else {
161
		if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
162 163 164 165 166
			pr_debug("Failed to load kernel map.\n");
			return NULL;
		}
	}
found:
167 168 169 170 171 172 173
	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;
174 175
}

176
#ifdef DWARF_SUPPORT
177 178
/* Open new debuginfo of given module */
static struct debuginfo *open_debuginfo(const char *module)
179
{
180
	const char *path;
181

182 183 184 185 186 187 188 189 190 191 192
	/* A file path -- this is an offline module */
	if (module && strchr(module, '/'))
		path = module;
	else {
		path = kernel_get_module_path(module);

		if (!path) {
			pr_err("Failed to find path of %s module.\n",
			       module ?: "kernel");
			return NULL;
		}
193
	}
194
	return debuginfo__new(path);
195
}
196

197 198 199 200 201
/*
 * Convert trace point to probe point with debuginfo
 * Currently only handles kprobes.
 */
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
202
					struct perf_probe_point *pp)
203 204
{
	struct symbol *sym;
205 206 207
	struct map *map;
	u64 addr;
	int ret = -ENOENT;
208
	struct debuginfo *dinfo;
209

210
	sym = __find_kernel_function_by_name(tp->symbol, &map);
211
	if (sym) {
212
		addr = map->unmap_ip(map, sym->start + tp->offset);
213
		pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
214
			 tp->offset, addr);
215 216 217 218 219 220 221 222 223 224 225

		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;
		}
226 227
	}
	if (ret <= 0) {
228 229
		pr_debug("Failed to find corresponding probes from "
			 "debuginfo. Use kprobe event information.\n");
230 231 232
		pp->function = strdup(tp->symbol);
		if (pp->function == NULL)
			return -ENOMEM;
233 234 235
		pp->offset = tp->offset;
	}
	pp->retprobe = tp->retprobe;
236 237

	return 0;
238 239
}

240 241 242
static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
					    int ntevs, const char *module)
{
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	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() */
	}

261 262
	for (i = 0; i < ntevs; i++) {
		tevs[i].point.module = strdup(module);
263 264 265 266
		if (!tevs[i].point.module) {
			ret = -ENOMEM;
			break;
		}
267
	}
268 269 270 271 272

	if (tmp)
		free(tmp);

	return ret;
273 274
}

275
/* Try to find perf_probe_event with debuginfo */
276
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
277 278
					  struct probe_trace_event **tevs,
					  int max_tevs, const char *module)
279 280
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
281
	struct debuginfo *dinfo = open_debuginfo(module);
282
	int ntevs, ret = 0;
283

284
	if (!dinfo) {
285 286
		if (need_dwarf) {
			pr_warning("Failed to open debuginfo file.\n");
287
			return -ENOENT;
288
		}
289
		pr_debug("Could not open debuginfo. Try to use symbols.\n");
290 291 292
		return 0;
	}

293 294 295 296
	/* Searching trace events corresponding to a probe event */
	ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);

	debuginfo__delete(dinfo);
297

298
	if (ntevs > 0) {	/* Succeeded to find trace events */
299
		pr_debug("find %d probe_trace_events.\n", ntevs);
300 301 302 303
		if (module)
			ret = add_module_to_probe_trace_events(*tevs, ntevs,
							       module);
		return ret < 0 ? ret : ntevs;
304
	}
305

306 307 308 309 310 311
	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 */
312 313 314 315 316
	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 已提交
317
			pr_debug("Trying to use symbols.\n");
318 319
			return 0;
		}
320
	}
321
	return ntevs;
322 323
}

324 325 326 327 328 329
/*
 * 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.
 */
330 331
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
332
{
333 334 335 336 337 338 339 340 341 342 343 344 345
	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;
		}
346 347
	}

348
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
349 350 351 352
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
353
		sprintf(*new_path, "%s/%s", prefix, raw_path);
354 355 356 357

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

358 359 360 361
		if (!symbol_conf.source_prefix)
			/* In case of searching comp_dir, don't retry */
			return -errno;

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
		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;
		}
	}
}

383 384 385
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

386
static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
387 388
{
	char buf[LINEBUF_SIZE];
389 390
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
391

392
	do {
393 394
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
395 396 397 398 399
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
400
		}
401 402 403
		color_fprintf(stdout, color, "%s", buf);

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

405
	return 1;
406
error:
407
	if (ferror(fp)) {
408
		pr_warning("File read error: %s\n", strerror(errno));
409 410 411 412
		return -1;
	}
	return 0;
}
413

414 415 416 417 418 419 420 421
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;
422 423
}

424 425 426 427 428
#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)

429 430 431 432
/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
433
int show_line_range(struct line_range *lr, const char *module)
434
{
435
	int l = 1;
436
	struct line_node *ln;
437
	struct debuginfo *dinfo;
438
	FILE *fp;
439
	int ret;
440
	char *tmp;
441 442

	/* Search a line range */
443 444 445 446
	ret = init_vmlinux();
	if (ret < 0)
		return ret;

447 448
	dinfo = open_debuginfo(module);
	if (!dinfo) {
449
		pr_warning("Failed to open debuginfo file.\n");
450
		return -ENOENT;
451 452
	}

453 454
	ret = debuginfo__find_line_range(dinfo, lr);
	debuginfo__delete(dinfo);
455 456 457 458 459 460 461
	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;
	}
462

463 464
	/* Convert source file path */
	tmp = lr->path;
465
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
466 467 468 469 470 471
	free(tmp);	/* Free old path */
	if (ret < 0) {
		pr_warning("Failed to find source file. (%d)\n", ret);
		return ret;
	}

472 473 474
	setup_pager();

	if (lr->function)
475
		fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
476 477
			lr->start - lr->offset);
	else
478
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
479 480

	fp = fopen(lr->path, "r");
481 482 483 484 485
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
			   strerror(errno));
		return -errno;
	}
486
	/* Skip to starting line number */
487
	while (l < lr->start) {
488
		ret = skip_one_line(fp, l++);
489 490 491
		if (ret < 0)
			goto end;
	}
492 493

	list_for_each_entry(ln, &lr->line_list, list) {
494
		for (; ln->line > l; l++) {
495
			ret = show_one_line(fp, l - lr->offset);
496 497 498
			if (ret < 0)
				goto end;
		}
499
		ret = show_one_line_with_num(fp, l++ - lr->offset);
500 501
		if (ret < 0)
			goto end;
502 503 504 505
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
506 507 508
	while (l <= lr->end) {
		ret = show_one_line_or_eof(fp, l++ - lr->offset);
		if (ret <= 0)
509 510
			break;
	}
511
end:
512
	fclose(fp);
513
	return ret;
514 515
}

516 517
static int show_available_vars_at(struct debuginfo *dinfo,
				  struct perf_probe_event *pev,
518 519
				  int max_vls, struct strfilter *_filter,
				  bool externs)
520 521
{
	char *buf;
522
	int ret, i, nvars;
523 524
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;
525
	const char *var;
526 527 528 529 530 531

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

532 533
	ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
						max_vls, externs);
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
	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)) {
554
					fprintf(stdout, "\t\t%s\n", node->s);
555 556 557 558
					nvars++;
				}
			}
			strlist__delete(vl->vars);
559
		}
560 561 562 563 564
		if (nvars == 0)
			fprintf(stdout, "\t\t(No matched variables)\n");
	}
	free(vls);
end:
565 566 567 568 569 570
	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
571 572
			int max_vls, const char *module,
			struct strfilter *_filter, bool externs)
573
{
574 575
	int i, ret = 0;
	struct debuginfo *dinfo;
576 577 578 579 580

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

581 582 583 584 585 586
	dinfo = open_debuginfo(module);
	if (!dinfo) {
		pr_warning("Failed to open debuginfo file.\n");
		return -ENOENT;
	}

587 588
	setup_pager();

589 590
	for (i = 0; i < npevs && ret >= 0; i++)
		ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
591
					     externs);
592 593

	debuginfo__delete(dinfo);
594 595 596
	return ret;
}

597 598
#else	/* !DWARF_SUPPORT */

599
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
600
					struct perf_probe_point *pp)
601
{
602 603 604 605 606 607 608
	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;
	}
609 610 611
	pp->function = strdup(tp->symbol);
	if (pp->function == NULL)
		return -ENOMEM;
612 613
	pp->offset = tp->offset;
	pp->retprobe = tp->retprobe;
614 615

	return 0;
616 617
}

618 619
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
				struct probe_trace_event **tevs __unused,
620
				int max_tevs __unused, const char *mod __unused)
621
{
622 623 624 625
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
626 627 628
	return 0;
}

629
int show_line_range(struct line_range *lr __unused, const char *module __unused)
630
{
631 632
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
633 634
}

635
int show_available_vars(struct perf_probe_event *pevs __unused,
636
			int npevs __unused, int max_vls __unused,
637 638 639
			const char *module __unused,
			struct strfilter *filter __unused,
			bool externs __unused)
640 641 642 643
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
644 645
#endif

646 647 648 649 650 651 652 653 654 655 656 657 658
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;
}

659 660 661 662 663
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
664
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
665
 */
666
int parse_line_range_desc(const char *arg, struct line_range *lr)
667
{
668
	char *range, *file, *name = strdup(arg);
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
	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--;
			}
		}
703

704
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
705 706

		err = -EINVAL;
707
		if (lr->start > lr->end) {
708
			semantic_error("Start line must be smaller"
709
				       " than end line.\n");
710
			goto err;
711
		}
712 713 714
		if (*range != '\0') {
			semantic_error("Tailing with invalid str '%s'.\n", range);
			goto err;
715
		}
716
	}
717

718 719 720 721 722 723 724 725 726 727
	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, '.'))
728
		lr->file = name;
729
	else
730
		lr->function = name;
731 732

	return 0;
733 734 735
err:
	free(name);
	return err;
736 737
}

738 739 740 741 742 743 744 745 746 747 748 749
/* 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;
}

750
/* Parse probepoint definition. */
751
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
752
{
753
	struct perf_probe_point *pp = &pev->point;
754 755 756 757
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
758 759
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
760 761
	 *
	 * TODO:Group name support
762 763
	 */

764 765
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
766 767
		*ptr = '\0';
		tmp = ptr + 1;
768 769 770 771 772
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
773
			semantic_error("%s is bad for event name -it must "
774 775 776
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
777 778 779
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
780
		pev->group = NULL;
781 782 783
		arg = tmp;
	}

784
	ptr = strpbrk(arg, ";:+@%");
785 786 787 788 789
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

790 791 792 793
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

794
	/* Check arg is function or file and copy it */
795 796
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
797
	else			/* Function */
798
		pp->function = tmp;
799 800 801 802 803

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
804
		if (c == ';') {	/* Lazy pattern must be the last part */
805 806 807
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
808 809 810
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
811 812 813 814 815 816 817
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
818
			if (*tmp != '\0') {
819
				semantic_error("There is non-digit char"
820 821 822
					       " in line number.\n");
				return -EINVAL;
			}
823 824 825
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
826
			if (*tmp != '\0') {
827
				semantic_error("There is non-digit character"
828 829 830
						" in offset.\n");
				return -EINVAL;
			}
831 832
			break;
		case '@':	/* File name */
833 834 835 836
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
837 838 839
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
840 841 842 843
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
844 845 846 847
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
848
			break;
849 850 851 852
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
853 854 855 856 857
			break;
		}
	}

	/* Exclusion check */
858
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
859 860
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
861 862
		return -EINVAL;
	}
863

864
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
865
		semantic_error("Lazy pattern can't be used with offset.\n");
866 867
		return -EINVAL;
	}
868

869
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
870
		semantic_error("Offset can't be used with line number.\n");
871 872
		return -EINVAL;
	}
873

874
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
875
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
876
			       "lazy pattern.\n");
877 878
		return -EINVAL;
	}
879

880
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
881
		semantic_error("Offset requires an entry function.\n");
882 883
		return -EINVAL;
	}
884

885
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
886
		semantic_error("Return probe requires an entry function.\n");
887 888
		return -EINVAL;
	}
889

890
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
891
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
892
			       "return probe.\n");
893 894
		return -EINVAL;
	}
895

896
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
897 898
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
899
	return 0;
900 901
}

902
/* Parse perf-probe event argument */
903
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
904
{
905
	char *tmp, *goodname;
906 907 908 909
	struct perf_probe_arg_field **fieldp;

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

910 911
	tmp = strchr(str, '=');
	if (tmp) {
912 913 914
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
915
		pr_debug("name:%s ", arg->name);
916 917 918
		str = tmp + 1;
	}

919 920 921
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
922 923 924
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
925 926 927
		pr_debug("type:%s ", arg->type);
	}

928
	tmp = strpbrk(str, "-.[");
929 930
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
931 932 933
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
934
		pr_debug("%s\n", arg->var);
935
		return 0;
936 937
	}

938
	/* Structure fields or array element */
939 940 941
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
942
	goodname = arg->var;
943
	pr_debug("%s, ", arg->var);
944 945 946
	fieldp = &arg->field;

	do {
947 948 949
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
950 951 952
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
953
			(*fieldp)->ref = true;
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
			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, "-.[");
975
		}
976
		if (tmp) {
977 978 979
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
980 981
			if (*str != '[')
				goodname = (*fieldp)->name;
982 983 984 985
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
986 987 988
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
989 990
	if (*str != '[')
		goodname = (*fieldp)->name;
991
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
992

993
	/* If no name is specified, set the last field name (not array index)*/
994
	if (!arg->name) {
995
		arg->name = strdup(goodname);
996 997 998
		if (arg->name == NULL)
			return -ENOMEM;
	}
999
	return 0;
1000 1001
}

1002
/* Parse perf-probe event command */
1003
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1004
{
1005
	char **argv;
1006
	int argc, i, ret = 0;
1007

1008
	argv = argv_split(cmd, &argc);
1009 1010 1011 1012 1013 1014 1015 1016 1017
	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;
	}
1018
	/* Parse probe point */
1019 1020 1021
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
1022

1023
	/* Copy arguments and ensure return probe has no C argument */
1024
	pev->nargs = argc - 1;
1025 1026 1027 1028 1029
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1030 1031 1032 1033
	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) {
1034
			semantic_error("You can't specify local variable for"
1035 1036 1037
				       " kretprobe.\n");
			ret = -EINVAL;
		}
1038
	}
1039
out:
1040
	argv_free(argv);
1041 1042

	return ret;
1043 1044
}

1045 1046 1047 1048 1049 1050 1051 1052 1053
/* 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++)
1054
		if (is_c_varname(pev->args[i].var))
1055 1056 1057 1058 1059
			return true;

	return false;
}

1060 1061
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
1062
				     struct probe_trace_event *tev)
1063
{
1064
	struct probe_trace_point *tp = &tev->point;
1065 1066 1067 1068 1069
	char pr;
	char *p;
	int ret, i, argc;
	char **argv;

1070
	pr_debug("Parsing probe_events: %s\n", cmd);
1071
	argv = argv_split(cmd, &argc);
1072 1073 1074 1075 1076 1077 1078 1079 1080
	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;
	}
1081 1082

	/* Scan event and group name. */
1083
	ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
1084 1085
		     &pr, (float *)(void *)&tev->group,
		     (float *)(void *)&tev->event);
1086 1087 1088 1089 1090
	if (ret != 3) {
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
1091
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1092

1093
	tp->retprobe = (pr == 'r');
1094

1095 1096 1097 1098 1099 1100 1101 1102
	/* 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,
1103
		     &tp->offset);
1104
	if (ret == 1)
1105
		tp->offset = 0;
1106

1107
	tev->nargs = argc - 2;
1108
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1109 1110 1111 1112
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
1113
	for (i = 0; i < tev->nargs; i++) {
1114 1115
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
1116 1117 1118
			*p++ = '\0';
		else
			p = argv[i + 2];
1119
		tev->args[i].name = strdup(argv[i + 2]);
1120
		/* TODO: parse regs and offset */
1121 1122 1123 1124 1125
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
1126
	}
1127 1128
	ret = 0;
out:
1129
	argv_free(argv);
1130
	return ret;
1131 1132
}

1133 1134 1135 1136 1137 1138 1139
/* 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;

1140 1141 1142 1143
	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);
1144 1145 1146 1147 1148 1149
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
1150 1151 1152 1153 1154
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
1155 1156 1157 1158 1159 1160
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
1161 1162 1163 1164 1165 1166 1167 1168 1169

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

1170 1171
	return tmp - buf;
error:
M
Masami Hiramatsu 已提交
1172
	pr_debug("Failed to synthesize perf probe argument: %s\n",
1173 1174
		 strerror(-ret));
	return ret;
1175 1176
}

1177 1178
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1179
{
1180 1181 1182
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1183

1184 1185 1186 1187 1188
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1189
	if (pp->offset) {
1190
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1191 1192 1193 1194
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1195 1196 1197 1198 1199
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1200 1201 1202 1203 1204 1205 1206
		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);
1207 1208 1209 1210 1211
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1212 1213 1214
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1215
	else
1216
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1217 1218 1219 1220
	if (ret <= 0)
		goto error;

	return buf;
1221
error:
M
Masami Hiramatsu 已提交
1222
	pr_debug("Failed to synthesize perf probe point: %s\n",
1223
		 strerror(-ret));
1224 1225
	if (buf)
		free(buf);
1226
	return NULL;
1227 1228
}

1229 1230
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1231 1232 1233 1234
{
	char *buf;
	int i, len, ret;

1235 1236 1237
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1238

1239 1240
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1241
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1242 1243 1244 1245 1246
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1247 1248 1249
		len += ret;
	}

1250 1251 1252 1253
	return buf;
}
#endif

1254
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1255 1256 1257 1258 1259
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1260
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
							 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;
1275 1276 1277

}

1278
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1279
				       char *buf, size_t buflen)
1280
{
1281
	struct probe_trace_arg_ref *ref = arg->ref;
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
	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;

1295 1296 1297 1298
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1299
	/* Dereferencing arguments */
1300
	if (ref) {
1301
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1302 1303 1304 1305 1306 1307
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1308 1309 1310 1311 1312
	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);
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
	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;
	}
1326 1327 1328 1329 1330 1331 1332
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1333 1334 1335 1336

	return buf - tmp;
}

1337
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1338
{
1339
	struct probe_trace_point *tp = &tev->point;
1340 1341 1342
	char *buf;
	int i, len, ret;

1343 1344 1345 1346
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1347
	len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1348 1349
			 tp->retprobe ? 'r' : 'p',
			 tev->group, tev->event,
1350
			 tp->module ?: "", tp->module ? ":" : "",
1351 1352
			 tp->symbol, tp->offset);
	if (len <= 0)
1353 1354
		goto error;

1355
	for (i = 0; i < tev->nargs; i++) {
1356
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1357
						  MAX_CMDLEN - len);
1358
		if (ret <= 0)
1359 1360 1361 1362
			goto error;
		len += ret;
	}

1363
	return buf;
1364
error:
1365 1366 1367
	free(buf);
	return NULL;
}
1368

1369
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1370
				       struct perf_probe_event *pev)
1371
{
1372
	char buf[64] = "";
1373
	int i, ret;
1374

1375
	/* Convert event/group name */
1376 1377 1378 1379
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1380

1381
	/* Convert trace_point to probe_point */
1382
	ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1383 1384
	if (ret < 0)
		return ret;
1385

1386 1387
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1388 1389 1390
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1391
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1392
		if (tev->args[i].name)
1393
			pev->args[i].name = strdup(tev->args[i].name);
1394
		else {
1395
			ret = synthesize_probe_trace_arg(&tev->args[i],
1396
							  buf, 64);
1397
			pev->args[i].name = strdup(buf);
1398
		}
1399 1400 1401
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1402 1403 1404 1405 1406

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1407 1408 1409 1410 1411
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
	struct perf_probe_point *pp = &pev->point;
1412
	struct perf_probe_arg_field *field, *next;
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
	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);
1425
	for (i = 0; i < pev->nargs; i++) {
1426 1427
		if (pev->args[i].name)
			free(pev->args[i].name);
1428 1429
		if (pev->args[i].var)
			free(pev->args[i].var);
1430 1431
		if (pev->args[i].type)
			free(pev->args[i].type);
1432 1433 1434 1435 1436 1437 1438 1439 1440
		field = pev->args[i].field;
		while (field) {
			next = field->next;
			if (field->name)
				free(field->name);
			free(field);
			field = next;
		}
	}
1441 1442 1443 1444 1445
	if (pev->args)
		free(pev->args);
	memset(pev, 0, sizeof(*pev));
}

1446
static void clear_probe_trace_event(struct probe_trace_event *tev)
1447
{
1448
	struct probe_trace_arg_ref *ref, *next;
1449 1450 1451 1452 1453 1454 1455 1456
	int i;

	if (tev->event)
		free(tev->event);
	if (tev->group)
		free(tev->group);
	if (tev->point.symbol)
		free(tev->point.symbol);
1457 1458
	if (tev->point.module)
		free(tev->point.module);
1459 1460 1461 1462 1463
	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);
1464 1465
		if (tev->args[i].type)
			free(tev->args[i].type);
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
		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));
1476 1477
}

1478
static int open_kprobe_events(bool readwrite)
1479 1480
{
	char buf[PATH_MAX];
1481
	const char *__debugfs;
1482 1483
	int ret;

1484 1485 1486 1487 1488 1489 1490
	__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);
1491
	if (ret >= 0) {
1492
		pr_debug("Opening %s write=%d\n", buf, readwrite);
1493 1494 1495 1496 1497
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
	}
1498

1499 1500
	if (ret < 0) {
		if (errno == ENOENT)
1501 1502
			pr_warning("kprobe_events file does not exist - please"
				 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1503
		else
1504 1505
			pr_warning("Failed to open kprobe_events file: %s\n",
				   strerror(errno));
1506 1507 1508 1509 1510
	}
	return ret;
}

/* Get raw string list of current kprobe_events */
1511
static struct strlist *get_probe_trace_command_rawlist(int fd)
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
{
	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);
1531 1532 1533 1534 1535
		if (ret < 0) {
			pr_debug("strlist__add failed: %s\n", strerror(-ret));
			strlist__delete(sl);
			return NULL;
		}
1536 1537 1538 1539 1540 1541
	}
	fclose(fp);

	return sl;
}

1542
/* Show an event */
1543
static int show_perf_probe_event(struct perf_probe_event *pev)
1544
{
1545
	int i, ret;
1546
	char buf[128];
1547
	char *place;
1548

1549 1550
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
1551 1552
	if (!place)
		return -EINVAL;
1553 1554

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1555
	if (ret < 0)
1556 1557
		return ret;

1558
	printf("  %-20s (on %s", buf, place);
1559

1560
	if (pev->nargs > 0) {
1561
		printf(" with");
1562
		for (i = 0; i < pev->nargs; i++) {
1563 1564 1565 1566
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
1567 1568
			printf(" %s", buf);
		}
1569 1570
	}
	printf(")\n");
1571
	free(place);
1572
	return ret;
1573 1574
}

1575
/* List up current perf-probe events */
1576
int show_perf_probe_events(void)
1577
{
1578
	int fd, ret;
1579
	struct probe_trace_event tev;
1580
	struct perf_probe_event pev;
1581 1582 1583
	struct strlist *rawlist;
	struct str_node *ent;

1584
	setup_pager();
1585 1586 1587
	ret = init_vmlinux();
	if (ret < 0)
		return ret;
1588 1589 1590

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

1592
	fd = open_kprobe_events(false);
1593 1594 1595
	if (fd < 0)
		return fd;

1596
	rawlist = get_probe_trace_command_rawlist(fd);
1597
	close(fd);
1598 1599
	if (!rawlist)
		return -ENOENT;
1600

1601
	strlist__for_each(ent, rawlist) {
1602
		ret = parse_probe_trace_command(ent->s, &tev);
1603 1604 1605 1606 1607
		if (ret >= 0) {
			ret = convert_to_perf_probe_event(&tev, &pev);
			if (ret >= 0)
				ret = show_perf_probe_event(&pev);
		}
1608
		clear_perf_probe_event(&pev);
1609
		clear_probe_trace_event(&tev);
1610 1611
		if (ret < 0)
			break;
1612 1613
	}
	strlist__delete(rawlist);
1614 1615

	return ret;
1616 1617
}

1618
/* Get current perf-probe event names */
1619
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1620
{
1621
	char buf[128];
1622 1623
	struct strlist *sl, *rawlist;
	struct str_node *ent;
1624
	struct probe_trace_event tev;
1625
	int ret = 0;
1626

1627
	memset(&tev, 0, sizeof(tev));
1628
	rawlist = get_probe_trace_command_rawlist(fd);
1629
	sl = strlist__new(true, NULL);
1630
	strlist__for_each(ent, rawlist) {
1631
		ret = parse_probe_trace_command(ent->s, &tev);
1632 1633
		if (ret < 0)
			break;
1634
		if (include_group) {
1635 1636 1637 1638
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
1639
		} else
1640
			ret = strlist__add(sl, tev.event);
1641
		clear_probe_trace_event(&tev);
1642 1643
		if (ret < 0)
			break;
1644 1645 1646
	}
	strlist__delete(rawlist);

1647 1648 1649 1650
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
1651 1652 1653
	return sl;
}

1654
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1655
{
1656
	int ret = 0;
1657
	char *buf = synthesize_probe_trace_command(tev);
1658

1659
	if (!buf) {
1660
		pr_debug("Failed to synthesize probe trace event.\n");
1661 1662 1663
		return -EINVAL;
	}

1664
	pr_debug("Writing event: %s\n", buf);
1665 1666 1667
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
		if (ret <= 0)
1668 1669
			pr_warning("Failed to write event: %s\n",
				   strerror(errno));
1670
	}
1671
	free(buf);
1672
	return ret;
1673 1674
}

1675 1676
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
1677 1678
{
	int i, ret;
1679 1680 1681

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
1682 1683 1684 1685
	if (ret < 0) {
		pr_debug("snprintf() failed: %s\n", strerror(-ret));
		return ret;
	}
1686
	if (!strlist__has_entry(namelist, buf))
1687
		return 0;
1688

1689 1690 1691
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
1692
		return -EEXIST;
1693 1694
	}

1695 1696
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
1697
		ret = e_snprintf(buf, len, "%s_%d", base, i);
1698 1699 1700 1701
		if (ret < 0) {
			pr_debug("snprintf() failed: %s\n", strerror(-ret));
			return ret;
		}
1702 1703 1704
		if (!strlist__has_entry(namelist, buf))
			break;
	}
1705 1706 1707 1708 1709 1710
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
1711 1712
}

1713 1714
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
1715
				     int ntevs, bool allow_suffix)
1716
{
1717
	int i, fd, ret;
1718
	struct probe_trace_event *tev = NULL;
1719 1720
	char buf[64];
	const char *event, *group;
1721
	struct strlist *namelist;
1722

1723
	fd = open_kprobe_events(true);
1724 1725
	if (fd < 0)
		return fd;
1726
	/* Get current event names */
1727
	namelist = get_probe_trace_event_names(fd, false);
1728 1729 1730 1731
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
1732

1733
	ret = 0;
1734
	printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1735
	for (i = 0; i < ntevs; i++) {
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
		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 */
1750 1751 1752 1753
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
1754 1755
		event = buf;

1756 1757 1758 1759 1760 1761
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
1762
		ret = write_probe_trace_event(fd, tev);
1763 1764
		if (ret < 0)
			break;
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
		/* 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;
1785
	}
1786 1787 1788 1789 1790 1791 1792

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

1794
	strlist__delete(namelist);
1795
	close(fd);
1796
	return ret;
1797
}
1798

1799 1800
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
					  struct probe_trace_event **tevs,
1801
					  int max_tevs, const char *module)
1802 1803
{
	struct symbol *sym;
1804
	int ret = 0, i;
1805
	struct probe_trace_event *tev;
1806

1807
	/* Convert perf_probe_event with debuginfo */
1808
	ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
1809
	if (ret != 0)
1810
		return ret;	/* Found in debuginfo or got an error */
1811

1812
	/* Allocate trace event buffer */
1813
	tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1814 1815
	if (tev == NULL)
		return -ENOMEM;
1816 1817

	/* Copy parameters */
1818 1819 1820 1821 1822
	tev->point.symbol = strdup(pev->point.function);
	if (tev->point.symbol == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1823 1824 1825 1826 1827 1828 1829

	if (module) {
		tev->point.module = strdup(module);
		if (tev->point.module == NULL) {
			ret = -ENOMEM;
			goto error;
		}
1830
	}
1831

1832
	tev->point.offset = pev->point.offset;
1833
	tev->point.retprobe = pev->point.retprobe;
1834 1835
	tev->nargs = pev->nargs;
	if (tev->nargs) {
1836
		tev->args = zalloc(sizeof(struct probe_trace_arg)
1837 1838
				   * tev->nargs);
		if (tev->args == NULL) {
1839 1840
			ret = -ENOMEM;
			goto error;
1841
		}
1842
		for (i = 0; i < tev->nargs; i++) {
1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
			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;
				}
			}
1862
		}
1863 1864 1865
	}

	/* Currently just checking function name from symbol map */
1866
	sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1867 1868 1869
	if (!sym) {
		pr_warning("Kernel symbol \'%s\' not found.\n",
			   tev->point.symbol);
1870 1871 1872
		ret = -ENOENT;
		goto error;
	}
1873

1874 1875
	return 1;
error:
1876
	clear_probe_trace_event(tev);
1877 1878
	free(tev);
	*tevs = NULL;
1879
	return ret;
1880 1881 1882 1883
}

struct __event_package {
	struct perf_probe_event		*pev;
1884
	struct probe_trace_event	*tevs;
1885 1886 1887
	int				ntevs;
};

1888
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1889
			  int max_tevs, const char *module, bool force_add)
1890
{
1891
	int i, j, ret;
1892 1893
	struct __event_package *pkgs;

1894 1895 1896
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
	if (pkgs == NULL)
		return -ENOMEM;
1897 1898

	/* Init vmlinux path */
1899
	ret = init_vmlinux();
1900 1901
	if (ret < 0) {
		free(pkgs);
1902
		return ret;
1903
	}
1904 1905 1906 1907 1908

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
1909
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
1910 1911 1912
						     &pkgs[i].tevs,
						     max_tevs,
						     module);
1913 1914 1915
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
1916 1917
	}

1918
	/* Loop 2: add all events */
1919
	for (i = 0; i < npevs; i++) {
1920
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1921
						pkgs[i].ntevs, force_add);
1922 1923 1924
		if (ret < 0)
			break;
	}
1925
end:
1926 1927
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
1928
		for (j = 0; j < pkgs[i].ntevs; j++)
1929
			clear_probe_trace_event(&pkgs[i].tevs[j]);
1930 1931 1932
		free(pkgs[i].tevs);
	}
	free(pkgs);
1933 1934

	return ret;
1935 1936
}

1937
static int __del_trace_probe_event(int fd, struct str_node *ent)
1938 1939 1940
{
	char *p;
	char buf[128];
1941
	int ret;
1942

1943
	/* Convert from perf-probe event to trace-probe event */
1944 1945 1946 1947
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

1948
	p = strchr(buf + 2, ':');
1949 1950 1951 1952 1953 1954
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
1955 1956
	*p = '/';

1957 1958
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
1959 1960 1961
	if (ret < 0)
		goto error;

1962
	printf("Remove event: %s\n", ent->s);
1963 1964 1965 1966
	return 0;
error:
	pr_warning("Failed to delete event: %s\n", strerror(-ret));
	return ret;
1967 1968
}

1969
static int del_trace_probe_event(int fd, const char *group,
1970
				  const char *event, struct strlist *namelist)
1971 1972
{
	char buf[128];
1973
	struct str_node *ent, *n;
1974
	int found = 0, ret = 0;
1975

1976 1977
	ret = e_snprintf(buf, 128, "%s:%s", group, event);
	if (ret < 0) {
M
Masami Hiramatsu 已提交
1978
		pr_err("Failed to copy event.\n");
1979 1980
		return ret;
	}
1981

1982 1983 1984 1985
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
				found++;
1986
				ret = __del_trace_probe_event(fd, ent);
1987 1988
				if (ret < 0)
					break;
1989 1990 1991 1992 1993 1994
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
			found++;
1995
			ret = __del_trace_probe_event(fd, ent);
1996 1997
			if (ret >= 0)
				strlist__remove(namelist, ent);
1998 1999
		}
	}
2000 2001 2002 2003
	if (found == 0 && ret >= 0)
		pr_info("Info: Event \"%s\" does not exist.\n", buf);

	return ret;
2004 2005
}

2006
int del_perf_probe_events(struct strlist *dellist)
2007
{
2008
	int fd, ret = 0;
2009 2010 2011 2012 2013
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
	struct strlist *namelist;

2014
	fd = open_kprobe_events(true);
2015 2016 2017
	if (fd < 0)
		return fd;

2018
	/* Get current event names */
2019
	namelist = get_probe_trace_event_names(fd, true);
2020 2021
	if (namelist == NULL)
		return -EINVAL;
2022

2023
	strlist__for_each(ent, dellist) {
2024 2025 2026 2027 2028
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
			break;
		}
2029
		pr_debug("Parsing: %s\n", str);
2030 2031 2032 2033 2034 2035
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
2036
			group = "*";
2037 2038
			event = str;
		}
2039
		pr_debug("Group: %s, Event: %s\n", group, event);
2040
		ret = del_trace_probe_event(fd, group, event, namelist);
2041
		free(str);
2042 2043
		if (ret < 0)
			break;
2044 2045 2046
	}
	strlist__delete(namelist);
	close(fd);
2047 2048

	return ret;
2049
}
2050 2051
/* TODO: don't use a global variable for filter ... */
static struct strfilter *available_func_filter;
2052

2053
/*
2054 2055
 * If a symbol corresponds to a function with global binding and
 * matches filter return 0. For all others return 1.
2056
 */
2057 2058
static int filter_available_functions(struct map *map __unused,
				      struct symbol *sym)
2059
{
2060 2061 2062 2063
	if (sym->binding == STB_GLOBAL &&
	    strfilter__compare(available_func_filter, sym->name))
		return 0;
	return 1;
2064 2065
}

2066
int show_available_funcs(const char *module, struct strfilter *_filter)
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
{
	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;
	}
2082 2083
	available_func_filter = _filter;
	if (map__load(map, filter_available_functions)) {
2084 2085 2086 2087 2088 2089 2090 2091 2092
		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;
}