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

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

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

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

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

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

62 63 64 65 66 67 68 69 70 71 72 73
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;
}

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

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

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

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

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

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
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);
}

const char *kernel_get_module_path(const char *module)
{
	struct dso *dso;

	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;
	} else {
		dso = machine.vmlinux_maps[MAP__FUNCTION]->dso;
		if (dso__load_vmlinux_path(dso,
			 machine.vmlinux_maps[MAP__FUNCTION], NULL) < 0) {
			pr_debug("Failed to load kernel map.\n");
			return NULL;
		}
	}
found:
	return dso->long_name;
}

138
#ifdef DWARF_SUPPORT
139
static int open_vmlinux(const char *module)
140
{
141 142
	const char *path = kernel_get_module_path(module);
	if (!path) {
M
Masami Hiramatsu 已提交
143 144
		pr_err("Failed to find path of %s module.\n",
		       module ?: "kernel");
145
		return -ENOENT;
146
	}
147 148
	pr_debug("Try to open %s\n", path);
	return open(path, O_RDONLY);
149
}
150

151 152 153 154 155
/*
 * Convert trace point to probe point with debuginfo
 * Currently only handles kprobes.
 */
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
156
					struct perf_probe_point *pp)
157 158
{
	struct symbol *sym;
159 160 161
	struct map *map;
	u64 addr;
	int ret = -ENOENT;
162

163
	sym = __find_kernel_function_by_name(tp->symbol, &map);
164
	if (sym) {
165 166 167 168
		addr = map->unmap_ip(map, sym->start + tp->offset);
		pr_debug("try to find %s+%ld@%llx\n", tp->symbol,
			 tp->offset, addr);
		ret = find_perf_probe_point((unsigned long)addr, pp);
169 170
	}
	if (ret <= 0) {
171 172
		pr_debug("Failed to find corresponding probes from "
			 "debuginfo. Use kprobe event information.\n");
173 174 175
		pp->function = strdup(tp->symbol);
		if (pp->function == NULL)
			return -ENOMEM;
176 177 178
		pp->offset = tp->offset;
	}
	pp->retprobe = tp->retprobe;
179 180

	return 0;
181 182 183
}

/* Try to find perf_probe_event with debuginfo */
184 185
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
					   struct probe_trace_event **tevs,
186
					   int max_tevs, const char *module)
187 188 189 190
{
	bool need_dwarf = perf_probe_event_need_dwarf(pev);
	int fd, ntevs;

191
	fd = open_vmlinux(module);
192
	if (fd < 0) {
193 194 195 196
		if (need_dwarf) {
			pr_warning("Failed to open debuginfo file.\n");
			return fd;
		}
197 198 199 200 201
		pr_debug("Could not open vmlinux. Try to use symbols.\n");
		return 0;
	}

	/* Searching trace events corresponding to probe event */
202
	ntevs = find_probe_trace_events(fd, pev, tevs, max_tevs);
203 204
	close(fd);

205
	if (ntevs > 0) {	/* Succeeded to find trace events */
206
		pr_debug("find %d probe_trace_events.\n", ntevs);
207
		return ntevs;
208
	}
209

210 211 212 213 214 215
	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 */
216 217 218 219 220
	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 已提交
221
			pr_debug("Trying to use symbols.\n");
222 223
			return 0;
		}
224
	}
225
	return ntevs;
226 227
}

228 229 230 231 232 233
/*
 * 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.
 */
234 235
static int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
236
{
237 238 239 240 241 242 243 244 245 246 247 248 249
	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;
		}
250 251
	}

252
	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
253 254 255 256
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
257
		sprintf(*new_path, "%s/%s", prefix, raw_path);
258 259 260 261

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

262 263 264 265
		if (!symbol_conf.source_prefix)
			/* In case of searching comp_dir, don't retry */
			return -errno;

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
		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;
		}
	}
}

287 288 289
#define LINEBUF_SIZE 256
#define NR_ADDITIONAL_LINES 2

290
static int show_one_line(FILE *fp, int l, bool skip, bool show_num)
291 292
{
	char buf[LINEBUF_SIZE];
293 294
	const char *color = show_num ? "" : PERF_COLOR_BLUE;
	const char *prefix = NULL;
295

296
	do {
297 298
		if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
			goto error;
299 300 301 302 303
		if (skip)
			continue;
		if (!prefix) {
			prefix = show_num ? "%7d  " : "         ";
			color_fprintf(stdout, color, prefix, l);
304
		}
305 306 307
		color_fprintf(stdout, color, "%s", buf);

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

	return 0;
310 311
error:
	if (feof(fp))
312
		pr_warning("Source file is shorter than expected.\n");
313
	else
314 315 316
		pr_warning("File read error: %s\n", strerror(errno));

	return -1;
317 318 319 320 321 322
}

/*
 * Show line-range always requires debuginfo to find source file and
 * line number.
 */
323
int show_line_range(struct line_range *lr, const char *module)
324
{
325
	int l = 1;
326 327 328
	struct line_node *ln;
	FILE *fp;
	int fd, ret;
329
	char *tmp;
330 331

	/* Search a line range */
332 333 334 335
	ret = init_vmlinux();
	if (ret < 0)
		return ret;

336
	fd = open_vmlinux(module);
337 338 339 340 341
	if (fd < 0) {
		pr_warning("Failed to open debuginfo file.\n");
		return fd;
	}

342 343
	ret = find_line_range(fd, lr);
	close(fd);
344 345 346 347 348 349 350
	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;
	}
351

352 353
	/* Convert source file path */
	tmp = lr->path;
354
	ret = get_real_path(tmp, lr->comp_dir, &lr->path);
355 356 357 358 359 360
	free(tmp);	/* Free old path */
	if (ret < 0) {
		pr_warning("Failed to find source file. (%d)\n", ret);
		return ret;
	}

361 362 363 364 365 366
	setup_pager();

	if (lr->function)
		fprintf(stdout, "<%s:%d>\n", lr->function,
			lr->start - lr->offset);
	else
367
		fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
368 369

	fp = fopen(lr->path, "r");
370 371 372 373 374
	if (fp == NULL) {
		pr_warning("Failed to open %s: %s\n", lr->path,
			   strerror(errno));
		return -errno;
	}
375
	/* Skip to starting line number */
376 377 378 379
	while (l < lr->start && ret >= 0)
		ret = show_one_line(fp, l++, true, false);
	if (ret < 0)
		goto end;
380 381

	list_for_each_entry(ln, &lr->line_list, list) {
382 383 384 385 386 387 388 389
		while (ln->line > l && ret >= 0)
			ret = show_one_line(fp, (l++) - lr->offset,
					    false, false);
		if (ret >= 0)
			ret = show_one_line(fp, (l++) - lr->offset,
					    false, true);
		if (ret < 0)
			goto end;
390 391 392 393
	}

	if (lr->end == INT_MAX)
		lr->end = l + NR_ADDITIONAL_LINES;
394
	while (l <= lr->end && !feof(fp) && ret >= 0)
395 396
		ret = show_one_line(fp, (l++) - lr->offset, false, false);
end:
397
	fclose(fp);
398
	return ret;
399 400
}

401
static int show_available_vars_at(int fd, struct perf_probe_event *pev,
402
				  int max_vls, bool externs)
403 404 405 406 407 408 409 410 411 412 413
{
	char *buf;
	int ret, i;
	struct str_node *node;
	struct variable_list *vls = NULL, *vl;

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

414
	ret = find_available_vars_at(fd, pev, &vls, max_vls, externs);
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
	if (ret > 0) {
		/* Some variables were 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);
			if (vl->vars) {
				strlist__for_each(node, vl->vars)
					fprintf(stdout, "\t\t%s\n", node->s);
				strlist__delete(vl->vars);
			} else
				fprintf(stdout, "(No variables)\n");
		}
		free(vls);
	} else
		pr_err("Failed to find variables at %s (%d)\n", buf, ret);

	free(buf);
	return ret;
}

/* Show available variables on given probe point */
int show_available_vars(struct perf_probe_event *pevs, int npevs,
444
			int max_vls, const char *module, bool externs)
445 446 447 448 449 450 451
{
	int i, fd, ret = 0;

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

452
	fd = open_vmlinux(module);
453
	if (fd < 0) {
M
Masami Hiramatsu 已提交
454
		pr_warning("Failed to open debug information file.\n");
455 456 457 458 459 460
		return fd;
	}

	setup_pager();

	for (i = 0; i < npevs && ret >= 0; i++)
461
		ret = show_available_vars_at(fd, &pevs[i], max_vls, externs);
462 463 464 465 466

	close(fd);
	return ret;
}

467 468
#else	/* !DWARF_SUPPORT */

469
static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
470
					struct perf_probe_point *pp)
471
{
472 473 474 475 476 477 478
	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;
	}
479 480 481
	pp->function = strdup(tp->symbol);
	if (pp->function == NULL)
		return -ENOMEM;
482 483
	pp->offset = tp->offset;
	pp->retprobe = tp->retprobe;
484 485

	return 0;
486 487
}

488 489
static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
				struct probe_trace_event **tevs __unused,
490
				int max_tevs __unused, const char *mod __unused)
491
{
492 493 494 495
	if (perf_probe_event_need_dwarf(pev)) {
		pr_warning("Debuginfo-analysis is not supported.\n");
		return -ENOSYS;
	}
496 497 498
	return 0;
}

499
int show_line_range(struct line_range *lr __unused, const char *module __unused)
500
{
501 502
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
503 504
}

505
int show_available_vars(struct perf_probe_event *pevs __unused,
506 507
			int npevs __unused, int max_vls __unused,
			const char *module __unused, bool externs __unused)
508 509 510 511
{
	pr_warning("Debuginfo-analysis is not supported.\n");
	return -ENOSYS;
}
512 513
#endif

514
int parse_line_range_desc(const char *arg, struct line_range *lr)
515 516 517 518 519 520 521 522 523 524
{
	const char *ptr;
	char *tmp;
	/*
	 * <Syntax>
	 * SRC:SLN[+NUM|-ELN]
	 * FUNC[:SLN[+NUM|-ELN]]
	 */
	ptr = strchr(arg, ':');
	if (ptr) {
525
		lr->start = (int)strtoul(ptr + 1, &tmp, 0);
526
		if (*tmp == '+') {
527
			lr->end = lr->start + (int)strtoul(tmp + 1, &tmp, 0);
528 529 530 531 532 533 534
			lr->end--;	/*
					 * 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.
					 */
		} else if (*tmp == '-')
535
			lr->end = (int)strtoul(tmp + 1, &tmp, 0);
536
		else
537 538 539
			lr->end = INT_MAX;
		pr_debug("Line range is %d to %d\n", lr->start, lr->end);
		if (lr->start > lr->end) {
540
			semantic_error("Start line must be smaller"
541 542 543 544 545
				       " than end line.\n");
			return -EINVAL;
		}
		if (*tmp != '\0') {
			semantic_error("Tailing with invalid character '%d'.\n",
546
				       *tmp);
547 548
			return -EINVAL;
		}
549
		tmp = strndup(arg, (ptr - arg));
550
	} else {
551
		tmp = strdup(arg);
552 553
		lr->end = INT_MAX;
	}
554 555 556

	if (tmp == NULL)
		return -ENOMEM;
557 558 559 560 561

	if (strchr(tmp, '.'))
		lr->file = tmp;
	else
		lr->function = tmp;
562 563

	return 0;
564 565
}

566 567 568 569 570 571 572 573 574 575 576 577
/* 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;
}

578
/* Parse probepoint definition. */
579
static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
580
{
581
	struct perf_probe_point *pp = &pev->point;
582 583 584 585
	char *ptr, *tmp;
	char c, nc = 0;
	/*
	 * <Syntax>
586 587
	 * perf probe [EVENT=]SRC[:LN|;PTN]
	 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
588 589
	 *
	 * TODO:Group name support
590 591
	 */

592 593
	ptr = strpbrk(arg, ";=@+%");
	if (ptr && *ptr == '=') {	/* Event name */
594 595
		*ptr = '\0';
		tmp = ptr + 1;
596 597 598 599 600
		if (strchr(arg, ':')) {
			semantic_error("Group name is not supported yet.\n");
			return -ENOTSUP;
		}
		if (!check_event_name(arg)) {
601
			semantic_error("%s is bad for event name -it must "
602 603 604
				       "follow C symbol-naming rule.\n", arg);
			return -EINVAL;
		}
605 606 607
		pev->event = strdup(arg);
		if (pev->event == NULL)
			return -ENOMEM;
608
		pev->group = NULL;
609 610 611
		arg = tmp;
	}

612
	ptr = strpbrk(arg, ";:+@%");
613 614 615 616 617
	if (ptr) {
		nc = *ptr;
		*ptr++ = '\0';
	}

618 619 620 621
	tmp = strdup(arg);
	if (tmp == NULL)
		return -ENOMEM;

622
	/* Check arg is function or file and copy it */
623 624
	if (strchr(tmp, '.'))	/* File */
		pp->file = tmp;
625
	else			/* Function */
626
		pp->function = tmp;
627 628 629 630 631

	/* Parse other options */
	while (ptr) {
		arg = ptr;
		c = nc;
632
		if (c == ';') {	/* Lazy pattern must be the last part */
633 634 635
			pp->lazy_line = strdup(arg);
			if (pp->lazy_line == NULL)
				return -ENOMEM;
636 637 638
			break;
		}
		ptr = strpbrk(arg, ";:+@%");
639 640 641 642 643 644 645
		if (ptr) {
			nc = *ptr;
			*ptr++ = '\0';
		}
		switch (c) {
		case ':':	/* Line number */
			pp->line = strtoul(arg, &tmp, 0);
646
			if (*tmp != '\0') {
647
				semantic_error("There is non-digit char"
648 649 650
					       " in line number.\n");
				return -EINVAL;
			}
651 652 653
			break;
		case '+':	/* Byte offset from a symbol */
			pp->offset = strtoul(arg, &tmp, 0);
654
			if (*tmp != '\0') {
655
				semantic_error("There is non-digit character"
656 657 658
						" in offset.\n");
				return -EINVAL;
			}
659 660
			break;
		case '@':	/* File name */
661 662 663 664
			if (pp->file) {
				semantic_error("SRC@SRC is not allowed.\n");
				return -EINVAL;
			}
665 666 667
			pp->file = strdup(arg);
			if (pp->file == NULL)
				return -ENOMEM;
668 669 670 671
			break;
		case '%':	/* Probe places */
			if (strcmp(arg, "return") == 0) {
				pp->retprobe = 1;
672 673 674 675
			} else {	/* Others not supported yet */
				semantic_error("%%%s is not supported.\n", arg);
				return -ENOTSUP;
			}
676
			break;
677 678 679 680
		default:	/* Buggy case */
			pr_err("This program has a bug at %s:%d.\n",
				__FILE__, __LINE__);
			return -ENOTSUP;
681 682 683 684 685
			break;
		}
	}

	/* Exclusion check */
686
	if (pp->lazy_line && pp->line) {
M
Masami Hiramatsu 已提交
687 688
		semantic_error("Lazy pattern can't be used with"
			       " line number.\n");
689 690
		return -EINVAL;
	}
691

692
	if (pp->lazy_line && pp->offset) {
M
Masami Hiramatsu 已提交
693
		semantic_error("Lazy pattern can't be used with offset.\n");
694 695
		return -EINVAL;
	}
696

697
	if (pp->line && pp->offset) {
M
Masami Hiramatsu 已提交
698
		semantic_error("Offset can't be used with line number.\n");
699 700
		return -EINVAL;
	}
701

702
	if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
703
		semantic_error("File always requires line number or "
M
Masami Hiramatsu 已提交
704
			       "lazy pattern.\n");
705 706
		return -EINVAL;
	}
707

708
	if (pp->offset && !pp->function) {
M
Masami Hiramatsu 已提交
709
		semantic_error("Offset requires an entry function.\n");
710 711
		return -EINVAL;
	}
712

713
	if (pp->retprobe && !pp->function) {
M
Masami Hiramatsu 已提交
714
		semantic_error("Return probe requires an entry function.\n");
715 716
		return -EINVAL;
	}
717

718
	if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
719
		semantic_error("Offset/Line/Lazy pattern can't be used with "
M
Masami Hiramatsu 已提交
720
			       "return probe.\n");
721 722
		return -EINVAL;
	}
723

724
	pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
725 726
		 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
		 pp->lazy_line);
727
	return 0;
728 729
}

730
/* Parse perf-probe event argument */
731
static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
732
{
733
	char *tmp, *goodname;
734 735 736 737
	struct perf_probe_arg_field **fieldp;

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

738 739
	tmp = strchr(str, '=');
	if (tmp) {
740 741 742
		arg->name = strndup(str, tmp - str);
		if (arg->name == NULL)
			return -ENOMEM;
743
		pr_debug("name:%s ", arg->name);
744 745 746
		str = tmp + 1;
	}

747 748 749
	tmp = strchr(str, ':');
	if (tmp) {	/* Type setting */
		*tmp = '\0';
750 751 752
		arg->type = strdup(tmp + 1);
		if (arg->type == NULL)
			return -ENOMEM;
753 754 755
		pr_debug("type:%s ", arg->type);
	}

756
	tmp = strpbrk(str, "-.[");
757 758
	if (!is_c_varname(str) || !tmp) {
		/* A variable, register, symbol or special value */
759 760 761
		arg->var = strdup(str);
		if (arg->var == NULL)
			return -ENOMEM;
762
		pr_debug("%s\n", arg->var);
763
		return 0;
764 765
	}

766
	/* Structure fields or array element */
767 768 769
	arg->var = strndup(str, tmp - str);
	if (arg->var == NULL)
		return -ENOMEM;
770
	goodname = arg->var;
771
	pr_debug("%s, ", arg->var);
772 773 774
	fieldp = &arg->field;

	do {
775 776 777
		*fieldp = zalloc(sizeof(struct perf_probe_arg_field));
		if (*fieldp == NULL)
			return -ENOMEM;
778 779 780
		if (*tmp == '[') {	/* Array */
			str = tmp;
			(*fieldp)->index = strtol(str + 1, &tmp, 0);
781
			(*fieldp)->ref = true;
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
			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, "-.[");
803
		}
804
		if (tmp) {
805 806 807
			(*fieldp)->name = strndup(str, tmp - str);
			if ((*fieldp)->name == NULL)
				return -ENOMEM;
808 809
			if (*str != '[')
				goodname = (*fieldp)->name;
810 811 812 813
			pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
			fieldp = &(*fieldp)->next;
		}
	} while (tmp);
814 815 816
	(*fieldp)->name = strdup(str);
	if ((*fieldp)->name == NULL)
		return -ENOMEM;
817 818
	if (*str != '[')
		goodname = (*fieldp)->name;
819
	pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
820

821
	/* If no name is specified, set the last field name (not array index)*/
822
	if (!arg->name) {
823
		arg->name = strdup(goodname);
824 825 826
		if (arg->name == NULL)
			return -ENOMEM;
	}
827
	return 0;
828 829
}

830
/* Parse perf-probe event command */
831
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
832
{
833
	char **argv;
834
	int argc, i, ret = 0;
835

836
	argv = argv_split(cmd, &argc);
837 838 839 840 841 842 843 844 845
	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;
	}
846
	/* Parse probe point */
847 848 849
	ret = parse_perf_probe_point(argv[0], pev);
	if (ret < 0)
		goto out;
850

851
	/* Copy arguments and ensure return probe has no C argument */
852
	pev->nargs = argc - 1;
853 854 855 856 857
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
858 859 860 861
	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) {
862
			semantic_error("You can't specify local variable for"
863 864 865
				       " kretprobe.\n");
			ret = -EINVAL;
		}
866
	}
867
out:
868
	argv_free(argv);
869 870

	return ret;
871 872
}

873 874 875 876 877 878 879 880 881
/* 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++)
882
		if (is_c_varname(pev->args[i].var))
883 884 885 886 887
			return true;

	return false;
}

888 889 890
/* Parse probe_events event into struct probe_point */
static int parse_probe_trace_command(const char *cmd,
					struct probe_trace_event *tev)
891
{
892
	struct probe_trace_point *tp = &tev->point;
893 894 895 896 897
	char pr;
	char *p;
	int ret, i, argc;
	char **argv;

898
	pr_debug("Parsing probe_events: %s\n", cmd);
899
	argv = argv_split(cmd, &argc);
900 901 902 903 904 905 906 907 908
	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;
	}
909 910

	/* Scan event and group name. */
911
	ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
912 913
		     &pr, (float *)(void *)&tev->group,
		     (float *)(void *)&tev->event);
914 915 916 917 918
	if (ret != 3) {
		semantic_error("Failed to parse event name: %s\n", argv[0]);
		ret = -EINVAL;
		goto out;
	}
919
	pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
920

921
	tp->retprobe = (pr == 'r');
922 923

	/* Scan function name and offset */
924 925
	ret = sscanf(argv[1], "%a[^+]+%lu", (float *)(void *)&tp->symbol,
		     &tp->offset);
926
	if (ret == 1)
927
		tp->offset = 0;
928

929
	tev->nargs = argc - 2;
930
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
931 932 933 934
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto out;
	}
935
	for (i = 0; i < tev->nargs; i++) {
936 937
		p = strchr(argv[i + 2], '=');
		if (p)	/* We don't need which register is assigned. */
938 939 940
			*p++ = '\0';
		else
			p = argv[i + 2];
941
		tev->args[i].name = strdup(argv[i + 2]);
942
		/* TODO: parse regs and offset */
943 944 945 946 947
		tev->args[i].value = strdup(p);
		if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
			ret = -ENOMEM;
			goto out;
		}
948
	}
949 950
	ret = 0;
out:
951
	argv_free(argv);
952
	return ret;
953 954
}

955 956 957 958 959 960 961
/* 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;

962 963 964 965
	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);
966 967 968 969 970 971
	if (ret <= 0)
		goto error;
	tmp += ret;
	len -= ret;

	while (field) {
972 973 974 975 976
		if (field->name[0] == '[')
			ret = e_snprintf(tmp, len, "%s", field->name);
		else
			ret = e_snprintf(tmp, len, "%s%s",
					 field->ref ? "->" : ".", field->name);
977 978 979 980 981 982
		if (ret <= 0)
			goto error;
		tmp += ret;
		len -= ret;
		field = field->next;
	}
983 984 985 986 987 988 989 990 991

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

992 993
	return tmp - buf;
error:
M
Masami Hiramatsu 已提交
994
	pr_debug("Failed to synthesize perf probe argument: %s\n",
995 996
		 strerror(-ret));
	return ret;
997 998
}

999 1000
/* Compose only probe point (not argument) */
static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1001
{
1002 1003 1004
	char *buf, *tmp;
	char offs[32] = "", line[32] = "", file[32] = "";
	int ret, len;
1005

1006 1007 1008 1009 1010
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1011
	if (pp->offset) {
1012
		ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1013 1014 1015 1016
		if (ret <= 0)
			goto error;
	}
	if (pp->line) {
1017 1018 1019 1020 1021
		ret = e_snprintf(line, 32, ":%d", pp->line);
		if (ret <= 0)
			goto error;
	}
	if (pp->file) {
1022
		len = strlen(pp->file) - 31;
1023 1024 1025 1026
		if (len < 0)
			len = 0;
		tmp = strchr(pp->file + len, '/');
		if (!tmp)
1027
			tmp = pp->file + len;
1028
		ret = e_snprintf(file, 32, "@%s", tmp + 1);
1029 1030 1031 1032 1033
		if (ret <= 0)
			goto error;
	}

	if (pp->function)
1034 1035 1036
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
				 offs, pp->retprobe ? "%return" : "", line,
				 file);
1037
	else
1038
		ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1039 1040 1041 1042
	if (ret <= 0)
		goto error;

	return buf;
1043
error:
M
Masami Hiramatsu 已提交
1044
	pr_debug("Failed to synthesize perf probe point: %s\n",
1045
		 strerror(-ret));
1046 1047
	if (buf)
		free(buf);
1048
	return NULL;
1049 1050
}

1051 1052
#if 0
char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1053 1054 1055 1056
{
	char *buf;
	int i, len, ret;

1057 1058 1059
	buf = synthesize_perf_probe_point(&pev->point);
	if (!buf)
		return NULL;
1060

1061 1062
	len = strlen(buf);
	for (i = 0; i < pev->nargs; i++) {
1063
		ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1064 1065 1066 1067 1068
				 pev->args[i].name);
		if (ret <= 0) {
			free(buf);
			return NULL;
		}
1069 1070 1071
		len += ret;
	}

1072 1073 1074 1075
	return buf;
}
#endif

1076
static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1077 1078 1079 1080 1081
					     char **buf, size_t *buflen,
					     int depth)
{
	int ret;
	if (ref->next) {
1082
		depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
							 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;
1097 1098 1099

}

1100
static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1101
				       char *buf, size_t buflen)
1102
{
1103
	struct probe_trace_arg_ref *ref = arg->ref;
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	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;

1117 1118 1119 1120
	/* Special case: @XXX */
	if (arg->value[0] == '@' && arg->ref)
			ref = ref->next;

1121
	/* Dereferencing arguments */
1122
	if (ref) {
1123
		depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1124 1125 1126 1127 1128 1129
							  &buflen, 1);
		if (depth < 0)
			return depth;
	}

	/* Print argument value */
1130 1131 1132 1133 1134
	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);
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
	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;
	}
1148 1149 1150 1151 1152 1153 1154
	/* Print argument type */
	if (arg->type) {
		ret = e_snprintf(buf, buflen, ":%s", arg->type);
		if (ret <= 0)
			return ret;
		buf += ret;
	}
1155 1156 1157 1158

	return buf - tmp;
}

1159
char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1160
{
1161
	struct probe_trace_point *tp = &tev->point;
1162 1163 1164
	char *buf;
	int i, len, ret;

1165 1166 1167 1168
	buf = zalloc(MAX_CMDLEN);
	if (buf == NULL)
		return NULL;

1169 1170 1171 1172 1173
	len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s+%lu",
			 tp->retprobe ? 'r' : 'p',
			 tev->group, tev->event,
			 tp->symbol, tp->offset);
	if (len <= 0)
1174 1175
		goto error;

1176
	for (i = 0; i < tev->nargs; i++) {
1177
		ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1178
						  MAX_CMDLEN - len);
1179
		if (ret <= 0)
1180 1181 1182 1183
			goto error;
		len += ret;
	}

1184
	return buf;
1185
error:
1186 1187 1188
	free(buf);
	return NULL;
}
1189

1190
static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1191
				       struct perf_probe_event *pev)
1192
{
1193
	char buf[64] = "";
1194
	int i, ret;
1195

1196
	/* Convert event/group name */
1197 1198 1199 1200
	pev->event = strdup(tev->event);
	pev->group = strdup(tev->group);
	if (pev->event == NULL || pev->group == NULL)
		return -ENOMEM;
1201

1202
	/* Convert trace_point to probe_point */
1203
	ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1204 1205
	if (ret < 0)
		return ret;
1206

1207 1208
	/* Convert trace_arg to probe_arg */
	pev->nargs = tev->nargs;
1209 1210 1211
	pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
	if (pev->args == NULL)
		return -ENOMEM;
1212
	for (i = 0; i < tev->nargs && ret >= 0; i++) {
1213
		if (tev->args[i].name)
1214
			pev->args[i].name = strdup(tev->args[i].name);
1215
		else {
1216
			ret = synthesize_probe_trace_arg(&tev->args[i],
1217
							  buf, 64);
1218
			pev->args[i].name = strdup(buf);
1219
		}
1220 1221 1222
		if (pev->args[i].name == NULL && ret >= 0)
			ret = -ENOMEM;
	}
1223 1224 1225 1226 1227

	if (ret < 0)
		clear_perf_probe_event(pev);

	return ret;
1228 1229 1230 1231 1232
}

void clear_perf_probe_event(struct perf_probe_event *pev)
{
	struct perf_probe_point *pp = &pev->point;
1233
	struct perf_probe_arg_field *field, *next;
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
	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);
1246
	for (i = 0; i < pev->nargs; i++) {
1247 1248
		if (pev->args[i].name)
			free(pev->args[i].name);
1249 1250
		if (pev->args[i].var)
			free(pev->args[i].var);
1251 1252
		if (pev->args[i].type)
			free(pev->args[i].type);
1253 1254 1255 1256 1257 1258 1259 1260 1261
		field = pev->args[i].field;
		while (field) {
			next = field->next;
			if (field->name)
				free(field->name);
			free(field);
			field = next;
		}
	}
1262 1263 1264 1265 1266
	if (pev->args)
		free(pev->args);
	memset(pev, 0, sizeof(*pev));
}

1267
static void clear_probe_trace_event(struct probe_trace_event *tev)
1268
{
1269
	struct probe_trace_arg_ref *ref, *next;
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
	int i;

	if (tev->event)
		free(tev->event);
	if (tev->group)
		free(tev->group);
	if (tev->point.symbol)
		free(tev->point.symbol);
	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);
1283 1284
		if (tev->args[i].type)
			free(tev->args[i].type);
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
		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));
1295 1296
}

1297
static int open_kprobe_events(bool readwrite)
1298 1299
{
	char buf[PATH_MAX];
1300
	const char *__debugfs;
1301 1302
	int ret;

1303 1304 1305 1306 1307 1308 1309
	__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);
1310
	if (ret >= 0) {
1311
		pr_debug("Opening %s write=%d\n", buf, readwrite);
1312 1313 1314 1315 1316
		if (readwrite && !probe_event_dry_run)
			ret = open(buf, O_RDWR, O_APPEND);
		else
			ret = open(buf, O_RDONLY, 0);
	}
1317

1318 1319
	if (ret < 0) {
		if (errno == ENOENT)
1320 1321
			pr_warning("kprobe_events file does not exist - please"
				 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1322
		else
1323 1324
			pr_warning("Failed to open kprobe_events file: %s\n",
				   strerror(errno));
1325 1326 1327 1328 1329
	}
	return ret;
}

/* Get raw string list of current kprobe_events */
1330
static struct strlist *get_probe_trace_command_rawlist(int fd)
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
{
	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);
1350 1351 1352 1353 1354
		if (ret < 0) {
			pr_debug("strlist__add failed: %s\n", strerror(-ret));
			strlist__delete(sl);
			return NULL;
		}
1355 1356 1357 1358 1359 1360
	}
	fclose(fp);

	return sl;
}

1361
/* Show an event */
1362
static int show_perf_probe_event(struct perf_probe_event *pev)
1363
{
1364
	int i, ret;
1365
	char buf[128];
1366
	char *place;
1367

1368 1369
	/* Synthesize only event probe point */
	place = synthesize_perf_probe_point(&pev->point);
1370 1371
	if (!place)
		return -EINVAL;
1372 1373

	ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1374
	if (ret < 0)
1375 1376
		return ret;

1377
	printf("  %-20s (on %s", buf, place);
1378

1379
	if (pev->nargs > 0) {
1380
		printf(" with");
1381
		for (i = 0; i < pev->nargs; i++) {
1382 1383 1384 1385
			ret = synthesize_perf_probe_arg(&pev->args[i],
							buf, 128);
			if (ret < 0)
				break;
1386 1387
			printf(" %s", buf);
		}
1388 1389
	}
	printf(")\n");
1390
	free(place);
1391
	return ret;
1392 1393
}

1394
/* List up current perf-probe events */
1395
int show_perf_probe_events(void)
1396
{
1397
	int fd, ret;
1398
	struct probe_trace_event tev;
1399
	struct perf_probe_event pev;
1400 1401 1402
	struct strlist *rawlist;
	struct str_node *ent;

1403
	setup_pager();
1404 1405 1406
	ret = init_vmlinux();
	if (ret < 0)
		return ret;
1407 1408 1409

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

1411
	fd = open_kprobe_events(false);
1412 1413 1414
	if (fd < 0)
		return fd;

1415
	rawlist = get_probe_trace_command_rawlist(fd);
1416
	close(fd);
1417 1418
	if (!rawlist)
		return -ENOENT;
1419

1420
	strlist__for_each(ent, rawlist) {
1421
		ret = parse_probe_trace_command(ent->s, &tev);
1422 1423 1424 1425 1426
		if (ret >= 0) {
			ret = convert_to_perf_probe_event(&tev, &pev);
			if (ret >= 0)
				ret = show_perf_probe_event(&pev);
		}
1427
		clear_perf_probe_event(&pev);
1428
		clear_probe_trace_event(&tev);
1429 1430
		if (ret < 0)
			break;
1431 1432
	}
	strlist__delete(rawlist);
1433 1434

	return ret;
1435 1436
}

1437
/* Get current perf-probe event names */
1438
static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1439
{
1440
	char buf[128];
1441 1442
	struct strlist *sl, *rawlist;
	struct str_node *ent;
1443
	struct probe_trace_event tev;
1444
	int ret = 0;
1445

1446
	memset(&tev, 0, sizeof(tev));
1447
	rawlist = get_probe_trace_command_rawlist(fd);
1448
	sl = strlist__new(true, NULL);
1449
	strlist__for_each(ent, rawlist) {
1450
		ret = parse_probe_trace_command(ent->s, &tev);
1451 1452
		if (ret < 0)
			break;
1453
		if (include_group) {
1454 1455 1456 1457
			ret = e_snprintf(buf, 128, "%s:%s", tev.group,
					tev.event);
			if (ret >= 0)
				ret = strlist__add(sl, buf);
1458
		} else
1459
			ret = strlist__add(sl, tev.event);
1460
		clear_probe_trace_event(&tev);
1461 1462
		if (ret < 0)
			break;
1463 1464 1465
	}
	strlist__delete(rawlist);

1466 1467 1468 1469
	if (ret < 0) {
		strlist__delete(sl);
		return NULL;
	}
1470 1471 1472
	return sl;
}

1473
static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1474
{
1475
	int ret = 0;
1476
	char *buf = synthesize_probe_trace_command(tev);
1477

1478
	if (!buf) {
1479
		pr_debug("Failed to synthesize probe trace event.\n");
1480 1481 1482
		return -EINVAL;
	}

1483
	pr_debug("Writing event: %s\n", buf);
1484 1485 1486
	if (!probe_event_dry_run) {
		ret = write(fd, buf, strlen(buf));
		if (ret <= 0)
1487 1488
			pr_warning("Failed to write event: %s\n",
				   strerror(errno));
1489
	}
1490
	free(buf);
1491
	return ret;
1492 1493
}

1494 1495
static int get_new_event_name(char *buf, size_t len, const char *base,
			      struct strlist *namelist, bool allow_suffix)
1496 1497
{
	int i, ret;
1498 1499 1500

	/* Try no suffix */
	ret = e_snprintf(buf, len, "%s", base);
1501 1502 1503 1504
	if (ret < 0) {
		pr_debug("snprintf() failed: %s\n", strerror(-ret));
		return ret;
	}
1505
	if (!strlist__has_entry(namelist, buf))
1506
		return 0;
1507

1508 1509 1510
	if (!allow_suffix) {
		pr_warning("Error: event \"%s\" already exists. "
			   "(Use -f to force duplicates.)\n", base);
1511
		return -EEXIST;
1512 1513
	}

1514 1515
	/* Try to add suffix */
	for (i = 1; i < MAX_EVENT_INDEX; i++) {
1516
		ret = e_snprintf(buf, len, "%s_%d", base, i);
1517 1518 1519 1520
		if (ret < 0) {
			pr_debug("snprintf() failed: %s\n", strerror(-ret));
			return ret;
		}
1521 1522 1523
		if (!strlist__has_entry(namelist, buf))
			break;
	}
1524 1525 1526 1527 1528 1529
	if (i == MAX_EVENT_INDEX) {
		pr_warning("Too many events are on the same function.\n");
		ret = -ERANGE;
	}

	return ret;
1530 1531
}

1532 1533
static int __add_probe_trace_events(struct perf_probe_event *pev,
				     struct probe_trace_event *tevs,
1534
				     int ntevs, bool allow_suffix)
1535
{
1536
	int i, fd, ret;
1537
	struct probe_trace_event *tev = NULL;
1538 1539
	char buf[64];
	const char *event, *group;
1540
	struct strlist *namelist;
1541

1542
	fd = open_kprobe_events(true);
1543 1544
	if (fd < 0)
		return fd;
1545
	/* Get current event names */
1546
	namelist = get_probe_trace_event_names(fd, false);
1547 1548 1549 1550
	if (!namelist) {
		pr_debug("Failed to get current event list.\n");
		return -EIO;
	}
1551

1552
	ret = 0;
1553
	printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1554
	for (i = 0; i < ntevs; i++) {
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
		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 */
1569 1570 1571 1572
		ret = get_new_event_name(buf, 64, event,
					 namelist, allow_suffix);
		if (ret < 0)
			break;
1573 1574
		event = buf;

1575 1576 1577 1578 1579 1580
		tev->event = strdup(event);
		tev->group = strdup(group);
		if (tev->event == NULL || tev->group == NULL) {
			ret = -ENOMEM;
			break;
		}
1581
		ret = write_probe_trace_event(fd, tev);
1582 1583
		if (ret < 0)
			break;
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
		/* 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;
1604
	}
1605 1606 1607 1608 1609 1610 1611

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

1613
	strlist__delete(namelist);
1614
	close(fd);
1615
	return ret;
1616
}
1617

1618 1619
static int convert_to_probe_trace_events(struct perf_probe_event *pev,
					  struct probe_trace_event **tevs,
1620
					  int max_tevs, const char *module)
1621 1622
{
	struct symbol *sym;
1623
	int ret = 0, i;
1624
	struct probe_trace_event *tev;
1625

1626
	/* Convert perf_probe_event with debuginfo */
1627
	ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, module);
1628 1629
	if (ret != 0)
		return ret;
1630

1631
	/* Allocate trace event buffer */
1632
	tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1633 1634
	if (tev == NULL)
		return -ENOMEM;
1635 1636

	/* Copy parameters */
1637 1638 1639 1640 1641
	tev->point.symbol = strdup(pev->point.function);
	if (tev->point.symbol == NULL) {
		ret = -ENOMEM;
		goto error;
	}
1642
	tev->point.offset = pev->point.offset;
1643
	tev->point.retprobe = pev->point.retprobe;
1644 1645
	tev->nargs = pev->nargs;
	if (tev->nargs) {
1646
		tev->args = zalloc(sizeof(struct probe_trace_arg)
1647 1648
				   * tev->nargs);
		if (tev->args == NULL) {
1649 1650
			ret = -ENOMEM;
			goto error;
1651
		}
1652
		for (i = 0; i < tev->nargs; i++) {
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
			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;
				}
			}
1672
		}
1673 1674 1675
	}

	/* Currently just checking function name from symbol map */
1676
	sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1677 1678 1679
	if (!sym) {
		pr_warning("Kernel symbol \'%s\' not found.\n",
			   tev->point.symbol);
1680 1681 1682
		ret = -ENOENT;
		goto error;
	}
1683

1684 1685
	return 1;
error:
1686
	clear_probe_trace_event(tev);
1687 1688
	free(tev);
	*tevs = NULL;
1689
	return ret;
1690 1691 1692 1693
}

struct __event_package {
	struct perf_probe_event		*pev;
1694
	struct probe_trace_event	*tevs;
1695 1696 1697
	int				ntevs;
};

1698
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1699
			  int max_tevs, const char *module, bool force_add)
1700
{
1701
	int i, j, ret;
1702 1703
	struct __event_package *pkgs;

1704 1705 1706
	pkgs = zalloc(sizeof(struct __event_package) * npevs);
	if (pkgs == NULL)
		return -ENOMEM;
1707 1708

	/* Init vmlinux path */
1709
	ret = init_vmlinux();
1710 1711
	if (ret < 0) {
		free(pkgs);
1712
		return ret;
1713
	}
1714 1715 1716 1717 1718

	/* Loop 1: convert all events */
	for (i = 0; i < npevs; i++) {
		pkgs[i].pev = &pevs[i];
		/* Convert with or without debuginfo */
1719
		ret  = convert_to_probe_trace_events(pkgs[i].pev,
1720 1721 1722
						     &pkgs[i].tevs,
						     max_tevs,
						     module);
1723 1724 1725
		if (ret < 0)
			goto end;
		pkgs[i].ntevs = ret;
1726 1727
	}

1728
	/* Loop 2: add all events */
1729
	for (i = 0; i < npevs && ret >= 0; i++)
1730
		ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1731 1732
						pkgs[i].ntevs, force_add);
end:
1733 1734
	/* Loop 3: cleanup and free trace events  */
	for (i = 0; i < npevs; i++) {
1735
		for (j = 0; j < pkgs[i].ntevs; j++)
1736
			clear_probe_trace_event(&pkgs[i].tevs[j]);
1737 1738 1739
		free(pkgs[i].tevs);
	}
	free(pkgs);
1740 1741

	return ret;
1742 1743
}

1744
static int __del_trace_probe_event(int fd, struct str_node *ent)
1745 1746 1747
{
	char *p;
	char buf[128];
1748
	int ret;
1749

1750
	/* Convert from perf-probe event to trace-probe event */
1751 1752 1753 1754
	ret = e_snprintf(buf, 128, "-:%s", ent->s);
	if (ret < 0)
		goto error;

1755
	p = strchr(buf + 2, ':');
1756 1757 1758 1759 1760 1761
	if (!p) {
		pr_debug("Internal error: %s should have ':' but not.\n",
			 ent->s);
		ret = -ENOTSUP;
		goto error;
	}
1762 1763
	*p = '/';

1764 1765
	pr_debug("Writing event: %s\n", buf);
	ret = write(fd, buf, strlen(buf));
1766 1767 1768
	if (ret < 0)
		goto error;

1769
	printf("Remove event: %s\n", ent->s);
1770 1771 1772 1773
	return 0;
error:
	pr_warning("Failed to delete event: %s\n", strerror(-ret));
	return ret;
1774 1775
}

1776
static int del_trace_probe_event(int fd, const char *group,
1777
				  const char *event, struct strlist *namelist)
1778 1779
{
	char buf[128];
1780
	struct str_node *ent, *n;
1781
	int found = 0, ret = 0;
1782

1783 1784
	ret = e_snprintf(buf, 128, "%s:%s", group, event);
	if (ret < 0) {
M
Masami Hiramatsu 已提交
1785
		pr_err("Failed to copy event.\n");
1786 1787
		return ret;
	}
1788

1789 1790 1791 1792
	if (strpbrk(buf, "*?")) { /* Glob-exp */
		strlist__for_each_safe(ent, n, namelist)
			if (strglobmatch(ent->s, buf)) {
				found++;
1793
				ret = __del_trace_probe_event(fd, ent);
1794 1795
				if (ret < 0)
					break;
1796 1797 1798 1799 1800 1801
				strlist__remove(namelist, ent);
			}
	} else {
		ent = strlist__find(namelist, buf);
		if (ent) {
			found++;
1802
			ret = __del_trace_probe_event(fd, ent);
1803 1804
			if (ret >= 0)
				strlist__remove(namelist, ent);
1805 1806
		}
	}
1807 1808 1809 1810
	if (found == 0 && ret >= 0)
		pr_info("Info: Event \"%s\" does not exist.\n", buf);

	return ret;
1811 1812
}

1813
int del_perf_probe_events(struct strlist *dellist)
1814
{
1815
	int fd, ret = 0;
1816 1817 1818 1819 1820
	const char *group, *event;
	char *p, *str;
	struct str_node *ent;
	struct strlist *namelist;

1821
	fd = open_kprobe_events(true);
1822 1823 1824
	if (fd < 0)
		return fd;

1825
	/* Get current event names */
1826
	namelist = get_probe_trace_event_names(fd, true);
1827 1828
	if (namelist == NULL)
		return -EINVAL;
1829

1830
	strlist__for_each(ent, dellist) {
1831 1832 1833 1834 1835
		str = strdup(ent->s);
		if (str == NULL) {
			ret = -ENOMEM;
			break;
		}
1836
		pr_debug("Parsing: %s\n", str);
1837 1838 1839 1840 1841 1842
		p = strchr(str, ':');
		if (p) {
			group = str;
			*p = '\0';
			event = p + 1;
		} else {
1843
			group = "*";
1844 1845
			event = str;
		}
1846
		pr_debug("Group: %s, Event: %s\n", group, event);
1847
		ret = del_trace_probe_event(fd, group, event, namelist);
1848
		free(str);
1849 1850
		if (ret < 0)
			break;
1851 1852 1853
	}
	strlist__delete(namelist);
	close(fd);
1854 1855

	return ret;
1856 1857
}