perf probe: Fix line range to show end line
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / tools / perf / util / probe-event.c
blob5bf8ab034466b4977e1fdcdeef819ab00a0c517b
1 /*
2 * probe-event.c : perf-probe definition to kprobe_events format converter
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
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.
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.
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.
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>
32 #include <stdarg.h>
33 #include <limits.h>
35 #undef _GNU_SOURCE
36 #include "util.h"
37 #include "event.h"
38 #include "string.h"
39 #include "strlist.h"
40 #include "debug.h"
41 #include "cache.h"
42 #include "color.h"
43 #include "symbol.h"
44 #include "thread.h"
45 #include "debugfs.h"
46 #include "trace-event.h" /* For __unused */
47 #include "probe-event.h"
48 #include "probe-finder.h"
50 #define MAX_CMDLEN 256
51 #define MAX_PROBE_ARGS 128
52 #define PERFPROBE_GROUP "probe"
54 bool probe_event_dry_run; /* Dry run flag */
56 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
58 /* If there is no space to write, returns -E2BIG. */
59 static int e_snprintf(char *str, size_t size, const char *format, ...)
60 __attribute__((format(printf, 3, 4)));
62 static int e_snprintf(char *str, size_t size, const char *format, ...)
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;
74 static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
75 static struct map_groups kmap_groups;
76 static struct map *kmaps[MAP__NR_TYPES];
78 /* Initialize symbol maps and path of vmlinux */
79 static int init_vmlinux(void)
81 int ret;
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);
88 ret = symbol__init();
89 if (ret < 0) {
90 pr_debug("Failed to init symbol map.\n");
91 goto out;
94 map_groups__init(&kmap_groups);
95 ret = map_groups__create_kernel_maps(&kmap_groups, kmaps);
96 if (ret < 0)
97 pr_debug("Failed to create kernel maps.\n");
99 out:
100 if (ret < 0)
101 pr_warning("Failed to init vmlinux path.\n");
102 return ret;
105 #ifdef DWARF_SUPPORT
106 static int open_vmlinux(void)
108 if (map__load(kmaps[MAP__FUNCTION], NULL) < 0) {
109 pr_debug("Failed to load kernel map.\n");
110 return -EINVAL;
112 pr_debug("Try to open %s\n", kmaps[MAP__FUNCTION]->dso->long_name);
113 return open(kmaps[MAP__FUNCTION]->dso->long_name, O_RDONLY);
116 /* Convert trace point to probe point with debuginfo */
117 static int convert_to_perf_probe_point(struct kprobe_trace_point *tp,
118 struct perf_probe_point *pp)
120 struct symbol *sym;
121 int fd, ret = -ENOENT;
123 sym = map__find_symbol_by_name(kmaps[MAP__FUNCTION],
124 tp->symbol, NULL);
125 if (sym) {
126 fd = open_vmlinux();
127 if (fd >= 0) {
128 ret = find_perf_probe_point(fd,
129 sym->start + tp->offset, pp);
130 close(fd);
133 if (ret <= 0) {
134 pr_debug("Failed to find corresponding probes from "
135 "debuginfo. Use kprobe event information.\n");
136 pp->function = strdup(tp->symbol);
137 if (pp->function == NULL)
138 return -ENOMEM;
139 pp->offset = tp->offset;
141 pp->retprobe = tp->retprobe;
143 return 0;
146 /* Try to find perf_probe_event with debuginfo */
147 static int try_to_find_kprobe_trace_events(struct perf_probe_event *pev,
148 struct kprobe_trace_event **tevs)
150 bool need_dwarf = perf_probe_event_need_dwarf(pev);
151 int fd, ntevs;
153 fd = open_vmlinux();
154 if (fd < 0) {
155 if (need_dwarf) {
156 pr_warning("Failed to open debuginfo file.\n");
157 return fd;
159 pr_debug("Could not open vmlinux. Try to use symbols.\n");
160 return 0;
163 /* Searching trace events corresponding to probe event */
164 ntevs = find_kprobe_trace_events(fd, pev, tevs);
165 close(fd);
167 if (ntevs > 0) { /* Succeeded to find trace events */
168 pr_debug("find %d kprobe_trace_events.\n", ntevs);
169 return ntevs;
172 if (ntevs == 0) { /* No error but failed to find probe point. */
173 pr_warning("Probe point '%s' not found.\n",
174 synthesize_perf_probe_point(&pev->point));
175 return -ENOENT;
177 /* Error path : ntevs < 0 */
178 if (need_dwarf) {
179 if (ntevs == -EBADF)
180 pr_warning("No dwarf info found in the vmlinux - "
181 "please rebuild with CONFIG_DEBUG_INFO=y.\n");
182 return ntevs;
184 pr_debug("An error occurred in debuginfo analysis."
185 " Try to use symbols.\n");
186 return 0;
189 #define LINEBUF_SIZE 256
190 #define NR_ADDITIONAL_LINES 2
192 static int show_one_line(FILE *fp, int l, bool skip, bool show_num)
194 char buf[LINEBUF_SIZE];
195 const char *color = PERF_COLOR_BLUE;
197 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
198 goto error;
199 if (!skip) {
200 if (show_num)
201 fprintf(stdout, "%7d %s", l, buf);
202 else
203 color_fprintf(stdout, color, " %s", buf);
206 while (strlen(buf) == LINEBUF_SIZE - 1 &&
207 buf[LINEBUF_SIZE - 2] != '\n') {
208 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
209 goto error;
210 if (!skip) {
211 if (show_num)
212 fprintf(stdout, "%s", buf);
213 else
214 color_fprintf(stdout, color, "%s", buf);
218 return 0;
219 error:
220 if (feof(fp))
221 pr_warning("Source file is shorter than expected.\n");
222 else
223 pr_warning("File read error: %s\n", strerror(errno));
225 return -1;
229 * Show line-range always requires debuginfo to find source file and
230 * line number.
232 int show_line_range(struct line_range *lr)
234 int l = 1;
235 struct line_node *ln;
236 FILE *fp;
237 int fd, ret;
239 /* Search a line range */
240 ret = init_vmlinux();
241 if (ret < 0)
242 return ret;
244 fd = open_vmlinux();
245 if (fd < 0) {
246 pr_warning("Failed to open debuginfo file.\n");
247 return fd;
250 ret = find_line_range(fd, lr);
251 close(fd);
252 if (ret == 0) {
253 pr_warning("Specified source line is not found.\n");
254 return -ENOENT;
255 } else if (ret < 0) {
256 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
257 return ret;
260 setup_pager();
262 if (lr->function)
263 fprintf(stdout, "<%s:%d>\n", lr->function,
264 lr->start - lr->offset);
265 else
266 fprintf(stdout, "<%s:%d>\n", lr->file, lr->start);
268 fp = fopen(lr->path, "r");
269 if (fp == NULL) {
270 pr_warning("Failed to open %s: %s\n", lr->path,
271 strerror(errno));
272 return -errno;
274 /* Skip to starting line number */
275 while (l < lr->start && ret >= 0)
276 ret = show_one_line(fp, l++, true, false);
277 if (ret < 0)
278 goto end;
280 list_for_each_entry(ln, &lr->line_list, list) {
281 while (ln->line > l && ret >= 0)
282 ret = show_one_line(fp, (l++) - lr->offset,
283 false, false);
284 if (ret >= 0)
285 ret = show_one_line(fp, (l++) - lr->offset,
286 false, true);
287 if (ret < 0)
288 goto end;
291 if (lr->end == INT_MAX)
292 lr->end = l + NR_ADDITIONAL_LINES;
293 while (l <= lr->end && !feof(fp) && ret >= 0)
294 ret = show_one_line(fp, (l++) - lr->offset, false, false);
295 end:
296 fclose(fp);
297 return ret;
300 #else /* !DWARF_SUPPORT */
302 static int convert_to_perf_probe_point(struct kprobe_trace_point *tp,
303 struct perf_probe_point *pp)
305 pp->function = strdup(tp->symbol);
306 if (pp->function == NULL)
307 return -ENOMEM;
308 pp->offset = tp->offset;
309 pp->retprobe = tp->retprobe;
311 return 0;
314 static int try_to_find_kprobe_trace_events(struct perf_probe_event *pev,
315 struct kprobe_trace_event **tevs __unused)
317 if (perf_probe_event_need_dwarf(pev)) {
318 pr_warning("Debuginfo-analysis is not supported.\n");
319 return -ENOSYS;
321 return 0;
324 int show_line_range(struct line_range *lr __unused)
326 pr_warning("Debuginfo-analysis is not supported.\n");
327 return -ENOSYS;
330 #endif
332 int parse_line_range_desc(const char *arg, struct line_range *lr)
334 const char *ptr;
335 char *tmp;
337 * <Syntax>
338 * SRC:SLN[+NUM|-ELN]
339 * FUNC[:SLN[+NUM|-ELN]]
341 ptr = strchr(arg, ':');
342 if (ptr) {
343 lr->start = (int)strtoul(ptr + 1, &tmp, 0);
344 if (*tmp == '+') {
345 lr->end = lr->start + (int)strtoul(tmp + 1, &tmp, 0);
346 lr->end--; /*
347 * Adjust the number of lines here.
348 * If the number of lines == 1, the
349 * the end of line should be equal to
350 * the start of line.
352 } else if (*tmp == '-')
353 lr->end = (int)strtoul(tmp + 1, &tmp, 0);
354 else
355 lr->end = INT_MAX;
356 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
357 if (lr->start > lr->end) {
358 semantic_error("Start line must be smaller"
359 " than end line.\n");
360 return -EINVAL;
362 if (*tmp != '\0') {
363 semantic_error("Tailing with invalid character '%d'.\n",
364 *tmp);
365 return -EINVAL;
367 tmp = strndup(arg, (ptr - arg));
368 } else {
369 tmp = strdup(arg);
370 lr->end = INT_MAX;
373 if (tmp == NULL)
374 return -ENOMEM;
376 if (strchr(tmp, '.'))
377 lr->file = tmp;
378 else
379 lr->function = tmp;
381 return 0;
384 /* Check the name is good for event/group */
385 static bool check_event_name(const char *name)
387 if (!isalpha(*name) && *name != '_')
388 return false;
389 while (*++name != '\0') {
390 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
391 return false;
393 return true;
396 /* Parse probepoint definition. */
397 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
399 struct perf_probe_point *pp = &pev->point;
400 char *ptr, *tmp;
401 char c, nc = 0;
403 * <Syntax>
404 * perf probe [EVENT=]SRC[:LN|;PTN]
405 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
407 * TODO:Group name support
410 ptr = strpbrk(arg, ";=@+%");
411 if (ptr && *ptr == '=') { /* Event name */
412 *ptr = '\0';
413 tmp = ptr + 1;
414 if (strchr(arg, ':')) {
415 semantic_error("Group name is not supported yet.\n");
416 return -ENOTSUP;
418 if (!check_event_name(arg)) {
419 semantic_error("%s is bad for event name -it must "
420 "follow C symbol-naming rule.\n", arg);
421 return -EINVAL;
423 pev->event = strdup(arg);
424 if (pev->event == NULL)
425 return -ENOMEM;
426 pev->group = NULL;
427 arg = tmp;
430 ptr = strpbrk(arg, ";:+@%");
431 if (ptr) {
432 nc = *ptr;
433 *ptr++ = '\0';
436 tmp = strdup(arg);
437 if (tmp == NULL)
438 return -ENOMEM;
440 /* Check arg is function or file and copy it */
441 if (strchr(tmp, '.')) /* File */
442 pp->file = tmp;
443 else /* Function */
444 pp->function = tmp;
446 /* Parse other options */
447 while (ptr) {
448 arg = ptr;
449 c = nc;
450 if (c == ';') { /* Lazy pattern must be the last part */
451 pp->lazy_line = strdup(arg);
452 if (pp->lazy_line == NULL)
453 return -ENOMEM;
454 break;
456 ptr = strpbrk(arg, ";:+@%");
457 if (ptr) {
458 nc = *ptr;
459 *ptr++ = '\0';
461 switch (c) {
462 case ':': /* Line number */
463 pp->line = strtoul(arg, &tmp, 0);
464 if (*tmp != '\0') {
465 semantic_error("There is non-digit char"
466 " in line number.\n");
467 return -EINVAL;
469 break;
470 case '+': /* Byte offset from a symbol */
471 pp->offset = strtoul(arg, &tmp, 0);
472 if (*tmp != '\0') {
473 semantic_error("There is non-digit character"
474 " in offset.\n");
475 return -EINVAL;
477 break;
478 case '@': /* File name */
479 if (pp->file) {
480 semantic_error("SRC@SRC is not allowed.\n");
481 return -EINVAL;
483 pp->file = strdup(arg);
484 if (pp->file == NULL)
485 return -ENOMEM;
486 break;
487 case '%': /* Probe places */
488 if (strcmp(arg, "return") == 0) {
489 pp->retprobe = 1;
490 } else { /* Others not supported yet */
491 semantic_error("%%%s is not supported.\n", arg);
492 return -ENOTSUP;
494 break;
495 default: /* Buggy case */
496 pr_err("This program has a bug at %s:%d.\n",
497 __FILE__, __LINE__);
498 return -ENOTSUP;
499 break;
503 /* Exclusion check */
504 if (pp->lazy_line && pp->line) {
505 semantic_error("Lazy pattern can't be used with line number.");
506 return -EINVAL;
509 if (pp->lazy_line && pp->offset) {
510 semantic_error("Lazy pattern can't be used with offset.");
511 return -EINVAL;
514 if (pp->line && pp->offset) {
515 semantic_error("Offset can't be used with line number.");
516 return -EINVAL;
519 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
520 semantic_error("File always requires line number or "
521 "lazy pattern.");
522 return -EINVAL;
525 if (pp->offset && !pp->function) {
526 semantic_error("Offset requires an entry function.");
527 return -EINVAL;
530 if (pp->retprobe && !pp->function) {
531 semantic_error("Return probe requires an entry function.");
532 return -EINVAL;
535 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
536 semantic_error("Offset/Line/Lazy pattern can't be used with "
537 "return probe.");
538 return -EINVAL;
541 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
542 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
543 pp->lazy_line);
544 return 0;
547 /* Parse perf-probe event argument */
548 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
550 char *tmp;
551 struct perf_probe_arg_field **fieldp;
553 pr_debug("parsing arg: %s into ", str);
555 tmp = strchr(str, '=');
556 if (tmp) {
557 arg->name = strndup(str, tmp - str);
558 if (arg->name == NULL)
559 return -ENOMEM;
560 pr_debug("name:%s ", arg->name);
561 str = tmp + 1;
564 tmp = strchr(str, ':');
565 if (tmp) { /* Type setting */
566 *tmp = '\0';
567 arg->type = strdup(tmp + 1);
568 if (arg->type == NULL)
569 return -ENOMEM;
570 pr_debug("type:%s ", arg->type);
573 tmp = strpbrk(str, "-.");
574 if (!is_c_varname(str) || !tmp) {
575 /* A variable, register, symbol or special value */
576 arg->var = strdup(str);
577 if (arg->var == NULL)
578 return -ENOMEM;
579 pr_debug("%s\n", arg->var);
580 return 0;
583 /* Structure fields */
584 arg->var = strndup(str, tmp - str);
585 if (arg->var == NULL)
586 return -ENOMEM;
587 pr_debug("%s, ", arg->var);
588 fieldp = &arg->field;
590 do {
591 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
592 if (*fieldp == NULL)
593 return -ENOMEM;
594 if (*tmp == '.') {
595 str = tmp + 1;
596 (*fieldp)->ref = false;
597 } else if (tmp[1] == '>') {
598 str = tmp + 2;
599 (*fieldp)->ref = true;
600 } else {
601 semantic_error("Argument parse error: %s\n", str);
602 return -EINVAL;
605 tmp = strpbrk(str, "-.");
606 if (tmp) {
607 (*fieldp)->name = strndup(str, tmp - str);
608 if ((*fieldp)->name == NULL)
609 return -ENOMEM;
610 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
611 fieldp = &(*fieldp)->next;
613 } while (tmp);
614 (*fieldp)->name = strdup(str);
615 if ((*fieldp)->name == NULL)
616 return -ENOMEM;
617 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
619 /* If no name is specified, set the last field name */
620 if (!arg->name) {
621 arg->name = strdup((*fieldp)->name);
622 if (arg->name == NULL)
623 return -ENOMEM;
625 return 0;
628 /* Parse perf-probe event command */
629 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
631 char **argv;
632 int argc, i, ret = 0;
634 argv = argv_split(cmd, &argc);
635 if (!argv) {
636 pr_debug("Failed to split arguments.\n");
637 return -ENOMEM;
639 if (argc - 1 > MAX_PROBE_ARGS) {
640 semantic_error("Too many probe arguments (%d).\n", argc - 1);
641 ret = -ERANGE;
642 goto out;
644 /* Parse probe point */
645 ret = parse_perf_probe_point(argv[0], pev);
646 if (ret < 0)
647 goto out;
649 /* Copy arguments and ensure return probe has no C argument */
650 pev->nargs = argc - 1;
651 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
652 if (pev->args == NULL) {
653 ret = -ENOMEM;
654 goto out;
656 for (i = 0; i < pev->nargs && ret >= 0; i++) {
657 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
658 if (ret >= 0 &&
659 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
660 semantic_error("You can't specify local variable for"
661 " kretprobe.\n");
662 ret = -EINVAL;
665 out:
666 argv_free(argv);
668 return ret;
671 /* Return true if this perf_probe_event requires debuginfo */
672 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
674 int i;
676 if (pev->point.file || pev->point.line || pev->point.lazy_line)
677 return true;
679 for (i = 0; i < pev->nargs; i++)
680 if (is_c_varname(pev->args[i].var))
681 return true;
683 return false;
686 /* Parse kprobe_events event into struct probe_point */
687 int parse_kprobe_trace_command(const char *cmd, struct kprobe_trace_event *tev)
689 struct kprobe_trace_point *tp = &tev->point;
690 char pr;
691 char *p;
692 int ret, i, argc;
693 char **argv;
695 pr_debug("Parsing kprobe_events: %s\n", cmd);
696 argv = argv_split(cmd, &argc);
697 if (!argv) {
698 pr_debug("Failed to split arguments.\n");
699 return -ENOMEM;
701 if (argc < 2) {
702 semantic_error("Too few probe arguments.\n");
703 ret = -ERANGE;
704 goto out;
707 /* Scan event and group name. */
708 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
709 &pr, (float *)(void *)&tev->group,
710 (float *)(void *)&tev->event);
711 if (ret != 3) {
712 semantic_error("Failed to parse event name: %s\n", argv[0]);
713 ret = -EINVAL;
714 goto out;
716 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
718 tp->retprobe = (pr == 'r');
720 /* Scan function name and offset */
721 ret = sscanf(argv[1], "%a[^+]+%lu", (float *)(void *)&tp->symbol,
722 &tp->offset);
723 if (ret == 1)
724 tp->offset = 0;
726 tev->nargs = argc - 2;
727 tev->args = zalloc(sizeof(struct kprobe_trace_arg) * tev->nargs);
728 if (tev->args == NULL) {
729 ret = -ENOMEM;
730 goto out;
732 for (i = 0; i < tev->nargs; i++) {
733 p = strchr(argv[i + 2], '=');
734 if (p) /* We don't need which register is assigned. */
735 *p++ = '\0';
736 else
737 p = argv[i + 2];
738 tev->args[i].name = strdup(argv[i + 2]);
739 /* TODO: parse regs and offset */
740 tev->args[i].value = strdup(p);
741 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
742 ret = -ENOMEM;
743 goto out;
746 ret = 0;
747 out:
748 argv_free(argv);
749 return ret;
752 /* Compose only probe arg */
753 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
755 struct perf_probe_arg_field *field = pa->field;
756 int ret;
757 char *tmp = buf;
759 if (pa->name && pa->var)
760 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
761 else
762 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
763 if (ret <= 0)
764 goto error;
765 tmp += ret;
766 len -= ret;
768 while (field) {
769 ret = e_snprintf(tmp, len, "%s%s", field->ref ? "->" : ".",
770 field->name);
771 if (ret <= 0)
772 goto error;
773 tmp += ret;
774 len -= ret;
775 field = field->next;
778 if (pa->type) {
779 ret = e_snprintf(tmp, len, ":%s", pa->type);
780 if (ret <= 0)
781 goto error;
782 tmp += ret;
783 len -= ret;
786 return tmp - buf;
787 error:
788 pr_debug("Failed to synthesize perf probe argument: %s",
789 strerror(-ret));
790 return ret;
793 /* Compose only probe point (not argument) */
794 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
796 char *buf, *tmp;
797 char offs[32] = "", line[32] = "", file[32] = "";
798 int ret, len;
800 buf = zalloc(MAX_CMDLEN);
801 if (buf == NULL) {
802 ret = -ENOMEM;
803 goto error;
805 if (pp->offset) {
806 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
807 if (ret <= 0)
808 goto error;
810 if (pp->line) {
811 ret = e_snprintf(line, 32, ":%d", pp->line);
812 if (ret <= 0)
813 goto error;
815 if (pp->file) {
816 len = strlen(pp->file) - 31;
817 if (len < 0)
818 len = 0;
819 tmp = strchr(pp->file + len, '/');
820 if (!tmp)
821 tmp = pp->file + len;
822 ret = e_snprintf(file, 32, "@%s", tmp + 1);
823 if (ret <= 0)
824 goto error;
827 if (pp->function)
828 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
829 offs, pp->retprobe ? "%return" : "", line,
830 file);
831 else
832 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
833 if (ret <= 0)
834 goto error;
836 return buf;
837 error:
838 pr_debug("Failed to synthesize perf probe point: %s",
839 strerror(-ret));
840 if (buf)
841 free(buf);
842 return NULL;
845 #if 0
846 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
848 char *buf;
849 int i, len, ret;
851 buf = synthesize_perf_probe_point(&pev->point);
852 if (!buf)
853 return NULL;
855 len = strlen(buf);
856 for (i = 0; i < pev->nargs; i++) {
857 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
858 pev->args[i].name);
859 if (ret <= 0) {
860 free(buf);
861 return NULL;
863 len += ret;
866 return buf;
868 #endif
870 static int __synthesize_kprobe_trace_arg_ref(struct kprobe_trace_arg_ref *ref,
871 char **buf, size_t *buflen,
872 int depth)
874 int ret;
875 if (ref->next) {
876 depth = __synthesize_kprobe_trace_arg_ref(ref->next, buf,
877 buflen, depth + 1);
878 if (depth < 0)
879 goto out;
882 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
883 if (ret < 0)
884 depth = ret;
885 else {
886 *buf += ret;
887 *buflen -= ret;
889 out:
890 return depth;
894 static int synthesize_kprobe_trace_arg(struct kprobe_trace_arg *arg,
895 char *buf, size_t buflen)
897 int ret, depth = 0;
898 char *tmp = buf;
900 /* Argument name or separator */
901 if (arg->name)
902 ret = e_snprintf(buf, buflen, " %s=", arg->name);
903 else
904 ret = e_snprintf(buf, buflen, " ");
905 if (ret < 0)
906 return ret;
907 buf += ret;
908 buflen -= ret;
910 /* Dereferencing arguments */
911 if (arg->ref) {
912 depth = __synthesize_kprobe_trace_arg_ref(arg->ref, &buf,
913 &buflen, 1);
914 if (depth < 0)
915 return depth;
918 /* Print argument value */
919 ret = e_snprintf(buf, buflen, "%s", arg->value);
920 if (ret < 0)
921 return ret;
922 buf += ret;
923 buflen -= ret;
925 /* Closing */
926 while (depth--) {
927 ret = e_snprintf(buf, buflen, ")");
928 if (ret < 0)
929 return ret;
930 buf += ret;
931 buflen -= ret;
933 /* Print argument type */
934 if (arg->type) {
935 ret = e_snprintf(buf, buflen, ":%s", arg->type);
936 if (ret <= 0)
937 return ret;
938 buf += ret;
941 return buf - tmp;
944 char *synthesize_kprobe_trace_command(struct kprobe_trace_event *tev)
946 struct kprobe_trace_point *tp = &tev->point;
947 char *buf;
948 int i, len, ret;
950 buf = zalloc(MAX_CMDLEN);
951 if (buf == NULL)
952 return NULL;
954 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s+%lu",
955 tp->retprobe ? 'r' : 'p',
956 tev->group, tev->event,
957 tp->symbol, tp->offset);
958 if (len <= 0)
959 goto error;
961 for (i = 0; i < tev->nargs; i++) {
962 ret = synthesize_kprobe_trace_arg(&tev->args[i], buf + len,
963 MAX_CMDLEN - len);
964 if (ret <= 0)
965 goto error;
966 len += ret;
969 return buf;
970 error:
971 free(buf);
972 return NULL;
975 int convert_to_perf_probe_event(struct kprobe_trace_event *tev,
976 struct perf_probe_event *pev)
978 char buf[64] = "";
979 int i, ret;
981 /* Convert event/group name */
982 pev->event = strdup(tev->event);
983 pev->group = strdup(tev->group);
984 if (pev->event == NULL || pev->group == NULL)
985 return -ENOMEM;
987 /* Convert trace_point to probe_point */
988 ret = convert_to_perf_probe_point(&tev->point, &pev->point);
989 if (ret < 0)
990 return ret;
992 /* Convert trace_arg to probe_arg */
993 pev->nargs = tev->nargs;
994 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
995 if (pev->args == NULL)
996 return -ENOMEM;
997 for (i = 0; i < tev->nargs && ret >= 0; i++) {
998 if (tev->args[i].name)
999 pev->args[i].name = strdup(tev->args[i].name);
1000 else {
1001 ret = synthesize_kprobe_trace_arg(&tev->args[i],
1002 buf, 64);
1003 pev->args[i].name = strdup(buf);
1005 if (pev->args[i].name == NULL && ret >= 0)
1006 ret = -ENOMEM;
1009 if (ret < 0)
1010 clear_perf_probe_event(pev);
1012 return ret;
1015 void clear_perf_probe_event(struct perf_probe_event *pev)
1017 struct perf_probe_point *pp = &pev->point;
1018 struct perf_probe_arg_field *field, *next;
1019 int i;
1021 if (pev->event)
1022 free(pev->event);
1023 if (pev->group)
1024 free(pev->group);
1025 if (pp->file)
1026 free(pp->file);
1027 if (pp->function)
1028 free(pp->function);
1029 if (pp->lazy_line)
1030 free(pp->lazy_line);
1031 for (i = 0; i < pev->nargs; i++) {
1032 if (pev->args[i].name)
1033 free(pev->args[i].name);
1034 if (pev->args[i].var)
1035 free(pev->args[i].var);
1036 if (pev->args[i].type)
1037 free(pev->args[i].type);
1038 field = pev->args[i].field;
1039 while (field) {
1040 next = field->next;
1041 if (field->name)
1042 free(field->name);
1043 free(field);
1044 field = next;
1047 if (pev->args)
1048 free(pev->args);
1049 memset(pev, 0, sizeof(*pev));
1052 void clear_kprobe_trace_event(struct kprobe_trace_event *tev)
1054 struct kprobe_trace_arg_ref *ref, *next;
1055 int i;
1057 if (tev->event)
1058 free(tev->event);
1059 if (tev->group)
1060 free(tev->group);
1061 if (tev->point.symbol)
1062 free(tev->point.symbol);
1063 for (i = 0; i < tev->nargs; i++) {
1064 if (tev->args[i].name)
1065 free(tev->args[i].name);
1066 if (tev->args[i].value)
1067 free(tev->args[i].value);
1068 if (tev->args[i].type)
1069 free(tev->args[i].type);
1070 ref = tev->args[i].ref;
1071 while (ref) {
1072 next = ref->next;
1073 free(ref);
1074 ref = next;
1077 if (tev->args)
1078 free(tev->args);
1079 memset(tev, 0, sizeof(*tev));
1082 static int open_kprobe_events(bool readwrite)
1084 char buf[PATH_MAX];
1085 const char *__debugfs;
1086 int ret;
1088 __debugfs = debugfs_find_mountpoint();
1089 if (__debugfs == NULL) {
1090 pr_warning("Debugfs is not mounted.\n");
1091 return -ENOENT;
1094 ret = e_snprintf(buf, PATH_MAX, "%stracing/kprobe_events", __debugfs);
1095 if (ret >= 0) {
1096 pr_debug("Opening %s write=%d\n", buf, readwrite);
1097 if (readwrite && !probe_event_dry_run)
1098 ret = open(buf, O_RDWR, O_APPEND);
1099 else
1100 ret = open(buf, O_RDONLY, 0);
1103 if (ret < 0) {
1104 if (errno == ENOENT)
1105 pr_warning("kprobe_events file does not exist - please"
1106 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1107 else
1108 pr_warning("Failed to open kprobe_events file: %s\n",
1109 strerror(errno));
1111 return ret;
1114 /* Get raw string list of current kprobe_events */
1115 static struct strlist *get_kprobe_trace_command_rawlist(int fd)
1117 int ret, idx;
1118 FILE *fp;
1119 char buf[MAX_CMDLEN];
1120 char *p;
1121 struct strlist *sl;
1123 sl = strlist__new(true, NULL);
1125 fp = fdopen(dup(fd), "r");
1126 while (!feof(fp)) {
1127 p = fgets(buf, MAX_CMDLEN, fp);
1128 if (!p)
1129 break;
1131 idx = strlen(p) - 1;
1132 if (p[idx] == '\n')
1133 p[idx] = '\0';
1134 ret = strlist__add(sl, buf);
1135 if (ret < 0) {
1136 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1137 strlist__delete(sl);
1138 return NULL;
1141 fclose(fp);
1143 return sl;
1146 /* Show an event */
1147 static int show_perf_probe_event(struct perf_probe_event *pev)
1149 int i, ret;
1150 char buf[128];
1151 char *place;
1153 /* Synthesize only event probe point */
1154 place = synthesize_perf_probe_point(&pev->point);
1155 if (!place)
1156 return -EINVAL;
1158 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1159 if (ret < 0)
1160 return ret;
1162 printf(" %-20s (on %s", buf, place);
1164 if (pev->nargs > 0) {
1165 printf(" with");
1166 for (i = 0; i < pev->nargs; i++) {
1167 ret = synthesize_perf_probe_arg(&pev->args[i],
1168 buf, 128);
1169 if (ret < 0)
1170 break;
1171 printf(" %s", buf);
1174 printf(")\n");
1175 free(place);
1176 return ret;
1179 /* List up current perf-probe events */
1180 int show_perf_probe_events(void)
1182 int fd, ret;
1183 struct kprobe_trace_event tev;
1184 struct perf_probe_event pev;
1185 struct strlist *rawlist;
1186 struct str_node *ent;
1188 setup_pager();
1189 ret = init_vmlinux();
1190 if (ret < 0)
1191 return ret;
1193 memset(&tev, 0, sizeof(tev));
1194 memset(&pev, 0, sizeof(pev));
1196 fd = open_kprobe_events(false);
1197 if (fd < 0)
1198 return fd;
1200 rawlist = get_kprobe_trace_command_rawlist(fd);
1201 close(fd);
1202 if (!rawlist)
1203 return -ENOENT;
1205 strlist__for_each(ent, rawlist) {
1206 ret = parse_kprobe_trace_command(ent->s, &tev);
1207 if (ret >= 0) {
1208 ret = convert_to_perf_probe_event(&tev, &pev);
1209 if (ret >= 0)
1210 ret = show_perf_probe_event(&pev);
1212 clear_perf_probe_event(&pev);
1213 clear_kprobe_trace_event(&tev);
1214 if (ret < 0)
1215 break;
1217 strlist__delete(rawlist);
1219 return ret;
1222 /* Get current perf-probe event names */
1223 static struct strlist *get_kprobe_trace_event_names(int fd, bool include_group)
1225 char buf[128];
1226 struct strlist *sl, *rawlist;
1227 struct str_node *ent;
1228 struct kprobe_trace_event tev;
1229 int ret = 0;
1231 memset(&tev, 0, sizeof(tev));
1233 rawlist = get_kprobe_trace_command_rawlist(fd);
1234 sl = strlist__new(true, NULL);
1235 strlist__for_each(ent, rawlist) {
1236 ret = parse_kprobe_trace_command(ent->s, &tev);
1237 if (ret < 0)
1238 break;
1239 if (include_group) {
1240 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1241 tev.event);
1242 if (ret >= 0)
1243 ret = strlist__add(sl, buf);
1244 } else
1245 ret = strlist__add(sl, tev.event);
1246 clear_kprobe_trace_event(&tev);
1247 if (ret < 0)
1248 break;
1250 strlist__delete(rawlist);
1252 if (ret < 0) {
1253 strlist__delete(sl);
1254 return NULL;
1256 return sl;
1259 static int write_kprobe_trace_event(int fd, struct kprobe_trace_event *tev)
1261 int ret;
1262 char *buf = synthesize_kprobe_trace_command(tev);
1264 if (!buf) {
1265 pr_debug("Failed to synthesize kprobe trace event.\n");
1266 return -EINVAL;
1269 pr_debug("Writing event: %s\n", buf);
1270 if (!probe_event_dry_run) {
1271 ret = write(fd, buf, strlen(buf));
1272 if (ret <= 0)
1273 pr_warning("Failed to write event: %s\n",
1274 strerror(errno));
1276 free(buf);
1277 return ret;
1280 static int get_new_event_name(char *buf, size_t len, const char *base,
1281 struct strlist *namelist, bool allow_suffix)
1283 int i, ret;
1285 /* Try no suffix */
1286 ret = e_snprintf(buf, len, "%s", base);
1287 if (ret < 0) {
1288 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1289 return ret;
1291 if (!strlist__has_entry(namelist, buf))
1292 return 0;
1294 if (!allow_suffix) {
1295 pr_warning("Error: event \"%s\" already exists. "
1296 "(Use -f to force duplicates.)\n", base);
1297 return -EEXIST;
1300 /* Try to add suffix */
1301 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1302 ret = e_snprintf(buf, len, "%s_%d", base, i);
1303 if (ret < 0) {
1304 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1305 return ret;
1307 if (!strlist__has_entry(namelist, buf))
1308 break;
1310 if (i == MAX_EVENT_INDEX) {
1311 pr_warning("Too many events are on the same function.\n");
1312 ret = -ERANGE;
1315 return ret;
1318 static int __add_kprobe_trace_events(struct perf_probe_event *pev,
1319 struct kprobe_trace_event *tevs,
1320 int ntevs, bool allow_suffix)
1322 int i, fd, ret;
1323 struct kprobe_trace_event *tev = NULL;
1324 char buf[64];
1325 const char *event, *group;
1326 struct strlist *namelist;
1328 fd = open_kprobe_events(true);
1329 if (fd < 0)
1330 return fd;
1331 /* Get current event names */
1332 namelist = get_kprobe_trace_event_names(fd, false);
1333 if (!namelist) {
1334 pr_debug("Failed to get current event list.\n");
1335 return -EIO;
1338 ret = 0;
1339 printf("Add new event%s\n", (ntevs > 1) ? "s:" : ":");
1340 for (i = 0; i < ntevs; i++) {
1341 tev = &tevs[i];
1342 if (pev->event)
1343 event = pev->event;
1344 else
1345 if (pev->point.function)
1346 event = pev->point.function;
1347 else
1348 event = tev->point.symbol;
1349 if (pev->group)
1350 group = pev->group;
1351 else
1352 group = PERFPROBE_GROUP;
1354 /* Get an unused new event name */
1355 ret = get_new_event_name(buf, 64, event,
1356 namelist, allow_suffix);
1357 if (ret < 0)
1358 break;
1359 event = buf;
1361 tev->event = strdup(event);
1362 tev->group = strdup(group);
1363 if (tev->event == NULL || tev->group == NULL) {
1364 ret = -ENOMEM;
1365 break;
1367 ret = write_kprobe_trace_event(fd, tev);
1368 if (ret < 0)
1369 break;
1370 /* Add added event name to namelist */
1371 strlist__add(namelist, event);
1373 /* Trick here - save current event/group */
1374 event = pev->event;
1375 group = pev->group;
1376 pev->event = tev->event;
1377 pev->group = tev->group;
1378 show_perf_probe_event(pev);
1379 /* Trick here - restore current event/group */
1380 pev->event = (char *)event;
1381 pev->group = (char *)group;
1384 * Probes after the first probe which comes from same
1385 * user input are always allowed to add suffix, because
1386 * there might be several addresses corresponding to
1387 * one code line.
1389 allow_suffix = true;
1392 if (ret >= 0) {
1393 /* Show how to use the event. */
1394 printf("\nYou can now use it on all perf tools, such as:\n\n");
1395 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1396 tev->event);
1399 strlist__delete(namelist);
1400 close(fd);
1401 return ret;
1404 static int convert_to_kprobe_trace_events(struct perf_probe_event *pev,
1405 struct kprobe_trace_event **tevs)
1407 struct symbol *sym;
1408 int ret = 0, i;
1409 struct kprobe_trace_event *tev;
1411 /* Convert perf_probe_event with debuginfo */
1412 ret = try_to_find_kprobe_trace_events(pev, tevs);
1413 if (ret != 0)
1414 return ret;
1416 /* Allocate trace event buffer */
1417 tev = *tevs = zalloc(sizeof(struct kprobe_trace_event));
1418 if (tev == NULL)
1419 return -ENOMEM;
1421 /* Copy parameters */
1422 tev->point.symbol = strdup(pev->point.function);
1423 if (tev->point.symbol == NULL) {
1424 ret = -ENOMEM;
1425 goto error;
1427 tev->point.offset = pev->point.offset;
1428 tev->nargs = pev->nargs;
1429 if (tev->nargs) {
1430 tev->args = zalloc(sizeof(struct kprobe_trace_arg)
1431 * tev->nargs);
1432 if (tev->args == NULL) {
1433 ret = -ENOMEM;
1434 goto error;
1436 for (i = 0; i < tev->nargs; i++) {
1437 if (pev->args[i].name) {
1438 tev->args[i].name = strdup(pev->args[i].name);
1439 if (tev->args[i].name == NULL) {
1440 ret = -ENOMEM;
1441 goto error;
1444 tev->args[i].value = strdup(pev->args[i].var);
1445 if (tev->args[i].value == NULL) {
1446 ret = -ENOMEM;
1447 goto error;
1449 if (pev->args[i].type) {
1450 tev->args[i].type = strdup(pev->args[i].type);
1451 if (tev->args[i].type == NULL) {
1452 ret = -ENOMEM;
1453 goto error;
1459 /* Currently just checking function name from symbol map */
1460 sym = map__find_symbol_by_name(kmaps[MAP__FUNCTION],
1461 tev->point.symbol, NULL);
1462 if (!sym) {
1463 pr_warning("Kernel symbol \'%s\' not found.\n",
1464 tev->point.symbol);
1465 ret = -ENOENT;
1466 goto error;
1469 return 1;
1470 error:
1471 clear_kprobe_trace_event(tev);
1472 free(tev);
1473 *tevs = NULL;
1474 return ret;
1477 struct __event_package {
1478 struct perf_probe_event *pev;
1479 struct kprobe_trace_event *tevs;
1480 int ntevs;
1483 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1484 bool force_add)
1486 int i, j, ret;
1487 struct __event_package *pkgs;
1489 pkgs = zalloc(sizeof(struct __event_package) * npevs);
1490 if (pkgs == NULL)
1491 return -ENOMEM;
1493 /* Init vmlinux path */
1494 ret = init_vmlinux();
1495 if (ret < 0)
1496 return ret;
1498 /* Loop 1: convert all events */
1499 for (i = 0; i < npevs; i++) {
1500 pkgs[i].pev = &pevs[i];
1501 /* Convert with or without debuginfo */
1502 ret = convert_to_kprobe_trace_events(pkgs[i].pev,
1503 &pkgs[i].tevs);
1504 if (ret < 0)
1505 goto end;
1506 pkgs[i].ntevs = ret;
1509 /* Loop 2: add all events */
1510 for (i = 0; i < npevs && ret >= 0; i++)
1511 ret = __add_kprobe_trace_events(pkgs[i].pev, pkgs[i].tevs,
1512 pkgs[i].ntevs, force_add);
1513 end:
1514 /* Loop 3: cleanup trace events */
1515 for (i = 0; i < npevs; i++)
1516 for (j = 0; j < pkgs[i].ntevs; j++)
1517 clear_kprobe_trace_event(&pkgs[i].tevs[j]);
1519 return ret;
1522 static int __del_trace_kprobe_event(int fd, struct str_node *ent)
1524 char *p;
1525 char buf[128];
1526 int ret;
1528 /* Convert from perf-probe event to trace-kprobe event */
1529 ret = e_snprintf(buf, 128, "-:%s", ent->s);
1530 if (ret < 0)
1531 goto error;
1533 p = strchr(buf + 2, ':');
1534 if (!p) {
1535 pr_debug("Internal error: %s should have ':' but not.\n",
1536 ent->s);
1537 ret = -ENOTSUP;
1538 goto error;
1540 *p = '/';
1542 pr_debug("Writing event: %s\n", buf);
1543 ret = write(fd, buf, strlen(buf));
1544 if (ret < 0)
1545 goto error;
1547 printf("Remove event: %s\n", ent->s);
1548 return 0;
1549 error:
1550 pr_warning("Failed to delete event: %s\n", strerror(-ret));
1551 return ret;
1554 static int del_trace_kprobe_event(int fd, const char *group,
1555 const char *event, struct strlist *namelist)
1557 char buf[128];
1558 struct str_node *ent, *n;
1559 int found = 0, ret = 0;
1561 ret = e_snprintf(buf, 128, "%s:%s", group, event);
1562 if (ret < 0) {
1563 pr_err("Failed to copy event.");
1564 return ret;
1567 if (strpbrk(buf, "*?")) { /* Glob-exp */
1568 strlist__for_each_safe(ent, n, namelist)
1569 if (strglobmatch(ent->s, buf)) {
1570 found++;
1571 ret = __del_trace_kprobe_event(fd, ent);
1572 if (ret < 0)
1573 break;
1574 strlist__remove(namelist, ent);
1576 } else {
1577 ent = strlist__find(namelist, buf);
1578 if (ent) {
1579 found++;
1580 ret = __del_trace_kprobe_event(fd, ent);
1581 if (ret >= 0)
1582 strlist__remove(namelist, ent);
1585 if (found == 0 && ret >= 0)
1586 pr_info("Info: Event \"%s\" does not exist.\n", buf);
1588 return ret;
1591 int del_perf_probe_events(struct strlist *dellist)
1593 int fd, ret = 0;
1594 const char *group, *event;
1595 char *p, *str;
1596 struct str_node *ent;
1597 struct strlist *namelist;
1599 fd = open_kprobe_events(true);
1600 if (fd < 0)
1601 return fd;
1603 /* Get current event names */
1604 namelist = get_kprobe_trace_event_names(fd, true);
1605 if (namelist == NULL)
1606 return -EINVAL;
1608 strlist__for_each(ent, dellist) {
1609 str = strdup(ent->s);
1610 if (str == NULL) {
1611 ret = -ENOMEM;
1612 break;
1614 pr_debug("Parsing: %s\n", str);
1615 p = strchr(str, ':');
1616 if (p) {
1617 group = str;
1618 *p = '\0';
1619 event = p + 1;
1620 } else {
1621 group = "*";
1622 event = str;
1624 pr_debug("Group: %s, Event: %s\n", group, event);
1625 ret = del_trace_kprobe_event(fd, group, event, namelist);
1626 free(str);
1627 if (ret < 0)
1628 break;
1630 strlist__delete(namelist);
1631 close(fd);
1633 return ret;