1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * probe-event.c : perf-probe definition to probe_events format converter
9 #include <sys/utsname.h>
10 #include <sys/types.h>
24 #include "namespaces.h"
26 #include "strfilter.h"
34 #include <api/fs/fs.h>
35 #include "trace-event.h" /* For __maybe_unused */
36 #include "probe-event.h"
37 #include "probe-finder.h"
38 #include "probe-file.h"
43 #include <subcmd/pager.h>
44 #include <linux/ctype.h>
45 #include <linux/zalloc.h>
47 #ifdef HAVE_DEBUGINFOD_SUPPORT
48 #include <elfutils/debuginfod.h>
51 #define PERFPROBE_GROUP "probe"
53 bool probe_event_dry_run; /* Dry run flag */
54 struct probe_conf probe_conf = { .magic_num = DEFAULT_PROBE_MAGIC_NUM };
56 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
58 int e_snprintf(char *str, size_t size, const char *format, ...)
63 ret = vsnprintf(str, size, format, ap);
70 static struct machine *host_machine;
72 /* Initialize symbol maps and path of vmlinux/modules */
73 int init_probe_symbol_maps(bool user_only)
77 symbol_conf.sort_by_name = true;
78 symbol_conf.allow_aliases = true;
79 ret = symbol__init(NULL);
81 pr_debug("Failed to init symbol map.\n");
85 if (host_machine || user_only) /* already initialized */
88 if (symbol_conf.vmlinux_name)
89 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
91 host_machine = machine__new_host();
93 pr_debug("machine__new_host() failed.\n");
99 pr_warning("Failed to init vmlinux path.\n");
103 void exit_probe_symbol_maps(void)
105 machine__delete(host_machine);
110 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(struct map **pmap)
113 struct map *map = machine__kernel_map(host_machine);
115 if (map__load(map) < 0)
118 kmap = map__kmap(map);
125 return kmap->ref_reloc_sym;
128 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
129 bool reloc, bool reladdr)
131 struct ref_reloc_sym *reloc_sym;
135 /* ref_reloc_sym is just a label. Need a special fix*/
136 reloc_sym = kernel_get_ref_reloc_sym(&map);
137 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
138 *addr = (!map->reloc || reloc) ? reloc_sym->addr :
139 reloc_sym->unrelocated_addr;
141 sym = machine__find_kernel_symbol_by_name(host_machine, name, &map);
144 *addr = map->unmap_ip(map, sym->start) -
145 ((reloc) ? 0 : map->reloc) -
146 ((reladdr) ? map->start : 0);
151 static struct map *kernel_get_module_map(const char *module)
153 struct maps *maps = machine__kernel_maps(host_machine);
156 /* A file path -- this is an offline module */
157 if (module && strchr(module, '/'))
158 return dso__new_map(module);
161 pos = machine__kernel_map(host_machine);
162 return map__get(pos);
165 maps__for_each_entry(maps, pos) {
166 /* short_name is "[module]" */
167 if (strncmp(pos->dso->short_name + 1, module,
168 pos->dso->short_name_len - 2) == 0 &&
169 module[pos->dso->short_name_len - 2] == '\0') {
170 return map__get(pos);
176 struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user)
178 /* Init maps of given executable or kernel */
182 map = dso__new_map(target);
183 if (map && map->dso) {
184 mutex_lock(&map->dso->lock);
185 nsinfo__put(map->dso->nsinfo);
186 map->dso->nsinfo = nsinfo__get(nsi);
187 mutex_unlock(&map->dso->lock);
191 return kernel_get_module_map(target);
195 static int convert_exec_to_group(const char *exec, char **result)
197 char *ptr1, *ptr2, *exec_copy;
201 exec_copy = strdup(exec);
205 ptr1 = basename(exec_copy);
211 for (ptr2 = ptr1; *ptr2 != '\0'; ptr2++) {
212 if (!isalnum(*ptr2) && *ptr2 != '_') {
218 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
222 *result = strdup(buf);
223 ret = *result ? 0 : -ENOMEM;
230 static void clear_perf_probe_point(struct perf_probe_point *pp)
233 zfree(&pp->function);
234 zfree(&pp->lazy_line);
237 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
241 for (i = 0; i < ntevs; i++)
242 clear_probe_trace_event(tevs + i);
245 static bool kprobe_blacklist__listed(u64 address);
246 static bool kprobe_warn_out_range(const char *symbol, u64 address)
251 map = kernel_get_module_map(NULL);
253 ret = address <= map->start || map->end < address;
255 pr_warning("%s is out of .text, skip it.\n", symbol);
258 if (!ret && kprobe_blacklist__listed(address)) {
259 pr_warning("%s is blacklisted function, skip it.\n", symbol);
267 * @module can be module name of module file path. In case of path,
268 * inspect elf and find out what is actual module name.
269 * Caller has to free mod_name after using it.
271 static char *find_module_name(const char *module)
279 char *mod_name = NULL;
282 fd = open(module, O_RDONLY);
286 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
290 if (gelf_getehdr(elf, &ehdr) == NULL)
293 sec = elf_section_by_name(elf, &ehdr, &shdr,
294 ".gnu.linkonce.this_module", NULL);
298 data = elf_getdata(sec, NULL);
299 if (!data || !data->d_buf)
304 * '.gnu.linkonce.this_module' section of kernel module elf directly
305 * maps to 'struct module' from linux/module.h. This section contains
306 * actual module name which will be used by kernel after loading it.
307 * But, we cannot use 'struct module' here since linux/module.h is not
308 * exposed to user-space. Offset of 'name' has remained same from long
309 * time, so hardcoding it here.
311 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32)
313 else /* expect ELFCLASS64 by default */
316 mod_name = strdup((char *)data->d_buf + name_offset);
325 #ifdef HAVE_DWARF_SUPPORT
327 static int kernel_get_module_dso(const char *module, struct dso **pdso)
331 const char *vmlinux_name;
335 char module_name[128];
337 snprintf(module_name, sizeof(module_name), "[%s]", module);
338 map = maps__find_by_name(machine__kernel_maps(host_machine), module_name);
343 pr_debug("Failed to find module %s.\n", module);
347 map = machine__kernel_map(host_machine);
349 if (!dso->has_build_id)
350 dso__read_running_kernel_build_id(dso, host_machine);
352 vmlinux_name = symbol_conf.vmlinux_name;
355 ret = dso__load_vmlinux(dso, map, vmlinux_name, false);
357 ret = dso__load_vmlinux_path(dso, map);
364 * Some binaries like glibc have special symbols which are on the symbol
365 * table, but not in the debuginfo. If we can find the address of the
366 * symbol from map, we can translate the address back to the probe point.
368 static int find_alternative_probe_point(struct debuginfo *dinfo,
369 struct perf_probe_point *pp,
370 struct perf_probe_point *result,
371 const char *target, struct nsinfo *nsi,
374 struct map *map = NULL;
379 /* This can work only for function-name based one */
380 if (!pp->function || pp->file)
383 map = get_target_map(target, nsi, uprobes);
387 /* Find the address of given function */
388 map__for_each_symbol_by_name(map, pp->function, sym) {
390 address = sym->start;
391 if (sym->type == STT_GNU_IFUNC)
392 pr_warning("Warning: The probe function (%s) is a GNU indirect function.\n"
393 "Consider identifying the final function used at run time and set the probe directly on that.\n",
396 address = map->unmap_ip(map, sym->start) - map->reloc;
403 pr_debug("Symbol %s address found : %" PRIx64 "\n",
404 pp->function, address);
406 ret = debuginfo__find_probe_point(dinfo, address, result);
408 ret = (!ret) ? -ENOENT : ret;
410 result->offset += pp->offset;
411 result->line += pp->line;
412 result->retprobe = pp->retprobe;
422 static int get_alternative_probe_event(struct debuginfo *dinfo,
423 struct perf_probe_event *pev,
424 struct perf_probe_point *tmp)
428 memcpy(tmp, &pev->point, sizeof(*tmp));
429 memset(&pev->point, 0, sizeof(pev->point));
430 ret = find_alternative_probe_point(dinfo, tmp, &pev->point, pev->target,
431 pev->nsi, pev->uprobes);
433 memcpy(&pev->point, tmp, sizeof(*tmp));
438 static int get_alternative_line_range(struct debuginfo *dinfo,
439 struct line_range *lr,
440 const char *target, bool user)
442 struct perf_probe_point pp = { .function = lr->function,
445 struct perf_probe_point result;
448 memset(&result, 0, sizeof(result));
450 if (lr->end != INT_MAX)
451 len = lr->end - lr->start;
452 ret = find_alternative_probe_point(dinfo, &pp, &result,
455 lr->function = result.function;
456 lr->file = result.file;
457 lr->start = result.line;
458 if (lr->end != INT_MAX)
459 lr->end = lr->start + len;
460 clear_perf_probe_point(&pp);
465 #ifdef HAVE_DEBUGINFOD_SUPPORT
466 static struct debuginfo *open_from_debuginfod(struct dso *dso, struct nsinfo *nsi,
469 debuginfod_client *c = debuginfod_begin();
470 char sbuild_id[SBUILD_ID_SIZE + 1];
471 struct debuginfo *ret = NULL;
479 build_id__sprintf(&dso->bid, sbuild_id);
480 fd = debuginfod_find_debuginfo(c, (const unsigned char *)sbuild_id,
487 pr_debug("Failed to find debuginfo in debuginfod.\n");
491 pr_debug("Load debuginfo from debuginfod (%s)\n", path);
493 nsinfo__mountns_enter(nsi, &nsc);
494 ret = debuginfo__new((const char *)path);
495 nsinfo__mountns_exit(&nsc);
500 struct debuginfo *open_from_debuginfod(struct dso *dso __maybe_unused,
501 struct nsinfo *nsi __maybe_unused,
502 bool silent __maybe_unused)
508 /* Open new debuginfo of given module */
509 static struct debuginfo *open_debuginfo(const char *module, struct nsinfo *nsi,
512 const char *path = module;
513 char reason[STRERR_BUFSIZE];
514 struct debuginfo *ret = NULL;
515 struct dso *dso = NULL;
519 if (!module || !strchr(module, '/')) {
520 err = kernel_get_module_dso(module, &dso);
522 if (!dso || dso->load_errno == 0) {
523 if (!str_error_r(-err, reason, STRERR_BUFSIZE))
524 strcpy(reason, "(unknown)");
526 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
528 ret = open_from_debuginfod(dso, nsi, silent);
533 pr_err("Module %s is not loaded, please specify its full path name.\n", module);
535 pr_err("Failed to find the path for the kernel: %s\n", reason);
539 path = dso->long_name;
541 nsinfo__mountns_enter(nsi, &nsc);
542 ret = debuginfo__new(path);
543 if (!ret && !silent) {
544 pr_warning("The %s file has no debug information.\n", path);
545 if (!module || !strtailcmp(path, ".ko"))
546 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
548 pr_warning("Rebuild with -g, ");
549 pr_warning("or install an appropriate debuginfo package.\n");
551 nsinfo__mountns_exit(&nsc);
555 /* For caching the last debuginfo */
556 static struct debuginfo *debuginfo_cache;
557 static char *debuginfo_cache_path;
559 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
561 const char *path = module;
563 /* If the module is NULL, it should be the kernel. */
567 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
570 /* Copy module path */
571 free(debuginfo_cache_path);
572 debuginfo_cache_path = strdup(path);
573 if (!debuginfo_cache_path) {
574 debuginfo__delete(debuginfo_cache);
575 debuginfo_cache = NULL;
579 debuginfo_cache = open_debuginfo(module, NULL, silent);
580 if (!debuginfo_cache)
581 zfree(&debuginfo_cache_path);
583 return debuginfo_cache;
586 static void debuginfo_cache__exit(void)
588 debuginfo__delete(debuginfo_cache);
589 debuginfo_cache = NULL;
590 zfree(&debuginfo_cache_path);
594 static int get_text_start_address(const char *exec, u64 *address,
600 int fd, ret = -ENOENT;
603 nsinfo__mountns_enter(nsi, &nsc);
604 fd = open(exec, O_RDONLY);
605 nsinfo__mountns_exit(&nsc);
609 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
615 if (gelf_getehdr(elf, &ehdr) == NULL)
618 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
621 *address = shdr.sh_addr - shdr.sh_offset;
632 * Convert trace point to probe point with debuginfo
634 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
635 struct perf_probe_point *pp,
638 struct debuginfo *dinfo = NULL;
640 u64 addr = tp->address;
643 /* convert the address to dwarf address */
649 ret = get_text_start_address(tp->module, &stext, NULL);
653 } else if (tp->symbol) {
654 /* If the module is given, this returns relative address */
655 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
656 false, !!tp->module);
662 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
663 tp->module ? : "kernel");
665 dinfo = debuginfo_cache__open(tp->module, verbose <= 0);
667 ret = debuginfo__find_probe_point(dinfo, addr, pp);
672 pp->retprobe = tp->retprobe;
676 pr_debug("Failed to find corresponding probes from debuginfo.\n");
677 return ret ? : -ENOENT;
680 /* Adjust symbol name and address */
681 static int post_process_probe_trace_point(struct probe_trace_point *tp,
682 struct map *map, u64 offs)
685 u64 addr = tp->address - offs;
687 sym = map__find_symbol(map, addr);
690 * If the address is in the inittext section, map can not
691 * find it. Ignore it if we are probing offline kernel.
693 return (symbol_conf.ignore_vmlinux_buildid) ? 0 : -ENOENT;
696 if (strcmp(sym->name, tp->symbol)) {
697 /* If we have no realname, use symbol for it */
699 tp->realname = tp->symbol;
702 tp->symbol = strdup(sym->name);
706 tp->offset = addr - sym->start;
713 * Rename DWARF symbols to ELF symbols -- gcc sometimes optimizes functions
714 * and generate new symbols with suffixes such as .constprop.N or .isra.N
715 * etc. Since those symbols are not recorded in DWARF, we have to find
716 * correct generated symbols from offline ELF binary.
717 * For online kernel or uprobes we don't need this because those are
718 * rebased on _text, or already a section relative address.
721 post_process_offline_probe_trace_events(struct probe_trace_event *tevs,
722 int ntevs, const char *pathname)
728 /* Prepare a map for offline binary */
729 map = dso__new_map(pathname);
730 if (!map || get_text_start_address(pathname, &stext, NULL) < 0) {
731 pr_warning("Failed to get ELF symbols for %s\n", pathname);
735 for (i = 0; i < ntevs; i++) {
736 ret = post_process_probe_trace_point(&tevs[i].point,
746 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
747 int ntevs, const char *exec,
756 ret = get_text_start_address(exec, &stext, nsi);
760 for (i = 0; i < ntevs && ret >= 0; i++) {
761 /* point.address is the address of point.symbol + point.offset */
762 tevs[i].point.address -= stext;
763 tevs[i].point.module = strdup(exec);
764 if (!tevs[i].point.module) {
768 tevs[i].uprobes = true;
775 post_process_module_probe_trace_events(struct probe_trace_event *tevs,
776 int ntevs, const char *module,
777 struct debuginfo *dinfo)
779 Dwarf_Addr text_offs = 0;
781 char *mod_name = NULL;
787 map = get_target_map(module, NULL, false);
788 if (!map || debuginfo__get_text_offset(dinfo, &text_offs, true) < 0) {
789 pr_warning("Failed to get ELF symbols for %s\n", module);
793 mod_name = find_module_name(module);
794 for (i = 0; i < ntevs; i++) {
795 ret = post_process_probe_trace_point(&tevs[i].point,
799 tevs[i].point.module =
800 strdup(mod_name ? mod_name : module);
801 if (!tevs[i].point.module) {
814 post_process_kernel_probe_trace_events(struct probe_trace_event *tevs,
817 struct ref_reloc_sym *reloc_sym;
822 /* Skip post process if the target is an offline kernel */
823 if (symbol_conf.ignore_vmlinux_buildid)
824 return post_process_offline_probe_trace_events(tevs, ntevs,
825 symbol_conf.vmlinux_name);
827 reloc_sym = kernel_get_ref_reloc_sym(&map);
829 pr_warning("Relocated base symbol is not found! "
830 "Check /proc/sys/kernel/kptr_restrict\n"
831 "and /proc/sys/kernel/perf_event_paranoid. "
832 "Or run as privileged perf user.\n\n");
836 for (i = 0; i < ntevs; i++) {
837 if (!tevs[i].point.address)
839 if (tevs[i].point.retprobe && !kretprobe_offset_is_supported())
842 * If we found a wrong one, mark it by NULL symbol.
843 * Since addresses in debuginfo is same as objdump, we need
844 * to convert it to addresses on memory.
846 if (kprobe_warn_out_range(tevs[i].point.symbol,
847 map__objdump_2mem(map, tevs[i].point.address))) {
851 tmp = strdup(reloc_sym->name);
855 /* If we have no realname, use symbol for it */
856 if (!tevs[i].point.realname)
857 tevs[i].point.realname = tevs[i].point.symbol;
859 free(tevs[i].point.symbol);
860 tevs[i].point.symbol = tmp;
861 tevs[i].point.offset = tevs[i].point.address -
862 (map->reloc ? reloc_sym->unrelocated_addr :
869 arch__post_process_probe_trace_events(struct perf_probe_event *pev __maybe_unused,
870 int ntevs __maybe_unused)
874 /* Post processing the probe events */
875 static int post_process_probe_trace_events(struct perf_probe_event *pev,
876 struct probe_trace_event *tevs,
877 int ntevs, const char *module,
878 bool uprobe, struct debuginfo *dinfo)
883 ret = add_exec_to_probe_trace_events(tevs, ntevs, module,
886 /* Currently ref_reloc_sym based probe is not for drivers */
887 ret = post_process_module_probe_trace_events(tevs, ntevs,
890 ret = post_process_kernel_probe_trace_events(tevs, ntevs);
893 arch__post_process_probe_trace_events(pev, ntevs);
898 /* Try to find perf_probe_event with debuginfo */
899 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
900 struct probe_trace_event **tevs)
902 bool need_dwarf = perf_probe_event_need_dwarf(pev);
903 struct perf_probe_point tmp;
904 struct debuginfo *dinfo;
907 /* Workaround for gcc #98776 issue.
908 * Perf failed to add kretprobe event with debuginfo of vmlinux which is
909 * compiled by gcc with -fpatchable-function-entry option enabled. The
910 * same issue with kernel module. The retprobe doesn`t need debuginfo.
911 * This workaround solution use map to query the probe function address
912 * for retprobe event.
914 if (pev->point.retprobe)
917 dinfo = open_debuginfo(pev->target, pev->nsi, !need_dwarf);
921 pr_debug("Could not open debuginfo. Try to use symbols.\n");
925 pr_debug("Try to find probe point from debuginfo.\n");
926 /* Searching trace events corresponding to a probe event */
927 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
929 if (ntevs == 0) { /* Not found, retry with an alternative */
930 ret = get_alternative_probe_event(dinfo, pev, &tmp);
932 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
934 * Write back to the original probe_event for
935 * setting appropriate (user given) event name
937 clear_perf_probe_point(&pev->point);
938 memcpy(&pev->point, &tmp, sizeof(tmp));
942 if (ntevs > 0) { /* Succeeded to find trace events */
943 pr_debug("Found %d probe_trace_events.\n", ntevs);
944 ret = post_process_probe_trace_events(pev, *tevs, ntevs,
945 pev->target, pev->uprobes, dinfo);
946 if (ret < 0 || ret == ntevs) {
947 pr_debug("Post processing failed or all events are skipped. (%d)\n", ret);
948 clear_probe_trace_events(*tevs, ntevs);
954 debuginfo__delete(dinfo);
956 if (ntevs == 0) { /* No error but failed to find probe point. */
957 pr_warning("Probe point '%s' not found.\n",
958 synthesize_perf_probe_point(&pev->point));
960 } else if (ntevs < 0) {
961 /* Error path : ntevs < 0 */
962 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
964 pr_warning("Warning: No dwarf info found in the vmlinux - "
965 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
967 pr_debug("Trying to use symbols.\n");
974 #define LINEBUF_SIZE 256
975 #define NR_ADDITIONAL_LINES 2
977 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
979 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
980 const char *color = show_num ? "" : PERF_COLOR_BLUE;
981 const char *prefix = NULL;
984 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
989 prefix = show_num ? "%7d " : " ";
990 color_fprintf(stdout, color, prefix, l);
992 color_fprintf(stdout, color, "%s", buf);
994 } while (strchr(buf, '\n') == NULL);
999 pr_warning("File read error: %s\n",
1000 str_error_r(errno, sbuf, sizeof(sbuf)));
1006 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
1008 int rv = __show_one_line(fp, l, skip, show_num);
1010 pr_warning("Source file is shorter than expected.\n");
1016 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
1017 #define show_one_line(f,l) _show_one_line(f,l,false,false)
1018 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
1019 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
1022 * Show line-range always requires debuginfo to find source file and
1025 static int __show_line_range(struct line_range *lr, const char *module,
1028 struct build_id bid;
1030 struct int_node *ln;
1031 struct debuginfo *dinfo;
1035 char sbuf[STRERR_BUFSIZE];
1036 char sbuild_id[SBUILD_ID_SIZE] = "";
1038 /* Search a line range */
1039 dinfo = open_debuginfo(module, NULL, false);
1043 ret = debuginfo__find_line_range(dinfo, lr);
1044 if (!ret) { /* Not found, retry with an alternative */
1045 ret = get_alternative_line_range(dinfo, lr, module, user);
1047 ret = debuginfo__find_line_range(dinfo, lr);
1049 if (dinfo->build_id) {
1050 build_id__init(&bid, dinfo->build_id, BUILD_ID_SIZE);
1051 build_id__sprintf(&bid, sbuild_id);
1053 debuginfo__delete(dinfo);
1054 if (ret == 0 || ret == -ENOENT) {
1055 pr_warning("Specified source line is not found.\n");
1057 } else if (ret < 0) {
1058 pr_warning("Debuginfo analysis failed.\n");
1062 /* Convert source file path */
1064 ret = find_source_path(tmp, sbuild_id, lr->comp_dir, &lr->path);
1066 /* Free old path when new path is assigned */
1067 if (tmp != lr->path)
1071 pr_warning("Failed to find source file path.\n");
1078 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
1079 lr->start - lr->offset);
1081 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
1083 fp = fopen(lr->path, "r");
1085 pr_warning("Failed to open %s: %s\n", lr->path,
1086 str_error_r(errno, sbuf, sizeof(sbuf)));
1089 /* Skip to starting line number */
1090 while (l < lr->start) {
1091 ret = skip_one_line(fp, l++);
1096 intlist__for_each_entry(ln, lr->line_list) {
1097 for (; ln->i > (unsigned long)l; l++) {
1098 ret = show_one_line(fp, l - lr->offset);
1102 ret = show_one_line_with_num(fp, l++ - lr->offset);
1107 if (lr->end == INT_MAX)
1108 lr->end = l + NR_ADDITIONAL_LINES;
1109 while (l <= lr->end) {
1110 ret = show_one_line_or_eof(fp, l++ - lr->offset);
1119 int show_line_range(struct line_range *lr, const char *module,
1120 struct nsinfo *nsi, bool user)
1123 struct nscookie nsc;
1125 ret = init_probe_symbol_maps(user);
1128 nsinfo__mountns_enter(nsi, &nsc);
1129 ret = __show_line_range(lr, module, user);
1130 nsinfo__mountns_exit(&nsc);
1131 exit_probe_symbol_maps();
1136 static int show_available_vars_at(struct debuginfo *dinfo,
1137 struct perf_probe_event *pev,
1138 struct strfilter *_filter)
1142 struct str_node *node;
1143 struct variable_list *vls = NULL, *vl;
1144 struct perf_probe_point tmp;
1147 buf = synthesize_perf_probe_point(&pev->point);
1150 pr_debug("Searching variables at %s\n", buf);
1152 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
1153 if (!ret) { /* Not found, retry with an alternative */
1154 ret = get_alternative_probe_event(dinfo, pev, &tmp);
1156 ret = debuginfo__find_available_vars_at(dinfo, pev,
1158 /* Release the old probe_point */
1159 clear_perf_probe_point(&tmp);
1163 if (ret == 0 || ret == -ENOENT) {
1164 pr_err("Failed to find the address of %s\n", buf);
1167 pr_warning("Debuginfo analysis failed.\n");
1171 /* Some variables are found */
1172 fprintf(stdout, "Available variables at %s\n", buf);
1173 for (i = 0; i < ret; i++) {
1176 * A probe point might be converted to
1177 * several trace points.
1179 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
1181 zfree(&vl->point.symbol);
1184 strlist__for_each_entry(node, vl->vars) {
1185 var = strchr(node->s, '\t') + 1;
1186 if (strfilter__compare(_filter, var)) {
1187 fprintf(stdout, "\t\t%s\n", node->s);
1191 strlist__delete(vl->vars);
1194 fprintf(stdout, "\t\t(No matched variables)\n");
1202 /* Show available variables on given probe point */
1203 int show_available_vars(struct perf_probe_event *pevs, int npevs,
1204 struct strfilter *_filter)
1207 struct debuginfo *dinfo;
1209 ret = init_probe_symbol_maps(pevs->uprobes);
1213 dinfo = open_debuginfo(pevs->target, pevs->nsi, false);
1221 for (i = 0; i < npevs && ret >= 0; i++)
1222 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1224 debuginfo__delete(dinfo);
1226 exit_probe_symbol_maps();
1230 #else /* !HAVE_DWARF_SUPPORT */
1232 static void debuginfo_cache__exit(void)
1237 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1238 struct perf_probe_point *pp __maybe_unused,
1239 bool is_kprobe __maybe_unused)
1244 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1245 struct probe_trace_event **tevs __maybe_unused)
1247 if (perf_probe_event_need_dwarf(pev)) {
1248 pr_warning("Debuginfo-analysis is not supported.\n");
1255 int show_line_range(struct line_range *lr __maybe_unused,
1256 const char *module __maybe_unused,
1257 struct nsinfo *nsi __maybe_unused,
1258 bool user __maybe_unused)
1260 pr_warning("Debuginfo-analysis is not supported.\n");
1264 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1265 int npevs __maybe_unused,
1266 struct strfilter *filter __maybe_unused)
1268 pr_warning("Debuginfo-analysis is not supported.\n");
1273 void line_range__clear(struct line_range *lr)
1275 zfree(&lr->function);
1278 zfree(&lr->comp_dir);
1279 intlist__delete(lr->line_list);
1282 int line_range__init(struct line_range *lr)
1284 memset(lr, 0, sizeof(*lr));
1285 lr->line_list = intlist__new(NULL);
1292 static int parse_line_num(char **ptr, int *val, const char *what)
1294 const char *start = *ptr;
1297 *val = strtol(*ptr, ptr, 0);
1298 if (errno || *ptr == start) {
1299 semantic_error("'%s' is not a valid number.\n", what);
1305 /* Check the name is good for event, group or function */
1306 static bool is_c_func_name(const char *name)
1308 if (!isalpha(*name) && *name != '_')
1310 while (*++name != '\0') {
1311 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1318 * Stuff 'lr' according to the line range described by 'arg'.
1319 * The line range syntax is described by:
1321 * SRC[:SLN[+NUM|-ELN]]
1322 * FNC[@SRC][:SLN[+NUM|-ELN]]
1324 int parse_line_range_desc(const char *arg, struct line_range *lr)
1326 char *range, *file, *name = strdup(arg);
1335 range = strchr(name, ':');
1339 err = parse_line_num(&range, &lr->start, "start line");
1343 if (*range == '+' || *range == '-') {
1344 const char c = *range++;
1346 err = parse_line_num(&range, &lr->end, "end line");
1351 lr->end += lr->start;
1353 * Adjust the number of lines here.
1354 * If the number of lines == 1, the
1355 * end of line should be equal to
1356 * the start of line.
1362 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1365 if (lr->start > lr->end) {
1366 semantic_error("Start line must be smaller"
1367 " than end line.\n");
1370 if (*range != '\0') {
1371 semantic_error("Tailing with invalid str '%s'.\n", range);
1376 file = strchr(name, '@');
1379 lr->file = strdup(++file);
1380 if (lr->file == NULL) {
1384 lr->function = name;
1385 } else if (strchr(name, '/') || strchr(name, '.'))
1387 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1388 lr->function = name;
1389 else { /* Invalid name */
1390 semantic_error("'%s' is not a valid function name.\n", name);
1401 static int parse_perf_probe_event_name(char **arg, struct perf_probe_event *pev)
1405 ptr = strpbrk_esc(*arg, ":");
1408 if (!pev->sdt && !is_c_func_name(*arg))
1410 pev->group = strdup_esc(*arg);
1417 pev->event = strdup_esc(*arg);
1418 if (pev->event == NULL)
1421 if (!pev->sdt && !is_c_func_name(pev->event)) {
1425 semantic_error("%s is bad for event name -it must "
1426 "follow C symbol-naming rule.\n", *arg);
1432 /* Parse probepoint definition. */
1433 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1435 struct perf_probe_point *pp = &pev->point;
1438 bool file_spec = false;
1443 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1444 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1445 * perf probe %[GRP:]SDT_EVENT
1450 if (is_sdt_event(arg)) {
1456 ptr = strpbrk_esc(arg, ";=@+%");
1460 semantic_error("%s must be an SDT name.\n",
1464 /* This must be a target file name or build id */
1465 tmp = build_id_cache__complement(ptr + 1);
1467 pev->target = build_id_cache__origname(tmp);
1470 pev->target = strdup_esc(ptr + 1);
1475 ret = parse_perf_probe_event_name(&arg, pev);
1477 if (asprintf(&pev->point.function, "%%%s", pev->event) < 0)
1483 if (ptr && *ptr == '=') { /* Event name */
1486 ret = parse_perf_probe_event_name(&arg, pev);
1494 * Check arg is function or file name and copy it.
1496 * We consider arg to be a file spec if and only if it satisfies
1497 * all of the below criteria::
1498 * - it does not include any of "+@%",
1499 * - it includes one of ":;", and
1500 * - it has a period '.' in the name.
1502 * Otherwise, we consider arg to be a function specification.
1504 if (!strpbrk_esc(arg, "+@%")) {
1505 ptr = strpbrk_esc(arg, ";:");
1506 /* This is a file spec if it includes a '.' before ; or : */
1507 if (ptr && memchr(arg, '.', ptr - arg))
1511 ptr = strpbrk_esc(arg, ";:+@%");
1520 tmp = strdup_esc(arg);
1531 * Keep pp->function even if this is absolute address,
1532 * so it can mark whether abs_address is valid.
1533 * Which make 'perf probe lib.bin 0x0' possible.
1535 * Note that checking length of tmp is not needed
1536 * because when we access tmp[1] we know tmp[0] is '0',
1537 * so tmp[1] should always valid (but could be '\0').
1539 if (tmp && !strncmp(tmp, "0x", 2)) {
1540 pp->abs_address = strtoull(pp->function, &tmp, 0);
1542 semantic_error("Invalid absolute address.\n");
1548 /* Parse other options */
1552 if (c == ';') { /* Lazy pattern must be the last part */
1553 pp->lazy_line = strdup(arg); /* let leave escapes */
1554 if (pp->lazy_line == NULL)
1558 ptr = strpbrk_esc(arg, ";:+@%");
1564 case ':': /* Line number */
1565 pp->line = strtoul(arg, &tmp, 0);
1567 semantic_error("There is non-digit char"
1568 " in line number.\n");
1572 case '+': /* Byte offset from a symbol */
1573 pp->offset = strtoul(arg, &tmp, 0);
1575 semantic_error("There is non-digit character"
1580 case '@': /* File name */
1582 semantic_error("SRC@SRC is not allowed.\n");
1585 pp->file = strdup_esc(arg);
1586 if (pp->file == NULL)
1589 case '%': /* Probe places */
1590 if (strcmp(arg, "return") == 0) {
1592 } else { /* Others not supported yet */
1593 semantic_error("%%%s is not supported.\n", arg);
1597 default: /* Buggy case */
1598 pr_err("This program has a bug at %s:%d.\n",
1599 __FILE__, __LINE__);
1605 /* Exclusion check */
1606 if (pp->lazy_line && pp->line) {
1607 semantic_error("Lazy pattern can't be used with"
1612 if (pp->lazy_line && pp->offset) {
1613 semantic_error("Lazy pattern can't be used with offset.\n");
1617 if (pp->line && pp->offset) {
1618 semantic_error("Offset can't be used with line number.\n");
1622 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1623 semantic_error("File always requires line number or "
1628 if (pp->offset && !pp->function) {
1629 semantic_error("Offset requires an entry function.\n");
1633 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1634 semantic_error("Offset/Line/Lazy pattern can't be used with "
1639 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1640 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1645 /* Parse perf-probe event argument */
1646 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1648 char *tmp, *goodname;
1649 struct perf_probe_arg_field **fieldp;
1651 pr_debug("parsing arg: %s into ", str);
1653 tmp = strchr(str, '=');
1655 arg->name = strndup(str, tmp - str);
1656 if (arg->name == NULL)
1658 pr_debug("name:%s ", arg->name);
1662 tmp = strchr(str, '@');
1663 if (tmp && tmp != str && !strcmp(tmp + 1, "user")) { /* user attr */
1664 if (!user_access_is_supported()) {
1665 semantic_error("ftrace does not support user access\n");
1669 arg->user_access = true;
1670 pr_debug("user_access ");
1673 tmp = strchr(str, ':');
1674 if (tmp) { /* Type setting */
1676 arg->type = strdup(tmp + 1);
1677 if (arg->type == NULL)
1679 pr_debug("type:%s ", arg->type);
1682 tmp = strpbrk(str, "-.[");
1683 if (!is_c_varname(str) || !tmp) {
1684 /* A variable, register, symbol or special value */
1685 arg->var = strdup(str);
1686 if (arg->var == NULL)
1688 pr_debug("%s\n", arg->var);
1692 /* Structure fields or array element */
1693 arg->var = strndup(str, tmp - str);
1694 if (arg->var == NULL)
1696 goodname = arg->var;
1697 pr_debug("%s, ", arg->var);
1698 fieldp = &arg->field;
1701 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1702 if (*fieldp == NULL)
1704 if (*tmp == '[') { /* Array */
1706 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1707 (*fieldp)->ref = true;
1708 if (*tmp != ']' || tmp == str + 1) {
1709 semantic_error("Array index must be a"
1716 } else { /* Structure */
1719 (*fieldp)->ref = false;
1720 } else if (tmp[1] == '>') {
1722 (*fieldp)->ref = true;
1724 semantic_error("Argument parse error: %s\n",
1728 tmp = strpbrk(str, "-.[");
1731 (*fieldp)->name = strndup(str, tmp - str);
1732 if ((*fieldp)->name == NULL)
1735 goodname = (*fieldp)->name;
1736 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1737 fieldp = &(*fieldp)->next;
1740 (*fieldp)->name = strdup(str);
1741 if ((*fieldp)->name == NULL)
1744 goodname = (*fieldp)->name;
1745 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1747 /* If no name is specified, set the last field name (not array index)*/
1749 arg->name = strdup(goodname);
1750 if (arg->name == NULL)
1756 /* Parse perf-probe event command */
1757 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1760 int argc, i, ret = 0;
1762 argv = argv_split(cmd, &argc);
1764 pr_debug("Failed to split arguments.\n");
1767 if (argc - 1 > MAX_PROBE_ARGS) {
1768 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1772 /* Parse probe point */
1773 ret = parse_perf_probe_point(argv[0], pev);
1777 /* Generate event name if needed */
1778 if (!pev->event && pev->point.function && pev->point.line
1779 && !pev->point.lazy_line && !pev->point.offset) {
1780 if (asprintf(&pev->event, "%s_L%d", pev->point.function,
1781 pev->point.line) < 0) {
1787 /* Copy arguments and ensure return probe has no C argument */
1788 pev->nargs = argc - 1;
1789 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1790 if (pev->args == NULL) {
1794 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1795 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1797 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1798 semantic_error("You can't specify local variable for"
1809 /* Returns true if *any* ARG is either C variable, $params or $vars. */
1810 bool perf_probe_with_var(struct perf_probe_event *pev)
1814 for (i = 0; i < pev->nargs; i++)
1815 if (is_c_varname(pev->args[i].var) ||
1816 !strcmp(pev->args[i].var, PROBE_ARG_PARAMS) ||
1817 !strcmp(pev->args[i].var, PROBE_ARG_VARS))
1822 /* Return true if this perf_probe_event requires debuginfo */
1823 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1825 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1828 if (perf_probe_with_var(pev))
1834 /* Parse probe_events event into struct probe_point */
1835 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1837 struct probe_trace_point *tp = &tev->point;
1840 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1844 pr_debug("Parsing probe_events: %s\n", cmd);
1845 argv = argv_split(cmd, &argc);
1847 pr_debug("Failed to split arguments.\n");
1851 semantic_error("Too few probe arguments.\n");
1856 /* Scan event and group name. */
1857 argv0_str = strdup(argv[0]);
1858 if (argv0_str == NULL) {
1862 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1863 fmt2_str = strtok_r(NULL, "/", &fmt);
1864 fmt3_str = strtok_r(NULL, " \t", &fmt);
1865 if (fmt1_str == NULL || fmt2_str == NULL || fmt3_str == NULL) {
1866 semantic_error("Failed to parse event name: %s\n", argv[0]);
1871 tev->group = strdup(fmt2_str);
1872 tev->event = strdup(fmt3_str);
1873 if (tev->group == NULL || tev->event == NULL) {
1877 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1879 tp->retprobe = (pr == 'r');
1881 /* Scan module name(if there), function name and offset */
1882 p = strchr(argv[1], ':');
1884 tp->module = strndup(argv[1], p - argv[1]);
1889 tev->uprobes = (tp->module[0] == '/');
1893 fmt1_str = strtok_r(p, "+", &fmt);
1894 /* only the address started with 0x */
1895 if (fmt1_str[0] == '0') {
1897 * Fix a special case:
1898 * if address == 0, kernel reports something like:
1899 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1900 * Newer kernel may fix that, but we want to
1901 * support old kernel also.
1903 if (strcmp(fmt1_str, "0x") == 0) {
1904 if (!argv[2] || strcmp(argv[2], "(null)")) {
1911 for (i = 2; argv[i + 1] != NULL; i++)
1912 argv[i] = argv[i + 1];
1917 tp->address = strtoull(fmt1_str, NULL, 0);
1919 /* Only the symbol-based probe has offset */
1920 tp->symbol = strdup(fmt1_str);
1921 if (tp->symbol == NULL) {
1925 fmt2_str = strtok_r(NULL, "", &fmt);
1926 if (fmt2_str == NULL)
1929 tp->offset = strtoul(fmt2_str, NULL, 10);
1933 fmt2_str = strchr(p, '(');
1935 tp->ref_ctr_offset = strtoul(fmt2_str + 1, NULL, 0);
1938 tev->nargs = argc - 2;
1939 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1940 if (tev->args == NULL) {
1944 for (i = 0; i < tev->nargs; i++) {
1945 p = strchr(argv[i + 2], '=');
1946 if (p) /* We don't need which register is assigned. */
1950 tev->args[i].name = strdup(argv[i + 2]);
1951 /* TODO: parse regs and offset */
1952 tev->args[i].value = strdup(p);
1953 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1965 /* Compose only probe arg */
1966 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1968 struct perf_probe_arg_field *field = pa->field;
1973 if (strbuf_init(&buf, 64) < 0)
1976 if (pa->name && pa->var)
1977 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1979 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1984 if (field->name[0] == '[')
1985 err = strbuf_addstr(&buf, field->name);
1987 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1989 field = field->next;
1995 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1998 ret = strbuf_detach(&buf, NULL);
2000 strbuf_release(&buf);
2004 /* Compose only probe point (not argument) */
2005 char *synthesize_perf_probe_point(struct perf_probe_point *pp)
2008 char *tmp, *ret = NULL;
2011 if (strbuf_init(&buf, 64) < 0)
2015 if (strbuf_addstr(&buf, pp->function) < 0)
2018 err = strbuf_addf(&buf, "+%lu", pp->offset);
2020 err = strbuf_addf(&buf, ":%d", pp->line);
2021 else if (pp->retprobe)
2022 err = strbuf_addstr(&buf, "%return");
2030 tmp = strchr(pp->file + len - 30, '/');
2031 tmp = tmp ? tmp + 1 : pp->file + len - 30;
2033 err = strbuf_addf(&buf, "@%s", tmp);
2034 if (!err && !pp->function && pp->line)
2035 err = strbuf_addf(&buf, ":%d", pp->line);
2038 ret = strbuf_detach(&buf, NULL);
2040 strbuf_release(&buf);
2044 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
2047 char *tmp, *ret = NULL;
2050 if (strbuf_init(&buf, 64))
2053 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
2057 tmp = synthesize_perf_probe_point(&pev->point);
2058 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
2062 for (i = 0; i < pev->nargs; i++) {
2063 tmp = synthesize_perf_probe_arg(pev->args + i);
2064 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
2069 ret = strbuf_detach(&buf, NULL);
2071 strbuf_release(&buf);
2075 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
2076 struct strbuf *buf, int depth)
2080 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
2085 if (ref->user_access)
2086 err = strbuf_addf(buf, "%s%ld(", "+u", ref->offset);
2088 err = strbuf_addf(buf, "%+ld(", ref->offset);
2089 return (err < 0) ? err : depth;
2092 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
2095 struct probe_trace_arg_ref *ref = arg->ref;
2098 /* Argument name or separator */
2100 err = strbuf_addf(buf, " %s=", arg->name);
2102 err = strbuf_addch(buf, ' ');
2106 /* Special case: @XXX */
2107 if (arg->value[0] == '@' && arg->ref)
2110 /* Dereferencing arguments */
2112 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
2117 /* Print argument value */
2118 if (arg->value[0] == '@' && arg->ref)
2119 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
2121 err = strbuf_addstr(buf, arg->value);
2124 while (!err && depth--)
2125 err = strbuf_addch(buf, ')');
2127 /* Print argument type */
2128 if (!err && arg->type)
2129 err = strbuf_addf(buf, ":%s", arg->type);
2135 synthesize_probe_trace_args(struct probe_trace_event *tev, struct strbuf *buf)
2139 for (i = 0; i < tev->nargs && ret >= 0; i++)
2140 ret = synthesize_probe_trace_arg(&tev->args[i], buf);
2146 synthesize_uprobe_trace_def(struct probe_trace_point *tp, struct strbuf *buf)
2150 /* Uprobes must have tp->module */
2154 * If tp->address == 0, then this point must be a
2155 * absolute address uprobe.
2156 * try_to_find_absolute_address() should have made
2157 * tp->symbol to "0x0".
2159 if (!tp->address && (!tp->symbol || strcmp(tp->symbol, "0x0")))
2162 /* Use the tp->address for uprobes */
2163 err = strbuf_addf(buf, "%s:0x%" PRIx64, tp->module, tp->address);
2165 if (err >= 0 && tp->ref_ctr_offset) {
2166 if (!uprobe_ref_ctr_is_supported())
2168 err = strbuf_addf(buf, "(0x%lx)", tp->ref_ctr_offset);
2170 return err >= 0 ? 0 : err;
2174 synthesize_kprobe_trace_def(struct probe_trace_point *tp, struct strbuf *buf)
2176 if (!strncmp(tp->symbol, "0x", 2)) {
2177 /* Absolute address. See try_to_find_absolute_address() */
2178 return strbuf_addf(buf, "%s%s0x%" PRIx64, tp->module ?: "",
2179 tp->module ? ":" : "", tp->address);
2181 return strbuf_addf(buf, "%s%s%s+%lu", tp->module ?: "",
2182 tp->module ? ":" : "", tp->symbol, tp->offset);
2186 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
2188 struct probe_trace_point *tp = &tev->point;
2193 if (strbuf_init(&buf, 32) < 0)
2196 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
2197 tev->group, tev->event) < 0)
2201 err = synthesize_uprobe_trace_def(tp, &buf);
2203 err = synthesize_kprobe_trace_def(tp, &buf);
2206 err = synthesize_probe_trace_args(tev, &buf);
2209 ret = strbuf_detach(&buf, NULL);
2211 strbuf_release(&buf);
2215 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
2216 struct perf_probe_point *pp,
2219 struct symbol *sym = NULL;
2220 struct map *map = NULL;
2221 u64 addr = tp->address;
2225 map = dso__new_map(tp->module);
2228 sym = map__find_symbol(map, addr);
2230 if (tp->symbol && !addr) {
2231 if (kernel_get_symbol_address_by_name(tp->symbol,
2232 &addr, true, false) < 0)
2237 sym = machine__find_kernel_symbol(host_machine, addr, &map);
2244 pp->retprobe = tp->retprobe;
2245 pp->offset = addr - map->unmap_ip(map, sym->start);
2246 pp->function = strdup(sym->name);
2247 ret = pp->function ? 0 : -ENOMEM;
2250 if (map && !is_kprobe) {
2257 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
2258 struct perf_probe_point *pp,
2264 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
2267 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
2271 pr_debug("Failed to find probe point from both of dwarf and map.\n");
2274 pp->function = strdup(tp->symbol);
2275 pp->offset = tp->offset;
2277 ret = e_snprintf(buf, 128, "0x%" PRIx64, tp->address);
2280 pp->function = strdup(buf);
2283 if (pp->function == NULL)
2286 pp->retprobe = tp->retprobe;
2291 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
2292 struct perf_probe_event *pev, bool is_kprobe)
2294 struct strbuf buf = STRBUF_INIT;
2297 /* Convert event/group name */
2298 pev->event = strdup(tev->event);
2299 pev->group = strdup(tev->group);
2300 if (pev->event == NULL || pev->group == NULL)
2303 /* Convert trace_point to probe_point */
2304 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
2308 /* Convert trace_arg to probe_arg */
2309 pev->nargs = tev->nargs;
2310 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
2311 if (pev->args == NULL)
2313 for (i = 0; i < tev->nargs && ret >= 0; i++) {
2314 if (tev->args[i].name)
2315 pev->args[i].name = strdup(tev->args[i].name);
2317 if ((ret = strbuf_init(&buf, 32)) < 0)
2319 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
2320 pev->args[i].name = strbuf_detach(&buf, NULL);
2322 if (pev->args[i].name == NULL && ret >= 0)
2327 clear_perf_probe_event(pev);
2332 void clear_perf_probe_event(struct perf_probe_event *pev)
2334 struct perf_probe_arg_field *field, *next;
2339 zfree(&pev->target);
2340 clear_perf_probe_point(&pev->point);
2342 for (i = 0; i < pev->nargs; i++) {
2343 zfree(&pev->args[i].name);
2344 zfree(&pev->args[i].var);
2345 zfree(&pev->args[i].type);
2346 field = pev->args[i].field;
2349 zfree(&field->name);
2358 #define strdup_or_goto(str, label) \
2359 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2361 static int perf_probe_point__copy(struct perf_probe_point *dst,
2362 struct perf_probe_point *src)
2364 dst->file = strdup_or_goto(src->file, out_err);
2365 dst->function = strdup_or_goto(src->function, out_err);
2366 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
2367 dst->line = src->line;
2368 dst->retprobe = src->retprobe;
2369 dst->offset = src->offset;
2373 clear_perf_probe_point(dst);
2377 static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2378 struct perf_probe_arg *src)
2380 struct perf_probe_arg_field *field, **ppfield;
2382 dst->name = strdup_or_goto(src->name, out_err);
2383 dst->var = strdup_or_goto(src->var, out_err);
2384 dst->type = strdup_or_goto(src->type, out_err);
2387 ppfield = &(dst->field);
2389 *ppfield = zalloc(sizeof(*field));
2392 (*ppfield)->name = strdup_or_goto(field->name, out_err);
2393 (*ppfield)->index = field->index;
2394 (*ppfield)->ref = field->ref;
2395 field = field->next;
2396 ppfield = &((*ppfield)->next);
2403 int perf_probe_event__copy(struct perf_probe_event *dst,
2404 struct perf_probe_event *src)
2408 dst->event = strdup_or_goto(src->event, out_err);
2409 dst->group = strdup_or_goto(src->group, out_err);
2410 dst->target = strdup_or_goto(src->target, out_err);
2411 dst->uprobes = src->uprobes;
2413 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2416 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2419 dst->nargs = src->nargs;
2421 for (i = 0; i < src->nargs; i++)
2422 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
2427 clear_perf_probe_event(dst);
2431 void clear_probe_trace_event(struct probe_trace_event *tev)
2433 struct probe_trace_arg_ref *ref, *next;
2438 zfree(&tev->point.symbol);
2439 zfree(&tev->point.realname);
2440 zfree(&tev->point.module);
2441 for (i = 0; i < tev->nargs; i++) {
2442 zfree(&tev->args[i].name);
2443 zfree(&tev->args[i].value);
2444 zfree(&tev->args[i].type);
2445 ref = tev->args[i].ref;
2456 struct kprobe_blacklist_node {
2457 struct list_head list;
2463 static void kprobe_blacklist__delete(struct list_head *blacklist)
2465 struct kprobe_blacklist_node *node;
2467 while (!list_empty(blacklist)) {
2468 node = list_first_entry(blacklist,
2469 struct kprobe_blacklist_node, list);
2470 list_del_init(&node->list);
2471 zfree(&node->symbol);
2476 static int kprobe_blacklist__load(struct list_head *blacklist)
2478 struct kprobe_blacklist_node *node;
2479 const char *__debugfs = debugfs__mountpoint();
2480 char buf[PATH_MAX], *p;
2484 if (__debugfs == NULL)
2487 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2491 fp = fopen(buf, "r");
2496 while (fgets(buf, PATH_MAX, fp)) {
2497 node = zalloc(sizeof(*node));
2502 INIT_LIST_HEAD(&node->list);
2503 list_add_tail(&node->list, blacklist);
2504 if (sscanf(buf, "0x%" PRIx64 "-0x%" PRIx64, &node->start, &node->end) != 2) {
2508 p = strchr(buf, '\t');
2511 if (p[strlen(p) - 1] == '\n')
2512 p[strlen(p) - 1] = '\0';
2514 p = (char *)"unknown";
2515 node->symbol = strdup(p);
2516 if (!node->symbol) {
2520 pr_debug2("Blacklist: 0x%" PRIx64 "-0x%" PRIx64 ", %s\n",
2521 node->start, node->end, node->symbol);
2525 kprobe_blacklist__delete(blacklist);
2531 static struct kprobe_blacklist_node *
2532 kprobe_blacklist__find_by_address(struct list_head *blacklist, u64 address)
2534 struct kprobe_blacklist_node *node;
2536 list_for_each_entry(node, blacklist, list) {
2537 if (node->start <= address && address < node->end)
2544 static LIST_HEAD(kprobe_blacklist);
2546 static void kprobe_blacklist__init(void)
2548 if (!list_empty(&kprobe_blacklist))
2551 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2552 pr_debug("No kprobe blacklist support, ignored\n");
2555 static void kprobe_blacklist__release(void)
2557 kprobe_blacklist__delete(&kprobe_blacklist);
2560 static bool kprobe_blacklist__listed(u64 address)
2562 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2565 static int perf_probe_event__sprintf(const char *group, const char *event,
2566 struct perf_probe_event *pev,
2568 struct strbuf *result)
2573 if (asprintf(&buf, "%s:%s", group, event) < 0)
2575 ret = strbuf_addf(result, " %-20s (on ", buf);
2580 /* Synthesize only event probe point */
2581 buf = synthesize_perf_probe_point(&pev->point);
2584 ret = strbuf_addstr(result, buf);
2588 ret = strbuf_addf(result, " in %s", module);
2590 if (!ret && pev->nargs > 0) {
2591 ret = strbuf_add(result, " with", 5);
2592 for (i = 0; !ret && i < pev->nargs; i++) {
2593 buf = synthesize_perf_probe_arg(&pev->args[i]);
2596 ret = strbuf_addf(result, " %s", buf);
2601 ret = strbuf_addch(result, ')');
2607 int show_perf_probe_event(const char *group, const char *event,
2608 struct perf_probe_event *pev,
2609 const char *module, bool use_stdout)
2611 struct strbuf buf = STRBUF_INIT;
2614 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2617 printf("%s\n", buf.buf);
2619 pr_info("%s\n", buf.buf);
2621 strbuf_release(&buf);
2626 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2627 struct strfilter *filter)
2631 /* At first, check the event name itself */
2632 if (strfilter__compare(filter, tev->event))
2635 /* Next, check the combination of name and group */
2636 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2638 return strfilter__compare(filter, tmp);
2641 static int __show_perf_probe_events(int fd, bool is_kprobe,
2642 struct strfilter *filter)
2645 struct probe_trace_event tev;
2646 struct perf_probe_event pev;
2647 struct strlist *rawlist;
2648 struct str_node *ent;
2650 memset(&tev, 0, sizeof(tev));
2651 memset(&pev, 0, sizeof(pev));
2653 rawlist = probe_file__get_rawlist(fd);
2657 strlist__for_each_entry(ent, rawlist) {
2658 ret = parse_probe_trace_command(ent->s, &tev);
2660 if (!filter_probe_trace_event(&tev, filter))
2662 ret = convert_to_perf_probe_event(&tev, &pev,
2666 ret = show_perf_probe_event(pev.group, pev.event,
2667 &pev, tev.point.module,
2671 clear_perf_probe_event(&pev);
2672 clear_probe_trace_event(&tev);
2676 strlist__delete(rawlist);
2677 /* Cleanup cached debuginfo if needed */
2678 debuginfo_cache__exit();
2683 /* List up current perf-probe events */
2684 int show_perf_probe_events(struct strfilter *filter)
2686 int kp_fd, up_fd, ret;
2690 if (probe_conf.cache)
2691 return probe_cache__show_all_caches(filter);
2693 ret = init_probe_symbol_maps(false);
2697 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2702 ret = __show_perf_probe_events(kp_fd, true, filter);
2703 if (up_fd >= 0 && ret >= 0)
2704 ret = __show_perf_probe_events(up_fd, false, filter);
2709 exit_probe_symbol_maps();
2714 static int get_new_event_name(char *buf, size_t len, const char *base,
2715 struct strlist *namelist, bool ret_event,
2723 nbase = strdup(base);
2727 /* Cut off the dot suffixes (e.g. .const, .isra) and version suffixes */
2728 p = strpbrk(nbase, ".@");
2729 if (p && p != nbase)
2732 /* Try no suffix number */
2733 ret = e_snprintf(buf, len, "%s%s", nbase, ret_event ? "__return" : "");
2735 pr_debug("snprintf() failed: %d\n", ret);
2738 if (!strlist__has_entry(namelist, buf))
2741 if (!allow_suffix) {
2742 pr_warning("Error: event \"%s\" already exists.\n"
2743 " Hint: Remove existing event by 'perf probe -d'\n"
2744 " or force duplicates by 'perf probe -f'\n"
2745 " or set 'force=yes' in BPF source.\n",
2751 /* Try to add suffix */
2752 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2753 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2755 pr_debug("snprintf() failed: %d\n", ret);
2758 if (!strlist__has_entry(namelist, buf))
2761 if (i == MAX_EVENT_INDEX) {
2762 pr_warning("Too many events are on the same function.\n");
2769 /* Final validation */
2770 if (ret >= 0 && !is_c_func_name(buf)) {
2771 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2779 /* Warn if the current kernel's uprobe implementation is old */
2780 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2783 char *buf = synthesize_probe_trace_command(tev);
2784 struct probe_trace_point *tp = &tev->point;
2786 if (tp->ref_ctr_offset && !uprobe_ref_ctr_is_supported()) {
2787 pr_warning("A semaphore is associated with %s:%s and "
2788 "seems your kernel doesn't support it.\n",
2789 tev->group, tev->event);
2792 /* Old uprobe event doesn't support memory dereference */
2793 if (!tev->uprobes || tev->nargs == 0 || !buf)
2796 for (i = 0; i < tev->nargs; i++)
2797 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2798 pr_warning("Please upgrade your kernel to at least "
2799 "3.14 to have access to feature %s\n",
2800 tev->args[i].value);
2807 /* Set new name from original perf_probe_event and namelist */
2808 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2809 struct perf_probe_event *pev,
2810 struct strlist *namelist,
2813 const char *event, *group;
2817 /* If probe_event or trace_event already have the name, reuse it */
2818 if (pev->event && !pev->sdt)
2820 else if (tev->event)
2823 /* Or generate new one from probe point */
2824 if (pev->point.function &&
2825 (strncmp(pev->point.function, "0x", 2) != 0) &&
2826 !strisglob(pev->point.function))
2827 event = pev->point.function;
2829 event = tev->point.realname;
2831 if (pev->group && !pev->sdt)
2833 else if (tev->group)
2836 group = PERFPROBE_GROUP;
2838 /* Get an unused new event name */
2839 ret = get_new_event_name(buf, 64, event, namelist,
2840 tev->point.retprobe, allow_suffix);
2846 tev->event = strdup(event);
2847 tev->group = strdup(group);
2848 if (tev->event == NULL || tev->group == NULL)
2852 * Add new event name to namelist if multiprobe event is NOT
2853 * supported, since we have to use new event name for following
2854 * probes in that case.
2856 if (!multiprobe_event_is_supported())
2857 strlist__add(namelist, event);
2861 static int __open_probe_file_and_namelist(bool uprobe,
2862 struct strlist **namelist)
2866 fd = probe_file__open(PF_FL_RW | (uprobe ? PF_FL_UPROBE : 0));
2870 /* Get current event names */
2871 *namelist = probe_file__get_namelist(fd);
2873 pr_debug("Failed to get current event list.\n");
2880 static int __add_probe_trace_events(struct perf_probe_event *pev,
2881 struct probe_trace_event *tevs,
2882 int ntevs, bool allow_suffix)
2884 int i, fd[2] = {-1, -1}, up, ret;
2885 struct probe_trace_event *tev = NULL;
2886 struct probe_cache *cache = NULL;
2887 struct strlist *namelist[2] = {NULL, NULL};
2888 struct nscookie nsc;
2890 up = pev->uprobes ? 1 : 0;
2891 fd[up] = __open_probe_file_and_namelist(up, &namelist[up]);
2896 for (i = 0; i < ntevs; i++) {
2898 up = tev->uprobes ? 1 : 0;
2899 if (fd[up] == -1) { /* Open the kprobe/uprobe_events */
2900 fd[up] = __open_probe_file_and_namelist(up,
2905 /* Skip if the symbol is out of .text or blacklisted */
2906 if (!tev->point.symbol && !pev->uprobes)
2909 /* Set new name for tev (and update namelist) */
2910 ret = probe_trace_event__set_name(tev, pev, namelist[up],
2915 nsinfo__mountns_enter(pev->nsi, &nsc);
2916 ret = probe_file__add_event(fd[up], tev);
2917 nsinfo__mountns_exit(&nsc);
2922 * Probes after the first probe which comes from same
2923 * user input are always allowed to add suffix, because
2924 * there might be several addresses corresponding to
2927 allow_suffix = true;
2929 if (ret == -EINVAL && pev->uprobes)
2930 warn_uprobe_event_compat(tev);
2931 if (ret == 0 && probe_conf.cache) {
2932 cache = probe_cache__new(pev->target, pev->nsi);
2934 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
2935 probe_cache__commit(cache) < 0)
2936 pr_warning("Failed to add event to probe cache\n");
2937 probe_cache__delete(cache);
2941 for (up = 0; up < 2; up++) {
2942 strlist__delete(namelist[up]);
2949 static int find_probe_functions(struct map *map, char *name,
2950 struct symbol **syms)
2954 struct rb_node *tmp;
2955 const char *norm, *ver;
2957 bool cut_version = true;
2959 if (map__load(map) < 0)
2960 return -EACCES; /* Possible permission error to load symbols */
2962 /* If user gives a version, don't cut off the version from symbols */
2963 if (strchr(name, '@'))
2964 cut_version = false;
2966 map__for_each_symbol(map, sym, tmp) {
2967 norm = arch__normalize_symbol_name(sym->name);
2972 /* We don't care about default symbol or not */
2973 ver = strchr(norm, '@');
2975 buf = strndup(norm, ver - norm);
2982 if (strglobmatch(norm, name)) {
2984 if (syms && found < probe_conf.max_probes)
2985 syms[found - 1] = sym;
2994 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2995 struct probe_trace_event *tev __maybe_unused,
2996 struct map *map __maybe_unused,
2997 struct symbol *sym __maybe_unused) { }
3000 static void pr_kallsyms_access_error(void)
3002 pr_err("Please ensure you can read the /proc/kallsyms symbol addresses.\n"
3003 "If /proc/sys/kernel/kptr_restrict is '2', you can not read\n"
3004 "kernel symbol addresses even if you are a superuser. Please change\n"
3005 "it to '1'. If kptr_restrict is '1', the superuser can read the\n"
3006 "symbol addresses.\n"
3007 "In that case, please run this command again with sudo.\n");
3011 * Find probe function addresses from map.
3012 * Return an error or the number of found probe_trace_event
3014 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
3015 struct probe_trace_event **tevs)
3017 struct map *map = NULL;
3018 struct ref_reloc_sym *reloc_sym = NULL;
3020 struct symbol **syms = NULL;
3021 struct probe_trace_event *tev;
3022 struct perf_probe_point *pp = &pev->point;
3023 struct probe_trace_point *tp;
3024 int num_matched_functions;
3025 int ret, i, j, skipped = 0;
3028 map = get_target_map(pev->target, pev->nsi, pev->uprobes);
3034 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
3041 * Load matched symbols: Since the different local symbols may have
3042 * same name but different addresses, this lists all the symbols.
3044 num_matched_functions = find_probe_functions(map, pp->function, syms);
3045 if (num_matched_functions <= 0) {
3046 if (num_matched_functions == -EACCES) {
3047 pr_err("Failed to load symbols from %s\n",
3048 pev->target ?: "/proc/kallsyms");
3050 pr_err("Please ensure the file is not stripped.\n");
3052 pr_kallsyms_access_error();
3054 pr_err("Failed to find symbol %s in %s\n", pp->function,
3055 pev->target ? : "kernel");
3058 } else if (num_matched_functions > probe_conf.max_probes) {
3059 pr_err("Too many functions matched in %s\n",
3060 pev->target ? : "kernel");
3065 /* Note that the symbols in the kmodule are not relocated */
3066 if (!pev->uprobes && !pev->target &&
3067 (!pp->retprobe || kretprobe_offset_is_supported())) {
3068 reloc_sym = kernel_get_ref_reloc_sym(NULL);
3070 pr_warning("Relocated base symbol is not found! "
3071 "Check /proc/sys/kernel/kptr_restrict\n"
3072 "and /proc/sys/kernel/perf_event_paranoid. "
3073 "Or run as privileged perf user.\n\n");
3079 /* Setup result trace-probe-events */
3080 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
3088 for (j = 0; j < num_matched_functions; j++) {
3091 if (sym->type != STT_FUNC)
3094 /* There can be duplicated symbols in the map */
3095 for (i = 0; i < j; i++)
3096 if (sym->start == syms[i]->start) {
3097 pr_debug("Found duplicated symbol %s @ %" PRIx64 "\n",
3098 sym->name, sym->start);
3104 tev = (*tevs) + ret;
3106 if (ret == num_matched_functions) {
3107 pr_warning("Too many symbols are listed. Skip it.\n");
3112 if (pp->offset > sym->end - sym->start) {
3113 pr_warning("Offset %ld is bigger than the size of %s\n",
3114 pp->offset, sym->name);
3118 /* Add one probe point */
3119 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
3121 /* Check the kprobe (not in module) is within .text */
3122 if (!pev->uprobes && !pev->target &&
3123 kprobe_warn_out_range(sym->name, tp->address)) {
3124 tp->symbol = NULL; /* Skip it */
3126 } else if (reloc_sym) {
3127 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
3128 tp->offset = tp->address - reloc_sym->addr;
3130 tp->symbol = strdup_or_goto(sym->name, nomem_out);
3131 tp->offset = pp->offset;
3133 tp->realname = strdup_or_goto(sym->name, nomem_out);
3135 tp->retprobe = pp->retprobe;
3138 tev->point.module = strdup_or_goto(pev->target,
3141 mod_name = find_module_name(pev->target);
3143 strdup(mod_name ? mod_name : pev->target);
3145 if (!tev->point.module)
3149 tev->uprobes = pev->uprobes;
3150 tev->nargs = pev->nargs;
3152 tev->args = zalloc(sizeof(struct probe_trace_arg) *
3154 if (tev->args == NULL)
3157 for (i = 0; i < tev->nargs; i++) {
3158 if (pev->args[i].name)
3160 strdup_or_goto(pev->args[i].name,
3163 tev->args[i].value = strdup_or_goto(pev->args[i].var,
3165 if (pev->args[i].type)
3167 strdup_or_goto(pev->args[i].type,
3170 arch__fix_tev_from_maps(pev, tev, map, sym);
3172 if (ret == skipped) {
3185 clear_probe_trace_events(*tevs, num_matched_functions);
3190 static int try_to_find_absolute_address(struct perf_probe_event *pev,
3191 struct probe_trace_event **tevs)
3193 struct perf_probe_point *pp = &pev->point;
3194 struct probe_trace_event *tev;
3195 struct probe_trace_point *tp;
3198 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
3200 if (perf_probe_event_need_dwarf(pev))
3204 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
3207 * Only one tev can be generated by this.
3209 *tevs = zalloc(sizeof(*tev));
3217 * Don't use tp->offset, use address directly, because
3218 * in synthesize_probe_trace_command() address cannot be
3221 tp->address = pev->point.abs_address;
3222 tp->retprobe = pp->retprobe;
3223 tev->uprobes = pev->uprobes;
3227 * Give it a '0x' leading symbol name.
3228 * In __add_probe_trace_events, a NULL symbol is interpreted as
3231 if (asprintf(&tp->symbol, "0x%" PRIx64, tp->address) < 0)
3234 /* For kprobe, check range */
3235 if ((!tev->uprobes) &&
3236 (kprobe_warn_out_range(tev->point.symbol,
3237 tev->point.address))) {
3242 if (asprintf(&tp->realname, "abs_%" PRIx64, tp->address) < 0)
3246 tp->module = strdup(pev->target);
3252 tev->group = strdup(pev->group);
3258 tev->event = strdup(pev->event);
3263 tev->nargs = pev->nargs;
3264 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
3268 for (i = 0; i < tev->nargs; i++)
3269 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
3274 clear_probe_trace_events(*tevs, 1);
3279 /* Concatenate two arrays */
3280 static void *memcat(void *a, size_t sz_a, void *b, size_t sz_b)
3284 ret = malloc(sz_a + sz_b);
3286 memcpy(ret, a, sz_a);
3287 memcpy(ret + sz_a, b, sz_b);
3293 concat_probe_trace_events(struct probe_trace_event **tevs, int *ntevs,
3294 struct probe_trace_event **tevs2, int ntevs2)
3296 struct probe_trace_event *new_tevs;
3306 if (*ntevs + ntevs2 > probe_conf.max_probes)
3309 /* Concatenate the array of probe_trace_event */
3310 new_tevs = memcat(*tevs, (*ntevs) * sizeof(**tevs),
3311 *tevs2, ntevs2 * sizeof(**tevs2));
3321 clear_probe_trace_events(*tevs2, ntevs2);
3328 * Try to find probe_trace_event from given probe caches. Return the number
3329 * of cached events found, if an error occurs return the error.
3331 static int find_cached_events(struct perf_probe_event *pev,
3332 struct probe_trace_event **tevs,
3335 struct probe_cache *cache;
3336 struct probe_cache_entry *entry;
3337 struct probe_trace_event *tmp_tevs = NULL;
3341 cache = probe_cache__new(target, pev->nsi);
3342 /* Return 0 ("not found") if the target has no probe cache. */
3346 for_each_probe_cache_entry(entry, cache) {
3347 /* Skip the cache entry which has no name */
3348 if (!entry->pev.event || !entry->pev.group)
3350 if ((!pev->group || strglobmatch(entry->pev.group, pev->group)) &&
3351 strglobmatch(entry->pev.event, pev->event)) {
3352 ret = probe_cache_entry__get_event(entry, &tmp_tevs);
3354 ret = concat_probe_trace_events(tevs, &ntevs,
3360 probe_cache__delete(cache);
3362 clear_probe_trace_events(*tevs, ntevs);
3366 if (ntevs > 0 && target && target[0] == '/')
3367 pev->uprobes = true;
3373 /* Try to find probe_trace_event from all probe caches */
3374 static int find_cached_events_all(struct perf_probe_event *pev,
3375 struct probe_trace_event **tevs)
3377 struct probe_trace_event *tmp_tevs = NULL;
3378 struct strlist *bidlist;
3379 struct str_node *nd;
3384 /* Get the buildid list of all valid caches */
3385 bidlist = build_id_cache__list_all(true);
3388 pr_debug("Failed to get buildids: %d\n", ret);
3393 strlist__for_each_entry(nd, bidlist) {
3394 pathname = build_id_cache__origname(nd->s);
3395 ret = find_cached_events(pev, &tmp_tevs, pathname);
3396 /* In the case of cnt == 0, we just skip it */
3398 ret = concat_probe_trace_events(tevs, &ntevs,
3404 strlist__delete(bidlist);
3407 clear_probe_trace_events(*tevs, ntevs);
3415 static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
3416 struct probe_trace_event **tevs)
3418 struct probe_cache *cache;
3419 struct probe_cache_entry *entry;
3420 struct probe_trace_event *tev;
3421 struct str_node *node;
3425 /* For SDT/cached events, we use special search functions */
3427 return find_cached_events_all(pev, tevs);
3429 return find_cached_events(pev, tevs, pev->target);
3431 cache = probe_cache__new(pev->target, pev->nsi);
3435 entry = probe_cache__find(cache, pev);
3437 /* SDT must be in the cache */
3438 ret = pev->sdt ? -ENOENT : 0;
3442 ret = strlist__nr_entries(entry->tevlist);
3443 if (ret > probe_conf.max_probes) {
3444 pr_debug("Too many entries matched in the cache of %s\n",
3445 pev->target ? : "kernel");
3450 *tevs = zalloc(ret * sizeof(*tev));
3457 strlist__for_each_entry(node, entry->tevlist) {
3458 tev = &(*tevs)[i++];
3459 ret = parse_probe_trace_command(node->s, tev);
3462 /* Set the uprobes attribute as same as original */
3463 tev->uprobes = pev->uprobes;
3468 probe_cache__delete(cache);
3472 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
3473 struct probe_trace_event **tevs)
3477 if (!pev->group && !pev->sdt) {
3478 /* Set group name if not given */
3479 if (!pev->uprobes) {
3480 pev->group = strdup(PERFPROBE_GROUP);
3481 ret = pev->group ? 0 : -ENOMEM;
3483 ret = convert_exec_to_group(pev->target, &pev->group);
3485 pr_warning("Failed to make a group name.\n");
3490 ret = try_to_find_absolute_address(pev, tevs);
3494 /* At first, we need to lookup cache entry */
3495 ret = find_probe_trace_events_from_cache(pev, tevs);
3496 if (ret > 0 || pev->sdt) /* SDT can be found only in the cache */
3497 return ret == 0 ? -ENOENT : ret; /* Found in probe cache */
3499 /* Convert perf_probe_event with debuginfo */
3500 ret = try_to_find_probe_trace_events(pev, tevs);
3502 return ret; /* Found in debuginfo or got an error */
3504 return find_probe_trace_events_from_map(pev, tevs);
3507 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3511 /* Loop 1: convert all events */
3512 for (i = 0; i < npevs; i++) {
3513 /* Init kprobe blacklist if needed */
3514 if (!pevs[i].uprobes)
3515 kprobe_blacklist__init();
3516 /* Convert with or without debuginfo */
3517 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
3520 pevs[i].ntevs = ret;
3522 /* This just release blacklist only if allocated */
3523 kprobe_blacklist__release();
3528 static int show_probe_trace_event(struct probe_trace_event *tev)
3530 char *buf = synthesize_probe_trace_command(tev);
3533 pr_debug("Failed to synthesize probe trace event.\n");
3537 /* Showing definition always go stdout */
3538 printf("%s\n", buf);
3544 int show_probe_trace_events(struct perf_probe_event *pevs, int npevs)
3546 struct strlist *namelist = strlist__new(NULL, NULL);
3547 struct probe_trace_event *tev;
3548 struct perf_probe_event *pev;
3554 for (j = 0; j < npevs && !ret; j++) {
3556 for (i = 0; i < pev->ntevs && !ret; i++) {
3557 tev = &pev->tevs[i];
3558 /* Skip if the symbol is out of .text or blacklisted */
3559 if (!tev->point.symbol && !pev->uprobes)
3562 /* Set new name for tev (and update namelist) */
3563 ret = probe_trace_event__set_name(tev, pev,
3566 ret = show_probe_trace_event(tev);
3569 strlist__delete(namelist);
3574 static int show_bootconfig_event(struct probe_trace_event *tev)
3576 struct probe_trace_point *tp = &tev->point;
3581 if (strbuf_init(&buf, 32) < 0)
3584 err = synthesize_kprobe_trace_def(tp, &buf);
3586 err = synthesize_probe_trace_args(tev, &buf);
3588 ret = strbuf_detach(&buf, NULL);
3589 strbuf_release(&buf);
3592 printf("'%s'", ret);
3599 int show_bootconfig_events(struct perf_probe_event *pevs, int npevs)
3601 struct strlist *namelist = strlist__new(NULL, NULL);
3602 struct probe_trace_event *tev;
3603 struct perf_probe_event *pev;
3604 char *cur_name = NULL;
3610 for (j = 0; j < npevs && !ret; j++) {
3612 if (pev->group && strcmp(pev->group, "probe"))
3613 pr_warning("WARN: Group name %s is ignored\n", pev->group);
3615 pr_warning("ERROR: Bootconfig doesn't support uprobes\n");
3619 for (i = 0; i < pev->ntevs && !ret; i++) {
3620 tev = &pev->tevs[i];
3621 /* Skip if the symbol is out of .text or blacklisted */
3622 if (!tev->point.symbol && !pev->uprobes)
3625 /* Set new name for tev (and update namelist) */
3626 ret = probe_trace_event__set_name(tev, pev,
3631 if (!cur_name || strcmp(cur_name, tev->event)) {
3632 printf("%sftrace.event.kprobes.%s.probe = ",
3633 cur_name ? "\n" : "", tev->event);
3634 cur_name = tev->event;
3637 ret = show_bootconfig_event(tev);
3641 strlist__delete(namelist);
3646 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3650 /* Loop 2: add all events */
3651 for (i = 0; i < npevs; i++) {
3652 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
3654 probe_conf.force_add);
3661 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3664 struct perf_probe_event *pev;
3666 /* Loop 3: cleanup and free trace events */
3667 for (i = 0; i < npevs; i++) {
3669 for (j = 0; j < pevs[i].ntevs; j++)
3670 clear_probe_trace_event(&pevs[i].tevs[j]);
3671 zfree(&pevs[i].tevs);
3673 nsinfo__zput(pev->nsi);
3674 clear_perf_probe_event(&pevs[i]);
3678 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3682 ret = init_probe_symbol_maps(pevs->uprobes);
3686 ret = convert_perf_probe_events(pevs, npevs);
3688 ret = apply_perf_probe_events(pevs, npevs);
3690 cleanup_perf_probe_events(pevs, npevs);
3692 exit_probe_symbol_maps();
3696 int del_perf_probe_events(struct strfilter *filter)
3698 int ret, ret2, ufd = -1, kfd = -1;
3699 char *str = strfilter__string(filter);
3704 /* Get current event names */
3705 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3709 ret = probe_file__del_events(kfd, filter);
3710 if (ret < 0 && ret != -ENOENT)
3713 ret2 = probe_file__del_events(ufd, filter);
3714 if (ret2 < 0 && ret2 != -ENOENT) {
3731 int show_available_funcs(const char *target, struct nsinfo *nsi,
3732 struct strfilter *_filter, bool user)
3738 ret = init_probe_symbol_maps(user);
3742 /* Get a symbol map */
3743 map = get_target_map(target, nsi, user);
3745 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3749 ret = map__load(map);
3752 char *str = strfilter__string(_filter);
3753 pr_err("Failed to find symbols matched to \"%s\"\n",
3757 pr_err("Failed to load symbols in %s\n",
3758 (target) ? : "kernel");
3761 if (!dso__sorted_by_name(map->dso))
3762 dso__sort_by_name(map->dso);
3764 /* Show all (filtered) symbols */
3767 for (nd = rb_first_cached(&map->dso->symbol_names); nd;
3769 struct symbol_name_rb_node *pos = rb_entry(nd, struct symbol_name_rb_node, rb_node);
3771 if (strfilter__compare(_filter, pos->sym.name))
3772 printf("%s\n", pos->sym.name);
3776 exit_probe_symbol_maps();
3781 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3782 struct perf_probe_arg *pvar)
3784 tvar->value = strdup(pvar->var);
3785 if (tvar->value == NULL)
3788 tvar->type = strdup(pvar->type);
3789 if (tvar->type == NULL)
3793 tvar->name = strdup(pvar->name);
3794 if (tvar->name == NULL)