2 * probe-event.c : perf-probe definition to probe_events format converter
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include <sys/utsname.h>
23 #include <sys/types.h>
43 #include <api/fs/fs.h>
44 #include "trace-event.h" /* For __maybe_unused */
45 #include "probe-event.h"
46 #include "probe-finder.h"
47 #include "probe-file.h"
50 #define MAX_CMDLEN 256
51 #define PERFPROBE_GROUP "probe"
53 bool probe_event_dry_run; /* Dry run flag */
54 struct probe_conf probe_conf;
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 char *synthesize_perf_probe_point(struct perf_probe_point *pp);
71 static struct machine *host_machine;
73 /* Initialize symbol maps and path of vmlinux/modules */
74 static int init_symbol_maps(bool user_only)
78 symbol_conf.sort_by_name = true;
79 symbol_conf.allow_aliases = true;
80 ret = symbol__init(NULL);
82 pr_debug("Failed to init symbol map.\n");
86 if (host_machine || user_only) /* already initialized */
89 if (symbol_conf.vmlinux_name)
90 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
92 host_machine = machine__new_host();
94 pr_debug("machine__new_host() failed.\n");
100 pr_warning("Failed to init vmlinux path.\n");
104 static void exit_symbol_maps(void)
107 machine__delete(host_machine);
113 static struct symbol *__find_kernel_function_by_name(const char *name,
116 return machine__find_kernel_function_by_name(host_machine, name, mapp,
120 static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
122 return machine__find_kernel_function(host_machine, addr, mapp, NULL);
125 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
127 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
130 if (map__load(host_machine->vmlinux_maps[MAP__FUNCTION], NULL) < 0)
133 kmap = map__kmap(host_machine->vmlinux_maps[MAP__FUNCTION]);
136 return kmap->ref_reloc_sym;
139 static u64 kernel_get_symbol_address_by_name(const char *name, bool reloc)
141 struct ref_reloc_sym *reloc_sym;
145 /* ref_reloc_sym is just a label. Need a special fix*/
146 reloc_sym = kernel_get_ref_reloc_sym();
147 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
148 return (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
150 sym = __find_kernel_function_by_name(name, &map);
152 return map->unmap_ip(map, sym->start) -
153 ((reloc) ? 0 : map->reloc);
158 static struct map *kernel_get_module_map(const char *module)
160 struct map_groups *grp = &host_machine->kmaps;
161 struct maps *maps = &grp->maps[MAP__FUNCTION];
164 /* A file path -- this is an offline module */
165 if (module && strchr(module, '/'))
166 return machine__findnew_module_map(host_machine, 0, module);
171 for (pos = maps__first(maps); pos; pos = map__next(pos)) {
172 if (strncmp(pos->dso->short_name + 1, module,
173 pos->dso->short_name_len - 2) == 0) {
180 static struct map *get_target_map(const char *target, bool user)
182 /* Init maps of given executable or kernel */
184 return dso__new_map(target);
186 return kernel_get_module_map(target);
189 static void put_target_map(struct map *map, bool user)
192 /* Only the user map needs to be released */
198 static int convert_exec_to_group(const char *exec, char **result)
200 char *ptr1, *ptr2, *exec_copy;
204 exec_copy = strdup(exec);
208 ptr1 = basename(exec_copy);
214 ptr2 = strpbrk(ptr1, "-._");
217 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
221 *result = strdup(buf);
222 ret = *result ? 0 : -ENOMEM;
229 static void clear_perf_probe_point(struct perf_probe_point *pp)
236 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
240 for (i = 0; i < ntevs; i++)
241 clear_probe_trace_event(tevs + i);
244 static bool kprobe_blacklist__listed(unsigned long address);
245 static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
249 /* Get the address of _etext for checking non-probable text symbol */
250 etext_addr = kernel_get_symbol_address_by_name("_etext", false);
252 if (etext_addr != 0 && etext_addr < address)
253 pr_warning("%s is out of .text, skip it.\n", symbol);
254 else if (kprobe_blacklist__listed(address))
255 pr_warning("%s is blacklisted function, skip it.\n", symbol);
262 #ifdef HAVE_DWARF_SUPPORT
264 static int kernel_get_module_dso(const char *module, struct dso **pdso)
268 const char *vmlinux_name;
272 list_for_each_entry(dso, &host_machine->dsos.head, node) {
275 if (strncmp(dso->short_name + 1, module,
276 dso->short_name_len - 2) == 0)
279 pr_debug("Failed to find module %s.\n", module);
283 map = host_machine->vmlinux_maps[MAP__FUNCTION];
286 vmlinux_name = symbol_conf.vmlinux_name;
289 ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
291 ret = dso__load_vmlinux_path(dso, map, NULL);
298 * Some binaries like glibc have special symbols which are on the symbol
299 * table, but not in the debuginfo. If we can find the address of the
300 * symbol from map, we can translate the address back to the probe point.
302 static int find_alternative_probe_point(struct debuginfo *dinfo,
303 struct perf_probe_point *pp,
304 struct perf_probe_point *result,
305 const char *target, bool uprobes)
307 struct map *map = NULL;
312 /* This can work only for function-name based one */
313 if (!pp->function || pp->file)
316 map = get_target_map(target, uprobes);
320 /* Find the address of given function */
321 map__for_each_symbol_by_name(map, pp->function, sym) {
323 address = sym->start;
325 address = map->unmap_ip(map, sym->start);
332 pr_debug("Symbol %s address found : %" PRIx64 "\n",
333 pp->function, address);
335 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
338 ret = (!ret) ? -ENOENT : ret;
340 result->offset += pp->offset;
341 result->line += pp->line;
342 result->retprobe = pp->retprobe;
347 put_target_map(map, uprobes);
352 static int get_alternative_probe_event(struct debuginfo *dinfo,
353 struct perf_probe_event *pev,
354 struct perf_probe_point *tmp)
358 memcpy(tmp, &pev->point, sizeof(*tmp));
359 memset(&pev->point, 0, sizeof(pev->point));
360 ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
361 pev->target, pev->uprobes);
363 memcpy(&pev->point, tmp, sizeof(*tmp));
368 static int get_alternative_line_range(struct debuginfo *dinfo,
369 struct line_range *lr,
370 const char *target, bool user)
372 struct perf_probe_point pp = { .function = lr->function,
375 struct perf_probe_point result;
378 memset(&result, 0, sizeof(result));
380 if (lr->end != INT_MAX)
381 len = lr->end - lr->start;
382 ret = find_alternative_probe_point(dinfo, &pp, &result,
385 lr->function = result.function;
386 lr->file = result.file;
387 lr->start = result.line;
388 if (lr->end != INT_MAX)
389 lr->end = lr->start + len;
390 clear_perf_probe_point(&pp);
395 /* Open new debuginfo of given module */
396 static struct debuginfo *open_debuginfo(const char *module, bool silent)
398 const char *path = module;
399 char reason[STRERR_BUFSIZE];
400 struct debuginfo *ret = NULL;
401 struct dso *dso = NULL;
404 if (!module || !strchr(module, '/')) {
405 err = kernel_get_module_dso(module, &dso);
407 if (!dso || dso->load_errno == 0) {
408 if (!strerror_r(-err, reason, STRERR_BUFSIZE))
409 strcpy(reason, "(unknown)");
411 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
413 pr_err("Failed to find the path for %s: %s\n",
414 module ?: "kernel", reason);
417 path = dso->long_name;
419 ret = debuginfo__new(path);
420 if (!ret && !silent) {
421 pr_warning("The %s file has no debug information.\n", path);
422 if (!module || !strtailcmp(path, ".ko"))
423 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
425 pr_warning("Rebuild with -g, ");
426 pr_warning("or install an appropriate debuginfo package.\n");
431 /* For caching the last debuginfo */
432 static struct debuginfo *debuginfo_cache;
433 static char *debuginfo_cache_path;
435 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
437 if ((debuginfo_cache_path && !strcmp(debuginfo_cache_path, module)) ||
438 (!debuginfo_cache_path && !module && debuginfo_cache))
441 /* Copy module path */
442 free(debuginfo_cache_path);
444 debuginfo_cache_path = strdup(module);
445 if (!debuginfo_cache_path) {
446 debuginfo__delete(debuginfo_cache);
447 debuginfo_cache = NULL;
452 debuginfo_cache = open_debuginfo(module, silent);
453 if (!debuginfo_cache)
454 zfree(&debuginfo_cache_path);
456 return debuginfo_cache;
459 static void debuginfo_cache__exit(void)
461 debuginfo__delete(debuginfo_cache);
462 debuginfo_cache = NULL;
463 zfree(&debuginfo_cache_path);
467 static int get_text_start_address(const char *exec, unsigned long *address)
472 int fd, ret = -ENOENT;
474 fd = open(exec, O_RDONLY);
478 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
482 if (gelf_getehdr(elf, &ehdr) == NULL)
485 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
488 *address = shdr.sh_addr - shdr.sh_offset;
496 * Convert trace point to probe point with debuginfo
498 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
499 struct perf_probe_point *pp,
502 struct debuginfo *dinfo = NULL;
503 unsigned long stext = 0;
504 u64 addr = tp->address;
507 /* convert the address to dwarf address */
513 ret = get_text_start_address(tp->module, &stext);
517 } else if (tp->symbol) {
518 addr = kernel_get_symbol_address_by_name(tp->symbol, false);
524 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
525 tp->module ? : "kernel");
527 dinfo = debuginfo_cache__open(tp->module, verbose == 0);
529 ret = debuginfo__find_probe_point(dinfo,
530 (unsigned long)addr, pp);
535 pp->retprobe = tp->retprobe;
539 pr_debug("Failed to find corresponding probes from debuginfo.\n");
540 return ret ? : -ENOENT;
543 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
544 int ntevs, const char *exec)
547 unsigned long stext = 0;
552 ret = get_text_start_address(exec, &stext);
556 for (i = 0; i < ntevs && ret >= 0; i++) {
557 /* point.address is the addres of point.symbol + point.offset */
558 tevs[i].point.address -= stext;
559 tevs[i].point.module = strdup(exec);
560 if (!tevs[i].point.module) {
564 tevs[i].uprobes = true;
570 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
571 int ntevs, const char *module)
579 tmp = strrchr(module, '/');
581 /* This is a module path -- get the module name */
582 module = strdup(tmp + 1);
585 tmp = strchr(module, '.');
588 tmp = (char *)module; /* For free() */
591 for (i = 0; i < ntevs; i++) {
592 tevs[i].point.module = strdup(module);
593 if (!tevs[i].point.module) {
603 /* Post processing the probe events */
604 static int post_process_probe_trace_events(struct probe_trace_event *tevs,
605 int ntevs, const char *module,
608 struct ref_reloc_sym *reloc_sym;
613 return add_exec_to_probe_trace_events(tevs, ntevs, module);
615 /* Note that currently ref_reloc_sym based probe is not for drivers */
617 return add_module_to_probe_trace_events(tevs, ntevs, module);
619 reloc_sym = kernel_get_ref_reloc_sym();
621 pr_warning("Relocated base symbol is not found!\n");
625 for (i = 0; i < ntevs; i++) {
626 if (!tevs[i].point.address || tevs[i].point.retprobe)
628 /* If we found a wrong one, mark it by NULL symbol */
629 if (kprobe_warn_out_range(tevs[i].point.symbol,
630 tevs[i].point.address)) {
634 tmp = strdup(reloc_sym->name);
638 /* If we have no realname, use symbol for it */
639 if (!tevs[i].point.realname)
640 tevs[i].point.realname = tevs[i].point.symbol;
642 free(tevs[i].point.symbol);
643 tevs[i].point.symbol = tmp;
644 tevs[i].point.offset = tevs[i].point.address -
645 reloc_sym->unrelocated_addr;
650 /* Try to find perf_probe_event with debuginfo */
651 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
652 struct probe_trace_event **tevs)
654 bool need_dwarf = perf_probe_event_need_dwarf(pev);
655 struct perf_probe_point tmp;
656 struct debuginfo *dinfo;
659 dinfo = open_debuginfo(pev->target, !need_dwarf);
663 pr_debug("Could not open debuginfo. Try to use symbols.\n");
667 pr_debug("Try to find probe point from debuginfo.\n");
668 /* Searching trace events corresponding to a probe event */
669 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
671 if (ntevs == 0) { /* Not found, retry with an alternative */
672 ret = get_alternative_probe_event(dinfo, pev, &tmp);
674 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
676 * Write back to the original probe_event for
677 * setting appropriate (user given) event name
679 clear_perf_probe_point(&pev->point);
680 memcpy(&pev->point, &tmp, sizeof(tmp));
684 debuginfo__delete(dinfo);
686 if (ntevs > 0) { /* Succeeded to find trace events */
687 pr_debug("Found %d probe_trace_events.\n", ntevs);
688 ret = post_process_probe_trace_events(*tevs, ntevs,
689 pev->target, pev->uprobes);
690 if (ret < 0 || ret == ntevs) {
691 clear_probe_trace_events(*tevs, ntevs);
695 return ret < 0 ? ret : ntevs;
700 if (ntevs == 0) { /* No error but failed to find probe point. */
701 pr_warning("Probe point '%s' not found.\n",
702 synthesize_perf_probe_point(&pev->point));
705 /* Error path : ntevs < 0 */
706 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
709 pr_warning("Warning: No dwarf info found in the vmlinux - "
710 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
712 pr_debug("Trying to use symbols.\n");
719 #define LINEBUF_SIZE 256
720 #define NR_ADDITIONAL_LINES 2
722 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
724 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
725 const char *color = show_num ? "" : PERF_COLOR_BLUE;
726 const char *prefix = NULL;
729 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
734 prefix = show_num ? "%7d " : " ";
735 color_fprintf(stdout, color, prefix, l);
737 color_fprintf(stdout, color, "%s", buf);
739 } while (strchr(buf, '\n') == NULL);
744 pr_warning("File read error: %s\n",
745 strerror_r(errno, sbuf, sizeof(sbuf)));
751 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
753 int rv = __show_one_line(fp, l, skip, show_num);
755 pr_warning("Source file is shorter than expected.\n");
761 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
762 #define show_one_line(f,l) _show_one_line(f,l,false,false)
763 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
764 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
767 * Show line-range always requires debuginfo to find source file and
770 static int __show_line_range(struct line_range *lr, const char *module,
775 struct debuginfo *dinfo;
779 char sbuf[STRERR_BUFSIZE];
781 /* Search a line range */
782 dinfo = open_debuginfo(module, false);
786 ret = debuginfo__find_line_range(dinfo, lr);
787 if (!ret) { /* Not found, retry with an alternative */
788 ret = get_alternative_line_range(dinfo, lr, module, user);
790 ret = debuginfo__find_line_range(dinfo, lr);
792 debuginfo__delete(dinfo);
793 if (ret == 0 || ret == -ENOENT) {
794 pr_warning("Specified source line is not found.\n");
796 } else if (ret < 0) {
797 pr_warning("Debuginfo analysis failed.\n");
801 /* Convert source file path */
803 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
805 /* Free old path when new path is assigned */
810 pr_warning("Failed to find source file path.\n");
817 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
818 lr->start - lr->offset);
820 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
822 fp = fopen(lr->path, "r");
824 pr_warning("Failed to open %s: %s\n", lr->path,
825 strerror_r(errno, sbuf, sizeof(sbuf)));
828 /* Skip to starting line number */
829 while (l < lr->start) {
830 ret = skip_one_line(fp, l++);
835 intlist__for_each(ln, lr->line_list) {
836 for (; ln->i > l; l++) {
837 ret = show_one_line(fp, l - lr->offset);
841 ret = show_one_line_with_num(fp, l++ - lr->offset);
846 if (lr->end == INT_MAX)
847 lr->end = l + NR_ADDITIONAL_LINES;
848 while (l <= lr->end) {
849 ret = show_one_line_or_eof(fp, l++ - lr->offset);
858 int show_line_range(struct line_range *lr, const char *module, bool user)
862 ret = init_symbol_maps(user);
865 ret = __show_line_range(lr, module, user);
871 static int show_available_vars_at(struct debuginfo *dinfo,
872 struct perf_probe_event *pev,
873 struct strfilter *_filter)
877 struct str_node *node;
878 struct variable_list *vls = NULL, *vl;
879 struct perf_probe_point tmp;
882 buf = synthesize_perf_probe_point(&pev->point);
885 pr_debug("Searching variables at %s\n", buf);
887 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
888 if (!ret) { /* Not found, retry with an alternative */
889 ret = get_alternative_probe_event(dinfo, pev, &tmp);
891 ret = debuginfo__find_available_vars_at(dinfo, pev,
893 /* Release the old probe_point */
894 clear_perf_probe_point(&tmp);
898 if (ret == 0 || ret == -ENOENT) {
899 pr_err("Failed to find the address of %s\n", buf);
902 pr_warning("Debuginfo analysis failed.\n");
906 /* Some variables are found */
907 fprintf(stdout, "Available variables at %s\n", buf);
908 for (i = 0; i < ret; i++) {
911 * A probe point might be converted to
912 * several trace points.
914 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
916 zfree(&vl->point.symbol);
919 strlist__for_each(node, vl->vars) {
920 var = strchr(node->s, '\t') + 1;
921 if (strfilter__compare(_filter, var)) {
922 fprintf(stdout, "\t\t%s\n", node->s);
926 strlist__delete(vl->vars);
929 fprintf(stdout, "\t\t(No matched variables)\n");
937 /* Show available variables on given probe point */
938 int show_available_vars(struct perf_probe_event *pevs, int npevs,
939 struct strfilter *_filter)
942 struct debuginfo *dinfo;
944 ret = init_symbol_maps(pevs->uprobes);
948 dinfo = open_debuginfo(pevs->target, false);
956 for (i = 0; i < npevs && ret >= 0; i++)
957 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
959 debuginfo__delete(dinfo);
965 #else /* !HAVE_DWARF_SUPPORT */
967 static void debuginfo_cache__exit(void)
972 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
973 struct perf_probe_point *pp __maybe_unused,
974 bool is_kprobe __maybe_unused)
979 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
980 struct probe_trace_event **tevs __maybe_unused)
982 if (perf_probe_event_need_dwarf(pev)) {
983 pr_warning("Debuginfo-analysis is not supported.\n");
990 int show_line_range(struct line_range *lr __maybe_unused,
991 const char *module __maybe_unused,
992 bool user __maybe_unused)
994 pr_warning("Debuginfo-analysis is not supported.\n");
998 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
999 int npevs __maybe_unused,
1000 struct strfilter *filter __maybe_unused)
1002 pr_warning("Debuginfo-analysis is not supported.\n");
1007 void line_range__clear(struct line_range *lr)
1013 intlist__delete(lr->line_list);
1014 memset(lr, 0, sizeof(*lr));
1017 int line_range__init(struct line_range *lr)
1019 memset(lr, 0, sizeof(*lr));
1020 lr->line_list = intlist__new(NULL);
1027 static int parse_line_num(char **ptr, int *val, const char *what)
1029 const char *start = *ptr;
1032 *val = strtol(*ptr, ptr, 0);
1033 if (errno || *ptr == start) {
1034 semantic_error("'%s' is not a valid number.\n", what);
1040 /* Check the name is good for event, group or function */
1041 static bool is_c_func_name(const char *name)
1043 if (!isalpha(*name) && *name != '_')
1045 while (*++name != '\0') {
1046 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1053 * Stuff 'lr' according to the line range described by 'arg'.
1054 * The line range syntax is described by:
1056 * SRC[:SLN[+NUM|-ELN]]
1057 * FNC[@SRC][:SLN[+NUM|-ELN]]
1059 int parse_line_range_desc(const char *arg, struct line_range *lr)
1061 char *range, *file, *name = strdup(arg);
1070 range = strchr(name, ':');
1074 err = parse_line_num(&range, &lr->start, "start line");
1078 if (*range == '+' || *range == '-') {
1079 const char c = *range++;
1081 err = parse_line_num(&range, &lr->end, "end line");
1086 lr->end += lr->start;
1088 * Adjust the number of lines here.
1089 * If the number of lines == 1, the
1090 * the end of line should be equal to
1091 * the start of line.
1097 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1100 if (lr->start > lr->end) {
1101 semantic_error("Start line must be smaller"
1102 " than end line.\n");
1105 if (*range != '\0') {
1106 semantic_error("Tailing with invalid str '%s'.\n", range);
1111 file = strchr(name, '@');
1114 lr->file = strdup(++file);
1115 if (lr->file == NULL) {
1119 lr->function = name;
1120 } else if (strchr(name, '/') || strchr(name, '.'))
1122 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1123 lr->function = name;
1124 else { /* Invalid name */
1125 semantic_error("'%s' is not a valid function name.\n", name);
1136 /* Parse probepoint definition. */
1137 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1139 struct perf_probe_point *pp = &pev->point;
1142 bool file_spec = false;
1145 * perf probe [EVENT=]SRC[:LN|;PTN]
1146 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1148 * TODO:Group name support
1153 ptr = strpbrk(arg, ";=@+%");
1154 if (ptr && *ptr == '=') { /* Event name */
1157 if (strchr(arg, ':')) {
1158 semantic_error("Group name is not supported yet.\n");
1161 if (!is_c_func_name(arg)) {
1162 semantic_error("%s is bad for event name -it must "
1163 "follow C symbol-naming rule.\n", arg);
1166 pev->event = strdup(arg);
1167 if (pev->event == NULL)
1174 * Check arg is function or file name and copy it.
1176 * We consider arg to be a file spec if and only if it satisfies
1177 * all of the below criteria::
1178 * - it does not include any of "+@%",
1179 * - it includes one of ":;", and
1180 * - it has a period '.' in the name.
1182 * Otherwise, we consider arg to be a function specification.
1184 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
1185 /* This is a file spec if it includes a '.' before ; or : */
1186 if (memchr(arg, '.', ptr - arg))
1190 ptr = strpbrk(arg, ";:+@%");
1210 * Keep pp->function even if this is absolute address,
1211 * so it can mark whether abs_address is valid.
1212 * Which make 'perf probe lib.bin 0x0' possible.
1214 * Note that checking length of tmp is not needed
1215 * because when we access tmp[1] we know tmp[0] is '0',
1216 * so tmp[1] should always valid (but could be '\0').
1218 if (tmp && !strncmp(tmp, "0x", 2)) {
1219 pp->abs_address = strtoul(pp->function, &tmp, 0);
1221 semantic_error("Invalid absolute address.\n");
1227 /* Parse other options */
1231 if (c == ';') { /* Lazy pattern must be the last part */
1232 pp->lazy_line = strdup(arg);
1233 if (pp->lazy_line == NULL)
1237 ptr = strpbrk(arg, ";:+@%");
1243 case ':': /* Line number */
1244 pp->line = strtoul(arg, &tmp, 0);
1246 semantic_error("There is non-digit char"
1247 " in line number.\n");
1251 case '+': /* Byte offset from a symbol */
1252 pp->offset = strtoul(arg, &tmp, 0);
1254 semantic_error("There is non-digit character"
1259 case '@': /* File name */
1261 semantic_error("SRC@SRC is not allowed.\n");
1264 pp->file = strdup(arg);
1265 if (pp->file == NULL)
1268 case '%': /* Probe places */
1269 if (strcmp(arg, "return") == 0) {
1271 } else { /* Others not supported yet */
1272 semantic_error("%%%s is not supported.\n", arg);
1276 default: /* Buggy case */
1277 pr_err("This program has a bug at %s:%d.\n",
1278 __FILE__, __LINE__);
1284 /* Exclusion check */
1285 if (pp->lazy_line && pp->line) {
1286 semantic_error("Lazy pattern can't be used with"
1291 if (pp->lazy_line && pp->offset) {
1292 semantic_error("Lazy pattern can't be used with offset.\n");
1296 if (pp->line && pp->offset) {
1297 semantic_error("Offset can't be used with line number.\n");
1301 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1302 semantic_error("File always requires line number or "
1307 if (pp->offset && !pp->function) {
1308 semantic_error("Offset requires an entry function.\n");
1312 if (pp->retprobe && !pp->function) {
1313 semantic_error("Return probe requires an entry function.\n");
1317 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1318 semantic_error("Offset/Line/Lazy pattern can't be used with "
1323 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1324 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1329 /* Parse perf-probe event argument */
1330 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1332 char *tmp, *goodname;
1333 struct perf_probe_arg_field **fieldp;
1335 pr_debug("parsing arg: %s into ", str);
1337 tmp = strchr(str, '=');
1339 arg->name = strndup(str, tmp - str);
1340 if (arg->name == NULL)
1342 pr_debug("name:%s ", arg->name);
1346 tmp = strchr(str, ':');
1347 if (tmp) { /* Type setting */
1349 arg->type = strdup(tmp + 1);
1350 if (arg->type == NULL)
1352 pr_debug("type:%s ", arg->type);
1355 tmp = strpbrk(str, "-.[");
1356 if (!is_c_varname(str) || !tmp) {
1357 /* A variable, register, symbol or special value */
1358 arg->var = strdup(str);
1359 if (arg->var == NULL)
1361 pr_debug("%s\n", arg->var);
1365 /* Structure fields or array element */
1366 arg->var = strndup(str, tmp - str);
1367 if (arg->var == NULL)
1369 goodname = arg->var;
1370 pr_debug("%s, ", arg->var);
1371 fieldp = &arg->field;
1374 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1375 if (*fieldp == NULL)
1377 if (*tmp == '[') { /* Array */
1379 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1380 (*fieldp)->ref = true;
1381 if (*tmp != ']' || tmp == str + 1) {
1382 semantic_error("Array index must be a"
1389 } else { /* Structure */
1392 (*fieldp)->ref = false;
1393 } else if (tmp[1] == '>') {
1395 (*fieldp)->ref = true;
1397 semantic_error("Argument parse error: %s\n",
1401 tmp = strpbrk(str, "-.[");
1404 (*fieldp)->name = strndup(str, tmp - str);
1405 if ((*fieldp)->name == NULL)
1408 goodname = (*fieldp)->name;
1409 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1410 fieldp = &(*fieldp)->next;
1413 (*fieldp)->name = strdup(str);
1414 if ((*fieldp)->name == NULL)
1417 goodname = (*fieldp)->name;
1418 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1420 /* If no name is specified, set the last field name (not array index)*/
1422 arg->name = strdup(goodname);
1423 if (arg->name == NULL)
1429 /* Parse perf-probe event command */
1430 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1433 int argc, i, ret = 0;
1435 argv = argv_split(cmd, &argc);
1437 pr_debug("Failed to split arguments.\n");
1440 if (argc - 1 > MAX_PROBE_ARGS) {
1441 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1445 /* Parse probe point */
1446 ret = parse_perf_probe_point(argv[0], pev);
1450 /* Copy arguments and ensure return probe has no C argument */
1451 pev->nargs = argc - 1;
1452 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1453 if (pev->args == NULL) {
1457 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1458 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1460 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1461 semantic_error("You can't specify local variable for"
1472 /* Return true if this perf_probe_event requires debuginfo */
1473 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1477 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1480 for (i = 0; i < pev->nargs; i++)
1481 if (is_c_varname(pev->args[i].var))
1487 /* Parse probe_events event into struct probe_point */
1488 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1490 struct probe_trace_point *tp = &tev->point;
1493 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1497 pr_debug("Parsing probe_events: %s\n", cmd);
1498 argv = argv_split(cmd, &argc);
1500 pr_debug("Failed to split arguments.\n");
1504 semantic_error("Too few probe arguments.\n");
1509 /* Scan event and group name. */
1510 argv0_str = strdup(argv[0]);
1511 if (argv0_str == NULL) {
1515 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1516 fmt2_str = strtok_r(NULL, "/", &fmt);
1517 fmt3_str = strtok_r(NULL, " \t", &fmt);
1518 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1519 || fmt3_str == NULL) {
1520 semantic_error("Failed to parse event name: %s\n", argv[0]);
1525 tev->group = strdup(fmt2_str);
1526 tev->event = strdup(fmt3_str);
1527 if (tev->group == NULL || tev->event == NULL) {
1531 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1533 tp->retprobe = (pr == 'r');
1535 /* Scan module name(if there), function name and offset */
1536 p = strchr(argv[1], ':');
1538 tp->module = strndup(argv[1], p - argv[1]);
1542 fmt1_str = strtok_r(p, "+", &fmt);
1543 /* only the address started with 0x */
1544 if (fmt1_str[0] == '0') {
1546 * Fix a special case:
1547 * if address == 0, kernel reports something like:
1548 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1549 * Newer kernel may fix that, but we want to
1550 * support old kernel also.
1552 if (strcmp(fmt1_str, "0x") == 0) {
1553 if (!argv[2] || strcmp(argv[2], "(null)")) {
1560 for (i = 2; argv[i + 1] != NULL; i++)
1561 argv[i] = argv[i + 1];
1566 tp->address = strtoul(fmt1_str, NULL, 0);
1568 /* Only the symbol-based probe has offset */
1569 tp->symbol = strdup(fmt1_str);
1570 if (tp->symbol == NULL) {
1574 fmt2_str = strtok_r(NULL, "", &fmt);
1575 if (fmt2_str == NULL)
1578 tp->offset = strtoul(fmt2_str, NULL, 10);
1581 tev->nargs = argc - 2;
1582 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1583 if (tev->args == NULL) {
1587 for (i = 0; i < tev->nargs; i++) {
1588 p = strchr(argv[i + 2], '=');
1589 if (p) /* We don't need which register is assigned. */
1593 tev->args[i].name = strdup(argv[i + 2]);
1594 /* TODO: parse regs and offset */
1595 tev->args[i].value = strdup(p);
1596 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1608 /* Compose only probe arg */
1609 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1611 struct perf_probe_arg_field *field = pa->field;
1615 if (pa->name && pa->var)
1616 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1618 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1625 if (field->name[0] == '[')
1626 ret = e_snprintf(tmp, len, "%s", field->name);
1628 ret = e_snprintf(tmp, len, "%s%s",
1629 field->ref ? "->" : ".", field->name);
1634 field = field->next;
1638 ret = e_snprintf(tmp, len, ":%s", pa->type);
1647 pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1651 /* Compose only probe point (not argument) */
1652 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1655 char offs[32] = "", line[32] = "", file[32] = "";
1658 buf = zalloc(MAX_CMDLEN);
1664 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1669 ret = e_snprintf(line, 32, ":%d", pp->line);
1677 tmp = strchr(pp->file + len - 30, '/');
1678 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1680 ret = e_snprintf(file, 32, "@%s", tmp);
1686 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1687 offs, pp->retprobe ? "%return" : "", line,
1690 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1696 pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1702 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1707 buf = synthesize_perf_probe_point(&pev->point);
1712 for (i = 0; i < pev->nargs; i++) {
1713 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1726 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1727 char **buf, size_t *buflen,
1732 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1738 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1750 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1751 char *buf, size_t buflen)
1753 struct probe_trace_arg_ref *ref = arg->ref;
1757 /* Argument name or separator */
1759 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1761 ret = e_snprintf(buf, buflen, " ");
1767 /* Special case: @XXX */
1768 if (arg->value[0] == '@' && arg->ref)
1771 /* Dereferencing arguments */
1773 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1779 /* Print argument value */
1780 if (arg->value[0] == '@' && arg->ref)
1781 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1784 ret = e_snprintf(buf, buflen, "%s", arg->value);
1792 ret = e_snprintf(buf, buflen, ")");
1798 /* Print argument type */
1800 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1809 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1811 struct probe_trace_point *tp = &tev->point;
1815 buf = zalloc(MAX_CMDLEN);
1819 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1820 tev->group, tev->event);
1824 /* Uprobes must have tp->module */
1825 if (tev->uprobes && !tp->module)
1828 * If tp->address == 0, then this point must be a
1829 * absolute address uprobe.
1830 * try_to_find_absolute_address() should have made
1831 * tp->symbol to "0x0".
1833 if (tev->uprobes && !tp->address) {
1834 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
1838 /* Use the tp->address for uprobes */
1840 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
1841 tp->module, tp->address);
1842 else if (!strncmp(tp->symbol, "0x", 2))
1843 /* Absolute address. See try_to_find_absolute_address() */
1844 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s0x%lx",
1845 tp->module ?: "", tp->module ? ":" : "",
1848 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1849 tp->module ?: "", tp->module ? ":" : "",
1850 tp->symbol, tp->offset);
1856 for (i = 0; i < tev->nargs; i++) {
1857 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1870 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1871 struct perf_probe_point *pp,
1874 struct symbol *sym = NULL;
1876 u64 addr = tp->address;
1880 map = dso__new_map(tp->module);
1883 sym = map__find_symbol(map, addr, NULL);
1886 addr = kernel_get_symbol_address_by_name(tp->symbol, true);
1889 sym = __find_kernel_function(addr, &map);
1895 pp->retprobe = tp->retprobe;
1896 pp->offset = addr - map->unmap_ip(map, sym->start);
1897 pp->function = strdup(sym->name);
1898 ret = pp->function ? 0 : -ENOMEM;
1901 if (map && !is_kprobe) {
1908 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1909 struct perf_probe_point *pp,
1915 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1918 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1922 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1925 pp->function = strdup(tp->symbol);
1926 pp->offset = tp->offset;
1928 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1931 pp->function = strdup(buf);
1934 if (pp->function == NULL)
1937 pp->retprobe = tp->retprobe;
1942 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1943 struct perf_probe_event *pev, bool is_kprobe)
1948 /* Convert event/group name */
1949 pev->event = strdup(tev->event);
1950 pev->group = strdup(tev->group);
1951 if (pev->event == NULL || pev->group == NULL)
1954 /* Convert trace_point to probe_point */
1955 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1959 /* Convert trace_arg to probe_arg */
1960 pev->nargs = tev->nargs;
1961 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1962 if (pev->args == NULL)
1964 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1965 if (tev->args[i].name)
1966 pev->args[i].name = strdup(tev->args[i].name);
1968 ret = synthesize_probe_trace_arg(&tev->args[i],
1970 pev->args[i].name = strdup(buf);
1972 if (pev->args[i].name == NULL && ret >= 0)
1977 clear_perf_probe_event(pev);
1982 void clear_perf_probe_event(struct perf_probe_event *pev)
1984 struct perf_probe_arg_field *field, *next;
1990 clear_perf_probe_point(&pev->point);
1992 for (i = 0; i < pev->nargs; i++) {
1993 free(pev->args[i].name);
1994 free(pev->args[i].var);
1995 free(pev->args[i].type);
1996 field = pev->args[i].field;
1999 zfree(&field->name);
2005 memset(pev, 0, sizeof(*pev));
2008 void clear_probe_trace_event(struct probe_trace_event *tev)
2010 struct probe_trace_arg_ref *ref, *next;
2015 free(tev->point.symbol);
2016 free(tev->point.realname);
2017 free(tev->point.module);
2018 for (i = 0; i < tev->nargs; i++) {
2019 free(tev->args[i].name);
2020 free(tev->args[i].value);
2021 free(tev->args[i].type);
2022 ref = tev->args[i].ref;
2030 memset(tev, 0, sizeof(*tev));
2033 struct kprobe_blacklist_node {
2034 struct list_head list;
2035 unsigned long start;
2040 static void kprobe_blacklist__delete(struct list_head *blacklist)
2042 struct kprobe_blacklist_node *node;
2044 while (!list_empty(blacklist)) {
2045 node = list_first_entry(blacklist,
2046 struct kprobe_blacklist_node, list);
2047 list_del(&node->list);
2053 static int kprobe_blacklist__load(struct list_head *blacklist)
2055 struct kprobe_blacklist_node *node;
2056 const char *__debugfs = debugfs__mountpoint();
2057 char buf[PATH_MAX], *p;
2061 if (__debugfs == NULL)
2064 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2068 fp = fopen(buf, "r");
2073 while (fgets(buf, PATH_MAX, fp)) {
2074 node = zalloc(sizeof(*node));
2079 INIT_LIST_HEAD(&node->list);
2080 list_add_tail(&node->list, blacklist);
2081 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2085 p = strchr(buf, '\t');
2088 if (p[strlen(p) - 1] == '\n')
2089 p[strlen(p) - 1] = '\0';
2091 p = (char *)"unknown";
2092 node->symbol = strdup(p);
2093 if (!node->symbol) {
2097 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2098 node->start, node->end, node->symbol);
2102 kprobe_blacklist__delete(blacklist);
2108 static struct kprobe_blacklist_node *
2109 kprobe_blacklist__find_by_address(struct list_head *blacklist,
2110 unsigned long address)
2112 struct kprobe_blacklist_node *node;
2114 list_for_each_entry(node, blacklist, list) {
2115 if (node->start <= address && address <= node->end)
2122 static LIST_HEAD(kprobe_blacklist);
2124 static void kprobe_blacklist__init(void)
2126 if (!list_empty(&kprobe_blacklist))
2129 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2130 pr_debug("No kprobe blacklist support, ignored\n");
2133 static void kprobe_blacklist__release(void)
2135 kprobe_blacklist__delete(&kprobe_blacklist);
2138 static bool kprobe_blacklist__listed(unsigned long address)
2140 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2143 static int perf_probe_event__sprintf(const char *group, const char *event,
2144 struct perf_probe_event *pev,
2146 struct strbuf *result)
2152 /* Synthesize only event probe point */
2153 place = synthesize_perf_probe_point(&pev->point);
2157 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2161 strbuf_addf(result, " %-20s (on %s", buf, place);
2163 strbuf_addf(result, " in %s", module);
2165 if (pev->nargs > 0) {
2166 strbuf_addstr(result, " with");
2167 for (i = 0; i < pev->nargs; i++) {
2168 ret = synthesize_perf_probe_arg(&pev->args[i],
2172 strbuf_addf(result, " %s", buf);
2175 strbuf_addch(result, ')');
2182 int show_perf_probe_event(const char *group, const char *event,
2183 struct perf_probe_event *pev,
2184 const char *module, bool use_stdout)
2186 struct strbuf buf = STRBUF_INIT;
2189 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2192 printf("%s\n", buf.buf);
2194 pr_info("%s\n", buf.buf);
2196 strbuf_release(&buf);
2201 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2202 struct strfilter *filter)
2206 /* At first, check the event name itself */
2207 if (strfilter__compare(filter, tev->event))
2210 /* Next, check the combination of name and group */
2211 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2213 return strfilter__compare(filter, tmp);
2216 static int __show_perf_probe_events(int fd, bool is_kprobe,
2217 struct strfilter *filter)
2220 struct probe_trace_event tev;
2221 struct perf_probe_event pev;
2222 struct strlist *rawlist;
2223 struct str_node *ent;
2225 memset(&tev, 0, sizeof(tev));
2226 memset(&pev, 0, sizeof(pev));
2228 rawlist = probe_file__get_rawlist(fd);
2232 strlist__for_each(ent, rawlist) {
2233 ret = parse_probe_trace_command(ent->s, &tev);
2235 if (!filter_probe_trace_event(&tev, filter))
2237 ret = convert_to_perf_probe_event(&tev, &pev,
2241 ret = show_perf_probe_event(pev.group, pev.event,
2242 &pev, tev.point.module,
2246 clear_perf_probe_event(&pev);
2247 clear_probe_trace_event(&tev);
2251 strlist__delete(rawlist);
2252 /* Cleanup cached debuginfo if needed */
2253 debuginfo_cache__exit();
2258 /* List up current perf-probe events */
2259 int show_perf_probe_events(struct strfilter *filter)
2261 int kp_fd, up_fd, ret;
2265 ret = init_symbol_maps(false);
2269 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2274 ret = __show_perf_probe_events(kp_fd, true, filter);
2275 if (up_fd >= 0 && ret >= 0)
2276 ret = __show_perf_probe_events(up_fd, false, filter);
2286 static int get_new_event_name(char *buf, size_t len, const char *base,
2287 struct strlist *namelist, bool allow_suffix)
2296 ret = e_snprintf(buf, len, "%s", base);
2298 pr_debug("snprintf() failed: %d\n", ret);
2301 /* Cut off the postfixes (e.g. .const, .isra)*/
2302 p = strchr(buf, '.');
2305 if (!strlist__has_entry(namelist, buf))
2308 if (!allow_suffix) {
2309 pr_warning("Error: event \"%s\" already exists. "
2310 "(Use -f to force duplicates.)\n", base);
2314 /* Try to add suffix */
2315 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2316 ret = e_snprintf(buf, len, "%s_%d", base, i);
2318 pr_debug("snprintf() failed: %d\n", ret);
2321 if (!strlist__has_entry(namelist, buf))
2324 if (i == MAX_EVENT_INDEX) {
2325 pr_warning("Too many events are on the same function.\n");
2332 /* Warn if the current kernel's uprobe implementation is old */
2333 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2336 char *buf = synthesize_probe_trace_command(tev);
2338 /* Old uprobe event doesn't support memory dereference */
2339 if (!tev->uprobes || tev->nargs == 0 || !buf)
2342 for (i = 0; i < tev->nargs; i++)
2343 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2344 pr_warning("Please upgrade your kernel to at least "
2345 "3.14 to have access to feature %s\n",
2346 tev->args[i].value);
2353 /* Set new name from original perf_probe_event and namelist */
2354 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2355 struct perf_probe_event *pev,
2356 struct strlist *namelist,
2359 const char *event, *group;
2366 if (pev->point.function &&
2367 (strncmp(pev->point.function, "0x", 2) != 0) &&
2368 !strisglob(pev->point.function))
2369 event = pev->point.function;
2371 event = tev->point.realname;
2375 group = PERFPROBE_GROUP;
2377 /* Get an unused new event name */
2378 ret = get_new_event_name(buf, 64, event,
2379 namelist, allow_suffix);
2385 tev->event = strdup(event);
2386 tev->group = strdup(group);
2387 if (tev->event == NULL || tev->group == NULL)
2390 /* Add added event name to namelist */
2391 strlist__add(namelist, event);
2395 static int __add_probe_trace_events(struct perf_probe_event *pev,
2396 struct probe_trace_event *tevs,
2397 int ntevs, bool allow_suffix)
2400 struct probe_trace_event *tev = NULL;
2401 struct strlist *namelist;
2403 fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
2407 /* Get current event names */
2408 namelist = probe_file__get_namelist(fd);
2410 pr_debug("Failed to get current event list.\n");
2416 for (i = 0; i < ntevs; i++) {
2418 /* Skip if the symbol is out of .text or blacklisted */
2419 if (!tev->point.symbol)
2422 /* Set new name for tev (and update namelist) */
2423 ret = probe_trace_event__set_name(tev, pev, namelist,
2428 ret = probe_file__add_event(fd, tev);
2433 * Probes after the first probe which comes from same
2434 * user input are always allowed to add suffix, because
2435 * there might be several addresses corresponding to
2438 allow_suffix = true;
2440 if (ret == -EINVAL && pev->uprobes)
2441 warn_uprobe_event_compat(tev);
2443 strlist__delete(namelist);
2449 static int find_probe_functions(struct map *map, char *name,
2450 struct symbol **syms)
2454 struct rb_node *tmp;
2456 if (map__load(map, NULL) < 0)
2459 map__for_each_symbol(map, sym, tmp) {
2460 if (strglobmatch(sym->name, name)) {
2462 if (syms && found < probe_conf.max_probes)
2463 syms[found - 1] = sym;
2470 #define strdup_or_goto(str, label) \
2471 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2473 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2474 struct probe_trace_event *tev __maybe_unused,
2475 struct map *map __maybe_unused) { }
2478 * Find probe function addresses from map.
2479 * Return an error or the number of found probe_trace_event
2481 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2482 struct probe_trace_event **tevs)
2484 struct map *map = NULL;
2485 struct ref_reloc_sym *reloc_sym = NULL;
2487 struct symbol **syms = NULL;
2488 struct probe_trace_event *tev;
2489 struct perf_probe_point *pp = &pev->point;
2490 struct probe_trace_point *tp;
2491 int num_matched_functions;
2492 int ret, i, j, skipped = 0;
2494 map = get_target_map(pev->target, pev->uprobes);
2500 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2507 * Load matched symbols: Since the different local symbols may have
2508 * same name but different addresses, this lists all the symbols.
2510 num_matched_functions = find_probe_functions(map, pp->function, syms);
2511 if (num_matched_functions == 0) {
2512 pr_err("Failed to find symbol %s in %s\n", pp->function,
2513 pev->target ? : "kernel");
2516 } else if (num_matched_functions > probe_conf.max_probes) {
2517 pr_err("Too many functions matched in %s\n",
2518 pev->target ? : "kernel");
2523 if (!pev->uprobes && !pp->retprobe) {
2524 reloc_sym = kernel_get_ref_reloc_sym();
2526 pr_warning("Relocated base symbol is not found!\n");
2532 /* Setup result trace-probe-events */
2533 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2541 for (j = 0; j < num_matched_functions; j++) {
2544 tev = (*tevs) + ret;
2546 if (ret == num_matched_functions) {
2547 pr_warning("Too many symbols are listed. Skip it.\n");
2552 if (pp->offset > sym->end - sym->start) {
2553 pr_warning("Offset %ld is bigger than the size of %s\n",
2554 pp->offset, sym->name);
2558 /* Add one probe point */
2559 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2560 /* If we found a wrong one, mark it by NULL symbol */
2561 if (!pev->uprobes &&
2562 kprobe_warn_out_range(sym->name, tp->address)) {
2563 tp->symbol = NULL; /* Skip it */
2565 } else if (reloc_sym) {
2566 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2567 tp->offset = tp->address - reloc_sym->addr;
2569 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2570 tp->offset = pp->offset;
2572 tp->realname = strdup_or_goto(sym->name, nomem_out);
2574 tp->retprobe = pp->retprobe;
2576 tev->point.module = strdup_or_goto(pev->target,
2578 tev->uprobes = pev->uprobes;
2579 tev->nargs = pev->nargs;
2581 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2583 if (tev->args == NULL)
2586 for (i = 0; i < tev->nargs; i++) {
2587 if (pev->args[i].name)
2589 strdup_or_goto(pev->args[i].name,
2592 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2594 if (pev->args[i].type)
2596 strdup_or_goto(pev->args[i].type,
2599 arch__fix_tev_from_maps(pev, tev, map);
2601 if (ret == skipped) {
2607 put_target_map(map, pev->uprobes);
2614 clear_probe_trace_events(*tevs, num_matched_functions);
2619 static int try_to_find_absolute_address(struct perf_probe_event *pev,
2620 struct probe_trace_event **tevs)
2622 struct perf_probe_point *pp = &pev->point;
2623 struct probe_trace_event *tev;
2624 struct probe_trace_point *tp;
2627 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
2629 if (perf_probe_event_need_dwarf(pev))
2633 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
2636 * Only one tev can be generated by this.
2638 *tevs = zalloc(sizeof(*tev));
2646 * Don't use tp->offset, use address directly, because
2647 * in synthesize_probe_trace_command() address cannot be
2650 tp->address = pev->point.abs_address;
2651 tp->retprobe = pp->retprobe;
2652 tev->uprobes = pev->uprobes;
2656 * Give it a '0x' leading symbol name.
2657 * In __add_probe_trace_events, a NULL symbol is interpreted as
2660 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
2663 /* For kprobe, check range */
2664 if ((!tev->uprobes) &&
2665 (kprobe_warn_out_range(tev->point.symbol,
2666 tev->point.address))) {
2671 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
2675 tp->module = strdup(pev->target);
2681 tev->group = strdup(pev->group);
2687 tev->event = strdup(pev->event);
2692 tev->nargs = pev->nargs;
2693 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
2698 for (i = 0; i < tev->nargs; i++)
2699 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
2705 clear_probe_trace_events(*tevs, 1);
2711 bool __weak arch__prefers_symtab(void) { return false; }
2713 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2714 struct probe_trace_event **tevs)
2718 if (pev->uprobes && !pev->group) {
2719 /* Replace group name if not given */
2720 ret = convert_exec_to_group(pev->target, &pev->group);
2722 pr_warning("Failed to make a group name.\n");
2727 ret = try_to_find_absolute_address(pev, tevs);
2731 if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2732 ret = find_probe_trace_events_from_map(pev, tevs);
2734 return ret; /* Found in symbol table */
2737 /* Convert perf_probe_event with debuginfo */
2738 ret = try_to_find_probe_trace_events(pev, tevs);
2740 return ret; /* Found in debuginfo or got an error */
2742 return find_probe_trace_events_from_map(pev, tevs);
2745 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2749 ret = init_symbol_maps(pevs->uprobes);
2753 /* Loop 1: convert all events */
2754 for (i = 0; i < npevs; i++) {
2755 /* Init kprobe blacklist if needed */
2756 if (!pevs[i].uprobes)
2757 kprobe_blacklist__init();
2758 /* Convert with or without debuginfo */
2759 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
2762 pevs[i].ntevs = ret;
2764 /* This just release blacklist only if allocated */
2765 kprobe_blacklist__release();
2770 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2774 /* Loop 2: add all events */
2775 for (i = 0; i < npevs; i++) {
2776 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
2778 probe_conf.force_add);
2785 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2789 /* Loop 3: cleanup and free trace events */
2790 for (i = 0; i < npevs; i++) {
2791 for (j = 0; j < pevs[i].ntevs; j++)
2792 clear_probe_trace_event(&pevs[i].tevs[j]);
2793 zfree(&pevs[i].tevs);
2800 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2804 ret = convert_perf_probe_events(pevs, npevs);
2806 ret = apply_perf_probe_events(pevs, npevs);
2808 cleanup_perf_probe_events(pevs, npevs);
2813 int del_perf_probe_events(struct strfilter *filter)
2815 int ret, ret2, ufd = -1, kfd = -1;
2816 char *str = strfilter__string(filter);
2821 /* Get current event names */
2822 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
2826 ret = probe_file__del_events(kfd, filter);
2827 if (ret < 0 && ret != -ENOENT)
2830 ret2 = probe_file__del_events(ufd, filter);
2831 if (ret2 < 0 && ret2 != -ENOENT) {
2848 /* TODO: don't use a global variable for filter ... */
2849 static struct strfilter *available_func_filter;
2852 * If a symbol corresponds to a function with global binding and
2853 * matches filter return 0. For all others return 1.
2855 static int filter_available_functions(struct map *map __maybe_unused,
2858 if (strfilter__compare(available_func_filter, sym->name))
2863 int show_available_funcs(const char *target, struct strfilter *_filter,
2869 ret = init_symbol_maps(user);
2873 /* Get a symbol map */
2875 map = dso__new_map(target);
2877 map = kernel_get_module_map(target);
2879 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2883 /* Load symbols with given filter */
2884 available_func_filter = _filter;
2885 if (map__load(map, filter_available_functions)) {
2886 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2889 if (!dso__sorted_by_name(map->dso, map->type))
2890 dso__sort_by_name(map->dso, map->type);
2892 /* Show all (filtered) symbols */
2894 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2904 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
2905 struct perf_probe_arg *pvar)
2907 tvar->value = strdup(pvar->var);
2908 if (tvar->value == NULL)
2911 tvar->type = strdup(pvar->type);
2912 if (tvar->type == NULL)
2916 tvar->name = strdup(pvar->name);
2917 if (tvar->name == NULL)