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 #ifdef HAVE_DEBUGINFOD_SUPPORT
47 #include <elfutils/debuginfod.h>
50 #define PERFPROBE_GROUP "probe"
52 bool probe_event_dry_run; /* Dry run flag */
53 struct probe_conf probe_conf = { .magic_num = DEFAULT_PROBE_MAGIC_NUM };
55 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
57 int e_snprintf(char *str, size_t size, const char *format, ...)
62 ret = vsnprintf(str, size, format, ap);
69 static struct machine *host_machine;
71 /* Initialize symbol maps and path of vmlinux/modules */
72 int init_probe_symbol_maps(bool user_only)
76 symbol_conf.sort_by_name = true;
77 symbol_conf.allow_aliases = true;
78 ret = symbol__init(NULL);
80 pr_debug("Failed to init symbol map.\n");
84 if (host_machine || user_only) /* already initialized */
87 if (symbol_conf.vmlinux_name)
88 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
90 host_machine = machine__new_host();
92 pr_debug("machine__new_host() failed.\n");
98 pr_warning("Failed to init vmlinux path.\n");
102 void exit_probe_symbol_maps(void)
104 machine__delete(host_machine);
109 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(struct map **pmap)
112 struct map *map = machine__kernel_map(host_machine);
114 if (map__load(map) < 0)
117 kmap = map__kmap(map);
124 return kmap->ref_reloc_sym;
127 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
128 bool reloc, bool reladdr)
130 struct ref_reloc_sym *reloc_sym;
134 /* ref_reloc_sym is just a label. Need a special fix*/
135 reloc_sym = kernel_get_ref_reloc_sym(&map);
136 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
137 *addr = (!map->reloc || reloc) ? reloc_sym->addr :
138 reloc_sym->unrelocated_addr;
140 sym = machine__find_kernel_symbol_by_name(host_machine, name, &map);
143 *addr = map->unmap_ip(map, sym->start) -
144 ((reloc) ? 0 : map->reloc) -
145 ((reladdr) ? map->start : 0);
150 static struct map *kernel_get_module_map(const char *module)
152 struct maps *maps = machine__kernel_maps(host_machine);
155 /* A file path -- this is an offline module */
156 if (module && strchr(module, '/'))
157 return dso__new_map(module);
160 pos = machine__kernel_map(host_machine);
161 return map__get(pos);
164 maps__for_each_entry(maps, pos) {
165 /* short_name is "[module]" */
166 if (strncmp(pos->dso->short_name + 1, module,
167 pos->dso->short_name_len - 2) == 0 &&
168 module[pos->dso->short_name_len - 2] == '\0') {
169 return map__get(pos);
175 struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user)
177 /* Init maps of given executable or kernel */
181 map = dso__new_map(target);
182 if (map && map->dso) {
183 nsinfo__put(map->dso->nsinfo);
184 map->dso->nsinfo = nsinfo__get(nsi);
188 return kernel_get_module_map(target);
192 static int convert_exec_to_group(const char *exec, char **result)
194 char *ptr1, *ptr2, *exec_copy;
198 exec_copy = strdup(exec);
202 ptr1 = basename(exec_copy);
208 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
209 if (!isalnum(*ptr2) && *ptr2 != '_') {
215 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
219 *result = strdup(buf);
220 ret = *result ? 0 : -ENOMEM;
227 static void clear_perf_probe_point(struct perf_probe_point *pp)
230 zfree(&pp->function);
231 zfree(&pp->lazy_line);
234 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
238 for (i = 0; i < ntevs; i++)
239 clear_probe_trace_event(tevs + i);
242 static bool kprobe_blacklist__listed(u64 address);
243 static bool kprobe_warn_out_range(const char *symbol, u64 address)
248 map = kernel_get_module_map(NULL);
250 ret = address <= map->start || map->end < address;
252 pr_warning("%s is out of .text, skip it.\n", symbol);
255 if (!ret && kprobe_blacklist__listed(address)) {
256 pr_warning("%s is blacklisted function, skip it.\n", symbol);
264 * @module can be module name of module file path. In case of path,
265 * inspect elf and find out what is actual module name.
266 * Caller has to free mod_name after using it.
268 static char *find_module_name(const char *module)
276 char *mod_name = NULL;
279 fd = open(module, O_RDONLY);
283 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
287 if (gelf_getehdr(elf, &ehdr) == NULL)
290 sec = elf_section_by_name(elf, &ehdr, &shdr,
291 ".gnu.linkonce.this_module", NULL);
295 data = elf_getdata(sec, NULL);
296 if (!data || !data->d_buf)
301 * '.gnu.linkonce.this_module' section of kernel module elf directly
302 * maps to 'struct module' from linux/module.h. This section contains
303 * actual module name which will be used by kernel after loading it.
304 * But, we cannot use 'struct module' here since linux/module.h is not
305 * exposed to user-space. Offset of 'name' has remained same from long
306 * time, so hardcoding it here.
308 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
310 else /* expect ELFCLASS64 by default */
313 mod_name = strdup((char *)data->d_buf + name_offset);
322 #ifdef HAVE_DWARF_SUPPORT
324 static int kernel_get_module_dso(const char *module, struct dso **pdso)
328 const char *vmlinux_name;
332 char module_name[128];
334 snprintf(module_name, sizeof(module_name), "[%s]", module);
335 map = maps__find_by_name(machine__kernel_maps(host_machine), module_name);
340 pr_debug("Failed to find module %s.\n", module);
344 map = machine__kernel_map(host_machine);
346 if (!dso->has_build_id)
347 dso__read_running_kernel_build_id(dso, host_machine);
349 vmlinux_name = symbol_conf.vmlinux_name;
352 ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
354 ret = dso__load_vmlinux_path(dso, map);
361 * Some binaries like glibc have special symbols which are on the symbol
362 * table, but not in the debuginfo. If we can find the address of the
363 * symbol from map, we can translate the address back to the probe point.
365 static int find_alternative_probe_point(struct debuginfo *dinfo,
366 struct perf_probe_point *pp,
367 struct perf_probe_point *result,
368 const char *target, struct nsinfo *nsi,
371 struct map *map = NULL;
376 /* This can work only for function-name based one */
377 if (!pp->function || pp->file)
380 map = get_target_map(target, nsi, uprobes);
384 /* Find the address of given function */
385 map__for_each_symbol_by_name(map, pp->function, sym) {
387 address = sym->start;
388 if (sym->type == STT_GNU_IFUNC)
389 pr_warning("Warning: The probe function (%s) is a GNU indirect function.\n"
390 "Consider identifying the final function used at run time and set the probe directly on that.\n",
393 address = map->unmap_ip(map, sym->start) - map->reloc;
400 pr_debug("Symbol %s address found : %" PRIx64 "\n",
401 pp->function, address);
403 ret = debuginfo__find_probe_point(dinfo, address, result);
405 ret = (!ret) ? -ENOENT : ret;
407 result->offset += pp->offset;
408 result->line += pp->line;
409 result->retprobe = pp->retprobe;
419 static int get_alternative_probe_event(struct debuginfo *dinfo,
420 struct perf_probe_event *pev,
421 struct perf_probe_point *tmp)
425 memcpy(tmp, &pev->point, sizeof(*tmp));
426 memset(&pev->point, 0, sizeof(pev->point));
427 ret = find_alternative_probe_point(dinfo, tmp, &pev->point, pev->target,
428 pev->nsi, pev->uprobes);
430 memcpy(&pev->point, tmp, sizeof(*tmp));
435 static int get_alternative_line_range(struct debuginfo *dinfo,
436 struct line_range *lr,
437 const char *target, bool user)
439 struct perf_probe_point pp = { .function = lr->function,
442 struct perf_probe_point result;
445 memset(&result, 0, sizeof(result));
447 if (lr->end != INT_MAX)
448 len = lr->end - lr->start;
449 ret = find_alternative_probe_point(dinfo, &pp, &result,
452 lr->function = result.function;
453 lr->file = result.file;
454 lr->start = result.line;
455 if (lr->end != INT_MAX)
456 lr->end = lr->start + len;
457 clear_perf_probe_point(&pp);
462 #ifdef HAVE_DEBUGINFOD_SUPPORT
463 static struct debuginfo *open_from_debuginfod(struct dso *dso, struct nsinfo *nsi,
466 debuginfod_client *c = debuginfod_begin();
467 char sbuild_id[SBUILD_ID_SIZE + 1];
468 struct debuginfo *ret = NULL;
476 build_id__sprintf(&dso->bid, sbuild_id);
477 fd = debuginfod_find_debuginfo(c, (const unsigned char *)sbuild_id,
484 pr_debug("Failed to find debuginfo in debuginfod.\n");
488 pr_debug("Load debuginfo from debuginfod (%s)\n", path);
490 nsinfo__mountns_enter(nsi, &nsc);
491 ret = debuginfo__new((const char *)path);
492 nsinfo__mountns_exit(&nsc);
497 struct debuginfo *open_from_debuginfod(struct dso *dso __maybe_unused,
498 struct nsinfo *nsi __maybe_unused,
499 bool silent __maybe_unused)
505 /* Open new debuginfo of given module */
506 static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi,
509 const char *path = module;
510 char reason[STRERR_BUFSIZE];
511 struct debuginfo *ret = NULL;
512 struct dso *dso = NULL;
516 if (!module || !strchr(module, '/')) {
517 err = kernel_get_module_dso(module, &dso);
519 if (!dso || dso->load_errno == 0) {
520 if (!str_error_r(-err, reason, STRERR_BUFSIZE))
521 strcpy(reason, "(unknown)");
523 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
525 ret = open_from_debuginfod(dso, nsi, silent);
530 pr_err("Module %s is not loaded, please specify its full path name.\n", module);
532 pr_err("Failed to find the path for the kernel: %s\n", reason);
536 path = dso->long_name;
538 nsinfo__mountns_enter(nsi, &nsc);
539 ret = debuginfo__new(path);
540 if (!ret && !silent) {
541 pr_warning("The %s file has no debug information.\n", path);
542 if (!module || !strtailcmp(path, ".ko"))
543 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
545 pr_warning("Rebuild with -g, ");
546 pr_warning("or install an appropriate debuginfo package.\n");
548 nsinfo__mountns_exit(&nsc);
552 /* For caching the last debuginfo */
553 static struct debuginfo *debuginfo_cache;
554 static char *debuginfo_cache_path;
556 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
558 const char *path = module;
560 /* If the module is NULL, it should be the kernel. */
564 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
567 /* Copy module path */
568 free(debuginfo_cache_path);
569 debuginfo_cache_path = strdup(path);
570 if (!debuginfo_cache_path) {
571 debuginfo__delete(debuginfo_cache);
572 debuginfo_cache = NULL;
576 debuginfo_cache = open_debuginfo(module, NULL, silent);
577 if (!debuginfo_cache)
578 zfree(&debuginfo_cache_path);
580 return debuginfo_cache;
583 static void debuginfo_cache__exit(void)
585 debuginfo__delete(debuginfo_cache);
586 debuginfo_cache = NULL;
587 zfree(&debuginfo_cache_path);
591 static int get_text_start_address(const char *exec, u64 *address,
597 int fd, ret = -ENOENT;
600 nsinfo__mountns_enter(nsi, &nsc);
601 fd = open(exec, O_RDONLY);
602 nsinfo__mountns_exit(&nsc);
606 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
612 if (gelf_getehdr(elf, &ehdr) == NULL)
615 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
618 *address = shdr.sh_addr - shdr.sh_offset;
629 * Convert trace point to probe point with debuginfo
631 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
632 struct perf_probe_point *pp,
635 struct debuginfo *dinfo = NULL;
637 u64 addr = tp->address;
640 /* convert the address to dwarf address */
646 ret = get_text_start_address(tp->module, &stext, NULL);
650 } else if (tp->symbol) {
651 /* If the module is given, this returns relative address */
652 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
653 false, !!tp->module);
659 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
660 tp->module ? : "kernel");
662 dinfo = debuginfo_cache__open(tp->module, verbose <= 0);
664 ret = debuginfo__find_probe_point(dinfo, addr, pp);
669 pp->retprobe = tp->retprobe;
673 pr_debug("Failed to find corresponding probes from debuginfo.\n");
674 return ret ? : -ENOENT;
677 /* Adjust symbol name and address */
678 static int post_process_probe_trace_point(struct probe_trace_point *tp,
679 struct map *map, u64 offs)
682 u64 addr = tp->address - offs;
684 sym = map__find_symbol(map, addr);
687 * If the address is in the inittext section, map can not
688 * find it. Ignore it if we are probing offline kernel.
690 return (symbol_conf.ignore_vmlinux_buildid) ? 0 : -ENOENT;
693 if (strcmp(sym->name, tp->symbol)) {
694 /* If we have no realname, use symbol for it */
696 tp->realname = tp->symbol;
699 tp->symbol = strdup(sym->name);
703 tp->offset = addr - sym->start;
710 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
711 * and generate new symbols with suffixes such as .constprop.N or .isra.N
712 * etc. Since those symbols are not recorded in DWARF, we have to find
713 * correct generated symbols from offline ELF binary.
714 * For online kernel or uprobes we don't need this because those are
715 * rebased on _text, or already a section relative address.
718 post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
719 int ntevs, const char *pathname)
725 /* Prepare a map for offline binary */
726 map = dso__new_map(pathname);
727 if (!map || get_text_start_address(pathname, &stext, NULL) < 0) {
728 pr_warning("Failed to get ELF symbols for %s\n", pathname);
732 for (i = 0; i < ntevs; i++) {
733 ret = post_process_probe_trace_point(&tevs[i].point,
743 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
744 int ntevs, const char *exec,
753 ret = get_text_start_address(exec, &stext, nsi);
757 for (i = 0; i < ntevs && ret >= 0; i++) {
758 /* point.address is the address of point.symbol + point.offset */
759 tevs[i].point.address -= stext;
760 tevs[i].point.module = strdup(exec);
761 if (!tevs[i].point.module) {
765 tevs[i].uprobes = true;
772 post_process_module_probe_trace_events(struct probe_trace_event *tevs,
773 int ntevs, const char *module,
774 struct debuginfo *dinfo)
776 Dwarf_Addr text_offs = 0;
778 char *mod_name = NULL;
784 map = get_target_map(module, NULL, false);
785 if (!map || debuginfo__get_text_offset(dinfo, &text_offs, true) < 0) {
786 pr_warning("Failed to get ELF symbols for %s\n", module);
790 mod_name = find_module_name(module);
791 for (i = 0; i < ntevs; i++) {
792 ret = post_process_probe_trace_point(&tevs[i].point,
796 tevs[i].point.module =
797 strdup(mod_name ? mod_name : module);
798 if (!tevs[i].point.module) {
811 post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
814 struct ref_reloc_sym *reloc_sym;
819 /* Skip post process if the target is an offline kernel */
820 if (symbol_conf.ignore_vmlinux_buildid)
821 return post_process_offline_probe_trace_events(tevs, ntevs,
822 symbol_conf.vmlinux_name);
824 reloc_sym = kernel_get_ref_reloc_sym(&map);
826 pr_warning("Relocated base symbol is not found! "
827 "Check /proc/sys/kernel/kptr_restrict\n"
828 "and /proc/sys/kernel/perf_event_paranoid. "
829 "Or run as privileged perf user.\n\n");
833 for (i = 0; i < ntevs; i++) {
834 if (!tevs[i].point.address)
836 if (tevs[i].point.retprobe && !kretprobe_offset_is_supported())
839 * If we found a wrong one, mark it by NULL symbol.
840 * Since addresses in debuginfo is same as objdump, we need
841 * to convert it to addresses on memory.
843 if (kprobe_warn_out_range(tevs[i].point.symbol,
844 map__objdump_2mem(map, tevs[i].point.address))) {
848 tmp = strdup(reloc_sym->name);
852 /* If we have no realname, use symbol for it */
853 if (!tevs[i].point.realname)
854 tevs[i].point.realname = tevs[i].point.symbol;
856 free(tevs[i].point.symbol);
857 tevs[i].point.symbol = tmp;
858 tevs[i].point.offset = tevs[i].point.address -
859 (map->reloc ? reloc_sym->unrelocated_addr :
866 arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
867 int ntevs __maybe_unused)
871 /* Post processing the probe events */
872 static int post_process_probe_trace_events(struct perf_probe_event *pev,
873 struct probe_trace_event *tevs,
874 int ntevs, const char *module,
875 bool uprobe, struct debuginfo *dinfo)
880 ret = add_exec_to_probe_trace_events(tevs, ntevs, module,
883 /* Currently ref_reloc_sym based probe is not for drivers */
884 ret = post_process_module_probe_trace_events(tevs, ntevs,
887 ret = post_process_kernel_probe_trace_events(tevs, ntevs);
890 arch__post_process_probe_trace_events(pev, ntevs);
895 /* Try to find perf_probe_event with debuginfo */
896 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
897 struct probe_trace_event **tevs)
899 bool need_dwarf = perf_probe_event_need_dwarf(pev);
900 struct perf_probe_point tmp;
901 struct debuginfo *dinfo;
904 /* Workaround for gcc #98776 issue.
905 * Perf failed to add kretprobe event with debuginfo of vmlinux which is
906 * compiled by gcc with -fpatchable-function-entry option enabled. The
907 * same issue with kernel module. The retprobe doesn`t need debuginfo.
908 * This workaround solution use map to query the probe function address
909 * for retprobe event.
911 if (pev->point.retprobe)
914 dinfo = open_debuginfo(pev->target, pev->nsi, !need_dwarf);
918 pr_debug("Could not open debuginfo. Try to use symbols.\n");
922 pr_debug("Try to find probe point from debuginfo.\n");
923 /* Searching trace events corresponding to a probe event */
924 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
926 if (ntevs == 0) { /* Not found, retry with an alternative */
927 ret = get_alternative_probe_event(dinfo, pev, &tmp);
929 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
931 * Write back to the original probe_event for
932 * setting appropriate (user given) event name
934 clear_perf_probe_point(&pev->point);
935 memcpy(&pev->point, &tmp, sizeof(tmp));
939 if (ntevs > 0) { /* Succeeded to find trace events */
940 pr_debug("Found %d probe_trace_events.\n", ntevs);
941 ret = post_process_probe_trace_events(pev, *tevs, ntevs,
942 pev->target, pev->uprobes, dinfo);
943 if (ret < 0 || ret == ntevs) {
944 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret);
945 clear_probe_trace_events(*tevs, ntevs);
951 debuginfo__delete(dinfo);
953 if (ntevs == 0) { /* No error but failed to find probe point. */
954 pr_warning("Probe point '%s' not found.\n",
955 synthesize_perf_probe_point(&pev->point));
957 } else if (ntevs < 0) {
958 /* Error path : ntevs < 0 */
959 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
961 pr_warning("Warning: No dwarf info found in the vmlinux - "
962 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
964 pr_debug("Trying to use symbols.\n");
971 #define LINEBUF_SIZE 256
972 #define NR_ADDITIONAL_LINES 2
974 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
976 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
977 const char *color = show_num ? "" : PERF_COLOR_BLUE;
978 const char *prefix = NULL;
981 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
986 prefix = show_num ? "%7d " : " ";
987 color_fprintf(stdout, color, prefix, l);
989 color_fprintf(stdout, color, "%s", buf);
991 } while (strchr(buf, '\n') == NULL);
996 pr_warning("File read error: %s\n",
997 str_error_r(errno, sbuf, sizeof(sbuf)));
1003 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
1005 int rv = __show_one_line(fp, l, skip, show_num);
1007 pr_warning("Source file is shorter than expected.\n");
1013 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
1014 #define show_one_line(f,l) _show_one_line(f,l,false,false)
1015 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
1016 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
1019 * Show line-range always requires debuginfo to find source file and
1022 static int __show_line_range(struct line_range *lr, const char *module,
1025 struct build_id bid;
1027 struct int_node *ln;
1028 struct debuginfo *dinfo;
1032 char sbuf[STRERR_BUFSIZE];
1033 char sbuild_id[SBUILD_ID_SIZE] = "";
1035 /* Search a line range */
1036 dinfo = open_debuginfo(module, NULL, false);
1040 ret = debuginfo__find_line_range(dinfo, lr);
1041 if (!ret) { /* Not found, retry with an alternative */
1042 ret = get_alternative_line_range(dinfo, lr, module, user);
1044 ret = debuginfo__find_line_range(dinfo, lr);
1046 if (dinfo->build_id) {
1047 build_id__init(&bid, dinfo->build_id, BUILD_ID_SIZE);
1048 build_id__sprintf(&bid, sbuild_id);
1050 debuginfo__delete(dinfo);
1051 if (ret == 0 || ret == -ENOENT) {
1052 pr_warning("Specified source line is not found.\n");
1054 } else if (ret < 0) {
1055 pr_warning("Debuginfo analysis failed.\n");
1059 /* Convert source file path */
1061 ret = find_source_path(tmp, sbuild_id, lr->comp_dir, &lr->path);
1063 /* Free old path when new path is assigned */
1064 if (tmp != lr->path)
1068 pr_warning("Failed to find source file path.\n");
1075 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
1076 lr->start - lr->offset);
1078 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
1080 fp = fopen(lr->path, "r");
1082 pr_warning("Failed to open %s: %s\n", lr->path,
1083 str_error_r(errno, sbuf, sizeof(sbuf)));
1086 /* Skip to starting line number */
1087 while (l < lr->start) {
1088 ret = skip_one_line(fp, l++);
1093 intlist__for_each_entry(ln, lr->line_list) {
1094 for (; ln->i > (unsigned long)l; l++) {
1095 ret = show_one_line(fp, l - lr->offset);
1099 ret = show_one_line_with_num(fp, l++ - lr->offset);
1104 if (lr->end == INT_MAX)
1105 lr->end = l + NR_ADDITIONAL_LINES;
1106 while (l <= lr->end) {
1107 ret = show_one_line_or_eof(fp, l++ - lr->offset);
1116 int show_line_range(struct line_range *lr, const char *module,
1117 struct nsinfo *nsi, bool user)
1120 struct nscookie nsc;
1122 ret = init_probe_symbol_maps(user);
1125 nsinfo__mountns_enter(nsi, &nsc);
1126 ret = __show_line_range(lr, module, user);
1127 nsinfo__mountns_exit(&nsc);
1128 exit_probe_symbol_maps();
1133 static int show_available_vars_at(struct debuginfo *dinfo,
1134 struct perf_probe_event *pev,
1135 struct strfilter *_filter)
1139 struct str_node *node;
1140 struct variable_list *vls = NULL, *vl;
1141 struct perf_probe_point tmp;
1144 buf = synthesize_perf_probe_point(&pev->point);
1147 pr_debug("Searching variables at %s\n", buf);
1149 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
1150 if (!ret) { /* Not found, retry with an alternative */
1151 ret = get_alternative_probe_event(dinfo, pev, &tmp);
1153 ret = debuginfo__find_available_vars_at(dinfo, pev,
1155 /* Release the old probe_point */
1156 clear_perf_probe_point(&tmp);
1160 if (ret == 0 || ret == -ENOENT) {
1161 pr_err("Failed to find the address of %s\n", buf);
1164 pr_warning("Debuginfo analysis failed.\n");
1168 /* Some variables are found */
1169 fprintf(stdout, "Available variables at %s\n", buf);
1170 for (i = 0; i < ret; i++) {
1173 * A probe point might be converted to
1174 * several trace points.
1176 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
1178 zfree(&vl->point.symbol);
1181 strlist__for_each_entry(node, vl->vars) {
1182 var = strchr(node->s, '\t') + 1;
1183 if (strfilter__compare(_filter, var)) {
1184 fprintf(stdout, "\t\t%s\n", node->s);
1188 strlist__delete(vl->vars);
1191 fprintf(stdout, "\t\t(No matched variables)\n");
1199 /* Show available variables on given probe point */
1200 int show_available_vars(struct perf_probe_event *pevs, int npevs,
1201 struct strfilter *_filter)
1204 struct debuginfo *dinfo;
1206 ret = init_probe_symbol_maps(pevs->uprobes);
1210 dinfo = open_debuginfo(pevs->target, pevs->nsi, false);
1218 for (i = 0; i < npevs && ret >= 0; i++)
1219 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1221 debuginfo__delete(dinfo);
1223 exit_probe_symbol_maps();
1227 #else /* !HAVE_DWARF_SUPPORT */
1229 static void debuginfo_cache__exit(void)
1234 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1235 struct perf_probe_point *pp __maybe_unused,
1236 bool is_kprobe __maybe_unused)
1241 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1242 struct probe_trace_event **tevs __maybe_unused)
1244 if (perf_probe_event_need_dwarf(pev)) {
1245 pr_warning("Debuginfo-analysis is not supported.\n");
1252 int show_line_range(struct line_range *lr __maybe_unused,
1253 const char *module __maybe_unused,
1254 struct nsinfo *nsi __maybe_unused,
1255 bool user __maybe_unused)
1257 pr_warning("Debuginfo-analysis is not supported.\n");
1261 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1262 int npevs __maybe_unused,
1263 struct strfilter *filter __maybe_unused)
1265 pr_warning("Debuginfo-analysis is not supported.\n");
1270 void line_range__clear(struct line_range *lr)
1272 zfree(&lr->function);
1275 zfree(&lr->comp_dir);
1276 intlist__delete(lr->line_list);
1279 int line_range__init(struct line_range *lr)
1281 memset(lr, 0, sizeof(*lr));
1282 lr->line_list = intlist__new(NULL);
1289 static int parse_line_num(char **ptr, int *val, const char *what)
1291 const char *start = *ptr;
1294 *val = strtol(*ptr, ptr, 0);
1295 if (errno || *ptr == start) {
1296 semantic_error("'%s' is not a valid number.\n", what);
1302 /* Check the name is good for event, group or function */
1303 static bool is_c_func_name(const char *name)
1305 if (!isalpha(*name) && *name != '_')
1307 while (*++name != '\0') {
1308 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1315 * Stuff 'lr' according to the line range described by 'arg'.
1316 * The line range syntax is described by:
1318 * SRC[:SLN[+NUM|-ELN]]
1319 * FNC[@SRC][:SLN[+NUM|-ELN]]
1321 int parse_line_range_desc(const char *arg, struct line_range *lr)
1323 char *range, *file, *name = strdup(arg);
1332 range = strchr(name, ':');
1336 err = parse_line_num(&range, &lr->start, "start line");
1340 if (*range == '+' || *range == '-') {
1341 const char c = *range++;
1343 err = parse_line_num(&range, &lr->end, "end line");
1348 lr->end += lr->start;
1350 * Adjust the number of lines here.
1351 * If the number of lines == 1, the
1352 * the end of line should be equal to
1353 * the start of line.
1359 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1362 if (lr->start > lr->end) {
1363 semantic_error("Start line must be smaller"
1364 " than end line.\n");
1367 if (*range != '\0') {
1368 semantic_error("Tailing with invalid str '%s'.\n", range);
1373 file = strchr(name, '@');
1376 lr->file = strdup(++file);
1377 if (lr->file == NULL) {
1381 lr->function = name;
1382 } else if (strchr(name, '/') || strchr(name, '.'))
1384 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1385 lr->function = name;
1386 else { /* Invalid name */
1387 semantic_error("'%s' is not a valid function name.\n", name);
1398 static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
1402 ptr = strpbrk_esc(*arg, ":");
1405 if (!pev->sdt && !is_c_func_name(*arg))
1407 pev->group = strdup_esc(*arg);
1414 pev->event = strdup_esc(*arg);
1415 if (pev->event == NULL)
1418 if (!pev->sdt && !is_c_func_name(pev->event)) {
1422 semantic_error("%s is bad for event name -it must "
1423 "follow C symbol-naming rule.\n", *arg);
1429 /* Parse probepoint definition. */
1430 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1432 struct perf_probe_point *pp = &pev->point;
1435 bool file_spec = false;
1440 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1441 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1442 * perf probe %[GRP:]SDT_EVENT
1447 if (is_sdt_event(arg)) {
1453 ptr = strpbrk_esc(arg, ";=@+%");
1457 semantic_error("%s must be an SDT name.\n",
1461 /* This must be a target file name or build id */
1462 tmp = build_id_cache__complement(ptr + 1);
1464 pev->target = build_id_cache__origname(tmp);
1467 pev->target = strdup_esc(ptr + 1);
1472 ret = parse_perf_probe_event_name(&arg, pev);
1474 if (asprintf(&pev->point.function, "%%%s", pev->event) < 0)
1480 if (ptr && *ptr == '=') { /* Event name */
1483 ret = parse_perf_probe_event_name(&arg, pev);
1491 * Check arg is function or file name and copy it.
1493 * We consider arg to be a file spec if and only if it satisfies
1494 * all of the below criteria::
1495 * - it does not include any of "+@%",
1496 * - it includes one of ":;", and
1497 * - it has a period '.' in the name.
1499 * Otherwise, we consider arg to be a function specification.
1501 if (!strpbrk_esc(arg, "+@%")) {
1502 ptr = strpbrk_esc(arg, ";:");
1503 /* This is a file spec if it includes a '.' before ; or : */
1504 if (ptr && memchr(arg, '.', ptr - arg))
1508 ptr = strpbrk_esc(arg, ";:+@%");
1517 tmp = strdup_esc(arg);
1528 * Keep pp->function even if this is absolute address,
1529 * so it can mark whether abs_address is valid.
1530 * Which make 'perf probe lib.bin 0x0' possible.
1532 * Note that checking length of tmp is not needed
1533 * because when we access tmp[1] we know tmp[0] is '0',
1534 * so tmp[1] should always valid (but could be '\0').
1536 if (tmp && !strncmp(tmp, "0x", 2)) {
1537 pp->abs_address = strtoull(pp->function, &tmp, 0);
1539 semantic_error("Invalid absolute address.\n");
1545 /* Parse other options */
1549 if (c == ';') { /* Lazy pattern must be the last part */
1550 pp->lazy_line = strdup(arg); /* let leave escapes */
1551 if (pp->lazy_line == NULL)
1555 ptr = strpbrk_esc(arg, ";:+@%");
1561 case ':': /* Line number */
1562 pp->line = strtoul(arg, &tmp, 0);
1564 semantic_error("There is non-digit char"
1565 " in line number.\n");
1569 case '+': /* Byte offset from a symbol */
1570 pp->offset = strtoul(arg, &tmp, 0);
1572 semantic_error("There is non-digit character"
1577 case '@': /* File name */
1579 semantic_error("SRC@SRC is not allowed.\n");
1582 pp->file = strdup_esc(arg);
1583 if (pp->file == NULL)
1586 case '%': /* Probe places */
1587 if (strcmp(arg, "return") == 0) {
1589 } else { /* Others not supported yet */
1590 semantic_error("%%%s is not supported.\n", arg);
1594 default: /* Buggy case */
1595 pr_err("This program has a bug at %s:%d.\n",
1596 __FILE__, __LINE__);
1602 /* Exclusion check */
1603 if (pp->lazy_line && pp->line) {
1604 semantic_error("Lazy pattern can't be used with"
1609 if (pp->lazy_line && pp->offset) {
1610 semantic_error("Lazy pattern can't be used with offset.\n");
1614 if (pp->line && pp->offset) {
1615 semantic_error("Offset can't be used with line number.\n");
1619 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1620 semantic_error("File always requires line number or "
1625 if (pp->offset && !pp->function) {
1626 semantic_error("Offset requires an entry function.\n");
1630 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1631 semantic_error("Offset/Line/Lazy pattern can't be used with "
1636 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1637 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1642 /* Parse perf-probe event argument */
1643 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1645 char *tmp, *goodname;
1646 struct perf_probe_arg_field **fieldp;
1648 pr_debug("parsing arg: %s into ", str);
1650 tmp = strchr(str, '=');
1652 arg->name = strndup(str, tmp - str);
1653 if (arg->name == NULL)
1655 pr_debug("name:%s ", arg->name);
1659 tmp = strchr(str, '@');
1660 if (tmp && tmp != str && !strcmp(tmp + 1, "user")) { /* user attr */
1661 if (!user_access_is_supported()) {
1662 semantic_error("ftrace does not support user access\n");
1666 arg->user_access = true;
1667 pr_debug("user_access ");
1670 tmp = strchr(str, ':');
1671 if (tmp) { /* Type setting */
1673 arg->type = strdup(tmp + 1);
1674 if (arg->type == NULL)
1676 pr_debug("type:%s ", arg->type);
1679 tmp = strpbrk(str, "-.[");
1680 if (!is_c_varname(str) || !tmp) {
1681 /* A variable, register, symbol or special value */
1682 arg->var = strdup(str);
1683 if (arg->var == NULL)
1685 pr_debug("%s\n", arg->var);
1689 /* Structure fields or array element */
1690 arg->var = strndup(str, tmp - str);
1691 if (arg->var == NULL)
1693 goodname = arg->var;
1694 pr_debug("%s, ", arg->var);
1695 fieldp = &arg->field;
1698 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1699 if (*fieldp == NULL)
1701 if (*tmp == '[') { /* Array */
1703 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1704 (*fieldp)->ref = true;
1705 if (*tmp != ']' || tmp == str + 1) {
1706 semantic_error("Array index must be a"
1713 } else { /* Structure */
1716 (*fieldp)->ref = false;
1717 } else if (tmp[1] == '>') {
1719 (*fieldp)->ref = true;
1721 semantic_error("Argument parse error: %s\n",
1725 tmp = strpbrk(str, "-.[");
1728 (*fieldp)->name = strndup(str, tmp - str);
1729 if ((*fieldp)->name == NULL)
1732 goodname = (*fieldp)->name;
1733 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1734 fieldp = &(*fieldp)->next;
1737 (*fieldp)->name = strdup(str);
1738 if ((*fieldp)->name == NULL)
1741 goodname = (*fieldp)->name;
1742 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1744 /* If no name is specified, set the last field name (not array index)*/
1746 arg->name = strdup(goodname);
1747 if (arg->name == NULL)
1753 /* Parse perf-probe event command */
1754 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1757 int argc, i, ret = 0;
1759 argv = argv_split(cmd, &argc);
1761 pr_debug("Failed to split arguments.\n");
1764 if (argc - 1 > MAX_PROBE_ARGS) {
1765 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1769 /* Parse probe point */
1770 ret = parse_perf_probe_point(argv[0], pev);
1774 /* Generate event name if needed */
1775 if (!pev->event && pev->point.function && pev->point.line
1776 && !pev->point.lazy_line && !pev->point.offset) {
1777 if (asprintf(&pev->event, "%s_L%d", pev->point.function,
1778 pev->point.line) < 0)
1782 /* Copy arguments and ensure return probe has no C argument */
1783 pev->nargs = argc - 1;
1784 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1785 if (pev->args == NULL) {
1789 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1790 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1792 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1793 semantic_error("You can't specify local variable for"
1804 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1805 bool perf_probe_with_var(struct perf_probe_event *pev)
1809 for (i = 0; i < pev->nargs; i++)
1810 if (is_c_varname(pev->args[i].var) ||
1811 !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) ||
1812 !strcmp(pev->args[i].var, PROBE_ARG_VARS))
1817 /* Return true if this perf_probe_event requires debuginfo */
1818 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1820 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1823 if (perf_probe_with_var(pev))
1829 /* Parse probe_events event into struct probe_point */
1830 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1832 struct probe_trace_point *tp = &tev->point;
1835 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1839 pr_debug("Parsing probe_events: %s\n", cmd);
1840 argv = argv_split(cmd, &argc);
1842 pr_debug("Failed to split arguments.\n");
1846 semantic_error("Too few probe arguments.\n");
1851 /* Scan event and group name. */
1852 argv0_str = strdup(argv[0]);
1853 if (argv0_str == NULL) {
1857 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1858 fmt2_str = strtok_r(NULL, "/", &fmt);
1859 fmt3_str = strtok_r(NULL, " \t", &fmt);
1860 if (fmt1_str == NULL || fmt2_str == NULL || fmt3_str == NULL) {
1861 semantic_error("Failed to parse event name: %s\n", argv[0]);
1866 tev->group = strdup(fmt2_str);
1867 tev->event = strdup(fmt3_str);
1868 if (tev->group == NULL || tev->event == NULL) {
1872 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1874 tp->retprobe = (pr == 'r');
1876 /* Scan module name(if there), function name and offset */
1877 p = strchr(argv[1], ':');
1879 tp->module = strndup(argv[1], p - argv[1]);
1884 tev->uprobes = (tp->module[0] == '/');
1888 fmt1_str = strtok_r(p, "+", &fmt);
1889 /* only the address started with 0x */
1890 if (fmt1_str[0] == '0') {
1892 * Fix a special case:
1893 * if address == 0, kernel reports something like:
1894 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1895 * Newer kernel may fix that, but we want to
1896 * support old kernel also.
1898 if (strcmp(fmt1_str, "0x") == 0) {
1899 if (!argv[2] || strcmp(argv[2], "(null)")) {
1906 for (i = 2; argv[i + 1] != NULL; i++)
1907 argv[i] = argv[i + 1];
1912 tp->address = strtoull(fmt1_str, NULL, 0);
1914 /* Only the symbol-based probe has offset */
1915 tp->symbol = strdup(fmt1_str);
1916 if (tp->symbol == NULL) {
1920 fmt2_str = strtok_r(NULL, "", &fmt);
1921 if (fmt2_str == NULL)
1924 tp->offset = strtoul(fmt2_str, NULL, 10);
1928 fmt2_str = strchr(p, '(');
1930 tp->ref_ctr_offset = strtoul(fmt2_str + 1, NULL, 0);
1933 tev->nargs = argc - 2;
1934 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1935 if (tev->args == NULL) {
1939 for (i = 0; i < tev->nargs; i++) {
1940 p = strchr(argv[i + 2], '=');
1941 if (p) /* We don't need which register is assigned. */
1945 tev->args[i].name = strdup(argv[i + 2]);
1946 /* TODO: parse regs and offset */
1947 tev->args[i].value = strdup(p);
1948 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1960 /* Compose only probe arg */
1961 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1963 struct perf_probe_arg_field *field = pa->field;
1968 if (strbuf_init(&buf, 64) < 0)
1971 if (pa->name && pa->var)
1972 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1974 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1979 if (field->name[0] == '[')
1980 err = strbuf_addstr(&buf, field->name);
1982 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1984 field = field->next;
1990 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1993 ret = strbuf_detach(&buf, NULL);
1995 strbuf_release(&buf);
1999 /* Compose only probe point (not argument) */
2000 char *synthesize_perf_probe_point(struct perf_probe_point *pp)
2003 char *tmp, *ret = NULL;
2006 if (strbuf_init(&buf, 64) < 0)
2010 if (strbuf_addstr(&buf, pp->function) < 0)
2013 err = strbuf_addf(&buf, "+%lu", pp->offset);
2015 err = strbuf_addf(&buf, ":%d", pp->line);
2016 else if (pp->retprobe)
2017 err = strbuf_addstr(&buf, "%return");
2025 tmp = strchr(pp->file + len - 30, '/');
2026 tmp = tmp ? tmp + 1 : pp->file + len - 30;
2028 err = strbuf_addf(&buf, "@%s", tmp);
2029 if (!err && !pp->function && pp->line)
2030 err = strbuf_addf(&buf, ":%d", pp->line);
2033 ret = strbuf_detach(&buf, NULL);
2035 strbuf_release(&buf);
2039 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
2042 char *tmp, *ret = NULL;
2045 if (strbuf_init(&buf, 64))
2048 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
2052 tmp = synthesize_perf_probe_point(&pev->point);
2053 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
2057 for (i = 0; i < pev->nargs; i++) {
2058 tmp = synthesize_perf_probe_arg(pev->args + i);
2059 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
2064 ret = strbuf_detach(&buf, NULL);
2066 strbuf_release(&buf);
2070 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
2071 struct strbuf *buf, int depth)
2075 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
2080 if (ref->user_access)
2081 err = strbuf_addf(buf, "%s%ld(", "+u", ref->offset);
2083 err = strbuf_addf(buf, "%+ld(", ref->offset);
2084 return (err < 0) ? err : depth;
2087 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
2090 struct probe_trace_arg_ref *ref = arg->ref;
2093 /* Argument name or separator */
2095 err = strbuf_addf(buf, " %s=", arg->name);
2097 err = strbuf_addch(buf, ' ');
2101 /* Special case: @XXX */
2102 if (arg->value[0] == '@' && arg->ref)
2105 /* Dereferencing arguments */
2107 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
2112 /* Print argument value */
2113 if (arg->value[0] == '@' && arg->ref)
2114 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
2116 err = strbuf_addstr(buf, arg->value);
2119 while (!err && depth--)
2120 err = strbuf_addch(buf, ')');
2122 /* Print argument type */
2123 if (!err && arg->type)
2124 err = strbuf_addf(buf, ":%s", arg->type);
2130 synthesize_probe_trace_args(struct probe_trace_event *tev, struct strbuf *buf)
2134 for (i = 0; i < tev->nargs && ret >= 0; i++)
2135 ret = synthesize_probe_trace_arg(&tev->args[i], buf);
2141 synthesize_uprobe_trace_def(struct probe_trace_point *tp, struct strbuf *buf)
2145 /* Uprobes must have tp->module */
2149 * If tp->address == 0, then this point must be a
2150 * absolute address uprobe.
2151 * try_to_find_absolute_address() should have made
2152 * tp->symbol to "0x0".
2154 if (!tp->address && (!tp->symbol || strcmp(tp->symbol, "0x0")))
2157 /* Use the tp->address for uprobes */
2158 err = strbuf_addf(buf, "%s:0x%" PRIx64, tp->module, tp->address);
2160 if (err >= 0 && tp->ref_ctr_offset) {
2161 if (!uprobe_ref_ctr_is_supported())
2163 err = strbuf_addf(buf, "(0x%lx)", tp->ref_ctr_offset);
2165 return err >= 0 ? 0 : err;
2169 synthesize_kprobe_trace_def(struct probe_trace_point *tp, struct strbuf *buf)
2171 if (!strncmp(tp->symbol, "0x", 2)) {
2172 /* Absolute address. See try_to_find_absolute_address() */
2173 return strbuf_addf(buf, "%s%s0x%" PRIx64, tp->module ?: "",
2174 tp->module ? ":" : "", tp->address);
2176 return strbuf_addf(buf, "%s%s%s+%lu", tp->module ?: "",
2177 tp->module ? ":" : "", tp->symbol, tp->offset);
2181 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
2183 struct probe_trace_point *tp = &tev->point;
2188 if (strbuf_init(&buf, 32) < 0)
2191 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
2192 tev->group, tev->event) < 0)
2196 err = synthesize_uprobe_trace_def(tp, &buf);
2198 err = synthesize_kprobe_trace_def(tp, &buf);
2201 err = synthesize_probe_trace_args(tev, &buf);
2204 ret = strbuf_detach(&buf, NULL);
2206 strbuf_release(&buf);
2210 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
2211 struct perf_probe_point *pp,
2214 struct symbol *sym = NULL;
2215 struct map *map = NULL;
2216 u64 addr = tp->address;
2220 map = dso__new_map(tp->module);
2223 sym = map__find_symbol(map, addr);
2225 if (tp->symbol && !addr) {
2226 if (kernel_get_symbol_address_by_name(tp->symbol,
2227 &addr, true, false) < 0)
2232 sym = machine__find_kernel_symbol(host_machine, addr, &map);
2239 pp->retprobe = tp->retprobe;
2240 pp->offset = addr - map->unmap_ip(map, sym->start);
2241 pp->function = strdup(sym->name);
2242 ret = pp->function ? 0 : -ENOMEM;
2245 if (map && !is_kprobe) {
2252 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2253 struct perf_probe_point *pp,
2259 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
2262 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
2266 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2269 pp->function = strdup(tp->symbol);
2270 pp->offset = tp->offset;
2272 ret = e_snprintf(buf, 128, "0x%" PRIx64, tp->address);
2275 pp->function = strdup(buf);
2278 if (pp->function == NULL)
2281 pp->retprobe = tp->retprobe;
2286 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2287 struct perf_probe_event *pev, bool is_kprobe)
2289 struct strbuf buf = STRBUF_INIT;
2292 /* Convert event/group name */
2293 pev->event = strdup(tev->event);
2294 pev->group = strdup(tev->group);
2295 if (pev->event == NULL || pev->group == NULL)
2298 /* Convert trace_point to probe_point */
2299 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2303 /* Convert trace_arg to probe_arg */
2304 pev->nargs = tev->nargs;
2305 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
2306 if (pev->args == NULL)
2308 for (i = 0; i < tev->nargs && ret >= 0; i++) {
2309 if (tev->args[i].name)
2310 pev->args[i].name = strdup(tev->args[i].name);
2312 if ((ret = strbuf_init(&buf, 32)) < 0)
2314 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
2315 pev->args[i].name = strbuf_detach(&buf, NULL);
2317 if (pev->args[i].name == NULL && ret >= 0)
2322 clear_perf_probe_event(pev);
2327 void clear_perf_probe_event(struct perf_probe_event *pev)
2329 struct perf_probe_arg_field *field, *next;
2334 zfree(&pev->target);
2335 clear_perf_probe_point(&pev->point);
2337 for (i = 0; i < pev->nargs; i++) {
2338 zfree(&pev->args[i].name);
2339 zfree(&pev->args[i].var);
2340 zfree(&pev->args[i].type);
2341 field = pev->args[i].field;
2344 zfree(&field->name);
2353 #define strdup_or_goto(str, label) \
2354 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2356 static int perf_probe_point__copy(struct perf_probe_point *dst,
2357 struct perf_probe_point *src)
2359 dst->file = strdup_or_goto(src->file, out_err);
2360 dst->function = strdup_or_goto(src->function, out_err);
2361 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
2362 dst->line = src->line;
2363 dst->retprobe = src->retprobe;
2364 dst->offset = src->offset;
2368 clear_perf_probe_point(dst);
2372 static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2373 struct perf_probe_arg *src)
2375 struct perf_probe_arg_field *field, **ppfield;
2377 dst->name = strdup_or_goto(src->name, out_err);
2378 dst->var = strdup_or_goto(src->var, out_err);
2379 dst->type = strdup_or_goto(src->type, out_err);
2382 ppfield = &(dst->field);
2384 *ppfield = zalloc(sizeof(*field));
2387 (*ppfield)->name = strdup_or_goto(field->name, out_err);
2388 (*ppfield)->index = field->index;
2389 (*ppfield)->ref = field->ref;
2390 field = field->next;
2391 ppfield = &((*ppfield)->next);
2398 int perf_probe_event__copy(struct perf_probe_event *dst,
2399 struct perf_probe_event *src)
2403 dst->event = strdup_or_goto(src->event, out_err);
2404 dst->group = strdup_or_goto(src->group, out_err);
2405 dst->target = strdup_or_goto(src->target, out_err);
2406 dst->uprobes = src->uprobes;
2408 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2411 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2414 dst->nargs = src->nargs;
2416 for (i = 0; i < src->nargs; i++)
2417 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
2422 clear_perf_probe_event(dst);
2426 void clear_probe_trace_event(struct probe_trace_event *tev)
2428 struct probe_trace_arg_ref *ref, *next;
2433 zfree(&tev->point.symbol);
2434 zfree(&tev->point.realname);
2435 zfree(&tev->point.module);
2436 for (i = 0; i < tev->nargs; i++) {
2437 zfree(&tev->args[i].name);
2438 zfree(&tev->args[i].value);
2439 zfree(&tev->args[i].type);
2440 ref = tev->args[i].ref;
2451 struct kprobe_blacklist_node {
2452 struct list_head list;
2458 static void kprobe_blacklist__delete(struct list_head *blacklist)
2460 struct kprobe_blacklist_node *node;
2462 while (!list_empty(blacklist)) {
2463 node = list_first_entry(blacklist,
2464 struct kprobe_blacklist_node, list);
2465 list_del_init(&node->list);
2466 zfree(&node->symbol);
2471 static int kprobe_blacklist__load(struct list_head *blacklist)
2473 struct kprobe_blacklist_node *node;
2474 const char *__debugfs = debugfs__mountpoint();
2475 char buf[PATH_MAX], *p;
2479 if (__debugfs == NULL)
2482 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2486 fp = fopen(buf, "r");
2491 while (fgets(buf, PATH_MAX, fp)) {
2492 node = zalloc(sizeof(*node));
2497 INIT_LIST_HEAD(&node->list);
2498 list_add_tail(&node->list, blacklist);
2499 if (sscanf(buf, "0x%" PRIx64 "-0x%" PRIx64, &node->start, &node->end) != 2) {
2503 p = strchr(buf, '\t');
2506 if (p[strlen(p) - 1] == '\n')
2507 p[strlen(p) - 1] = '\0';
2509 p = (char *)"unknown";
2510 node->symbol = strdup(p);
2511 if (!node->symbol) {
2515 pr_debug2("Blacklist: 0x%" PRIx64 "-0x%" PRIx64 ", %s\n",
2516 node->start, node->end, node->symbol);
2520 kprobe_blacklist__delete(blacklist);
2526 static struct kprobe_blacklist_node *
2527 kprobe_blacklist__find_by_address(struct list_head *blacklist, u64 address)
2529 struct kprobe_blacklist_node *node;
2531 list_for_each_entry(node, blacklist, list) {
2532 if (node->start <= address && address < node->end)
2539 static LIST_HEAD(kprobe_blacklist);
2541 static void kprobe_blacklist__init(void)
2543 if (!list_empty(&kprobe_blacklist))
2546 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2547 pr_debug("No kprobe blacklist support, ignored\n");
2550 static void kprobe_blacklist__release(void)
2552 kprobe_blacklist__delete(&kprobe_blacklist);
2555 static bool kprobe_blacklist__listed(u64 address)
2557 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2560 static int perf_probe_event__sprintf(const char *group, const char *event,
2561 struct perf_probe_event *pev,
2563 struct strbuf *result)
2568 if (asprintf(&buf, "%s:%s", group, event) < 0)
2570 ret = strbuf_addf(result, " %-20s (on ", buf);
2575 /* Synthesize only event probe point */
2576 buf = synthesize_perf_probe_point(&pev->point);
2579 ret = strbuf_addstr(result, buf);
2583 ret = strbuf_addf(result, " in %s", module);
2585 if (!ret && pev->nargs > 0) {
2586 ret = strbuf_add(result, " with", 5);
2587 for (i = 0; !ret && i < pev->nargs; i++) {
2588 buf = synthesize_perf_probe_arg(&pev->args[i]);
2591 ret = strbuf_addf(result, " %s", buf);
2596 ret = strbuf_addch(result, ')');
2602 int show_perf_probe_event(const char *group, const char *event,
2603 struct perf_probe_event *pev,
2604 const char *module, bool use_stdout)
2606 struct strbuf buf = STRBUF_INIT;
2609 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2612 printf("%s\n", buf.buf);
2614 pr_info("%s\n", buf.buf);
2616 strbuf_release(&buf);
2621 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2622 struct strfilter *filter)
2626 /* At first, check the event name itself */
2627 if (strfilter__compare(filter, tev->event))
2630 /* Next, check the combination of name and group */
2631 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2633 return strfilter__compare(filter, tmp);
2636 static int __show_perf_probe_events(int fd, bool is_kprobe,
2637 struct strfilter *filter)
2640 struct probe_trace_event tev;
2641 struct perf_probe_event pev;
2642 struct strlist *rawlist;
2643 struct str_node *ent;
2645 memset(&tev, 0, sizeof(tev));
2646 memset(&pev, 0, sizeof(pev));
2648 rawlist = probe_file__get_rawlist(fd);
2652 strlist__for_each_entry(ent, rawlist) {
2653 ret = parse_probe_trace_command(ent->s, &tev);
2655 if (!filter_probe_trace_event(&tev, filter))
2657 ret = convert_to_perf_probe_event(&tev, &pev,
2661 ret = show_perf_probe_event(pev.group, pev.event,
2662 &pev, tev.point.module,
2666 clear_perf_probe_event(&pev);
2667 clear_probe_trace_event(&tev);
2671 strlist__delete(rawlist);
2672 /* Cleanup cached debuginfo if needed */
2673 debuginfo_cache__exit();
2678 /* List up current perf-probe events */
2679 int show_perf_probe_events(struct strfilter *filter)
2681 int kp_fd, up_fd, ret;
2685 if (probe_conf.cache)
2686 return probe_cache__show_all_caches(filter);
2688 ret = init_probe_symbol_maps(false);
2692 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2697 ret = __show_perf_probe_events(kp_fd, true, filter);
2698 if (up_fd >= 0 && ret >= 0)
2699 ret = __show_perf_probe_events(up_fd, false, filter);
2704 exit_probe_symbol_maps();
2709 static int get_new_event_name(char *buf, size_t len, const char *base,
2710 struct strlist *namelist, bool ret_event,
2718 nbase = strdup(base);
2722 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2723 p = strpbrk(nbase, ".@");
2724 if (p && p != nbase)
2727 /* Try no suffix number */
2728 ret = e_snprintf(buf, len, "%s%s", nbase, ret_event ? "__return" : "");
2730 pr_debug("snprintf() failed: %d\n", ret);
2733 if (!strlist__has_entry(namelist, buf))
2736 if (!allow_suffix) {
2737 pr_warning("Error: event \"%s\" already exists.\n"
2738 " Hint: Remove existing event by 'perf probe -d'\n"
2739 " or force duplicates by 'perf probe -f'\n"
2740 " or set 'force=yes' in BPF source.\n",
2746 /* Try to add suffix */
2747 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2748 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2750 pr_debug("snprintf() failed: %d\n", ret);
2753 if (!strlist__has_entry(namelist, buf))
2756 if (i == MAX_EVENT_INDEX) {
2757 pr_warning("Too many events are on the same function.\n");
2764 /* Final validation */
2765 if (ret >= 0 && !is_c_func_name(buf)) {
2766 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2774 /* Warn if the current kernel's uprobe implementation is old */
2775 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2778 char *buf = synthesize_probe_trace_command(tev);
2779 struct probe_trace_point *tp = &tev->point;
2781 if (tp->ref_ctr_offset && !uprobe_ref_ctr_is_supported()) {
2782 pr_warning("A semaphore is associated with %s:%s and "
2783 "seems your kernel doesn't support it.\n",
2784 tev->group, tev->event);
2787 /* Old uprobe event doesn't support memory dereference */
2788 if (!tev->uprobes || tev->nargs == 0 || !buf)
2791 for (i = 0; i < tev->nargs; i++)
2792 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2793 pr_warning("Please upgrade your kernel to at least "
2794 "3.14 to have access to feature %s\n",
2795 tev->args[i].value);
2802 /* Set new name from original perf_probe_event and namelist */
2803 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2804 struct perf_probe_event *pev,
2805 struct strlist *namelist,
2808 const char *event, *group;
2812 /* If probe_event or trace_event already have the name, reuse it */
2813 if (pev->event && !pev->sdt)
2815 else if (tev->event)
2818 /* Or generate new one from probe point */
2819 if (pev->point.function &&
2820 (strncmp(pev->point.function, "0x", 2) != 0) &&
2821 !strisglob(pev->point.function))
2822 event = pev->point.function;
2824 event = tev->point.realname;
2826 if (pev->group && !pev->sdt)
2828 else if (tev->group)
2831 group = PERFPROBE_GROUP;
2833 /* Get an unused new event name */
2834 ret = get_new_event_name(buf, 64, event, namelist,
2835 tev->point.retprobe, allow_suffix);
2841 tev->event = strdup(event);
2842 tev->group = strdup(group);
2843 if (tev->event == NULL || tev->group == NULL)
2847 * Add new event name to namelist if multiprobe event is NOT
2848 * supported, since we have to use new event name for following
2849 * probes in that case.
2851 if (!multiprobe_event_is_supported())
2852 strlist__add(namelist, event);
2856 static int __open_probe_file_and_namelist(bool uprobe,
2857 struct strlist **namelist)
2861 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2865 /* Get current event names */
2866 *namelist = probe_file__get_namelist(fd);
2868 pr_debug("Failed to get current event list.\n");
2875 static int __add_probe_trace_events(struct perf_probe_event *pev,
2876 struct probe_trace_event *tevs,
2877 int ntevs, bool allow_suffix)
2879 int i, fd[2] = {-1, -1}, up, ret;
2880 struct probe_trace_event *tev = NULL;
2881 struct probe_cache *cache = NULL;
2882 struct strlist *namelist[2] = {NULL, NULL};
2883 struct nscookie nsc;
2885 up = pev->uprobes ? 1 : 0;
2886 fd[up] = __open_probe_file_and_namelist(up, &namelist[up]);
2891 for (i = 0; i < ntevs; i++) {
2893 up = tev->uprobes ? 1 : 0;
2894 if (fd[up] == -1) { /* Open the kprobe/uprobe_events */
2895 fd[up] = __open_probe_file_and_namelist(up,
2900 /* Skip if the symbol is out of .text or blacklisted */
2901 if (!tev->point.symbol && !pev->uprobes)
2904 /* Set new name for tev (and update namelist) */
2905 ret = probe_trace_event__set_name(tev, pev, namelist[up],
2910 nsinfo__mountns_enter(pev->nsi, &nsc);
2911 ret = probe_file__add_event(fd[up], tev);
2912 nsinfo__mountns_exit(&nsc);
2917 * Probes after the first probe which comes from same
2918 * user input are always allowed to add suffix, because
2919 * there might be several addresses corresponding to
2922 allow_suffix = true;
2924 if (ret == -EINVAL && pev->uprobes)
2925 warn_uprobe_event_compat(tev);
2926 if (ret == 0 && probe_conf.cache) {
2927 cache = probe_cache__new(pev->target, pev->nsi);
2929 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
2930 probe_cache__commit(cache) < 0)
2931 pr_warning("Failed to add event to probe cache\n");
2932 probe_cache__delete(cache);
2936 for (up = 0; up < 2; up++) {
2937 strlist__delete(namelist[up]);
2944 static int find_probe_functions(struct map *map, char *name,
2945 struct symbol **syms)
2949 struct rb_node *tmp;
2950 const char *norm, *ver;
2952 bool cut_version = true;
2954 if (map__load(map) < 0)
2955 return -EACCES; /* Possible permission error to load symbols */
2957 /* If user gives a version, don't cut off the version from symbols */
2958 if (strchr(name, '@'))
2959 cut_version = false;
2961 map__for_each_symbol(map, sym, tmp) {
2962 norm = arch__normalize_symbol_name(sym->name);
2967 /* We don't care about default symbol or not */
2968 ver = strchr(norm, '@');
2970 buf = strndup(norm, ver - norm);
2977 if (strglobmatch(norm, name)) {
2979 if (syms && found < probe_conf.max_probes)
2980 syms[found - 1] = sym;
2989 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2990 struct probe_trace_event *tev __maybe_unused,
2991 struct map *map __maybe_unused,
2992 struct symbol *sym __maybe_unused) { }
2995 static void pr_kallsyms_access_error(void)
2997 pr_err("Please ensure you can read the /proc/kallsyms symbol addresses.\n"
2998 "If /proc/sys/kernel/kptr_restrict is '2', you can not read\n"
2999 "kernel symbol addresses even if you are a superuser. Please change\n"
3000 "it to '1'. If kptr_restrict is '1', the superuser can read the\n"
3001 "symbol addresses.\n"
3002 "In that case, please run this command again with sudo.\n");
3006 * Find probe function addresses from map.
3007 * Return an error or the number of found probe_trace_event
3009 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
3010 struct probe_trace_event **tevs)
3012 struct map *map = NULL;
3013 struct ref_reloc_sym *reloc_sym = NULL;
3015 struct symbol **syms = NULL;
3016 struct probe_trace_event *tev;
3017 struct perf_probe_point *pp = &pev->point;
3018 struct probe_trace_point *tp;
3019 int num_matched_functions;
3020 int ret, i, j, skipped = 0;
3023 map = get_target_map(pev->target, pev->nsi, pev->uprobes);
3029 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
3036 * Load matched symbols: Since the different local symbols may have
3037 * same name but different addresses, this lists all the symbols.
3039 num_matched_functions = find_probe_functions(map, pp->function, syms);
3040 if (num_matched_functions <= 0) {
3041 if (num_matched_functions == -EACCES) {
3042 pr_err("Failed to load symbols from %s\n",
3043 pev->target ?: "/proc/kallsyms");
3045 pr_err("Please ensure the file is not stripped.\n");
3047 pr_kallsyms_access_error();
3049 pr_err("Failed to find symbol %s in %s\n", pp->function,
3050 pev->target ? : "kernel");
3053 } else if (num_matched_functions > probe_conf.max_probes) {
3054 pr_err("Too many functions matched in %s\n",
3055 pev->target ? : "kernel");
3060 /* Note that the symbols in the kmodule are not relocated */
3061 if (!pev->uprobes && !pev->target &&
3062 (!pp->retprobe || kretprobe_offset_is_supported())) {
3063 reloc_sym = kernel_get_ref_reloc_sym(NULL);
3065 pr_warning("Relocated base symbol is not found! "
3066 "Check /proc/sys/kernel/kptr_restrict\n"
3067 "and /proc/sys/kernel/perf_event_paranoid. "
3068 "Or run as privileged perf user.\n\n");
3074 /* Setup result trace-probe-events */
3075 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
3083 for (j = 0; j < num_matched_functions; j++) {
3086 if (sym->type != STT_FUNC)
3089 /* There can be duplicated symbols in the map */
3090 for (i = 0; i < j; i++)
3091 if (sym->start == syms[i]->start) {
3092 pr_debug("Found duplicated symbol %s @ %" PRIx64 "\n",
3093 sym->name, sym->start);
3099 tev = (*tevs) + ret;
3101 if (ret == num_matched_functions) {
3102 pr_warning("Too many symbols are listed. Skip it.\n");
3107 if (pp->offset > sym->end - sym->start) {
3108 pr_warning("Offset %ld is bigger than the size of %s\n",
3109 pp->offset, sym->name);
3113 /* Add one probe point */
3114 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
3116 /* Check the kprobe (not in module) is within .text */
3117 if (!pev->uprobes && !pev->target &&
3118 kprobe_warn_out_range(sym->name, tp->address)) {
3119 tp->symbol = NULL; /* Skip it */
3121 } else if (reloc_sym) {
3122 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
3123 tp->offset = tp->address - reloc_sym->addr;
3125 tp->symbol = strdup_or_goto(sym->name, nomem_out);
3126 tp->offset = pp->offset;
3128 tp->realname = strdup_or_goto(sym->name, nomem_out);
3130 tp->retprobe = pp->retprobe;
3133 tev->point.module = strdup_or_goto(pev->target,
3136 mod_name = find_module_name(pev->target);
3138 strdup(mod_name ? mod_name : pev->target);
3140 if (!tev->point.module)
3144 tev->uprobes = pev->uprobes;
3145 tev->nargs = pev->nargs;
3147 tev->args = zalloc(sizeof(struct probe_trace_arg) *
3149 if (tev->args == NULL)
3152 for (i = 0; i < tev->nargs; i++) {
3153 if (pev->args[i].name)
3155 strdup_or_goto(pev->args[i].name,
3158 tev->args[i].value = strdup_or_goto(pev->args[i].var,
3160 if (pev->args[i].type)
3162 strdup_or_goto(pev->args[i].type,
3165 arch__fix_tev_from_maps(pev, tev, map, sym);
3167 if (ret == skipped) {
3180 clear_probe_trace_events(*tevs, num_matched_functions);
3185 static int try_to_find_absolute_address(struct perf_probe_event *pev,
3186 struct probe_trace_event **tevs)
3188 struct perf_probe_point *pp = &pev->point;
3189 struct probe_trace_event *tev;
3190 struct probe_trace_point *tp;
3193 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
3195 if (perf_probe_event_need_dwarf(pev))
3199 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3202 * Only one tev can be generated by this.
3204 *tevs = zalloc(sizeof(*tev));
3212 * Don't use tp->offset, use address directly, because
3213 * in synthesize_probe_trace_command() address cannot be
3216 tp->address = pev->point.abs_address;
3217 tp->retprobe = pp->retprobe;
3218 tev->uprobes = pev->uprobes;
3222 * Give it a '0x' leading symbol name.
3223 * In __add_probe_trace_events, a NULL symbol is interpreted as
3226 if (asprintf(&tp->symbol, "0x%" PRIx64, tp->address) < 0)
3229 /* For kprobe, check range */
3230 if ((!tev->uprobes) &&
3231 (kprobe_warn_out_range(tev->point.symbol,
3232 tev->point.address))) {
3237 if (asprintf(&tp->realname, "abs_%" PRIx64, tp->address) < 0)
3241 tp->module = strdup(pev->target);
3247 tev->group = strdup(pev->group);
3253 tev->event = strdup(pev->event);
3258 tev->nargs = pev->nargs;
3259 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
3263 for (i = 0; i < tev->nargs; i++)
3264 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
3269 clear_probe_trace_events(*tevs, 1);
3274 /* Concatenate two arrays */
3275 static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
3279 ret = malloc(sz_a + sz_b);
3281 memcpy(ret, a, sz_a);
3282 memcpy(ret + sz_a, b, sz_b);
3288 concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
3289 struct probe_trace_event **tevs2, int ntevs2)
3291 struct probe_trace_event *new_tevs;
3301 if (*ntevs + ntevs2 > probe_conf.max_probes)
3304 /* Concatenate the array of probe_trace_event */
3305 new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs),
3306 *tevs2, ntevs2 * sizeof(**tevs2));
3316 clear_probe_trace_events(*tevs2, ntevs2);
3323 * Try to find probe_trace_event from given probe caches. Return the number
3324 * of cached events found, if an error occurs return the error.
3326 static int find_cached_events(struct perf_probe_event *pev,
3327 struct probe_trace_event **tevs,
3330 struct probe_cache *cache;
3331 struct probe_cache_entry *entry;
3332 struct probe_trace_event *tmp_tevs = NULL;
3336 cache = probe_cache__new(target, pev->nsi);
3337 /* Return 0 ("not found") if the target has no probe cache. */
3341 for_each_probe_cache_entry(entry, cache) {
3342 /* Skip the cache entry which has no name */
3343 if (!entry->pev.event || !entry->pev.group)
3345 if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) &&
3346 strglobmatch(entry->pev.event, pev->event)) {
3347 ret = probe_cache_entry__get_event(entry, &tmp_tevs);
3349 ret = concat_probe_trace_events(tevs, &ntevs,
3355 probe_cache__delete(cache);
3357 clear_probe_trace_events(*tevs, ntevs);
3361 if (ntevs > 0 && target && target[0] == '/')
3362 pev->uprobes = true;
3368 /* Try to find probe_trace_event from all probe caches */
3369 static int find_cached_events_all(struct perf_probe_event *pev,
3370 struct probe_trace_event **tevs)
3372 struct probe_trace_event *tmp_tevs = NULL;
3373 struct strlist *bidlist;
3374 struct str_node *nd;
3379 /* Get the buildid list of all valid caches */
3380 bidlist = build_id_cache__list_all(true);
3383 pr_debug("Failed to get buildids: %d\n", ret);
3388 strlist__for_each_entry(nd, bidlist) {
3389 pathname = build_id_cache__origname(nd->s);
3390 ret = find_cached_events(pev, &tmp_tevs, pathname);
3391 /* In the case of cnt == 0, we just skip it */
3393 ret = concat_probe_trace_events(tevs, &ntevs,
3399 strlist__delete(bidlist);
3402 clear_probe_trace_events(*tevs, ntevs);
3410 static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
3411 struct probe_trace_event **tevs)
3413 struct probe_cache *cache;
3414 struct probe_cache_entry *entry;
3415 struct probe_trace_event *tev;
3416 struct str_node *node;
3420 /* For SDT/cached events, we use special search functions */
3422 return find_cached_events_all(pev, tevs);
3424 return find_cached_events(pev, tevs, pev->target);
3426 cache = probe_cache__new(pev->target, pev->nsi);
3430 entry = probe_cache__find(cache, pev);
3432 /* SDT must be in the cache */
3433 ret = pev->sdt ? -ENOENT : 0;
3437 ret = strlist__nr_entries(entry->tevlist);
3438 if (ret > probe_conf.max_probes) {
3439 pr_debug("Too many entries matched in the cache of %s\n",
3440 pev->target ? : "kernel");
3445 *tevs = zalloc(ret * sizeof(*tev));
3452 strlist__for_each_entry(node, entry->tevlist) {
3453 tev = &(*tevs)[i++];
3454 ret = parse_probe_trace_command(node->s, tev);
3457 /* Set the uprobes attribute as same as original */
3458 tev->uprobes = pev->uprobes;
3463 probe_cache__delete(cache);
3467 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3468 struct probe_trace_event **tevs)
3472 if (!pev->group && !pev->sdt) {
3473 /* Set group name if not given */
3474 if (!pev->uprobes) {
3475 pev->group = strdup(PERFPROBE_GROUP);
3476 ret = pev->group ? 0 : -ENOMEM;
3478 ret = convert_exec_to_group(pev->target, &pev->group);
3480 pr_warning("Failed to make a group name.\n");
3485 ret = try_to_find_absolute_address(pev, tevs);
3489 /* At first, we need to lookup cache entry */
3490 ret = find_probe_trace_events_from_cache(pev, tevs);
3491 if (ret > 0 || pev->sdt) /* SDT can be found only in the cache */
3492 return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3494 /* Convert perf_probe_event with debuginfo */
3495 ret = try_to_find_probe_trace_events(pev, tevs);
3497 return ret; /* Found in debuginfo or got an error */
3499 return find_probe_trace_events_from_map(pev, tevs);
3502 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3506 /* Loop 1: convert all events */
3507 for (i = 0; i < npevs; i++) {
3508 /* Init kprobe blacklist if needed */
3509 if (!pevs[i].uprobes)
3510 kprobe_blacklist__init();
3511 /* Convert with or without debuginfo */
3512 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3515 pevs[i].ntevs = ret;
3517 /* This just release blacklist only if allocated */
3518 kprobe_blacklist__release();
3523 static int show_probe_trace_event(struct probe_trace_event *tev)
3525 char *buf = synthesize_probe_trace_command(tev);
3528 pr_debug("Failed to synthesize probe trace event.\n");
3532 /* Showing definition always go stdout */
3533 printf("%s\n", buf);
3539 int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
3541 struct strlist *namelist = strlist__new(NULL, NULL);
3542 struct probe_trace_event *tev;
3543 struct perf_probe_event *pev;
3549 for (j = 0; j < npevs && !ret; j++) {
3551 for (i = 0; i < pev->ntevs && !ret; i++) {
3552 tev = &pev->tevs[i];
3553 /* Skip if the symbol is out of .text or blacklisted */
3554 if (!tev->point.symbol && !pev->uprobes)
3557 /* Set new name for tev (and update namelist) */
3558 ret = probe_trace_event__set_name(tev, pev,
3561 ret = show_probe_trace_event(tev);
3564 strlist__delete(namelist);
3569 static int show_bootconfig_event(struct probe_trace_event *tev)
3571 struct probe_trace_point *tp = &tev->point;
3576 if (strbuf_init(&buf, 32) < 0)
3579 err = synthesize_kprobe_trace_def(tp, &buf);
3581 err = synthesize_probe_trace_args(tev, &buf);
3583 ret = strbuf_detach(&buf, NULL);
3584 strbuf_release(&buf);
3587 printf("'%s'", ret);
3594 int show_bootconfig_events(struct perf_probe_event *pevs, int npevs)
3596 struct strlist *namelist = strlist__new(NULL, NULL);
3597 struct probe_trace_event *tev;
3598 struct perf_probe_event *pev;
3599 char *cur_name = NULL;
3605 for (j = 0; j < npevs && !ret; j++) {
3607 if (pev->group && strcmp(pev->group, "probe"))
3608 pr_warning("WARN: Group name %s is ignored\n", pev->group);
3610 pr_warning("ERROR: Bootconfig doesn't support uprobes\n");
3614 for (i = 0; i < pev->ntevs && !ret; i++) {
3615 tev = &pev->tevs[i];
3616 /* Skip if the symbol is out of .text or blacklisted */
3617 if (!tev->point.symbol && !pev->uprobes)
3620 /* Set new name for tev (and update namelist) */
3621 ret = probe_trace_event__set_name(tev, pev,
3626 if (!cur_name || strcmp(cur_name, tev->event)) {
3627 printf("%sftrace.event.kprobes.%s.probe = ",
3628 cur_name ? "\n" : "", tev->event);
3629 cur_name = tev->event;
3632 ret = show_bootconfig_event(tev);
3636 strlist__delete(namelist);
3641 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3645 /* Loop 2: add all events */
3646 for (i = 0; i < npevs; i++) {
3647 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
3649 probe_conf.force_add);
3656 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3659 struct perf_probe_event *pev;
3661 /* Loop 3: cleanup and free trace events */
3662 for (i = 0; i < npevs; i++) {
3664 for (j = 0; j < pevs[i].ntevs; j++)
3665 clear_probe_trace_event(&pevs[i].tevs[j]);
3666 zfree(&pevs[i].tevs);
3668 nsinfo__zput(pev->nsi);
3669 clear_perf_probe_event(&pevs[i]);
3673 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3677 ret = init_probe_symbol_maps(pevs->uprobes);
3681 ret = convert_perf_probe_events(pevs, npevs);
3683 ret = apply_perf_probe_events(pevs, npevs);
3685 cleanup_perf_probe_events(pevs, npevs);
3687 exit_probe_symbol_maps();
3691 int del_perf_probe_events(struct strfilter *filter)
3693 int ret, ret2, ufd = -1, kfd = -1;
3694 char *str = strfilter__string(filter);
3699 /* Get current event names */
3700 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3704 ret = probe_file__del_events(kfd, filter);
3705 if (ret < 0 && ret != -ENOENT)
3708 ret2 = probe_file__del_events(ufd, filter);
3709 if (ret2 < 0 && ret2 != -ENOENT) {
3726 int show_available_funcs(const char *target, struct nsinfo *nsi,
3727 struct strfilter *_filter, bool user)
3733 ret = init_probe_symbol_maps(user);
3737 /* Get a symbol map */
3738 map = get_target_map(target, nsi, user);
3740 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3744 ret = map__load(map);
3747 char *str = strfilter__string(_filter);
3748 pr_err("Failed to find symbols matched to \"%s\"\n",
3752 pr_err("Failed to load symbols in %s\n",
3753 (target) ? : "kernel");
3756 if (!dso__sorted_by_name(map->dso))
3757 dso__sort_by_name(map->dso);
3759 /* Show all (filtered) symbols */
3762 for (nd = rb_first_cached(&map->dso->symbol_names); nd;
3764 struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
3766 if (strfilter__compare(_filter, pos->sym.name))
3767 printf("%s\n", pos->sym.name);
3771 exit_probe_symbol_maps();
3776 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3777 struct perf_probe_arg *pvar)
3779 tvar->value = strdup(pvar->var);
3780 if (tvar->value == NULL)
3783 tvar->type = strdup(pvar->type);
3784 if (tvar->type == NULL)
3788 tvar->name = strdup(pvar->name);
3789 if (tvar->name == NULL)