2 * probe-event.c : perf-probe definition to probe_events format converter
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <sys/utsname.h>
24 #include <sys/types.h>
39 #include "strfilter.h"
45 #include <api/fs/fs.h>
46 #include "trace-event.h" /* For __maybe_unused */
47 #include "probe-event.h"
48 #include "probe-finder.h"
49 #include "probe-file.h"
53 #include "sane_ctype.h"
55 #define PERFPROBE_GROUP "probe"
57 bool probe_event_dry_run
; /* Dry run flag */
58 struct probe_conf probe_conf
;
60 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
62 int e_snprintf(char *str
, size_t size
, const char *format
, ...)
67 ret
= vsnprintf(str
, size
, format
, ap
);
74 static struct machine
*host_machine
;
76 /* Initialize symbol maps and path of vmlinux/modules */
77 int init_probe_symbol_maps(bool user_only
)
81 symbol_conf
.sort_by_name
= true;
82 symbol_conf
.allow_aliases
= true;
83 ret
= symbol__init(NULL
);
85 pr_debug("Failed to init symbol map.\n");
89 if (host_machine
|| user_only
) /* already initialized */
92 if (symbol_conf
.vmlinux_name
)
93 pr_debug("Use vmlinux: %s\n", symbol_conf
.vmlinux_name
);
95 host_machine
= machine__new_host();
97 pr_debug("machine__new_host() failed.\n");
103 pr_warning("Failed to init vmlinux path.\n");
107 void exit_probe_symbol_maps(void)
109 machine__delete(host_machine
);
114 static struct symbol
*__find_kernel_function_by_name(const char *name
,
117 return machine__find_kernel_function_by_name(host_machine
, name
, mapp
);
120 static struct symbol
*__find_kernel_function(u64 addr
, struct map
**mapp
)
122 return machine__find_kernel_function(host_machine
, addr
, mapp
);
125 static struct ref_reloc_sym
*kernel_get_ref_reloc_sym(void)
127 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
129 struct map
*map
= machine__kernel_map(host_machine
);
131 if (map__load(map
) < 0)
134 kmap
= map__kmap(map
);
137 return kmap
->ref_reloc_sym
;
140 static int kernel_get_symbol_address_by_name(const char *name
, u64
*addr
,
141 bool reloc
, bool reladdr
)
143 struct ref_reloc_sym
*reloc_sym
;
147 /* ref_reloc_sym is just a label. Need a special fix*/
148 reloc_sym
= kernel_get_ref_reloc_sym();
149 if (reloc_sym
&& strcmp(name
, reloc_sym
->name
) == 0)
150 *addr
= (reloc
) ? reloc_sym
->addr
: reloc_sym
->unrelocated_addr
;
152 sym
= __find_kernel_function_by_name(name
, &map
);
155 *addr
= map
->unmap_ip(map
, sym
->start
) -
156 ((reloc
) ? 0 : map
->reloc
) -
157 ((reladdr
) ? map
->start
: 0);
162 static struct map
*kernel_get_module_map(const char *module
)
164 struct map_groups
*grp
= &host_machine
->kmaps
;
165 struct maps
*maps
= &grp
->maps
[MAP__FUNCTION
];
168 /* A file path -- this is an offline module */
169 if (module
&& strchr(module
, '/'))
170 return dso__new_map(module
);
175 for (pos
= maps__first(maps
); pos
; pos
= map__next(pos
)) {
176 /* short_name is "[module]" */
177 if (strncmp(pos
->dso
->short_name
+ 1, module
,
178 pos
->dso
->short_name_len
- 2) == 0 &&
179 module
[pos
->dso
->short_name_len
- 2] == '\0') {
187 struct map
*get_target_map(const char *target
, struct nsinfo
*nsi
, bool user
)
189 /* Init maps of given executable or kernel */
193 map
= dso__new_map(target
);
195 map
->dso
->nsinfo
= nsinfo__get(nsi
);
198 return kernel_get_module_map(target
);
202 static int convert_exec_to_group(const char *exec
, char **result
)
204 char *ptr1
, *ptr2
, *exec_copy
;
208 exec_copy
= strdup(exec
);
212 ptr1
= basename(exec_copy
);
218 for (ptr2
= ptr1
; *ptr2
!= '\0'; ptr2
++) {
219 if (!isalnum(*ptr2
) && *ptr2
!= '_') {
225 ret
= e_snprintf(buf
, 64, "%s_%s", PERFPROBE_GROUP
, ptr1
);
229 *result
= strdup(buf
);
230 ret
= *result
? 0 : -ENOMEM
;
237 static void clear_perf_probe_point(struct perf_probe_point
*pp
)
244 static void clear_probe_trace_events(struct probe_trace_event
*tevs
, int ntevs
)
248 for (i
= 0; i
< ntevs
; i
++)
249 clear_probe_trace_event(tevs
+ i
);
252 static bool kprobe_blacklist__listed(unsigned long address
);
253 static bool kprobe_warn_out_range(const char *symbol
, unsigned long address
)
258 /* Get the address of _etext for checking non-probable text symbol */
259 ret
= kernel_get_symbol_address_by_name("_etext", &etext_addr
,
262 if (ret
== 0 && etext_addr
< address
)
263 pr_warning("%s is out of .text, skip it.\n", symbol
);
264 else if (kprobe_blacklist__listed(address
))
265 pr_warning("%s is blacklisted function, skip it.\n", symbol
);
273 * @module can be module name of module file path. In case of path,
274 * inspect elf and find out what is actual module name.
275 * Caller has to free mod_name after using it.
277 static char *find_module_name(const char *module
)
285 char *mod_name
= NULL
;
288 fd
= open(module
, O_RDONLY
);
292 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
296 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
299 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
,
300 ".gnu.linkonce.this_module", NULL
);
304 data
= elf_getdata(sec
, NULL
);
305 if (!data
|| !data
->d_buf
)
310 * '.gnu.linkonce.this_module' section of kernel module elf directly
311 * maps to 'struct module' from linux/module.h. This section contains
312 * actual module name which will be used by kernel after loading it.
313 * But, we cannot use 'struct module' here since linux/module.h is not
314 * exposed to user-space. Offset of 'name' has remained same from long
315 * time, so hardcoding it here.
317 if (ehdr
.e_ident
[EI_CLASS
] == ELFCLASS32
)
319 else /* expect ELFCLASS64 by default */
322 mod_name
= strdup((char *)data
->d_buf
+ name_offset
);
331 #ifdef HAVE_DWARF_SUPPORT
333 static int kernel_get_module_dso(const char *module
, struct dso
**pdso
)
337 const char *vmlinux_name
;
341 char module_name
[128];
343 snprintf(module_name
, sizeof(module_name
), "[%s]", module
);
344 map
= map_groups__find_by_name(&host_machine
->kmaps
, MAP__FUNCTION
, module_name
);
349 pr_debug("Failed to find module %s.\n", module
);
353 map
= machine__kernel_map(host_machine
);
356 vmlinux_name
= symbol_conf
.vmlinux_name
;
359 ret
= dso__load_vmlinux(dso
, map
, vmlinux_name
, false);
361 ret
= dso__load_vmlinux_path(dso
, map
);
368 * Some binaries like glibc have special symbols which are on the symbol
369 * table, but not in the debuginfo. If we can find the address of the
370 * symbol from map, we can translate the address back to the probe point.
372 static int find_alternative_probe_point(struct debuginfo
*dinfo
,
373 struct perf_probe_point
*pp
,
374 struct perf_probe_point
*result
,
375 const char *target
, struct nsinfo
*nsi
,
378 struct map
*map
= NULL
;
383 /* This can work only for function-name based one */
384 if (!pp
->function
|| pp
->file
)
387 map
= get_target_map(target
, nsi
, uprobes
);
391 /* Find the address of given function */
392 map__for_each_symbol_by_name(map
, pp
->function
, sym
) {
394 address
= sym
->start
;
396 address
= map
->unmap_ip(map
, sym
->start
) - map
->reloc
;
403 pr_debug("Symbol %s address found : %" PRIx64
"\n",
404 pp
->function
, address
);
406 ret
= debuginfo__find_probe_point(dinfo
, (unsigned long)address
,
409 ret
= (!ret
) ? -ENOENT
: ret
;
411 result
->offset
+= pp
->offset
;
412 result
->line
+= pp
->line
;
413 result
->retprobe
= pp
->retprobe
;
423 static int get_alternative_probe_event(struct debuginfo
*dinfo
,
424 struct perf_probe_event
*pev
,
425 struct perf_probe_point
*tmp
)
429 memcpy(tmp
, &pev
->point
, sizeof(*tmp
));
430 memset(&pev
->point
, 0, sizeof(pev
->point
));
431 ret
= find_alternative_probe_point(dinfo
, tmp
, &pev
->point
, pev
->target
,
432 pev
->nsi
, pev
->uprobes
);
434 memcpy(&pev
->point
, tmp
, sizeof(*tmp
));
439 static int get_alternative_line_range(struct debuginfo
*dinfo
,
440 struct line_range
*lr
,
441 const char *target
, bool user
)
443 struct perf_probe_point pp
= { .function
= lr
->function
,
446 struct perf_probe_point result
;
449 memset(&result
, 0, sizeof(result
));
451 if (lr
->end
!= INT_MAX
)
452 len
= lr
->end
- lr
->start
;
453 ret
= find_alternative_probe_point(dinfo
, &pp
, &result
,
456 lr
->function
= result
.function
;
457 lr
->file
= result
.file
;
458 lr
->start
= result
.line
;
459 if (lr
->end
!= INT_MAX
)
460 lr
->end
= lr
->start
+ len
;
461 clear_perf_probe_point(&pp
);
466 /* Open new debuginfo of given module */
467 static struct debuginfo
*open_debuginfo(const char *module
, struct nsinfo
*nsi
,
470 const char *path
= module
;
471 char reason
[STRERR_BUFSIZE
];
472 struct debuginfo
*ret
= NULL
;
473 struct dso
*dso
= NULL
;
477 if (!module
|| !strchr(module
, '/')) {
478 err
= kernel_get_module_dso(module
, &dso
);
480 if (!dso
|| dso
->load_errno
== 0) {
481 if (!str_error_r(-err
, reason
, STRERR_BUFSIZE
))
482 strcpy(reason
, "(unknown)");
484 dso__strerror_load(dso
, reason
, STRERR_BUFSIZE
);
486 pr_err("Failed to find the path for %s: %s\n",
487 module
?: "kernel", reason
);
490 path
= dso
->long_name
;
492 nsinfo__mountns_enter(nsi
, &nsc
);
493 ret
= debuginfo__new(path
);
494 if (!ret
&& !silent
) {
495 pr_warning("The %s file has no debug information.\n", path
);
496 if (!module
|| !strtailcmp(path
, ".ko"))
497 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
499 pr_warning("Rebuild with -g, ");
500 pr_warning("or install an appropriate debuginfo package.\n");
502 nsinfo__mountns_exit(&nsc
);
506 /* For caching the last debuginfo */
507 static struct debuginfo
*debuginfo_cache
;
508 static char *debuginfo_cache_path
;
510 static struct debuginfo
*debuginfo_cache__open(const char *module
, bool silent
)
512 const char *path
= module
;
514 /* If the module is NULL, it should be the kernel. */
518 if (debuginfo_cache_path
&& !strcmp(debuginfo_cache_path
, path
))
521 /* Copy module path */
522 free(debuginfo_cache_path
);
523 debuginfo_cache_path
= strdup(path
);
524 if (!debuginfo_cache_path
) {
525 debuginfo__delete(debuginfo_cache
);
526 debuginfo_cache
= NULL
;
530 debuginfo_cache
= open_debuginfo(module
, NULL
, silent
);
531 if (!debuginfo_cache
)
532 zfree(&debuginfo_cache_path
);
534 return debuginfo_cache
;
537 static void debuginfo_cache__exit(void)
539 debuginfo__delete(debuginfo_cache
);
540 debuginfo_cache
= NULL
;
541 zfree(&debuginfo_cache_path
);
545 static int get_text_start_address(const char *exec
, unsigned long *address
,
551 int fd
, ret
= -ENOENT
;
554 nsinfo__mountns_enter(nsi
, &nsc
);
555 fd
= open(exec
, O_RDONLY
);
556 nsinfo__mountns_exit(&nsc
);
560 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
566 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
569 if (!elf_section_by_name(elf
, &ehdr
, &shdr
, ".text", NULL
))
572 *address
= shdr
.sh_addr
- shdr
.sh_offset
;
583 * Convert trace point to probe point with debuginfo
585 static int find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp
,
586 struct perf_probe_point
*pp
,
589 struct debuginfo
*dinfo
= NULL
;
590 unsigned long stext
= 0;
591 u64 addr
= tp
->address
;
594 /* convert the address to dwarf address */
600 ret
= get_text_start_address(tp
->module
, &stext
, NULL
);
604 } else if (tp
->symbol
) {
605 /* If the module is given, this returns relative address */
606 ret
= kernel_get_symbol_address_by_name(tp
->symbol
, &addr
,
607 false, !!tp
->module
);
613 pr_debug("try to find information at %" PRIx64
" in %s\n", addr
,
614 tp
->module
? : "kernel");
616 dinfo
= debuginfo_cache__open(tp
->module
, verbose
<= 0);
618 ret
= debuginfo__find_probe_point(dinfo
,
619 (unsigned long)addr
, pp
);
624 pp
->retprobe
= tp
->retprobe
;
628 pr_debug("Failed to find corresponding probes from debuginfo.\n");
629 return ret
? : -ENOENT
;
632 /* Adjust symbol name and address */
633 static int post_process_probe_trace_point(struct probe_trace_point
*tp
,
634 struct map
*map
, unsigned long offs
)
637 u64 addr
= tp
->address
- offs
;
639 sym
= map__find_symbol(map
, addr
);
643 if (strcmp(sym
->name
, tp
->symbol
)) {
644 /* If we have no realname, use symbol for it */
646 tp
->realname
= tp
->symbol
;
649 tp
->symbol
= strdup(sym
->name
);
653 tp
->offset
= addr
- sym
->start
;
660 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
661 * and generate new symbols with suffixes such as .constprop.N or .isra.N
662 * etc. Since those symbols are not recorded in DWARF, we have to find
663 * correct generated symbols from offline ELF binary.
664 * For online kernel or uprobes we don't need this because those are
665 * rebased on _text, or already a section relative address.
668 post_process_offline_probe_trace_events(struct probe_trace_event
*tevs
,
669 int ntevs
, const char *pathname
)
672 unsigned long stext
= 0;
675 /* Prepare a map for offline binary */
676 map
= dso__new_map(pathname
);
677 if (!map
|| get_text_start_address(pathname
, &stext
, NULL
) < 0) {
678 pr_warning("Failed to get ELF symbols for %s\n", pathname
);
682 for (i
= 0; i
< ntevs
; i
++) {
683 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
693 static int add_exec_to_probe_trace_events(struct probe_trace_event
*tevs
,
694 int ntevs
, const char *exec
,
698 unsigned long stext
= 0;
703 ret
= get_text_start_address(exec
, &stext
, nsi
);
707 for (i
= 0; i
< ntevs
&& ret
>= 0; i
++) {
708 /* point.address is the addres of point.symbol + point.offset */
709 tevs
[i
].point
.address
-= stext
;
710 tevs
[i
].point
.module
= strdup(exec
);
711 if (!tevs
[i
].point
.module
) {
715 tevs
[i
].uprobes
= true;
722 post_process_module_probe_trace_events(struct probe_trace_event
*tevs
,
723 int ntevs
, const char *module
,
724 struct debuginfo
*dinfo
)
726 Dwarf_Addr text_offs
= 0;
728 char *mod_name
= NULL
;
734 map
= get_target_map(module
, NULL
, false);
735 if (!map
|| debuginfo__get_text_offset(dinfo
, &text_offs
, true) < 0) {
736 pr_warning("Failed to get ELF symbols for %s\n", module
);
740 mod_name
= find_module_name(module
);
741 for (i
= 0; i
< ntevs
; i
++) {
742 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
743 map
, (unsigned long)text_offs
);
746 tevs
[i
].point
.module
=
747 strdup(mod_name
? mod_name
: module
);
748 if (!tevs
[i
].point
.module
) {
761 post_process_kernel_probe_trace_events(struct probe_trace_event
*tevs
,
764 struct ref_reloc_sym
*reloc_sym
;
768 /* Skip post process if the target is an offline kernel */
769 if (symbol_conf
.ignore_vmlinux_buildid
)
770 return post_process_offline_probe_trace_events(tevs
, ntevs
,
771 symbol_conf
.vmlinux_name
);
773 reloc_sym
= kernel_get_ref_reloc_sym();
775 pr_warning("Relocated base symbol is not found!\n");
779 for (i
= 0; i
< ntevs
; i
++) {
780 if (!tevs
[i
].point
.address
)
782 if (tevs
[i
].point
.retprobe
&& !kretprobe_offset_is_supported())
784 /* If we found a wrong one, mark it by NULL symbol */
785 if (kprobe_warn_out_range(tevs
[i
].point
.symbol
,
786 tevs
[i
].point
.address
)) {
790 tmp
= strdup(reloc_sym
->name
);
794 /* If we have no realname, use symbol for it */
795 if (!tevs
[i
].point
.realname
)
796 tevs
[i
].point
.realname
= tevs
[i
].point
.symbol
;
798 free(tevs
[i
].point
.symbol
);
799 tevs
[i
].point
.symbol
= tmp
;
800 tevs
[i
].point
.offset
= tevs
[i
].point
.address
-
801 reloc_sym
->unrelocated_addr
;
807 arch__post_process_probe_trace_events(struct perf_probe_event
*pev __maybe_unused
,
808 int ntevs __maybe_unused
)
812 /* Post processing the probe events */
813 static int post_process_probe_trace_events(struct perf_probe_event
*pev
,
814 struct probe_trace_event
*tevs
,
815 int ntevs
, const char *module
,
816 bool uprobe
, struct debuginfo
*dinfo
)
821 ret
= add_exec_to_probe_trace_events(tevs
, ntevs
, module
,
824 /* Currently ref_reloc_sym based probe is not for drivers */
825 ret
= post_process_module_probe_trace_events(tevs
, ntevs
,
828 ret
= post_process_kernel_probe_trace_events(tevs
, ntevs
);
831 arch__post_process_probe_trace_events(pev
, ntevs
);
836 /* Try to find perf_probe_event with debuginfo */
837 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
838 struct probe_trace_event
**tevs
)
840 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
841 struct perf_probe_point tmp
;
842 struct debuginfo
*dinfo
;
845 dinfo
= open_debuginfo(pev
->target
, pev
->nsi
, !need_dwarf
);
849 pr_debug("Could not open debuginfo. Try to use symbols.\n");
853 pr_debug("Try to find probe point from debuginfo.\n");
854 /* Searching trace events corresponding to a probe event */
855 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
857 if (ntevs
== 0) { /* Not found, retry with an alternative */
858 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
860 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
862 * Write back to the original probe_event for
863 * setting appropriate (user given) event name
865 clear_perf_probe_point(&pev
->point
);
866 memcpy(&pev
->point
, &tmp
, sizeof(tmp
));
870 if (ntevs
> 0) { /* Succeeded to find trace events */
871 pr_debug("Found %d probe_trace_events.\n", ntevs
);
872 ret
= post_process_probe_trace_events(pev
, *tevs
, ntevs
,
873 pev
->target
, pev
->uprobes
, dinfo
);
874 if (ret
< 0 || ret
== ntevs
) {
875 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret
);
876 clear_probe_trace_events(*tevs
, ntevs
);
882 debuginfo__delete(dinfo
);
884 if (ntevs
== 0) { /* No error but failed to find probe point. */
885 pr_warning("Probe point '%s' not found.\n",
886 synthesize_perf_probe_point(&pev
->point
));
888 } else if (ntevs
< 0) {
889 /* Error path : ntevs < 0 */
890 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
892 pr_warning("Warning: No dwarf info found in the vmlinux - "
893 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
895 pr_debug("Trying to use symbols.\n");
902 #define LINEBUF_SIZE 256
903 #define NR_ADDITIONAL_LINES 2
905 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
907 char buf
[LINEBUF_SIZE
], sbuf
[STRERR_BUFSIZE
];
908 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
909 const char *prefix
= NULL
;
912 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
917 prefix
= show_num
? "%7d " : " ";
918 color_fprintf(stdout
, color
, prefix
, l
);
920 color_fprintf(stdout
, color
, "%s", buf
);
922 } while (strchr(buf
, '\n') == NULL
);
927 pr_warning("File read error: %s\n",
928 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
934 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
936 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
938 pr_warning("Source file is shorter than expected.\n");
944 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
945 #define show_one_line(f,l) _show_one_line(f,l,false,false)
946 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
947 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
950 * Show line-range always requires debuginfo to find source file and
953 static int __show_line_range(struct line_range
*lr
, const char *module
,
958 struct debuginfo
*dinfo
;
962 char sbuf
[STRERR_BUFSIZE
];
964 /* Search a line range */
965 dinfo
= open_debuginfo(module
, NULL
, false);
969 ret
= debuginfo__find_line_range(dinfo
, lr
);
970 if (!ret
) { /* Not found, retry with an alternative */
971 ret
= get_alternative_line_range(dinfo
, lr
, module
, user
);
973 ret
= debuginfo__find_line_range(dinfo
, lr
);
975 debuginfo__delete(dinfo
);
976 if (ret
== 0 || ret
== -ENOENT
) {
977 pr_warning("Specified source line is not found.\n");
979 } else if (ret
< 0) {
980 pr_warning("Debuginfo analysis failed.\n");
984 /* Convert source file path */
986 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
988 /* Free old path when new path is assigned */
993 pr_warning("Failed to find source file path.\n");
1000 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
1001 lr
->start
- lr
->offset
);
1003 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
1005 fp
= fopen(lr
->path
, "r");
1007 pr_warning("Failed to open %s: %s\n", lr
->path
,
1008 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
1011 /* Skip to starting line number */
1012 while (l
< lr
->start
) {
1013 ret
= skip_one_line(fp
, l
++);
1018 intlist__for_each_entry(ln
, lr
->line_list
) {
1019 for (; ln
->i
> l
; l
++) {
1020 ret
= show_one_line(fp
, l
- lr
->offset
);
1024 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
1029 if (lr
->end
== INT_MAX
)
1030 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
1031 while (l
<= lr
->end
) {
1032 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
1041 int show_line_range(struct line_range
*lr
, const char *module
,
1042 struct nsinfo
*nsi
, bool user
)
1045 struct nscookie nsc
;
1047 ret
= init_probe_symbol_maps(user
);
1050 nsinfo__mountns_enter(nsi
, &nsc
);
1051 ret
= __show_line_range(lr
, module
, user
);
1052 nsinfo__mountns_exit(&nsc
);
1053 exit_probe_symbol_maps();
1058 static int show_available_vars_at(struct debuginfo
*dinfo
,
1059 struct perf_probe_event
*pev
,
1060 struct strfilter
*_filter
)
1064 struct str_node
*node
;
1065 struct variable_list
*vls
= NULL
, *vl
;
1066 struct perf_probe_point tmp
;
1069 buf
= synthesize_perf_probe_point(&pev
->point
);
1072 pr_debug("Searching variables at %s\n", buf
);
1074 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
);
1075 if (!ret
) { /* Not found, retry with an alternative */
1076 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
1078 ret
= debuginfo__find_available_vars_at(dinfo
, pev
,
1080 /* Release the old probe_point */
1081 clear_perf_probe_point(&tmp
);
1085 if (ret
== 0 || ret
== -ENOENT
) {
1086 pr_err("Failed to find the address of %s\n", buf
);
1089 pr_warning("Debuginfo analysis failed.\n");
1093 /* Some variables are found */
1094 fprintf(stdout
, "Available variables at %s\n", buf
);
1095 for (i
= 0; i
< ret
; i
++) {
1098 * A probe point might be converted to
1099 * several trace points.
1101 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
1103 zfree(&vl
->point
.symbol
);
1106 strlist__for_each_entry(node
, vl
->vars
) {
1107 var
= strchr(node
->s
, '\t') + 1;
1108 if (strfilter__compare(_filter
, var
)) {
1109 fprintf(stdout
, "\t\t%s\n", node
->s
);
1113 strlist__delete(vl
->vars
);
1116 fprintf(stdout
, "\t\t(No matched variables)\n");
1124 /* Show available variables on given probe point */
1125 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
1126 struct strfilter
*_filter
)
1129 struct debuginfo
*dinfo
;
1131 ret
= init_probe_symbol_maps(pevs
->uprobes
);
1135 dinfo
= open_debuginfo(pevs
->target
, pevs
->nsi
, false);
1143 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
1144 ret
= show_available_vars_at(dinfo
, &pevs
[i
], _filter
);
1146 debuginfo__delete(dinfo
);
1148 exit_probe_symbol_maps();
1152 #else /* !HAVE_DWARF_SUPPORT */
1154 static void debuginfo_cache__exit(void)
1159 find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp __maybe_unused
,
1160 struct perf_probe_point
*pp __maybe_unused
,
1161 bool is_kprobe __maybe_unused
)
1166 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
1167 struct probe_trace_event
**tevs __maybe_unused
)
1169 if (perf_probe_event_need_dwarf(pev
)) {
1170 pr_warning("Debuginfo-analysis is not supported.\n");
1177 int show_line_range(struct line_range
*lr __maybe_unused
,
1178 const char *module __maybe_unused
,
1179 struct nsinfo
*nsi __maybe_unused
,
1180 bool user __maybe_unused
)
1182 pr_warning("Debuginfo-analysis is not supported.\n");
1186 int show_available_vars(struct perf_probe_event
*pevs __maybe_unused
,
1187 int npevs __maybe_unused
,
1188 struct strfilter
*filter __maybe_unused
)
1190 pr_warning("Debuginfo-analysis is not supported.\n");
1195 void line_range__clear(struct line_range
*lr
)
1201 intlist__delete(lr
->line_list
);
1202 memset(lr
, 0, sizeof(*lr
));
1205 int line_range__init(struct line_range
*lr
)
1207 memset(lr
, 0, sizeof(*lr
));
1208 lr
->line_list
= intlist__new(NULL
);
1215 static int parse_line_num(char **ptr
, int *val
, const char *what
)
1217 const char *start
= *ptr
;
1220 *val
= strtol(*ptr
, ptr
, 0);
1221 if (errno
|| *ptr
== start
) {
1222 semantic_error("'%s' is not a valid number.\n", what
);
1228 /* Check the name is good for event, group or function */
1229 static bool is_c_func_name(const char *name
)
1231 if (!isalpha(*name
) && *name
!= '_')
1233 while (*++name
!= '\0') {
1234 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
1241 * Stuff 'lr' according to the line range described by 'arg'.
1242 * The line range syntax is described by:
1244 * SRC[:SLN[+NUM|-ELN]]
1245 * FNC[@SRC][:SLN[+NUM|-ELN]]
1247 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
1249 char *range
, *file
, *name
= strdup(arg
);
1258 range
= strchr(name
, ':');
1262 err
= parse_line_num(&range
, &lr
->start
, "start line");
1266 if (*range
== '+' || *range
== '-') {
1267 const char c
= *range
++;
1269 err
= parse_line_num(&range
, &lr
->end
, "end line");
1274 lr
->end
+= lr
->start
;
1276 * Adjust the number of lines here.
1277 * If the number of lines == 1, the
1278 * the end of line should be equal to
1279 * the start of line.
1285 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
1288 if (lr
->start
> lr
->end
) {
1289 semantic_error("Start line must be smaller"
1290 " than end line.\n");
1293 if (*range
!= '\0') {
1294 semantic_error("Tailing with invalid str '%s'.\n", range
);
1299 file
= strchr(name
, '@');
1302 lr
->file
= strdup(++file
);
1303 if (lr
->file
== NULL
) {
1307 lr
->function
= name
;
1308 } else if (strchr(name
, '/') || strchr(name
, '.'))
1310 else if (is_c_func_name(name
))/* We reuse it for checking funcname */
1311 lr
->function
= name
;
1312 else { /* Invalid name */
1313 semantic_error("'%s' is not a valid function name.\n", name
);
1324 static int parse_perf_probe_event_name(char **arg
, struct perf_probe_event
*pev
)
1328 ptr
= strpbrk_esc(*arg
, ":");
1331 if (!pev
->sdt
&& !is_c_func_name(*arg
))
1333 pev
->group
= strdup_esc(*arg
);
1340 pev
->event
= strdup_esc(*arg
);
1341 if (pev
->event
== NULL
)
1344 if (!pev
->sdt
&& !is_c_func_name(pev
->event
)) {
1348 semantic_error("%s is bad for event name -it must "
1349 "follow C symbol-naming rule.\n", *arg
);
1355 /* Parse probepoint definition. */
1356 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
1358 struct perf_probe_point
*pp
= &pev
->point
;
1361 bool file_spec
= false;
1366 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1367 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1368 * perf probe %[GRP:]SDT_EVENT
1373 if (is_sdt_event(arg
)) {
1379 ptr
= strpbrk_esc(arg
, ";=@+%");
1383 semantic_error("%s must be an SDT name.\n",
1387 /* This must be a target file name or build id */
1388 tmp
= build_id_cache__complement(ptr
+ 1);
1390 pev
->target
= build_id_cache__origname(tmp
);
1393 pev
->target
= strdup_esc(ptr
+ 1);
1398 ret
= parse_perf_probe_event_name(&arg
, pev
);
1400 if (asprintf(&pev
->point
.function
, "%%%s", pev
->event
) < 0)
1406 if (ptr
&& *ptr
== '=') { /* Event name */
1409 ret
= parse_perf_probe_event_name(&arg
, pev
);
1417 * Check arg is function or file name and copy it.
1419 * We consider arg to be a file spec if and only if it satisfies
1420 * all of the below criteria::
1421 * - it does not include any of "+@%",
1422 * - it includes one of ":;", and
1423 * - it has a period '.' in the name.
1425 * Otherwise, we consider arg to be a function specification.
1427 if (!strpbrk_esc(arg
, "+@%")) {
1428 ptr
= strpbrk_esc(arg
, ";:");
1429 /* This is a file spec if it includes a '.' before ; or : */
1430 if (ptr
&& memchr(arg
, '.', ptr
- arg
))
1434 ptr
= strpbrk_esc(arg
, ";:+@%");
1443 tmp
= strdup_esc(arg
);
1454 * Keep pp->function even if this is absolute address,
1455 * so it can mark whether abs_address is valid.
1456 * Which make 'perf probe lib.bin 0x0' possible.
1458 * Note that checking length of tmp is not needed
1459 * because when we access tmp[1] we know tmp[0] is '0',
1460 * so tmp[1] should always valid (but could be '\0').
1462 if (tmp
&& !strncmp(tmp
, "0x", 2)) {
1463 pp
->abs_address
= strtoul(pp
->function
, &tmp
, 0);
1465 semantic_error("Invalid absolute address.\n");
1471 /* Parse other options */
1475 if (c
== ';') { /* Lazy pattern must be the last part */
1476 pp
->lazy_line
= strdup(arg
); /* let leave escapes */
1477 if (pp
->lazy_line
== NULL
)
1481 ptr
= strpbrk_esc(arg
, ";:+@%");
1487 case ':': /* Line number */
1488 pp
->line
= strtoul(arg
, &tmp
, 0);
1490 semantic_error("There is non-digit char"
1491 " in line number.\n");
1495 case '+': /* Byte offset from a symbol */
1496 pp
->offset
= strtoul(arg
, &tmp
, 0);
1498 semantic_error("There is non-digit character"
1503 case '@': /* File name */
1505 semantic_error("SRC@SRC is not allowed.\n");
1508 pp
->file
= strdup_esc(arg
);
1509 if (pp
->file
== NULL
)
1512 case '%': /* Probe places */
1513 if (strcmp(arg
, "return") == 0) {
1515 } else { /* Others not supported yet */
1516 semantic_error("%%%s is not supported.\n", arg
);
1520 default: /* Buggy case */
1521 pr_err("This program has a bug at %s:%d.\n",
1522 __FILE__
, __LINE__
);
1528 /* Exclusion check */
1529 if (pp
->lazy_line
&& pp
->line
) {
1530 semantic_error("Lazy pattern can't be used with"
1535 if (pp
->lazy_line
&& pp
->offset
) {
1536 semantic_error("Lazy pattern can't be used with offset.\n");
1540 if (pp
->line
&& pp
->offset
) {
1541 semantic_error("Offset can't be used with line number.\n");
1545 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
1546 semantic_error("File always requires line number or "
1551 if (pp
->offset
&& !pp
->function
) {
1552 semantic_error("Offset requires an entry function.\n");
1556 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
1557 semantic_error("Offset/Line/Lazy pattern can't be used with "
1562 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1563 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
1568 /* Parse perf-probe event argument */
1569 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
1571 char *tmp
, *goodname
;
1572 struct perf_probe_arg_field
**fieldp
;
1574 pr_debug("parsing arg: %s into ", str
);
1576 tmp
= strchr(str
, '=');
1578 arg
->name
= strndup(str
, tmp
- str
);
1579 if (arg
->name
== NULL
)
1581 pr_debug("name:%s ", arg
->name
);
1585 tmp
= strchr(str
, ':');
1586 if (tmp
) { /* Type setting */
1588 arg
->type
= strdup(tmp
+ 1);
1589 if (arg
->type
== NULL
)
1591 pr_debug("type:%s ", arg
->type
);
1594 tmp
= strpbrk(str
, "-.[");
1595 if (!is_c_varname(str
) || !tmp
) {
1596 /* A variable, register, symbol or special value */
1597 arg
->var
= strdup(str
);
1598 if (arg
->var
== NULL
)
1600 pr_debug("%s\n", arg
->var
);
1604 /* Structure fields or array element */
1605 arg
->var
= strndup(str
, tmp
- str
);
1606 if (arg
->var
== NULL
)
1608 goodname
= arg
->var
;
1609 pr_debug("%s, ", arg
->var
);
1610 fieldp
= &arg
->field
;
1613 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
1614 if (*fieldp
== NULL
)
1616 if (*tmp
== '[') { /* Array */
1618 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
1619 (*fieldp
)->ref
= true;
1620 if (*tmp
!= ']' || tmp
== str
+ 1) {
1621 semantic_error("Array index must be a"
1628 } else { /* Structure */
1631 (*fieldp
)->ref
= false;
1632 } else if (tmp
[1] == '>') {
1634 (*fieldp
)->ref
= true;
1636 semantic_error("Argument parse error: %s\n",
1640 tmp
= strpbrk(str
, "-.[");
1643 (*fieldp
)->name
= strndup(str
, tmp
- str
);
1644 if ((*fieldp
)->name
== NULL
)
1647 goodname
= (*fieldp
)->name
;
1648 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
1649 fieldp
= &(*fieldp
)->next
;
1652 (*fieldp
)->name
= strdup(str
);
1653 if ((*fieldp
)->name
== NULL
)
1656 goodname
= (*fieldp
)->name
;
1657 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
1659 /* If no name is specified, set the last field name (not array index)*/
1661 arg
->name
= strdup(goodname
);
1662 if (arg
->name
== NULL
)
1668 /* Parse perf-probe event command */
1669 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1672 int argc
, i
, ret
= 0;
1674 argv
= argv_split(cmd
, &argc
);
1676 pr_debug("Failed to split arguments.\n");
1679 if (argc
- 1 > MAX_PROBE_ARGS
) {
1680 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1684 /* Parse probe point */
1685 ret
= parse_perf_probe_point(argv
[0], pev
);
1689 /* Copy arguments and ensure return probe has no C argument */
1690 pev
->nargs
= argc
- 1;
1691 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1692 if (pev
->args
== NULL
) {
1696 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1697 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1699 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1700 semantic_error("You can't specify local variable for"
1711 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1712 bool perf_probe_with_var(struct perf_probe_event
*pev
)
1716 for (i
= 0; i
< pev
->nargs
; i
++)
1717 if (is_c_varname(pev
->args
[i
].var
) ||
1718 !strcmp(pev
->args
[i
].var
, PROBE_ARG_PARAMS
) ||
1719 !strcmp(pev
->args
[i
].var
, PROBE_ARG_VARS
))
1724 /* Return true if this perf_probe_event requires debuginfo */
1725 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1727 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1730 if (perf_probe_with_var(pev
))
1736 /* Parse probe_events event into struct probe_point */
1737 int parse_probe_trace_command(const char *cmd
, struct probe_trace_event
*tev
)
1739 struct probe_trace_point
*tp
= &tev
->point
;
1742 char *argv0_str
= NULL
, *fmt
, *fmt1_str
, *fmt2_str
, *fmt3_str
;
1746 pr_debug("Parsing probe_events: %s\n", cmd
);
1747 argv
= argv_split(cmd
, &argc
);
1749 pr_debug("Failed to split arguments.\n");
1753 semantic_error("Too few probe arguments.\n");
1758 /* Scan event and group name. */
1759 argv0_str
= strdup(argv
[0]);
1760 if (argv0_str
== NULL
) {
1764 fmt1_str
= strtok_r(argv0_str
, ":", &fmt
);
1765 fmt2_str
= strtok_r(NULL
, "/", &fmt
);
1766 fmt3_str
= strtok_r(NULL
, " \t", &fmt
);
1767 if (fmt1_str
== NULL
|| strlen(fmt1_str
) != 1 || fmt2_str
== NULL
1768 || fmt3_str
== NULL
) {
1769 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1774 tev
->group
= strdup(fmt2_str
);
1775 tev
->event
= strdup(fmt3_str
);
1776 if (tev
->group
== NULL
|| tev
->event
== NULL
) {
1780 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1782 tp
->retprobe
= (pr
== 'r');
1784 /* Scan module name(if there), function name and offset */
1785 p
= strchr(argv
[1], ':');
1787 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1792 tev
->uprobes
= (tp
->module
[0] == '/');
1796 fmt1_str
= strtok_r(p
, "+", &fmt
);
1797 /* only the address started with 0x */
1798 if (fmt1_str
[0] == '0') {
1800 * Fix a special case:
1801 * if address == 0, kernel reports something like:
1802 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1803 * Newer kernel may fix that, but we want to
1804 * support old kernel also.
1806 if (strcmp(fmt1_str
, "0x") == 0) {
1807 if (!argv
[2] || strcmp(argv
[2], "(null)")) {
1814 for (i
= 2; argv
[i
+ 1] != NULL
; i
++)
1815 argv
[i
] = argv
[i
+ 1];
1820 tp
->address
= strtoul(fmt1_str
, NULL
, 0);
1822 /* Only the symbol-based probe has offset */
1823 tp
->symbol
= strdup(fmt1_str
);
1824 if (tp
->symbol
== NULL
) {
1828 fmt2_str
= strtok_r(NULL
, "", &fmt
);
1829 if (fmt2_str
== NULL
)
1832 tp
->offset
= strtoul(fmt2_str
, NULL
, 10);
1835 tev
->nargs
= argc
- 2;
1836 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
1837 if (tev
->args
== NULL
) {
1841 for (i
= 0; i
< tev
->nargs
; i
++) {
1842 p
= strchr(argv
[i
+ 2], '=');
1843 if (p
) /* We don't need which register is assigned. */
1847 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
1848 /* TODO: parse regs and offset */
1849 tev
->args
[i
].value
= strdup(p
);
1850 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1862 /* Compose only probe arg */
1863 char *synthesize_perf_probe_arg(struct perf_probe_arg
*pa
)
1865 struct perf_probe_arg_field
*field
= pa
->field
;
1870 if (strbuf_init(&buf
, 64) < 0)
1873 if (pa
->name
&& pa
->var
)
1874 err
= strbuf_addf(&buf
, "%s=%s", pa
->name
, pa
->var
);
1876 err
= strbuf_addstr(&buf
, pa
->name
?: pa
->var
);
1881 if (field
->name
[0] == '[')
1882 err
= strbuf_addstr(&buf
, field
->name
);
1884 err
= strbuf_addf(&buf
, "%s%s", field
->ref
? "->" : ".",
1886 field
= field
->next
;
1892 if (strbuf_addf(&buf
, ":%s", pa
->type
) < 0)
1895 ret
= strbuf_detach(&buf
, NULL
);
1897 strbuf_release(&buf
);
1901 /* Compose only probe point (not argument) */
1902 char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1905 char *tmp
, *ret
= NULL
;
1908 if (strbuf_init(&buf
, 64) < 0)
1912 if (strbuf_addstr(&buf
, pp
->function
) < 0)
1915 err
= strbuf_addf(&buf
, "+%lu", pp
->offset
);
1917 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
1918 else if (pp
->retprobe
)
1919 err
= strbuf_addstr(&buf
, "%return");
1927 tmp
= strchr(pp
->file
+ len
- 30, '/');
1928 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1930 err
= strbuf_addf(&buf
, "@%s", tmp
);
1931 if (!err
&& !pp
->function
&& pp
->line
)
1932 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
1935 ret
= strbuf_detach(&buf
, NULL
);
1937 strbuf_release(&buf
);
1941 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1944 char *tmp
, *ret
= NULL
;
1947 if (strbuf_init(&buf
, 64))
1950 if (strbuf_addf(&buf
, "%s:%s=", pev
->group
?: PERFPROBE_GROUP
,
1954 tmp
= synthesize_perf_probe_point(&pev
->point
);
1955 if (!tmp
|| strbuf_addstr(&buf
, tmp
) < 0)
1959 for (i
= 0; i
< pev
->nargs
; i
++) {
1960 tmp
= synthesize_perf_probe_arg(pev
->args
+ i
);
1961 if (!tmp
|| strbuf_addf(&buf
, " %s", tmp
) < 0)
1966 ret
= strbuf_detach(&buf
, NULL
);
1968 strbuf_release(&buf
);
1972 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1973 struct strbuf
*buf
, int depth
)
1977 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1982 err
= strbuf_addf(buf
, "%+ld(", ref
->offset
);
1983 return (err
< 0) ? err
: depth
;
1986 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1989 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1992 /* Argument name or separator */
1994 err
= strbuf_addf(buf
, " %s=", arg
->name
);
1996 err
= strbuf_addch(buf
, ' ');
2000 /* Special case: @XXX */
2001 if (arg
->value
[0] == '@' && arg
->ref
)
2004 /* Dereferencing arguments */
2006 depth
= __synthesize_probe_trace_arg_ref(ref
, buf
, 1);
2011 /* Print argument value */
2012 if (arg
->value
[0] == '@' && arg
->ref
)
2013 err
= strbuf_addf(buf
, "%s%+ld", arg
->value
, arg
->ref
->offset
);
2015 err
= strbuf_addstr(buf
, arg
->value
);
2018 while (!err
&& depth
--)
2019 err
= strbuf_addch(buf
, ')');
2021 /* Print argument type */
2022 if (!err
&& arg
->type
)
2023 err
= strbuf_addf(buf
, ":%s", arg
->type
);
2028 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
2030 struct probe_trace_point
*tp
= &tev
->point
;
2035 /* Uprobes must have tp->module */
2036 if (tev
->uprobes
&& !tp
->module
)
2039 if (strbuf_init(&buf
, 32) < 0)
2042 if (strbuf_addf(&buf
, "%c:%s/%s ", tp
->retprobe
? 'r' : 'p',
2043 tev
->group
, tev
->event
) < 0)
2046 * If tp->address == 0, then this point must be a
2047 * absolute address uprobe.
2048 * try_to_find_absolute_address() should have made
2049 * tp->symbol to "0x0".
2051 if (tev
->uprobes
&& !tp
->address
) {
2052 if (!tp
->symbol
|| strcmp(tp
->symbol
, "0x0"))
2056 /* Use the tp->address for uprobes */
2058 err
= strbuf_addf(&buf
, "%s:0x%lx", tp
->module
, tp
->address
);
2059 else if (!strncmp(tp
->symbol
, "0x", 2))
2060 /* Absolute address. See try_to_find_absolute_address() */
2061 err
= strbuf_addf(&buf
, "%s%s0x%lx", tp
->module
?: "",
2062 tp
->module
? ":" : "", tp
->address
);
2064 err
= strbuf_addf(&buf
, "%s%s%s+%lu", tp
->module
?: "",
2065 tp
->module
? ":" : "", tp
->symbol
, tp
->offset
);
2069 for (i
= 0; i
< tev
->nargs
; i
++)
2070 if (synthesize_probe_trace_arg(&tev
->args
[i
], &buf
) < 0)
2073 ret
= strbuf_detach(&buf
, NULL
);
2075 strbuf_release(&buf
);
2079 static int find_perf_probe_point_from_map(struct probe_trace_point
*tp
,
2080 struct perf_probe_point
*pp
,
2083 struct symbol
*sym
= NULL
;
2084 struct map
*map
= NULL
;
2085 u64 addr
= tp
->address
;
2089 map
= dso__new_map(tp
->module
);
2092 sym
= map__find_symbol(map
, addr
);
2094 if (tp
->symbol
&& !addr
) {
2095 if (kernel_get_symbol_address_by_name(tp
->symbol
,
2096 &addr
, true, false) < 0)
2101 sym
= __find_kernel_function(addr
, &map
);
2108 pp
->retprobe
= tp
->retprobe
;
2109 pp
->offset
= addr
- map
->unmap_ip(map
, sym
->start
);
2110 pp
->function
= strdup(sym
->name
);
2111 ret
= pp
->function
? 0 : -ENOMEM
;
2114 if (map
&& !is_kprobe
) {
2121 static int convert_to_perf_probe_point(struct probe_trace_point
*tp
,
2122 struct perf_probe_point
*pp
,
2128 ret
= find_perf_probe_point_from_dwarf(tp
, pp
, is_kprobe
);
2131 ret
= find_perf_probe_point_from_map(tp
, pp
, is_kprobe
);
2135 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2138 pp
->function
= strdup(tp
->symbol
);
2139 pp
->offset
= tp
->offset
;
2141 ret
= e_snprintf(buf
, 128, "0x%" PRIx64
, (u64
)tp
->address
);
2144 pp
->function
= strdup(buf
);
2147 if (pp
->function
== NULL
)
2150 pp
->retprobe
= tp
->retprobe
;
2155 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
2156 struct perf_probe_event
*pev
, bool is_kprobe
)
2158 struct strbuf buf
= STRBUF_INIT
;
2161 /* Convert event/group name */
2162 pev
->event
= strdup(tev
->event
);
2163 pev
->group
= strdup(tev
->group
);
2164 if (pev
->event
== NULL
|| pev
->group
== NULL
)
2167 /* Convert trace_point to probe_point */
2168 ret
= convert_to_perf_probe_point(&tev
->point
, &pev
->point
, is_kprobe
);
2172 /* Convert trace_arg to probe_arg */
2173 pev
->nargs
= tev
->nargs
;
2174 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
2175 if (pev
->args
== NULL
)
2177 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
2178 if (tev
->args
[i
].name
)
2179 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
2181 if ((ret
= strbuf_init(&buf
, 32)) < 0)
2183 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], &buf
);
2184 pev
->args
[i
].name
= strbuf_detach(&buf
, NULL
);
2186 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
2191 clear_perf_probe_event(pev
);
2196 void clear_perf_probe_event(struct perf_probe_event
*pev
)
2198 struct perf_probe_arg_field
*field
, *next
;
2204 clear_perf_probe_point(&pev
->point
);
2206 for (i
= 0; i
< pev
->nargs
; i
++) {
2207 free(pev
->args
[i
].name
);
2208 free(pev
->args
[i
].var
);
2209 free(pev
->args
[i
].type
);
2210 field
= pev
->args
[i
].field
;
2213 zfree(&field
->name
);
2219 memset(pev
, 0, sizeof(*pev
));
2222 #define strdup_or_goto(str, label) \
2223 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2225 static int perf_probe_point__copy(struct perf_probe_point
*dst
,
2226 struct perf_probe_point
*src
)
2228 dst
->file
= strdup_or_goto(src
->file
, out_err
);
2229 dst
->function
= strdup_or_goto(src
->function
, out_err
);
2230 dst
->lazy_line
= strdup_or_goto(src
->lazy_line
, out_err
);
2231 dst
->line
= src
->line
;
2232 dst
->retprobe
= src
->retprobe
;
2233 dst
->offset
= src
->offset
;
2237 clear_perf_probe_point(dst
);
2241 static int perf_probe_arg__copy(struct perf_probe_arg
*dst
,
2242 struct perf_probe_arg
*src
)
2244 struct perf_probe_arg_field
*field
, **ppfield
;
2246 dst
->name
= strdup_or_goto(src
->name
, out_err
);
2247 dst
->var
= strdup_or_goto(src
->var
, out_err
);
2248 dst
->type
= strdup_or_goto(src
->type
, out_err
);
2251 ppfield
= &(dst
->field
);
2253 *ppfield
= zalloc(sizeof(*field
));
2256 (*ppfield
)->name
= strdup_or_goto(field
->name
, out_err
);
2257 (*ppfield
)->index
= field
->index
;
2258 (*ppfield
)->ref
= field
->ref
;
2259 field
= field
->next
;
2260 ppfield
= &((*ppfield
)->next
);
2267 int perf_probe_event__copy(struct perf_probe_event
*dst
,
2268 struct perf_probe_event
*src
)
2272 dst
->event
= strdup_or_goto(src
->event
, out_err
);
2273 dst
->group
= strdup_or_goto(src
->group
, out_err
);
2274 dst
->target
= strdup_or_goto(src
->target
, out_err
);
2275 dst
->uprobes
= src
->uprobes
;
2277 if (perf_probe_point__copy(&dst
->point
, &src
->point
) < 0)
2280 dst
->args
= zalloc(sizeof(struct perf_probe_arg
) * src
->nargs
);
2283 dst
->nargs
= src
->nargs
;
2285 for (i
= 0; i
< src
->nargs
; i
++)
2286 if (perf_probe_arg__copy(&dst
->args
[i
], &src
->args
[i
]) < 0)
2291 clear_perf_probe_event(dst
);
2295 void clear_probe_trace_event(struct probe_trace_event
*tev
)
2297 struct probe_trace_arg_ref
*ref
, *next
;
2302 free(tev
->point
.symbol
);
2303 free(tev
->point
.realname
);
2304 free(tev
->point
.module
);
2305 for (i
= 0; i
< tev
->nargs
; i
++) {
2306 free(tev
->args
[i
].name
);
2307 free(tev
->args
[i
].value
);
2308 free(tev
->args
[i
].type
);
2309 ref
= tev
->args
[i
].ref
;
2317 memset(tev
, 0, sizeof(*tev
));
2320 struct kprobe_blacklist_node
{
2321 struct list_head list
;
2322 unsigned long start
;
2327 static void kprobe_blacklist__delete(struct list_head
*blacklist
)
2329 struct kprobe_blacklist_node
*node
;
2331 while (!list_empty(blacklist
)) {
2332 node
= list_first_entry(blacklist
,
2333 struct kprobe_blacklist_node
, list
);
2334 list_del(&node
->list
);
2340 static int kprobe_blacklist__load(struct list_head
*blacklist
)
2342 struct kprobe_blacklist_node
*node
;
2343 const char *__debugfs
= debugfs__mountpoint();
2344 char buf
[PATH_MAX
], *p
;
2348 if (__debugfs
== NULL
)
2351 ret
= e_snprintf(buf
, PATH_MAX
, "%s/kprobes/blacklist", __debugfs
);
2355 fp
= fopen(buf
, "r");
2360 while (fgets(buf
, PATH_MAX
, fp
)) {
2361 node
= zalloc(sizeof(*node
));
2366 INIT_LIST_HEAD(&node
->list
);
2367 list_add_tail(&node
->list
, blacklist
);
2368 if (sscanf(buf
, "0x%lx-0x%lx", &node
->start
, &node
->end
) != 2) {
2372 p
= strchr(buf
, '\t');
2375 if (p
[strlen(p
) - 1] == '\n')
2376 p
[strlen(p
) - 1] = '\0';
2378 p
= (char *)"unknown";
2379 node
->symbol
= strdup(p
);
2380 if (!node
->symbol
) {
2384 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2385 node
->start
, node
->end
, node
->symbol
);
2389 kprobe_blacklist__delete(blacklist
);
2395 static struct kprobe_blacklist_node
*
2396 kprobe_blacklist__find_by_address(struct list_head
*blacklist
,
2397 unsigned long address
)
2399 struct kprobe_blacklist_node
*node
;
2401 list_for_each_entry(node
, blacklist
, list
) {
2402 if (node
->start
<= address
&& address
< node
->end
)
2409 static LIST_HEAD(kprobe_blacklist
);
2411 static void kprobe_blacklist__init(void)
2413 if (!list_empty(&kprobe_blacklist
))
2416 if (kprobe_blacklist__load(&kprobe_blacklist
) < 0)
2417 pr_debug("No kprobe blacklist support, ignored\n");
2420 static void kprobe_blacklist__release(void)
2422 kprobe_blacklist__delete(&kprobe_blacklist
);
2425 static bool kprobe_blacklist__listed(unsigned long address
)
2427 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist
, address
);
2430 static int perf_probe_event__sprintf(const char *group
, const char *event
,
2431 struct perf_probe_event
*pev
,
2433 struct strbuf
*result
)
2438 if (asprintf(&buf
, "%s:%s", group
, event
) < 0)
2440 ret
= strbuf_addf(result
, " %-20s (on ", buf
);
2445 /* Synthesize only event probe point */
2446 buf
= synthesize_perf_probe_point(&pev
->point
);
2449 ret
= strbuf_addstr(result
, buf
);
2453 ret
= strbuf_addf(result
, " in %s", module
);
2455 if (!ret
&& pev
->nargs
> 0) {
2456 ret
= strbuf_add(result
, " with", 5);
2457 for (i
= 0; !ret
&& i
< pev
->nargs
; i
++) {
2458 buf
= synthesize_perf_probe_arg(&pev
->args
[i
]);
2461 ret
= strbuf_addf(result
, " %s", buf
);
2466 ret
= strbuf_addch(result
, ')');
2472 int show_perf_probe_event(const char *group
, const char *event
,
2473 struct perf_probe_event
*pev
,
2474 const char *module
, bool use_stdout
)
2476 struct strbuf buf
= STRBUF_INIT
;
2479 ret
= perf_probe_event__sprintf(group
, event
, pev
, module
, &buf
);
2482 printf("%s\n", buf
.buf
);
2484 pr_info("%s\n", buf
.buf
);
2486 strbuf_release(&buf
);
2491 static bool filter_probe_trace_event(struct probe_trace_event
*tev
,
2492 struct strfilter
*filter
)
2496 /* At first, check the event name itself */
2497 if (strfilter__compare(filter
, tev
->event
))
2500 /* Next, check the combination of name and group */
2501 if (e_snprintf(tmp
, 128, "%s:%s", tev
->group
, tev
->event
) < 0)
2503 return strfilter__compare(filter
, tmp
);
2506 static int __show_perf_probe_events(int fd
, bool is_kprobe
,
2507 struct strfilter
*filter
)
2510 struct probe_trace_event tev
;
2511 struct perf_probe_event pev
;
2512 struct strlist
*rawlist
;
2513 struct str_node
*ent
;
2515 memset(&tev
, 0, sizeof(tev
));
2516 memset(&pev
, 0, sizeof(pev
));
2518 rawlist
= probe_file__get_rawlist(fd
);
2522 strlist__for_each_entry(ent
, rawlist
) {
2523 ret
= parse_probe_trace_command(ent
->s
, &tev
);
2525 if (!filter_probe_trace_event(&tev
, filter
))
2527 ret
= convert_to_perf_probe_event(&tev
, &pev
,
2531 ret
= show_perf_probe_event(pev
.group
, pev
.event
,
2532 &pev
, tev
.point
.module
,
2536 clear_perf_probe_event(&pev
);
2537 clear_probe_trace_event(&tev
);
2541 strlist__delete(rawlist
);
2542 /* Cleanup cached debuginfo if needed */
2543 debuginfo_cache__exit();
2548 /* List up current perf-probe events */
2549 int show_perf_probe_events(struct strfilter
*filter
)
2551 int kp_fd
, up_fd
, ret
;
2555 if (probe_conf
.cache
)
2556 return probe_cache__show_all_caches(filter
);
2558 ret
= init_probe_symbol_maps(false);
2562 ret
= probe_file__open_both(&kp_fd
, &up_fd
, 0);
2567 ret
= __show_perf_probe_events(kp_fd
, true, filter
);
2568 if (up_fd
>= 0 && ret
>= 0)
2569 ret
= __show_perf_probe_events(up_fd
, false, filter
);
2574 exit_probe_symbol_maps();
2579 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
2580 struct strlist
*namelist
, bool ret_event
,
2588 nbase
= strdup(base
);
2592 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2593 p
= strpbrk(nbase
, ".@");
2594 if (p
&& p
!= nbase
)
2597 /* Try no suffix number */
2598 ret
= e_snprintf(buf
, len
, "%s%s", nbase
, ret_event
? "__return" : "");
2600 pr_debug("snprintf() failed: %d\n", ret
);
2603 if (!strlist__has_entry(namelist
, buf
))
2606 if (!allow_suffix
) {
2607 pr_warning("Error: event \"%s\" already exists.\n"
2608 " Hint: Remove existing event by 'perf probe -d'\n"
2609 " or force duplicates by 'perf probe -f'\n"
2610 " or set 'force=yes' in BPF source.\n",
2616 /* Try to add suffix */
2617 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
2618 ret
= e_snprintf(buf
, len
, "%s_%d", nbase
, i
);
2620 pr_debug("snprintf() failed: %d\n", ret
);
2623 if (!strlist__has_entry(namelist
, buf
))
2626 if (i
== MAX_EVENT_INDEX
) {
2627 pr_warning("Too many events are on the same function.\n");
2634 /* Final validation */
2635 if (ret
>= 0 && !is_c_func_name(buf
)) {
2636 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2644 /* Warn if the current kernel's uprobe implementation is old */
2645 static void warn_uprobe_event_compat(struct probe_trace_event
*tev
)
2648 char *buf
= synthesize_probe_trace_command(tev
);
2650 /* Old uprobe event doesn't support memory dereference */
2651 if (!tev
->uprobes
|| tev
->nargs
== 0 || !buf
)
2654 for (i
= 0; i
< tev
->nargs
; i
++)
2655 if (strglobmatch(tev
->args
[i
].value
, "[$@+-]*")) {
2656 pr_warning("Please upgrade your kernel to at least "
2657 "3.14 to have access to feature %s\n",
2658 tev
->args
[i
].value
);
2665 /* Set new name from original perf_probe_event and namelist */
2666 static int probe_trace_event__set_name(struct probe_trace_event
*tev
,
2667 struct perf_probe_event
*pev
,
2668 struct strlist
*namelist
,
2671 const char *event
, *group
;
2675 /* If probe_event or trace_event already have the name, reuse it */
2676 if (pev
->event
&& !pev
->sdt
)
2678 else if (tev
->event
)
2681 /* Or generate new one from probe point */
2682 if (pev
->point
.function
&&
2683 (strncmp(pev
->point
.function
, "0x", 2) != 0) &&
2684 !strisglob(pev
->point
.function
))
2685 event
= pev
->point
.function
;
2687 event
= tev
->point
.realname
;
2689 if (pev
->group
&& !pev
->sdt
)
2691 else if (tev
->group
)
2694 group
= PERFPROBE_GROUP
;
2696 /* Get an unused new event name */
2697 ret
= get_new_event_name(buf
, 64, event
, namelist
,
2698 tev
->point
.retprobe
, allow_suffix
);
2704 tev
->event
= strdup(event
);
2705 tev
->group
= strdup(group
);
2706 if (tev
->event
== NULL
|| tev
->group
== NULL
)
2709 /* Add added event name to namelist */
2710 strlist__add(namelist
, event
);
2714 static int __open_probe_file_and_namelist(bool uprobe
,
2715 struct strlist
**namelist
)
2719 fd
= probe_file__open(PF_FL_RW
| (uprobe
? PF_FL_UPROBE
: 0));
2723 /* Get current event names */
2724 *namelist
= probe_file__get_namelist(fd
);
2726 pr_debug("Failed to get current event list.\n");
2733 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
2734 struct probe_trace_event
*tevs
,
2735 int ntevs
, bool allow_suffix
)
2737 int i
, fd
[2] = {-1, -1}, up
, ret
;
2738 struct probe_trace_event
*tev
= NULL
;
2739 struct probe_cache
*cache
= NULL
;
2740 struct strlist
*namelist
[2] = {NULL
, NULL
};
2741 struct nscookie nsc
;
2743 up
= pev
->uprobes
? 1 : 0;
2744 fd
[up
] = __open_probe_file_and_namelist(up
, &namelist
[up
]);
2749 for (i
= 0; i
< ntevs
; i
++) {
2751 up
= tev
->uprobes
? 1 : 0;
2752 if (fd
[up
] == -1) { /* Open the kprobe/uprobe_events */
2753 fd
[up
] = __open_probe_file_and_namelist(up
,
2758 /* Skip if the symbol is out of .text or blacklisted */
2759 if (!tev
->point
.symbol
&& !pev
->uprobes
)
2762 /* Set new name for tev (and update namelist) */
2763 ret
= probe_trace_event__set_name(tev
, pev
, namelist
[up
],
2768 nsinfo__mountns_enter(pev
->nsi
, &nsc
);
2769 ret
= probe_file__add_event(fd
[up
], tev
);
2770 nsinfo__mountns_exit(&nsc
);
2775 * Probes after the first probe which comes from same
2776 * user input are always allowed to add suffix, because
2777 * there might be several addresses corresponding to
2780 allow_suffix
= true;
2782 if (ret
== -EINVAL
&& pev
->uprobes
)
2783 warn_uprobe_event_compat(tev
);
2784 if (ret
== 0 && probe_conf
.cache
) {
2785 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
2787 probe_cache__add_entry(cache
, pev
, tevs
, ntevs
) < 0 ||
2788 probe_cache__commit(cache
) < 0)
2789 pr_warning("Failed to add event to probe cache\n");
2790 probe_cache__delete(cache
);
2794 for (up
= 0; up
< 2; up
++) {
2795 strlist__delete(namelist
[up
]);
2802 static int find_probe_functions(struct map
*map
, char *name
,
2803 struct symbol
**syms
)
2807 struct rb_node
*tmp
;
2808 const char *norm
, *ver
;
2810 bool cut_version
= true;
2812 if (map__load(map
) < 0)
2815 /* If user gives a version, don't cut off the version from symbols */
2816 if (strchr(name
, '@'))
2817 cut_version
= false;
2819 map__for_each_symbol(map
, sym
, tmp
) {
2820 norm
= arch__normalize_symbol_name(sym
->name
);
2825 /* We don't care about default symbol or not */
2826 ver
= strchr(norm
, '@');
2828 buf
= strndup(norm
, ver
- norm
);
2835 if (strglobmatch(norm
, name
)) {
2837 if (syms
&& found
< probe_conf
.max_probes
)
2838 syms
[found
- 1] = sym
;
2847 void __weak
arch__fix_tev_from_maps(struct perf_probe_event
*pev __maybe_unused
,
2848 struct probe_trace_event
*tev __maybe_unused
,
2849 struct map
*map __maybe_unused
,
2850 struct symbol
*sym __maybe_unused
) { }
2853 * Find probe function addresses from map.
2854 * Return an error or the number of found probe_trace_event
2856 static int find_probe_trace_events_from_map(struct perf_probe_event
*pev
,
2857 struct probe_trace_event
**tevs
)
2859 struct map
*map
= NULL
;
2860 struct ref_reloc_sym
*reloc_sym
= NULL
;
2862 struct symbol
**syms
= NULL
;
2863 struct probe_trace_event
*tev
;
2864 struct perf_probe_point
*pp
= &pev
->point
;
2865 struct probe_trace_point
*tp
;
2866 int num_matched_functions
;
2867 int ret
, i
, j
, skipped
= 0;
2870 map
= get_target_map(pev
->target
, pev
->nsi
, pev
->uprobes
);
2876 syms
= malloc(sizeof(struct symbol
*) * probe_conf
.max_probes
);
2883 * Load matched symbols: Since the different local symbols may have
2884 * same name but different addresses, this lists all the symbols.
2886 num_matched_functions
= find_probe_functions(map
, pp
->function
, syms
);
2887 if (num_matched_functions
<= 0) {
2888 pr_err("Failed to find symbol %s in %s\n", pp
->function
,
2889 pev
->target
? : "kernel");
2892 } else if (num_matched_functions
> probe_conf
.max_probes
) {
2893 pr_err("Too many functions matched in %s\n",
2894 pev
->target
? : "kernel");
2899 /* Note that the symbols in the kmodule are not relocated */
2900 if (!pev
->uprobes
&& !pev
->target
&&
2901 (!pp
->retprobe
|| kretprobe_offset_is_supported())) {
2902 reloc_sym
= kernel_get_ref_reloc_sym();
2904 pr_warning("Relocated base symbol is not found!\n");
2910 /* Setup result trace-probe-events */
2911 *tevs
= zalloc(sizeof(*tev
) * num_matched_functions
);
2919 for (j
= 0; j
< num_matched_functions
; j
++) {
2922 tev
= (*tevs
) + ret
;
2924 if (ret
== num_matched_functions
) {
2925 pr_warning("Too many symbols are listed. Skip it.\n");
2930 if (pp
->offset
> sym
->end
- sym
->start
) {
2931 pr_warning("Offset %ld is bigger than the size of %s\n",
2932 pp
->offset
, sym
->name
);
2936 /* Add one probe point */
2937 tp
->address
= map
->unmap_ip(map
, sym
->start
) + pp
->offset
;
2939 /* Check the kprobe (not in module) is within .text */
2940 if (!pev
->uprobes
&& !pev
->target
&&
2941 kprobe_warn_out_range(sym
->name
, tp
->address
)) {
2942 tp
->symbol
= NULL
; /* Skip it */
2944 } else if (reloc_sym
) {
2945 tp
->symbol
= strdup_or_goto(reloc_sym
->name
, nomem_out
);
2946 tp
->offset
= tp
->address
- reloc_sym
->addr
;
2948 tp
->symbol
= strdup_or_goto(sym
->name
, nomem_out
);
2949 tp
->offset
= pp
->offset
;
2951 tp
->realname
= strdup_or_goto(sym
->name
, nomem_out
);
2953 tp
->retprobe
= pp
->retprobe
;
2956 tev
->point
.module
= strdup_or_goto(pev
->target
,
2959 mod_name
= find_module_name(pev
->target
);
2961 strdup(mod_name
? mod_name
: pev
->target
);
2963 if (!tev
->point
.module
)
2967 tev
->uprobes
= pev
->uprobes
;
2968 tev
->nargs
= pev
->nargs
;
2970 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) *
2972 if (tev
->args
== NULL
)
2975 for (i
= 0; i
< tev
->nargs
; i
++) {
2976 if (pev
->args
[i
].name
)
2978 strdup_or_goto(pev
->args
[i
].name
,
2981 tev
->args
[i
].value
= strdup_or_goto(pev
->args
[i
].var
,
2983 if (pev
->args
[i
].type
)
2985 strdup_or_goto(pev
->args
[i
].type
,
2988 arch__fix_tev_from_maps(pev
, tev
, map
, sym
);
2990 if (ret
== skipped
) {
3003 clear_probe_trace_events(*tevs
, num_matched_functions
);
3008 static int try_to_find_absolute_address(struct perf_probe_event
*pev
,
3009 struct probe_trace_event
**tevs
)
3011 struct perf_probe_point
*pp
= &pev
->point
;
3012 struct probe_trace_event
*tev
;
3013 struct probe_trace_point
*tp
;
3016 if (!(pev
->point
.function
&& !strncmp(pev
->point
.function
, "0x", 2)))
3018 if (perf_probe_event_need_dwarf(pev
))
3022 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3025 * Only one tev can be generated by this.
3027 *tevs
= zalloc(sizeof(*tev
));
3035 * Don't use tp->offset, use address directly, because
3036 * in synthesize_probe_trace_command() address cannot be
3039 tp
->address
= pev
->point
.abs_address
;
3040 tp
->retprobe
= pp
->retprobe
;
3041 tev
->uprobes
= pev
->uprobes
;
3045 * Give it a '0x' leading symbol name.
3046 * In __add_probe_trace_events, a NULL symbol is interpreted as
3049 if (asprintf(&tp
->symbol
, "0x%lx", tp
->address
) < 0)
3052 /* For kprobe, check range */
3053 if ((!tev
->uprobes
) &&
3054 (kprobe_warn_out_range(tev
->point
.symbol
,
3055 tev
->point
.address
))) {
3060 if (asprintf(&tp
->realname
, "abs_%lx", tp
->address
) < 0)
3064 tp
->module
= strdup(pev
->target
);
3070 tev
->group
= strdup(pev
->group
);
3076 tev
->event
= strdup(pev
->event
);
3081 tev
->nargs
= pev
->nargs
;
3082 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
3086 for (i
= 0; i
< tev
->nargs
; i
++)
3087 copy_to_probe_trace_arg(&tev
->args
[i
], &pev
->args
[i
]);
3092 clear_probe_trace_events(*tevs
, 1);
3097 /* Concatinate two arrays */
3098 static void *memcat(void *a
, size_t sz_a
, void *b
, size_t sz_b
)
3102 ret
= malloc(sz_a
+ sz_b
);
3104 memcpy(ret
, a
, sz_a
);
3105 memcpy(ret
+ sz_a
, b
, sz_b
);
3111 concat_probe_trace_events(struct probe_trace_event
**tevs
, int *ntevs
,
3112 struct probe_trace_event
**tevs2
, int ntevs2
)
3114 struct probe_trace_event
*new_tevs
;
3124 if (*ntevs
+ ntevs2
> probe_conf
.max_probes
)
3127 /* Concatinate the array of probe_trace_event */
3128 new_tevs
= memcat(*tevs
, (*ntevs
) * sizeof(**tevs
),
3129 *tevs2
, ntevs2
* sizeof(**tevs2
));
3139 clear_probe_trace_events(*tevs2
, ntevs2
);
3146 * Try to find probe_trace_event from given probe caches. Return the number
3147 * of cached events found, if an error occurs return the error.
3149 static int find_cached_events(struct perf_probe_event
*pev
,
3150 struct probe_trace_event
**tevs
,
3153 struct probe_cache
*cache
;
3154 struct probe_cache_entry
*entry
;
3155 struct probe_trace_event
*tmp_tevs
= NULL
;
3159 cache
= probe_cache__new(target
, pev
->nsi
);
3160 /* Return 0 ("not found") if the target has no probe cache. */
3164 for_each_probe_cache_entry(entry
, cache
) {
3165 /* Skip the cache entry which has no name */
3166 if (!entry
->pev
.event
|| !entry
->pev
.group
)
3168 if ((!pev
->group
|| strglobmatch(entry
->pev
.group
, pev
->group
)) &&
3169 strglobmatch(entry
->pev
.event
, pev
->event
)) {
3170 ret
= probe_cache_entry__get_event(entry
, &tmp_tevs
);
3172 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3178 probe_cache__delete(cache
);
3180 clear_probe_trace_events(*tevs
, ntevs
);
3184 if (ntevs
> 0 && target
&& target
[0] == '/')
3185 pev
->uprobes
= true;
3191 /* Try to find probe_trace_event from all probe caches */
3192 static int find_cached_events_all(struct perf_probe_event
*pev
,
3193 struct probe_trace_event
**tevs
)
3195 struct probe_trace_event
*tmp_tevs
= NULL
;
3196 struct strlist
*bidlist
;
3197 struct str_node
*nd
;
3202 /* Get the buildid list of all valid caches */
3203 bidlist
= build_id_cache__list_all(true);
3206 pr_debug("Failed to get buildids: %d\n", ret
);
3211 strlist__for_each_entry(nd
, bidlist
) {
3212 pathname
= build_id_cache__origname(nd
->s
);
3213 ret
= find_cached_events(pev
, &tmp_tevs
, pathname
);
3214 /* In the case of cnt == 0, we just skip it */
3216 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3222 strlist__delete(bidlist
);
3225 clear_probe_trace_events(*tevs
, ntevs
);
3233 static int find_probe_trace_events_from_cache(struct perf_probe_event
*pev
,
3234 struct probe_trace_event
**tevs
)
3236 struct probe_cache
*cache
;
3237 struct probe_cache_entry
*entry
;
3238 struct probe_trace_event
*tev
;
3239 struct str_node
*node
;
3243 /* For SDT/cached events, we use special search functions */
3245 return find_cached_events_all(pev
, tevs
);
3247 return find_cached_events(pev
, tevs
, pev
->target
);
3249 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
3253 entry
= probe_cache__find(cache
, pev
);
3255 /* SDT must be in the cache */
3256 ret
= pev
->sdt
? -ENOENT
: 0;
3260 ret
= strlist__nr_entries(entry
->tevlist
);
3261 if (ret
> probe_conf
.max_probes
) {
3262 pr_debug("Too many entries matched in the cache of %s\n",
3263 pev
->target
? : "kernel");
3268 *tevs
= zalloc(ret
* sizeof(*tev
));
3275 strlist__for_each_entry(node
, entry
->tevlist
) {
3276 tev
= &(*tevs
)[i
++];
3277 ret
= parse_probe_trace_command(node
->s
, tev
);
3280 /* Set the uprobes attribute as same as original */
3281 tev
->uprobes
= pev
->uprobes
;
3286 probe_cache__delete(cache
);
3290 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
3291 struct probe_trace_event
**tevs
)
3295 if (!pev
->group
&& !pev
->sdt
) {
3296 /* Set group name if not given */
3297 if (!pev
->uprobes
) {
3298 pev
->group
= strdup(PERFPROBE_GROUP
);
3299 ret
= pev
->group
? 0 : -ENOMEM
;
3301 ret
= convert_exec_to_group(pev
->target
, &pev
->group
);
3303 pr_warning("Failed to make a group name.\n");
3308 ret
= try_to_find_absolute_address(pev
, tevs
);
3312 /* At first, we need to lookup cache entry */
3313 ret
= find_probe_trace_events_from_cache(pev
, tevs
);
3314 if (ret
> 0 || pev
->sdt
) /* SDT can be found only in the cache */
3315 return ret
== 0 ? -ENOENT
: ret
; /* Found in probe cache */
3317 /* Convert perf_probe_event with debuginfo */
3318 ret
= try_to_find_probe_trace_events(pev
, tevs
);
3320 return ret
; /* Found in debuginfo or got an error */
3322 return find_probe_trace_events_from_map(pev
, tevs
);
3325 int convert_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3329 /* Loop 1: convert all events */
3330 for (i
= 0; i
< npevs
; i
++) {
3331 /* Init kprobe blacklist if needed */
3332 if (!pevs
[i
].uprobes
)
3333 kprobe_blacklist__init();
3334 /* Convert with or without debuginfo */
3335 ret
= convert_to_probe_trace_events(&pevs
[i
], &pevs
[i
].tevs
);
3338 pevs
[i
].ntevs
= ret
;
3340 /* This just release blacklist only if allocated */
3341 kprobe_blacklist__release();
3346 static int show_probe_trace_event(struct probe_trace_event
*tev
)
3348 char *buf
= synthesize_probe_trace_command(tev
);
3351 pr_debug("Failed to synthesize probe trace event.\n");
3355 /* Showing definition always go stdout */
3356 printf("%s\n", buf
);
3362 int show_probe_trace_events(struct perf_probe_event
*pevs
, int npevs
)
3364 struct strlist
*namelist
= strlist__new(NULL
, NULL
);
3365 struct probe_trace_event
*tev
;
3366 struct perf_probe_event
*pev
;
3372 for (j
= 0; j
< npevs
&& !ret
; j
++) {
3374 for (i
= 0; i
< pev
->ntevs
&& !ret
; i
++) {
3375 tev
= &pev
->tevs
[i
];
3376 /* Skip if the symbol is out of .text or blacklisted */
3377 if (!tev
->point
.symbol
&& !pev
->uprobes
)
3380 /* Set new name for tev (and update namelist) */
3381 ret
= probe_trace_event__set_name(tev
, pev
,
3384 ret
= show_probe_trace_event(tev
);
3387 strlist__delete(namelist
);
3392 int apply_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3396 /* Loop 2: add all events */
3397 for (i
= 0; i
< npevs
; i
++) {
3398 ret
= __add_probe_trace_events(&pevs
[i
], pevs
[i
].tevs
,
3400 probe_conf
.force_add
);
3407 void cleanup_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3410 struct perf_probe_event
*pev
;
3412 /* Loop 3: cleanup and free trace events */
3413 for (i
= 0; i
< npevs
; i
++) {
3415 for (j
= 0; j
< pevs
[i
].ntevs
; j
++)
3416 clear_probe_trace_event(&pevs
[i
].tevs
[j
]);
3417 zfree(&pevs
[i
].tevs
);
3419 nsinfo__zput(pev
->nsi
);
3420 clear_perf_probe_event(&pevs
[i
]);
3424 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3428 ret
= init_probe_symbol_maps(pevs
->uprobes
);
3432 ret
= convert_perf_probe_events(pevs
, npevs
);
3434 ret
= apply_perf_probe_events(pevs
, npevs
);
3436 cleanup_perf_probe_events(pevs
, npevs
);
3438 exit_probe_symbol_maps();
3442 int del_perf_probe_events(struct strfilter
*filter
)
3444 int ret
, ret2
, ufd
= -1, kfd
= -1;
3445 char *str
= strfilter__string(filter
);
3450 /* Get current event names */
3451 ret
= probe_file__open_both(&kfd
, &ufd
, PF_FL_RW
);
3455 ret
= probe_file__del_events(kfd
, filter
);
3456 if (ret
< 0 && ret
!= -ENOENT
)
3459 ret2
= probe_file__del_events(ufd
, filter
);
3460 if (ret2
< 0 && ret2
!= -ENOENT
) {
3477 int show_available_funcs(const char *target
, struct nsinfo
*nsi
,
3478 struct strfilter
*_filter
, bool user
)
3484 ret
= init_probe_symbol_maps(user
);
3488 /* Get a symbol map */
3489 map
= get_target_map(target
, nsi
, user
);
3491 pr_err("Failed to get a map for %s\n", (target
) ? : "kernel");
3495 ret
= map__load(map
);
3498 char *str
= strfilter__string(_filter
);
3499 pr_err("Failed to find symbols matched to \"%s\"\n",
3503 pr_err("Failed to load symbols in %s\n",
3504 (target
) ? : "kernel");
3507 if (!dso__sorted_by_name(map
->dso
, map
->type
))
3508 dso__sort_by_name(map
->dso
, map
->type
);
3510 /* Show all (filtered) symbols */
3513 for (nd
= rb_first(&map
->dso
->symbol_names
[map
->type
]); nd
; nd
= rb_next(nd
)) {
3514 struct symbol_name_rb_node
*pos
= rb_entry(nd
, struct symbol_name_rb_node
, rb_node
);
3516 if (strfilter__compare(_filter
, pos
->sym
.name
))
3517 printf("%s\n", pos
->sym
.name
);
3522 exit_probe_symbol_maps();
3527 int copy_to_probe_trace_arg(struct probe_trace_arg
*tvar
,
3528 struct perf_probe_arg
*pvar
)
3530 tvar
->value
= strdup(pvar
->var
);
3531 if (tvar
->value
== NULL
)
3534 tvar
->type
= strdup(pvar
->type
);
3535 if (tvar
->type
== NULL
)
3539 tvar
->name
= strdup(pvar
->name
);
3540 if (tvar
->name
== NULL
)