]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - tools/perf/util/probe-event.c
2 * probe-event.c : perf-probe definition to probe_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.
23 #include <sys/utsname.h>
24 #include <sys/types.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
, ...)
67 ret
= vsnprintf(str
, size
, format
, ap
);
74 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
);
75 static struct machine machine
;
77 /* Initialize symbol maps and path of vmlinux/modules */
78 static int init_vmlinux(void)
82 symbol_conf
.sort_by_name
= true;
83 if (symbol_conf
.vmlinux_name
== NULL
)
84 symbol_conf
.try_vmlinux_path
= true;
86 pr_debug("Use vmlinux: %s\n", symbol_conf
.vmlinux_name
);
89 pr_debug("Failed to init symbol map.\n");
93 ret
= machine__init(&machine
, "", HOST_KERNEL_ID
);
97 if (machine__create_kernel_maps(&machine
) < 0) {
98 pr_debug("machine__create_kernel_maps() failed.\n");
103 pr_warning("Failed to init vmlinux path.\n");
107 static struct symbol
*__find_kernel_function_by_name(const char *name
,
110 return machine__find_kernel_function_by_name(&machine
, name
, mapp
,
114 const char *kernel_get_module_path(const char *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)
124 pr_debug("Failed to find module %s.\n", module
);
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");
135 return dso
->long_name
;
139 static int open_vmlinux(const char *module
)
141 const char *path
= kernel_get_module_path(module
);
143 pr_err("Failed to find path of %s module.\n",
147 pr_debug("Try to open %s\n", path
);
148 return open(path
, O_RDONLY
);
152 * Convert trace point to probe point with debuginfo
153 * Currently only handles kprobes.
155 static int kprobe_convert_to_perf_probe(struct probe_trace_point
*tp
,
156 struct perf_probe_point
*pp
)
163 sym
= __find_kernel_function_by_name(tp
->symbol
, &map
);
165 addr
= map
->unmap_ip(map
, sym
->start
+ tp
->offset
);
166 pr_debug("try to find %s+%ld@%llx\n", tp
->symbol
,
168 ret
= find_perf_probe_point((unsigned long)addr
, pp
);
171 pr_debug("Failed to find corresponding probes from "
172 "debuginfo. Use kprobe event information.\n");
173 pp
->function
= strdup(tp
->symbol
);
174 if (pp
->function
== NULL
)
176 pp
->offset
= tp
->offset
;
178 pp
->retprobe
= tp
->retprobe
;
183 /* Try to find perf_probe_event with debuginfo */
184 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
185 struct probe_trace_event
**tevs
,
186 int max_tevs
, const char *module
)
188 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
191 fd
= open_vmlinux(module
);
194 pr_warning("Failed to open debuginfo file.\n");
197 pr_debug("Could not open vmlinux. Try to use symbols.\n");
201 /* Searching trace events corresponding to probe event */
202 ntevs
= find_probe_trace_events(fd
, pev
, tevs
, max_tevs
);
205 if (ntevs
> 0) { /* Succeeded to find trace events */
206 pr_debug("find %d probe_trace_events.\n", ntevs
);
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
));
215 /* Error path : ntevs < 0 */
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");
221 pr_debug("Trying to use symbols.\n");
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.
234 static int get_real_path(const char *raw_path
, const char *comp_dir
,
237 const char *prefix
= symbol_conf
.source_prefix
;
240 if (raw_path
[0] != '/' && comp_dir
)
241 /* If not an absolute path, try to use comp_dir */
244 if (access(raw_path
, R_OK
) == 0) {
245 *new_path
= strdup(raw_path
);
252 *new_path
= malloc((strlen(prefix
) + strlen(raw_path
) + 2));
257 sprintf(*new_path
, "%s/%s", prefix
, raw_path
);
259 if (access(*new_path
, R_OK
) == 0)
262 if (!symbol_conf
.source_prefix
)
263 /* In case of searching comp_dir, don't retry */
271 raw_path
= strchr(++raw_path
, '/');
287 #define LINEBUF_SIZE 256
288 #define NR_ADDITIONAL_LINES 2
290 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
292 char buf
[LINEBUF_SIZE
];
293 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
294 const char *prefix
= NULL
;
297 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
302 prefix
= show_num
? "%7d " : " ";
303 color_fprintf(stdout
, color
, prefix
, l
);
305 color_fprintf(stdout
, color
, "%s", buf
);
307 } while (strchr(buf
, '\n') == NULL
);
312 pr_warning("File read error: %s\n", strerror(errno
));
318 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
320 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
322 pr_warning("Source file is shorter than expected.\n");
328 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
329 #define show_one_line(f,l) _show_one_line(f,l,false,false)
330 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
331 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
334 * Show line-range always requires debuginfo to find source file and
337 int show_line_range(struct line_range
*lr
, const char *module
)
340 struct line_node
*ln
;
345 /* Search a line range */
346 ret
= init_vmlinux();
350 fd
= open_vmlinux(module
);
352 pr_warning("Failed to open debuginfo file.\n");
356 ret
= find_line_range(fd
, lr
);
359 pr_warning("Specified source line is not found.\n");
361 } else if (ret
< 0) {
362 pr_warning("Debuginfo analysis failed. (%d)\n", ret
);
366 /* Convert source file path */
368 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
369 free(tmp
); /* Free old path */
371 pr_warning("Failed to find source file. (%d)\n", ret
);
378 fprintf(stdout
, "<%s:%d>\n", lr
->function
,
379 lr
->start
- lr
->offset
);
381 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
383 fp
= fopen(lr
->path
, "r");
385 pr_warning("Failed to open %s: %s\n", lr
->path
,
389 /* Skip to starting line number */
390 while (l
< lr
->start
) {
391 ret
= skip_one_line(fp
, l
++);
396 list_for_each_entry(ln
, &lr
->line_list
, list
) {
397 for (; ln
->line
> l
; l
++) {
398 ret
= show_one_line(fp
, l
- lr
->offset
);
402 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
407 if (lr
->end
== INT_MAX
)
408 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
409 while (l
<= lr
->end
) {
410 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
419 static int show_available_vars_at(int fd
, struct perf_probe_event
*pev
,
420 int max_vls
, bool externs
)
424 struct str_node
*node
;
425 struct variable_list
*vls
= NULL
, *vl
;
427 buf
= synthesize_perf_probe_point(&pev
->point
);
430 pr_debug("Searching variables at %s\n", buf
);
432 ret
= find_available_vars_at(fd
, pev
, &vls
, max_vls
, externs
);
434 /* Some variables were found */
435 fprintf(stdout
, "Available variables at %s\n", buf
);
436 for (i
= 0; i
< ret
; i
++) {
439 * A probe point might be converted to
440 * several trace points.
442 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
444 free(vl
->point
.symbol
);
446 strlist__for_each(node
, vl
->vars
)
447 fprintf(stdout
, "\t\t%s\n", node
->s
);
448 strlist__delete(vl
->vars
);
450 fprintf(stdout
, "(No variables)\n");
454 pr_err("Failed to find variables at %s (%d)\n", buf
, ret
);
460 /* Show available variables on given probe point */
461 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
462 int max_vls
, const char *module
, bool externs
)
466 ret
= init_vmlinux();
470 fd
= open_vmlinux(module
);
472 pr_warning("Failed to open debug information file.\n");
478 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
479 ret
= show_available_vars_at(fd
, &pevs
[i
], max_vls
, externs
);
485 #else /* !DWARF_SUPPORT */
487 static int kprobe_convert_to_perf_probe(struct probe_trace_point
*tp
,
488 struct perf_probe_point
*pp
)
492 sym
= __find_kernel_function_by_name(tp
->symbol
, NULL
);
494 pr_err("Failed to find symbol %s in kernel.\n", tp
->symbol
);
497 pp
->function
= strdup(tp
->symbol
);
498 if (pp
->function
== NULL
)
500 pp
->offset
= tp
->offset
;
501 pp
->retprobe
= tp
->retprobe
;
506 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
507 struct probe_trace_event
**tevs __unused
,
508 int max_tevs __unused
, const char *mod __unused
)
510 if (perf_probe_event_need_dwarf(pev
)) {
511 pr_warning("Debuginfo-analysis is not supported.\n");
517 int show_line_range(struct line_range
*lr __unused
, const char *module __unused
)
519 pr_warning("Debuginfo-analysis is not supported.\n");
523 int show_available_vars(struct perf_probe_event
*pevs __unused
,
524 int npevs __unused
, int max_vls __unused
,
525 const char *module __unused
, bool externs __unused
)
527 pr_warning("Debuginfo-analysis is not supported.\n");
532 static int parse_line_num(char **ptr
, int *val
, const char *what
)
534 const char *start
= *ptr
;
537 *val
= strtol(*ptr
, ptr
, 0);
538 if (errno
|| *ptr
== start
) {
539 semantic_error("'%s' is not a valid number.\n", what
);
546 * Stuff 'lr' according to the line range described by 'arg'.
547 * The line range syntax is described by:
549 * SRC[:SLN[+NUM|-ELN]]
550 * FNC[:SLN[+NUM|-ELN]]
552 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
554 char *range
, *name
= strdup(arg
);
563 range
= strchr(name
, ':');
567 err
= parse_line_num(&range
, &lr
->start
, "start line");
571 if (*range
== '+' || *range
== '-') {
572 const char c
= *range
++;
574 err
= parse_line_num(&range
, &lr
->end
, "end line");
579 lr
->end
+= lr
->start
;
581 * Adjust the number of lines here.
582 * If the number of lines == 1, the
583 * the end of line should be equal to
590 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
593 if (lr
->start
> lr
->end
) {
594 semantic_error("Start line must be smaller"
595 " than end line.\n");
598 if (*range
!= '\0') {
599 semantic_error("Tailing with invalid str '%s'.\n", range
);
604 if (strchr(name
, '.'))
615 /* Check the name is good for event/group */
616 static bool check_event_name(const char *name
)
618 if (!isalpha(*name
) && *name
!= '_')
620 while (*++name
!= '\0') {
621 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
627 /* Parse probepoint definition. */
628 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
630 struct perf_probe_point
*pp
= &pev
->point
;
635 * perf probe [EVENT=]SRC[:LN|;PTN]
636 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
638 * TODO:Group name support
641 ptr
= strpbrk(arg
, ";=@+%");
642 if (ptr
&& *ptr
== '=') { /* Event name */
645 if (strchr(arg
, ':')) {
646 semantic_error("Group name is not supported yet.\n");
649 if (!check_event_name(arg
)) {
650 semantic_error("%s is bad for event name -it must "
651 "follow C symbol-naming rule.\n", arg
);
654 pev
->event
= strdup(arg
);
655 if (pev
->event
== NULL
)
661 ptr
= strpbrk(arg
, ";:+@%");
671 /* Check arg is function or file and copy it */
672 if (strchr(tmp
, '.')) /* File */
677 /* Parse other options */
681 if (c
== ';') { /* Lazy pattern must be the last part */
682 pp
->lazy_line
= strdup(arg
);
683 if (pp
->lazy_line
== NULL
)
687 ptr
= strpbrk(arg
, ";:+@%");
693 case ':': /* Line number */
694 pp
->line
= strtoul(arg
, &tmp
, 0);
696 semantic_error("There is non-digit char"
697 " in line number.\n");
701 case '+': /* Byte offset from a symbol */
702 pp
->offset
= strtoul(arg
, &tmp
, 0);
704 semantic_error("There is non-digit character"
709 case '@': /* File name */
711 semantic_error("SRC@SRC is not allowed.\n");
714 pp
->file
= strdup(arg
);
715 if (pp
->file
== NULL
)
718 case '%': /* Probe places */
719 if (strcmp(arg
, "return") == 0) {
721 } else { /* Others not supported yet */
722 semantic_error("%%%s is not supported.\n", arg
);
726 default: /* Buggy case */
727 pr_err("This program has a bug at %s:%d.\n",
734 /* Exclusion check */
735 if (pp
->lazy_line
&& pp
->line
) {
736 semantic_error("Lazy pattern can't be used with"
741 if (pp
->lazy_line
&& pp
->offset
) {
742 semantic_error("Lazy pattern can't be used with offset.\n");
746 if (pp
->line
&& pp
->offset
) {
747 semantic_error("Offset can't be used with line number.\n");
751 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
752 semantic_error("File always requires line number or "
757 if (pp
->offset
&& !pp
->function
) {
758 semantic_error("Offset requires an entry function.\n");
762 if (pp
->retprobe
&& !pp
->function
) {
763 semantic_error("Return probe requires an entry function.\n");
767 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
768 semantic_error("Offset/Line/Lazy pattern can't be used with "
773 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
774 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
779 /* Parse perf-probe event argument */
780 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
782 char *tmp
, *goodname
;
783 struct perf_probe_arg_field
**fieldp
;
785 pr_debug("parsing arg: %s into ", str
);
787 tmp
= strchr(str
, '=');
789 arg
->name
= strndup(str
, tmp
- str
);
790 if (arg
->name
== NULL
)
792 pr_debug("name:%s ", arg
->name
);
796 tmp
= strchr(str
, ':');
797 if (tmp
) { /* Type setting */
799 arg
->type
= strdup(tmp
+ 1);
800 if (arg
->type
== NULL
)
802 pr_debug("type:%s ", arg
->type
);
805 tmp
= strpbrk(str
, "-.[");
806 if (!is_c_varname(str
) || !tmp
) {
807 /* A variable, register, symbol or special value */
808 arg
->var
= strdup(str
);
809 if (arg
->var
== NULL
)
811 pr_debug("%s\n", arg
->var
);
815 /* Structure fields or array element */
816 arg
->var
= strndup(str
, tmp
- str
);
817 if (arg
->var
== NULL
)
820 pr_debug("%s, ", arg
->var
);
821 fieldp
= &arg
->field
;
824 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
827 if (*tmp
== '[') { /* Array */
829 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
830 (*fieldp
)->ref
= true;
831 if (*tmp
!= ']' || tmp
== str
+ 1) {
832 semantic_error("Array index must be a"
839 } else { /* Structure */
842 (*fieldp
)->ref
= false;
843 } else if (tmp
[1] == '>') {
845 (*fieldp
)->ref
= true;
847 semantic_error("Argument parse error: %s\n",
851 tmp
= strpbrk(str
, "-.[");
854 (*fieldp
)->name
= strndup(str
, tmp
- str
);
855 if ((*fieldp
)->name
== NULL
)
858 goodname
= (*fieldp
)->name
;
859 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
860 fieldp
= &(*fieldp
)->next
;
863 (*fieldp
)->name
= strdup(str
);
864 if ((*fieldp
)->name
== NULL
)
867 goodname
= (*fieldp
)->name
;
868 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
870 /* If no name is specified, set the last field name (not array index)*/
872 arg
->name
= strdup(goodname
);
873 if (arg
->name
== NULL
)
879 /* Parse perf-probe event command */
880 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
883 int argc
, i
, ret
= 0;
885 argv
= argv_split(cmd
, &argc
);
887 pr_debug("Failed to split arguments.\n");
890 if (argc
- 1 > MAX_PROBE_ARGS
) {
891 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
895 /* Parse probe point */
896 ret
= parse_perf_probe_point(argv
[0], pev
);
900 /* Copy arguments and ensure return probe has no C argument */
901 pev
->nargs
= argc
- 1;
902 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
903 if (pev
->args
== NULL
) {
907 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
908 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
910 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
911 semantic_error("You can't specify local variable for"
922 /* Return true if this perf_probe_event requires debuginfo */
923 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
927 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
930 for (i
= 0; i
< pev
->nargs
; i
++)
931 if (is_c_varname(pev
->args
[i
].var
))
937 /* Parse probe_events event into struct probe_point */
938 static int parse_probe_trace_command(const char *cmd
,
939 struct probe_trace_event
*tev
)
941 struct probe_trace_point
*tp
= &tev
->point
;
947 pr_debug("Parsing probe_events: %s\n", cmd
);
948 argv
= argv_split(cmd
, &argc
);
950 pr_debug("Failed to split arguments.\n");
954 semantic_error("Too few probe arguments.\n");
959 /* Scan event and group name. */
960 ret
= sscanf(argv
[0], "%c:%a[^/ \t]/%a[^ \t]",
961 &pr
, (float *)(void *)&tev
->group
,
962 (float *)(void *)&tev
->event
);
964 semantic_error("Failed to parse event name: %s\n", argv
[0]);
968 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
970 tp
->retprobe
= (pr
== 'r');
972 /* Scan function name and offset */
973 ret
= sscanf(argv
[1], "%a[^+]+%lu", (float *)(void *)&tp
->symbol
,
978 tev
->nargs
= argc
- 2;
979 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
980 if (tev
->args
== NULL
) {
984 for (i
= 0; i
< tev
->nargs
; i
++) {
985 p
= strchr(argv
[i
+ 2], '=');
986 if (p
) /* We don't need which register is assigned. */
990 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
991 /* TODO: parse regs and offset */
992 tev
->args
[i
].value
= strdup(p
);
993 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1004 /* Compose only probe arg */
1005 int synthesize_perf_probe_arg(struct perf_probe_arg
*pa
, char *buf
, size_t len
)
1007 struct perf_probe_arg_field
*field
= pa
->field
;
1011 if (pa
->name
&& pa
->var
)
1012 ret
= e_snprintf(tmp
, len
, "%s=%s", pa
->name
, pa
->var
);
1014 ret
= e_snprintf(tmp
, len
, "%s", pa
->name
? pa
->name
: pa
->var
);
1021 if (field
->name
[0] == '[')
1022 ret
= e_snprintf(tmp
, len
, "%s", field
->name
);
1024 ret
= e_snprintf(tmp
, len
, "%s%s",
1025 field
->ref
? "->" : ".", field
->name
);
1030 field
= field
->next
;
1034 ret
= e_snprintf(tmp
, len
, ":%s", pa
->type
);
1043 pr_debug("Failed to synthesize perf probe argument: %s\n",
1048 /* Compose only probe point (not argument) */
1049 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1052 char offs
[32] = "", line
[32] = "", file
[32] = "";
1055 buf
= zalloc(MAX_CMDLEN
);
1061 ret
= e_snprintf(offs
, 32, "+%lu", pp
->offset
);
1066 ret
= e_snprintf(line
, 32, ":%d", pp
->line
);
1074 tmp
= strchr(pp
->file
+ len
- 30, '/');
1075 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1077 ret
= e_snprintf(file
, 32, "@%s", tmp
);
1083 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s%s%s%s", pp
->function
,
1084 offs
, pp
->retprobe
? "%return" : "", line
,
1087 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s", file
, line
);
1093 pr_debug("Failed to synthesize perf probe point: %s\n",
1101 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1106 buf
= synthesize_perf_probe_point(&pev
->point
);
1111 for (i
= 0; i
< pev
->nargs
; i
++) {
1112 ret
= e_snprintf(&buf
[len
], MAX_CMDLEN
- len
, " %s",
1125 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1126 char **buf
, size_t *buflen
,
1131 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1137 ret
= e_snprintf(*buf
, *buflen
, "%+ld(", ref
->offset
);
1149 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1150 char *buf
, size_t buflen
)
1152 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1156 /* Argument name or separator */
1158 ret
= e_snprintf(buf
, buflen
, " %s=", arg
->name
);
1160 ret
= e_snprintf(buf
, buflen
, " ");
1166 /* Special case: @XXX */
1167 if (arg
->value
[0] == '@' && arg
->ref
)
1170 /* Dereferencing arguments */
1172 depth
= __synthesize_probe_trace_arg_ref(ref
, &buf
,
1178 /* Print argument value */
1179 if (arg
->value
[0] == '@' && arg
->ref
)
1180 ret
= e_snprintf(buf
, buflen
, "%s%+ld", arg
->value
,
1183 ret
= e_snprintf(buf
, buflen
, "%s", arg
->value
);
1191 ret
= e_snprintf(buf
, buflen
, ")");
1197 /* Print argument type */
1199 ret
= e_snprintf(buf
, buflen
, ":%s", arg
->type
);
1208 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
1210 struct probe_trace_point
*tp
= &tev
->point
;
1214 buf
= zalloc(MAX_CMDLEN
);
1218 len
= e_snprintf(buf
, MAX_CMDLEN
, "%c:%s/%s %s+%lu",
1219 tp
->retprobe
? 'r' : 'p',
1220 tev
->group
, tev
->event
,
1221 tp
->symbol
, tp
->offset
);
1225 for (i
= 0; i
< tev
->nargs
; i
++) {
1226 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], buf
+ len
,
1239 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
1240 struct perf_probe_event
*pev
)
1245 /* Convert event/group name */
1246 pev
->event
= strdup(tev
->event
);
1247 pev
->group
= strdup(tev
->group
);
1248 if (pev
->event
== NULL
|| pev
->group
== NULL
)
1251 /* Convert trace_point to probe_point */
1252 ret
= kprobe_convert_to_perf_probe(&tev
->point
, &pev
->point
);
1256 /* Convert trace_arg to probe_arg */
1257 pev
->nargs
= tev
->nargs
;
1258 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1259 if (pev
->args
== NULL
)
1261 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
1262 if (tev
->args
[i
].name
)
1263 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
1265 ret
= synthesize_probe_trace_arg(&tev
->args
[i
],
1267 pev
->args
[i
].name
= strdup(buf
);
1269 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
1274 clear_perf_probe_event(pev
);
1279 void clear_perf_probe_event(struct perf_probe_event
*pev
)
1281 struct perf_probe_point
*pp
= &pev
->point
;
1282 struct perf_probe_arg_field
*field
, *next
;
1294 free(pp
->lazy_line
);
1295 for (i
= 0; i
< pev
->nargs
; i
++) {
1296 if (pev
->args
[i
].name
)
1297 free(pev
->args
[i
].name
);
1298 if (pev
->args
[i
].var
)
1299 free(pev
->args
[i
].var
);
1300 if (pev
->args
[i
].type
)
1301 free(pev
->args
[i
].type
);
1302 field
= pev
->args
[i
].field
;
1313 memset(pev
, 0, sizeof(*pev
));
1316 static void clear_probe_trace_event(struct probe_trace_event
*tev
)
1318 struct probe_trace_arg_ref
*ref
, *next
;
1325 if (tev
->point
.symbol
)
1326 free(tev
->point
.symbol
);
1327 for (i
= 0; i
< tev
->nargs
; i
++) {
1328 if (tev
->args
[i
].name
)
1329 free(tev
->args
[i
].name
);
1330 if (tev
->args
[i
].value
)
1331 free(tev
->args
[i
].value
);
1332 if (tev
->args
[i
].type
)
1333 free(tev
->args
[i
].type
);
1334 ref
= tev
->args
[i
].ref
;
1343 memset(tev
, 0, sizeof(*tev
));
1346 static int open_kprobe_events(bool readwrite
)
1349 const char *__debugfs
;
1352 __debugfs
= debugfs_find_mountpoint();
1353 if (__debugfs
== NULL
) {
1354 pr_warning("Debugfs is not mounted.\n");
1358 ret
= e_snprintf(buf
, PATH_MAX
, "%stracing/kprobe_events", __debugfs
);
1360 pr_debug("Opening %s write=%d\n", buf
, readwrite
);
1361 if (readwrite
&& !probe_event_dry_run
)
1362 ret
= open(buf
, O_RDWR
, O_APPEND
);
1364 ret
= open(buf
, O_RDONLY
, 0);
1368 if (errno
== ENOENT
)
1369 pr_warning("kprobe_events file does not exist - please"
1370 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1372 pr_warning("Failed to open kprobe_events file: %s\n",
1378 /* Get raw string list of current kprobe_events */
1379 static struct strlist
*get_probe_trace_command_rawlist(int fd
)
1383 char buf
[MAX_CMDLEN
];
1387 sl
= strlist__new(true, NULL
);
1389 fp
= fdopen(dup(fd
), "r");
1391 p
= fgets(buf
, MAX_CMDLEN
, fp
);
1395 idx
= strlen(p
) - 1;
1398 ret
= strlist__add(sl
, buf
);
1400 pr_debug("strlist__add failed: %s\n", strerror(-ret
));
1401 strlist__delete(sl
);
1411 static int show_perf_probe_event(struct perf_probe_event
*pev
)
1417 /* Synthesize only event probe point */
1418 place
= synthesize_perf_probe_point(&pev
->point
);
1422 ret
= e_snprintf(buf
, 128, "%s:%s", pev
->group
, pev
->event
);
1426 printf(" %-20s (on %s", buf
, place
);
1428 if (pev
->nargs
> 0) {
1430 for (i
= 0; i
< pev
->nargs
; i
++) {
1431 ret
= synthesize_perf_probe_arg(&pev
->args
[i
],
1443 /* List up current perf-probe events */
1444 int show_perf_probe_events(void)
1447 struct probe_trace_event tev
;
1448 struct perf_probe_event pev
;
1449 struct strlist
*rawlist
;
1450 struct str_node
*ent
;
1453 ret
= init_vmlinux();
1457 memset(&tev
, 0, sizeof(tev
));
1458 memset(&pev
, 0, sizeof(pev
));
1460 fd
= open_kprobe_events(false);
1464 rawlist
= get_probe_trace_command_rawlist(fd
);
1469 strlist__for_each(ent
, rawlist
) {
1470 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1472 ret
= convert_to_perf_probe_event(&tev
, &pev
);
1474 ret
= show_perf_probe_event(&pev
);
1476 clear_perf_probe_event(&pev
);
1477 clear_probe_trace_event(&tev
);
1481 strlist__delete(rawlist
);
1486 /* Get current perf-probe event names */
1487 static struct strlist
*get_probe_trace_event_names(int fd
, bool include_group
)
1490 struct strlist
*sl
, *rawlist
;
1491 struct str_node
*ent
;
1492 struct probe_trace_event tev
;
1495 memset(&tev
, 0, sizeof(tev
));
1496 rawlist
= get_probe_trace_command_rawlist(fd
);
1497 sl
= strlist__new(true, NULL
);
1498 strlist__for_each(ent
, rawlist
) {
1499 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1502 if (include_group
) {
1503 ret
= e_snprintf(buf
, 128, "%s:%s", tev
.group
,
1506 ret
= strlist__add(sl
, buf
);
1508 ret
= strlist__add(sl
, tev
.event
);
1509 clear_probe_trace_event(&tev
);
1513 strlist__delete(rawlist
);
1516 strlist__delete(sl
);
1522 static int write_probe_trace_event(int fd
, struct probe_trace_event
*tev
)
1525 char *buf
= synthesize_probe_trace_command(tev
);
1528 pr_debug("Failed to synthesize probe trace event.\n");
1532 pr_debug("Writing event: %s\n", buf
);
1533 if (!probe_event_dry_run
) {
1534 ret
= write(fd
, buf
, strlen(buf
));
1536 pr_warning("Failed to write event: %s\n",
1543 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
1544 struct strlist
*namelist
, bool allow_suffix
)
1549 ret
= e_snprintf(buf
, len
, "%s", base
);
1551 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
1554 if (!strlist__has_entry(namelist
, buf
))
1557 if (!allow_suffix
) {
1558 pr_warning("Error: event \"%s\" already exists. "
1559 "(Use -f to force duplicates.)\n", base
);
1563 /* Try to add suffix */
1564 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
1565 ret
= e_snprintf(buf
, len
, "%s_%d", base
, i
);
1567 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
1570 if (!strlist__has_entry(namelist
, buf
))
1573 if (i
== MAX_EVENT_INDEX
) {
1574 pr_warning("Too many events are on the same function.\n");
1581 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
1582 struct probe_trace_event
*tevs
,
1583 int ntevs
, bool allow_suffix
)
1586 struct probe_trace_event
*tev
= NULL
;
1588 const char *event
, *group
;
1589 struct strlist
*namelist
;
1591 fd
= open_kprobe_events(true);
1594 /* Get current event names */
1595 namelist
= get_probe_trace_event_names(fd
, false);
1597 pr_debug("Failed to get current event list.\n");
1602 printf("Add new event%s\n", (ntevs
> 1) ? "s:" : ":");
1603 for (i
= 0; i
< ntevs
; i
++) {
1608 if (pev
->point
.function
)
1609 event
= pev
->point
.function
;
1611 event
= tev
->point
.symbol
;
1615 group
= PERFPROBE_GROUP
;
1617 /* Get an unused new event name */
1618 ret
= get_new_event_name(buf
, 64, event
,
1619 namelist
, allow_suffix
);
1624 tev
->event
= strdup(event
);
1625 tev
->group
= strdup(group
);
1626 if (tev
->event
== NULL
|| tev
->group
== NULL
) {
1630 ret
= write_probe_trace_event(fd
, tev
);
1633 /* Add added event name to namelist */
1634 strlist__add(namelist
, event
);
1636 /* Trick here - save current event/group */
1639 pev
->event
= tev
->event
;
1640 pev
->group
= tev
->group
;
1641 show_perf_probe_event(pev
);
1642 /* Trick here - restore current event/group */
1643 pev
->event
= (char *)event
;
1644 pev
->group
= (char *)group
;
1647 * Probes after the first probe which comes from same
1648 * user input are always allowed to add suffix, because
1649 * there might be several addresses corresponding to
1652 allow_suffix
= true;
1656 /* Show how to use the event. */
1657 printf("\nYou can now use it on all perf tools, such as:\n\n");
1658 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev
->group
,
1662 strlist__delete(namelist
);
1667 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
1668 struct probe_trace_event
**tevs
,
1669 int max_tevs
, const char *module
)
1673 struct probe_trace_event
*tev
;
1675 /* Convert perf_probe_event with debuginfo */
1676 ret
= try_to_find_probe_trace_events(pev
, tevs
, max_tevs
, module
);
1680 /* Allocate trace event buffer */
1681 tev
= *tevs
= zalloc(sizeof(struct probe_trace_event
));
1685 /* Copy parameters */
1686 tev
->point
.symbol
= strdup(pev
->point
.function
);
1687 if (tev
->point
.symbol
== NULL
) {
1691 tev
->point
.offset
= pev
->point
.offset
;
1692 tev
->point
.retprobe
= pev
->point
.retprobe
;
1693 tev
->nargs
= pev
->nargs
;
1695 tev
->args
= zalloc(sizeof(struct probe_trace_arg
)
1697 if (tev
->args
== NULL
) {
1701 for (i
= 0; i
< tev
->nargs
; i
++) {
1702 if (pev
->args
[i
].name
) {
1703 tev
->args
[i
].name
= strdup(pev
->args
[i
].name
);
1704 if (tev
->args
[i
].name
== NULL
) {
1709 tev
->args
[i
].value
= strdup(pev
->args
[i
].var
);
1710 if (tev
->args
[i
].value
== NULL
) {
1714 if (pev
->args
[i
].type
) {
1715 tev
->args
[i
].type
= strdup(pev
->args
[i
].type
);
1716 if (tev
->args
[i
].type
== NULL
) {
1724 /* Currently just checking function name from symbol map */
1725 sym
= __find_kernel_function_by_name(tev
->point
.symbol
, NULL
);
1727 pr_warning("Kernel symbol \'%s\' not found.\n",
1735 clear_probe_trace_event(tev
);
1741 struct __event_package
{
1742 struct perf_probe_event
*pev
;
1743 struct probe_trace_event
*tevs
;
1747 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
,
1748 int max_tevs
, const char *module
, bool force_add
)
1751 struct __event_package
*pkgs
;
1753 pkgs
= zalloc(sizeof(struct __event_package
) * npevs
);
1757 /* Init vmlinux path */
1758 ret
= init_vmlinux();
1764 /* Loop 1: convert all events */
1765 for (i
= 0; i
< npevs
; i
++) {
1766 pkgs
[i
].pev
= &pevs
[i
];
1767 /* Convert with or without debuginfo */
1768 ret
= convert_to_probe_trace_events(pkgs
[i
].pev
,
1774 pkgs
[i
].ntevs
= ret
;
1777 /* Loop 2: add all events */
1778 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
1779 ret
= __add_probe_trace_events(pkgs
[i
].pev
, pkgs
[i
].tevs
,
1780 pkgs
[i
].ntevs
, force_add
);
1782 /* Loop 3: cleanup and free trace events */
1783 for (i
= 0; i
< npevs
; i
++) {
1784 for (j
= 0; j
< pkgs
[i
].ntevs
; j
++)
1785 clear_probe_trace_event(&pkgs
[i
].tevs
[j
]);
1793 static int __del_trace_probe_event(int fd
, struct str_node
*ent
)
1799 /* Convert from perf-probe event to trace-probe event */
1800 ret
= e_snprintf(buf
, 128, "-:%s", ent
->s
);
1804 p
= strchr(buf
+ 2, ':');
1806 pr_debug("Internal error: %s should have ':' but not.\n",
1813 pr_debug("Writing event: %s\n", buf
);
1814 ret
= write(fd
, buf
, strlen(buf
));
1818 printf("Remove event: %s\n", ent
->s
);
1821 pr_warning("Failed to delete event: %s\n", strerror(-ret
));
1825 static int del_trace_probe_event(int fd
, const char *group
,
1826 const char *event
, struct strlist
*namelist
)
1829 struct str_node
*ent
, *n
;
1830 int found
= 0, ret
= 0;
1832 ret
= e_snprintf(buf
, 128, "%s:%s", group
, event
);
1834 pr_err("Failed to copy event.\n");
1838 if (strpbrk(buf
, "*?")) { /* Glob-exp */
1839 strlist__for_each_safe(ent
, n
, namelist
)
1840 if (strglobmatch(ent
->s
, buf
)) {
1842 ret
= __del_trace_probe_event(fd
, ent
);
1845 strlist__remove(namelist
, ent
);
1848 ent
= strlist__find(namelist
, buf
);
1851 ret
= __del_trace_probe_event(fd
, ent
);
1853 strlist__remove(namelist
, ent
);
1856 if (found
== 0 && ret
>= 0)
1857 pr_info("Info: Event \"%s\" does not exist.\n", buf
);
1862 int del_perf_probe_events(struct strlist
*dellist
)
1865 const char *group
, *event
;
1867 struct str_node
*ent
;
1868 struct strlist
*namelist
;
1870 fd
= open_kprobe_events(true);
1874 /* Get current event names */
1875 namelist
= get_probe_trace_event_names(fd
, true);
1876 if (namelist
== NULL
)
1879 strlist__for_each(ent
, dellist
) {
1880 str
= strdup(ent
->s
);
1885 pr_debug("Parsing: %s\n", str
);
1886 p
= strchr(str
, ':');
1895 pr_debug("Group: %s, Event: %s\n", group
, event
);
1896 ret
= del_trace_probe_event(fd
, group
, event
, namelist
);
1901 strlist__delete(namelist
);