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.
22 #include <sys/utsname.h>
23 #include <sys/types.h>
43 #include <api/fs/debugfs.h>
44 #include "trace-event.h" /* For __maybe_unused */
45 #include "probe-event.h"
46 #include "probe-finder.h"
49 #define MAX_CMDLEN 256
50 #define PERFPROBE_GROUP "probe"
52 bool probe_event_dry_run
; /* Dry run flag */
54 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
56 /* If there is no space to write, returns -E2BIG. */
57 static int e_snprintf(char *str
, size_t size
, const char *format
, ...)
58 __attribute__((format(printf
, 3, 4)));
60 static int e_snprintf(char *str
, size_t size
, const char *format
, ...)
65 ret
= vsnprintf(str
, size
, format
, ap
);
72 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
);
73 static void clear_probe_trace_event(struct probe_trace_event
*tev
);
74 static struct machine
*host_machine
;
76 /* Initialize symbol maps and path of vmlinux/modules */
77 static int init_symbol_maps(bool user_only
)
81 symbol_conf
.sort_by_name
= true;
82 ret
= symbol__init(NULL
);
84 pr_debug("Failed to init symbol map.\n");
88 if (host_machine
|| user_only
) /* already initialized */
91 if (symbol_conf
.vmlinux_name
)
92 pr_debug("Use vmlinux: %s\n", symbol_conf
.vmlinux_name
);
94 host_machine
= machine__new_host();
96 pr_debug("machine__new_host() failed.\n");
102 pr_warning("Failed to init vmlinux path.\n");
106 static void exit_symbol_maps(void)
109 machine__delete(host_machine
);
115 static struct symbol
*__find_kernel_function_by_name(const char *name
,
118 return machine__find_kernel_function_by_name(host_machine
, name
, mapp
,
122 static struct symbol
*__find_kernel_function(u64 addr
, struct map
**mapp
)
124 return machine__find_kernel_function(host_machine
, addr
, mapp
, NULL
);
127 static struct ref_reloc_sym
*kernel_get_ref_reloc_sym(void)
129 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
132 if (map__load(host_machine
->vmlinux_maps
[MAP__FUNCTION
], NULL
) < 0)
135 kmap
= map__kmap(host_machine
->vmlinux_maps
[MAP__FUNCTION
]);
136 return kmap
->ref_reloc_sym
;
139 static u64
kernel_get_symbol_address_by_name(const char *name
, bool reloc
)
141 struct ref_reloc_sym
*reloc_sym
;
145 /* ref_reloc_sym is just a label. Need a special fix*/
146 reloc_sym
= kernel_get_ref_reloc_sym();
147 if (reloc_sym
&& strcmp(name
, reloc_sym
->name
) == 0)
148 return (reloc
) ? reloc_sym
->addr
: reloc_sym
->unrelocated_addr
;
150 sym
= __find_kernel_function_by_name(name
, &map
);
152 return map
->unmap_ip(map
, sym
->start
) -
153 (reloc
) ? 0 : map
->reloc
;
158 static struct map
*kernel_get_module_map(const char *module
)
161 struct map_groups
*grp
= &host_machine
->kmaps
;
163 /* A file path -- this is an offline module */
164 if (module
&& strchr(module
, '/'))
165 return machine__new_module(host_machine
, 0, module
);
170 for (nd
= rb_first(&grp
->maps
[MAP__FUNCTION
]); nd
; nd
= rb_next(nd
)) {
171 struct map
*pos
= rb_entry(nd
, struct map
, rb_node
);
172 if (strncmp(pos
->dso
->short_name
+ 1, module
,
173 pos
->dso
->short_name_len
- 2) == 0) {
180 static struct dso
*kernel_get_module_dso(const char *module
)
184 const char *vmlinux_name
;
187 list_for_each_entry(dso
, &host_machine
->kernel_dsos
, node
) {
188 if (strncmp(dso
->short_name
+ 1, module
,
189 dso
->short_name_len
- 2) == 0)
192 pr_debug("Failed to find module %s.\n", module
);
196 map
= host_machine
->vmlinux_maps
[MAP__FUNCTION
];
199 vmlinux_name
= symbol_conf
.vmlinux_name
;
201 if (dso__load_vmlinux(dso
, map
, vmlinux_name
, false, NULL
) <= 0)
204 if (dso__load_vmlinux_path(dso
, map
, NULL
) <= 0) {
205 pr_debug("Failed to load kernel map.\n");
213 const char *kernel_get_module_path(const char *module
)
215 struct dso
*dso
= kernel_get_module_dso(module
);
216 return (dso
) ? dso
->long_name
: NULL
;
219 static int convert_exec_to_group(const char *exec
, char **result
)
221 char *ptr1
, *ptr2
, *exec_copy
;
225 exec_copy
= strdup(exec
);
229 ptr1
= basename(exec_copy
);
235 ptr2
= strpbrk(ptr1
, "-._");
238 ret
= e_snprintf(buf
, 64, "%s_%s", PERFPROBE_GROUP
, ptr1
);
242 *result
= strdup(buf
);
243 ret
= *result
? 0 : -ENOMEM
;
250 static void clear_probe_trace_events(struct probe_trace_event
*tevs
, int ntevs
)
254 for (i
= 0; i
< ntevs
; i
++)
255 clear_probe_trace_event(tevs
+ i
);
258 #ifdef HAVE_DWARF_SUPPORT
260 /* Open new debuginfo of given module */
261 static struct debuginfo
*open_debuginfo(const char *module
, bool silent
)
263 const char *path
= module
;
264 struct debuginfo
*ret
;
266 if (!module
|| !strchr(module
, '/')) {
267 path
= kernel_get_module_path(module
);
270 pr_err("Failed to find path of %s module.\n",
275 ret
= debuginfo__new(path
);
276 if (!ret
&& !silent
) {
277 pr_warning("The %s file has no debug information.\n", path
);
278 if (!module
|| !strtailcmp(path
, ".ko"))
279 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
281 pr_warning("Rebuild with -g, ");
282 pr_warning("or install an appropriate debuginfo package.\n");
288 static int get_text_start_address(const char *exec
, unsigned long *address
)
293 int fd
, ret
= -ENOENT
;
295 fd
= open(exec
, O_RDONLY
);
299 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
303 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
306 if (!elf_section_by_name(elf
, &ehdr
, &shdr
, ".text", NULL
))
309 *address
= shdr
.sh_addr
- shdr
.sh_offset
;
317 * Convert trace point to probe point with debuginfo
319 static int find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp
,
320 struct perf_probe_point
*pp
,
323 struct debuginfo
*dinfo
= NULL
;
324 unsigned long stext
= 0;
325 u64 addr
= tp
->address
;
328 /* convert the address to dwarf address */
334 ret
= get_text_start_address(tp
->module
, &stext
);
339 addr
= kernel_get_symbol_address_by_name(tp
->symbol
, false);
345 pr_debug("try to find information at %" PRIx64
" in %s\n", addr
,
346 tp
->module
? : "kernel");
348 dinfo
= open_debuginfo(tp
->module
, verbose
== 0);
350 ret
= debuginfo__find_probe_point(dinfo
,
351 (unsigned long)addr
, pp
);
352 debuginfo__delete(dinfo
);
357 pp
->retprobe
= tp
->retprobe
;
361 pr_debug("Failed to find corresponding probes from debuginfo.\n");
362 return ret
? : -ENOENT
;
365 static int add_exec_to_probe_trace_events(struct probe_trace_event
*tevs
,
366 int ntevs
, const char *exec
)
369 unsigned long stext
= 0;
374 ret
= get_text_start_address(exec
, &stext
);
378 for (i
= 0; i
< ntevs
&& ret
>= 0; i
++) {
379 /* point.address is the addres of point.symbol + point.offset */
380 tevs
[i
].point
.address
-= stext
;
381 tevs
[i
].point
.module
= strdup(exec
);
382 if (!tevs
[i
].point
.module
) {
386 tevs
[i
].uprobes
= true;
392 static int add_module_to_probe_trace_events(struct probe_trace_event
*tevs
,
393 int ntevs
, const char *module
)
401 tmp
= strrchr(module
, '/');
403 /* This is a module path -- get the module name */
404 module
= strdup(tmp
+ 1);
407 tmp
= strchr(module
, '.');
410 tmp
= (char *)module
; /* For free() */
413 for (i
= 0; i
< ntevs
; i
++) {
414 tevs
[i
].point
.module
= strdup(module
);
415 if (!tevs
[i
].point
.module
) {
425 /* Post processing the probe events */
426 static int post_process_probe_trace_events(struct probe_trace_event
*tevs
,
427 int ntevs
, const char *module
,
430 struct ref_reloc_sym
*reloc_sym
;
435 return add_exec_to_probe_trace_events(tevs
, ntevs
, module
);
437 /* Note that currently ref_reloc_sym based probe is not for drivers */
439 return add_module_to_probe_trace_events(tevs
, ntevs
, module
);
441 reloc_sym
= kernel_get_ref_reloc_sym();
443 pr_warning("Relocated base symbol is not found!\n");
447 for (i
= 0; i
< ntevs
; i
++) {
448 if (tevs
[i
].point
.address
) {
449 tmp
= strdup(reloc_sym
->name
);
452 free(tevs
[i
].point
.symbol
);
453 tevs
[i
].point
.symbol
= tmp
;
454 tevs
[i
].point
.offset
= tevs
[i
].point
.address
-
455 reloc_sym
->unrelocated_addr
;
461 /* Try to find perf_probe_event with debuginfo */
462 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
463 struct probe_trace_event
**tevs
,
464 int max_tevs
, const char *target
)
466 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
467 struct debuginfo
*dinfo
;
470 dinfo
= open_debuginfo(target
, !need_dwarf
);
475 pr_debug("Could not open debuginfo. Try to use symbols.\n");
479 pr_debug("Try to find probe point from debuginfo.\n");
480 /* Searching trace events corresponding to a probe event */
481 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
, max_tevs
);
483 debuginfo__delete(dinfo
);
485 if (ntevs
> 0) { /* Succeeded to find trace events */
486 pr_debug("Found %d probe_trace_events.\n", ntevs
);
487 ret
= post_process_probe_trace_events(*tevs
, ntevs
,
488 target
, pev
->uprobes
);
490 clear_probe_trace_events(*tevs
, ntevs
);
493 return ret
< 0 ? ret
: ntevs
;
496 if (ntevs
== 0) { /* No error but failed to find probe point. */
497 pr_warning("Probe point '%s' not found.\n",
498 synthesize_perf_probe_point(&pev
->point
));
501 /* Error path : ntevs < 0 */
502 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
503 if (ntevs
== -EBADF
) {
504 pr_warning("Warning: No dwarf info found in the vmlinux - "
505 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
507 pr_debug("Trying to use symbols.\n");
515 * Find a src file from a DWARF tag path. Prepend optional source path prefix
516 * and chop off leading directories that do not exist. Result is passed back as
517 * a newly allocated path on success.
518 * Return 0 if file was found and readable, -errno otherwise.
520 static int get_real_path(const char *raw_path
, const char *comp_dir
,
523 const char *prefix
= symbol_conf
.source_prefix
;
526 if (raw_path
[0] != '/' && comp_dir
)
527 /* If not an absolute path, try to use comp_dir */
530 if (access(raw_path
, R_OK
) == 0) {
531 *new_path
= strdup(raw_path
);
538 *new_path
= malloc((strlen(prefix
) + strlen(raw_path
) + 2));
543 sprintf(*new_path
, "%s/%s", prefix
, raw_path
);
545 if (access(*new_path
, R_OK
) == 0)
548 if (!symbol_conf
.source_prefix
)
549 /* In case of searching comp_dir, don't retry */
557 raw_path
= strchr(++raw_path
, '/');
571 #define LINEBUF_SIZE 256
572 #define NR_ADDITIONAL_LINES 2
574 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
576 char buf
[LINEBUF_SIZE
];
577 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
578 const char *prefix
= NULL
;
581 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
586 prefix
= show_num
? "%7d " : " ";
587 color_fprintf(stdout
, color
, prefix
, l
);
589 color_fprintf(stdout
, color
, "%s", buf
);
591 } while (strchr(buf
, '\n') == NULL
);
596 pr_warning("File read error: %s\n", strerror(errno
));
602 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
604 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
606 pr_warning("Source file is shorter than expected.\n");
612 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
613 #define show_one_line(f,l) _show_one_line(f,l,false,false)
614 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
615 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
618 * Show line-range always requires debuginfo to find source file and
621 static int __show_line_range(struct line_range
*lr
, const char *module
)
625 struct debuginfo
*dinfo
;
630 /* Search a line range */
631 dinfo
= open_debuginfo(module
, false);
635 ret
= debuginfo__find_line_range(dinfo
, lr
);
636 debuginfo__delete(dinfo
);
637 if (ret
== 0 || ret
== -ENOENT
) {
638 pr_warning("Specified source line is not found.\n");
640 } else if (ret
< 0) {
641 pr_warning("Debuginfo analysis failed.\n");
645 /* Convert source file path */
647 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
648 free(tmp
); /* Free old path */
650 pr_warning("Failed to find source file path.\n");
657 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
658 lr
->start
- lr
->offset
);
660 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
662 fp
= fopen(lr
->path
, "r");
664 pr_warning("Failed to open %s: %s\n", lr
->path
,
668 /* Skip to starting line number */
669 while (l
< lr
->start
) {
670 ret
= skip_one_line(fp
, l
++);
675 intlist__for_each(ln
, lr
->line_list
) {
676 for (; ln
->i
> l
; l
++) {
677 ret
= show_one_line(fp
, l
- lr
->offset
);
681 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
686 if (lr
->end
== INT_MAX
)
687 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
688 while (l
<= lr
->end
) {
689 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
698 int show_line_range(struct line_range
*lr
, const char *module
)
702 ret
= init_symbol_maps(false);
705 ret
= __show_line_range(lr
, module
);
711 static int show_available_vars_at(struct debuginfo
*dinfo
,
712 struct perf_probe_event
*pev
,
713 int max_vls
, struct strfilter
*_filter
,
718 struct str_node
*node
;
719 struct variable_list
*vls
= NULL
, *vl
;
722 buf
= synthesize_perf_probe_point(&pev
->point
);
725 pr_debug("Searching variables at %s\n", buf
);
727 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
,
730 if (ret
== 0 || ret
== -ENOENT
) {
731 pr_err("Failed to find the address of %s\n", buf
);
734 pr_warning("Debuginfo analysis failed.\n");
738 /* Some variables are found */
739 fprintf(stdout
, "Available variables at %s\n", buf
);
740 for (i
= 0; i
< ret
; i
++) {
743 * A probe point might be converted to
744 * several trace points.
746 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
748 zfree(&vl
->point
.symbol
);
751 strlist__for_each(node
, vl
->vars
) {
752 var
= strchr(node
->s
, '\t') + 1;
753 if (strfilter__compare(_filter
, var
)) {
754 fprintf(stdout
, "\t\t%s\n", node
->s
);
758 strlist__delete(vl
->vars
);
761 fprintf(stdout
, "\t\t(No matched variables)\n");
769 /* Show available variables on given probe point */
770 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
771 int max_vls
, const char *module
,
772 struct strfilter
*_filter
, bool externs
)
775 struct debuginfo
*dinfo
;
777 ret
= init_symbol_maps(false);
781 dinfo
= open_debuginfo(module
, false);
789 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
790 ret
= show_available_vars_at(dinfo
, &pevs
[i
], max_vls
, _filter
,
793 debuginfo__delete(dinfo
);
799 #else /* !HAVE_DWARF_SUPPORT */
802 find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp __maybe_unused
,
803 struct perf_probe_point
*pp __maybe_unused
,
804 bool is_kprobe __maybe_unused
)
809 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
810 struct probe_trace_event
**tevs __maybe_unused
,
811 int max_tevs __maybe_unused
,
812 const char *target __maybe_unused
)
814 if (perf_probe_event_need_dwarf(pev
)) {
815 pr_warning("Debuginfo-analysis is not supported.\n");
822 int show_line_range(struct line_range
*lr __maybe_unused
,
823 const char *module __maybe_unused
)
825 pr_warning("Debuginfo-analysis is not supported.\n");
829 int show_available_vars(struct perf_probe_event
*pevs __maybe_unused
,
830 int npevs __maybe_unused
, int max_vls __maybe_unused
,
831 const char *module __maybe_unused
,
832 struct strfilter
*filter __maybe_unused
,
833 bool externs __maybe_unused
)
835 pr_warning("Debuginfo-analysis is not supported.\n");
840 void line_range__clear(struct line_range
*lr
)
846 intlist__delete(lr
->line_list
);
847 memset(lr
, 0, sizeof(*lr
));
850 int line_range__init(struct line_range
*lr
)
852 memset(lr
, 0, sizeof(*lr
));
853 lr
->line_list
= intlist__new(NULL
);
860 static int parse_line_num(char **ptr
, int *val
, const char *what
)
862 const char *start
= *ptr
;
865 *val
= strtol(*ptr
, ptr
, 0);
866 if (errno
|| *ptr
== start
) {
867 semantic_error("'%s' is not a valid number.\n", what
);
874 * Stuff 'lr' according to the line range described by 'arg'.
875 * The line range syntax is described by:
877 * SRC[:SLN[+NUM|-ELN]]
878 * FNC[@SRC][:SLN[+NUM|-ELN]]
880 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
882 char *range
, *file
, *name
= strdup(arg
);
891 range
= strchr(name
, ':');
895 err
= parse_line_num(&range
, &lr
->start
, "start line");
899 if (*range
== '+' || *range
== '-') {
900 const char c
= *range
++;
902 err
= parse_line_num(&range
, &lr
->end
, "end line");
907 lr
->end
+= lr
->start
;
909 * Adjust the number of lines here.
910 * If the number of lines == 1, the
911 * the end of line should be equal to
918 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
921 if (lr
->start
> lr
->end
) {
922 semantic_error("Start line must be smaller"
923 " than end line.\n");
926 if (*range
!= '\0') {
927 semantic_error("Tailing with invalid str '%s'.\n", range
);
932 file
= strchr(name
, '@');
935 lr
->file
= strdup(++file
);
936 if (lr
->file
== NULL
) {
941 } else if (strchr(name
, '.'))
952 /* Check the name is good for event/group */
953 static bool check_event_name(const char *name
)
955 if (!isalpha(*name
) && *name
!= '_')
957 while (*++name
!= '\0') {
958 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
964 /* Parse probepoint definition. */
965 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
967 struct perf_probe_point
*pp
= &pev
->point
;
972 * perf probe [EVENT=]SRC[:LN|;PTN]
973 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
975 * TODO:Group name support
978 ptr
= strpbrk(arg
, ";=@+%");
979 if (ptr
&& *ptr
== '=') { /* Event name */
982 if (strchr(arg
, ':')) {
983 semantic_error("Group name is not supported yet.\n");
986 if (!check_event_name(arg
)) {
987 semantic_error("%s is bad for event name -it must "
988 "follow C symbol-naming rule.\n", arg
);
991 pev
->event
= strdup(arg
);
992 if (pev
->event
== NULL
)
998 ptr
= strpbrk(arg
, ";:+@%");
1008 /* Check arg is function or file and copy it */
1009 if (strchr(tmp
, '.')) /* File */
1014 /* Parse other options */
1018 if (c
== ';') { /* Lazy pattern must be the last part */
1019 pp
->lazy_line
= strdup(arg
);
1020 if (pp
->lazy_line
== NULL
)
1024 ptr
= strpbrk(arg
, ";:+@%");
1030 case ':': /* Line number */
1031 pp
->line
= strtoul(arg
, &tmp
, 0);
1033 semantic_error("There is non-digit char"
1034 " in line number.\n");
1038 case '+': /* Byte offset from a symbol */
1039 pp
->offset
= strtoul(arg
, &tmp
, 0);
1041 semantic_error("There is non-digit character"
1046 case '@': /* File name */
1048 semantic_error("SRC@SRC is not allowed.\n");
1051 pp
->file
= strdup(arg
);
1052 if (pp
->file
== NULL
)
1055 case '%': /* Probe places */
1056 if (strcmp(arg
, "return") == 0) {
1058 } else { /* Others not supported yet */
1059 semantic_error("%%%s is not supported.\n", arg
);
1063 default: /* Buggy case */
1064 pr_err("This program has a bug at %s:%d.\n",
1065 __FILE__
, __LINE__
);
1071 /* Exclusion check */
1072 if (pp
->lazy_line
&& pp
->line
) {
1073 semantic_error("Lazy pattern can't be used with"
1078 if (pp
->lazy_line
&& pp
->offset
) {
1079 semantic_error("Lazy pattern can't be used with offset.\n");
1083 if (pp
->line
&& pp
->offset
) {
1084 semantic_error("Offset can't be used with line number.\n");
1088 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
1089 semantic_error("File always requires line number or "
1094 if (pp
->offset
&& !pp
->function
) {
1095 semantic_error("Offset requires an entry function.\n");
1099 if (pp
->retprobe
&& !pp
->function
) {
1100 semantic_error("Return probe requires an entry function.\n");
1104 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
1105 semantic_error("Offset/Line/Lazy pattern can't be used with "
1110 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1111 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
1116 /* Parse perf-probe event argument */
1117 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
1119 char *tmp
, *goodname
;
1120 struct perf_probe_arg_field
**fieldp
;
1122 pr_debug("parsing arg: %s into ", str
);
1124 tmp
= strchr(str
, '=');
1126 arg
->name
= strndup(str
, tmp
- str
);
1127 if (arg
->name
== NULL
)
1129 pr_debug("name:%s ", arg
->name
);
1133 tmp
= strchr(str
, ':');
1134 if (tmp
) { /* Type setting */
1136 arg
->type
= strdup(tmp
+ 1);
1137 if (arg
->type
== NULL
)
1139 pr_debug("type:%s ", arg
->type
);
1142 tmp
= strpbrk(str
, "-.[");
1143 if (!is_c_varname(str
) || !tmp
) {
1144 /* A variable, register, symbol or special value */
1145 arg
->var
= strdup(str
);
1146 if (arg
->var
== NULL
)
1148 pr_debug("%s\n", arg
->var
);
1152 /* Structure fields or array element */
1153 arg
->var
= strndup(str
, tmp
- str
);
1154 if (arg
->var
== NULL
)
1156 goodname
= arg
->var
;
1157 pr_debug("%s, ", arg
->var
);
1158 fieldp
= &arg
->field
;
1161 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
1162 if (*fieldp
== NULL
)
1164 if (*tmp
== '[') { /* Array */
1166 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
1167 (*fieldp
)->ref
= true;
1168 if (*tmp
!= ']' || tmp
== str
+ 1) {
1169 semantic_error("Array index must be a"
1176 } else { /* Structure */
1179 (*fieldp
)->ref
= false;
1180 } else if (tmp
[1] == '>') {
1182 (*fieldp
)->ref
= true;
1184 semantic_error("Argument parse error: %s\n",
1188 tmp
= strpbrk(str
, "-.[");
1191 (*fieldp
)->name
= strndup(str
, tmp
- str
);
1192 if ((*fieldp
)->name
== NULL
)
1195 goodname
= (*fieldp
)->name
;
1196 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
1197 fieldp
= &(*fieldp
)->next
;
1200 (*fieldp
)->name
= strdup(str
);
1201 if ((*fieldp
)->name
== NULL
)
1204 goodname
= (*fieldp
)->name
;
1205 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
1207 /* If no name is specified, set the last field name (not array index)*/
1209 arg
->name
= strdup(goodname
);
1210 if (arg
->name
== NULL
)
1216 /* Parse perf-probe event command */
1217 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1220 int argc
, i
, ret
= 0;
1222 argv
= argv_split(cmd
, &argc
);
1224 pr_debug("Failed to split arguments.\n");
1227 if (argc
- 1 > MAX_PROBE_ARGS
) {
1228 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1232 /* Parse probe point */
1233 ret
= parse_perf_probe_point(argv
[0], pev
);
1237 /* Copy arguments and ensure return probe has no C argument */
1238 pev
->nargs
= argc
- 1;
1239 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1240 if (pev
->args
== NULL
) {
1244 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1245 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1247 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1248 semantic_error("You can't specify local variable for"
1259 /* Return true if this perf_probe_event requires debuginfo */
1260 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1264 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1267 for (i
= 0; i
< pev
->nargs
; i
++)
1268 if (is_c_varname(pev
->args
[i
].var
))
1274 /* Parse probe_events event into struct probe_point */
1275 static int parse_probe_trace_command(const char *cmd
,
1276 struct probe_trace_event
*tev
)
1278 struct probe_trace_point
*tp
= &tev
->point
;
1281 char *argv0_str
= NULL
, *fmt
, *fmt1_str
, *fmt2_str
, *fmt3_str
;
1285 pr_debug("Parsing probe_events: %s\n", cmd
);
1286 argv
= argv_split(cmd
, &argc
);
1288 pr_debug("Failed to split arguments.\n");
1292 semantic_error("Too few probe arguments.\n");
1297 /* Scan event and group name. */
1298 argv0_str
= strdup(argv
[0]);
1299 if (argv0_str
== NULL
) {
1303 fmt1_str
= strtok_r(argv0_str
, ":", &fmt
);
1304 fmt2_str
= strtok_r(NULL
, "/", &fmt
);
1305 fmt3_str
= strtok_r(NULL
, " \t", &fmt
);
1306 if (fmt1_str
== NULL
|| strlen(fmt1_str
) != 1 || fmt2_str
== NULL
1307 || fmt3_str
== NULL
) {
1308 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1313 tev
->group
= strdup(fmt2_str
);
1314 tev
->event
= strdup(fmt3_str
);
1315 if (tev
->group
== NULL
|| tev
->event
== NULL
) {
1319 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1321 tp
->retprobe
= (pr
== 'r');
1323 /* Scan module name(if there), function name and offset */
1324 p
= strchr(argv
[1], ':');
1326 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1330 fmt1_str
= strtok_r(p
, "+", &fmt
);
1331 if (fmt1_str
[0] == '0') /* only the address started with 0x */
1332 tp
->address
= strtoul(fmt1_str
, NULL
, 0);
1334 /* Only the symbol-based probe has offset */
1335 tp
->symbol
= strdup(fmt1_str
);
1336 if (tp
->symbol
== NULL
) {
1340 fmt2_str
= strtok_r(NULL
, "", &fmt
);
1341 if (fmt2_str
== NULL
)
1344 tp
->offset
= strtoul(fmt2_str
, NULL
, 10);
1347 tev
->nargs
= argc
- 2;
1348 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
1349 if (tev
->args
== NULL
) {
1353 for (i
= 0; i
< tev
->nargs
; i
++) {
1354 p
= strchr(argv
[i
+ 2], '=');
1355 if (p
) /* We don't need which register is assigned. */
1359 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
1360 /* TODO: parse regs and offset */
1361 tev
->args
[i
].value
= strdup(p
);
1362 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1374 /* Compose only probe arg */
1375 int synthesize_perf_probe_arg(struct perf_probe_arg
*pa
, char *buf
, size_t len
)
1377 struct perf_probe_arg_field
*field
= pa
->field
;
1381 if (pa
->name
&& pa
->var
)
1382 ret
= e_snprintf(tmp
, len
, "%s=%s", pa
->name
, pa
->var
);
1384 ret
= e_snprintf(tmp
, len
, "%s", pa
->name
? pa
->name
: pa
->var
);
1391 if (field
->name
[0] == '[')
1392 ret
= e_snprintf(tmp
, len
, "%s", field
->name
);
1394 ret
= e_snprintf(tmp
, len
, "%s%s",
1395 field
->ref
? "->" : ".", field
->name
);
1400 field
= field
->next
;
1404 ret
= e_snprintf(tmp
, len
, ":%s", pa
->type
);
1413 pr_debug("Failed to synthesize perf probe argument: %s\n",
1418 /* Compose only probe point (not argument) */
1419 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1422 char offs
[32] = "", line
[32] = "", file
[32] = "";
1425 buf
= zalloc(MAX_CMDLEN
);
1431 ret
= e_snprintf(offs
, 32, "+%lu", pp
->offset
);
1436 ret
= e_snprintf(line
, 32, ":%d", pp
->line
);
1444 tmp
= strchr(pp
->file
+ len
- 30, '/');
1445 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1447 ret
= e_snprintf(file
, 32, "@%s", tmp
);
1453 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s%s%s%s", pp
->function
,
1454 offs
, pp
->retprobe
? "%return" : "", line
,
1457 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s", file
, line
);
1463 pr_debug("Failed to synthesize perf probe point: %s\n",
1470 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1475 buf
= synthesize_perf_probe_point(&pev
->point
);
1480 for (i
= 0; i
< pev
->nargs
; i
++) {
1481 ret
= e_snprintf(&buf
[len
], MAX_CMDLEN
- len
, " %s",
1494 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1495 char **buf
, size_t *buflen
,
1500 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1506 ret
= e_snprintf(*buf
, *buflen
, "%+ld(", ref
->offset
);
1518 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1519 char *buf
, size_t buflen
)
1521 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1525 /* Argument name or separator */
1527 ret
= e_snprintf(buf
, buflen
, " %s=", arg
->name
);
1529 ret
= e_snprintf(buf
, buflen
, " ");
1535 /* Special case: @XXX */
1536 if (arg
->value
[0] == '@' && arg
->ref
)
1539 /* Dereferencing arguments */
1541 depth
= __synthesize_probe_trace_arg_ref(ref
, &buf
,
1547 /* Print argument value */
1548 if (arg
->value
[0] == '@' && arg
->ref
)
1549 ret
= e_snprintf(buf
, buflen
, "%s%+ld", arg
->value
,
1552 ret
= e_snprintf(buf
, buflen
, "%s", arg
->value
);
1560 ret
= e_snprintf(buf
, buflen
, ")");
1566 /* Print argument type */
1568 ret
= e_snprintf(buf
, buflen
, ":%s", arg
->type
);
1577 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
1579 struct probe_trace_point
*tp
= &tev
->point
;
1583 buf
= zalloc(MAX_CMDLEN
);
1587 len
= e_snprintf(buf
, MAX_CMDLEN
, "%c:%s/%s ", tp
->retprobe
? 'r' : 'p',
1588 tev
->group
, tev
->event
);
1592 /* Uprobes must have tp->address and tp->module */
1593 if (tev
->uprobes
&& (!tp
->address
|| !tp
->module
))
1596 /* Use the tp->address for uprobes */
1598 ret
= e_snprintf(buf
+ len
, MAX_CMDLEN
- len
, "%s:0x%lx",
1599 tp
->module
, tp
->address
);
1601 ret
= e_snprintf(buf
+ len
, MAX_CMDLEN
- len
, "%s%s%s+%lu",
1602 tp
->module
?: "", tp
->module
? ":" : "",
1603 tp
->symbol
, tp
->offset
);
1609 for (i
= 0; i
< tev
->nargs
; i
++) {
1610 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], buf
+ len
,
1623 static int find_perf_probe_point_from_map(struct probe_trace_point
*tp
,
1624 struct perf_probe_point
*pp
,
1627 struct symbol
*sym
= NULL
;
1633 map
= dso__new_map(tp
->module
);
1637 sym
= map__find_symbol(map
, addr
, NULL
);
1639 addr
= kernel_get_symbol_address_by_name(tp
->symbol
, true);
1642 sym
= __find_kernel_function(addr
, &map
);
1648 pp
->retprobe
= tp
->retprobe
;
1649 pp
->offset
= addr
- map
->unmap_ip(map
, sym
->start
);
1650 pp
->function
= strdup(sym
->name
);
1651 ret
= pp
->function
? 0 : -ENOMEM
;
1654 if (map
&& !is_kprobe
) {
1655 dso__delete(map
->dso
);
1662 static int convert_to_perf_probe_point(struct probe_trace_point
*tp
,
1663 struct perf_probe_point
*pp
,
1669 ret
= find_perf_probe_point_from_dwarf(tp
, pp
, is_kprobe
);
1672 ret
= find_perf_probe_point_from_map(tp
, pp
, is_kprobe
);
1676 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1679 pp
->function
= strdup(tp
->symbol
);
1680 pp
->offset
= tp
->offset
;
1681 } else if (!tp
->module
&& !is_kprobe
) {
1682 ret
= e_snprintf(buf
, 128, "0x%" PRIx64
, (u64
)tp
->address
);
1685 pp
->function
= strdup(buf
);
1688 if (pp
->function
== NULL
)
1691 pp
->retprobe
= tp
->retprobe
;
1696 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
1697 struct perf_probe_event
*pev
, bool is_kprobe
)
1702 /* Convert event/group name */
1703 pev
->event
= strdup(tev
->event
);
1704 pev
->group
= strdup(tev
->group
);
1705 if (pev
->event
== NULL
|| pev
->group
== NULL
)
1708 /* Convert trace_point to probe_point */
1709 ret
= convert_to_perf_probe_point(&tev
->point
, &pev
->point
, is_kprobe
);
1713 /* Convert trace_arg to probe_arg */
1714 pev
->nargs
= tev
->nargs
;
1715 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1716 if (pev
->args
== NULL
)
1718 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
1719 if (tev
->args
[i
].name
)
1720 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
1722 ret
= synthesize_probe_trace_arg(&tev
->args
[i
],
1724 pev
->args
[i
].name
= strdup(buf
);
1726 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
1731 clear_perf_probe_event(pev
);
1736 void clear_perf_probe_event(struct perf_probe_event
*pev
)
1738 struct perf_probe_point
*pp
= &pev
->point
;
1739 struct perf_probe_arg_field
*field
, *next
;
1746 free(pp
->lazy_line
);
1748 for (i
= 0; i
< pev
->nargs
; i
++) {
1749 free(pev
->args
[i
].name
);
1750 free(pev
->args
[i
].var
);
1751 free(pev
->args
[i
].type
);
1752 field
= pev
->args
[i
].field
;
1755 zfree(&field
->name
);
1761 memset(pev
, 0, sizeof(*pev
));
1764 static void clear_probe_trace_event(struct probe_trace_event
*tev
)
1766 struct probe_trace_arg_ref
*ref
, *next
;
1771 free(tev
->point
.symbol
);
1772 free(tev
->point
.module
);
1773 for (i
= 0; i
< tev
->nargs
; i
++) {
1774 free(tev
->args
[i
].name
);
1775 free(tev
->args
[i
].value
);
1776 free(tev
->args
[i
].type
);
1777 ref
= tev
->args
[i
].ref
;
1785 memset(tev
, 0, sizeof(*tev
));
1788 static void print_open_warning(int err
, bool is_kprobe
)
1792 if (err
== -ENOENT
) {
1796 config
= "CONFIG_UPROBE_EVENTS";
1798 config
= "CONFIG_KPROBE_EVENTS";
1800 pr_warning("%cprobe_events file does not exist"
1801 " - please rebuild kernel with %s.\n",
1802 is_kprobe
? 'k' : 'u', config
);
1803 } else if (err
== -ENOTSUP
)
1804 pr_warning("Debugfs is not mounted.\n");
1806 pr_warning("Failed to open %cprobe_events: %s\n",
1807 is_kprobe
? 'k' : 'u',
1808 strerror_r(-err
, sbuf
, sizeof(sbuf
)));
1811 static void print_both_open_warning(int kerr
, int uerr
)
1813 /* Both kprobes and uprobes are disabled, warn it. */
1814 if (kerr
== -ENOTSUP
&& uerr
== -ENOTSUP
)
1815 pr_warning("Debugfs is not mounted.\n");
1816 else if (kerr
== -ENOENT
&& uerr
== -ENOENT
)
1817 pr_warning("Please rebuild kernel with CONFIG_KPROBE_EVENTS "
1818 "or/and CONFIG_UPROBE_EVENTS.\n");
1821 pr_warning("Failed to open kprobe events: %s.\n",
1822 strerror_r(-kerr
, sbuf
, sizeof(sbuf
)));
1823 pr_warning("Failed to open uprobe events: %s.\n",
1824 strerror_r(-uerr
, sbuf
, sizeof(sbuf
)));
1828 static int open_probe_events(const char *trace_file
, bool readwrite
)
1831 const char *__debugfs
;
1834 __debugfs
= debugfs_find_mountpoint();
1835 if (__debugfs
== NULL
)
1838 ret
= e_snprintf(buf
, PATH_MAX
, "%s/%s", __debugfs
, trace_file
);
1840 pr_debug("Opening %s write=%d\n", buf
, readwrite
);
1841 if (readwrite
&& !probe_event_dry_run
)
1842 ret
= open(buf
, O_RDWR
, O_APPEND
);
1844 ret
= open(buf
, O_RDONLY
, 0);
1852 static int open_kprobe_events(bool readwrite
)
1854 return open_probe_events("tracing/kprobe_events", readwrite
);
1857 static int open_uprobe_events(bool readwrite
)
1859 return open_probe_events("tracing/uprobe_events", readwrite
);
1862 /* Get raw string list of current kprobe_events or uprobe_events */
1863 static struct strlist
*get_probe_trace_command_rawlist(int fd
)
1867 char buf
[MAX_CMDLEN
];
1871 sl
= strlist__new(true, NULL
);
1873 fp
= fdopen(dup(fd
), "r");
1875 p
= fgets(buf
, MAX_CMDLEN
, fp
);
1879 idx
= strlen(p
) - 1;
1882 ret
= strlist__add(sl
, buf
);
1884 pr_debug("strlist__add failed: %s\n", strerror(-ret
));
1885 strlist__delete(sl
);
1895 static int show_perf_probe_event(struct perf_probe_event
*pev
,
1902 /* Synthesize only event probe point */
1903 place
= synthesize_perf_probe_point(&pev
->point
);
1907 ret
= e_snprintf(buf
, 128, "%s:%s", pev
->group
, pev
->event
);
1911 printf(" %-20s (on %s", buf
, place
);
1913 printf(" in %s", module
);
1915 if (pev
->nargs
> 0) {
1917 for (i
= 0; i
< pev
->nargs
; i
++) {
1918 ret
= synthesize_perf_probe_arg(&pev
->args
[i
],
1930 static int __show_perf_probe_events(int fd
, bool is_kprobe
)
1933 struct probe_trace_event tev
;
1934 struct perf_probe_event pev
;
1935 struct strlist
*rawlist
;
1936 struct str_node
*ent
;
1938 memset(&tev
, 0, sizeof(tev
));
1939 memset(&pev
, 0, sizeof(pev
));
1941 rawlist
= get_probe_trace_command_rawlist(fd
);
1945 strlist__for_each(ent
, rawlist
) {
1946 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1948 ret
= convert_to_perf_probe_event(&tev
, &pev
,
1951 ret
= show_perf_probe_event(&pev
,
1954 clear_perf_probe_event(&pev
);
1955 clear_probe_trace_event(&tev
);
1959 strlist__delete(rawlist
);
1964 /* List up current perf-probe events */
1965 int show_perf_probe_events(void)
1967 int kp_fd
, up_fd
, ret
;
1971 ret
= init_symbol_maps(false);
1975 kp_fd
= open_kprobe_events(false);
1977 ret
= __show_perf_probe_events(kp_fd
, true);
1983 up_fd
= open_uprobe_events(false);
1984 if (kp_fd
< 0 && up_fd
< 0) {
1985 print_both_open_warning(kp_fd
, up_fd
);
1991 ret
= __show_perf_probe_events(up_fd
, false);
1999 /* Get current perf-probe event names */
2000 static struct strlist
*get_probe_trace_event_names(int fd
, bool include_group
)
2003 struct strlist
*sl
, *rawlist
;
2004 struct str_node
*ent
;
2005 struct probe_trace_event tev
;
2008 memset(&tev
, 0, sizeof(tev
));
2009 rawlist
= get_probe_trace_command_rawlist(fd
);
2010 sl
= strlist__new(true, NULL
);
2011 strlist__for_each(ent
, rawlist
) {
2012 ret
= parse_probe_trace_command(ent
->s
, &tev
);
2015 if (include_group
) {
2016 ret
= e_snprintf(buf
, 128, "%s:%s", tev
.group
,
2019 ret
= strlist__add(sl
, buf
);
2021 ret
= strlist__add(sl
, tev
.event
);
2022 clear_probe_trace_event(&tev
);
2026 strlist__delete(rawlist
);
2029 strlist__delete(sl
);
2035 static int write_probe_trace_event(int fd
, struct probe_trace_event
*tev
)
2038 char *buf
= synthesize_probe_trace_command(tev
);
2041 pr_debug("Failed to synthesize probe trace event.\n");
2045 pr_debug("Writing event: %s\n", buf
);
2046 if (!probe_event_dry_run
) {
2047 ret
= write(fd
, buf
, strlen(buf
));
2049 pr_warning("Failed to write event: %s\n",
2056 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
2057 struct strlist
*namelist
, bool allow_suffix
)
2062 ret
= e_snprintf(buf
, len
, "%s", base
);
2064 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
2067 if (!strlist__has_entry(namelist
, buf
))
2070 if (!allow_suffix
) {
2071 pr_warning("Error: event \"%s\" already exists. "
2072 "(Use -f to force duplicates.)\n", base
);
2076 /* Try to add suffix */
2077 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
2078 ret
= e_snprintf(buf
, len
, "%s_%d", base
, i
);
2080 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
2083 if (!strlist__has_entry(namelist
, buf
))
2086 if (i
== MAX_EVENT_INDEX
) {
2087 pr_warning("Too many events are on the same function.\n");
2094 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
2095 struct probe_trace_event
*tevs
,
2096 int ntevs
, bool allow_suffix
)
2099 struct probe_trace_event
*tev
= NULL
;
2101 const char *event
, *group
;
2102 struct strlist
*namelist
;
2105 fd
= open_uprobe_events(true);
2107 fd
= open_kprobe_events(true);
2110 print_open_warning(fd
, !pev
->uprobes
);
2114 /* Get current event names */
2115 namelist
= get_probe_trace_event_names(fd
, false);
2117 pr_debug("Failed to get current event list.\n");
2122 printf("Added new event%s\n", (ntevs
> 1) ? "s:" : ":");
2123 for (i
= 0; i
< ntevs
; i
++) {
2128 if (pev
->point
.function
)
2129 event
= pev
->point
.function
;
2131 event
= tev
->point
.symbol
;
2135 group
= PERFPROBE_GROUP
;
2137 /* Get an unused new event name */
2138 ret
= get_new_event_name(buf
, 64, event
,
2139 namelist
, allow_suffix
);
2144 tev
->event
= strdup(event
);
2145 tev
->group
= strdup(group
);
2146 if (tev
->event
== NULL
|| tev
->group
== NULL
) {
2150 ret
= write_probe_trace_event(fd
, tev
);
2153 /* Add added event name to namelist */
2154 strlist__add(namelist
, event
);
2156 /* Trick here - save current event/group */
2159 pev
->event
= tev
->event
;
2160 pev
->group
= tev
->group
;
2161 show_perf_probe_event(pev
, tev
->point
.module
);
2162 /* Trick here - restore current event/group */
2163 pev
->event
= (char *)event
;
2164 pev
->group
= (char *)group
;
2167 * Probes after the first probe which comes from same
2168 * user input are always allowed to add suffix, because
2169 * there might be several addresses corresponding to
2172 allow_suffix
= true;
2176 /* Show how to use the event. */
2177 printf("\nYou can now use it in all perf tools, such as:\n\n");
2178 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev
->group
,
2182 strlist__delete(namelist
);
2187 static char *looking_function_name
;
2188 static int num_matched_functions
;
2190 static int probe_function_filter(struct map
*map __maybe_unused
,
2193 if ((sym
->binding
== STB_GLOBAL
|| sym
->binding
== STB_LOCAL
) &&
2194 strcmp(looking_function_name
, sym
->name
) == 0) {
2195 num_matched_functions
++;
2201 #define strdup_or_goto(str, label) \
2202 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2205 * Find probe function addresses from map.
2206 * Return an error or the number of found probe_trace_event
2208 static int find_probe_trace_events_from_map(struct perf_probe_event
*pev
,
2209 struct probe_trace_event
**tevs
,
2210 int max_tevs
, const char *target
)
2212 struct map
*map
= NULL
;
2213 struct kmap
*kmap
= NULL
;
2214 struct ref_reloc_sym
*reloc_sym
= NULL
;
2217 struct probe_trace_event
*tev
;
2218 struct perf_probe_point
*pp
= &pev
->point
;
2219 struct probe_trace_point
*tp
;
2222 /* Init maps of given executable or kernel */
2224 map
= dso__new_map(target
);
2226 map
= kernel_get_module_map(target
);
2233 * Load matched symbols: Since the different local symbols may have
2234 * same name but different addresses, this lists all the symbols.
2236 num_matched_functions
= 0;
2237 looking_function_name
= pp
->function
;
2238 ret
= map__load(map
, probe_function_filter
);
2239 if (ret
|| num_matched_functions
== 0) {
2240 pr_err("Failed to find symbol %s in %s\n", pp
->function
,
2241 target
? : "kernel");
2244 } else if (num_matched_functions
> max_tevs
) {
2245 pr_err("Too many functions matched in %s\n",
2246 target
? : "kernel");
2251 if (!pev
->uprobes
) {
2252 kmap
= map__kmap(map
);
2253 reloc_sym
= kmap
->ref_reloc_sym
;
2255 pr_warning("Relocated base symbol is not found!\n");
2261 /* Setup result trace-probe-events */
2262 *tevs
= zalloc(sizeof(*tev
) * num_matched_functions
);
2269 map__for_each_symbol(map
, sym
, nd
) {
2270 tev
= (*tevs
) + ret
;
2272 if (ret
== num_matched_functions
) {
2273 pr_warning("Too many symbols are listed. Skip it.\n");
2278 if (pp
->offset
> sym
->end
- sym
->start
) {
2279 pr_warning("Offset %ld is bigger than the size of %s\n",
2280 pp
->offset
, sym
->name
);
2284 /* Add one probe point */
2285 tp
->address
= map
->unmap_ip(map
, sym
->start
) + pp
->offset
;
2287 tp
->symbol
= strdup_or_goto(reloc_sym
->name
, nomem_out
);
2288 tp
->offset
= tp
->address
- reloc_sym
->addr
;
2290 tp
->symbol
= strdup_or_goto(sym
->name
, nomem_out
);
2291 tp
->offset
= pp
->offset
;
2293 tp
->retprobe
= pp
->retprobe
;
2295 tev
->point
.module
= strdup_or_goto(target
, nomem_out
);
2296 tev
->uprobes
= pev
->uprobes
;
2297 tev
->nargs
= pev
->nargs
;
2299 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) *
2301 if (tev
->args
== NULL
)
2304 for (i
= 0; i
< tev
->nargs
; i
++) {
2305 if (pev
->args
[i
].name
)
2307 strdup_or_goto(pev
->args
[i
].name
,
2310 tev
->args
[i
].value
= strdup_or_goto(pev
->args
[i
].var
,
2312 if (pev
->args
[i
].type
)
2314 strdup_or_goto(pev
->args
[i
].type
,
2320 if (map
&& pev
->uprobes
) {
2321 /* Only when using uprobe(exec) map needs to be released */
2322 dso__delete(map
->dso
);
2330 clear_probe_trace_events(*tevs
, num_matched_functions
);
2335 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
2336 struct probe_trace_event
**tevs
,
2337 int max_tevs
, const char *target
)
2341 if (pev
->uprobes
&& !pev
->group
) {
2342 /* Replace group name if not given */
2343 ret
= convert_exec_to_group(target
, &pev
->group
);
2345 pr_warning("Failed to make a group name.\n");
2350 /* Convert perf_probe_event with debuginfo */
2351 ret
= try_to_find_probe_trace_events(pev
, tevs
, max_tevs
, target
);
2353 return ret
; /* Found in debuginfo or got an error */
2355 return find_probe_trace_events_from_map(pev
, tevs
, max_tevs
, target
);
2358 struct __event_package
{
2359 struct perf_probe_event
*pev
;
2360 struct probe_trace_event
*tevs
;
2364 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
,
2365 int max_tevs
, const char *target
, bool force_add
)
2368 struct __event_package
*pkgs
;
2371 pkgs
= zalloc(sizeof(struct __event_package
) * npevs
);
2376 ret
= init_symbol_maps(pevs
->uprobes
);
2382 /* Loop 1: convert all events */
2383 for (i
= 0; i
< npevs
; i
++) {
2384 pkgs
[i
].pev
= &pevs
[i
];
2385 /* Convert with or without debuginfo */
2386 ret
= convert_to_probe_trace_events(pkgs
[i
].pev
,
2392 pkgs
[i
].ntevs
= ret
;
2395 /* Loop 2: add all events */
2396 for (i
= 0; i
< npevs
; i
++) {
2397 ret
= __add_probe_trace_events(pkgs
[i
].pev
, pkgs
[i
].tevs
,
2398 pkgs
[i
].ntevs
, force_add
);
2403 /* Loop 3: cleanup and free trace events */
2404 for (i
= 0; i
< npevs
; i
++) {
2405 for (j
= 0; j
< pkgs
[i
].ntevs
; j
++)
2406 clear_probe_trace_event(&pkgs
[i
].tevs
[j
]);
2407 zfree(&pkgs
[i
].tevs
);
2415 static int __del_trace_probe_event(int fd
, struct str_node
*ent
)
2421 /* Convert from perf-probe event to trace-probe event */
2422 ret
= e_snprintf(buf
, 128, "-:%s", ent
->s
);
2426 p
= strchr(buf
+ 2, ':');
2428 pr_debug("Internal error: %s should have ':' but not.\n",
2435 pr_debug("Writing event: %s\n", buf
);
2436 ret
= write(fd
, buf
, strlen(buf
));
2442 printf("Removed event: %s\n", ent
->s
);
2445 pr_warning("Failed to delete event: %s\n", strerror(-ret
));
2449 static int del_trace_probe_event(int fd
, const char *buf
,
2450 struct strlist
*namelist
)
2452 struct str_node
*ent
, *n
;
2455 if (strpbrk(buf
, "*?")) { /* Glob-exp */
2456 strlist__for_each_safe(ent
, n
, namelist
)
2457 if (strglobmatch(ent
->s
, buf
)) {
2458 ret
= __del_trace_probe_event(fd
, ent
);
2461 strlist__remove(namelist
, ent
);
2464 ent
= strlist__find(namelist
, buf
);
2466 ret
= __del_trace_probe_event(fd
, ent
);
2468 strlist__remove(namelist
, ent
);
2475 int del_perf_probe_events(struct strlist
*dellist
)
2477 int ret
= -1, ufd
= -1, kfd
= -1;
2479 const char *group
, *event
;
2481 struct str_node
*ent
;
2482 struct strlist
*namelist
= NULL
, *unamelist
= NULL
;
2484 /* Get current event names */
2485 kfd
= open_kprobe_events(true);
2487 namelist
= get_probe_trace_event_names(kfd
, true);
2489 ufd
= open_uprobe_events(true);
2491 unamelist
= get_probe_trace_event_names(ufd
, true);
2493 if (kfd
< 0 && ufd
< 0) {
2494 print_both_open_warning(kfd
, ufd
);
2498 if (namelist
== NULL
&& unamelist
== NULL
)
2501 strlist__for_each(ent
, dellist
) {
2502 str
= strdup(ent
->s
);
2507 pr_debug("Parsing: %s\n", str
);
2508 p
= strchr(str
, ':');
2518 ret
= e_snprintf(buf
, 128, "%s:%s", group
, event
);
2520 pr_err("Failed to copy event.");
2525 pr_debug("Group: %s, Event: %s\n", group
, event
);
2528 ret
= del_trace_probe_event(kfd
, buf
, namelist
);
2530 if (unamelist
&& ret
!= 0)
2531 ret
= del_trace_probe_event(ufd
, buf
, unamelist
);
2534 pr_info("Info: Event \"%s\" does not exist.\n", buf
);
2541 strlist__delete(namelist
);
2546 strlist__delete(unamelist
);
2553 /* TODO: don't use a global variable for filter ... */
2554 static struct strfilter
*available_func_filter
;
2557 * If a symbol corresponds to a function with global binding and
2558 * matches filter return 0. For all others return 1.
2560 static int filter_available_functions(struct map
*map __maybe_unused
,
2563 if ((sym
->binding
== STB_GLOBAL
|| sym
->binding
== STB_LOCAL
) &&
2564 strfilter__compare(available_func_filter
, sym
->name
))
2569 int show_available_funcs(const char *target
, struct strfilter
*_filter
,
2575 ret
= init_symbol_maps(user
);
2579 /* Get a symbol map */
2581 map
= dso__new_map(target
);
2583 map
= kernel_get_module_map(target
);
2585 pr_err("Failed to get a map for %s\n", (target
) ? : "kernel");
2589 /* Load symbols with given filter */
2590 available_func_filter
= _filter
;
2591 if (map__load(map
, filter_available_functions
)) {
2592 pr_err("Failed to load symbols in %s\n", (target
) ? : "kernel");
2595 if (!dso__sorted_by_name(map
->dso
, map
->type
))
2596 dso__sort_by_name(map
->dso
, map
->type
);
2598 /* Show all (filtered) symbols */
2600 dso__fprintf_symbols_by_name(map
->dso
, map
->type
, stdout
);
2603 dso__delete(map
->dso
);