perf probe: Show accessible global variables
[linux-2.6-block.git] / tools / perf / util / probe-event.c
CommitLineData
50656eec 1/*
0e60836b 2 * probe-event.c : perf-probe definition to probe_events format converter
50656eec
MH
3 *
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 *
20 */
21
22#define _GNU_SOURCE
23#include <sys/utsname.h>
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <fcntl.h>
27#include <errno.h>
28#include <stdio.h>
29#include <unistd.h>
30#include <stdlib.h>
31#include <string.h>
4de189fe
MH
32#include <stdarg.h>
33#include <limits.h>
50656eec
MH
34
35#undef _GNU_SOURCE
31facc5f 36#include "util.h"
50656eec 37#include "event.h"
e1c01d61 38#include "string.h"
4de189fe 39#include "strlist.h"
50656eec 40#include "debug.h"
72041334 41#include "cache.h"
631c9def 42#include "color.h"
e0faa8d3
MH
43#include "symbol.h"
44#include "thread.h"
7ca5989d 45#include "debugfs.h"
4b4da7f7 46#include "trace-event.h" /* For __unused */
50656eec 47#include "probe-event.h"
4235b045 48#include "probe-finder.h"
50656eec
MH
49
50#define MAX_CMDLEN 256
51#define MAX_PROBE_ARGS 128
52#define PERFPROBE_GROUP "probe"
53
f4d7da49
MH
54bool probe_event_dry_run; /* Dry run flag */
55
146a1439 56#define semantic_error(msg ...) pr_err("Semantic error :" msg)
50656eec 57
4de189fe 58/* If there is no space to write, returns -E2BIG. */
84988450
MH
59static int e_snprintf(char *str, size_t size, const char *format, ...)
60 __attribute__((format(printf, 3, 4)));
61
4de189fe
MH
62static int e_snprintf(char *str, size_t size, const char *format, ...)
63{
64 int ret;
65 va_list ap;
66 va_start(ap, format);
67 ret = vsnprintf(str, size, format, ap);
68 va_end(ap);
69 if (ret >= (int)size)
70 ret = -E2BIG;
71 return ret;
72}
73
4b4da7f7 74static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
d28c6223 75static struct machine machine;
e0faa8d3 76
4b4da7f7 77/* Initialize symbol maps and path of vmlinux */
146a1439 78static int init_vmlinux(void)
e0faa8d3 79{
a1645ce1 80 struct dso *kernel;
146a1439
MH
81 int ret;
82
e0faa8d3
MH
83 symbol_conf.sort_by_name = true;
84 if (symbol_conf.vmlinux_name == NULL)
85 symbol_conf.try_vmlinux_path = true;
86 else
87 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
146a1439
MH
88 ret = symbol__init();
89 if (ret < 0) {
90 pr_debug("Failed to init symbol map.\n");
91 goto out;
92 }
e0faa8d3 93
d28c6223
ACM
94 ret = machine__init(&machine, "/", 0);
95 if (ret < 0)
96 goto out;
97
a1645ce1
ZY
98 kernel = dso__new_kernel(symbol_conf.vmlinux_name);
99 if (kernel == NULL)
100 die("Failed to create kernel dso.");
101
d28c6223 102 ret = __machine__create_kernel_maps(&machine, kernel);
146a1439
MH
103 if (ret < 0)
104 pr_debug("Failed to create kernel maps.\n");
105
106out:
107 if (ret < 0)
108 pr_warning("Failed to init vmlinux path.\n");
109 return ret;
e0faa8d3
MH
110}
111
4b4da7f7 112#ifdef DWARF_SUPPORT
e0faa8d3
MH
113static int open_vmlinux(void)
114{
d28c6223 115 if (map__load(machine.vmlinux_maps[MAP__FUNCTION], NULL) < 0) {
e0faa8d3
MH
116 pr_debug("Failed to load kernel map.\n");
117 return -EINVAL;
118 }
d28c6223
ACM
119 pr_debug("Try to open %s\n", machine.vmlinux_maps[MAP__FUNCTION]->dso->long_name);
120 return open(machine.vmlinux_maps[MAP__FUNCTION]->dso->long_name, O_RDONLY);
e0faa8d3 121}
4b4da7f7 122
0e60836b
SD
123/*
124 * Convert trace point to probe point with debuginfo
125 * Currently only handles kprobes.
126 */
127static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
146a1439 128 struct perf_probe_point *pp)
4b4da7f7
MH
129{
130 struct symbol *sym;
146a1439 131 int fd, ret = -ENOENT;
4b4da7f7 132
d28c6223 133 sym = map__find_symbol_by_name(machine.vmlinux_maps[MAP__FUNCTION],
4b4da7f7
MH
134 tp->symbol, NULL);
135 if (sym) {
136 fd = open_vmlinux();
146a1439
MH
137 if (fd >= 0) {
138 ret = find_perf_probe_point(fd,
139 sym->start + tp->offset, pp);
140 close(fd);
141 }
4b4da7f7
MH
142 }
143 if (ret <= 0) {
146a1439
MH
144 pr_debug("Failed to find corresponding probes from "
145 "debuginfo. Use kprobe event information.\n");
02b95dad
MH
146 pp->function = strdup(tp->symbol);
147 if (pp->function == NULL)
148 return -ENOMEM;
4b4da7f7
MH
149 pp->offset = tp->offset;
150 }
151 pp->retprobe = tp->retprobe;
146a1439
MH
152
153 return 0;
4b4da7f7
MH
154}
155
156/* Try to find perf_probe_event with debuginfo */
0e60836b
SD
157static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
158 struct probe_trace_event **tevs,
ef4a3565 159 int max_tevs)
4b4da7f7
MH
160{
161 bool need_dwarf = perf_probe_event_need_dwarf(pev);
162 int fd, ntevs;
163
164 fd = open_vmlinux();
165 if (fd < 0) {
146a1439
MH
166 if (need_dwarf) {
167 pr_warning("Failed to open debuginfo file.\n");
168 return fd;
169 }
4b4da7f7
MH
170 pr_debug("Could not open vmlinux. Try to use symbols.\n");
171 return 0;
172 }
173
174 /* Searching trace events corresponding to probe event */
0e60836b 175 ntevs = find_probe_trace_events(fd, pev, tevs, max_tevs);
4b4da7f7
MH
176 close(fd);
177
146a1439 178 if (ntevs > 0) { /* Succeeded to find trace events */
0e60836b 179 pr_debug("find %d probe_trace_events.\n", ntevs);
4b4da7f7 180 return ntevs;
146a1439 181 }
4b4da7f7 182
146a1439
MH
183 if (ntevs == 0) { /* No error but failed to find probe point. */
184 pr_warning("Probe point '%s' not found.\n",
185 synthesize_perf_probe_point(&pev->point));
186 return -ENOENT;
187 }
188 /* Error path : ntevs < 0 */
15eca306
MH
189 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
190 if (ntevs == -EBADF) {
191 pr_warning("Warning: No dwarf info found in the vmlinux - "
192 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
193 if (!need_dwarf) {
194 pr_debug("Trying to use symbols.\nn");
195 return 0;
196 }
4b4da7f7 197 }
15eca306 198 return ntevs;
4b4da7f7
MH
199}
200
7cf0b79e
MH
201/*
202 * Find a src file from a DWARF tag path. Prepend optional source path prefix
203 * and chop off leading directories that do not exist. Result is passed back as
204 * a newly allocated path on success.
205 * Return 0 if file was found and readable, -errno otherwise.
206 */
6a330a3c
MH
207static int get_real_path(const char *raw_path, const char *comp_dir,
208 char **new_path)
7cf0b79e 209{
6a330a3c
MH
210 const char *prefix = symbol_conf.source_prefix;
211
212 if (!prefix) {
213 if (raw_path[0] != '/' && comp_dir)
214 /* If not an absolute path, try to use comp_dir */
215 prefix = comp_dir;
216 else {
217 if (access(raw_path, R_OK) == 0) {
218 *new_path = strdup(raw_path);
219 return 0;
220 } else
221 return -errno;
222 }
7cf0b79e
MH
223 }
224
6a330a3c 225 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
7cf0b79e
MH
226 if (!*new_path)
227 return -ENOMEM;
228
229 for (;;) {
6a330a3c 230 sprintf(*new_path, "%s/%s", prefix, raw_path);
7cf0b79e
MH
231
232 if (access(*new_path, R_OK) == 0)
233 return 0;
234
6a330a3c
MH
235 if (!symbol_conf.source_prefix)
236 /* In case of searching comp_dir, don't retry */
237 return -errno;
238
7cf0b79e
MH
239 switch (errno) {
240 case ENAMETOOLONG:
241 case ENOENT:
242 case EROFS:
243 case EFAULT:
244 raw_path = strchr(++raw_path, '/');
245 if (!raw_path) {
246 free(*new_path);
247 *new_path = NULL;
248 return -ENOENT;
249 }
250 continue;
251
252 default:
253 free(*new_path);
254 *new_path = NULL;
255 return -errno;
256 }
257 }
258}
259
4b4da7f7
MH
260#define LINEBUF_SIZE 256
261#define NR_ADDITIONAL_LINES 2
262
d3b63d7a 263static int show_one_line(FILE *fp, int l, bool skip, bool show_num)
4b4da7f7
MH
264{
265 char buf[LINEBUF_SIZE];
266 const char *color = PERF_COLOR_BLUE;
267
268 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
269 goto error;
270 if (!skip) {
271 if (show_num)
d3b63d7a 272 fprintf(stdout, "%7d %s", l, buf);
4b4da7f7
MH
273 else
274 color_fprintf(stdout, color, " %s", buf);
275 }
276
277 while (strlen(buf) == LINEBUF_SIZE - 1 &&
278 buf[LINEBUF_SIZE - 2] != '\n') {
279 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
280 goto error;
281 if (!skip) {
282 if (show_num)
283 fprintf(stdout, "%s", buf);
284 else
285 color_fprintf(stdout, color, "%s", buf);
286 }
287 }
146a1439
MH
288
289 return 0;
4b4da7f7
MH
290error:
291 if (feof(fp))
146a1439 292 pr_warning("Source file is shorter than expected.\n");
4b4da7f7 293 else
146a1439
MH
294 pr_warning("File read error: %s\n", strerror(errno));
295
296 return -1;
4b4da7f7
MH
297}
298
299/*
300 * Show line-range always requires debuginfo to find source file and
301 * line number.
302 */
146a1439 303int show_line_range(struct line_range *lr)
4b4da7f7 304{
d3b63d7a 305 int l = 1;
4b4da7f7
MH
306 struct line_node *ln;
307 FILE *fp;
308 int fd, ret;
7cf0b79e 309 char *tmp;
4b4da7f7
MH
310
311 /* Search a line range */
146a1439
MH
312 ret = init_vmlinux();
313 if (ret < 0)
314 return ret;
315
4b4da7f7 316 fd = open_vmlinux();
146a1439
MH
317 if (fd < 0) {
318 pr_warning("Failed to open debuginfo file.\n");
319 return fd;
320 }
321
4b4da7f7 322 ret = find_line_range(fd, lr);
4b4da7f7 323 close(fd);
146a1439
MH
324 if (ret == 0) {
325 pr_warning("Specified source line is not found.\n");
326 return -ENOENT;
327 } else if (ret < 0) {
328 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
329 return ret;
330 }
4b4da7f7 331
7cf0b79e
MH
332 /* Convert source file path */
333 tmp = lr->path;
6a330a3c 334 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
7cf0b79e
MH
335 free(tmp); /* Free old path */
336 if (ret < 0) {
337 pr_warning("Failed to find source file. (%d)\n", ret);
338 return ret;
339 }
340
4b4da7f7
MH
341 setup_pager();
342
343 if (lr->function)
344 fprintf(stdout, "<%s:%d>\n", lr->function,
345 lr->start - lr->offset);
346 else
347 fprintf(stdout, "<%s:%d>\n", lr->file, lr->start);
348
349 fp = fopen(lr->path, "r");
146a1439
MH
350 if (fp == NULL) {
351 pr_warning("Failed to open %s: %s\n", lr->path,
352 strerror(errno));
353 return -errno;
354 }
4b4da7f7 355 /* Skip to starting line number */
146a1439
MH
356 while (l < lr->start && ret >= 0)
357 ret = show_one_line(fp, l++, true, false);
358 if (ret < 0)
359 goto end;
4b4da7f7
MH
360
361 list_for_each_entry(ln, &lr->line_list, list) {
146a1439
MH
362 while (ln->line > l && ret >= 0)
363 ret = show_one_line(fp, (l++) - lr->offset,
364 false, false);
365 if (ret >= 0)
366 ret = show_one_line(fp, (l++) - lr->offset,
367 false, true);
368 if (ret < 0)
369 goto end;
4b4da7f7
MH
370 }
371
372 if (lr->end == INT_MAX)
373 lr->end = l + NR_ADDITIONAL_LINES;
dda4ab34 374 while (l <= lr->end && !feof(fp) && ret >= 0)
146a1439
MH
375 ret = show_one_line(fp, (l++) - lr->offset, false, false);
376end:
4b4da7f7 377 fclose(fp);
146a1439 378 return ret;
4b4da7f7
MH
379}
380
cf6eb489 381static int show_available_vars_at(int fd, struct perf_probe_event *pev,
fb8c5a56 382 int max_vls, bool externs)
cf6eb489
MH
383{
384 char *buf;
385 int ret, i;
386 struct str_node *node;
387 struct variable_list *vls = NULL, *vl;
388
389 buf = synthesize_perf_probe_point(&pev->point);
390 if (!buf)
391 return -EINVAL;
392 pr_debug("Searching variables at %s\n", buf);
393
fb8c5a56 394 ret = find_available_vars_at(fd, pev, &vls, max_vls, externs);
cf6eb489
MH
395 if (ret > 0) {
396 /* Some variables were found */
397 fprintf(stdout, "Available variables at %s\n", buf);
398 for (i = 0; i < ret; i++) {
399 vl = &vls[i];
400 /*
401 * A probe point might be converted to
402 * several trace points.
403 */
404 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
405 vl->point.offset);
406 free(vl->point.symbol);
407 if (vl->vars) {
408 strlist__for_each(node, vl->vars)
409 fprintf(stdout, "\t\t%s\n", node->s);
410 strlist__delete(vl->vars);
411 } else
412 fprintf(stdout, "(No variables)\n");
413 }
414 free(vls);
415 } else
416 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
417
418 free(buf);
419 return ret;
420}
421
422/* Show available variables on given probe point */
423int show_available_vars(struct perf_probe_event *pevs, int npevs,
fb8c5a56 424 int max_vls, bool externs)
cf6eb489
MH
425{
426 int i, fd, ret = 0;
427
428 ret = init_vmlinux();
429 if (ret < 0)
430 return ret;
431
432 fd = open_vmlinux();
433 if (fd < 0) {
434 pr_warning("Failed to open debuginfo file.\n");
435 return fd;
436 }
437
438 setup_pager();
439
440 for (i = 0; i < npevs && ret >= 0; i++)
fb8c5a56 441 ret = show_available_vars_at(fd, &pevs[i], max_vls, externs);
cf6eb489
MH
442
443 close(fd);
444 return ret;
445}
446
4b4da7f7
MH
447#else /* !DWARF_SUPPORT */
448
0e60836b
SD
449static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
450 struct perf_probe_point *pp)
4b4da7f7 451{
02b95dad
MH
452 pp->function = strdup(tp->symbol);
453 if (pp->function == NULL)
454 return -ENOMEM;
4b4da7f7
MH
455 pp->offset = tp->offset;
456 pp->retprobe = tp->retprobe;
146a1439
MH
457
458 return 0;
4b4da7f7
MH
459}
460
0e60836b
SD
461static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
462 struct probe_trace_event **tevs __unused,
ef4a3565 463 int max_tevs __unused)
4b4da7f7 464{
146a1439
MH
465 if (perf_probe_event_need_dwarf(pev)) {
466 pr_warning("Debuginfo-analysis is not supported.\n");
467 return -ENOSYS;
468 }
4b4da7f7
MH
469 return 0;
470}
471
146a1439 472int show_line_range(struct line_range *lr __unused)
4b4da7f7 473{
146a1439
MH
474 pr_warning("Debuginfo-analysis is not supported.\n");
475 return -ENOSYS;
4b4da7f7
MH
476}
477
cf6eb489
MH
478int show_available_vars(struct perf_probe_event *pevs __unused,
479 int npevs __unused, int max_probe_points __unused)
480{
481 pr_warning("Debuginfo-analysis is not supported.\n");
482 return -ENOSYS;
483}
e0faa8d3
MH
484#endif
485
146a1439 486int parse_line_range_desc(const char *arg, struct line_range *lr)
631c9def
MH
487{
488 const char *ptr;
489 char *tmp;
490 /*
491 * <Syntax>
492 * SRC:SLN[+NUM|-ELN]
493 * FUNC[:SLN[+NUM|-ELN]]
494 */
495 ptr = strchr(arg, ':');
496 if (ptr) {
d3b63d7a 497 lr->start = (int)strtoul(ptr + 1, &tmp, 0);
dda4ab34 498 if (*tmp == '+') {
d3b63d7a 499 lr->end = lr->start + (int)strtoul(tmp + 1, &tmp, 0);
dda4ab34
MH
500 lr->end--; /*
501 * Adjust the number of lines here.
502 * If the number of lines == 1, the
503 * the end of line should be equal to
504 * the start of line.
505 */
506 } else if (*tmp == '-')
d3b63d7a 507 lr->end = (int)strtoul(tmp + 1, &tmp, 0);
631c9def 508 else
d3b63d7a
MH
509 lr->end = INT_MAX;
510 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
511 if (lr->start > lr->end) {
631c9def 512 semantic_error("Start line must be smaller"
146a1439
MH
513 " than end line.\n");
514 return -EINVAL;
515 }
516 if (*tmp != '\0') {
517 semantic_error("Tailing with invalid character '%d'.\n",
631c9def 518 *tmp);
146a1439
MH
519 return -EINVAL;
520 }
02b95dad 521 tmp = strndup(arg, (ptr - arg));
d3b63d7a 522 } else {
02b95dad 523 tmp = strdup(arg);
d3b63d7a
MH
524 lr->end = INT_MAX;
525 }
02b95dad
MH
526
527 if (tmp == NULL)
528 return -ENOMEM;
631c9def
MH
529
530 if (strchr(tmp, '.'))
531 lr->file = tmp;
532 else
533 lr->function = tmp;
146a1439
MH
534
535 return 0;
631c9def
MH
536}
537
b7702a21
MH
538/* Check the name is good for event/group */
539static bool check_event_name(const char *name)
540{
541 if (!isalpha(*name) && *name != '_')
542 return false;
543 while (*++name != '\0') {
544 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
545 return false;
546 }
547 return true;
548}
549
50656eec 550/* Parse probepoint definition. */
146a1439 551static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
50656eec 552{
4235b045 553 struct perf_probe_point *pp = &pev->point;
50656eec
MH
554 char *ptr, *tmp;
555 char c, nc = 0;
556 /*
557 * <Syntax>
2a9c8c36
MH
558 * perf probe [EVENT=]SRC[:LN|;PTN]
559 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
af663d75
MH
560 *
561 * TODO:Group name support
50656eec
MH
562 */
563
2a9c8c36
MH
564 ptr = strpbrk(arg, ";=@+%");
565 if (ptr && *ptr == '=') { /* Event name */
af663d75
MH
566 *ptr = '\0';
567 tmp = ptr + 1;
146a1439
MH
568 if (strchr(arg, ':')) {
569 semantic_error("Group name is not supported yet.\n");
570 return -ENOTSUP;
571 }
572 if (!check_event_name(arg)) {
b7702a21 573 semantic_error("%s is bad for event name -it must "
146a1439
MH
574 "follow C symbol-naming rule.\n", arg);
575 return -EINVAL;
576 }
02b95dad
MH
577 pev->event = strdup(arg);
578 if (pev->event == NULL)
579 return -ENOMEM;
4235b045 580 pev->group = NULL;
af663d75
MH
581 arg = tmp;
582 }
583
2a9c8c36 584 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
585 if (ptr) {
586 nc = *ptr;
587 *ptr++ = '\0';
588 }
589
02b95dad
MH
590 tmp = strdup(arg);
591 if (tmp == NULL)
592 return -ENOMEM;
593
50656eec 594 /* Check arg is function or file and copy it */
02b95dad
MH
595 if (strchr(tmp, '.')) /* File */
596 pp->file = tmp;
50656eec 597 else /* Function */
02b95dad 598 pp->function = tmp;
50656eec
MH
599
600 /* Parse other options */
601 while (ptr) {
602 arg = ptr;
603 c = nc;
2a9c8c36 604 if (c == ';') { /* Lazy pattern must be the last part */
02b95dad
MH
605 pp->lazy_line = strdup(arg);
606 if (pp->lazy_line == NULL)
607 return -ENOMEM;
2a9c8c36
MH
608 break;
609 }
610 ptr = strpbrk(arg, ";:+@%");
50656eec
MH
611 if (ptr) {
612 nc = *ptr;
613 *ptr++ = '\0';
614 }
615 switch (c) {
616 case ':': /* Line number */
617 pp->line = strtoul(arg, &tmp, 0);
146a1439 618 if (*tmp != '\0') {
2a9c8c36 619 semantic_error("There is non-digit char"
146a1439
MH
620 " in line number.\n");
621 return -EINVAL;
622 }
50656eec
MH
623 break;
624 case '+': /* Byte offset from a symbol */
625 pp->offset = strtoul(arg, &tmp, 0);
146a1439 626 if (*tmp != '\0') {
2a9c8c36 627 semantic_error("There is non-digit character"
146a1439
MH
628 " in offset.\n");
629 return -EINVAL;
630 }
50656eec
MH
631 break;
632 case '@': /* File name */
146a1439
MH
633 if (pp->file) {
634 semantic_error("SRC@SRC is not allowed.\n");
635 return -EINVAL;
636 }
02b95dad
MH
637 pp->file = strdup(arg);
638 if (pp->file == NULL)
639 return -ENOMEM;
50656eec
MH
640 break;
641 case '%': /* Probe places */
642 if (strcmp(arg, "return") == 0) {
643 pp->retprobe = 1;
146a1439
MH
644 } else { /* Others not supported yet */
645 semantic_error("%%%s is not supported.\n", arg);
646 return -ENOTSUP;
647 }
50656eec 648 break;
146a1439
MH
649 default: /* Buggy case */
650 pr_err("This program has a bug at %s:%d.\n",
651 __FILE__, __LINE__);
652 return -ENOTSUP;
50656eec
MH
653 break;
654 }
655 }
656
657 /* Exclusion check */
146a1439 658 if (pp->lazy_line && pp->line) {
2a9c8c36 659 semantic_error("Lazy pattern can't be used with line number.");
146a1439
MH
660 return -EINVAL;
661 }
2a9c8c36 662
146a1439 663 if (pp->lazy_line && pp->offset) {
2a9c8c36 664 semantic_error("Lazy pattern can't be used with offset.");
146a1439
MH
665 return -EINVAL;
666 }
2a9c8c36 667
146a1439 668 if (pp->line && pp->offset) {
50656eec 669 semantic_error("Offset can't be used with line number.");
146a1439
MH
670 return -EINVAL;
671 }
50656eec 672
146a1439 673 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
2a9c8c36
MH
674 semantic_error("File always requires line number or "
675 "lazy pattern.");
146a1439
MH
676 return -EINVAL;
677 }
50656eec 678
146a1439 679 if (pp->offset && !pp->function) {
50656eec 680 semantic_error("Offset requires an entry function.");
146a1439
MH
681 return -EINVAL;
682 }
50656eec 683
146a1439 684 if (pp->retprobe && !pp->function) {
50656eec 685 semantic_error("Return probe requires an entry function.");
146a1439
MH
686 return -EINVAL;
687 }
50656eec 688
146a1439 689 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
2a9c8c36
MH
690 semantic_error("Offset/Line/Lazy pattern can't be used with "
691 "return probe.");
146a1439
MH
692 return -EINVAL;
693 }
50656eec 694
4235b045 695 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
2a9c8c36
MH
696 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
697 pp->lazy_line);
146a1439 698 return 0;
50656eec
MH
699}
700
7df2f329 701/* Parse perf-probe event argument */
146a1439 702static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
7df2f329 703{
b2a3c12b 704 char *tmp, *goodname;
7df2f329
MH
705 struct perf_probe_arg_field **fieldp;
706
707 pr_debug("parsing arg: %s into ", str);
708
48481938
MH
709 tmp = strchr(str, '=');
710 if (tmp) {
02b95dad
MH
711 arg->name = strndup(str, tmp - str);
712 if (arg->name == NULL)
713 return -ENOMEM;
11a1ca35 714 pr_debug("name:%s ", arg->name);
48481938
MH
715 str = tmp + 1;
716 }
717
11a1ca35
MH
718 tmp = strchr(str, ':');
719 if (tmp) { /* Type setting */
720 *tmp = '\0';
02b95dad
MH
721 arg->type = strdup(tmp + 1);
722 if (arg->type == NULL)
723 return -ENOMEM;
11a1ca35
MH
724 pr_debug("type:%s ", arg->type);
725 }
726
b2a3c12b 727 tmp = strpbrk(str, "-.[");
7df2f329
MH
728 if (!is_c_varname(str) || !tmp) {
729 /* A variable, register, symbol or special value */
02b95dad
MH
730 arg->var = strdup(str);
731 if (arg->var == NULL)
732 return -ENOMEM;
48481938 733 pr_debug("%s\n", arg->var);
146a1439 734 return 0;
7df2f329
MH
735 }
736
b2a3c12b 737 /* Structure fields or array element */
02b95dad
MH
738 arg->var = strndup(str, tmp - str);
739 if (arg->var == NULL)
740 return -ENOMEM;
b2a3c12b 741 goodname = arg->var;
48481938 742 pr_debug("%s, ", arg->var);
7df2f329
MH
743 fieldp = &arg->field;
744
745 do {
e334016f
MH
746 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
747 if (*fieldp == NULL)
748 return -ENOMEM;
b2a3c12b
MH
749 if (*tmp == '[') { /* Array */
750 str = tmp;
751 (*fieldp)->index = strtol(str + 1, &tmp, 0);
7df2f329 752 (*fieldp)->ref = true;
b2a3c12b
MH
753 if (*tmp != ']' || tmp == str + 1) {
754 semantic_error("Array index must be a"
755 " number.\n");
756 return -EINVAL;
757 }
758 tmp++;
759 if (*tmp == '\0')
760 tmp = NULL;
761 } else { /* Structure */
762 if (*tmp == '.') {
763 str = tmp + 1;
764 (*fieldp)->ref = false;
765 } else if (tmp[1] == '>') {
766 str = tmp + 2;
767 (*fieldp)->ref = true;
768 } else {
769 semantic_error("Argument parse error: %s\n",
770 str);
771 return -EINVAL;
772 }
773 tmp = strpbrk(str, "-.[");
146a1439 774 }
7df2f329 775 if (tmp) {
02b95dad
MH
776 (*fieldp)->name = strndup(str, tmp - str);
777 if ((*fieldp)->name == NULL)
778 return -ENOMEM;
b2a3c12b
MH
779 if (*str != '[')
780 goodname = (*fieldp)->name;
7df2f329
MH
781 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
782 fieldp = &(*fieldp)->next;
783 }
784 } while (tmp);
02b95dad
MH
785 (*fieldp)->name = strdup(str);
786 if ((*fieldp)->name == NULL)
787 return -ENOMEM;
b2a3c12b
MH
788 if (*str != '[')
789 goodname = (*fieldp)->name;
7df2f329 790 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
df0faf4b 791
b2a3c12b 792 /* If no name is specified, set the last field name (not array index)*/
02b95dad 793 if (!arg->name) {
b2a3c12b 794 arg->name = strdup(goodname);
02b95dad
MH
795 if (arg->name == NULL)
796 return -ENOMEM;
797 }
146a1439 798 return 0;
7df2f329
MH
799}
800
4235b045 801/* Parse perf-probe event command */
146a1439 802int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
50656eec 803{
e1c01d61 804 char **argv;
146a1439 805 int argc, i, ret = 0;
fac13fd5 806
4235b045 807 argv = argv_split(cmd, &argc);
146a1439
MH
808 if (!argv) {
809 pr_debug("Failed to split arguments.\n");
810 return -ENOMEM;
811 }
812 if (argc - 1 > MAX_PROBE_ARGS) {
813 semantic_error("Too many probe arguments (%d).\n", argc - 1);
814 ret = -ERANGE;
815 goto out;
816 }
50656eec 817 /* Parse probe point */
146a1439
MH
818 ret = parse_perf_probe_point(argv[0], pev);
819 if (ret < 0)
820 goto out;
50656eec 821
e1c01d61 822 /* Copy arguments and ensure return probe has no C argument */
4235b045 823 pev->nargs = argc - 1;
e334016f
MH
824 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
825 if (pev->args == NULL) {
826 ret = -ENOMEM;
827 goto out;
828 }
146a1439
MH
829 for (i = 0; i < pev->nargs && ret >= 0; i++) {
830 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
831 if (ret >= 0 &&
832 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
4235b045 833 semantic_error("You can't specify local variable for"
146a1439
MH
834 " kretprobe.\n");
835 ret = -EINVAL;
836 }
e1c01d61 837 }
146a1439 838out:
e1c01d61 839 argv_free(argv);
146a1439
MH
840
841 return ret;
50656eec
MH
842}
843
4235b045
MH
844/* Return true if this perf_probe_event requires debuginfo */
845bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
846{
847 int i;
848
849 if (pev->point.file || pev->point.line || pev->point.lazy_line)
850 return true;
851
852 for (i = 0; i < pev->nargs; i++)
48481938 853 if (is_c_varname(pev->args[i].var))
4235b045
MH
854 return true;
855
856 return false;
857}
858
0e60836b
SD
859/* Parse probe_events event into struct probe_point */
860static int parse_probe_trace_command(const char *cmd,
861 struct probe_trace_event *tev)
4de189fe 862{
0e60836b 863 struct probe_trace_point *tp = &tev->point;
4de189fe
MH
864 char pr;
865 char *p;
866 int ret, i, argc;
867 char **argv;
868
0e60836b 869 pr_debug("Parsing probe_events: %s\n", cmd);
4235b045 870 argv = argv_split(cmd, &argc);
146a1439
MH
871 if (!argv) {
872 pr_debug("Failed to split arguments.\n");
873 return -ENOMEM;
874 }
875 if (argc < 2) {
876 semantic_error("Too few probe arguments.\n");
877 ret = -ERANGE;
878 goto out;
879 }
4de189fe
MH
880
881 /* Scan event and group name. */
93aaa45a 882 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
4235b045
MH
883 &pr, (float *)(void *)&tev->group,
884 (float *)(void *)&tev->event);
146a1439
MH
885 if (ret != 3) {
886 semantic_error("Failed to parse event name: %s\n", argv[0]);
887 ret = -EINVAL;
888 goto out;
889 }
4235b045 890 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
4de189fe 891
4235b045 892 tp->retprobe = (pr == 'r');
4de189fe
MH
893
894 /* Scan function name and offset */
4235b045
MH
895 ret = sscanf(argv[1], "%a[^+]+%lu", (float *)(void *)&tp->symbol,
896 &tp->offset);
4de189fe 897 if (ret == 1)
4235b045 898 tp->offset = 0;
4de189fe 899
4235b045 900 tev->nargs = argc - 2;
0e60836b 901 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
e334016f
MH
902 if (tev->args == NULL) {
903 ret = -ENOMEM;
904 goto out;
905 }
4235b045 906 for (i = 0; i < tev->nargs; i++) {
4de189fe
MH
907 p = strchr(argv[i + 2], '=');
908 if (p) /* We don't need which register is assigned. */
4235b045
MH
909 *p++ = '\0';
910 else
911 p = argv[i + 2];
02b95dad 912 tev->args[i].name = strdup(argv[i + 2]);
4235b045 913 /* TODO: parse regs and offset */
02b95dad
MH
914 tev->args[i].value = strdup(p);
915 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
916 ret = -ENOMEM;
917 goto out;
918 }
4de189fe 919 }
146a1439
MH
920 ret = 0;
921out:
4de189fe 922 argv_free(argv);
146a1439 923 return ret;
4de189fe
MH
924}
925
7df2f329
MH
926/* Compose only probe arg */
927int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
928{
929 struct perf_probe_arg_field *field = pa->field;
930 int ret;
931 char *tmp = buf;
932
48481938
MH
933 if (pa->name && pa->var)
934 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
935 else
936 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
7df2f329
MH
937 if (ret <= 0)
938 goto error;
939 tmp += ret;
940 len -= ret;
941
942 while (field) {
b2a3c12b
MH
943 if (field->name[0] == '[')
944 ret = e_snprintf(tmp, len, "%s", field->name);
945 else
946 ret = e_snprintf(tmp, len, "%s%s",
947 field->ref ? "->" : ".", field->name);
7df2f329
MH
948 if (ret <= 0)
949 goto error;
950 tmp += ret;
951 len -= ret;
952 field = field->next;
953 }
11a1ca35
MH
954
955 if (pa->type) {
956 ret = e_snprintf(tmp, len, ":%s", pa->type);
957 if (ret <= 0)
958 goto error;
959 tmp += ret;
960 len -= ret;
961 }
962
7df2f329
MH
963 return tmp - buf;
964error:
146a1439
MH
965 pr_debug("Failed to synthesize perf probe argument: %s",
966 strerror(-ret));
967 return ret;
7df2f329
MH
968}
969
4235b045
MH
970/* Compose only probe point (not argument) */
971static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
4de189fe 972{
fb1587d8
MH
973 char *buf, *tmp;
974 char offs[32] = "", line[32] = "", file[32] = "";
975 int ret, len;
4de189fe 976
e334016f
MH
977 buf = zalloc(MAX_CMDLEN);
978 if (buf == NULL) {
979 ret = -ENOMEM;
980 goto error;
981 }
4de189fe 982 if (pp->offset) {
fb1587d8 983 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
4de189fe
MH
984 if (ret <= 0)
985 goto error;
986 }
987 if (pp->line) {
fb1587d8
MH
988 ret = e_snprintf(line, 32, ":%d", pp->line);
989 if (ret <= 0)
990 goto error;
991 }
992 if (pp->file) {
dd259c5d 993 len = strlen(pp->file) - 31;
fb1587d8
MH
994 if (len < 0)
995 len = 0;
996 tmp = strchr(pp->file + len, '/');
997 if (!tmp)
dd259c5d 998 tmp = pp->file + len;
fb1587d8 999 ret = e_snprintf(file, 32, "@%s", tmp + 1);
4de189fe
MH
1000 if (ret <= 0)
1001 goto error;
1002 }
1003
1004 if (pp->function)
fb1587d8
MH
1005 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1006 offs, pp->retprobe ? "%return" : "", line,
1007 file);
4de189fe 1008 else
fb1587d8 1009 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
4235b045
MH
1010 if (ret <= 0)
1011 goto error;
1012
1013 return buf;
7ef17aaf 1014error:
146a1439
MH
1015 pr_debug("Failed to synthesize perf probe point: %s",
1016 strerror(-ret));
e334016f
MH
1017 if (buf)
1018 free(buf);
146a1439 1019 return NULL;
7ef17aaf
MH
1020}
1021
4235b045
MH
1022#if 0
1023char *synthesize_perf_probe_command(struct perf_probe_event *pev)
7ef17aaf
MH
1024{
1025 char *buf;
1026 int i, len, ret;
1027
4235b045
MH
1028 buf = synthesize_perf_probe_point(&pev->point);
1029 if (!buf)
1030 return NULL;
4de189fe 1031
4235b045
MH
1032 len = strlen(buf);
1033 for (i = 0; i < pev->nargs; i++) {
4de189fe 1034 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
4235b045
MH
1035 pev->args[i].name);
1036 if (ret <= 0) {
1037 free(buf);
1038 return NULL;
1039 }
4de189fe
MH
1040 len += ret;
1041 }
4de189fe 1042
4235b045
MH
1043 return buf;
1044}
1045#endif
1046
0e60836b 1047static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
4235b045
MH
1048 char **buf, size_t *buflen,
1049 int depth)
1050{
1051 int ret;
1052 if (ref->next) {
0e60836b 1053 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
4235b045
MH
1054 buflen, depth + 1);
1055 if (depth < 0)
1056 goto out;
1057 }
1058
1059 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1060 if (ret < 0)
1061 depth = ret;
1062 else {
1063 *buf += ret;
1064 *buflen -= ret;
1065 }
1066out:
1067 return depth;
4de189fe 1068
4de189fe
MH
1069}
1070
0e60836b 1071static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
4235b045 1072 char *buf, size_t buflen)
50656eec 1073{
0e60836b 1074 struct probe_trace_arg_ref *ref = arg->ref;
4235b045
MH
1075 int ret, depth = 0;
1076 char *tmp = buf;
1077
1078 /* Argument name or separator */
1079 if (arg->name)
1080 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1081 else
1082 ret = e_snprintf(buf, buflen, " ");
1083 if (ret < 0)
1084 return ret;
1085 buf += ret;
1086 buflen -= ret;
1087
b7dcb857
MH
1088 /* Special case: @XXX */
1089 if (arg->value[0] == '@' && arg->ref)
1090 ref = ref->next;
1091
4235b045 1092 /* Dereferencing arguments */
b7dcb857 1093 if (ref) {
0e60836b 1094 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
4235b045
MH
1095 &buflen, 1);
1096 if (depth < 0)
1097 return depth;
1098 }
1099
1100 /* Print argument value */
b7dcb857
MH
1101 if (arg->value[0] == '@' && arg->ref)
1102 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1103 arg->ref->offset);
1104 else
1105 ret = e_snprintf(buf, buflen, "%s", arg->value);
4235b045
MH
1106 if (ret < 0)
1107 return ret;
1108 buf += ret;
1109 buflen -= ret;
1110
1111 /* Closing */
1112 while (depth--) {
1113 ret = e_snprintf(buf, buflen, ")");
1114 if (ret < 0)
1115 return ret;
1116 buf += ret;
1117 buflen -= ret;
1118 }
4984912e
MH
1119 /* Print argument type */
1120 if (arg->type) {
1121 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1122 if (ret <= 0)
1123 return ret;
1124 buf += ret;
1125 }
4235b045
MH
1126
1127 return buf - tmp;
1128}
1129
0e60836b 1130char *synthesize_probe_trace_command(struct probe_trace_event *tev)
4235b045 1131{
0e60836b 1132 struct probe_trace_point *tp = &tev->point;
50656eec
MH
1133 char *buf;
1134 int i, len, ret;
1135
e334016f
MH
1136 buf = zalloc(MAX_CMDLEN);
1137 if (buf == NULL)
1138 return NULL;
1139
4235b045
MH
1140 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s+%lu",
1141 tp->retprobe ? 'r' : 'p',
1142 tev->group, tev->event,
1143 tp->symbol, tp->offset);
1144 if (len <= 0)
50656eec 1145 goto error;
50656eec 1146
4235b045 1147 for (i = 0; i < tev->nargs; i++) {
0e60836b 1148 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
4235b045 1149 MAX_CMDLEN - len);
4de189fe 1150 if (ret <= 0)
50656eec
MH
1151 goto error;
1152 len += ret;
1153 }
50656eec 1154
4235b045 1155 return buf;
50656eec 1156error:
4235b045
MH
1157 free(buf);
1158 return NULL;
1159}
50656eec 1160
0e60836b 1161static int convert_to_perf_probe_event(struct probe_trace_event *tev,
146a1439 1162 struct perf_probe_event *pev)
4235b045 1163{
02b95dad 1164 char buf[64] = "";
146a1439 1165 int i, ret;
4235b045 1166
4b4da7f7 1167 /* Convert event/group name */
02b95dad
MH
1168 pev->event = strdup(tev->event);
1169 pev->group = strdup(tev->group);
1170 if (pev->event == NULL || pev->group == NULL)
1171 return -ENOMEM;
fb1587d8 1172
4b4da7f7 1173 /* Convert trace_point to probe_point */
0e60836b 1174 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
146a1439
MH
1175 if (ret < 0)
1176 return ret;
4b4da7f7 1177
4235b045
MH
1178 /* Convert trace_arg to probe_arg */
1179 pev->nargs = tev->nargs;
e334016f
MH
1180 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1181 if (pev->args == NULL)
1182 return -ENOMEM;
02b95dad 1183 for (i = 0; i < tev->nargs && ret >= 0; i++) {
4235b045 1184 if (tev->args[i].name)
02b95dad 1185 pev->args[i].name = strdup(tev->args[i].name);
4235b045 1186 else {
0e60836b 1187 ret = synthesize_probe_trace_arg(&tev->args[i],
146a1439 1188 buf, 64);
02b95dad 1189 pev->args[i].name = strdup(buf);
4235b045 1190 }
02b95dad
MH
1191 if (pev->args[i].name == NULL && ret >= 0)
1192 ret = -ENOMEM;
1193 }
146a1439
MH
1194
1195 if (ret < 0)
1196 clear_perf_probe_event(pev);
1197
1198 return ret;
4235b045
MH
1199}
1200
1201void clear_perf_probe_event(struct perf_probe_event *pev)
1202{
1203 struct perf_probe_point *pp = &pev->point;
7df2f329 1204 struct perf_probe_arg_field *field, *next;
4235b045
MH
1205 int i;
1206
1207 if (pev->event)
1208 free(pev->event);
1209 if (pev->group)
1210 free(pev->group);
1211 if (pp->file)
1212 free(pp->file);
1213 if (pp->function)
1214 free(pp->function);
1215 if (pp->lazy_line)
1216 free(pp->lazy_line);
7df2f329 1217 for (i = 0; i < pev->nargs; i++) {
4235b045
MH
1218 if (pev->args[i].name)
1219 free(pev->args[i].name);
48481938
MH
1220 if (pev->args[i].var)
1221 free(pev->args[i].var);
11a1ca35
MH
1222 if (pev->args[i].type)
1223 free(pev->args[i].type);
7df2f329
MH
1224 field = pev->args[i].field;
1225 while (field) {
1226 next = field->next;
1227 if (field->name)
1228 free(field->name);
1229 free(field);
1230 field = next;
1231 }
1232 }
4235b045
MH
1233 if (pev->args)
1234 free(pev->args);
1235 memset(pev, 0, sizeof(*pev));
1236}
1237
0e60836b 1238static void clear_probe_trace_event(struct probe_trace_event *tev)
4235b045 1239{
0e60836b 1240 struct probe_trace_arg_ref *ref, *next;
4235b045
MH
1241 int i;
1242
1243 if (tev->event)
1244 free(tev->event);
1245 if (tev->group)
1246 free(tev->group);
1247 if (tev->point.symbol)
1248 free(tev->point.symbol);
1249 for (i = 0; i < tev->nargs; i++) {
1250 if (tev->args[i].name)
1251 free(tev->args[i].name);
1252 if (tev->args[i].value)
1253 free(tev->args[i].value);
4984912e
MH
1254 if (tev->args[i].type)
1255 free(tev->args[i].type);
4235b045
MH
1256 ref = tev->args[i].ref;
1257 while (ref) {
1258 next = ref->next;
1259 free(ref);
1260 ref = next;
1261 }
1262 }
1263 if (tev->args)
1264 free(tev->args);
1265 memset(tev, 0, sizeof(*tev));
50656eec
MH
1266}
1267
f4d7da49 1268static int open_kprobe_events(bool readwrite)
4de189fe
MH
1269{
1270 char buf[PATH_MAX];
7ca5989d 1271 const char *__debugfs;
4de189fe
MH
1272 int ret;
1273
7ca5989d
MH
1274 __debugfs = debugfs_find_mountpoint();
1275 if (__debugfs == NULL) {
1276 pr_warning("Debugfs is not mounted.\n");
1277 return -ENOENT;
1278 }
1279
1280 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
146a1439 1281 if (ret >= 0) {
7ca5989d 1282 pr_debug("Opening %s write=%d\n", buf, readwrite);
146a1439
MH
1283 if (readwrite && !probe_event_dry_run)
1284 ret = open(buf, O_RDWR, O_APPEND);
1285 else
1286 ret = open(buf, O_RDONLY, 0);
1287 }
f4d7da49 1288
4de189fe
MH
1289 if (ret < 0) {
1290 if (errno == ENOENT)
146a1439
MH
1291 pr_warning("kprobe_events file does not exist - please"
1292 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
4de189fe 1293 else
146a1439
MH
1294 pr_warning("Failed to open kprobe_events file: %s\n",
1295 strerror(errno));
4de189fe
MH
1296 }
1297 return ret;
1298}
1299
1300/* Get raw string list of current kprobe_events */
0e60836b 1301static struct strlist *get_probe_trace_command_rawlist(int fd)
4de189fe
MH
1302{
1303 int ret, idx;
1304 FILE *fp;
1305 char buf[MAX_CMDLEN];
1306 char *p;
1307 struct strlist *sl;
1308
1309 sl = strlist__new(true, NULL);
1310
1311 fp = fdopen(dup(fd), "r");
1312 while (!feof(fp)) {
1313 p = fgets(buf, MAX_CMDLEN, fp);
1314 if (!p)
1315 break;
1316
1317 idx = strlen(p) - 1;
1318 if (p[idx] == '\n')
1319 p[idx] = '\0';
1320 ret = strlist__add(sl, buf);
146a1439
MH
1321 if (ret < 0) {
1322 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1323 strlist__delete(sl);
1324 return NULL;
1325 }
4de189fe
MH
1326 }
1327 fclose(fp);
1328
1329 return sl;
1330}
1331
278498d4 1332/* Show an event */
146a1439 1333static int show_perf_probe_event(struct perf_probe_event *pev)
278498d4 1334{
7e990a51 1335 int i, ret;
278498d4 1336 char buf[128];
4235b045 1337 char *place;
278498d4 1338
4235b045
MH
1339 /* Synthesize only event probe point */
1340 place = synthesize_perf_probe_point(&pev->point);
146a1439
MH
1341 if (!place)
1342 return -EINVAL;
4235b045
MH
1343
1344 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
7e990a51 1345 if (ret < 0)
146a1439
MH
1346 return ret;
1347
fb1587d8 1348 printf(" %-20s (on %s", buf, place);
278498d4 1349
4235b045 1350 if (pev->nargs > 0) {
278498d4 1351 printf(" with");
7df2f329 1352 for (i = 0; i < pev->nargs; i++) {
146a1439
MH
1353 ret = synthesize_perf_probe_arg(&pev->args[i],
1354 buf, 128);
1355 if (ret < 0)
1356 break;
7df2f329
MH
1357 printf(" %s", buf);
1358 }
278498d4
MH
1359 }
1360 printf(")\n");
4235b045 1361 free(place);
146a1439 1362 return ret;
278498d4
MH
1363}
1364
4de189fe 1365/* List up current perf-probe events */
146a1439 1366int show_perf_probe_events(void)
4de189fe 1367{
146a1439 1368 int fd, ret;
0e60836b 1369 struct probe_trace_event tev;
4235b045 1370 struct perf_probe_event pev;
4de189fe
MH
1371 struct strlist *rawlist;
1372 struct str_node *ent;
1373
72041334 1374 setup_pager();
146a1439
MH
1375 ret = init_vmlinux();
1376 if (ret < 0)
1377 return ret;
4235b045
MH
1378
1379 memset(&tev, 0, sizeof(tev));
1380 memset(&pev, 0, sizeof(pev));
72041334 1381
f4d7da49 1382 fd = open_kprobe_events(false);
146a1439
MH
1383 if (fd < 0)
1384 return fd;
1385
0e60836b 1386 rawlist = get_probe_trace_command_rawlist(fd);
4de189fe 1387 close(fd);
146a1439
MH
1388 if (!rawlist)
1389 return -ENOENT;
4de189fe 1390
adf365f4 1391 strlist__for_each(ent, rawlist) {
0e60836b 1392 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1393 if (ret >= 0) {
1394 ret = convert_to_perf_probe_event(&tev, &pev);
1395 if (ret >= 0)
1396 ret = show_perf_probe_event(&pev);
1397 }
4235b045 1398 clear_perf_probe_event(&pev);
0e60836b 1399 clear_probe_trace_event(&tev);
146a1439
MH
1400 if (ret < 0)
1401 break;
4de189fe 1402 }
4de189fe 1403 strlist__delete(rawlist);
146a1439
MH
1404
1405 return ret;
4de189fe
MH
1406}
1407
b498ce1f 1408/* Get current perf-probe event names */
0e60836b 1409static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
b498ce1f 1410{
fa28244d 1411 char buf[128];
b498ce1f
MH
1412 struct strlist *sl, *rawlist;
1413 struct str_node *ent;
0e60836b 1414 struct probe_trace_event tev;
146a1439 1415 int ret = 0;
b498ce1f 1416
4235b045 1417 memset(&tev, 0, sizeof(tev));
0e60836b 1418 rawlist = get_probe_trace_command_rawlist(fd);
e1d2017b 1419 sl = strlist__new(true, NULL);
adf365f4 1420 strlist__for_each(ent, rawlist) {
0e60836b 1421 ret = parse_probe_trace_command(ent->s, &tev);
146a1439
MH
1422 if (ret < 0)
1423 break;
fa28244d 1424 if (include_group) {
146a1439
MH
1425 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1426 tev.event);
1427 if (ret >= 0)
1428 ret = strlist__add(sl, buf);
fa28244d 1429 } else
146a1439 1430 ret = strlist__add(sl, tev.event);
0e60836b 1431 clear_probe_trace_event(&tev);
146a1439
MH
1432 if (ret < 0)
1433 break;
b498ce1f 1434 }
b498ce1f
MH
1435 strlist__delete(rawlist);
1436
146a1439
MH
1437 if (ret < 0) {
1438 strlist__delete(sl);
1439 return NULL;
1440 }
b498ce1f
MH
1441 return sl;
1442}
1443
0e60836b 1444static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
50656eec 1445{
6eca8cc3 1446 int ret = 0;
0e60836b 1447 char *buf = synthesize_probe_trace_command(tev);
50656eec 1448
146a1439 1449 if (!buf) {
0e60836b 1450 pr_debug("Failed to synthesize probe trace event.\n");
146a1439
MH
1451 return -EINVAL;
1452 }
1453
fa28244d 1454 pr_debug("Writing event: %s\n", buf);
f4d7da49
MH
1455 if (!probe_event_dry_run) {
1456 ret = write(fd, buf, strlen(buf));
1457 if (ret <= 0)
146a1439
MH
1458 pr_warning("Failed to write event: %s\n",
1459 strerror(errno));
f4d7da49 1460 }
4235b045 1461 free(buf);
146a1439 1462 return ret;
50656eec
MH
1463}
1464
146a1439
MH
1465static int get_new_event_name(char *buf, size_t len, const char *base,
1466 struct strlist *namelist, bool allow_suffix)
b498ce1f
MH
1467{
1468 int i, ret;
17f88fcd
MH
1469
1470 /* Try no suffix */
1471 ret = e_snprintf(buf, len, "%s", base);
146a1439
MH
1472 if (ret < 0) {
1473 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1474 return ret;
1475 }
17f88fcd 1476 if (!strlist__has_entry(namelist, buf))
146a1439 1477 return 0;
17f88fcd 1478
d761b08b
MH
1479 if (!allow_suffix) {
1480 pr_warning("Error: event \"%s\" already exists. "
1481 "(Use -f to force duplicates.)\n", base);
146a1439 1482 return -EEXIST;
d761b08b
MH
1483 }
1484
17f88fcd
MH
1485 /* Try to add suffix */
1486 for (i = 1; i < MAX_EVENT_INDEX; i++) {
b498ce1f 1487 ret = e_snprintf(buf, len, "%s_%d", base, i);
146a1439
MH
1488 if (ret < 0) {
1489 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1490 return ret;
1491 }
b498ce1f
MH
1492 if (!strlist__has_entry(namelist, buf))
1493 break;
1494 }
146a1439
MH
1495 if (i == MAX_EVENT_INDEX) {
1496 pr_warning("Too many events are on the same function.\n");
1497 ret = -ERANGE;
1498 }
1499
1500 return ret;
b498ce1f
MH
1501}
1502
0e60836b
SD
1503static int __add_probe_trace_events(struct perf_probe_event *pev,
1504 struct probe_trace_event *tevs,
146a1439 1505 int ntevs, bool allow_suffix)
50656eec 1506{
146a1439 1507 int i, fd, ret;
0e60836b 1508 struct probe_trace_event *tev = NULL;
4235b045
MH
1509 char buf[64];
1510 const char *event, *group;
b498ce1f 1511 struct strlist *namelist;
50656eec 1512
f4d7da49 1513 fd = open_kprobe_events(true);
146a1439
MH
1514 if (fd < 0)
1515 return fd;
b498ce1f 1516 /* Get current event names */
0e60836b 1517 namelist = get_probe_trace_event_names(fd, false);
146a1439
MH
1518 if (!namelist) {
1519 pr_debug("Failed to get current event list.\n");
1520 return -EIO;
1521 }
4235b045 1522
146a1439 1523 ret = 0;
4235b045 1524 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
02b95dad 1525 for (i = 0; i < ntevs; i++) {
4235b045
MH
1526 tev = &tevs[i];
1527 if (pev->event)
1528 event = pev->event;
1529 else
1530 if (pev->point.function)
1531 event = pev->point.function;
1532 else
1533 event = tev->point.symbol;
1534 if (pev->group)
1535 group = pev->group;
1536 else
1537 group = PERFPROBE_GROUP;
1538
1539 /* Get an unused new event name */
146a1439
MH
1540 ret = get_new_event_name(buf, 64, event,
1541 namelist, allow_suffix);
1542 if (ret < 0)
1543 break;
4235b045
MH
1544 event = buf;
1545
02b95dad
MH
1546 tev->event = strdup(event);
1547 tev->group = strdup(group);
1548 if (tev->event == NULL || tev->group == NULL) {
1549 ret = -ENOMEM;
1550 break;
1551 }
0e60836b 1552 ret = write_probe_trace_event(fd, tev);
146a1439
MH
1553 if (ret < 0)
1554 break;
4235b045
MH
1555 /* Add added event name to namelist */
1556 strlist__add(namelist, event);
1557
1558 /* Trick here - save current event/group */
1559 event = pev->event;
1560 group = pev->group;
1561 pev->event = tev->event;
1562 pev->group = tev->group;
1563 show_perf_probe_event(pev);
1564 /* Trick here - restore current event/group */
1565 pev->event = (char *)event;
1566 pev->group = (char *)group;
1567
1568 /*
1569 * Probes after the first probe which comes from same
1570 * user input are always allowed to add suffix, because
1571 * there might be several addresses corresponding to
1572 * one code line.
1573 */
1574 allow_suffix = true;
50656eec 1575 }
146a1439
MH
1576
1577 if (ret >= 0) {
1578 /* Show how to use the event. */
1579 printf("\nYou can now use it on all perf tools, such as:\n\n");
1580 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1581 tev->event);
1582 }
a9b495b0 1583
e1d2017b 1584 strlist__delete(namelist);
50656eec 1585 close(fd);
146a1439 1586 return ret;
50656eec 1587}
fa28244d 1588
0e60836b
SD
1589static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1590 struct probe_trace_event **tevs,
ef4a3565 1591 int max_tevs)
e0faa8d3
MH
1592{
1593 struct symbol *sym;
e334016f 1594 int ret = 0, i;
0e60836b 1595 struct probe_trace_event *tev;
4235b045 1596
4b4da7f7 1597 /* Convert perf_probe_event with debuginfo */
0e60836b 1598 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs);
e334016f
MH
1599 if (ret != 0)
1600 return ret;
e0faa8d3 1601
4235b045 1602 /* Allocate trace event buffer */
0e60836b 1603 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
e334016f
MH
1604 if (tev == NULL)
1605 return -ENOMEM;
4235b045
MH
1606
1607 /* Copy parameters */
02b95dad
MH
1608 tev->point.symbol = strdup(pev->point.function);
1609 if (tev->point.symbol == NULL) {
1610 ret = -ENOMEM;
1611 goto error;
1612 }
4235b045 1613 tev->point.offset = pev->point.offset;
04ddd04b 1614 tev->point.retprobe = pev->point.retprobe;
4235b045
MH
1615 tev->nargs = pev->nargs;
1616 if (tev->nargs) {
0e60836b 1617 tev->args = zalloc(sizeof(struct probe_trace_arg)
e334016f
MH
1618 * tev->nargs);
1619 if (tev->args == NULL) {
02b95dad
MH
1620 ret = -ENOMEM;
1621 goto error;
e334016f 1622 }
48481938 1623 for (i = 0; i < tev->nargs; i++) {
02b95dad
MH
1624 if (pev->args[i].name) {
1625 tev->args[i].name = strdup(pev->args[i].name);
1626 if (tev->args[i].name == NULL) {
1627 ret = -ENOMEM;
1628 goto error;
1629 }
1630 }
1631 tev->args[i].value = strdup(pev->args[i].var);
1632 if (tev->args[i].value == NULL) {
1633 ret = -ENOMEM;
1634 goto error;
1635 }
1636 if (pev->args[i].type) {
1637 tev->args[i].type = strdup(pev->args[i].type);
1638 if (tev->args[i].type == NULL) {
1639 ret = -ENOMEM;
1640 goto error;
1641 }
1642 }
48481938 1643 }
4235b045
MH
1644 }
1645
1646 /* Currently just checking function name from symbol map */
d28c6223 1647 sym = map__find_symbol_by_name(machine.vmlinux_maps[MAP__FUNCTION],
4235b045 1648 tev->point.symbol, NULL);
146a1439
MH
1649 if (!sym) {
1650 pr_warning("Kernel symbol \'%s\' not found.\n",
1651 tev->point.symbol);
02b95dad
MH
1652 ret = -ENOENT;
1653 goto error;
1654 }
e334016f 1655
02b95dad
MH
1656 return 1;
1657error:
0e60836b 1658 clear_probe_trace_event(tev);
02b95dad
MH
1659 free(tev);
1660 *tevs = NULL;
e334016f 1661 return ret;
4235b045
MH
1662}
1663
1664struct __event_package {
1665 struct perf_probe_event *pev;
0e60836b 1666 struct probe_trace_event *tevs;
4235b045
MH
1667 int ntevs;
1668};
1669
146a1439 1670int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
c82ec0a2 1671 int max_tevs, bool force_add)
4235b045 1672{
146a1439 1673 int i, j, ret;
4235b045
MH
1674 struct __event_package *pkgs;
1675
e334016f
MH
1676 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1677 if (pkgs == NULL)
1678 return -ENOMEM;
4235b045
MH
1679
1680 /* Init vmlinux path */
146a1439 1681 ret = init_vmlinux();
449e5b24
MH
1682 if (ret < 0) {
1683 free(pkgs);
146a1439 1684 return ret;
449e5b24 1685 }
4235b045
MH
1686
1687 /* Loop 1: convert all events */
1688 for (i = 0; i < npevs; i++) {
1689 pkgs[i].pev = &pevs[i];
1690 /* Convert with or without debuginfo */
0e60836b 1691 ret = convert_to_probe_trace_events(pkgs[i].pev,
ef4a3565 1692 &pkgs[i].tevs, max_tevs);
146a1439
MH
1693 if (ret < 0)
1694 goto end;
1695 pkgs[i].ntevs = ret;
e0faa8d3
MH
1696 }
1697
4235b045 1698 /* Loop 2: add all events */
146a1439 1699 for (i = 0; i < npevs && ret >= 0; i++)
0e60836b 1700 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
146a1439
MH
1701 pkgs[i].ntevs, force_add);
1702end:
449e5b24
MH
1703 /* Loop 3: cleanup and free trace events */
1704 for (i = 0; i < npevs; i++) {
146a1439 1705 for (j = 0; j < pkgs[i].ntevs; j++)
0e60836b 1706 clear_probe_trace_event(&pkgs[i].tevs[j]);
449e5b24
MH
1707 free(pkgs[i].tevs);
1708 }
1709 free(pkgs);
146a1439
MH
1710
1711 return ret;
e0faa8d3
MH
1712}
1713
0e60836b 1714static int __del_trace_probe_event(int fd, struct str_node *ent)
bbbb521b
MH
1715{
1716 char *p;
1717 char buf[128];
4235b045 1718 int ret;
bbbb521b 1719
0e60836b 1720 /* Convert from perf-probe event to trace-probe event */
146a1439
MH
1721 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1722 if (ret < 0)
1723 goto error;
1724
bbbb521b 1725 p = strchr(buf + 2, ':');
146a1439
MH
1726 if (!p) {
1727 pr_debug("Internal error: %s should have ':' but not.\n",
1728 ent->s);
1729 ret = -ENOTSUP;
1730 goto error;
1731 }
bbbb521b
MH
1732 *p = '/';
1733
4235b045
MH
1734 pr_debug("Writing event: %s\n", buf);
1735 ret = write(fd, buf, strlen(buf));
146a1439
MH
1736 if (ret < 0)
1737 goto error;
1738
bbbb521b 1739 printf("Remove event: %s\n", ent->s);
146a1439
MH
1740 return 0;
1741error:
1742 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1743 return ret;
bbbb521b
MH
1744}
1745
0e60836b 1746static int del_trace_probe_event(int fd, const char *group,
146a1439 1747 const char *event, struct strlist *namelist)
fa28244d
MH
1748{
1749 char buf[128];
bbbb521b 1750 struct str_node *ent, *n;
146a1439 1751 int found = 0, ret = 0;
fa28244d 1752
146a1439
MH
1753 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1754 if (ret < 0) {
1755 pr_err("Failed to copy event.");
1756 return ret;
1757 }
fa28244d 1758
bbbb521b
MH
1759 if (strpbrk(buf, "*?")) { /* Glob-exp */
1760 strlist__for_each_safe(ent, n, namelist)
1761 if (strglobmatch(ent->s, buf)) {
1762 found++;
0e60836b 1763 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1764 if (ret < 0)
1765 break;
bbbb521b
MH
1766 strlist__remove(namelist, ent);
1767 }
1768 } else {
1769 ent = strlist__find(namelist, buf);
1770 if (ent) {
1771 found++;
0e60836b 1772 ret = __del_trace_probe_event(fd, ent);
146a1439
MH
1773 if (ret >= 0)
1774 strlist__remove(namelist, ent);
bbbb521b
MH
1775 }
1776 }
146a1439
MH
1777 if (found == 0 && ret >= 0)
1778 pr_info("Info: Event \"%s\" does not exist.\n", buf);
1779
1780 return ret;
fa28244d
MH
1781}
1782
146a1439 1783int del_perf_probe_events(struct strlist *dellist)
fa28244d 1784{
146a1439 1785 int fd, ret = 0;
fa28244d
MH
1786 const char *group, *event;
1787 char *p, *str;
1788 struct str_node *ent;
1789 struct strlist *namelist;
1790
f4d7da49 1791 fd = open_kprobe_events(true);
146a1439
MH
1792 if (fd < 0)
1793 return fd;
1794
fa28244d 1795 /* Get current event names */
0e60836b 1796 namelist = get_probe_trace_event_names(fd, true);
146a1439
MH
1797 if (namelist == NULL)
1798 return -EINVAL;
fa28244d 1799
adf365f4 1800 strlist__for_each(ent, dellist) {
02b95dad
MH
1801 str = strdup(ent->s);
1802 if (str == NULL) {
1803 ret = -ENOMEM;
1804 break;
1805 }
bbbb521b 1806 pr_debug("Parsing: %s\n", str);
fa28244d
MH
1807 p = strchr(str, ':');
1808 if (p) {
1809 group = str;
1810 *p = '\0';
1811 event = p + 1;
1812 } else {
bbbb521b 1813 group = "*";
fa28244d
MH
1814 event = str;
1815 }
bbbb521b 1816 pr_debug("Group: %s, Event: %s\n", group, event);
0e60836b 1817 ret = del_trace_probe_event(fd, group, event, namelist);
fa28244d 1818 free(str);
146a1439
MH
1819 if (ret < 0)
1820 break;
fa28244d
MH
1821 }
1822 strlist__delete(namelist);
1823 close(fd);
146a1439
MH
1824
1825 return ret;
fa28244d
MH
1826}
1827