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
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

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

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

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

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

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

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

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

73
static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
74
static struct machine machine;
75

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

81 82 83 84 85
	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);
86 87 88 89 90
	ret = symbol__init();
	if (ret < 0) {
		pr_debug("Failed to init symbol map.\n");
		goto out;
	}
91

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

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

106 107 108 109 110 111 112
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);
}

113 114 115 116 117
static struct map *kernel_get_module_map(const char *module)
{
	struct rb_node *nd;
	struct map_groups *grp = &machine.kmaps;

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

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

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

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

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

180 181 182 183 184 185 186 187 188 189 190
	/* 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;
		}
191
	}
192
	return debuginfo__new(path);
193
}
194

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

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

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

	return 0;
236 237
}

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

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

	if (tmp)
		free(tmp);

	return ret;
271 272
}

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

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

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

	debuginfo__delete(dinfo);
295

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

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

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

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

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

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

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

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

381 382 383
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

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

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

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

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

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

422 423 424 425 426
#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)

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

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

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

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

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

470 471 472
	setup_pager();

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

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

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

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

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

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

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

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

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

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

585 586
	setup_pager();

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

	debuginfo__delete(dinfo);
592 593 594
	return ret;
}

595 596
#else	/* !DWARF_SUPPORT */

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

	return 0;
614 615
}

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

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

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

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

657 658 659 660 661
/*
 * Stuff 'lr' according to the line range described by 'arg'.
 * The line range syntax is described by:
 *
 *         SRC[:SLN[+NUM|-ELN]]
662
 *         FNC[@SRC][:SLN[+NUM|-ELN]]
663
 */
664
int parse_line_range_desc(const char *arg, struct line_range *lr)
665
{
666
	char *range, *file, *name = strdup(arg);
667 668 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
	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--;
			}
		}
701

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

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

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

	return 0;
731 732 733
err:
	free(name);
	return err;
734 735
}

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

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

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

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

788 789 790 791
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return ret;
1041 1042
}

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

	return false;
}

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

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

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

1091
	tp->retprobe = (pr == 'r');
1092

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1248 1249 1250 1251
	return buf;
}
#endif

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

}

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

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

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

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

	return buf - tmp;
}

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

1341 1342 1343 1344
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

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

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

1361
	return buf;
1362
error:
1363 1364 1365
	free(buf);
	return NULL;
}
1366

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

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

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

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

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1405 1406 1407 1408 1409
}

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

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

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

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

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

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

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

	return sl;
}

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

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

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

1556
	printf("  %-20s (on %s", buf, place);
1557

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

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

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

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

1590
	fd = open_kprobe_events(false);
1591 1592 1593
	if (fd < 0)
		return fd;

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

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

	return ret;
1614 1615
}

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

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

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

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

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

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

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

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

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

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

	return ret;
1709 1710
}

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

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

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

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

	if (ret >= 0) {
		/* Show how to use the event. */
S
Srikar Dronamraju 已提交
1787
		printf("\nYou can now use it in all perf tools, such as:\n\n");
1788 1789 1790
		printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
			 tev->event);
	}
1791

1792
	strlist__delete(namelist);
1793
	close(fd);
1794
	return ret;
1795
}
1796

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

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

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

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

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

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

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

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

struct __event_package {
	struct perf_probe_event		*pev;
1882
	struct probe_trace_event	*tevs;
1883 1884 1885
	int				ntevs;
};

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

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

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

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

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

	return ret;
1933 1934
}

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

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

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

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

S
Srikar Dronamraju 已提交
1962
	printf("Removed 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;
}