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>
25 #include "namespaces.h"
27 #include "strfilter.h"
35 #include <api/fs/fs.h>
36 #include "trace-event.h" /* For __maybe_unused */
37 #include "probe-event.h"
38 #include "probe-finder.h"
39 #include "probe-file.h"
43 #include "parse-events.h"
45 #include <subcmd/pager.h>
46 #include <linux/ctype.h>
47 #include <linux/zalloc.h>
49 #ifdef HAVE_DEBUGINFOD_SUPPORT
50 #include <elfutils/debuginfod.h>
53 #define PERFPROBE_GROUP "probe"
55 /* Defined in kernel/trace/trace.h */
56 #define MAX_EVENT_NAME_LEN 64
58 bool probe_event_dry_run
; /* Dry run flag */
59 struct probe_conf probe_conf
= { .magic_num
= DEFAULT_PROBE_MAGIC_NUM
};
61 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
);
63 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
65 int e_snprintf(char *str
, size_t size
, const char *format
, ...)
70 ret
= vsnprintf(str
, size
, format
, ap
);
77 static struct machine
*host_machine
;
79 /* Initialize symbol maps and path of vmlinux/modules */
80 int init_probe_symbol_maps(bool user_only
)
84 symbol_conf
.allow_aliases
= true;
85 ret
= symbol__init(NULL
);
87 pr_debug("Failed to init symbol map.\n");
91 if (host_machine
|| user_only
) /* already initialized */
94 if (symbol_conf
.vmlinux_name
)
95 pr_debug("Use vmlinux: %s\n", symbol_conf
.vmlinux_name
);
97 host_machine
= machine__new_host();
99 pr_debug("machine__new_host() failed.\n");
105 pr_warning("Failed to init vmlinux path.\n");
109 void exit_probe_symbol_maps(void)
111 machine__delete(host_machine
);
116 static struct ref_reloc_sym
*kernel_get_ref_reloc_sym(struct map
**pmap
)
119 struct map
*map
= machine__kernel_map(host_machine
);
121 if (map__load(map
) < 0)
124 kmap
= map__kmap(map
);
131 return kmap
->ref_reloc_sym
;
134 static int kernel_get_symbol_address_by_name(const char *name
, u64
*addr
,
135 bool reloc
, bool reladdr
)
137 struct ref_reloc_sym
*reloc_sym
;
141 /* ref_reloc_sym is just a label. Need a special fix*/
142 reloc_sym
= kernel_get_ref_reloc_sym(&map
);
143 if (reloc_sym
&& strcmp(name
, reloc_sym
->name
) == 0)
144 *addr
= (!map__reloc(map
) || reloc
) ? reloc_sym
->addr
:
145 reloc_sym
->unrelocated_addr
;
147 sym
= machine__find_kernel_symbol_by_name(host_machine
, name
, &map
);
150 *addr
= map__unmap_ip(map
, sym
->start
) -
151 ((reloc
) ? 0 : map__reloc(map
)) -
152 ((reladdr
) ? map__start(map
) : 0);
157 struct kernel_get_module_map_cb_args
{
162 static int kernel_get_module_map_cb(struct map
*map
, void *data
)
164 struct kernel_get_module_map_cb_args
*args
= data
;
165 struct dso
*dso
= map__dso(map
);
166 const char *short_name
= dso__short_name(dso
);
167 u16 short_name_len
= dso__short_name_len(dso
);
169 if (strncmp(short_name
+ 1, args
->module
, short_name_len
- 2) == 0 &&
170 args
->module
[short_name_len
- 2] == '\0') {
171 args
->result
= map__get(map
);
177 static struct map
*kernel_get_module_map(const char *module
)
179 struct kernel_get_module_map_cb_args args
= {
184 /* A file path -- this is an offline module */
185 if (module
&& strchr(module
, '/'))
186 return dso__new_map(module
);
189 struct map
*map
= machine__kernel_map(host_machine
);
191 return map__get(map
);
194 maps__for_each_map(machine__kernel_maps(host_machine
), kernel_get_module_map_cb
, &args
);
199 struct map
*get_target_map(const char *target
, struct nsinfo
*nsi
, bool user
)
201 /* Init maps of given executable or kernel */
206 map
= dso__new_map(target
);
207 dso
= map
? map__dso(map
) : NULL
;
209 mutex_lock(dso__lock(dso
));
210 dso__set_nsinfo(dso
, nsinfo__get(nsi
));
211 mutex_unlock(dso__lock(dso
));
215 return kernel_get_module_map(target
);
219 static int convert_exec_to_group(const char *exec
, char **result
)
221 char *ptr1
, *ptr2
, *exec_copy
;
225 exec_copy
= strdup(exec
);
229 ptr1
= basename(exec_copy
);
235 for (ptr2
= ptr1
; *ptr2
!= '\0'; ptr2
++) {
236 if (!isalnum(*ptr2
) && *ptr2
!= '_') {
242 ret
= e_snprintf(buf
, sizeof(buf
), "%s_%s", PERFPROBE_GROUP
, ptr1
);
246 *result
= strdup(buf
);
247 ret
= *result
? 0 : -ENOMEM
;
254 static void clear_perf_probe_point(struct perf_probe_point
*pp
)
257 zfree(&pp
->function
);
258 zfree(&pp
->lazy_line
);
261 static void clear_probe_trace_events(struct probe_trace_event
*tevs
, int ntevs
)
265 for (i
= 0; i
< ntevs
; i
++)
266 clear_probe_trace_event(tevs
+ i
);
269 static bool kprobe_blacklist__listed(u64 address
);
270 static bool kprobe_warn_out_range(const char *symbol
, u64 address
)
275 map
= kernel_get_module_map(NULL
);
277 ret
= address
<= map__start(map
) || map__end(map
) < address
;
279 pr_warning("%s is out of .text, skip it.\n", symbol
);
282 if (!ret
&& kprobe_blacklist__listed(address
)) {
283 pr_warning("%s is blacklisted function, skip it.\n", symbol
);
291 * @module can be module name of module file path. In case of path,
292 * inspect elf and find out what is actual module name.
293 * Caller has to free mod_name after using it.
295 static char *find_module_name(const char *module
)
303 char *mod_name
= NULL
;
306 fd
= open(module
, O_RDONLY
);
310 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
314 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
317 sec
= elf_section_by_name(elf
, &ehdr
, &shdr
,
318 ".gnu.linkonce.this_module", NULL
);
322 data
= elf_getdata(sec
, NULL
);
323 if (!data
|| !data
->d_buf
)
328 * '.gnu.linkonce.this_module' section of kernel module elf directly
329 * maps to 'struct module' from linux/module.h. This section contains
330 * actual module name which will be used by kernel after loading it.
331 * But, we cannot use 'struct module' here since linux/module.h is not
332 * exposed to user-space. Offset of 'name' has remained same from long
333 * time, so hardcoding it here.
335 if (ehdr
.e_ident
[EI_CLASS
] == ELFCLASS32
)
337 else /* expect ELFCLASS64 by default */
340 mod_name
= strdup((char *)data
->d_buf
+ name_offset
);
349 #ifdef HAVE_LIBDW_SUPPORT
351 static int kernel_get_module_dso(const char *module
, struct dso
**pdso
)
355 const char *vmlinux_name
;
359 char module_name
[128];
361 snprintf(module_name
, sizeof(module_name
), "[%s]", module
);
362 map
= maps__find_by_name(machine__kernel_maps(host_machine
), module_name
);
368 pr_debug("Failed to find module %s.\n", module
);
372 map
= machine__kernel_map(host_machine
);
374 if (!dso__has_build_id(dso
))
375 dso__read_running_kernel_build_id(dso
, host_machine
);
377 vmlinux_name
= symbol_conf
.vmlinux_name
;
378 *dso__load_errno(dso
) = 0;
380 ret
= dso__load_vmlinux(dso
, map
, vmlinux_name
, false);
382 ret
= dso__load_vmlinux_path(dso
, map
);
389 * Some binaries like glibc have special symbols which are on the symbol
390 * table, but not in the debuginfo. If we can find the address of the
391 * symbol from map, we can translate the address back to the probe point.
393 static int find_alternative_probe_point(struct debuginfo
*dinfo
,
394 struct perf_probe_point
*pp
,
395 struct perf_probe_point
*result
,
396 const char *target
, struct nsinfo
*nsi
,
399 struct map
*map
= NULL
;
405 /* This can work only for function-name based one */
406 if (!pp
->function
|| pp
->file
)
409 map
= get_target_map(target
, nsi
, uprobes
);
413 /* Find the address of given function */
414 map__for_each_symbol_by_name(map
, pp
->function
, sym
, idx
) {
416 address
= sym
->start
;
417 if (sym
->type
== STT_GNU_IFUNC
)
418 pr_warning("Warning: The probe function (%s) is a GNU indirect function.\n"
419 "Consider identifying the final function used at run time and set the probe directly on that.\n",
422 address
= map__unmap_ip(map
, sym
->start
) - map__reloc(map
);
429 pr_debug("Symbol %s address found : %" PRIx64
"\n",
430 pp
->function
, address
);
432 ret
= debuginfo__find_probe_point(dinfo
, address
, result
);
434 ret
= (!ret
) ? -ENOENT
: ret
;
436 result
->offset
+= pp
->offset
;
437 result
->line
+= pp
->line
;
438 result
->retprobe
= pp
->retprobe
;
448 static int get_alternative_probe_event(struct debuginfo
*dinfo
,
449 struct perf_probe_event
*pev
,
450 struct perf_probe_point
*tmp
)
454 memcpy(tmp
, &pev
->point
, sizeof(*tmp
));
455 memset(&pev
->point
, 0, sizeof(pev
->point
));
456 ret
= find_alternative_probe_point(dinfo
, tmp
, &pev
->point
, pev
->target
,
457 pev
->nsi
, pev
->uprobes
);
459 memcpy(&pev
->point
, tmp
, sizeof(*tmp
));
464 static int get_alternative_line_range(struct debuginfo
*dinfo
,
465 struct line_range
*lr
,
466 const char *target
, bool user
)
468 struct perf_probe_point pp
= { .function
= lr
->function
,
471 struct perf_probe_point result
;
474 memset(&result
, 0, sizeof(result
));
476 if (lr
->end
!= INT_MAX
)
477 len
= lr
->end
- lr
->start
;
478 ret
= find_alternative_probe_point(dinfo
, &pp
, &result
,
481 lr
->function
= result
.function
;
482 lr
->file
= result
.file
;
483 lr
->start
= result
.line
;
484 if (lr
->end
!= INT_MAX
)
485 lr
->end
= lr
->start
+ len
;
486 clear_perf_probe_point(&pp
);
491 #ifdef HAVE_DEBUGINFOD_SUPPORT
492 static struct debuginfo
*open_from_debuginfod(struct dso
*dso
, struct nsinfo
*nsi
,
495 debuginfod_client
*c
= debuginfod_begin();
496 char sbuild_id
[SBUILD_ID_SIZE
+ 1];
497 struct debuginfo
*ret
= NULL
;
505 build_id__sprintf(dso__bid(dso
), sbuild_id
);
506 fd
= debuginfod_find_debuginfo(c
, (const unsigned char *)sbuild_id
,
513 pr_debug("Failed to find debuginfo in debuginfod.\n");
517 pr_debug("Load debuginfo from debuginfod (%s)\n", path
);
519 nsinfo__mountns_enter(nsi
, &nsc
);
520 ret
= debuginfo__new((const char *)path
);
521 nsinfo__mountns_exit(&nsc
);
526 struct debuginfo
*open_from_debuginfod(struct dso
*dso __maybe_unused
,
527 struct nsinfo
*nsi __maybe_unused
,
528 bool silent __maybe_unused
)
534 /* Open new debuginfo of given module */
535 static struct debuginfo
*open_debuginfo(const char *module
, struct nsinfo
*nsi
,
538 const char *path
= module
;
539 char reason
[STRERR_BUFSIZE
];
540 struct debuginfo
*ret
= NULL
;
541 struct dso
*dso
= NULL
;
545 if (!module
|| !strchr(module
, '/')) {
546 err
= kernel_get_module_dso(module
, &dso
);
548 if (!dso
|| *dso__load_errno(dso
) == 0) {
549 if (!str_error_r(-err
, reason
, STRERR_BUFSIZE
))
550 strcpy(reason
, "(unknown)");
552 dso__strerror_load(dso
, reason
, STRERR_BUFSIZE
);
554 ret
= open_from_debuginfod(dso
, nsi
, silent
);
559 pr_err("Module %s is not loaded, please specify its full path name.\n", module
);
561 pr_err("Failed to find the path for the kernel: %s\n", reason
);
565 path
= dso__long_name(dso
);
567 nsinfo__mountns_enter(nsi
, &nsc
);
568 ret
= debuginfo__new(path
);
569 if (!ret
&& !silent
) {
570 pr_warning("The %s file has no debug information.\n", path
);
571 if (!module
|| !strtailcmp(path
, ".ko"))
572 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
574 pr_warning("Rebuild with -g, ");
575 pr_warning("or install an appropriate debuginfo package.\n");
577 nsinfo__mountns_exit(&nsc
);
581 /* For caching the last debuginfo */
582 static struct debuginfo
*debuginfo_cache
;
583 static char *debuginfo_cache_path
;
585 static struct debuginfo
*debuginfo_cache__open(const char *module
, bool silent
)
587 const char *path
= module
;
589 /* If the module is NULL, it should be the kernel. */
593 if (debuginfo_cache_path
&& !strcmp(debuginfo_cache_path
, path
))
596 /* Copy module path */
597 free(debuginfo_cache_path
);
598 debuginfo_cache_path
= strdup(path
);
599 if (!debuginfo_cache_path
) {
600 debuginfo__delete(debuginfo_cache
);
601 debuginfo_cache
= NULL
;
605 debuginfo_cache
= open_debuginfo(module
, NULL
, silent
);
606 if (!debuginfo_cache
)
607 zfree(&debuginfo_cache_path
);
609 return debuginfo_cache
;
612 static void debuginfo_cache__exit(void)
614 debuginfo__delete(debuginfo_cache
);
615 debuginfo_cache
= NULL
;
616 zfree(&debuginfo_cache_path
);
620 static int get_text_start_address(const char *exec
, u64
*address
,
626 int fd
, ret
= -ENOENT
;
629 nsinfo__mountns_enter(nsi
, &nsc
);
630 fd
= open(exec
, O_RDONLY
);
631 nsinfo__mountns_exit(&nsc
);
635 elf
= elf_begin(fd
, PERF_ELF_C_READ_MMAP
, NULL
);
641 if (gelf_getehdr(elf
, &ehdr
) == NULL
)
644 if (!elf_section_by_name(elf
, &ehdr
, &shdr
, ".text", NULL
))
647 *address
= shdr
.sh_addr
- shdr
.sh_offset
;
658 * Convert trace point to probe point with debuginfo
660 static int find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp
,
661 struct perf_probe_point
*pp
,
664 struct debuginfo
*dinfo
= NULL
;
666 u64 addr
= tp
->address
;
669 /* convert the address to dwarf address */
675 ret
= get_text_start_address(tp
->module
, &stext
, NULL
);
679 } else if (tp
->symbol
) {
680 /* If the module is given, this returns relative address */
681 ret
= kernel_get_symbol_address_by_name(tp
->symbol
, &addr
,
682 false, !!tp
->module
);
688 pr_debug("try to find information at %" PRIx64
" in %s\n", addr
,
689 tp
->module
? : "kernel");
691 dinfo
= debuginfo_cache__open(tp
->module
, verbose
<= 0);
693 ret
= debuginfo__find_probe_point(dinfo
, addr
, pp
);
698 pp
->retprobe
= tp
->retprobe
;
702 pr_debug("Failed to find corresponding probes from debuginfo.\n");
703 return ret
? : -ENOENT
;
706 /* Adjust symbol name and address */
707 static int post_process_probe_trace_point(struct probe_trace_point
*tp
,
708 struct map
*map
, u64 offs
)
711 u64 addr
= tp
->address
- offs
;
713 sym
= map__find_symbol(map
, addr
);
716 * If the address is in the inittext section, map can not
717 * find it. Ignore it if we are probing offline kernel.
719 return (symbol_conf
.ignore_vmlinux_buildid
) ? 0 : -ENOENT
;
722 if (strcmp(sym
->name
, tp
->symbol
)) {
723 /* If we have no realname, use symbol for it */
725 tp
->realname
= tp
->symbol
;
728 tp
->symbol
= strdup(sym
->name
);
732 tp
->offset
= addr
- sym
->start
;
739 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
740 * and generate new symbols with suffixes such as .constprop.N or .isra.N
741 * etc. Since those symbols are not recorded in DWARF, we have to find
742 * correct generated symbols from offline ELF binary.
743 * For online kernel or uprobes we don't need this because those are
744 * rebased on _text, or already a section relative address.
747 post_process_offline_probe_trace_events(struct probe_trace_event
*tevs
,
748 int ntevs
, const char *pathname
)
754 /* Prepare a map for offline binary */
755 map
= dso__new_map(pathname
);
756 if (!map
|| get_text_start_address(pathname
, &stext
, NULL
) < 0) {
757 pr_warning("Failed to get ELF symbols for %s\n", pathname
);
761 for (i
= 0; i
< ntevs
; i
++) {
762 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
772 static int add_exec_to_probe_trace_events(struct probe_trace_event
*tevs
,
773 int ntevs
, const char *exec
,
782 ret
= get_text_start_address(exec
, &stext
, nsi
);
786 for (i
= 0; i
< ntevs
&& ret
>= 0; i
++) {
787 /* point.address is the address of point.symbol + point.offset */
788 tevs
[i
].point
.address
-= stext
;
789 tevs
[i
].point
.module
= strdup(exec
);
790 if (!tevs
[i
].point
.module
) {
794 tevs
[i
].uprobes
= true;
801 post_process_module_probe_trace_events(struct probe_trace_event
*tevs
,
802 int ntevs
, const char *module
,
803 struct debuginfo
*dinfo
)
805 Dwarf_Addr text_offs
= 0;
807 char *mod_name
= NULL
;
813 map
= get_target_map(module
, NULL
, false);
814 if (!map
|| debuginfo__get_text_offset(dinfo
, &text_offs
, true) < 0) {
815 pr_warning("Failed to get ELF symbols for %s\n", module
);
819 mod_name
= find_module_name(module
);
820 for (i
= 0; i
< ntevs
; i
++) {
821 ret
= post_process_probe_trace_point(&tevs
[i
].point
,
825 tevs
[i
].point
.module
=
826 strdup(mod_name
? mod_name
: module
);
827 if (!tevs
[i
].point
.module
) {
840 post_process_kernel_probe_trace_events(struct probe_trace_event
*tevs
,
843 struct ref_reloc_sym
*reloc_sym
;
848 /* Skip post process if the target is an offline kernel */
849 if (symbol_conf
.ignore_vmlinux_buildid
)
850 return post_process_offline_probe_trace_events(tevs
, ntevs
,
851 symbol_conf
.vmlinux_name
);
853 reloc_sym
= kernel_get_ref_reloc_sym(&map
);
855 pr_warning("Relocated base symbol is not found! "
856 "Check /proc/sys/kernel/kptr_restrict\n"
857 "and /proc/sys/kernel/perf_event_paranoid. "
858 "Or run as privileged perf user.\n\n");
862 for (i
= 0; i
< ntevs
; i
++) {
863 if (!tevs
[i
].point
.address
)
865 if (tevs
[i
].point
.retprobe
&& !kretprobe_offset_is_supported())
868 * If we found a wrong one, mark it by NULL symbol.
869 * Since addresses in debuginfo is same as objdump, we need
870 * to convert it to addresses on memory.
872 if (kprobe_warn_out_range(tevs
[i
].point
.symbol
,
873 map__objdump_2mem(map
, tevs
[i
].point
.address
))) {
877 tmp
= strdup(reloc_sym
->name
);
881 /* If we have no realname, use symbol for it */
882 if (!tevs
[i
].point
.realname
)
883 tevs
[i
].point
.realname
= tevs
[i
].point
.symbol
;
885 free(tevs
[i
].point
.symbol
);
886 tevs
[i
].point
.symbol
= tmp
;
887 tevs
[i
].point
.offset
= tevs
[i
].point
.address
-
888 (map__reloc(map
) ? reloc_sym
->unrelocated_addr
:
895 arch__post_process_probe_trace_events(struct perf_probe_event
*pev __maybe_unused
,
896 int ntevs __maybe_unused
)
900 /* Post processing the probe events */
901 static int post_process_probe_trace_events(struct perf_probe_event
*pev
,
902 struct probe_trace_event
*tevs
,
903 int ntevs
, const char *module
,
904 bool uprobe
, struct debuginfo
*dinfo
)
909 ret
= add_exec_to_probe_trace_events(tevs
, ntevs
, module
,
912 /* Currently ref_reloc_sym based probe is not for drivers */
913 ret
= post_process_module_probe_trace_events(tevs
, ntevs
,
916 ret
= post_process_kernel_probe_trace_events(tevs
, ntevs
);
919 arch__post_process_probe_trace_events(pev
, ntevs
);
924 /* Try to find perf_probe_event with debuginfo */
925 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
926 struct probe_trace_event
**tevs
)
928 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
929 struct perf_probe_point tmp
;
930 struct debuginfo
*dinfo
;
933 /* Workaround for gcc #98776 issue.
934 * Perf failed to add kretprobe event with debuginfo of vmlinux which is
935 * compiled by gcc with -fpatchable-function-entry option enabled. The
936 * same issue with kernel module. The retprobe doesn`t need debuginfo.
937 * This workaround solution use map to query the probe function address
938 * for retprobe event.
940 if (pev
->point
.retprobe
)
943 dinfo
= open_debuginfo(pev
->target
, pev
->nsi
, !need_dwarf
);
947 pr_debug("Could not open debuginfo. Try to use symbols.\n");
951 pr_debug("Try to find probe point from debuginfo.\n");
952 /* Searching trace events corresponding to a probe event */
953 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
955 if (ntevs
== 0) { /* Not found, retry with an alternative */
956 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
958 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
);
960 * Write back to the original probe_event for
961 * setting appropriate (user given) event name
963 clear_perf_probe_point(&pev
->point
);
964 memcpy(&pev
->point
, &tmp
, sizeof(tmp
));
968 if (ntevs
> 0) { /* Succeeded to find trace events */
969 pr_debug("Found %d probe_trace_events.\n", ntevs
);
970 ret
= post_process_probe_trace_events(pev
, *tevs
, ntevs
,
971 pev
->target
, pev
->uprobes
, dinfo
);
972 if (ret
< 0 || ret
== ntevs
) {
973 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret
);
974 clear_probe_trace_events(*tevs
, ntevs
);
980 debuginfo__delete(dinfo
);
982 if (ntevs
== 0) { /* No error but failed to find probe point. */
983 char *probe_point
= synthesize_perf_probe_point(&pev
->point
);
984 pr_warning("Probe point '%s' not found.\n", probe_point
);
987 } else if (ntevs
< 0) {
988 /* Error path : ntevs < 0 */
989 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
991 pr_warning("Warning: No dwarf info found in the vmlinux - "
992 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
994 pr_debug("Trying to use symbols.\n");
1001 #define LINEBUF_SIZE 256
1002 #define NR_ADDITIONAL_LINES 2
1004 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
1006 char buf
[LINEBUF_SIZE
], sbuf
[STRERR_BUFSIZE
];
1007 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
1008 const char *prefix
= NULL
;
1011 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
1016 prefix
= show_num
? "%7d " : " ";
1017 color_fprintf(stdout
, color
, prefix
, l
);
1019 color_fprintf(stdout
, color
, "%s", buf
);
1021 } while (strchr(buf
, '\n') == NULL
);
1026 pr_warning("File read error: %s\n",
1027 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
1033 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
1035 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
1037 pr_warning("Source file is shorter than expected.\n");
1043 static int sprint_line_description(char *sbuf
, size_t size
, struct line_range
*lr
)
1046 return snprintf(sbuf
, size
, "file: %s, line: %d", lr
->file
, lr
->start
);
1049 return snprintf(sbuf
, size
, "function: %s, file:%s, line: %d", lr
->function
, lr
->file
, lr
->start
);
1051 return snprintf(sbuf
, size
, "function: %s, line:%d", lr
->function
, lr
->start
);
1054 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
1055 #define show_one_line(f,l) _show_one_line(f,l,false,false)
1056 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
1057 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
1060 * Show line-range always requires debuginfo to find source file and
1063 static int __show_line_range(struct line_range
*lr
, const char *module
,
1066 struct build_id bid
;
1068 struct int_node
*ln
;
1069 struct debuginfo
*dinfo
;
1073 char sbuf
[STRERR_BUFSIZE
];
1074 char sbuild_id
[SBUILD_ID_SIZE
] = "";
1076 /* Search a line range */
1077 dinfo
= open_debuginfo(module
, NULL
, false);
1081 ret
= debuginfo__find_line_range(dinfo
, lr
);
1082 if (!ret
) { /* Not found, retry with an alternative */
1083 pr_debug2("Failed to find line range in debuginfo. Fallback to alternative\n");
1084 ret
= get_alternative_line_range(dinfo
, lr
, module
, user
);
1086 ret
= debuginfo__find_line_range(dinfo
, lr
);
1087 else /* Ignore error, we just failed to find it. */
1090 if (dinfo
->build_id
) {
1091 build_id__init(&bid
, dinfo
->build_id
, BUILD_ID_SIZE
);
1092 build_id__sprintf(&bid
, sbuild_id
);
1094 debuginfo__delete(dinfo
);
1095 if (ret
== 0 || ret
== -ENOENT
) {
1096 sprint_line_description(sbuf
, sizeof(sbuf
), lr
);
1097 pr_warning("Specified source line(%s) is not found.\n", sbuf
);
1099 } else if (ret
< 0) {
1100 pr_warning("Debuginfo analysis failed.\n");
1104 /* Convert source file path */
1106 ret
= find_source_path(tmp
, sbuild_id
, lr
->comp_dir
, &lr
->path
);
1108 /* Free old path when new path is assigned */
1109 if (tmp
!= lr
->path
)
1113 pr_warning("Failed to find source file path.\n");
1120 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
1121 lr
->start
- lr
->offset
);
1123 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
1125 fp
= fopen(lr
->path
, "r");
1127 pr_warning("Failed to open %s: %s\n", lr
->path
,
1128 str_error_r(errno
, sbuf
, sizeof(sbuf
)));
1131 /* Skip to starting line number */
1132 while (l
< lr
->start
) {
1133 ret
= skip_one_line(fp
, l
++);
1138 intlist__for_each_entry(ln
, lr
->line_list
) {
1139 for (; ln
->i
> (unsigned long)l
; l
++) {
1140 ret
= show_one_line(fp
, l
- lr
->offset
);
1144 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
1149 if (lr
->end
== INT_MAX
)
1150 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
1151 while (l
<= lr
->end
) {
1152 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
1161 int show_line_range(struct line_range
*lr
, const char *module
,
1162 struct nsinfo
*nsi
, bool user
)
1165 struct nscookie nsc
;
1167 ret
= init_probe_symbol_maps(user
);
1170 nsinfo__mountns_enter(nsi
, &nsc
);
1171 ret
= __show_line_range(lr
, module
, user
);
1172 nsinfo__mountns_exit(&nsc
);
1173 exit_probe_symbol_maps();
1178 static int show_available_vars_at(struct debuginfo
*dinfo
,
1179 struct perf_probe_event
*pev
,
1180 struct strfilter
*_filter
)
1184 struct str_node
*node
;
1185 struct variable_list
*vls
= NULL
, *vl
;
1186 struct perf_probe_point tmp
;
1189 buf
= synthesize_perf_probe_point(&pev
->point
);
1192 pr_debug("Searching variables at %s\n", buf
);
1194 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
);
1195 if (!ret
) { /* Not found, retry with an alternative */
1196 ret
= get_alternative_probe_event(dinfo
, pev
, &tmp
);
1198 ret
= debuginfo__find_available_vars_at(dinfo
, pev
,
1200 /* Release the old probe_point */
1201 clear_perf_probe_point(&tmp
);
1205 if (ret
== 0 || ret
== -ENOENT
) {
1206 pr_err("Failed to find the address of %s\n", buf
);
1209 pr_warning("Debuginfo analysis failed.\n");
1213 /* Some variables are found */
1214 fprintf(stdout
, "Available variables at %s\n", buf
);
1215 for (i
= 0; i
< ret
; i
++) {
1218 * A probe point might be converted to
1219 * several trace points.
1221 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
1223 zfree(&vl
->point
.symbol
);
1226 strlist__for_each_entry(node
, vl
->vars
) {
1227 var
= strchr(node
->s
, '\t') + 1;
1228 if (strfilter__compare(_filter
, var
)) {
1229 fprintf(stdout
, "\t\t%s\n", node
->s
);
1233 strlist__delete(vl
->vars
);
1236 fprintf(stdout
, "\t\t(No matched variables)\n");
1244 /* Show available variables on given probe point */
1245 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
1246 struct strfilter
*_filter
)
1249 struct debuginfo
*dinfo
;
1251 ret
= init_probe_symbol_maps(pevs
->uprobes
);
1255 dinfo
= open_debuginfo(pevs
->target
, pevs
->nsi
, false);
1263 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
1264 ret
= show_available_vars_at(dinfo
, &pevs
[i
], _filter
);
1266 debuginfo__delete(dinfo
);
1268 exit_probe_symbol_maps();
1272 #else /* !HAVE_LIBDW_SUPPORT */
1274 static void debuginfo_cache__exit(void)
1279 find_perf_probe_point_from_dwarf(struct probe_trace_point
*tp __maybe_unused
,
1280 struct perf_probe_point
*pp __maybe_unused
,
1281 bool is_kprobe __maybe_unused
)
1286 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
1287 struct probe_trace_event
**tevs __maybe_unused
)
1289 if (perf_probe_event_need_dwarf(pev
)) {
1290 pr_warning("Debuginfo-analysis is not supported.\n");
1297 int show_line_range(struct line_range
*lr __maybe_unused
,
1298 const char *module __maybe_unused
,
1299 struct nsinfo
*nsi __maybe_unused
,
1300 bool user __maybe_unused
)
1302 pr_warning("Debuginfo-analysis is not supported.\n");
1306 int show_available_vars(struct perf_probe_event
*pevs __maybe_unused
,
1307 int npevs __maybe_unused
,
1308 struct strfilter
*filter __maybe_unused
)
1310 pr_warning("Debuginfo-analysis is not supported.\n");
1315 void line_range__clear(struct line_range
*lr
)
1317 zfree(&lr
->function
);
1320 zfree(&lr
->comp_dir
);
1321 intlist__delete(lr
->line_list
);
1324 int line_range__init(struct line_range
*lr
)
1326 memset(lr
, 0, sizeof(*lr
));
1327 lr
->line_list
= intlist__new(NULL
);
1334 static int parse_line_num(char **ptr
, int *val
, const char *what
)
1336 const char *start
= *ptr
;
1339 *val
= strtol(*ptr
, ptr
, 0);
1340 if (errno
|| *ptr
== start
) {
1341 semantic_error("'%s' is not a valid number.\n", what
);
1347 /* Check the name is good for event, group or function */
1348 static bool is_c_func_name(const char *name
)
1350 if (!isalpha(*name
) && *name
!= '_')
1352 while (*++name
!= '\0') {
1353 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
1360 * Stuff 'lr' according to the line range described by 'arg'.
1361 * The line range syntax is described by:
1363 * SRC[:SLN[+NUM|-ELN]]
1364 * FNC[@SRC][:SLN[+NUM|-ELN]]
1366 * FNC@SRC accepts `FNC@*` which forcibly specify FNC as function name.
1367 * SRC and FUNC can be quoted by double/single quotes.
1369 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
1371 char *buf
= strdup(arg
);
1381 p
= strpbrk_esq(buf
, ":");
1384 semantic_error("No file/function name in '%s'.\n", p
);
1390 err
= parse_line_num(&p
, &lr
->start
, "start line");
1394 if (*p
== '+' || *p
== '-') {
1395 const char c
= *(p
++);
1397 err
= parse_line_num(&p
, &lr
->end
, "end line");
1402 lr
->end
+= lr
->start
;
1404 * Adjust the number of lines here.
1405 * If the number of lines == 1, the
1406 * end of line should be equal to
1407 * the start of line.
1413 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
1416 if (lr
->start
> lr
->end
) {
1417 semantic_error("Start line must be smaller"
1418 " than end line.\n");
1422 semantic_error("Tailing with invalid str '%s'.\n", p
);
1427 p
= strpbrk_esq(buf
, "@");
1430 if (strcmp(p
, "*")) {
1431 lr
->file
= strdup_esq(p
);
1432 if (lr
->file
== NULL
) {
1438 lr
->function
= strdup_esq(buf
);
1439 if (!lr
->function
&& !lr
->file
) {
1440 semantic_error("Only '@*' is not allowed.\n");
1444 } else if (strpbrk_esq(buf
, "/."))
1445 lr
->file
= strdup_esq(buf
);
1446 else if (is_c_func_name(buf
))/* We reuse it for checking funcname */
1447 lr
->function
= strdup_esq(buf
);
1448 else { /* Invalid name */
1449 semantic_error("'%s' is not a valid function name.\n", buf
);
1459 static int parse_perf_probe_event_name(char **arg
, struct perf_probe_event
*pev
)
1463 ptr
= strpbrk_esq(*arg
, ":");
1466 if (!pev
->sdt
&& !is_c_func_name(*arg
))
1468 pev
->group
= strdup_esq(*arg
);
1475 pev
->event
= strdup_esq(*arg
);
1476 if (pev
->event
== NULL
)
1479 if (!pev
->sdt
&& !is_c_func_name(pev
->event
)) {
1483 semantic_error("%s is bad for event name -it must "
1484 "follow C symbol-naming rule.\n", *arg
);
1490 /* Parse probepoint definition. */
1491 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
1493 struct perf_probe_point
*pp
= &pev
->point
;
1496 bool file_spec
= false;
1501 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1502 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1503 * perf probe %[GRP:]SDT_EVENT
1508 if (is_sdt_event(arg
)) {
1514 ptr
= strpbrk_esq(arg
, ";=@+%");
1518 semantic_error("%s must be an SDT name.\n",
1522 /* This must be a target file name or build id */
1523 tmp
= build_id_cache__complement(ptr
+ 1);
1525 pev
->target
= build_id_cache__origname(tmp
);
1528 pev
->target
= strdup_esq(ptr
+ 1);
1533 ret
= parse_perf_probe_event_name(&arg
, pev
);
1535 if (asprintf(&pev
->point
.function
, "%%%s", pev
->event
) < 0)
1541 if (ptr
&& *ptr
== '=') { /* Event name */
1544 ret
= parse_perf_probe_event_name(&arg
, pev
);
1552 * Check arg is function or file name and copy it.
1554 * We consider arg to be a file spec if and only if it satisfies
1555 * all of the below criteria::
1556 * - it does not include any of "+@%",
1557 * - it includes one of ":;", and
1558 * - it has a period '.' in the name.
1560 * Otherwise, we consider arg to be a function specification.
1562 if (!strpbrk_esc(arg
, "+@%")) {
1563 ptr
= strpbrk_esc(arg
, ";:");
1564 /* This is a file spec if it includes a '.' before ; or : */
1565 if (ptr
&& memchr(arg
, '.', ptr
- arg
))
1569 ptr
= strpbrk_esq(arg
, ";:+@%");
1578 tmp
= strdup_esq(arg
);
1589 * Keep pp->function even if this is absolute address,
1590 * so it can mark whether abs_address is valid.
1591 * Which make 'perf probe lib.bin 0x0' possible.
1593 * Note that checking length of tmp is not needed
1594 * because when we access tmp[1] we know tmp[0] is '0',
1595 * so tmp[1] should always valid (but could be '\0').
1597 if (tmp
&& !strncmp(tmp
, "0x", 2)) {
1598 pp
->abs_address
= strtoull(pp
->function
, &tmp
, 0);
1600 semantic_error("Invalid absolute address.\n");
1606 /* Parse other options */
1610 if (c
== ';') { /* Lazy pattern must be the last part */
1611 pp
->lazy_line
= strdup(arg
); /* let leave escapes */
1612 if (pp
->lazy_line
== NULL
)
1616 ptr
= strpbrk_esq(arg
, ";:+@%");
1622 case ':': /* Line number */
1623 pp
->line
= strtoul(arg
, &tmp
, 0);
1625 semantic_error("There is non-digit char"
1626 " in line number.\n");
1630 case '+': /* Byte offset from a symbol */
1631 pp
->offset
= strtoul(arg
, &tmp
, 0);
1633 semantic_error("There is non-digit character"
1638 case '@': /* File name */
1640 semantic_error("SRC@SRC is not allowed.\n");
1643 if (!strcmp(arg
, "*"))
1645 pp
->file
= strdup_esq(arg
);
1646 if (pp
->file
== NULL
)
1649 case '%': /* Probe places */
1650 if (strcmp(arg
, "return") == 0) {
1652 } else { /* Others not supported yet */
1653 semantic_error("%%%s is not supported.\n", arg
);
1657 default: /* Buggy case */
1658 pr_err("This program has a bug at %s:%d.\n",
1659 __FILE__
, __LINE__
);
1665 /* Exclusion check */
1666 if (pp
->lazy_line
&& pp
->line
) {
1667 semantic_error("Lazy pattern can't be used with"
1672 if (pp
->lazy_line
&& pp
->offset
) {
1673 semantic_error("Lazy pattern can't be used with offset.\n");
1677 if (pp
->line
&& pp
->offset
) {
1678 semantic_error("Offset can't be used with line number.\n");
1682 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
1683 semantic_error("File always requires line number or "
1688 if (pp
->offset
&& !pp
->function
) {
1689 semantic_error("Offset requires an entry function.\n");
1693 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
1694 semantic_error("Offset/Line/Lazy pattern can't be used with "
1699 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1700 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
1705 /* Parse perf-probe event argument */
1706 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
1708 char *tmp
, *goodname
;
1709 struct perf_probe_arg_field
**fieldp
;
1711 pr_debug("parsing arg: %s into ", str
);
1713 tmp
= strchr(str
, '=');
1715 arg
->name
= strndup(str
, tmp
- str
);
1716 if (arg
->name
== NULL
)
1718 pr_debug("name:%s ", arg
->name
);
1722 tmp
= strchr(str
, '@');
1723 if (tmp
&& tmp
!= str
&& !strcmp(tmp
+ 1, "user")) { /* user attr */
1724 if (!user_access_is_supported()) {
1725 semantic_error("ftrace does not support user access\n");
1729 arg
->user_access
= true;
1730 pr_debug("user_access ");
1733 tmp
= strchr(str
, ':');
1734 if (tmp
) { /* Type setting */
1736 arg
->type
= strdup(tmp
+ 1);
1737 if (arg
->type
== NULL
)
1739 pr_debug("type:%s ", arg
->type
);
1742 tmp
= strpbrk(str
, "-.[");
1743 if (!is_c_varname(str
) || !tmp
) {
1744 /* A variable, register, symbol or special value */
1745 arg
->var
= strdup(str
);
1746 if (arg
->var
== NULL
)
1748 pr_debug("%s\n", arg
->var
);
1752 /* Structure fields or array element */
1753 arg
->var
= strndup(str
, tmp
- str
);
1754 if (arg
->var
== NULL
)
1756 goodname
= arg
->var
;
1757 pr_debug("%s, ", arg
->var
);
1758 fieldp
= &arg
->field
;
1761 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
1762 if (*fieldp
== NULL
)
1764 if (*tmp
== '[') { /* Array */
1766 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
1767 (*fieldp
)->ref
= true;
1768 if (*tmp
!= ']' || tmp
== str
+ 1) {
1769 semantic_error("Array index must be a"
1776 } else { /* Structure */
1779 (*fieldp
)->ref
= false;
1780 } else if (tmp
[1] == '>') {
1782 (*fieldp
)->ref
= true;
1784 semantic_error("Argument parse error: %s\n",
1788 tmp
= strpbrk(str
, "-.[");
1791 (*fieldp
)->name
= strndup(str
, tmp
- str
);
1792 if ((*fieldp
)->name
== NULL
)
1795 goodname
= (*fieldp
)->name
;
1796 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
1797 fieldp
= &(*fieldp
)->next
;
1800 (*fieldp
)->name
= strdup(str
);
1801 if ((*fieldp
)->name
== NULL
)
1804 goodname
= (*fieldp
)->name
;
1805 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
1807 /* If no name is specified, set the last field name (not array index)*/
1809 arg
->name
= strdup(goodname
);
1810 if (arg
->name
== NULL
)
1816 /* Parse perf-probe event command */
1817 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1820 int argc
, i
, ret
= 0;
1822 argv
= argv_split(cmd
, &argc
);
1824 pr_debug("Failed to split arguments.\n");
1827 if (argc
- 1 > MAX_PROBE_ARGS
) {
1828 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1832 /* Parse probe point */
1833 ret
= parse_perf_probe_point(argv
[0], pev
);
1837 /* Generate event name if needed */
1838 if (!pev
->event
&& pev
->point
.function
&& pev
->point
.line
1839 && !pev
->point
.lazy_line
&& !pev
->point
.offset
) {
1840 if (asprintf(&pev
->event
, "%s_L%d", pev
->point
.function
,
1841 pev
->point
.line
) < 0) {
1847 /* Copy arguments and ensure return probe has no C argument */
1848 pev
->nargs
= argc
- 1;
1849 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1850 if (pev
->args
== NULL
) {
1854 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1855 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1857 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1858 semantic_error("You can't specify local variable for"
1869 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1870 bool perf_probe_with_var(struct perf_probe_event
*pev
)
1874 for (i
= 0; i
< pev
->nargs
; i
++)
1875 if (is_c_varname(pev
->args
[i
].var
) ||
1876 !strcmp(pev
->args
[i
].var
, PROBE_ARG_PARAMS
) ||
1877 !strcmp(pev
->args
[i
].var
, PROBE_ARG_VARS
))
1882 /* Return true if this perf_probe_event requires debuginfo */
1883 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1885 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1888 if (perf_probe_with_var(pev
))
1894 /* Parse probe_events event into struct probe_point */
1895 int parse_probe_trace_command(const char *cmd
, struct probe_trace_event
*tev
)
1897 struct probe_trace_point
*tp
= &tev
->point
;
1900 char *argv0_str
= NULL
, *fmt
, *fmt1_str
, *fmt2_str
, *fmt3_str
;
1904 pr_debug("Parsing probe_events: %s\n", cmd
);
1905 argv
= argv_split(cmd
, &argc
);
1907 pr_debug("Failed to split arguments.\n");
1911 semantic_error("Too few probe arguments.\n");
1916 /* Scan event and group name. */
1917 argv0_str
= strdup(argv
[0]);
1918 if (argv0_str
== NULL
) {
1922 fmt1_str
= strtok_r(argv0_str
, ":", &fmt
);
1923 fmt2_str
= strtok_r(NULL
, "/", &fmt
);
1924 fmt3_str
= strtok_r(NULL
, " \t", &fmt
);
1925 if (fmt1_str
== NULL
|| fmt2_str
== NULL
|| fmt3_str
== NULL
) {
1926 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1931 tev
->group
= strdup(fmt2_str
);
1932 tev
->event
= strdup(fmt3_str
);
1933 if (tev
->group
== NULL
|| tev
->event
== NULL
) {
1937 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1939 tp
->retprobe
= (pr
== 'r');
1941 /* Scan module name(if there), function name and offset */
1942 p
= strchr(argv
[1], ':');
1944 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1949 tev
->uprobes
= (tp
->module
[0] == '/');
1953 fmt1_str
= strtok_r(p
, "+", &fmt
);
1954 /* only the address started with 0x */
1955 if (fmt1_str
[0] == '0') {
1957 * Fix a special case:
1958 * if address == 0, kernel reports something like:
1959 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1960 * Newer kernel may fix that, but we want to
1961 * support old kernel also.
1963 if (strcmp(fmt1_str
, "0x") == 0) {
1964 if (!argv
[2] || strcmp(argv
[2], "(null)")) {
1971 for (i
= 2; argv
[i
+ 1] != NULL
; i
++)
1972 argv
[i
] = argv
[i
+ 1];
1977 tp
->address
= strtoull(fmt1_str
, NULL
, 0);
1979 /* Only the symbol-based probe has offset */
1980 tp
->symbol
= strdup(fmt1_str
);
1981 if (tp
->symbol
== NULL
) {
1985 fmt2_str
= strtok_r(NULL
, "", &fmt
);
1986 if (fmt2_str
== NULL
)
1989 tp
->offset
= strtoul(fmt2_str
, NULL
, 10);
1993 fmt2_str
= strchr(p
, '(');
1995 tp
->ref_ctr_offset
= strtoul(fmt2_str
+ 1, NULL
, 0);
1998 tev
->nargs
= argc
- 2;
1999 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
2000 if (tev
->args
== NULL
) {
2004 for (i
= 0; i
< tev
->nargs
; i
++) {
2005 p
= strchr(argv
[i
+ 2], '=');
2006 if (p
) /* We don't need which register is assigned. */
2010 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
2011 /* TODO: parse regs and offset */
2012 tev
->args
[i
].value
= strdup(p
);
2013 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
2025 /* Compose only probe arg */
2026 char *synthesize_perf_probe_arg(struct perf_probe_arg
*pa
)
2028 struct perf_probe_arg_field
*field
= pa
->field
;
2033 if (strbuf_init(&buf
, 64) < 0)
2036 if (pa
->name
&& pa
->var
)
2037 err
= strbuf_addf(&buf
, "%s=%s", pa
->name
, pa
->var
);
2039 err
= strbuf_addstr(&buf
, pa
->name
?: pa
->var
);
2044 if (field
->name
[0] == '[')
2045 err
= strbuf_addstr(&buf
, field
->name
);
2047 err
= strbuf_addf(&buf
, "%s%s", field
->ref
? "->" : ".",
2049 field
= field
->next
;
2055 if (strbuf_addf(&buf
, ":%s", pa
->type
) < 0)
2058 ret
= strbuf_detach(&buf
, NULL
);
2060 strbuf_release(&buf
);
2064 /* Compose only probe point (not argument) */
2065 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
2068 char *tmp
, *ret
= NULL
;
2071 if (strbuf_init(&buf
, 64) < 0)
2075 if (strbuf_addstr(&buf
, pp
->function
) < 0)
2078 err
= strbuf_addf(&buf
, "+%lu", pp
->offset
);
2080 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
2081 else if (pp
->retprobe
)
2082 err
= strbuf_addstr(&buf
, "%return");
2090 tmp
= strchr(pp
->file
+ len
- 30, '/');
2091 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
2093 err
= strbuf_addf(&buf
, "@%s", tmp
);
2094 if (!err
&& !pp
->function
&& pp
->line
)
2095 err
= strbuf_addf(&buf
, ":%d", pp
->line
);
2098 ret
= strbuf_detach(&buf
, NULL
);
2100 strbuf_release(&buf
);
2104 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
2107 char *tmp
, *ret
= NULL
;
2110 if (strbuf_init(&buf
, 64))
2113 if (strbuf_addf(&buf
, "%s:%s=", pev
->group
?: PERFPROBE_GROUP
,
2117 tmp
= synthesize_perf_probe_point(&pev
->point
);
2118 if (!tmp
|| strbuf_addstr(&buf
, tmp
) < 0) {
2124 for (i
= 0; i
< pev
->nargs
; i
++) {
2125 tmp
= synthesize_perf_probe_arg(pev
->args
+ i
);
2126 if (!tmp
|| strbuf_addf(&buf
, " %s", tmp
) < 0) {
2133 ret
= strbuf_detach(&buf
, NULL
);
2135 strbuf_release(&buf
);
2139 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
2140 struct strbuf
*buf
, int depth
)
2144 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
2149 if (ref
->user_access
)
2150 err
= strbuf_addf(buf
, "%s%ld(", "+u", ref
->offset
);
2152 err
= strbuf_addf(buf
, "%+ld(", ref
->offset
);
2153 return (err
< 0) ? err
: depth
;
2156 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
2159 struct probe_trace_arg_ref
*ref
= arg
->ref
;
2162 /* Argument name or separator */
2164 err
= strbuf_addf(buf
, " %s=", arg
->name
);
2166 err
= strbuf_addch(buf
, ' ');
2170 /* Special case: @XXX */
2171 if (arg
->value
[0] == '@' && arg
->ref
)
2174 /* Dereferencing arguments */
2176 depth
= __synthesize_probe_trace_arg_ref(ref
, buf
, 1);
2181 /* Print argument value */
2182 if (arg
->value
[0] == '@' && arg
->ref
)
2183 err
= strbuf_addf(buf
, "%s%+ld", arg
->value
, arg
->ref
->offset
);
2185 err
= strbuf_addstr(buf
, arg
->value
);
2188 while (!err
&& depth
--)
2189 err
= strbuf_addch(buf
, ')');
2191 /* Print argument type */
2192 if (!err
&& arg
->type
)
2193 err
= strbuf_addf(buf
, ":%s", arg
->type
);
2199 synthesize_probe_trace_args(struct probe_trace_event
*tev
, struct strbuf
*buf
)
2203 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++)
2204 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], buf
);
2210 synthesize_uprobe_trace_def(struct probe_trace_point
*tp
, struct strbuf
*buf
)
2214 /* Uprobes must have tp->module */
2218 * If tp->address == 0, then this point must be a
2219 * absolute address uprobe.
2220 * try_to_find_absolute_address() should have made
2221 * tp->symbol to "0x0".
2223 if (!tp
->address
&& (!tp
->symbol
|| strcmp(tp
->symbol
, "0x0")))
2226 /* Use the tp->address for uprobes */
2227 err
= strbuf_addf(buf
, "%s:0x%" PRIx64
, tp
->module
, tp
->address
);
2229 if (err
>= 0 && tp
->ref_ctr_offset
) {
2230 if (!uprobe_ref_ctr_is_supported())
2232 err
= strbuf_addf(buf
, "(0x%lx)", tp
->ref_ctr_offset
);
2234 return err
>= 0 ? 0 : err
;
2238 synthesize_kprobe_trace_def(struct probe_trace_point
*tp
, struct strbuf
*buf
)
2240 if (!strncmp(tp
->symbol
, "0x", 2)) {
2241 /* Absolute address. See try_to_find_absolute_address() */
2242 return strbuf_addf(buf
, "%s%s0x%" PRIx64
, tp
->module
?: "",
2243 tp
->module
? ":" : "", tp
->address
);
2245 return strbuf_addf(buf
, "%s%s%s+%lu", tp
->module
?: "",
2246 tp
->module
? ":" : "", tp
->symbol
, tp
->offset
);
2250 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
2252 struct probe_trace_point
*tp
= &tev
->point
;
2257 if (strbuf_init(&buf
, 32) < 0)
2260 if (strbuf_addf(&buf
, "%c:%s/%s ", tp
->retprobe
? 'r' : 'p',
2261 tev
->group
, tev
->event
) < 0)
2265 err
= synthesize_uprobe_trace_def(tp
, &buf
);
2267 err
= synthesize_kprobe_trace_def(tp
, &buf
);
2270 err
= synthesize_probe_trace_args(tev
, &buf
);
2273 ret
= strbuf_detach(&buf
, NULL
);
2275 strbuf_release(&buf
);
2279 static int find_perf_probe_point_from_map(struct probe_trace_point
*tp
,
2280 struct perf_probe_point
*pp
,
2283 struct symbol
*sym
= NULL
;
2284 struct map
*map
= NULL
;
2285 u64 addr
= tp
->address
;
2289 map
= dso__new_map(tp
->module
);
2292 sym
= map__find_symbol(map
, addr
);
2294 if (tp
->symbol
&& !addr
) {
2295 if (kernel_get_symbol_address_by_name(tp
->symbol
,
2296 &addr
, true, false) < 0)
2301 sym
= machine__find_kernel_symbol(host_machine
, addr
, &map
);
2308 pp
->retprobe
= tp
->retprobe
;
2309 pp
->offset
= addr
- map__unmap_ip(map
, sym
->start
);
2310 pp
->function
= strdup(sym
->name
);
2311 ret
= pp
->function
? 0 : -ENOMEM
;
2319 static int convert_to_perf_probe_point(struct probe_trace_point
*tp
,
2320 struct perf_probe_point
*pp
,
2326 ret
= find_perf_probe_point_from_dwarf(tp
, pp
, is_kprobe
);
2329 ret
= find_perf_probe_point_from_map(tp
, pp
, is_kprobe
);
2333 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2336 pp
->function
= strdup(tp
->symbol
);
2337 pp
->offset
= tp
->offset
;
2339 ret
= e_snprintf(buf
, 128, "0x%" PRIx64
, tp
->address
);
2342 pp
->function
= strdup(buf
);
2345 if (pp
->function
== NULL
)
2348 pp
->retprobe
= tp
->retprobe
;
2353 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
2354 struct perf_probe_event
*pev
, bool is_kprobe
)
2356 struct strbuf buf
= STRBUF_INIT
;
2359 /* Convert event/group name */
2360 pev
->event
= strdup(tev
->event
);
2361 pev
->group
= strdup(tev
->group
);
2362 if (pev
->event
== NULL
|| pev
->group
== NULL
)
2365 /* Convert trace_point to probe_point */
2366 ret
= convert_to_perf_probe_point(&tev
->point
, &pev
->point
, is_kprobe
);
2370 /* Convert trace_arg to probe_arg */
2371 pev
->nargs
= tev
->nargs
;
2372 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
2373 if (pev
->args
== NULL
)
2375 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
2376 if (tev
->args
[i
].name
)
2377 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
2379 if ((ret
= strbuf_init(&buf
, 32)) < 0)
2381 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], &buf
);
2382 pev
->args
[i
].name
= strbuf_detach(&buf
, NULL
);
2384 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
2389 clear_perf_probe_event(pev
);
2394 void clear_perf_probe_event(struct perf_probe_event
*pev
)
2396 struct perf_probe_arg_field
*field
, *next
;
2401 zfree(&pev
->target
);
2402 clear_perf_probe_point(&pev
->point
);
2404 for (i
= 0; i
< pev
->nargs
; i
++) {
2405 zfree(&pev
->args
[i
].name
);
2406 zfree(&pev
->args
[i
].var
);
2407 zfree(&pev
->args
[i
].type
);
2408 field
= pev
->args
[i
].field
;
2411 zfree(&field
->name
);
2420 #define strdup_or_goto(str, label) \
2421 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2423 static int perf_probe_point__copy(struct perf_probe_point
*dst
,
2424 struct perf_probe_point
*src
)
2426 dst
->file
= strdup_or_goto(src
->file
, out_err
);
2427 dst
->function
= strdup_or_goto(src
->function
, out_err
);
2428 dst
->lazy_line
= strdup_or_goto(src
->lazy_line
, out_err
);
2429 dst
->line
= src
->line
;
2430 dst
->retprobe
= src
->retprobe
;
2431 dst
->offset
= src
->offset
;
2435 clear_perf_probe_point(dst
);
2439 static int perf_probe_arg__copy(struct perf_probe_arg
*dst
,
2440 struct perf_probe_arg
*src
)
2442 struct perf_probe_arg_field
*field
, **ppfield
;
2444 dst
->name
= strdup_or_goto(src
->name
, out_err
);
2445 dst
->var
= strdup_or_goto(src
->var
, out_err
);
2446 dst
->type
= strdup_or_goto(src
->type
, out_err
);
2449 ppfield
= &(dst
->field
);
2451 *ppfield
= zalloc(sizeof(*field
));
2454 (*ppfield
)->name
= strdup_or_goto(field
->name
, out_err
);
2455 (*ppfield
)->index
= field
->index
;
2456 (*ppfield
)->ref
= field
->ref
;
2457 field
= field
->next
;
2458 ppfield
= &((*ppfield
)->next
);
2465 int perf_probe_event__copy(struct perf_probe_event
*dst
,
2466 struct perf_probe_event
*src
)
2470 dst
->event
= strdup_or_goto(src
->event
, out_err
);
2471 dst
->group
= strdup_or_goto(src
->group
, out_err
);
2472 dst
->target
= strdup_or_goto(src
->target
, out_err
);
2473 dst
->uprobes
= src
->uprobes
;
2475 if (perf_probe_point__copy(&dst
->point
, &src
->point
) < 0)
2478 dst
->args
= zalloc(sizeof(struct perf_probe_arg
) * src
->nargs
);
2481 dst
->nargs
= src
->nargs
;
2483 for (i
= 0; i
< src
->nargs
; i
++)
2484 if (perf_probe_arg__copy(&dst
->args
[i
], &src
->args
[i
]) < 0)
2489 clear_perf_probe_event(dst
);
2493 void clear_probe_trace_event(struct probe_trace_event
*tev
)
2495 struct probe_trace_arg_ref
*ref
, *next
;
2500 zfree(&tev
->point
.symbol
);
2501 zfree(&tev
->point
.realname
);
2502 zfree(&tev
->point
.module
);
2503 for (i
= 0; i
< tev
->nargs
; i
++) {
2504 zfree(&tev
->args
[i
].name
);
2505 zfree(&tev
->args
[i
].value
);
2506 zfree(&tev
->args
[i
].type
);
2507 ref
= tev
->args
[i
].ref
;
2518 struct kprobe_blacklist_node
{
2519 struct list_head list
;
2525 static void kprobe_blacklist__delete(struct list_head
*blacklist
)
2527 struct kprobe_blacklist_node
*node
;
2529 while (!list_empty(blacklist
)) {
2530 node
= list_first_entry(blacklist
,
2531 struct kprobe_blacklist_node
, list
);
2532 list_del_init(&node
->list
);
2533 zfree(&node
->symbol
);
2538 static int kprobe_blacklist__load(struct list_head
*blacklist
)
2540 struct kprobe_blacklist_node
*node
;
2541 const char *__debugfs
= debugfs__mountpoint();
2542 char buf
[PATH_MAX
], *p
;
2546 if (__debugfs
== NULL
)
2549 ret
= e_snprintf(buf
, PATH_MAX
, "%s/kprobes/blacklist", __debugfs
);
2553 fp
= fopen(buf
, "r");
2558 while (fgets(buf
, PATH_MAX
, fp
)) {
2559 node
= zalloc(sizeof(*node
));
2564 INIT_LIST_HEAD(&node
->list
);
2565 list_add_tail(&node
->list
, blacklist
);
2566 if (sscanf(buf
, "0x%" PRIx64
"-0x%" PRIx64
, &node
->start
, &node
->end
) != 2) {
2570 p
= strchr(buf
, '\t');
2573 if (p
[strlen(p
) - 1] == '\n')
2574 p
[strlen(p
) - 1] = '\0';
2576 p
= (char *)"unknown";
2577 node
->symbol
= strdup(p
);
2578 if (!node
->symbol
) {
2582 pr_debug2("Blacklist: 0x%" PRIx64
"-0x%" PRIx64
", %s\n",
2583 node
->start
, node
->end
, node
->symbol
);
2587 kprobe_blacklist__delete(blacklist
);
2593 static struct kprobe_blacklist_node
*
2594 kprobe_blacklist__find_by_address(struct list_head
*blacklist
, u64 address
)
2596 struct kprobe_blacklist_node
*node
;
2598 list_for_each_entry(node
, blacklist
, list
) {
2599 if (node
->start
<= address
&& address
< node
->end
)
2606 static LIST_HEAD(kprobe_blacklist
);
2608 static void kprobe_blacklist__init(void)
2610 if (!list_empty(&kprobe_blacklist
))
2613 if (kprobe_blacklist__load(&kprobe_blacklist
) < 0)
2614 pr_debug("No kprobe blacklist support, ignored\n");
2617 static void kprobe_blacklist__release(void)
2619 kprobe_blacklist__delete(&kprobe_blacklist
);
2622 static bool kprobe_blacklist__listed(u64 address
)
2624 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist
, address
);
2627 static int perf_probe_event__sprintf(const char *group
, const char *event
,
2628 struct perf_probe_event
*pev
,
2630 struct strbuf
*result
)
2635 if (asprintf(&buf
, "%s:%s", group
, event
) < 0)
2637 ret
= strbuf_addf(result
, " %-20s (on ", buf
);
2642 /* Synthesize only event probe point */
2643 buf
= synthesize_perf_probe_point(&pev
->point
);
2646 ret
= strbuf_addstr(result
, buf
);
2650 ret
= strbuf_addf(result
, " in %s", module
);
2652 if (!ret
&& pev
->nargs
> 0) {
2653 ret
= strbuf_add(result
, " with", 5);
2654 for (i
= 0; !ret
&& i
< pev
->nargs
; i
++) {
2655 buf
= synthesize_perf_probe_arg(&pev
->args
[i
]);
2658 ret
= strbuf_addf(result
, " %s", buf
);
2663 ret
= strbuf_addch(result
, ')');
2669 int show_perf_probe_event(const char *group
, const char *event
,
2670 struct perf_probe_event
*pev
,
2671 const char *module
, bool use_stdout
)
2673 struct strbuf buf
= STRBUF_INIT
;
2676 ret
= perf_probe_event__sprintf(group
, event
, pev
, module
, &buf
);
2679 printf("%s\n", buf
.buf
);
2681 pr_info("%s\n", buf
.buf
);
2683 strbuf_release(&buf
);
2688 static bool filter_probe_trace_event(struct probe_trace_event
*tev
,
2689 struct strfilter
*filter
)
2693 /* At first, check the event name itself */
2694 if (strfilter__compare(filter
, tev
->event
))
2697 /* Next, check the combination of name and group */
2698 if (e_snprintf(tmp
, 128, "%s:%s", tev
->group
, tev
->event
) < 0)
2700 return strfilter__compare(filter
, tmp
);
2703 static int __show_perf_probe_events(int fd
, bool is_kprobe
,
2704 struct strfilter
*filter
)
2707 struct probe_trace_event tev
;
2708 struct perf_probe_event pev
;
2709 struct strlist
*rawlist
;
2710 struct str_node
*ent
;
2712 memset(&tev
, 0, sizeof(tev
));
2713 memset(&pev
, 0, sizeof(pev
));
2715 rawlist
= probe_file__get_rawlist(fd
);
2719 strlist__for_each_entry(ent
, rawlist
) {
2720 ret
= parse_probe_trace_command(ent
->s
, &tev
);
2722 if (!filter_probe_trace_event(&tev
, filter
))
2724 ret
= convert_to_perf_probe_event(&tev
, &pev
,
2728 ret
= show_perf_probe_event(pev
.group
, pev
.event
,
2729 &pev
, tev
.point
.module
,
2733 clear_perf_probe_event(&pev
);
2734 clear_probe_trace_event(&tev
);
2738 strlist__delete(rawlist
);
2739 /* Cleanup cached debuginfo if needed */
2740 debuginfo_cache__exit();
2745 /* List up current perf-probe events */
2746 int show_perf_probe_events(struct strfilter
*filter
)
2748 int kp_fd
, up_fd
, ret
;
2752 if (probe_conf
.cache
)
2753 return probe_cache__show_all_caches(filter
);
2755 ret
= init_probe_symbol_maps(false);
2759 ret
= probe_file__open_both(&kp_fd
, &up_fd
, 0);
2764 ret
= __show_perf_probe_events(kp_fd
, true, filter
);
2765 if (up_fd
>= 0 && ret
>= 0)
2766 ret
= __show_perf_probe_events(up_fd
, false, filter
);
2771 exit_probe_symbol_maps();
2776 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
2777 struct strlist
*namelist
, bool ret_event
,
2785 nbase
= strdup(base
);
2789 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2790 p
= strpbrk(nbase
, ".@");
2791 if (p
&& p
!= nbase
)
2794 /* Try no suffix number */
2795 ret
= e_snprintf(buf
, len
, "%s%s", nbase
, ret_event
? "__return" : "");
2797 pr_warning("snprintf() failed: %d; the event name '%s' is too long\n"
2798 " Hint: Set a shorter event with syntax \"EVENT=PROBEDEF\"\n"
2799 " EVENT: Event name (max length: %d bytes).\n",
2800 ret
, nbase
, MAX_EVENT_NAME_LEN
);
2803 if (!strlist__has_entry(namelist
, buf
))
2806 if (!allow_suffix
) {
2807 pr_warning("Error: event \"%s\" already exists.\n"
2808 " Hint: Remove existing event by 'perf probe -d'\n"
2809 " or force duplicates by 'perf probe -f'\n"
2810 " or set 'force=yes' in BPF source.\n",
2816 /* Try to add suffix */
2817 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
2818 ret
= e_snprintf(buf
, len
, "%s_%d", nbase
, i
);
2820 pr_warning("Add suffix failed: %d; the event name '%s' is too long\n"
2821 " Hint: Set a shorter event with syntax \"EVENT=PROBEDEF\"\n"
2822 " EVENT: Event name (max length: %d bytes).\n",
2823 ret
, nbase
, MAX_EVENT_NAME_LEN
);
2826 if (!strlist__has_entry(namelist
, buf
))
2829 if (i
== MAX_EVENT_INDEX
) {
2830 pr_warning("Too many events are on the same function.\n");
2837 /* Final validation */
2838 if (ret
>= 0 && !is_c_func_name(buf
)) {
2839 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2847 /* Warn if the current kernel's uprobe implementation is old */
2848 static void warn_uprobe_event_compat(struct probe_trace_event
*tev
)
2851 char *buf
= synthesize_probe_trace_command(tev
);
2852 struct probe_trace_point
*tp
= &tev
->point
;
2854 if (tp
->ref_ctr_offset
&& !uprobe_ref_ctr_is_supported()) {
2855 pr_warning("A semaphore is associated with %s:%s and "
2856 "seems your kernel doesn't support it.\n",
2857 tev
->group
, tev
->event
);
2860 /* Old uprobe event doesn't support memory dereference */
2861 if (!tev
->uprobes
|| tev
->nargs
== 0 || !buf
)
2864 for (i
= 0; i
< tev
->nargs
; i
++) {
2865 if (strchr(tev
->args
[i
].value
, '@')) {
2866 pr_warning("%s accesses a variable by symbol name, but that is not supported for user application probe.\n",
2867 tev
->args
[i
].value
);
2870 if (strglobmatch(tev
->args
[i
].value
, "[$+-]*")) {
2871 pr_warning("Please upgrade your kernel to at least 3.14 to have access to feature %s\n",
2872 tev
->args
[i
].value
);
2880 /* Set new name from original perf_probe_event and namelist */
2881 static int probe_trace_event__set_name(struct probe_trace_event
*tev
,
2882 struct perf_probe_event
*pev
,
2883 struct strlist
*namelist
,
2886 const char *event
, *group
;
2887 char buf
[MAX_EVENT_NAME_LEN
];
2890 /* If probe_event or trace_event already have the name, reuse it */
2891 if (pev
->event
&& !pev
->sdt
)
2893 else if (tev
->event
)
2896 /* Or generate new one from probe point */
2897 if (pev
->point
.function
&&
2898 (strncmp(pev
->point
.function
, "0x", 2) != 0) &&
2899 !strisglob(pev
->point
.function
))
2900 event
= pev
->point
.function
;
2902 event
= tev
->point
.realname
;
2904 if (pev
->group
&& !pev
->sdt
)
2906 else if (tev
->group
)
2909 group
= PERFPROBE_GROUP
;
2911 if (strlen(group
) >= MAX_EVENT_NAME_LEN
) {
2912 pr_err("Probe group string='%s' is too long (>= %d bytes)\n",
2913 group
, MAX_EVENT_NAME_LEN
);
2917 /* Get an unused new event name */
2918 ret
= get_new_event_name(buf
, sizeof(buf
), event
, namelist
,
2919 tev
->point
.retprobe
, allow_suffix
);
2925 tev
->event
= strdup(event
);
2926 tev
->group
= strdup(group
);
2927 if (tev
->event
== NULL
|| tev
->group
== NULL
)
2931 * Add new event name to namelist if multiprobe event is NOT
2932 * supported, since we have to use new event name for following
2933 * probes in that case.
2935 if (!multiprobe_event_is_supported())
2936 strlist__add(namelist
, event
);
2940 static int __open_probe_file_and_namelist(bool uprobe
,
2941 struct strlist
**namelist
)
2945 fd
= probe_file__open(PF_FL_RW
| (uprobe
? PF_FL_UPROBE
: 0));
2949 /* Get current event names */
2950 *namelist
= probe_file__get_namelist(fd
);
2952 pr_debug("Failed to get current event list.\n");
2959 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
2960 struct probe_trace_event
*tevs
,
2961 int ntevs
, bool allow_suffix
)
2963 int i
, fd
[2] = {-1, -1}, up
, ret
;
2964 struct probe_trace_event
*tev
= NULL
;
2965 struct probe_cache
*cache
= NULL
;
2966 struct strlist
*namelist
[2] = {NULL
, NULL
};
2967 struct nscookie nsc
;
2969 up
= pev
->uprobes
? 1 : 0;
2970 fd
[up
] = __open_probe_file_and_namelist(up
, &namelist
[up
]);
2975 for (i
= 0; i
< ntevs
; i
++) {
2977 up
= tev
->uprobes
? 1 : 0;
2978 if (fd
[up
] == -1) { /* Open the kprobe/uprobe_events */
2979 fd
[up
] = __open_probe_file_and_namelist(up
,
2984 /* Skip if the symbol is out of .text or blacklisted */
2985 if (!tev
->point
.symbol
&& !pev
->uprobes
)
2988 /* Set new name for tev (and update namelist) */
2989 ret
= probe_trace_event__set_name(tev
, pev
, namelist
[up
],
2994 nsinfo__mountns_enter(pev
->nsi
, &nsc
);
2995 ret
= probe_file__add_event(fd
[up
], tev
);
2996 nsinfo__mountns_exit(&nsc
);
3001 * Probes after the first probe which comes from same
3002 * user input are always allowed to add suffix, because
3003 * there might be several addresses corresponding to
3006 allow_suffix
= true;
3008 if (ret
== -EINVAL
&& pev
->uprobes
)
3009 warn_uprobe_event_compat(tev
);
3010 if (ret
== 0 && probe_conf
.cache
) {
3011 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
3013 probe_cache__add_entry(cache
, pev
, tevs
, ntevs
) < 0 ||
3014 probe_cache__commit(cache
) < 0)
3015 pr_warning("Failed to add event to probe cache\n");
3016 probe_cache__delete(cache
);
3020 for (up
= 0; up
< 2; up
++) {
3021 strlist__delete(namelist
[up
]);
3028 static int find_probe_functions(struct map
*map
, char *name
,
3029 struct symbol
**syms
)
3033 struct rb_node
*tmp
;
3034 const char *norm
, *ver
;
3036 bool cut_version
= true;
3038 if (map__load(map
) < 0)
3039 return -EACCES
; /* Possible permission error to load symbols */
3041 /* If user gives a version, don't cut off the version from symbols */
3042 if (strchr(name
, '@'))
3043 cut_version
= false;
3045 map__for_each_symbol(map
, sym
, tmp
) {
3046 norm
= arch__normalize_symbol_name(sym
->name
);
3051 /* We don't care about default symbol or not */
3052 ver
= strchr(norm
, '@');
3054 buf
= strndup(norm
, ver
- norm
);
3061 if (strglobmatch(norm
, name
)) {
3063 if (syms
&& found
< probe_conf
.max_probes
)
3064 syms
[found
- 1] = sym
;
3073 void __weak
arch__fix_tev_from_maps(struct perf_probe_event
*pev __maybe_unused
,
3074 struct probe_trace_event
*tev __maybe_unused
,
3075 struct map
*map __maybe_unused
,
3076 struct symbol
*sym __maybe_unused
) { }
3079 static void pr_kallsyms_access_error(void)
3081 pr_err("Please ensure you can read the /proc/kallsyms symbol addresses.\n"
3082 "If /proc/sys/kernel/kptr_restrict is '2', you can not read\n"
3083 "kernel symbol addresses even if you are a superuser. Please change\n"
3084 "it to '1'. If kptr_restrict is '1', the superuser can read the\n"
3085 "symbol addresses.\n"
3086 "In that case, please run this command again with sudo.\n");
3090 * Find probe function addresses from map.
3091 * Return an error or the number of found probe_trace_event
3093 static int find_probe_trace_events_from_map(struct perf_probe_event
*pev
,
3094 struct probe_trace_event
**tevs
)
3096 struct map
*map
= NULL
;
3097 struct ref_reloc_sym
*reloc_sym
= NULL
;
3099 struct symbol
**syms
= NULL
;
3100 struct probe_trace_event
*tev
;
3101 struct perf_probe_point
*pp
= &pev
->point
;
3102 struct probe_trace_point
*tp
;
3103 int num_matched_functions
;
3104 int ret
, i
, j
, skipped
= 0;
3107 map
= get_target_map(pev
->target
, pev
->nsi
, pev
->uprobes
);
3113 syms
= malloc(sizeof(struct symbol
*) * probe_conf
.max_probes
);
3120 * Load matched symbols: Since the different local symbols may have
3121 * same name but different addresses, this lists all the symbols.
3123 num_matched_functions
= find_probe_functions(map
, pp
->function
, syms
);
3124 if (num_matched_functions
<= 0) {
3125 if (num_matched_functions
== -EACCES
) {
3126 pr_err("Failed to load symbols from %s\n",
3127 pev
->target
?: "/proc/kallsyms");
3129 pr_err("Please ensure the file is not stripped.\n");
3131 pr_kallsyms_access_error();
3133 pr_err("Failed to find symbol %s in %s\n", pp
->function
,
3134 pev
->target
? : "kernel");
3137 } else if (num_matched_functions
> probe_conf
.max_probes
) {
3138 pr_err("Too many functions matched in %s\n",
3139 pev
->target
? : "kernel");
3144 /* Note that the symbols in the kmodule are not relocated */
3145 if (!pev
->uprobes
&& !pev
->target
&&
3146 (!pp
->retprobe
|| kretprobe_offset_is_supported())) {
3147 reloc_sym
= kernel_get_ref_reloc_sym(NULL
);
3149 pr_warning("Relocated base symbol is not found! "
3150 "Check /proc/sys/kernel/kptr_restrict\n"
3151 "and /proc/sys/kernel/perf_event_paranoid. "
3152 "Or run as privileged perf user.\n\n");
3158 /* Setup result trace-probe-events */
3159 *tevs
= zalloc(sizeof(*tev
) * num_matched_functions
);
3167 for (j
= 0; j
< num_matched_functions
; j
++) {
3170 if (sym
->type
!= STT_FUNC
)
3173 /* There can be duplicated symbols in the map */
3174 for (i
= 0; i
< j
; i
++)
3175 if (sym
->start
== syms
[i
]->start
) {
3176 pr_debug("Found duplicated symbol %s @ %" PRIx64
"\n",
3177 sym
->name
, sym
->start
);
3183 tev
= (*tevs
) + ret
;
3185 if (ret
== num_matched_functions
) {
3186 pr_warning("Too many symbols are listed. Skip it.\n");
3191 if (pp
->offset
> sym
->end
- sym
->start
) {
3192 pr_warning("Offset %ld is bigger than the size of %s\n",
3193 pp
->offset
, sym
->name
);
3197 /* Add one probe point */
3198 tp
->address
= map__unmap_ip(map
, sym
->start
) + pp
->offset
;
3200 /* Check the kprobe (not in module) is within .text */
3201 if (!pev
->uprobes
&& !pev
->target
&&
3202 kprobe_warn_out_range(sym
->name
, tp
->address
)) {
3203 tp
->symbol
= NULL
; /* Skip it */
3205 } else if (reloc_sym
) {
3206 tp
->symbol
= strdup_or_goto(reloc_sym
->name
, nomem_out
);
3207 tp
->offset
= tp
->address
- reloc_sym
->addr
;
3209 tp
->symbol
= strdup_or_goto(sym
->name
, nomem_out
);
3210 tp
->offset
= pp
->offset
;
3212 tp
->realname
= strdup_or_goto(sym
->name
, nomem_out
);
3214 tp
->retprobe
= pp
->retprobe
;
3217 tev
->point
.module
= strdup_or_goto(pev
->target
,
3220 mod_name
= find_module_name(pev
->target
);
3222 strdup(mod_name
? mod_name
: pev
->target
);
3224 if (!tev
->point
.module
)
3228 tev
->uprobes
= pev
->uprobes
;
3229 tev
->nargs
= pev
->nargs
;
3231 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) *
3233 if (tev
->args
== NULL
)
3236 for (i
= 0; i
< tev
->nargs
; i
++) {
3237 if (pev
->args
[i
].name
)
3239 strdup_or_goto(pev
->args
[i
].name
,
3242 tev
->args
[i
].value
= strdup_or_goto(pev
->args
[i
].var
,
3244 if (pev
->args
[i
].type
)
3246 strdup_or_goto(pev
->args
[i
].type
,
3249 arch__fix_tev_from_maps(pev
, tev
, map
, sym
);
3251 if (ret
== skipped
) {
3264 clear_probe_trace_events(*tevs
, num_matched_functions
);
3269 static int try_to_find_absolute_address(struct perf_probe_event
*pev
,
3270 struct probe_trace_event
**tevs
)
3272 struct perf_probe_point
*pp
= &pev
->point
;
3273 struct probe_trace_event
*tev
;
3274 struct probe_trace_point
*tp
;
3277 if (!(pev
->point
.function
&& !strncmp(pev
->point
.function
, "0x", 2)))
3279 if (perf_probe_event_need_dwarf(pev
))
3283 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3286 * Only one tev can be generated by this.
3288 *tevs
= zalloc(sizeof(*tev
));
3296 * Don't use tp->offset, use address directly, because
3297 * in synthesize_probe_trace_command() address cannot be
3300 tp
->address
= pev
->point
.abs_address
;
3301 tp
->retprobe
= pp
->retprobe
;
3302 tev
->uprobes
= pev
->uprobes
;
3306 * Give it a '0x' leading symbol name.
3307 * In __add_probe_trace_events, a NULL symbol is interpreted as
3310 if (asprintf(&tp
->symbol
, "0x%" PRIx64
, tp
->address
) < 0)
3313 /* For kprobe, check range */
3314 if ((!tev
->uprobes
) &&
3315 (kprobe_warn_out_range(tev
->point
.symbol
,
3316 tev
->point
.address
))) {
3321 if (asprintf(&tp
->realname
, "abs_%" PRIx64
, tp
->address
) < 0)
3325 tp
->module
= strdup(pev
->target
);
3331 tev
->group
= strdup(pev
->group
);
3337 tev
->event
= strdup(pev
->event
);
3342 tev
->nargs
= pev
->nargs
;
3343 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
3347 for (i
= 0; i
< tev
->nargs
; i
++)
3348 copy_to_probe_trace_arg(&tev
->args
[i
], &pev
->args
[i
]);
3353 clear_probe_trace_events(*tevs
, 1);
3358 /* Concatenate two arrays */
3359 static void *memcat(void *a
, size_t sz_a
, void *b
, size_t sz_b
)
3363 ret
= malloc(sz_a
+ sz_b
);
3365 memcpy(ret
, a
, sz_a
);
3366 memcpy(ret
+ sz_a
, b
, sz_b
);
3372 concat_probe_trace_events(struct probe_trace_event
**tevs
, int *ntevs
,
3373 struct probe_trace_event
**tevs2
, int ntevs2
)
3375 struct probe_trace_event
*new_tevs
;
3385 if (*ntevs
+ ntevs2
> probe_conf
.max_probes
)
3388 /* Concatenate the array of probe_trace_event */
3389 new_tevs
= memcat(*tevs
, (*ntevs
) * sizeof(**tevs
),
3390 *tevs2
, ntevs2
* sizeof(**tevs2
));
3400 clear_probe_trace_events(*tevs2
, ntevs2
);
3407 * Try to find probe_trace_event from given probe caches. Return the number
3408 * of cached events found, if an error occurs return the error.
3410 static int find_cached_events(struct perf_probe_event
*pev
,
3411 struct probe_trace_event
**tevs
,
3414 struct probe_cache
*cache
;
3415 struct probe_cache_entry
*entry
;
3416 struct probe_trace_event
*tmp_tevs
= NULL
;
3420 cache
= probe_cache__new(target
, pev
->nsi
);
3421 /* Return 0 ("not found") if the target has no probe cache. */
3425 for_each_probe_cache_entry(entry
, cache
) {
3426 /* Skip the cache entry which has no name */
3427 if (!entry
->pev
.event
|| !entry
->pev
.group
)
3429 if ((!pev
->group
|| strglobmatch(entry
->pev
.group
, pev
->group
)) &&
3430 strglobmatch(entry
->pev
.event
, pev
->event
)) {
3431 ret
= probe_cache_entry__get_event(entry
, &tmp_tevs
);
3433 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3439 probe_cache__delete(cache
);
3441 clear_probe_trace_events(*tevs
, ntevs
);
3445 if (ntevs
> 0 && target
&& target
[0] == '/')
3446 pev
->uprobes
= true;
3452 /* Try to find probe_trace_event from all probe caches */
3453 static int find_cached_events_all(struct perf_probe_event
*pev
,
3454 struct probe_trace_event
**tevs
)
3456 struct probe_trace_event
*tmp_tevs
= NULL
;
3457 struct strlist
*bidlist
;
3458 struct str_node
*nd
;
3463 /* Get the buildid list of all valid caches */
3464 bidlist
= build_id_cache__list_all(true);
3467 pr_debug("Failed to get buildids: %d\n", ret
);
3472 strlist__for_each_entry(nd
, bidlist
) {
3473 pathname
= build_id_cache__origname(nd
->s
);
3474 ret
= find_cached_events(pev
, &tmp_tevs
, pathname
);
3475 /* In the case of cnt == 0, we just skip it */
3477 ret
= concat_probe_trace_events(tevs
, &ntevs
,
3483 strlist__delete(bidlist
);
3486 clear_probe_trace_events(*tevs
, ntevs
);
3494 static int find_probe_trace_events_from_cache(struct perf_probe_event
*pev
,
3495 struct probe_trace_event
**tevs
)
3497 struct probe_cache
*cache
;
3498 struct probe_cache_entry
*entry
;
3499 struct probe_trace_event
*tev
;
3500 struct str_node
*node
;
3504 /* For SDT/cached events, we use special search functions */
3506 return find_cached_events_all(pev
, tevs
);
3508 return find_cached_events(pev
, tevs
, pev
->target
);
3510 cache
= probe_cache__new(pev
->target
, pev
->nsi
);
3514 entry
= probe_cache__find(cache
, pev
);
3516 /* SDT must be in the cache */
3517 ret
= pev
->sdt
? -ENOENT
: 0;
3521 ret
= strlist__nr_entries(entry
->tevlist
);
3522 if (ret
> probe_conf
.max_probes
) {
3523 pr_debug("Too many entries matched in the cache of %s\n",
3524 pev
->target
? : "kernel");
3529 *tevs
= zalloc(ret
* sizeof(*tev
));
3536 strlist__for_each_entry(node
, entry
->tevlist
) {
3537 tev
= &(*tevs
)[i
++];
3538 ret
= parse_probe_trace_command(node
->s
, tev
);
3541 /* Set the uprobes attribute as same as original */
3542 tev
->uprobes
= pev
->uprobes
;
3547 probe_cache__delete(cache
);
3551 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
3552 struct probe_trace_event
**tevs
)
3556 if (!pev
->group
&& !pev
->sdt
) {
3557 /* Set group name if not given */
3558 if (!pev
->uprobes
) {
3559 pev
->group
= strdup(PERFPROBE_GROUP
);
3560 ret
= pev
->group
? 0 : -ENOMEM
;
3562 ret
= convert_exec_to_group(pev
->target
, &pev
->group
);
3564 pr_warning("Failed to make a group name.\n");
3569 ret
= try_to_find_absolute_address(pev
, tevs
);
3573 /* At first, we need to lookup cache entry */
3574 ret
= find_probe_trace_events_from_cache(pev
, tevs
);
3575 if (ret
> 0 || pev
->sdt
) /* SDT can be found only in the cache */
3576 return ret
== 0 ? -ENOENT
: ret
; /* Found in probe cache */
3578 /* Convert perf_probe_event with debuginfo */
3579 ret
= try_to_find_probe_trace_events(pev
, tevs
);
3581 return ret
; /* Found in debuginfo or got an error */
3583 return find_probe_trace_events_from_map(pev
, tevs
);
3586 int convert_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3590 /* Loop 1: convert all events */
3591 for (i
= 0; i
< npevs
; i
++) {
3592 /* Init kprobe blacklist if needed */
3593 if (!pevs
[i
].uprobes
)
3594 kprobe_blacklist__init();
3595 /* Convert with or without debuginfo */
3596 ret
= convert_to_probe_trace_events(&pevs
[i
], &pevs
[i
].tevs
);
3599 pevs
[i
].ntevs
= ret
;
3601 /* This just release blacklist only if allocated */
3602 kprobe_blacklist__release();
3607 static int show_probe_trace_event(struct probe_trace_event
*tev
)
3609 char *buf
= synthesize_probe_trace_command(tev
);
3612 pr_debug("Failed to synthesize probe trace event.\n");
3616 /* Showing definition always go stdout */
3617 printf("%s\n", buf
);
3623 int show_probe_trace_events(struct perf_probe_event
*pevs
, int npevs
)
3625 struct strlist
*namelist
= strlist__new(NULL
, NULL
);
3626 struct probe_trace_event
*tev
;
3627 struct perf_probe_event
*pev
;
3633 for (j
= 0; j
< npevs
&& !ret
; j
++) {
3635 for (i
= 0; i
< pev
->ntevs
&& !ret
; i
++) {
3636 tev
= &pev
->tevs
[i
];
3637 /* Skip if the symbol is out of .text or blacklisted */
3638 if (!tev
->point
.symbol
&& !pev
->uprobes
)
3641 /* Set new name for tev (and update namelist) */
3642 ret
= probe_trace_event__set_name(tev
, pev
,
3645 ret
= show_probe_trace_event(tev
);
3648 strlist__delete(namelist
);
3653 static int show_bootconfig_event(struct probe_trace_event
*tev
)
3655 struct probe_trace_point
*tp
= &tev
->point
;
3660 if (strbuf_init(&buf
, 32) < 0)
3663 err
= synthesize_kprobe_trace_def(tp
, &buf
);
3665 err
= synthesize_probe_trace_args(tev
, &buf
);
3667 ret
= strbuf_detach(&buf
, NULL
);
3668 strbuf_release(&buf
);
3671 printf("'%s'", ret
);
3678 int show_bootconfig_events(struct perf_probe_event
*pevs
, int npevs
)
3680 struct strlist
*namelist
= strlist__new(NULL
, NULL
);
3681 struct probe_trace_event
*tev
;
3682 struct perf_probe_event
*pev
;
3683 char *cur_name
= NULL
;
3689 for (j
= 0; j
< npevs
&& !ret
; j
++) {
3691 if (pev
->group
&& strcmp(pev
->group
, "probe"))
3692 pr_warning("WARN: Group name %s is ignored\n", pev
->group
);
3694 pr_warning("ERROR: Bootconfig doesn't support uprobes\n");
3698 for (i
= 0; i
< pev
->ntevs
&& !ret
; i
++) {
3699 tev
= &pev
->tevs
[i
];
3700 /* Skip if the symbol is out of .text or blacklisted */
3701 if (!tev
->point
.symbol
&& !pev
->uprobes
)
3704 /* Set new name for tev (and update namelist) */
3705 ret
= probe_trace_event__set_name(tev
, pev
,
3710 if (!cur_name
|| strcmp(cur_name
, tev
->event
)) {
3711 printf("%sftrace.event.kprobes.%s.probe = ",
3712 cur_name
? "\n" : "", tev
->event
);
3713 cur_name
= tev
->event
;
3716 ret
= show_bootconfig_event(tev
);
3720 strlist__delete(namelist
);
3725 int apply_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3729 /* Loop 2: add all events */
3730 for (i
= 0; i
< npevs
; i
++) {
3731 ret
= __add_probe_trace_events(&pevs
[i
], pevs
[i
].tevs
,
3733 probe_conf
.force_add
);
3740 void cleanup_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
)
3743 struct perf_probe_event
*pev
;
3745 /* Loop 3: cleanup and free trace events */
3746 for (i
= 0; i
< npevs
; i
++) {
3748 for (j
= 0; j
< pevs
[i
].ntevs
; j
++)
3749 clear_probe_trace_event(&pevs
[i
].tevs
[j
]);
3750 zfree(&pevs
[i
].tevs
);
3752 nsinfo__zput(pev
->nsi
);
3753 clear_perf_probe_event(&pevs
[i
]);
3757 int show_available_funcs(const char *target
, struct nsinfo
*nsi
,
3758 struct strfilter
*_filter
, bool user
)
3764 ret
= init_probe_symbol_maps(user
);
3768 /* Get a symbol map */
3769 map
= get_target_map(target
, nsi
, user
);
3771 pr_err("Failed to get a map for %s\n", (target
) ? : "kernel");
3775 ret
= map__load(map
);
3778 char *str
= strfilter__string(_filter
);
3779 pr_err("Failed to find symbols matched to \"%s\"\n",
3783 pr_err("Failed to load symbols in %s\n",
3784 (target
) ? : "kernel");
3787 dso
= map__dso(map
);
3788 dso__sort_by_name(dso
);
3790 /* Show all (filtered) symbols */
3793 for (size_t i
= 0; i
< dso__symbol_names_len(dso
); i
++) {
3794 struct symbol
*pos
= dso__symbol_names(dso
)[i
];
3796 if (strfilter__compare(_filter
, pos
->name
))
3797 printf("%s\n", pos
->name
);
3801 exit_probe_symbol_maps();
3806 int copy_to_probe_trace_arg(struct probe_trace_arg
*tvar
,
3807 struct perf_probe_arg
*pvar
)
3809 tvar
->value
= strdup(pvar
->var
);
3810 if (tvar
->value
== NULL
)
3813 tvar
->type
= strdup(pvar
->type
);
3814 if (tvar
->type
== NULL
)
3818 tvar
->name
= strdup(pvar
->name
);
3819 if (tvar
->name
== NULL
)