1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * probe-event.c : perf-probe definition to probe_events format converter
5 * Written by Masami Hiramatsu <mhiramat@redhat.com>
9 #include <sys/utsname.h>
10 #include <sys/types.h>
24 #include "namespaces.h"
26 #include "strfilter.h"
33 #include <api/fs/fs.h>
34 #include "trace-event.h" /* For __maybe_unused */
35 #include "probe-event.h"
36 #include "probe-finder.h"
37 #include "probe-file.h"
42 #include <subcmd/pager.h>
43 #include <linux/ctype.h>
44 #include <linux/zalloc.h>
46 #define PERFPROBE_GROUP "probe"
48 bool probe_event_dry_run
; /* Dry run flag */
49 struct probe_conf probe_conf
= { .magic_num
= DEFAULT_PROBE_MAGIC_NUM
};
51 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
53 int e_snprintf(char *str
, size_t size
, const char *format
, ...)
58 ret
= vsnprintf(str
, size
, format
, ap
);
65 static struct machine
*host_machine
;
67 /* Initialize symbol maps and path of vmlinux/modules */
68 int init_probe_symbol_maps(bool user_only
)
72 symbol_conf
.sort_by_name
= true;
73 symbol_conf
.allow_aliases
= true;
74 ret
= symbol__init(NULL
);
76 pr_debug("Failed to init symbol map.\n");
80 if (host_machine
|| user_only
) /* already initialized */
83 if (symbol_conf
.vmlinux_name
)
84 pr_debug("Use vmlinux: %s\n", symbol_conf
.vmlinux_name
);
86 host_machine
= machine__new_host();
88 pr_debug("machine__new_host() failed.\n");
94 pr_warning("Failed to init vmlinux path.\n");
98 void exit_probe_symbol_maps(void)
100 machine__delete(host_machine
);
105 static struct ref_reloc_sym
*kernel_get_ref_reloc_sym(void)
107 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
109 struct map
*map
= machine__kernel_map(host_machine
);
111 if (map__load(map
) < 0)
114 kmap
= map__kmap(map
);
117 return kmap
->ref_reloc_sym
;
120 static int kernel_get_symbol_address_by_name(const char *name
, u64
*addr
,
121 bool reloc
, bool reladdr
)
123 struct ref_reloc_sym
*reloc_sym
;
127 /* ref_reloc_sym is just a label. Need a special fix*/
128 reloc_sym
= kernel_get_ref_reloc_sym();
129 if (reloc_sym
&& strcmp(name
, reloc_sym
->name
) == 0)
130 *addr
= (reloc
) ? reloc_sym
->addr
: reloc_sym
->unrelocated_addr
;
132 sym
= machine__find_kernel_symbol_by_name(host_machine
, name
, &map
);
135 *addr
= map
->unmap_ip(map
, sym
->start
) -
136 ((reloc
) ? 0 : map
->reloc
) -
137 ((reladdr
) ? map
->start
: 0);
142 static struct map
*kernel_get_module_map(const char *module
)
144 struct maps
*maps
= machine__kernel_maps(host_machine
);
147 /* A file path -- this is an offline module */
148 if (module
&& strchr(module
, '/'))
149 return dso__new_map(module
);
152 pos
= machine__kernel_map(host_machine
);
153 return map__get(pos
);
156 maps__for_each_entry(maps
, pos
) {
157 /* short_name is "[module]" */
158 if (strncmp(pos
->dso
->short_name
+ 1, module
,
159 pos
->dso
->short_name_len
- 2) == 0 &&
160 module
[pos
->dso
->short_name_len
- 2] == '\0') {
161 return map__get(pos
);
167 struct map
*get_target_map(const char *target
, struct nsinfo
*nsi
, bool user
)
169 /* Init maps of given executable or kernel */
173 map
= dso__new_map(target
);
175 map
->dso
->nsinfo
= nsinfo__get(nsi
);
178 return kernel_get_module_map(target
);
182 static int convert_exec_to_group(const char *exec
, char **result
)
184 char *ptr1
, *ptr2
, *exec_copy
;
188 exec_copy
= strdup(exec
);
192 ptr1
= basename(exec_copy
);
198 for (ptr2
= ptr1
; *ptr2
!= '\0'; ptr2
++) {
199 if (!isalnum(*ptr2
) && *ptr2
!= '_') {
205 ret
= e_snprintf(buf
, 64, "%s_%s", PERFPROBE_GROUP
, ptr1
);
209 *result
= strdup(buf
);
210 ret
= *result
? 0 : -ENOMEM
;
217 static void clear_perf_probe_point(struct perf_probe_point
*pp
)
220 zfree(&pp
->function
);
221 zfree(&pp
->lazy_line
);
224 static void clear_probe_trace_events(struct probe_trace_event
*tevs
, int ntevs
)
228 for (i
= 0; i
< ntevs
; i
++)
229 clear_probe_trace_event(tevs
+ i
);
232 static bool kprobe_blacklist__listed(unsigned long address
);
233 static bool kprobe_warn_out_range(const char *symbol
, unsigned long address
)
238 /* Get the address of _etext for checking non-probable text symbol */
239 ret
= kernel_get_symbol_address_by_name("_etext", &etext_addr
,
242 if (ret
== 0 && etext_addr
< address
)
243 pr_warning("%s is out of .text, skip it.\n", symbol
);
244 else if (kprobe_blacklist__listed(address
))
245 pr_warning("%s is blacklisted function, skip it.\n", symbol
);
253 * @module can be module name of module file path. In case of path,
254 * inspect elf and find out what is actual module name.
255 * Caller has to free mod_name after using it.
257 static char *find_module_name(const char *module
)
265 char *mod_name
= NULL
;
268 fd
= open(module
, O_RDONLY
);
272 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
276 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
279 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
,
280 ".gnu.linkonce.this_module", NULL
);
284 data
= elf_getdata(sec
, NULL
);
285 if (!data
|| !data
->d_buf
)
290 * '.gnu.linkonce.this_module' section of kernel module elf directly
291 * maps to 'struct module' from linux/module.h. This section contains
292 * actual module name which will be used by kernel after loading it.
293 * But, we cannot use 'struct module' here since linux/module.h is not
294 * exposed to user-space. Offset of 'name' has remained same from long
295 * time, so hardcoding it here.
297 if (ehdr
.e_ident
[EI_CLASS
] == ELFCLASS32
)
299 else /* expect ELFCLASS64 by default */
302 mod_name
= strdup((char *)data
->d_buf
+ name_offset
);
311 #ifdef HAVE_DWARF_SUPPORT
313 static int kernel_get_module_dso(const char *module
, struct dso
**pdso
)
317 const char *vmlinux_name
;
321 char module_name
[128];
323 snprintf(module_name
, sizeof(module_name
), "[%s]", module
);
324 map
= maps__find_by_name(&host_machine
->kmaps
, module_name
);
329 pr_debug("Failed to find module %s.\n", module
);
333 map
= machine__kernel_map(host_machine
);
336 vmlinux_name
= symbol_conf
.vmlinux_name
;
339 ret
= dso__load_vmlinux(dso
, map
, vmlinux_name
, false);
341 ret
= dso__load_vmlinux_path(dso
, map
);
348 * Some binaries like glibc have special symbols which are on the symbol
349 * table, but not in the debuginfo. If we can find the address of the
350 * symbol from map, we can translate the address back to the probe point.
352 static int find_alternative_probe_point(struct debuginfo
*dinfo
,
353 struct perf_probe_point
*pp
,
354 struct perf_probe_point
*result
,
355 const char *target
, struct nsinfo
*nsi
,
358 struct map
*map
= NULL
;
363 /* This can work only for function-name based one */
364 if (!pp
->function
|| pp
->file
)
367 map
= get_target_map(target
, nsi
, uprobes
);
371 /* Find the address of given function */
372 map__for_each_symbol_by_name(map
, pp
->function
, sym
) {
374 address
= sym
->start
;
376 address
= map
->unmap_ip(map
, sym
->start
) - map
->reloc
;
383 pr_debug("Symbol %s address found : %" PRIx64
"\n",
384 pp
->function
, address
);
386 ret
= debuginfo__find_probe_point(dinfo
, (unsigned long)address
,
389 ret
= (!ret
) ? -ENOENT
: ret
;
391 result
->offset
+= pp
->offset
;
392 result
->line
+= pp
->line
;
393 result
->retprobe
= pp
->retprobe
;
403 static int get_alternative_probe_event(struct debuginfo
*dinfo
,
404 struct perf_probe_event
*pev
,
405 struct perf_probe_point
*tmp
)
409 memcpy(tmp
, &pev
->point
, sizeof(*tmp
));
410 memset(&pev
->point
, 0, sizeof(pev
->point
));
411 ret
= find_alternative_probe_point(dinfo
, tmp
, &pev
->point
, pev
->target
,
412 pev
->nsi
, pev
->uprobes
);
414 memcpy(&pev
->point
, tmp
, sizeof(*tmp
));
419 static int get_alternative_line_range(struct debuginfo
*dinfo
,
420 struct line_range
*lr
,
421 const char *target
, bool user
)
423 struct perf_probe_point pp
= { .function
= lr
->function
,
426 struct perf_probe_point result
;
429 memset(&result
, 0, sizeof(result
));
431 if (lr
->end
!= INT_MAX
)
432 len
= lr
->end
- lr
->start
;
433 ret
= find_alternative_probe_point(dinfo
, &pp
, &result
,
436 lr
->function
= result
.function
;
437 lr
->file
= result
.file
;
438 lr
->start
= result
.line
;
439 if (lr
->end
!= INT_MAX
)
440 lr
->end
= lr
->start
+ len
;
441 clear_perf_probe_point(&pp
);
446 /* Open new debuginfo of given module */
447 static struct debuginfo
*open_debuginfo(const char *module
, struct nsinfo
*nsi
,
450 const char *path
= module
;
451 char reason
[STRERR_BUFSIZE
];
452 struct debuginfo
*ret
= NULL
;
453 struct dso
*dso
= NULL
;
457 if (!module
|| !strchr(module
, '/')) {
458 err
= kernel_get_module_dso(module
, &dso
);
460 if (!dso
|| dso
->load_errno
== 0) {
461 if (!str_error_r(-err
, reason
, STRERR_BUFSIZE
))
462 strcpy(reason
, "(unknown)");
464 dso__strerror_load(dso
, reason
, STRERR_BUFSIZE
);
467 pr_err("Module %s is not loaded, please specify its full path name.\n", module
);
469 pr_err("Failed to find the path for the kernel: %s\n", reason
);
473 path
= dso
->long_name
;
475 nsinfo__mountns_enter(nsi
, &nsc
);
476 ret
= debuginfo__new(path
);
477 if (!ret
&& !silent
) {
478 pr_warning("The %s file has no debug information.\n", path
);
479 if (!module
|| !strtailcmp(path
, ".ko"))
480 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
482 pr_warning("Rebuild with -g, ");
483 pr_warning("or install an appropriate debuginfo package.\n");
485 nsinfo__mountns_exit(&nsc
);
489 /* For caching the last debuginfo */
490 static struct debuginfo
*debuginfo_cache
;
491 static char *debuginfo_cache_path
;
493 static struct debuginfo
*debuginfo_cache__open(const char *module
, bool silent
)
495 const char *path
= module
;
497 /* If the module is NULL, it should be the kernel. */
501 if (debuginfo_cache_path
&& !strcmp(debuginfo_cache_path
, path
))
504 /* Copy module path */
505 free(debuginfo_cache_path
);
506 debuginfo_cache_path
= strdup(path
);
507 if (!debuginfo_cache_path
) {
508 debuginfo__delete(debuginfo_cache
);
509 debuginfo_cache
= NULL
;
513 debuginfo_cache
= open_debuginfo(module
, NULL
, silent
);
514 if (!debuginfo_cache
)
515 zfree(&debuginfo_cache_path
);
517 return debuginfo_cache
;
520 static void debuginfo_cache__exit(void)
522 debuginfo__delete(debuginfo_cache
);
523 debuginfo_cache
= NULL
;
524 zfree(&debuginfo_cache_path
);
528 static int get_text_start_address(const char *exec
, unsigned long *address
,
534 int fd
, ret
= -ENOENT
;
537 nsinfo__mountns_enter(nsi
, &nsc
);
538 fd
= open(exec
, O_RDONLY
);
539 nsinfo__mountns_exit(&nsc
);
543 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
549 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
552 if (!elf_section_by_name(elf
, &ehdr
, &shdr
, ".text", NULL
))
555 *address
= shdr
.sh_addr
- shdr
.sh_offset
;
566 * Convert trace point to probe point with debuginfo
568 static int find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp
,
569 struct perf_probe_point
*pp
,
572 struct debuginfo
*dinfo
= NULL
;
573 unsigned long stext
= 0;
574 u64 addr
= tp
->address
;
577 /* convert the address to dwarf address */
583 ret
= get_text_start_address(tp
->module
, &stext
, NULL
);
587 } else if (tp
->symbol
) {
588 /* If the module is given, this returns relative address */
589 ret
= kernel_get_symbol_address_by_name(tp
->symbol
, &addr
,
590 false, !!tp
->module
);
596 pr_debug("try to find information at %" PRIx64
" in %s\n", addr
,
597 tp
->module
? : "kernel");
599 dinfo
= debuginfo_cache__open(tp
->module
, verbose
<= 0);
601 ret
= debuginfo__find_probe_point(dinfo
,
602 (unsigned long)addr
, pp
);
607 pp
->retprobe
= tp
->retprobe
;
611 pr_debug("Failed to find corresponding probes from debuginfo.\n");
612 return ret
? : -ENOENT
;
615 /* Adjust symbol name and address */
616 static int post_process_probe_trace_point(struct probe_trace_point
*tp
,
617 struct map
*map
, unsigned long offs
)
620 u64 addr
= tp
->address
- offs
;
622 sym
= map__find_symbol(map
, addr
);
626 if (strcmp(sym
->name
, tp
->symbol
)) {
627 /* If we have no realname, use symbol for it */
629 tp
->realname
= tp
->symbol
;
632 tp
->symbol
= strdup(sym
->name
);
636 tp
->offset
= addr
- sym
->start
;
643 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
644 * and generate new symbols with suffixes such as .constprop.N or .isra.N
645 * etc. Since those symbols are not recorded in DWARF, we have to find
646 * correct generated symbols from offline ELF binary.
647 * For online kernel or uprobes we don't need this because those are
648 * rebased on _text, or already a section relative address.
651 post_process_offline_probe_trace_events(struct probe_trace_event
*tevs
,
652 int ntevs
, const char *pathname
)
655 unsigned long stext
= 0;
658 /* Prepare a map for offline binary */
659 map
= dso__new_map(pathname
);
660 if (!map
|| get_text_start_address(pathname
, &stext
, NULL
) < 0) {
661 pr_warning("Failed to get ELF symbols for %s\n", pathname
);
665 for (i
= 0; i
< ntevs
; i
++) {
666 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
676 static int add_exec_to_probe_trace_events(struct probe_trace_event
*tevs
,
677 int ntevs
, const char *exec
,
681 unsigned long stext
= 0;
686 ret
= get_text_start_address(exec
, &stext
, nsi
);
690 for (i
= 0; i
< ntevs
&& ret
>= 0; i
++) {
691 /* point.address is the address of point.symbol + point.offset */
692 tevs
[i
].point
.address
-= stext
;
693 tevs
[i
].point
.module
= strdup(exec
);
694 if (!tevs
[i
].point
.module
) {
698 tevs
[i
].uprobes
= true;
705 post_process_module_probe_trace_events(struct probe_trace_event
*tevs
,
706 int ntevs
, const char *module
,
707 struct debuginfo
*dinfo
)
709 Dwarf_Addr text_offs
= 0;
711 char *mod_name
= NULL
;
717 map
= get_target_map(module
, NULL
, false);
718 if (!map
|| debuginfo__get_text_offset(dinfo
, &text_offs
, true) < 0) {
719 pr_warning("Failed to get ELF symbols for %s\n", module
);
723 mod_name
= find_module_name(module
);
724 for (i
= 0; i
< ntevs
; i
++) {
725 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
726 map
, (unsigned long)text_offs
);
729 tevs
[i
].point
.module
=
730 strdup(mod_name
? mod_name
: module
);
731 if (!tevs
[i
].point
.module
) {
744 post_process_kernel_probe_trace_events(struct probe_trace_event
*tevs
,
747 struct ref_reloc_sym
*reloc_sym
;
751 /* Skip post process if the target is an offline kernel */
752 if (symbol_conf
.ignore_vmlinux_buildid
)
753 return post_process_offline_probe_trace_events(tevs
, ntevs
,
754 symbol_conf
.vmlinux_name
);
756 reloc_sym
= kernel_get_ref_reloc_sym();
758 pr_warning("Relocated base symbol is not found!\n");
762 for (i
= 0; i
< ntevs
; i
++) {
763 if (!tevs
[i
].point
.address
)
765 if (tevs
[i
].point
.retprobe
&& !kretprobe_offset_is_supported())
767 /* If we found a wrong one, mark it by NULL symbol */
768 if (kprobe_warn_out_range(tevs
[i
].point
.symbol
,
769 tevs
[i
].point
.address
)) {
773 tmp
= strdup(reloc_sym
->name
);
777 /* If we have no realname, use symbol for it */
778 if (!tevs
[i
].point
.realname
)
779 tevs
[i
].point
.realname
= tevs
[i
].point
.symbol
;
781 free(tevs
[i
].point
.symbol
);
782 tevs
[i
].point
.symbol
= tmp
;
783 tevs
[i
].point
.offset
= tevs
[i
].point
.address
-
784 reloc_sym
->unrelocated_addr
;
790 arch__post_process_probe_trace_events(struct perf_probe_event
*pev __maybe_unused
,
791 int ntevs __maybe_unused
)
795 /* Post processing the probe events */
796 static int post_process_probe_trace_events(struct perf_probe_event
*pev
,
797 struct probe_trace_event
*tevs
,
798 int ntevs
, const char *module
,
799 bool uprobe
, struct debuginfo
*dinfo
)
804 ret
= add_exec_to_probe_trace_events(tevs
, ntevs
, module
,
807 /* Currently ref_reloc_sym based probe is not for drivers */
808 ret
= post_process_module_probe_trace_events(tevs
, ntevs
,
811 ret
= post_process_kernel_probe_trace_events(tevs
, ntevs
);
814 arch__post_process_probe_trace_events(pev
, ntevs
);
819 /* Try to find perf_probe_event with debuginfo */
820 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
821 struct probe_trace_event
**tevs
)
823 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
824 struct perf_probe_point tmp
;
825 struct debuginfo
*dinfo
;
828 dinfo
= open_debuginfo(pev
->target
, pev
->nsi
, !need_dwarf
);
832 pr_debug("Could not open debuginfo. Try to use symbols.\n");
836 pr_debug("Try to find probe point from debuginfo.\n");
837 /* Searching trace events corresponding to a probe event */
838 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
840 if (ntevs
== 0) { /* Not found, retry with an alternative */
841 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
843 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
845 * Write back to the original probe_event for
846 * setting appropriate (user given) event name
848 clear_perf_probe_point(&pev
->point
);
849 memcpy(&pev
->point
, &tmp
, sizeof(tmp
));
853 if (ntevs
> 0) { /* Succeeded to find trace events */
854 pr_debug("Found %d probe_trace_events.\n", ntevs
);
855 ret
= post_process_probe_trace_events(pev
, *tevs
, ntevs
,
856 pev
->target
, pev
->uprobes
, dinfo
);
857 if (ret
< 0 || ret
== ntevs
) {
858 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret
);
859 clear_probe_trace_events(*tevs
, ntevs
);
865 debuginfo__delete(dinfo
);
867 if (ntevs
== 0) { /* No error but failed to find probe point. */
868 pr_warning("Probe point '%s' not found.\n",
869 synthesize_perf_probe_point(&pev
->point
));
871 } else if (ntevs
< 0) {
872 /* Error path : ntevs < 0 */
873 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
875 pr_warning("Warning: No dwarf info found in the vmlinux - "
876 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
878 pr_debug("Trying to use symbols.\n");
885 #define LINEBUF_SIZE 256
886 #define NR_ADDITIONAL_LINES 2
888 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
890 char buf
[LINEBUF_SIZE
], sbuf
[STRERR_BUFSIZE
];
891 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
892 const char *prefix
= NULL
;
895 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
900 prefix
= show_num
? "%7d " : " ";
901 color_fprintf(stdout
, color
, prefix
, l
);
903 color_fprintf(stdout
, color
, "%s", buf
);
905 } while (strchr(buf
, '\n') == NULL
);
910 pr_warning("File read error: %s\n",
911 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
917 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
919 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
921 pr_warning("Source file is shorter than expected.\n");
927 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
928 #define show_one_line(f,l) _show_one_line(f,l,false,false)
929 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
930 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
933 * Show line-range always requires debuginfo to find source file and
936 static int __show_line_range(struct line_range
*lr
, const char *module
,
941 struct debuginfo
*dinfo
;
945 char sbuf
[STRERR_BUFSIZE
];
947 /* Search a line range */
948 dinfo
= open_debuginfo(module
, NULL
, false);
952 ret
= debuginfo__find_line_range(dinfo
, lr
);
953 if (!ret
) { /* Not found, retry with an alternative */
954 ret
= get_alternative_line_range(dinfo
, lr
, module
, user
);
956 ret
= debuginfo__find_line_range(dinfo
, lr
);
958 debuginfo__delete(dinfo
);
959 if (ret
== 0 || ret
== -ENOENT
) {
960 pr_warning("Specified source line is not found.\n");
962 } else if (ret
< 0) {
963 pr_warning("Debuginfo analysis failed.\n");
967 /* Convert source file path */
969 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
971 /* Free old path when new path is assigned */
976 pr_warning("Failed to find source file path.\n");
983 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
984 lr
->start
- lr
->offset
);
986 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
988 fp
= fopen(lr
->path
, "r");
990 pr_warning("Failed to open %s: %s\n", lr
->path
,
991 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
994 /* Skip to starting line number */
995 while (l
< lr
->start
) {
996 ret
= skip_one_line(fp
, l
++);
1001 intlist__for_each_entry(ln
, lr
->line_list
) {
1002 for (; ln
->i
> l
; l
++) {
1003 ret
= show_one_line(fp
, l
- lr
->offset
);
1007 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
1012 if (lr
->end
== INT_MAX
)
1013 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
1014 while (l
<= lr
->end
) {
1015 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
1024 int show_line_range(struct line_range
*lr
, const char *module
,
1025 struct nsinfo
*nsi
, bool user
)
1028 struct nscookie nsc
;
1030 ret
= init_probe_symbol_maps(user
);
1033 nsinfo__mountns_enter(nsi
, &nsc
);
1034 ret
= __show_line_range(lr
, module
, user
);
1035 nsinfo__mountns_exit(&nsc
);
1036 exit_probe_symbol_maps();
1041 static int show_available_vars_at(struct debuginfo
*dinfo
,
1042 struct perf_probe_event
*pev
,
1043 struct strfilter
*_filter
)
1047 struct str_node
*node
;
1048 struct variable_list
*vls
= NULL
, *vl
;
1049 struct perf_probe_point tmp
;
1052 buf
= synthesize_perf_probe_point(&pev
->point
);
1055 pr_debug("Searching variables at %s\n", buf
);
1057 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
);
1058 if (!ret
) { /* Not found, retry with an alternative */
1059 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
1061 ret
= debuginfo__find_available_vars_at(dinfo
, pev
,
1063 /* Release the old probe_point */
1064 clear_perf_probe_point(&tmp
);
1068 if (ret
== 0 || ret
== -ENOENT
) {
1069 pr_err("Failed to find the address of %s\n", buf
);
1072 pr_warning("Debuginfo analysis failed.\n");
1076 /* Some variables are found */
1077 fprintf(stdout
, "Available variables at %s\n", buf
);
1078 for (i
= 0; i
< ret
; i
++) {
1081 * A probe point might be converted to
1082 * several trace points.
1084 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
1086 zfree(&vl
->point
.symbol
);
1089 strlist__for_each_entry(node
, vl
->vars
) {
1090 var
= strchr(node
->s
, '\t') + 1;
1091 if (strfilter__compare(_filter
, var
)) {
1092 fprintf(stdout
, "\t\t%s\n", node
->s
);
1096 strlist__delete(vl
->vars
);
1099 fprintf(stdout
, "\t\t(No matched variables)\n");
1107 /* Show available variables on given probe point */
1108 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
1109 struct strfilter
*_filter
)
1112 struct debuginfo
*dinfo
;
1114 ret
= init_probe_symbol_maps(pevs
->uprobes
);
1118 dinfo
= open_debuginfo(pevs
->target
, pevs
->nsi
, false);
1126 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
1127 ret
= show_available_vars_at(dinfo
, &pevs
[i
], _filter
);
1129 debuginfo__delete(dinfo
);
1131 exit_probe_symbol_maps();
1135 #else /* !HAVE_DWARF_SUPPORT */
1137 static void debuginfo_cache__exit(void)
1142 find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp __maybe_unused
,
1143 struct perf_probe_point
*pp __maybe_unused
,
1144 bool is_kprobe __maybe_unused
)
1149 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
1150 struct probe_trace_event
**tevs __maybe_unused
)
1152 if (perf_probe_event_need_dwarf(pev
)) {
1153 pr_warning("Debuginfo-analysis is not supported.\n");
1160 int show_line_range(struct line_range
*lr __maybe_unused
,
1161 const char *module __maybe_unused
,
1162 struct nsinfo
*nsi __maybe_unused
,
1163 bool user __maybe_unused
)
1165 pr_warning("Debuginfo-analysis is not supported.\n");
1169 int show_available_vars(struct perf_probe_event
*pevs __maybe_unused
,
1170 int npevs __maybe_unused
,
1171 struct strfilter
*filter __maybe_unused
)
1173 pr_warning("Debuginfo-analysis is not supported.\n");
1178 void line_range__clear(struct line_range
*lr
)
1180 zfree(&lr
->function
);
1183 zfree(&lr
->comp_dir
);
1184 intlist__delete(lr
->line_list
);
1187 int line_range__init(struct line_range
*lr
)
1189 memset(lr
, 0, sizeof(*lr
));
1190 lr
->line_list
= intlist__new(NULL
);
1197 static int parse_line_num(char **ptr
, int *val
, const char *what
)
1199 const char *start
= *ptr
;
1202 *val
= strtol(*ptr
, ptr
, 0);
1203 if (errno
|| *ptr
== start
) {
1204 semantic_error("'%s' is not a valid number.\n", what
);
1210 /* Check the name is good for event, group or function */
1211 static bool is_c_func_name(const char *name
)
1213 if (!isalpha(*name
) && *name
!= '_')
1215 while (*++name
!= '\0') {
1216 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
1223 * Stuff 'lr' according to the line range described by 'arg'.
1224 * The line range syntax is described by:
1226 * SRC[:SLN[+NUM|-ELN]]
1227 * FNC[@SRC][:SLN[+NUM|-ELN]]
1229 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
1231 char *range
, *file
, *name
= strdup(arg
);
1240 range
= strchr(name
, ':');
1244 err
= parse_line_num(&range
, &lr
->start
, "start line");
1248 if (*range
== '+' || *range
== '-') {
1249 const char c
= *range
++;
1251 err
= parse_line_num(&range
, &lr
->end
, "end line");
1256 lr
->end
+= lr
->start
;
1258 * Adjust the number of lines here.
1259 * If the number of lines == 1, the
1260 * the end of line should be equal to
1261 * the start of line.
1267 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
1270 if (lr
->start
> lr
->end
) {
1271 semantic_error("Start line must be smaller"
1272 " than end line.\n");
1275 if (*range
!= '\0') {
1276 semantic_error("Tailing with invalid str '%s'.\n", range
);
1281 file
= strchr(name
, '@');
1284 lr
->file
= strdup(++file
);
1285 if (lr
->file
== NULL
) {
1289 lr
->function
= name
;
1290 } else if (strchr(name
, '/') || strchr(name
, '.'))
1292 else if (is_c_func_name(name
))/* We reuse it for checking funcname */
1293 lr
->function
= name
;
1294 else { /* Invalid name */
1295 semantic_error("'%s' is not a valid function name.\n", name
);
1306 static int parse_perf_probe_event_name(char **arg
, struct perf_probe_event
*pev
)
1310 ptr
= strpbrk_esc(*arg
, ":");
1313 if (!pev
->sdt
&& !is_c_func_name(*arg
))
1315 pev
->group
= strdup_esc(*arg
);
1322 pev
->event
= strdup_esc(*arg
);
1323 if (pev
->event
== NULL
)
1326 if (!pev
->sdt
&& !is_c_func_name(pev
->event
)) {
1330 semantic_error("%s is bad for event name -it must "
1331 "follow C symbol-naming rule.\n", *arg
);
1337 /* Parse probepoint definition. */
1338 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
1340 struct perf_probe_point
*pp
= &pev
->point
;
1343 bool file_spec
= false;
1348 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1349 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1350 * perf probe %[GRP:]SDT_EVENT
1355 if (is_sdt_event(arg
)) {
1361 ptr
= strpbrk_esc(arg
, ";=@+%");
1365 semantic_error("%s must be an SDT name.\n",
1369 /* This must be a target file name or build id */
1370 tmp
= build_id_cache__complement(ptr
+ 1);
1372 pev
->target
= build_id_cache__origname(tmp
);
1375 pev
->target
= strdup_esc(ptr
+ 1);
1380 ret
= parse_perf_probe_event_name(&arg
, pev
);
1382 if (asprintf(&pev
->point
.function
, "%%%s", pev
->event
) < 0)
1388 if (ptr
&& *ptr
== '=') { /* Event name */
1391 ret
= parse_perf_probe_event_name(&arg
, pev
);
1399 * Check arg is function or file name and copy it.
1401 * We consider arg to be a file spec if and only if it satisfies
1402 * all of the below criteria::
1403 * - it does not include any of "+@%",
1404 * - it includes one of ":;", and
1405 * - it has a period '.' in the name.
1407 * Otherwise, we consider arg to be a function specification.
1409 if (!strpbrk_esc(arg
, "+@%")) {
1410 ptr
= strpbrk_esc(arg
, ";:");
1411 /* This is a file spec if it includes a '.' before ; or : */
1412 if (ptr
&& memchr(arg
, '.', ptr
- arg
))
1416 ptr
= strpbrk_esc(arg
, ";:+@%");
1425 tmp
= strdup_esc(arg
);
1436 * Keep pp->function even if this is absolute address,
1437 * so it can mark whether abs_address is valid.
1438 * Which make 'perf probe lib.bin 0x0' possible.
1440 * Note that checking length of tmp is not needed
1441 * because when we access tmp[1] we know tmp[0] is '0',
1442 * so tmp[1] should always valid (but could be '\0').
1444 if (tmp
&& !strncmp(tmp
, "0x", 2)) {
1445 pp
->abs_address
= strtoul(pp
->function
, &tmp
, 0);
1447 semantic_error("Invalid absolute address.\n");
1453 /* Parse other options */
1457 if (c
== ';') { /* Lazy pattern must be the last part */
1458 pp
->lazy_line
= strdup(arg
); /* let leave escapes */
1459 if (pp
->lazy_line
== NULL
)
1463 ptr
= strpbrk_esc(arg
, ";:+@%");
1469 case ':': /* Line number */
1470 pp
->line
= strtoul(arg
, &tmp
, 0);
1472 semantic_error("There is non-digit char"
1473 " in line number.\n");
1477 case '+': /* Byte offset from a symbol */
1478 pp
->offset
= strtoul(arg
, &tmp
, 0);
1480 semantic_error("There is non-digit character"
1485 case '@': /* File name */
1487 semantic_error("SRC@SRC is not allowed.\n");
1490 pp
->file
= strdup_esc(arg
);
1491 if (pp
->file
== NULL
)
1494 case '%': /* Probe places */
1495 if (strcmp(arg
, "return") == 0) {
1497 } else { /* Others not supported yet */
1498 semantic_error("%%%s is not supported.\n", arg
);
1502 default: /* Buggy case */
1503 pr_err("This program has a bug at %s:%d.\n",
1504 __FILE__
, __LINE__
);
1510 /* Exclusion check */
1511 if (pp
->lazy_line
&& pp
->line
) {
1512 semantic_error("Lazy pattern can't be used with"
1517 if (pp
->lazy_line
&& pp
->offset
) {
1518 semantic_error("Lazy pattern can't be used with offset.\n");
1522 if (pp
->line
&& pp
->offset
) {
1523 semantic_error("Offset can't be used with line number.\n");
1527 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
1528 semantic_error("File always requires line number or "
1533 if (pp
->offset
&& !pp
->function
) {
1534 semantic_error("Offset requires an entry function.\n");
1538 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
1539 semantic_error("Offset/Line/Lazy pattern can't be used with "
1544 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1545 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
1550 /* Parse perf-probe event argument */
1551 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
1553 char *tmp
, *goodname
;
1554 struct perf_probe_arg_field
**fieldp
;
1556 pr_debug("parsing arg: %s into ", str
);
1558 tmp
= strchr(str
, '=');
1560 arg
->name
= strndup(str
, tmp
- str
);
1561 if (arg
->name
== NULL
)
1563 pr_debug("name:%s ", arg
->name
);
1567 tmp
= strchr(str
, '@');
1568 if (tmp
&& tmp
!= str
&& strcmp(tmp
+ 1, "user")) { /* user attr */
1569 if (!user_access_is_supported()) {
1570 semantic_error("ftrace does not support user access\n");
1574 arg
->user_access
= true;
1575 pr_debug("user_access ");
1578 tmp
= strchr(str
, ':');
1579 if (tmp
) { /* Type setting */
1581 arg
->type
= strdup(tmp
+ 1);
1582 if (arg
->type
== NULL
)
1584 pr_debug("type:%s ", arg
->type
);
1587 tmp
= strpbrk(str
, "-.[");
1588 if (!is_c_varname(str
) || !tmp
) {
1589 /* A variable, register, symbol or special value */
1590 arg
->var
= strdup(str
);
1591 if (arg
->var
== NULL
)
1593 pr_debug("%s\n", arg
->var
);
1597 /* Structure fields or array element */
1598 arg
->var
= strndup(str
, tmp
- str
);
1599 if (arg
->var
== NULL
)
1601 goodname
= arg
->var
;
1602 pr_debug("%s, ", arg
->var
);
1603 fieldp
= &arg
->field
;
1606 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
1607 if (*fieldp
== NULL
)
1609 if (*tmp
== '[') { /* Array */
1611 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
1612 (*fieldp
)->ref
= true;
1613 if (*tmp
!= ']' || tmp
== str
+ 1) {
1614 semantic_error("Array index must be a"
1621 } else { /* Structure */
1624 (*fieldp
)->ref
= false;
1625 } else if (tmp
[1] == '>') {
1627 (*fieldp
)->ref
= true;
1629 semantic_error("Argument parse error: %s\n",
1633 tmp
= strpbrk(str
, "-.[");
1636 (*fieldp
)->name
= strndup(str
, tmp
- str
);
1637 if ((*fieldp
)->name
== NULL
)
1640 goodname
= (*fieldp
)->name
;
1641 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
1642 fieldp
= &(*fieldp
)->next
;
1645 (*fieldp
)->name
= strdup(str
);
1646 if ((*fieldp
)->name
== NULL
)
1649 goodname
= (*fieldp
)->name
;
1650 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
1652 /* If no name is specified, set the last field name (not array index)*/
1654 arg
->name
= strdup(goodname
);
1655 if (arg
->name
== NULL
)
1661 /* Parse perf-probe event command */
1662 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1665 int argc
, i
, ret
= 0;
1667 argv
= argv_split(cmd
, &argc
);
1669 pr_debug("Failed to split arguments.\n");
1672 if (argc
- 1 > MAX_PROBE_ARGS
) {
1673 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1677 /* Parse probe point */
1678 ret
= parse_perf_probe_point(argv
[0], pev
);
1682 /* Generate event name if needed */
1683 if (!pev
->event
&& pev
->point
.function
&& pev
->point
.line
1684 && !pev
->point
.lazy_line
&& !pev
->point
.offset
) {
1685 if (asprintf(&pev
->event
, "%s_L%d", pev
->point
.function
,
1686 pev
->point
.line
) < 0)
1690 /* Copy arguments and ensure return probe has no C argument */
1691 pev
->nargs
= argc
- 1;
1692 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1693 if (pev
->args
== NULL
) {
1697 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1698 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1700 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1701 semantic_error("You can't specify local variable for"
1712 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1713 bool perf_probe_with_var(struct perf_probe_event
*pev
)
1717 for (i
= 0; i
< pev
->nargs
; i
++)
1718 if (is_c_varname(pev
->args
[i
].var
) ||
1719 !strcmp(pev
->args
[i
].var
, PROBE_ARG_PARAMS
) ||
1720 !strcmp(pev
->args
[i
].var
, PROBE_ARG_VARS
))
1725 /* Return true if this perf_probe_event requires debuginfo */
1726 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1728 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1731 if (perf_probe_with_var(pev
))
1737 /* Parse probe_events event into struct probe_point */
1738 int parse_probe_trace_command(const char *cmd
, struct probe_trace_event
*tev
)
1740 struct probe_trace_point
*tp
= &tev
->point
;
1743 char *argv0_str
= NULL
, *fmt
, *fmt1_str
, *fmt2_str
, *fmt3_str
;
1747 pr_debug("Parsing probe_events: %s\n", cmd
);
1748 argv
= argv_split(cmd
, &argc
);
1750 pr_debug("Failed to split arguments.\n");
1754 semantic_error("Too few probe arguments.\n");
1759 /* Scan event and group name. */
1760 argv0_str
= strdup(argv
[0]);
1761 if (argv0_str
== NULL
) {
1765 fmt1_str
= strtok_r(argv0_str
, ":", &fmt
);
1766 fmt2_str
= strtok_r(NULL
, "/", &fmt
);
1767 fmt3_str
= strtok_r(NULL
, " \t", &fmt
);
1768 if (fmt1_str
== NULL
|| strlen(fmt1_str
) != 1 || fmt2_str
== NULL
1769 || fmt3_str
== NULL
) {
1770 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1775 tev
->group
= strdup(fmt2_str
);
1776 tev
->event
= strdup(fmt3_str
);
1777 if (tev
->group
== NULL
|| tev
->event
== NULL
) {
1781 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1783 tp
->retprobe
= (pr
== 'r');
1785 /* Scan module name(if there), function name and offset */
1786 p
= strchr(argv
[1], ':');
1788 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1793 tev
->uprobes
= (tp
->module
[0] == '/');
1797 fmt1_str
= strtok_r(p
, "+", &fmt
);
1798 /* only the address started with 0x */
1799 if (fmt1_str
[0] == '0') {
1801 * Fix a special case:
1802 * if address == 0, kernel reports something like:
1803 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1804 * Newer kernel may fix that, but we want to
1805 * support old kernel also.
1807 if (strcmp(fmt1_str
, "0x") == 0) {
1808 if (!argv
[2] || strcmp(argv
[2], "(null)")) {
1815 for (i
= 2; argv
[i
+ 1] != NULL
; i
++)
1816 argv
[i
] = argv
[i
+ 1];
1821 tp
->address
= strtoul(fmt1_str
, NULL
, 0);
1823 /* Only the symbol-based probe has offset */
1824 tp
->symbol
= strdup(fmt1_str
);
1825 if (tp
->symbol
== NULL
) {
1829 fmt2_str
= strtok_r(NULL
, "", &fmt
);
1830 if (fmt2_str
== NULL
)
1833 tp
->offset
= strtoul(fmt2_str
, NULL
, 10);
1837 fmt2_str
= strchr(p
, '(');
1839 tp
->ref_ctr_offset
= strtoul(fmt2_str
+ 1, NULL
, 0);
1842 tev
->nargs
= argc
- 2;
1843 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
1844 if (tev
->args
== NULL
) {
1848 for (i
= 0; i
< tev
->nargs
; i
++) {
1849 p
= strchr(argv
[i
+ 2], '=');
1850 if (p
) /* We don't need which register is assigned. */
1854 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
1855 /* TODO: parse regs and offset */
1856 tev
->args
[i
].value
= strdup(p
);
1857 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1869 /* Compose only probe arg */
1870 char *synthesize_perf_probe_arg(struct perf_probe_arg
*pa
)
1872 struct perf_probe_arg_field
*field
= pa
->field
;
1877 if (strbuf_init(&buf
, 64) < 0)
1880 if (pa
->name
&& pa
->var
)
1881 err
= strbuf_addf(&buf
, "%s=%s", pa
->name
, pa
->var
);
1883 err
= strbuf_addstr(&buf
, pa
->name
?: pa
->var
);
1888 if (field
->name
[0] == '[')
1889 err
= strbuf_addstr(&buf
, field
->name
);
1891 err
= strbuf_addf(&buf
, "%s%s", field
->ref
? "->" : ".",
1893 field
= field
->next
;
1899 if (strbuf_addf(&buf
, ":%s", pa
->type
) < 0)
1902 ret
= strbuf_detach(&buf
, NULL
);
1904 strbuf_release(&buf
);
1908 /* Compose only probe point (not argument) */
1909 char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1912 char *tmp
, *ret
= NULL
;
1915 if (strbuf_init(&buf
, 64) < 0)
1919 if (strbuf_addstr(&buf
, pp
->function
) < 0)
1922 err
= strbuf_addf(&buf
, "+%lu", pp
->offset
);
1924 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
1925 else if (pp
->retprobe
)
1926 err
= strbuf_addstr(&buf
, "%return");
1934 tmp
= strchr(pp
->file
+ len
- 30, '/');
1935 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1937 err
= strbuf_addf(&buf
, "@%s", tmp
);
1938 if (!err
&& !pp
->function
&& pp
->line
)
1939 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
1942 ret
= strbuf_detach(&buf
, NULL
);
1944 strbuf_release(&buf
);
1948 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1951 char *tmp
, *ret
= NULL
;
1954 if (strbuf_init(&buf
, 64))
1957 if (strbuf_addf(&buf
, "%s:%s=", pev
->group
?: PERFPROBE_GROUP
,
1961 tmp
= synthesize_perf_probe_point(&pev
->point
);
1962 if (!tmp
|| strbuf_addstr(&buf
, tmp
) < 0)
1966 for (i
= 0; i
< pev
->nargs
; i
++) {
1967 tmp
= synthesize_perf_probe_arg(pev
->args
+ i
);
1968 if (!tmp
|| strbuf_addf(&buf
, " %s", tmp
) < 0)
1973 ret
= strbuf_detach(&buf
, NULL
);
1975 strbuf_release(&buf
);
1979 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1980 struct strbuf
*buf
, int depth
)
1984 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1989 err
= strbuf_addf(buf
, "%+ld(", ref
->offset
);
1990 return (err
< 0) ? err
: depth
;
1993 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1996 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1999 /* Argument name or separator */
2001 err
= strbuf_addf(buf
, " %s=", arg
->name
);
2003 err
= strbuf_addch(buf
, ' ');
2007 /* Special case: @XXX */
2008 if (arg
->value
[0] == '@' && arg
->ref
)
2011 /* Dereferencing arguments */
2013 depth
= __synthesize_probe_trace_arg_ref(ref
, buf
, 1);
2018 /* Print argument value */
2019 if (arg
->value
[0] == '@' && arg
->ref
)
2020 err
= strbuf_addf(buf
, "%s%+ld", arg
->value
, arg
->ref
->offset
);
2022 err
= strbuf_addstr(buf
, arg
->value
);
2025 while (!err
&& depth
--)
2026 err
= strbuf_addch(buf
, ')');
2028 /* Print argument type */
2029 if (!err
&& arg
->type
)
2030 err
= strbuf_addf(buf
, ":%s", arg
->type
);
2036 synthesize_uprobe_trace_def(struct probe_trace_event
*tev
, struct strbuf
*buf
)
2038 struct probe_trace_point
*tp
= &tev
->point
;
2041 err
= strbuf_addf(buf
, "%s:0x%lx", tp
->module
, tp
->address
);
2043 if (err
>= 0 && tp
->ref_ctr_offset
) {
2044 if (!uprobe_ref_ctr_is_supported())
2046 err
= strbuf_addf(buf
, "(0x%lx)", tp
->ref_ctr_offset
);
2048 return err
>= 0 ? 0 : -1;
2051 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
2053 struct probe_trace_point
*tp
= &tev
->point
;
2058 /* Uprobes must have tp->module */
2059 if (tev
->uprobes
&& !tp
->module
)
2062 if (strbuf_init(&buf
, 32) < 0)
2065 if (strbuf_addf(&buf
, "%c:%s/%s ", tp
->retprobe
? 'r' : 'p',
2066 tev
->group
, tev
->event
) < 0)
2069 * If tp->address == 0, then this point must be a
2070 * absolute address uprobe.
2071 * try_to_find_absolute_address() should have made
2072 * tp->symbol to "0x0".
2074 if (tev
->uprobes
&& !tp
->address
) {
2075 if (!tp
->symbol
|| strcmp(tp
->symbol
, "0x0"))
2079 /* Use the tp->address for uprobes */
2081 err
= synthesize_uprobe_trace_def(tev
, &buf
);
2082 } else if (!strncmp(tp
->symbol
, "0x", 2)) {
2083 /* Absolute address. See try_to_find_absolute_address() */
2084 err
= strbuf_addf(&buf
, "%s%s0x%lx", tp
->module
?: "",
2085 tp
->module
? ":" : "", tp
->address
);
2087 err
= strbuf_addf(&buf
, "%s%s%s+%lu", tp
->module
?: "",
2088 tp
->module
? ":" : "", tp
->symbol
, tp
->offset
);
2094 for (i
= 0; i
< tev
->nargs
; i
++)
2095 if (synthesize_probe_trace_arg(&tev
->args
[i
], &buf
) < 0)
2098 ret
= strbuf_detach(&buf
, NULL
);
2100 strbuf_release(&buf
);
2104 static int find_perf_probe_point_from_map(struct probe_trace_point
*tp
,
2105 struct perf_probe_point
*pp
,
2108 struct symbol
*sym
= NULL
;
2109 struct map
*map
= NULL
;
2110 u64 addr
= tp
->address
;
2114 map
= dso__new_map(tp
->module
);
2117 sym
= map__find_symbol(map
, addr
);
2119 if (tp
->symbol
&& !addr
) {
2120 if (kernel_get_symbol_address_by_name(tp
->symbol
,
2121 &addr
, true, false) < 0)
2126 sym
= machine__find_kernel_symbol(host_machine
, addr
, &map
);
2133 pp
->retprobe
= tp
->retprobe
;
2134 pp
->offset
= addr
- map
->unmap_ip(map
, sym
->start
);
2135 pp
->function
= strdup(sym
->name
);
2136 ret
= pp
->function
? 0 : -ENOMEM
;
2139 if (map
&& !is_kprobe
) {
2146 static int convert_to_perf_probe_point(struct probe_trace_point
*tp
,
2147 struct perf_probe_point
*pp
,
2153 ret
= find_perf_probe_point_from_dwarf(tp
, pp
, is_kprobe
);
2156 ret
= find_perf_probe_point_from_map(tp
, pp
, is_kprobe
);
2160 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2163 pp
->function
= strdup(tp
->symbol
);
2164 pp
->offset
= tp
->offset
;
2166 ret
= e_snprintf(buf
, 128, "0x%" PRIx64
, (u64
)tp
->address
);
2169 pp
->function
= strdup(buf
);
2172 if (pp
->function
== NULL
)
2175 pp
->retprobe
= tp
->retprobe
;
2180 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
2181 struct perf_probe_event
*pev
, bool is_kprobe
)
2183 struct strbuf buf
= STRBUF_INIT
;
2186 /* Convert event/group name */
2187 pev
->event
= strdup(tev
->event
);
2188 pev
->group
= strdup(tev
->group
);
2189 if (pev
->event
== NULL
|| pev
->group
== NULL
)
2192 /* Convert trace_point to probe_point */
2193 ret
= convert_to_perf_probe_point(&tev
->point
, &pev
->point
, is_kprobe
);
2197 /* Convert trace_arg to probe_arg */
2198 pev
->nargs
= tev
->nargs
;
2199 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
2200 if (pev
->args
== NULL
)
2202 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
2203 if (tev
->args
[i
].name
)
2204 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
2206 if ((ret
= strbuf_init(&buf
, 32)) < 0)
2208 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], &buf
);
2209 pev
->args
[i
].name
= strbuf_detach(&buf
, NULL
);
2211 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
2216 clear_perf_probe_event(pev
);
2221 void clear_perf_probe_event(struct perf_probe_event
*pev
)
2223 struct perf_probe_arg_field
*field
, *next
;
2228 zfree(&pev
->target
);
2229 clear_perf_probe_point(&pev
->point
);
2231 for (i
= 0; i
< pev
->nargs
; i
++) {
2232 zfree(&pev
->args
[i
].name
);
2233 zfree(&pev
->args
[i
].var
);
2234 zfree(&pev
->args
[i
].type
);
2235 field
= pev
->args
[i
].field
;
2238 zfree(&field
->name
);
2247 #define strdup_or_goto(str, label) \
2248 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2250 static int perf_probe_point__copy(struct perf_probe_point
*dst
,
2251 struct perf_probe_point
*src
)
2253 dst
->file
= strdup_or_goto(src
->file
, out_err
);
2254 dst
->function
= strdup_or_goto(src
->function
, out_err
);
2255 dst
->lazy_line
= strdup_or_goto(src
->lazy_line
, out_err
);
2256 dst
->line
= src
->line
;
2257 dst
->retprobe
= src
->retprobe
;
2258 dst
->offset
= src
->offset
;
2262 clear_perf_probe_point(dst
);
2266 static int perf_probe_arg__copy(struct perf_probe_arg
*dst
,
2267 struct perf_probe_arg
*src
)
2269 struct perf_probe_arg_field
*field
, **ppfield
;
2271 dst
->name
= strdup_or_goto(src
->name
, out_err
);
2272 dst
->var
= strdup_or_goto(src
->var
, out_err
);
2273 dst
->type
= strdup_or_goto(src
->type
, out_err
);
2276 ppfield
= &(dst
->field
);
2278 *ppfield
= zalloc(sizeof(*field
));
2281 (*ppfield
)->name
= strdup_or_goto(field
->name
, out_err
);
2282 (*ppfield
)->index
= field
->index
;
2283 (*ppfield
)->ref
= field
->ref
;
2284 field
= field
->next
;
2285 ppfield
= &((*ppfield
)->next
);
2292 int perf_probe_event__copy(struct perf_probe_event
*dst
,
2293 struct perf_probe_event
*src
)
2297 dst
->event
= strdup_or_goto(src
->event
, out_err
);
2298 dst
->group
= strdup_or_goto(src
->group
, out_err
);
2299 dst
->target
= strdup_or_goto(src
->target
, out_err
);
2300 dst
->uprobes
= src
->uprobes
;
2302 if (perf_probe_point__copy(&dst
->point
, &src
->point
) < 0)
2305 dst
->args
= zalloc(sizeof(struct perf_probe_arg
) * src
->nargs
);
2308 dst
->nargs
= src
->nargs
;
2310 for (i
= 0; i
< src
->nargs
; i
++)
2311 if (perf_probe_arg__copy(&dst
->args
[i
], &src
->args
[i
]) < 0)
2316 clear_perf_probe_event(dst
);
2320 void clear_probe_trace_event(struct probe_trace_event
*tev
)
2322 struct probe_trace_arg_ref
*ref
, *next
;
2327 zfree(&tev
->point
.symbol
);
2328 zfree(&tev
->point
.realname
);
2329 zfree(&tev
->point
.module
);
2330 for (i
= 0; i
< tev
->nargs
; i
++) {
2331 zfree(&tev
->args
[i
].name
);
2332 zfree(&tev
->args
[i
].value
);
2333 zfree(&tev
->args
[i
].type
);
2334 ref
= tev
->args
[i
].ref
;
2345 struct kprobe_blacklist_node
{
2346 struct list_head list
;
2347 unsigned long start
;
2352 static void kprobe_blacklist__delete(struct list_head
*blacklist
)
2354 struct kprobe_blacklist_node
*node
;
2356 while (!list_empty(blacklist
)) {
2357 node
= list_first_entry(blacklist
,
2358 struct kprobe_blacklist_node
, list
);
2359 list_del_init(&node
->list
);
2360 zfree(&node
->symbol
);
2365 static int kprobe_blacklist__load(struct list_head
*blacklist
)
2367 struct kprobe_blacklist_node
*node
;
2368 const char *__debugfs
= debugfs__mountpoint();
2369 char buf
[PATH_MAX
], *p
;
2373 if (__debugfs
== NULL
)
2376 ret
= e_snprintf(buf
, PATH_MAX
, "%s/kprobes/blacklist", __debugfs
);
2380 fp
= fopen(buf
, "r");
2385 while (fgets(buf
, PATH_MAX
, fp
)) {
2386 node
= zalloc(sizeof(*node
));
2391 INIT_LIST_HEAD(&node
->list
);
2392 list_add_tail(&node
->list
, blacklist
);
2393 if (sscanf(buf
, "0x%lx-0x%lx", &node
->start
, &node
->end
) != 2) {
2397 p
= strchr(buf
, '\t');
2400 if (p
[strlen(p
) - 1] == '\n')
2401 p
[strlen(p
) - 1] = '\0';
2403 p
= (char *)"unknown";
2404 node
->symbol
= strdup(p
);
2405 if (!node
->symbol
) {
2409 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2410 node
->start
, node
->end
, node
->symbol
);
2414 kprobe_blacklist__delete(blacklist
);
2420 static struct kprobe_blacklist_node
*
2421 kprobe_blacklist__find_by_address(struct list_head
*blacklist
,
2422 unsigned long address
)
2424 struct kprobe_blacklist_node
*node
;
2426 list_for_each_entry(node
, blacklist
, list
) {
2427 if (node
->start
<= address
&& address
< node
->end
)
2434 static LIST_HEAD(kprobe_blacklist
);
2436 static void kprobe_blacklist__init(void)
2438 if (!list_empty(&kprobe_blacklist
))
2441 if (kprobe_blacklist__load(&kprobe_blacklist
) < 0)
2442 pr_debug("No kprobe blacklist support, ignored\n");
2445 static void kprobe_blacklist__release(void)
2447 kprobe_blacklist__delete(&kprobe_blacklist
);
2450 static bool kprobe_blacklist__listed(unsigned long address
)
2452 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist
, address
);
2455 static int perf_probe_event__sprintf(const char *group
, const char *event
,
2456 struct perf_probe_event
*pev
,
2458 struct strbuf
*result
)
2463 if (asprintf(&buf
, "%s:%s", group
, event
) < 0)
2465 ret
= strbuf_addf(result
, " %-20s (on ", buf
);
2470 /* Synthesize only event probe point */
2471 buf
= synthesize_perf_probe_point(&pev
->point
);
2474 ret
= strbuf_addstr(result
, buf
);
2478 ret
= strbuf_addf(result
, " in %s", module
);
2480 if (!ret
&& pev
->nargs
> 0) {
2481 ret
= strbuf_add(result
, " with", 5);
2482 for (i
= 0; !ret
&& i
< pev
->nargs
; i
++) {
2483 buf
= synthesize_perf_probe_arg(&pev
->args
[i
]);
2486 ret
= strbuf_addf(result
, " %s", buf
);
2491 ret
= strbuf_addch(result
, ')');
2497 int show_perf_probe_event(const char *group
, const char *event
,
2498 struct perf_probe_event
*pev
,
2499 const char *module
, bool use_stdout
)
2501 struct strbuf buf
= STRBUF_INIT
;
2504 ret
= perf_probe_event__sprintf(group
, event
, pev
, module
, &buf
);
2507 printf("%s\n", buf
.buf
);
2509 pr_info("%s\n", buf
.buf
);
2511 strbuf_release(&buf
);
2516 static bool filter_probe_trace_event(struct probe_trace_event
*tev
,
2517 struct strfilter
*filter
)
2521 /* At first, check the event name itself */
2522 if (strfilter__compare(filter
, tev
->event
))
2525 /* Next, check the combination of name and group */
2526 if (e_snprintf(tmp
, 128, "%s:%s", tev
->group
, tev
->event
) < 0)
2528 return strfilter__compare(filter
, tmp
);
2531 static int __show_perf_probe_events(int fd
, bool is_kprobe
,
2532 struct strfilter
*filter
)
2535 struct probe_trace_event tev
;
2536 struct perf_probe_event pev
;
2537 struct strlist
*rawlist
;
2538 struct str_node
*ent
;
2540 memset(&tev
, 0, sizeof(tev
));
2541 memset(&pev
, 0, sizeof(pev
));
2543 rawlist
= probe_file__get_rawlist(fd
);
2547 strlist__for_each_entry(ent
, rawlist
) {
2548 ret
= parse_probe_trace_command(ent
->s
, &tev
);
2550 if (!filter_probe_trace_event(&tev
, filter
))
2552 ret
= convert_to_perf_probe_event(&tev
, &pev
,
2556 ret
= show_perf_probe_event(pev
.group
, pev
.event
,
2557 &pev
, tev
.point
.module
,
2561 clear_perf_probe_event(&pev
);
2562 clear_probe_trace_event(&tev
);
2566 strlist__delete(rawlist
);
2567 /* Cleanup cached debuginfo if needed */
2568 debuginfo_cache__exit();
2573 /* List up current perf-probe events */
2574 int show_perf_probe_events(struct strfilter
*filter
)
2576 int kp_fd
, up_fd
, ret
;
2580 if (probe_conf
.cache
)
2581 return probe_cache__show_all_caches(filter
);
2583 ret
= init_probe_symbol_maps(false);
2587 ret
= probe_file__open_both(&kp_fd
, &up_fd
, 0);
2592 ret
= __show_perf_probe_events(kp_fd
, true, filter
);
2593 if (up_fd
>= 0 && ret
>= 0)
2594 ret
= __show_perf_probe_events(up_fd
, false, filter
);
2599 exit_probe_symbol_maps();
2604 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
2605 struct strlist
*namelist
, bool ret_event
,
2613 nbase
= strdup(base
);
2617 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2618 p
= strpbrk(nbase
, ".@");
2619 if (p
&& p
!= nbase
)
2622 /* Try no suffix number */
2623 ret
= e_snprintf(buf
, len
, "%s%s", nbase
, ret_event
? "__return" : "");
2625 pr_debug("snprintf() failed: %d\n", ret
);
2628 if (!strlist__has_entry(namelist
, buf
))
2631 if (!allow_suffix
) {
2632 pr_warning("Error: event \"%s\" already exists.\n"
2633 " Hint: Remove existing event by 'perf probe -d'\n"
2634 " or force duplicates by 'perf probe -f'\n"
2635 " or set 'force=yes' in BPF source.\n",
2641 /* Try to add suffix */
2642 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
2643 ret
= e_snprintf(buf
, len
, "%s_%d", nbase
, i
);
2645 pr_debug("snprintf() failed: %d\n", ret
);
2648 if (!strlist__has_entry(namelist
, buf
))
2651 if (i
== MAX_EVENT_INDEX
) {
2652 pr_warning("Too many events are on the same function.\n");
2659 /* Final validation */
2660 if (ret
>= 0 && !is_c_func_name(buf
)) {
2661 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2669 /* Warn if the current kernel's uprobe implementation is old */
2670 static void warn_uprobe_event_compat(struct probe_trace_event
*tev
)
2673 char *buf
= synthesize_probe_trace_command(tev
);
2674 struct probe_trace_point
*tp
= &tev
->point
;
2676 if (tp
->ref_ctr_offset
&& !uprobe_ref_ctr_is_supported()) {
2677 pr_warning("A semaphore is associated with %s:%s and "
2678 "seems your kernel doesn't support it.\n",
2679 tev
->group
, tev
->event
);
2682 /* Old uprobe event doesn't support memory dereference */
2683 if (!tev
->uprobes
|| tev
->nargs
== 0 || !buf
)
2686 for (i
= 0; i
< tev
->nargs
; i
++)
2687 if (strglobmatch(tev
->args
[i
].value
, "[$@+-]*")) {
2688 pr_warning("Please upgrade your kernel to at least "
2689 "3.14 to have access to feature %s\n",
2690 tev
->args
[i
].value
);
2697 /* Set new name from original perf_probe_event and namelist */
2698 static int probe_trace_event__set_name(struct probe_trace_event
*tev
,
2699 struct perf_probe_event
*pev
,
2700 struct strlist
*namelist
,
2703 const char *event
, *group
;
2707 /* If probe_event or trace_event already have the name, reuse it */
2708 if (pev
->event
&& !pev
->sdt
)
2710 else if (tev
->event
)
2713 /* Or generate new one from probe point */
2714 if (pev
->point
.function
&&
2715 (strncmp(pev
->point
.function
, "0x", 2) != 0) &&
2716 !strisglob(pev
->point
.function
))
2717 event
= pev
->point
.function
;
2719 event
= tev
->point
.realname
;
2721 if (pev
->group
&& !pev
->sdt
)
2723 else if (tev
->group
)
2726 group
= PERFPROBE_GROUP
;
2728 /* Get an unused new event name */
2729 ret
= get_new_event_name(buf
, 64, event
, namelist
,
2730 tev
->point
.retprobe
, allow_suffix
);
2736 tev
->event
= strdup(event
);
2737 tev
->group
= strdup(group
);
2738 if (tev
->event
== NULL
|| tev
->group
== NULL
)
2742 * Add new event name to namelist if multiprobe event is NOT
2743 * supported, since we have to use new event name for following
2744 * probes in that case.
2746 if (!multiprobe_event_is_supported())
2747 strlist__add(namelist
, event
);
2751 static int __open_probe_file_and_namelist(bool uprobe
,
2752 struct strlist
**namelist
)
2756 fd
= probe_file__open(PF_FL_RW
| (uprobe
? PF_FL_UPROBE
: 0));
2760 /* Get current event names */
2761 *namelist
= probe_file__get_namelist(fd
);
2763 pr_debug("Failed to get current event list.\n");
2770 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
2771 struct probe_trace_event
*tevs
,
2772 int ntevs
, bool allow_suffix
)
2774 int i
, fd
[2] = {-1, -1}, up
, ret
;
2775 struct probe_trace_event
*tev
= NULL
;
2776 struct probe_cache
*cache
= NULL
;
2777 struct strlist
*namelist
[2] = {NULL
, NULL
};
2778 struct nscookie nsc
;
2780 up
= pev
->uprobes
? 1 : 0;
2781 fd
[up
] = __open_probe_file_and_namelist(up
, &namelist
[up
]);
2786 for (i
= 0; i
< ntevs
; i
++) {
2788 up
= tev
->uprobes
? 1 : 0;
2789 if (fd
[up
] == -1) { /* Open the kprobe/uprobe_events */
2790 fd
[up
] = __open_probe_file_and_namelist(up
,
2795 /* Skip if the symbol is out of .text or blacklisted */
2796 if (!tev
->point
.symbol
&& !pev
->uprobes
)
2799 /* Set new name for tev (and update namelist) */
2800 ret
= probe_trace_event__set_name(tev
, pev
, namelist
[up
],
2805 nsinfo__mountns_enter(pev
->nsi
, &nsc
);
2806 ret
= probe_file__add_event(fd
[up
], tev
);
2807 nsinfo__mountns_exit(&nsc
);
2812 * Probes after the first probe which comes from same
2813 * user input are always allowed to add suffix, because
2814 * there might be several addresses corresponding to
2817 allow_suffix
= true;
2819 if (ret
== -EINVAL
&& pev
->uprobes
)
2820 warn_uprobe_event_compat(tev
);
2821 if (ret
== 0 && probe_conf
.cache
) {
2822 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
2824 probe_cache__add_entry(cache
, pev
, tevs
, ntevs
) < 0 ||
2825 probe_cache__commit(cache
) < 0)
2826 pr_warning("Failed to add event to probe cache\n");
2827 probe_cache__delete(cache
);
2831 for (up
= 0; up
< 2; up
++) {
2832 strlist__delete(namelist
[up
]);
2839 static int find_probe_functions(struct map
*map
, char *name
,
2840 struct symbol
**syms
)
2844 struct rb_node
*tmp
;
2845 const char *norm
, *ver
;
2847 bool cut_version
= true;
2849 if (map__load(map
) < 0)
2852 /* If user gives a version, don't cut off the version from symbols */
2853 if (strchr(name
, '@'))
2854 cut_version
= false;
2856 map__for_each_symbol(map
, sym
, tmp
) {
2857 norm
= arch__normalize_symbol_name(sym
->name
);
2862 /* We don't care about default symbol or not */
2863 ver
= strchr(norm
, '@');
2865 buf
= strndup(norm
, ver
- norm
);
2872 if (strglobmatch(norm
, name
)) {
2874 if (syms
&& found
< probe_conf
.max_probes
)
2875 syms
[found
- 1] = sym
;
2884 void __weak
arch__fix_tev_from_maps(struct perf_probe_event
*pev __maybe_unused
,
2885 struct probe_trace_event
*tev __maybe_unused
,
2886 struct map
*map __maybe_unused
,
2887 struct symbol
*sym __maybe_unused
) { }
2890 * Find probe function addresses from map.
2891 * Return an error or the number of found probe_trace_event
2893 static int find_probe_trace_events_from_map(struct perf_probe_event
*pev
,
2894 struct probe_trace_event
**tevs
)
2896 struct map
*map
= NULL
;
2897 struct ref_reloc_sym
*reloc_sym
= NULL
;
2899 struct symbol
**syms
= NULL
;
2900 struct probe_trace_event
*tev
;
2901 struct perf_probe_point
*pp
= &pev
->point
;
2902 struct probe_trace_point
*tp
;
2903 int num_matched_functions
;
2904 int ret
, i
, j
, skipped
= 0;
2907 map
= get_target_map(pev
->target
, pev
->nsi
, pev
->uprobes
);
2913 syms
= malloc(sizeof(struct symbol
*) * probe_conf
.max_probes
);
2920 * Load matched symbols: Since the different local symbols may have
2921 * same name but different addresses, this lists all the symbols.
2923 num_matched_functions
= find_probe_functions(map
, pp
->function
, syms
);
2924 if (num_matched_functions
<= 0) {
2925 pr_err("Failed to find symbol %s in %s\n", pp
->function
,
2926 pev
->target
? : "kernel");
2929 } else if (num_matched_functions
> probe_conf
.max_probes
) {
2930 pr_err("Too many functions matched in %s\n",
2931 pev
->target
? : "kernel");
2936 /* Note that the symbols in the kmodule are not relocated */
2937 if (!pev
->uprobes
&& !pev
->target
&&
2938 (!pp
->retprobe
|| kretprobe_offset_is_supported())) {
2939 reloc_sym
= kernel_get_ref_reloc_sym();
2941 pr_warning("Relocated base symbol is not found!\n");
2947 /* Setup result trace-probe-events */
2948 *tevs
= zalloc(sizeof(*tev
) * num_matched_functions
);
2956 for (j
= 0; j
< num_matched_functions
; j
++) {
2959 tev
= (*tevs
) + ret
;
2961 if (ret
== num_matched_functions
) {
2962 pr_warning("Too many symbols are listed. Skip it.\n");
2967 if (pp
->offset
> sym
->end
- sym
->start
) {
2968 pr_warning("Offset %ld is bigger than the size of %s\n",
2969 pp
->offset
, sym
->name
);
2973 /* Add one probe point */
2974 tp
->address
= map
->unmap_ip(map
, sym
->start
) + pp
->offset
;
2976 /* Check the kprobe (not in module) is within .text */
2977 if (!pev
->uprobes
&& !pev
->target
&&
2978 kprobe_warn_out_range(sym
->name
, tp
->address
)) {
2979 tp
->symbol
= NULL
; /* Skip it */
2981 } else if (reloc_sym
) {
2982 tp
->symbol
= strdup_or_goto(reloc_sym
->name
, nomem_out
);
2983 tp
->offset
= tp
->address
- reloc_sym
->addr
;
2985 tp
->symbol
= strdup_or_goto(sym
->name
, nomem_out
);
2986 tp
->offset
= pp
->offset
;
2988 tp
->realname
= strdup_or_goto(sym
->name
, nomem_out
);
2990 tp
->retprobe
= pp
->retprobe
;
2993 tev
->point
.module
= strdup_or_goto(pev
->target
,
2996 mod_name
= find_module_name(pev
->target
);
2998 strdup(mod_name
? mod_name
: pev
->target
);
3000 if (!tev
->point
.module
)
3004 tev
->uprobes
= pev
->uprobes
;
3005 tev
->nargs
= pev
->nargs
;
3007 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) *
3009 if (tev
->args
== NULL
)
3012 for (i
= 0; i
< tev
->nargs
; i
++) {
3013 if (pev
->args
[i
].name
)
3015 strdup_or_goto(pev
->args
[i
].name
,
3018 tev
->args
[i
].value
= strdup_or_goto(pev
->args
[i
].var
,
3020 if (pev
->args
[i
].type
)
3022 strdup_or_goto(pev
->args
[i
].type
,
3025 arch__fix_tev_from_maps(pev
, tev
, map
, sym
);
3027 if (ret
== skipped
) {
3040 clear_probe_trace_events(*tevs
, num_matched_functions
);
3045 static int try_to_find_absolute_address(struct perf_probe_event
*pev
,
3046 struct probe_trace_event
**tevs
)
3048 struct perf_probe_point
*pp
= &pev
->point
;
3049 struct probe_trace_event
*tev
;
3050 struct probe_trace_point
*tp
;
3053 if (!(pev
->point
.function
&& !strncmp(pev
->point
.function
, "0x", 2)))
3055 if (perf_probe_event_need_dwarf(pev
))
3059 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3062 * Only one tev can be generated by this.
3064 *tevs
= zalloc(sizeof(*tev
));
3072 * Don't use tp->offset, use address directly, because
3073 * in synthesize_probe_trace_command() address cannot be
3076 tp
->address
= pev
->point
.abs_address
;
3077 tp
->retprobe
= pp
->retprobe
;
3078 tev
->uprobes
= pev
->uprobes
;
3082 * Give it a '0x' leading symbol name.
3083 * In __add_probe_trace_events, a NULL symbol is interpreted as
3086 if (asprintf(&tp
->symbol
, "0x%lx", tp
->address
) < 0)
3089 /* For kprobe, check range */
3090 if ((!tev
->uprobes
) &&
3091 (kprobe_warn_out_range(tev
->point
.symbol
,
3092 tev
->point
.address
))) {
3097 if (asprintf(&tp
->realname
, "abs_%lx", tp
->address
) < 0)
3101 tp
->module
= strdup(pev
->target
);
3107 tev
->group
= strdup(pev
->group
);
3113 tev
->event
= strdup(pev
->event
);
3118 tev
->nargs
= pev
->nargs
;
3119 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
3123 for (i
= 0; i
< tev
->nargs
; i
++)
3124 copy_to_probe_trace_arg(&tev
->args
[i
], &pev
->args
[i
]);
3129 clear_probe_trace_events(*tevs
, 1);
3134 /* Concatinate two arrays */
3135 static void *memcat(void *a
, size_t sz_a
, void *b
, size_t sz_b
)
3139 ret
= malloc(sz_a
+ sz_b
);
3141 memcpy(ret
, a
, sz_a
);
3142 memcpy(ret
+ sz_a
, b
, sz_b
);
3148 concat_probe_trace_events(struct probe_trace_event
**tevs
, int *ntevs
,
3149 struct probe_trace_event
**tevs2
, int ntevs2
)
3151 struct probe_trace_event
*new_tevs
;
3161 if (*ntevs
+ ntevs2
> probe_conf
.max_probes
)
3164 /* Concatinate the array of probe_trace_event */
3165 new_tevs
= memcat(*tevs
, (*ntevs
) * sizeof(**tevs
),
3166 *tevs2
, ntevs2
* sizeof(**tevs2
));
3176 clear_probe_trace_events(*tevs2
, ntevs2
);
3183 * Try to find probe_trace_event from given probe caches. Return the number
3184 * of cached events found, if an error occurs return the error.
3186 static int find_cached_events(struct perf_probe_event
*pev
,
3187 struct probe_trace_event
**tevs
,
3190 struct probe_cache
*cache
;
3191 struct probe_cache_entry
*entry
;
3192 struct probe_trace_event
*tmp_tevs
= NULL
;
3196 cache
= probe_cache__new(target
, pev
->nsi
);
3197 /* Return 0 ("not found") if the target has no probe cache. */
3201 for_each_probe_cache_entry(entry
, cache
) {
3202 /* Skip the cache entry which has no name */
3203 if (!entry
->pev
.event
|| !entry
->pev
.group
)
3205 if ((!pev
->group
|| strglobmatch(entry
->pev
.group
, pev
->group
)) &&
3206 strglobmatch(entry
->pev
.event
, pev
->event
)) {
3207 ret
= probe_cache_entry__get_event(entry
, &tmp_tevs
);
3209 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3215 probe_cache__delete(cache
);
3217 clear_probe_trace_events(*tevs
, ntevs
);
3221 if (ntevs
> 0 && target
&& target
[0] == '/')
3222 pev
->uprobes
= true;
3228 /* Try to find probe_trace_event from all probe caches */
3229 static int find_cached_events_all(struct perf_probe_event
*pev
,
3230 struct probe_trace_event
**tevs
)
3232 struct probe_trace_event
*tmp_tevs
= NULL
;
3233 struct strlist
*bidlist
;
3234 struct str_node
*nd
;
3239 /* Get the buildid list of all valid caches */
3240 bidlist
= build_id_cache__list_all(true);
3243 pr_debug("Failed to get buildids: %d\n", ret
);
3248 strlist__for_each_entry(nd
, bidlist
) {
3249 pathname
= build_id_cache__origname(nd
->s
);
3250 ret
= find_cached_events(pev
, &tmp_tevs
, pathname
);
3251 /* In the case of cnt == 0, we just skip it */
3253 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3259 strlist__delete(bidlist
);
3262 clear_probe_trace_events(*tevs
, ntevs
);
3270 static int find_probe_trace_events_from_cache(struct perf_probe_event
*pev
,
3271 struct probe_trace_event
**tevs
)
3273 struct probe_cache
*cache
;
3274 struct probe_cache_entry
*entry
;
3275 struct probe_trace_event
*tev
;
3276 struct str_node
*node
;
3280 /* For SDT/cached events, we use special search functions */
3282 return find_cached_events_all(pev
, tevs
);
3284 return find_cached_events(pev
, tevs
, pev
->target
);
3286 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
3290 entry
= probe_cache__find(cache
, pev
);
3292 /* SDT must be in the cache */
3293 ret
= pev
->sdt
? -ENOENT
: 0;
3297 ret
= strlist__nr_entries(entry
->tevlist
);
3298 if (ret
> probe_conf
.max_probes
) {
3299 pr_debug("Too many entries matched in the cache of %s\n",
3300 pev
->target
? : "kernel");
3305 *tevs
= zalloc(ret
* sizeof(*tev
));
3312 strlist__for_each_entry(node
, entry
->tevlist
) {
3313 tev
= &(*tevs
)[i
++];
3314 ret
= parse_probe_trace_command(node
->s
, tev
);
3317 /* Set the uprobes attribute as same as original */
3318 tev
->uprobes
= pev
->uprobes
;
3323 probe_cache__delete(cache
);
3327 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
3328 struct probe_trace_event
**tevs
)
3332 if (!pev
->group
&& !pev
->sdt
) {
3333 /* Set group name if not given */
3334 if (!pev
->uprobes
) {
3335 pev
->group
= strdup(PERFPROBE_GROUP
);
3336 ret
= pev
->group
? 0 : -ENOMEM
;
3338 ret
= convert_exec_to_group(pev
->target
, &pev
->group
);
3340 pr_warning("Failed to make a group name.\n");
3345 ret
= try_to_find_absolute_address(pev
, tevs
);
3349 /* At first, we need to lookup cache entry */
3350 ret
= find_probe_trace_events_from_cache(pev
, tevs
);
3351 if (ret
> 0 || pev
->sdt
) /* SDT can be found only in the cache */
3352 return ret
== 0 ? -ENOENT
: ret
; /* Found in probe cache */
3354 /* Convert perf_probe_event with debuginfo */
3355 ret
= try_to_find_probe_trace_events(pev
, tevs
);
3357 return ret
; /* Found in debuginfo or got an error */
3359 return find_probe_trace_events_from_map(pev
, tevs
);
3362 int convert_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3366 /* Loop 1: convert all events */
3367 for (i
= 0; i
< npevs
; i
++) {
3368 /* Init kprobe blacklist if needed */
3369 if (!pevs
[i
].uprobes
)
3370 kprobe_blacklist__init();
3371 /* Convert with or without debuginfo */
3372 ret
= convert_to_probe_trace_events(&pevs
[i
], &pevs
[i
].tevs
);
3375 pevs
[i
].ntevs
= ret
;
3377 /* This just release blacklist only if allocated */
3378 kprobe_blacklist__release();
3383 static int show_probe_trace_event(struct probe_trace_event
*tev
)
3385 char *buf
= synthesize_probe_trace_command(tev
);
3388 pr_debug("Failed to synthesize probe trace event.\n");
3392 /* Showing definition always go stdout */
3393 printf("%s\n", buf
);
3399 int show_probe_trace_events(struct perf_probe_event
*pevs
, int npevs
)
3401 struct strlist
*namelist
= strlist__new(NULL
, NULL
);
3402 struct probe_trace_event
*tev
;
3403 struct perf_probe_event
*pev
;
3409 for (j
= 0; j
< npevs
&& !ret
; j
++) {
3411 for (i
= 0; i
< pev
->ntevs
&& !ret
; i
++) {
3412 tev
= &pev
->tevs
[i
];
3413 /* Skip if the symbol is out of .text or blacklisted */
3414 if (!tev
->point
.symbol
&& !pev
->uprobes
)
3417 /* Set new name for tev (and update namelist) */
3418 ret
= probe_trace_event__set_name(tev
, pev
,
3421 ret
= show_probe_trace_event(tev
);
3424 strlist__delete(namelist
);
3429 int apply_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3433 /* Loop 2: add all events */
3434 for (i
= 0; i
< npevs
; i
++) {
3435 ret
= __add_probe_trace_events(&pevs
[i
], pevs
[i
].tevs
,
3437 probe_conf
.force_add
);
3444 void cleanup_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3447 struct perf_probe_event
*pev
;
3449 /* Loop 3: cleanup and free trace events */
3450 for (i
= 0; i
< npevs
; i
++) {
3452 for (j
= 0; j
< pevs
[i
].ntevs
; j
++)
3453 clear_probe_trace_event(&pevs
[i
].tevs
[j
]);
3454 zfree(&pevs
[i
].tevs
);
3456 nsinfo__zput(pev
->nsi
);
3457 clear_perf_probe_event(&pevs
[i
]);
3461 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3465 ret
= init_probe_symbol_maps(pevs
->uprobes
);
3469 ret
= convert_perf_probe_events(pevs
, npevs
);
3471 ret
= apply_perf_probe_events(pevs
, npevs
);
3473 cleanup_perf_probe_events(pevs
, npevs
);
3475 exit_probe_symbol_maps();
3479 int del_perf_probe_events(struct strfilter
*filter
)
3481 int ret
, ret2
, ufd
= -1, kfd
= -1;
3482 char *str
= strfilter__string(filter
);
3487 /* Get current event names */
3488 ret
= probe_file__open_both(&kfd
, &ufd
, PF_FL_RW
);
3492 ret
= probe_file__del_events(kfd
, filter
);
3493 if (ret
< 0 && ret
!= -ENOENT
)
3496 ret2
= probe_file__del_events(ufd
, filter
);
3497 if (ret2
< 0 && ret2
!= -ENOENT
) {
3514 int show_available_funcs(const char *target
, struct nsinfo
*nsi
,
3515 struct strfilter
*_filter
, bool user
)
3521 ret
= init_probe_symbol_maps(user
);
3525 /* Get a symbol map */
3526 map
= get_target_map(target
, nsi
, user
);
3528 pr_err("Failed to get a map for %s\n", (target
) ? : "kernel");
3532 ret
= map__load(map
);
3535 char *str
= strfilter__string(_filter
);
3536 pr_err("Failed to find symbols matched to \"%s\"\n",
3540 pr_err("Failed to load symbols in %s\n",
3541 (target
) ? : "kernel");
3544 if (!dso__sorted_by_name(map
->dso
))
3545 dso__sort_by_name(map
->dso
);
3547 /* Show all (filtered) symbols */
3550 for (nd
= rb_first_cached(&map
->dso
->symbol_names
); nd
;
3552 struct symbol_name_rb_node
*pos
= rb_entry(nd
, struct symbol_name_rb_node
, rb_node
);
3554 if (strfilter__compare(_filter
, pos
->sym
.name
))
3555 printf("%s\n", pos
->sym
.name
);
3559 exit_probe_symbol_maps();
3564 int copy_to_probe_trace_arg(struct probe_trace_arg
*tvar
,
3565 struct perf_probe_arg
*pvar
)
3567 tvar
->value
= strdup(pvar
->var
);
3568 if (tvar
->value
== NULL
)
3571 tvar
->type
= strdup(pvar
->type
);
3572 if (tvar
->type
== NULL
)
3576 tvar
->name
= strdup(pvar
->name
);
3577 if (tvar
->name
== NULL
)