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;
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
)
263 const char *path
= module
;
265 if (!module
|| !strchr(module
, '/')) {
266 path
= kernel_get_module_path(module
);
268 pr_err("Failed to find path of %s module.\n",
273 return debuginfo__new(path
);
276 static int get_text_start_address(const char *exec
, unsigned long *address
)
281 int fd
, ret
= -ENOENT
;
283 fd
= open(exec
, O_RDONLY
);
287 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
291 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
294 if (!elf_section_by_name(elf
, &ehdr
, &shdr
, ".text", NULL
))
297 *address
= shdr
.sh_addr
- shdr
.sh_offset
;
305 * Convert trace point to probe point with debuginfo
307 static int find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp
,
308 struct perf_probe_point
*pp
,
311 struct debuginfo
*dinfo
= NULL
;
312 unsigned long stext
= 0;
313 u64 addr
= tp
->address
;
316 /* convert the address to dwarf address */
322 ret
= get_text_start_address(tp
->module
, &stext
);
327 addr
= kernel_get_symbol_address_by_name(tp
->symbol
, false);
333 pr_debug("try to find information at %" PRIx64
" in %s\n", addr
,
334 tp
->module
? : "kernel");
336 dinfo
= open_debuginfo(tp
->module
);
338 ret
= debuginfo__find_probe_point(dinfo
,
339 (unsigned long)addr
, pp
);
340 debuginfo__delete(dinfo
);
342 pr_debug("Failed to open debuginfo at 0x%" PRIx64
"\n", addr
);
347 pp
->retprobe
= tp
->retprobe
;
351 pr_debug("Failed to find corresponding probes from debuginfo.\n");
352 return ret
? : -ENOENT
;
355 static int add_exec_to_probe_trace_events(struct probe_trace_event
*tevs
,
356 int ntevs
, const char *exec
)
359 unsigned long stext
= 0;
364 ret
= get_text_start_address(exec
, &stext
);
368 for (i
= 0; i
< ntevs
&& ret
>= 0; i
++) {
369 /* point.address is the addres of point.symbol + point.offset */
370 tevs
[i
].point
.address
-= stext
;
371 tevs
[i
].point
.module
= strdup(exec
);
372 if (!tevs
[i
].point
.module
) {
376 tevs
[i
].uprobes
= true;
382 static int add_module_to_probe_trace_events(struct probe_trace_event
*tevs
,
383 int ntevs
, const char *module
)
391 tmp
= strrchr(module
, '/');
393 /* This is a module path -- get the module name */
394 module
= strdup(tmp
+ 1);
397 tmp
= strchr(module
, '.');
400 tmp
= (char *)module
; /* For free() */
403 for (i
= 0; i
< ntevs
; i
++) {
404 tevs
[i
].point
.module
= strdup(module
);
405 if (!tevs
[i
].point
.module
) {
415 /* Post processing the probe events */
416 static int post_process_probe_trace_events(struct probe_trace_event
*tevs
,
417 int ntevs
, const char *module
,
420 struct ref_reloc_sym
*reloc_sym
;
425 return add_exec_to_probe_trace_events(tevs
, ntevs
, module
);
427 /* Note that currently ref_reloc_sym based probe is not for drivers */
429 return add_module_to_probe_trace_events(tevs
, ntevs
, module
);
431 reloc_sym
= kernel_get_ref_reloc_sym();
433 pr_warning("Relocated base symbol is not found!\n");
437 for (i
= 0; i
< ntevs
; i
++) {
438 if (tevs
[i
].point
.address
) {
439 tmp
= strdup(reloc_sym
->name
);
442 free(tevs
[i
].point
.symbol
);
443 tevs
[i
].point
.symbol
= tmp
;
444 tevs
[i
].point
.offset
= tevs
[i
].point
.address
-
445 reloc_sym
->unrelocated_addr
;
451 /* Try to find perf_probe_event with debuginfo */
452 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
453 struct probe_trace_event
**tevs
,
454 int max_tevs
, const char *target
)
456 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
457 struct debuginfo
*dinfo
;
460 dinfo
= open_debuginfo(target
);
464 pr_warning("Failed to open debuginfo file.\n");
467 pr_debug("Could not open debuginfo. Try to use symbols.\n");
471 pr_debug("Try to find probe point from debuginfo.\n");
472 /* Searching trace events corresponding to a probe event */
473 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
, max_tevs
);
475 debuginfo__delete(dinfo
);
477 if (ntevs
> 0) { /* Succeeded to find trace events */
478 pr_debug("Found %d probe_trace_events.\n", ntevs
);
479 ret
= post_process_probe_trace_events(*tevs
, ntevs
,
480 target
, pev
->uprobes
);
482 clear_probe_trace_events(*tevs
, ntevs
);
485 return ret
< 0 ? ret
: ntevs
;
488 if (ntevs
== 0) { /* No error but failed to find probe point. */
489 pr_warning("Probe point '%s' not found.\n",
490 synthesize_perf_probe_point(&pev
->point
));
493 /* Error path : ntevs < 0 */
494 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
495 if (ntevs
== -EBADF
) {
496 pr_warning("Warning: No dwarf info found in the vmlinux - "
497 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
499 pr_debug("Trying to use symbols.\n");
507 * Find a src file from a DWARF tag path. Prepend optional source path prefix
508 * and chop off leading directories that do not exist. Result is passed back as
509 * a newly allocated path on success.
510 * Return 0 if file was found and readable, -errno otherwise.
512 static int get_real_path(const char *raw_path
, const char *comp_dir
,
515 const char *prefix
= symbol_conf
.source_prefix
;
518 if (raw_path
[0] != '/' && comp_dir
)
519 /* If not an absolute path, try to use comp_dir */
522 if (access(raw_path
, R_OK
) == 0) {
523 *new_path
= strdup(raw_path
);
530 *new_path
= malloc((strlen(prefix
) + strlen(raw_path
) + 2));
535 sprintf(*new_path
, "%s/%s", prefix
, raw_path
);
537 if (access(*new_path
, R_OK
) == 0)
540 if (!symbol_conf
.source_prefix
)
541 /* In case of searching comp_dir, don't retry */
549 raw_path
= strchr(++raw_path
, '/');
563 #define LINEBUF_SIZE 256
564 #define NR_ADDITIONAL_LINES 2
566 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
568 char buf
[LINEBUF_SIZE
];
569 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
570 const char *prefix
= NULL
;
573 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
578 prefix
= show_num
? "%7d " : " ";
579 color_fprintf(stdout
, color
, prefix
, l
);
581 color_fprintf(stdout
, color
, "%s", buf
);
583 } while (strchr(buf
, '\n') == NULL
);
588 pr_warning("File read error: %s\n", strerror(errno
));
594 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
596 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
598 pr_warning("Source file is shorter than expected.\n");
604 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
605 #define show_one_line(f,l) _show_one_line(f,l,false,false)
606 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
607 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
610 * Show line-range always requires debuginfo to find source file and
613 static int __show_line_range(struct line_range
*lr
, const char *module
)
617 struct debuginfo
*dinfo
;
622 /* Search a line range */
623 dinfo
= open_debuginfo(module
);
625 pr_warning("Failed to open debuginfo file.\n");
629 ret
= debuginfo__find_line_range(dinfo
, lr
);
630 debuginfo__delete(dinfo
);
632 pr_warning("Specified source line is not found.\n");
634 } else if (ret
< 0) {
635 pr_warning("Debuginfo analysis failed. (%d)\n", ret
);
639 /* Convert source file path */
641 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
642 free(tmp
); /* Free old path */
644 pr_warning("Failed to find source file. (%d)\n", ret
);
651 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
652 lr
->start
- lr
->offset
);
654 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
656 fp
= fopen(lr
->path
, "r");
658 pr_warning("Failed to open %s: %s\n", lr
->path
,
662 /* Skip to starting line number */
663 while (l
< lr
->start
) {
664 ret
= skip_one_line(fp
, l
++);
669 intlist__for_each(ln
, lr
->line_list
) {
670 for (; ln
->i
> l
; l
++) {
671 ret
= show_one_line(fp
, l
- lr
->offset
);
675 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
680 if (lr
->end
== INT_MAX
)
681 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
682 while (l
<= lr
->end
) {
683 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
692 int show_line_range(struct line_range
*lr
, const char *module
)
696 ret
= init_symbol_maps(false);
699 ret
= __show_line_range(lr
, module
);
705 static int show_available_vars_at(struct debuginfo
*dinfo
,
706 struct perf_probe_event
*pev
,
707 int max_vls
, struct strfilter
*_filter
,
712 struct str_node
*node
;
713 struct variable_list
*vls
= NULL
, *vl
;
716 buf
= synthesize_perf_probe_point(&pev
->point
);
719 pr_debug("Searching variables at %s\n", buf
);
721 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
,
724 pr_err("Failed to find variables at %s (%d)\n", buf
, ret
);
727 /* Some variables are found */
728 fprintf(stdout
, "Available variables at %s\n", buf
);
729 for (i
= 0; i
< ret
; i
++) {
732 * A probe point might be converted to
733 * several trace points.
735 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
737 zfree(&vl
->point
.symbol
);
740 strlist__for_each(node
, vl
->vars
) {
741 var
= strchr(node
->s
, '\t') + 1;
742 if (strfilter__compare(_filter
, var
)) {
743 fprintf(stdout
, "\t\t%s\n", node
->s
);
747 strlist__delete(vl
->vars
);
750 fprintf(stdout
, "\t\t(No matched variables)\n");
758 /* Show available variables on given probe point */
759 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
760 int max_vls
, const char *module
,
761 struct strfilter
*_filter
, bool externs
)
764 struct debuginfo
*dinfo
;
766 ret
= init_symbol_maps(false);
770 dinfo
= open_debuginfo(module
);
772 pr_warning("Failed to open debuginfo file.\n");
779 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
780 ret
= show_available_vars_at(dinfo
, &pevs
[i
], max_vls
, _filter
,
783 debuginfo__delete(dinfo
);
789 #else /* !HAVE_DWARF_SUPPORT */
792 find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp __maybe_unused
,
793 struct perf_probe_point
*pp __maybe_unused
,
794 bool is_kprobe __maybe_unused
)
799 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
800 struct probe_trace_event
**tevs __maybe_unused
,
801 int max_tevs __maybe_unused
,
802 const char *target __maybe_unused
)
804 if (perf_probe_event_need_dwarf(pev
)) {
805 pr_warning("Debuginfo-analysis is not supported.\n");
812 int show_line_range(struct line_range
*lr __maybe_unused
,
813 const char *module __maybe_unused
)
815 pr_warning("Debuginfo-analysis is not supported.\n");
819 int show_available_vars(struct perf_probe_event
*pevs __maybe_unused
,
820 int npevs __maybe_unused
, int max_vls __maybe_unused
,
821 const char *module __maybe_unused
,
822 struct strfilter
*filter __maybe_unused
,
823 bool externs __maybe_unused
)
825 pr_warning("Debuginfo-analysis is not supported.\n");
830 void line_range__clear(struct line_range
*lr
)
836 intlist__delete(lr
->line_list
);
837 memset(lr
, 0, sizeof(*lr
));
840 int line_range__init(struct line_range
*lr
)
842 memset(lr
, 0, sizeof(*lr
));
843 lr
->line_list
= intlist__new(NULL
);
850 static int parse_line_num(char **ptr
, int *val
, const char *what
)
852 const char *start
= *ptr
;
855 *val
= strtol(*ptr
, ptr
, 0);
856 if (errno
|| *ptr
== start
) {
857 semantic_error("'%s' is not a valid number.\n", what
);
864 * Stuff 'lr' according to the line range described by 'arg'.
865 * The line range syntax is described by:
867 * SRC[:SLN[+NUM|-ELN]]
868 * FNC[@SRC][:SLN[+NUM|-ELN]]
870 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
872 char *range
, *file
, *name
= strdup(arg
);
881 range
= strchr(name
, ':');
885 err
= parse_line_num(&range
, &lr
->start
, "start line");
889 if (*range
== '+' || *range
== '-') {
890 const char c
= *range
++;
892 err
= parse_line_num(&range
, &lr
->end
, "end line");
897 lr
->end
+= lr
->start
;
899 * Adjust the number of lines here.
900 * If the number of lines == 1, the
901 * the end of line should be equal to
908 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
911 if (lr
->start
> lr
->end
) {
912 semantic_error("Start line must be smaller"
913 " than end line.\n");
916 if (*range
!= '\0') {
917 semantic_error("Tailing with invalid str '%s'.\n", range
);
922 file
= strchr(name
, '@');
925 lr
->file
= strdup(++file
);
926 if (lr
->file
== NULL
) {
931 } else if (strchr(name
, '.'))
942 /* Check the name is good for event/group */
943 static bool check_event_name(const char *name
)
945 if (!isalpha(*name
) && *name
!= '_')
947 while (*++name
!= '\0') {
948 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
954 /* Parse probepoint definition. */
955 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
957 struct perf_probe_point
*pp
= &pev
->point
;
962 * perf probe [EVENT=]SRC[:LN|;PTN]
963 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
965 * TODO:Group name support
968 ptr
= strpbrk(arg
, ";=@+%");
969 if (ptr
&& *ptr
== '=') { /* Event name */
972 if (strchr(arg
, ':')) {
973 semantic_error("Group name is not supported yet.\n");
976 if (!check_event_name(arg
)) {
977 semantic_error("%s is bad for event name -it must "
978 "follow C symbol-naming rule.\n", arg
);
981 pev
->event
= strdup(arg
);
982 if (pev
->event
== NULL
)
988 ptr
= strpbrk(arg
, ";:+@%");
998 /* Check arg is function or file and copy it */
999 if (strchr(tmp
, '.')) /* File */
1004 /* Parse other options */
1008 if (c
== ';') { /* Lazy pattern must be the last part */
1009 pp
->lazy_line
= strdup(arg
);
1010 if (pp
->lazy_line
== NULL
)
1014 ptr
= strpbrk(arg
, ";:+@%");
1020 case ':': /* Line number */
1021 pp
->line
= strtoul(arg
, &tmp
, 0);
1023 semantic_error("There is non-digit char"
1024 " in line number.\n");
1028 case '+': /* Byte offset from a symbol */
1029 pp
->offset
= strtoul(arg
, &tmp
, 0);
1031 semantic_error("There is non-digit character"
1036 case '@': /* File name */
1038 semantic_error("SRC@SRC is not allowed.\n");
1041 pp
->file
= strdup(arg
);
1042 if (pp
->file
== NULL
)
1045 case '%': /* Probe places */
1046 if (strcmp(arg
, "return") == 0) {
1048 } else { /* Others not supported yet */
1049 semantic_error("%%%s is not supported.\n", arg
);
1053 default: /* Buggy case */
1054 pr_err("This program has a bug at %s:%d.\n",
1055 __FILE__
, __LINE__
);
1061 /* Exclusion check */
1062 if (pp
->lazy_line
&& pp
->line
) {
1063 semantic_error("Lazy pattern can't be used with"
1068 if (pp
->lazy_line
&& pp
->offset
) {
1069 semantic_error("Lazy pattern can't be used with offset.\n");
1073 if (pp
->line
&& pp
->offset
) {
1074 semantic_error("Offset can't be used with line number.\n");
1078 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
1079 semantic_error("File always requires line number or "
1084 if (pp
->offset
&& !pp
->function
) {
1085 semantic_error("Offset requires an entry function.\n");
1089 if (pp
->retprobe
&& !pp
->function
) {
1090 semantic_error("Return probe requires an entry function.\n");
1094 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
1095 semantic_error("Offset/Line/Lazy pattern can't be used with "
1100 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1101 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
1106 /* Parse perf-probe event argument */
1107 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
1109 char *tmp
, *goodname
;
1110 struct perf_probe_arg_field
**fieldp
;
1112 pr_debug("parsing arg: %s into ", str
);
1114 tmp
= strchr(str
, '=');
1116 arg
->name
= strndup(str
, tmp
- str
);
1117 if (arg
->name
== NULL
)
1119 pr_debug("name:%s ", arg
->name
);
1123 tmp
= strchr(str
, ':');
1124 if (tmp
) { /* Type setting */
1126 arg
->type
= strdup(tmp
+ 1);
1127 if (arg
->type
== NULL
)
1129 pr_debug("type:%s ", arg
->type
);
1132 tmp
= strpbrk(str
, "-.[");
1133 if (!is_c_varname(str
) || !tmp
) {
1134 /* A variable, register, symbol or special value */
1135 arg
->var
= strdup(str
);
1136 if (arg
->var
== NULL
)
1138 pr_debug("%s\n", arg
->var
);
1142 /* Structure fields or array element */
1143 arg
->var
= strndup(str
, tmp
- str
);
1144 if (arg
->var
== NULL
)
1146 goodname
= arg
->var
;
1147 pr_debug("%s, ", arg
->var
);
1148 fieldp
= &arg
->field
;
1151 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
1152 if (*fieldp
== NULL
)
1154 if (*tmp
== '[') { /* Array */
1156 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
1157 (*fieldp
)->ref
= true;
1158 if (*tmp
!= ']' || tmp
== str
+ 1) {
1159 semantic_error("Array index must be a"
1166 } else { /* Structure */
1169 (*fieldp
)->ref
= false;
1170 } else if (tmp
[1] == '>') {
1172 (*fieldp
)->ref
= true;
1174 semantic_error("Argument parse error: %s\n",
1178 tmp
= strpbrk(str
, "-.[");
1181 (*fieldp
)->name
= strndup(str
, tmp
- str
);
1182 if ((*fieldp
)->name
== NULL
)
1185 goodname
= (*fieldp
)->name
;
1186 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
1187 fieldp
= &(*fieldp
)->next
;
1190 (*fieldp
)->name
= strdup(str
);
1191 if ((*fieldp
)->name
== NULL
)
1194 goodname
= (*fieldp
)->name
;
1195 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
1197 /* If no name is specified, set the last field name (not array index)*/
1199 arg
->name
= strdup(goodname
);
1200 if (arg
->name
== NULL
)
1206 /* Parse perf-probe event command */
1207 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1210 int argc
, i
, ret
= 0;
1212 argv
= argv_split(cmd
, &argc
);
1214 pr_debug("Failed to split arguments.\n");
1217 if (argc
- 1 > MAX_PROBE_ARGS
) {
1218 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1222 /* Parse probe point */
1223 ret
= parse_perf_probe_point(argv
[0], pev
);
1227 /* Copy arguments and ensure return probe has no C argument */
1228 pev
->nargs
= argc
- 1;
1229 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1230 if (pev
->args
== NULL
) {
1234 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1235 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1237 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1238 semantic_error("You can't specify local variable for"
1249 /* Return true if this perf_probe_event requires debuginfo */
1250 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1254 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1257 for (i
= 0; i
< pev
->nargs
; i
++)
1258 if (is_c_varname(pev
->args
[i
].var
))
1264 /* Parse probe_events event into struct probe_point */
1265 static int parse_probe_trace_command(const char *cmd
,
1266 struct probe_trace_event
*tev
)
1268 struct probe_trace_point
*tp
= &tev
->point
;
1271 char *argv0_str
= NULL
, *fmt
, *fmt1_str
, *fmt2_str
, *fmt3_str
;
1275 pr_debug("Parsing probe_events: %s\n", cmd
);
1276 argv
= argv_split(cmd
, &argc
);
1278 pr_debug("Failed to split arguments.\n");
1282 semantic_error("Too few probe arguments.\n");
1287 /* Scan event and group name. */
1288 argv0_str
= strdup(argv
[0]);
1289 if (argv0_str
== NULL
) {
1293 fmt1_str
= strtok_r(argv0_str
, ":", &fmt
);
1294 fmt2_str
= strtok_r(NULL
, "/", &fmt
);
1295 fmt3_str
= strtok_r(NULL
, " \t", &fmt
);
1296 if (fmt1_str
== NULL
|| strlen(fmt1_str
) != 1 || fmt2_str
== NULL
1297 || fmt3_str
== NULL
) {
1298 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1303 tev
->group
= strdup(fmt2_str
);
1304 tev
->event
= strdup(fmt3_str
);
1305 if (tev
->group
== NULL
|| tev
->event
== NULL
) {
1309 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1311 tp
->retprobe
= (pr
== 'r');
1313 /* Scan module name(if there), function name and offset */
1314 p
= strchr(argv
[1], ':');
1316 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1320 fmt1_str
= strtok_r(p
, "+", &fmt
);
1321 if (fmt1_str
[0] == '0') /* only the address started with 0x */
1322 tp
->address
= strtoul(fmt1_str
, NULL
, 0);
1324 /* Only the symbol-based probe has offset */
1325 tp
->symbol
= strdup(fmt1_str
);
1326 if (tp
->symbol
== NULL
) {
1330 fmt2_str
= strtok_r(NULL
, "", &fmt
);
1331 if (fmt2_str
== NULL
)
1334 tp
->offset
= strtoul(fmt2_str
, NULL
, 10);
1337 tev
->nargs
= argc
- 2;
1338 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
1339 if (tev
->args
== NULL
) {
1343 for (i
= 0; i
< tev
->nargs
; i
++) {
1344 p
= strchr(argv
[i
+ 2], '=');
1345 if (p
) /* We don't need which register is assigned. */
1349 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
1350 /* TODO: parse regs and offset */
1351 tev
->args
[i
].value
= strdup(p
);
1352 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1364 /* Compose only probe arg */
1365 int synthesize_perf_probe_arg(struct perf_probe_arg
*pa
, char *buf
, size_t len
)
1367 struct perf_probe_arg_field
*field
= pa
->field
;
1371 if (pa
->name
&& pa
->var
)
1372 ret
= e_snprintf(tmp
, len
, "%s=%s", pa
->name
, pa
->var
);
1374 ret
= e_snprintf(tmp
, len
, "%s", pa
->name
? pa
->name
: pa
->var
);
1381 if (field
->name
[0] == '[')
1382 ret
= e_snprintf(tmp
, len
, "%s", field
->name
);
1384 ret
= e_snprintf(tmp
, len
, "%s%s",
1385 field
->ref
? "->" : ".", field
->name
);
1390 field
= field
->next
;
1394 ret
= e_snprintf(tmp
, len
, ":%s", pa
->type
);
1403 pr_debug("Failed to synthesize perf probe argument: %s\n",
1408 /* Compose only probe point (not argument) */
1409 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1412 char offs
[32] = "", line
[32] = "", file
[32] = "";
1415 buf
= zalloc(MAX_CMDLEN
);
1421 ret
= e_snprintf(offs
, 32, "+%lu", pp
->offset
);
1426 ret
= e_snprintf(line
, 32, ":%d", pp
->line
);
1434 tmp
= strchr(pp
->file
+ len
- 30, '/');
1435 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1437 ret
= e_snprintf(file
, 32, "@%s", tmp
);
1443 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s%s%s%s", pp
->function
,
1444 offs
, pp
->retprobe
? "%return" : "", line
,
1447 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s", file
, line
);
1453 pr_debug("Failed to synthesize perf probe point: %s\n",
1460 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1465 buf
= synthesize_perf_probe_point(&pev
->point
);
1470 for (i
= 0; i
< pev
->nargs
; i
++) {
1471 ret
= e_snprintf(&buf
[len
], MAX_CMDLEN
- len
, " %s",
1484 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1485 char **buf
, size_t *buflen
,
1490 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1496 ret
= e_snprintf(*buf
, *buflen
, "%+ld(", ref
->offset
);
1508 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1509 char *buf
, size_t buflen
)
1511 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1515 /* Argument name or separator */
1517 ret
= e_snprintf(buf
, buflen
, " %s=", arg
->name
);
1519 ret
= e_snprintf(buf
, buflen
, " ");
1525 /* Special case: @XXX */
1526 if (arg
->value
[0] == '@' && arg
->ref
)
1529 /* Dereferencing arguments */
1531 depth
= __synthesize_probe_trace_arg_ref(ref
, &buf
,
1537 /* Print argument value */
1538 if (arg
->value
[0] == '@' && arg
->ref
)
1539 ret
= e_snprintf(buf
, buflen
, "%s%+ld", arg
->value
,
1542 ret
= e_snprintf(buf
, buflen
, "%s", arg
->value
);
1550 ret
= e_snprintf(buf
, buflen
, ")");
1556 /* Print argument type */
1558 ret
= e_snprintf(buf
, buflen
, ":%s", arg
->type
);
1567 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
1569 struct probe_trace_point
*tp
= &tev
->point
;
1573 buf
= zalloc(MAX_CMDLEN
);
1577 len
= e_snprintf(buf
, MAX_CMDLEN
, "%c:%s/%s ", tp
->retprobe
? 'r' : 'p',
1578 tev
->group
, tev
->event
);
1582 /* Uprobes must have tp->address and tp->module */
1583 if (tev
->uprobes
&& (!tp
->address
|| !tp
->module
))
1586 /* Use the tp->address for uprobes */
1588 ret
= e_snprintf(buf
+ len
, MAX_CMDLEN
- len
, "%s:0x%lx",
1589 tp
->module
, tp
->address
);
1591 ret
= e_snprintf(buf
+ len
, MAX_CMDLEN
- len
, "%s%s%s+%lu",
1592 tp
->module
?: "", tp
->module
? ":" : "",
1593 tp
->symbol
, tp
->offset
);
1599 for (i
= 0; i
< tev
->nargs
; i
++) {
1600 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], buf
+ len
,
1613 static int find_perf_probe_point_from_map(struct probe_trace_point
*tp
,
1614 struct perf_probe_point
*pp
,
1617 struct symbol
*sym
= NULL
;
1623 map
= dso__new_map(tp
->module
);
1627 sym
= map__find_symbol(map
, addr
, NULL
);
1629 addr
= kernel_get_symbol_address_by_name(tp
->symbol
, true);
1632 sym
= __find_kernel_function(addr
, &map
);
1638 pp
->retprobe
= tp
->retprobe
;
1639 pp
->offset
= addr
- map
->unmap_ip(map
, sym
->start
);
1640 pp
->function
= strdup(sym
->name
);
1641 ret
= pp
->function
? 0 : -ENOMEM
;
1644 if (map
&& !is_kprobe
) {
1645 dso__delete(map
->dso
);
1652 static int convert_to_perf_probe_point(struct probe_trace_point
*tp
,
1653 struct perf_probe_point
*pp
,
1659 ret
= find_perf_probe_point_from_dwarf(tp
, pp
, is_kprobe
);
1662 ret
= find_perf_probe_point_from_map(tp
, pp
, is_kprobe
);
1666 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1669 pp
->function
= strdup(tp
->symbol
);
1670 pp
->offset
= tp
->offset
;
1671 } else if (!tp
->module
&& !is_kprobe
) {
1672 ret
= e_snprintf(buf
, 128, "0x%" PRIx64
, (u64
)tp
->address
);
1675 pp
->function
= strdup(buf
);
1678 if (pp
->function
== NULL
)
1681 pp
->retprobe
= tp
->retprobe
;
1686 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
1687 struct perf_probe_event
*pev
, bool is_kprobe
)
1692 /* Convert event/group name */
1693 pev
->event
= strdup(tev
->event
);
1694 pev
->group
= strdup(tev
->group
);
1695 if (pev
->event
== NULL
|| pev
->group
== NULL
)
1698 /* Convert trace_point to probe_point */
1699 ret
= convert_to_perf_probe_point(&tev
->point
, &pev
->point
, is_kprobe
);
1703 /* Convert trace_arg to probe_arg */
1704 pev
->nargs
= tev
->nargs
;
1705 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1706 if (pev
->args
== NULL
)
1708 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
1709 if (tev
->args
[i
].name
)
1710 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
1712 ret
= synthesize_probe_trace_arg(&tev
->args
[i
],
1714 pev
->args
[i
].name
= strdup(buf
);
1716 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
1721 clear_perf_probe_event(pev
);
1726 void clear_perf_probe_event(struct perf_probe_event
*pev
)
1728 struct perf_probe_point
*pp
= &pev
->point
;
1729 struct perf_probe_arg_field
*field
, *next
;
1736 free(pp
->lazy_line
);
1738 for (i
= 0; i
< pev
->nargs
; i
++) {
1739 free(pev
->args
[i
].name
);
1740 free(pev
->args
[i
].var
);
1741 free(pev
->args
[i
].type
);
1742 field
= pev
->args
[i
].field
;
1745 zfree(&field
->name
);
1751 memset(pev
, 0, sizeof(*pev
));
1754 static void clear_probe_trace_event(struct probe_trace_event
*tev
)
1756 struct probe_trace_arg_ref
*ref
, *next
;
1761 free(tev
->point
.symbol
);
1762 free(tev
->point
.module
);
1763 for (i
= 0; i
< tev
->nargs
; i
++) {
1764 free(tev
->args
[i
].name
);
1765 free(tev
->args
[i
].value
);
1766 free(tev
->args
[i
].type
);
1767 ref
= tev
->args
[i
].ref
;
1775 memset(tev
, 0, sizeof(*tev
));
1778 static void print_warn_msg(const char *file
, bool is_kprobe
)
1781 if (errno
== ENOENT
) {
1785 config
= "CONFIG_UPROBE_EVENTS";
1787 config
= "CONFIG_KPROBE_EVENTS";
1789 pr_warning("%s file does not exist - please rebuild kernel"
1790 " with %s.\n", file
, config
);
1792 pr_warning("Failed to open %s file: %s\n", file
,
1796 static int open_probe_events(const char *trace_file
, bool readwrite
,
1800 const char *__debugfs
;
1803 __debugfs
= debugfs_find_mountpoint();
1804 if (__debugfs
== NULL
) {
1805 pr_warning("Debugfs is not mounted.\n");
1809 ret
= e_snprintf(buf
, PATH_MAX
, "%s/%s", __debugfs
, trace_file
);
1811 pr_debug("Opening %s write=%d\n", buf
, readwrite
);
1812 if (readwrite
&& !probe_event_dry_run
)
1813 ret
= open(buf
, O_RDWR
, O_APPEND
);
1815 ret
= open(buf
, O_RDONLY
, 0);
1818 print_warn_msg(buf
, is_kprobe
);
1823 static int open_kprobe_events(bool readwrite
)
1825 return open_probe_events("tracing/kprobe_events", readwrite
, true);
1828 static int open_uprobe_events(bool readwrite
)
1830 return open_probe_events("tracing/uprobe_events", readwrite
, false);
1833 /* Get raw string list of current kprobe_events or uprobe_events */
1834 static struct strlist
*get_probe_trace_command_rawlist(int fd
)
1838 char buf
[MAX_CMDLEN
];
1842 sl
= strlist__new(true, NULL
);
1844 fp
= fdopen(dup(fd
), "r");
1846 p
= fgets(buf
, MAX_CMDLEN
, fp
);
1850 idx
= strlen(p
) - 1;
1853 ret
= strlist__add(sl
, buf
);
1855 pr_debug("strlist__add failed: %s\n", strerror(-ret
));
1856 strlist__delete(sl
);
1866 static int show_perf_probe_event(struct perf_probe_event
*pev
,
1873 /* Synthesize only event probe point */
1874 place
= synthesize_perf_probe_point(&pev
->point
);
1878 ret
= e_snprintf(buf
, 128, "%s:%s", pev
->group
, pev
->event
);
1882 printf(" %-20s (on %s", buf
, place
);
1884 printf(" in %s", module
);
1886 if (pev
->nargs
> 0) {
1888 for (i
= 0; i
< pev
->nargs
; i
++) {
1889 ret
= synthesize_perf_probe_arg(&pev
->args
[i
],
1901 static int __show_perf_probe_events(int fd
, bool is_kprobe
)
1904 struct probe_trace_event tev
;
1905 struct perf_probe_event pev
;
1906 struct strlist
*rawlist
;
1907 struct str_node
*ent
;
1909 memset(&tev
, 0, sizeof(tev
));
1910 memset(&pev
, 0, sizeof(pev
));
1912 rawlist
= get_probe_trace_command_rawlist(fd
);
1916 strlist__for_each(ent
, rawlist
) {
1917 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1919 ret
= convert_to_perf_probe_event(&tev
, &pev
,
1922 ret
= show_perf_probe_event(&pev
,
1925 clear_perf_probe_event(&pev
);
1926 clear_probe_trace_event(&tev
);
1930 strlist__delete(rawlist
);
1935 /* List up current perf-probe events */
1936 int show_perf_probe_events(void)
1941 fd
= open_kprobe_events(false);
1946 ret
= init_symbol_maps(false);
1950 ret
= __show_perf_probe_events(fd
, true);
1953 fd
= open_uprobe_events(false);
1955 ret
= __show_perf_probe_events(fd
, false);
1963 /* Get current perf-probe event names */
1964 static struct strlist
*get_probe_trace_event_names(int fd
, bool include_group
)
1967 struct strlist
*sl
, *rawlist
;
1968 struct str_node
*ent
;
1969 struct probe_trace_event tev
;
1972 memset(&tev
, 0, sizeof(tev
));
1973 rawlist
= get_probe_trace_command_rawlist(fd
);
1974 sl
= strlist__new(true, NULL
);
1975 strlist__for_each(ent
, rawlist
) {
1976 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1979 if (include_group
) {
1980 ret
= e_snprintf(buf
, 128, "%s:%s", tev
.group
,
1983 ret
= strlist__add(sl
, buf
);
1985 ret
= strlist__add(sl
, tev
.event
);
1986 clear_probe_trace_event(&tev
);
1990 strlist__delete(rawlist
);
1993 strlist__delete(sl
);
1999 static int write_probe_trace_event(int fd
, struct probe_trace_event
*tev
)
2002 char *buf
= synthesize_probe_trace_command(tev
);
2005 pr_debug("Failed to synthesize probe trace event.\n");
2009 pr_debug("Writing event: %s\n", buf
);
2010 if (!probe_event_dry_run
) {
2011 ret
= write(fd
, buf
, strlen(buf
));
2013 pr_warning("Failed to write event: %s\n",
2020 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
2021 struct strlist
*namelist
, bool allow_suffix
)
2026 ret
= e_snprintf(buf
, len
, "%s", base
);
2028 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
2031 if (!strlist__has_entry(namelist
, buf
))
2034 if (!allow_suffix
) {
2035 pr_warning("Error: event \"%s\" already exists. "
2036 "(Use -f to force duplicates.)\n", base
);
2040 /* Try to add suffix */
2041 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
2042 ret
= e_snprintf(buf
, len
, "%s_%d", base
, i
);
2044 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
2047 if (!strlist__has_entry(namelist
, buf
))
2050 if (i
== MAX_EVENT_INDEX
) {
2051 pr_warning("Too many events are on the same function.\n");
2058 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
2059 struct probe_trace_event
*tevs
,
2060 int ntevs
, bool allow_suffix
)
2063 struct probe_trace_event
*tev
= NULL
;
2065 const char *event
, *group
;
2066 struct strlist
*namelist
;
2069 fd
= open_uprobe_events(true);
2071 fd
= open_kprobe_events(true);
2075 /* Get current event names */
2076 namelist
= get_probe_trace_event_names(fd
, false);
2078 pr_debug("Failed to get current event list.\n");
2083 printf("Added new event%s\n", (ntevs
> 1) ? "s:" : ":");
2084 for (i
= 0; i
< ntevs
; i
++) {
2089 if (pev
->point
.function
)
2090 event
= pev
->point
.function
;
2092 event
= tev
->point
.symbol
;
2096 group
= PERFPROBE_GROUP
;
2098 /* Get an unused new event name */
2099 ret
= get_new_event_name(buf
, 64, event
,
2100 namelist
, allow_suffix
);
2105 tev
->event
= strdup(event
);
2106 tev
->group
= strdup(group
);
2107 if (tev
->event
== NULL
|| tev
->group
== NULL
) {
2111 ret
= write_probe_trace_event(fd
, tev
);
2114 /* Add added event name to namelist */
2115 strlist__add(namelist
, event
);
2117 /* Trick here - save current event/group */
2120 pev
->event
= tev
->event
;
2121 pev
->group
= tev
->group
;
2122 show_perf_probe_event(pev
, tev
->point
.module
);
2123 /* Trick here - restore current event/group */
2124 pev
->event
= (char *)event
;
2125 pev
->group
= (char *)group
;
2128 * Probes after the first probe which comes from same
2129 * user input are always allowed to add suffix, because
2130 * there might be several addresses corresponding to
2133 allow_suffix
= true;
2137 /* Show how to use the event. */
2138 printf("\nYou can now use it in all perf tools, such as:\n\n");
2139 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev
->group
,
2143 strlist__delete(namelist
);
2148 static char *looking_function_name
;
2149 static int num_matched_functions
;
2151 static int probe_function_filter(struct map
*map __maybe_unused
,
2154 if ((sym
->binding
== STB_GLOBAL
|| sym
->binding
== STB_LOCAL
) &&
2155 strcmp(looking_function_name
, sym
->name
) == 0) {
2156 num_matched_functions
++;
2162 #define strdup_or_goto(str, label) \
2163 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2166 * Find probe function addresses from map.
2167 * Return an error or the number of found probe_trace_event
2169 static int find_probe_trace_events_from_map(struct perf_probe_event
*pev
,
2170 struct probe_trace_event
**tevs
,
2171 int max_tevs
, const char *target
)
2173 struct map
*map
= NULL
;
2174 struct kmap
*kmap
= NULL
;
2175 struct ref_reloc_sym
*reloc_sym
= NULL
;
2178 struct probe_trace_event
*tev
;
2179 struct perf_probe_point
*pp
= &pev
->point
;
2180 struct probe_trace_point
*tp
;
2183 /* Init maps of given executable or kernel */
2185 map
= dso__new_map(target
);
2187 map
= kernel_get_module_map(target
);
2194 * Load matched symbols: Since the different local symbols may have
2195 * same name but different addresses, this lists all the symbols.
2197 num_matched_functions
= 0;
2198 looking_function_name
= pp
->function
;
2199 ret
= map__load(map
, probe_function_filter
);
2200 if (ret
|| num_matched_functions
== 0) {
2201 pr_err("Failed to find symbol %s in %s\n", pp
->function
,
2202 target
? : "kernel");
2205 } else if (num_matched_functions
> max_tevs
) {
2206 pr_err("Too many functions matched in %s\n",
2207 target
? : "kernel");
2212 if (!pev
->uprobes
) {
2213 kmap
= map__kmap(map
);
2214 reloc_sym
= kmap
->ref_reloc_sym
;
2216 pr_warning("Relocated base symbol is not found!\n");
2222 /* Setup result trace-probe-events */
2223 *tevs
= zalloc(sizeof(*tev
) * num_matched_functions
);
2230 map__for_each_symbol(map
, sym
, nd
) {
2231 tev
= (*tevs
) + ret
;
2233 if (ret
== num_matched_functions
) {
2234 pr_warning("Too many symbols are listed. Skip it.\n");
2239 if (pp
->offset
> sym
->end
- sym
->start
) {
2240 pr_warning("Offset %ld is bigger than the size of %s\n",
2241 pp
->offset
, sym
->name
);
2245 /* Add one probe point */
2246 tp
->address
= map
->unmap_ip(map
, sym
->start
) + pp
->offset
;
2248 tp
->symbol
= strdup_or_goto(reloc_sym
->name
, nomem_out
);
2249 tp
->offset
= tp
->address
- reloc_sym
->addr
;
2251 tp
->symbol
= strdup_or_goto(sym
->name
, nomem_out
);
2252 tp
->offset
= pp
->offset
;
2254 tp
->retprobe
= pp
->retprobe
;
2256 tev
->point
.module
= strdup_or_goto(target
, nomem_out
);
2257 tev
->uprobes
= pev
->uprobes
;
2258 tev
->nargs
= pev
->nargs
;
2260 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) *
2262 if (tev
->args
== NULL
)
2265 for (i
= 0; i
< tev
->nargs
; i
++) {
2266 if (pev
->args
[i
].name
)
2268 strdup_or_goto(pev
->args
[i
].name
,
2271 tev
->args
[i
].value
= strdup_or_goto(pev
->args
[i
].var
,
2273 if (pev
->args
[i
].type
)
2275 strdup_or_goto(pev
->args
[i
].type
,
2281 if (map
&& pev
->uprobes
) {
2282 /* Only when using uprobe(exec) map needs to be released */
2283 dso__delete(map
->dso
);
2291 clear_probe_trace_events(*tevs
, num_matched_functions
);
2296 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
2297 struct probe_trace_event
**tevs
,
2298 int max_tevs
, const char *target
)
2302 if (pev
->uprobes
&& !pev
->group
) {
2303 /* Replace group name if not given */
2304 ret
= convert_exec_to_group(target
, &pev
->group
);
2306 pr_warning("Failed to make a group name.\n");
2311 /* Convert perf_probe_event with debuginfo */
2312 ret
= try_to_find_probe_trace_events(pev
, tevs
, max_tevs
, target
);
2314 return ret
; /* Found in debuginfo or got an error */
2316 return find_probe_trace_events_from_map(pev
, tevs
, max_tevs
, target
);
2319 struct __event_package
{
2320 struct perf_probe_event
*pev
;
2321 struct probe_trace_event
*tevs
;
2325 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
,
2326 int max_tevs
, const char *target
, bool force_add
)
2329 struct __event_package
*pkgs
;
2332 pkgs
= zalloc(sizeof(struct __event_package
) * npevs
);
2337 ret
= init_symbol_maps(pevs
->uprobes
);
2343 /* Loop 1: convert all events */
2344 for (i
= 0; i
< npevs
; i
++) {
2345 pkgs
[i
].pev
= &pevs
[i
];
2346 /* Convert with or without debuginfo */
2347 ret
= convert_to_probe_trace_events(pkgs
[i
].pev
,
2353 pkgs
[i
].ntevs
= ret
;
2356 /* Loop 2: add all events */
2357 for (i
= 0; i
< npevs
; i
++) {
2358 ret
= __add_probe_trace_events(pkgs
[i
].pev
, pkgs
[i
].tevs
,
2359 pkgs
[i
].ntevs
, force_add
);
2364 /* Loop 3: cleanup and free trace events */
2365 for (i
= 0; i
< npevs
; i
++) {
2366 for (j
= 0; j
< pkgs
[i
].ntevs
; j
++)
2367 clear_probe_trace_event(&pkgs
[i
].tevs
[j
]);
2368 zfree(&pkgs
[i
].tevs
);
2376 static int __del_trace_probe_event(int fd
, struct str_node
*ent
)
2382 /* Convert from perf-probe event to trace-probe event */
2383 ret
= e_snprintf(buf
, 128, "-:%s", ent
->s
);
2387 p
= strchr(buf
+ 2, ':');
2389 pr_debug("Internal error: %s should have ':' but not.\n",
2396 pr_debug("Writing event: %s\n", buf
);
2397 ret
= write(fd
, buf
, strlen(buf
));
2403 printf("Removed event: %s\n", ent
->s
);
2406 pr_warning("Failed to delete event: %s\n", strerror(-ret
));
2410 static int del_trace_probe_event(int fd
, const char *buf
,
2411 struct strlist
*namelist
)
2413 struct str_node
*ent
, *n
;
2416 if (strpbrk(buf
, "*?")) { /* Glob-exp */
2417 strlist__for_each_safe(ent
, n
, namelist
)
2418 if (strglobmatch(ent
->s
, buf
)) {
2419 ret
= __del_trace_probe_event(fd
, ent
);
2422 strlist__remove(namelist
, ent
);
2425 ent
= strlist__find(namelist
, buf
);
2427 ret
= __del_trace_probe_event(fd
, ent
);
2429 strlist__remove(namelist
, ent
);
2436 int del_perf_probe_events(struct strlist
*dellist
)
2438 int ret
= -1, ufd
= -1, kfd
= -1;
2440 const char *group
, *event
;
2442 struct str_node
*ent
;
2443 struct strlist
*namelist
= NULL
, *unamelist
= NULL
;
2445 /* Get current event names */
2446 kfd
= open_kprobe_events(true);
2450 namelist
= get_probe_trace_event_names(kfd
, true);
2451 ufd
= open_uprobe_events(true);
2454 unamelist
= get_probe_trace_event_names(ufd
, true);
2456 if (namelist
== NULL
&& unamelist
== NULL
)
2459 strlist__for_each(ent
, dellist
) {
2460 str
= strdup(ent
->s
);
2465 pr_debug("Parsing: %s\n", str
);
2466 p
= strchr(str
, ':');
2476 ret
= e_snprintf(buf
, 128, "%s:%s", group
, event
);
2478 pr_err("Failed to copy event.");
2483 pr_debug("Group: %s, Event: %s\n", group
, event
);
2486 ret
= del_trace_probe_event(kfd
, buf
, namelist
);
2488 if (unamelist
&& ret
!= 0)
2489 ret
= del_trace_probe_event(ufd
, buf
, unamelist
);
2492 pr_info("Info: Event \"%s\" does not exist.\n", buf
);
2499 strlist__delete(namelist
);
2504 strlist__delete(unamelist
);
2511 /* TODO: don't use a global variable for filter ... */
2512 static struct strfilter
*available_func_filter
;
2515 * If a symbol corresponds to a function with global binding and
2516 * matches filter return 0. For all others return 1.
2518 static int filter_available_functions(struct map
*map __maybe_unused
,
2521 if ((sym
->binding
== STB_GLOBAL
|| sym
->binding
== STB_LOCAL
) &&
2522 strfilter__compare(available_func_filter
, sym
->name
))
2527 int show_available_funcs(const char *target
, struct strfilter
*_filter
,
2533 ret
= init_symbol_maps(user
);
2537 /* Get a symbol map */
2539 map
= dso__new_map(target
);
2541 map
= kernel_get_module_map(target
);
2543 pr_err("Failed to get a map for %s\n", (target
) ? : "kernel");
2547 /* Load symbols with given filter */
2548 available_func_filter
= _filter
;
2549 if (map__load(map
, filter_available_functions
)) {
2550 pr_err("Failed to load symbols in %s\n", (target
) ? : "kernel");
2553 if (!dso__sorted_by_name(map
->dso
, map
->type
))
2554 dso__sort_by_name(map
->dso
, map
->type
);
2556 /* Show all (filtered) symbols */
2558 dso__fprintf_symbols_by_name(map
->dso
, map
->type
, stdout
);
2561 dso__delete(map
->dso
);