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