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 int init_probe_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 void exit_probe_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 */
129 struct map *map = machine__kernel_map(host_machine);
131 if (map__load(map, NULL) < 0)
134 kmap = map__kmap(map);
137 return kmap->ref_reloc_sym;
140 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
141 bool reloc, bool reladdr)
143 struct ref_reloc_sym *reloc_sym;
147 /* ref_reloc_sym is just a label. Need a special fix*/
148 reloc_sym = kernel_get_ref_reloc_sym();
149 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
150 *addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
152 sym = __find_kernel_function_by_name(name, &map);
155 *addr = map->unmap_ip(map, sym->start) -
156 ((reloc) ? 0 : map->reloc) -
157 ((reladdr) ? map->start : 0);
162 static struct map *kernel_get_module_map(const char *module)
164 struct map_groups *grp = &host_machine->kmaps;
165 struct maps *maps = &grp->maps[MAP__FUNCTION];
168 /* A file path -- this is an offline module */
169 if (module && strchr(module, '/'))
170 return machine__findnew_module_map(host_machine, 0, module);
175 for (pos = maps__first(maps); pos; pos = map__next(pos)) {
176 if (strncmp(pos->dso->short_name + 1, module,
177 pos->dso->short_name_len - 2) == 0) {
184 static struct map *get_target_map(const char *target, bool user)
186 /* Init maps of given executable or kernel */
188 return dso__new_map(target);
190 return kernel_get_module_map(target);
193 static void put_target_map(struct map *map, bool user)
196 /* Only the user map needs to be released */
202 static int convert_exec_to_group(const char *exec, char **result)
204 char *ptr1, *ptr2, *exec_copy;
208 exec_copy = strdup(exec);
212 ptr1 = basename(exec_copy);
218 ptr2 = strpbrk(ptr1, "-._");
221 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
225 *result = strdup(buf);
226 ret = *result ? 0 : -ENOMEM;
233 static void clear_perf_probe_point(struct perf_probe_point *pp)
240 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
244 for (i = 0; i < ntevs; i++)
245 clear_probe_trace_event(tevs + i);
248 static bool kprobe_blacklist__listed(unsigned long address);
249 static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
254 /* Get the address of _etext for checking non-probable text symbol */
255 ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
258 if (ret == 0 && etext_addr < address)
259 pr_warning("%s is out of .text, skip it.\n", symbol);
260 else if (kprobe_blacklist__listed(address))
261 pr_warning("%s is blacklisted function, skip it.\n", symbol);
268 #ifdef HAVE_DWARF_SUPPORT
270 static int kernel_get_module_dso(const char *module, struct dso **pdso)
274 const char *vmlinux_name;
278 char module_name[128];
280 snprintf(module_name, sizeof(module_name), "[%s]", module);
281 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
286 pr_debug("Failed to find module %s.\n", module);
290 map = machine__kernel_map(host_machine);
293 vmlinux_name = symbol_conf.vmlinux_name;
296 ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
298 ret = dso__load_vmlinux_path(dso, map, NULL);
305 * Some binaries like glibc have special symbols which are on the symbol
306 * table, but not in the debuginfo. If we can find the address of the
307 * symbol from map, we can translate the address back to the probe point.
309 static int find_alternative_probe_point(struct debuginfo *dinfo,
310 struct perf_probe_point *pp,
311 struct perf_probe_point *result,
312 const char *target, bool uprobes)
314 struct map *map = NULL;
319 /* This can work only for function-name based one */
320 if (!pp->function || pp->file)
323 map = get_target_map(target, uprobes);
327 /* Find the address of given function */
328 map__for_each_symbol_by_name(map, pp->function, sym) {
330 address = sym->start;
332 address = map->unmap_ip(map, sym->start);
339 pr_debug("Symbol %s address found : %" PRIx64 "\n",
340 pp->function, address);
342 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
345 ret = (!ret) ? -ENOENT : ret;
347 result->offset += pp->offset;
348 result->line += pp->line;
349 result->retprobe = pp->retprobe;
354 put_target_map(map, uprobes);
359 static int get_alternative_probe_event(struct debuginfo *dinfo,
360 struct perf_probe_event *pev,
361 struct perf_probe_point *tmp)
365 memcpy(tmp, &pev->point, sizeof(*tmp));
366 memset(&pev->point, 0, sizeof(pev->point));
367 ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
368 pev->target, pev->uprobes);
370 memcpy(&pev->point, tmp, sizeof(*tmp));
375 static int get_alternative_line_range(struct debuginfo *dinfo,
376 struct line_range *lr,
377 const char *target, bool user)
379 struct perf_probe_point pp = { .function = lr->function,
382 struct perf_probe_point result;
385 memset(&result, 0, sizeof(result));
387 if (lr->end != INT_MAX)
388 len = lr->end - lr->start;
389 ret = find_alternative_probe_point(dinfo, &pp, &result,
392 lr->function = result.function;
393 lr->file = result.file;
394 lr->start = result.line;
395 if (lr->end != INT_MAX)
396 lr->end = lr->start + len;
397 clear_perf_probe_point(&pp);
402 /* Open new debuginfo of given module */
403 static struct debuginfo *open_debuginfo(const char *module, bool silent)
405 const char *path = module;
406 char reason[STRERR_BUFSIZE];
407 struct debuginfo *ret = NULL;
408 struct dso *dso = NULL;
411 if (!module || !strchr(module, '/')) {
412 err = kernel_get_module_dso(module, &dso);
414 if (!dso || dso->load_errno == 0) {
415 if (!strerror_r(-err, reason, STRERR_BUFSIZE))
416 strcpy(reason, "(unknown)");
418 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
420 pr_err("Failed to find the path for %s: %s\n",
421 module ?: "kernel", reason);
424 path = dso->long_name;
426 ret = debuginfo__new(path);
427 if (!ret && !silent) {
428 pr_warning("The %s file has no debug information.\n", path);
429 if (!module || !strtailcmp(path, ".ko"))
430 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
432 pr_warning("Rebuild with -g, ");
433 pr_warning("or install an appropriate debuginfo package.\n");
438 /* For caching the last debuginfo */
439 static struct debuginfo *debuginfo_cache;
440 static char *debuginfo_cache_path;
442 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
444 const char *path = module;
446 /* If the module is NULL, it should be the kernel. */
450 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
453 /* Copy module path */
454 free(debuginfo_cache_path);
455 debuginfo_cache_path = strdup(path);
456 if (!debuginfo_cache_path) {
457 debuginfo__delete(debuginfo_cache);
458 debuginfo_cache = NULL;
462 debuginfo_cache = open_debuginfo(module, silent);
463 if (!debuginfo_cache)
464 zfree(&debuginfo_cache_path);
466 return debuginfo_cache;
469 static void debuginfo_cache__exit(void)
471 debuginfo__delete(debuginfo_cache);
472 debuginfo_cache = NULL;
473 zfree(&debuginfo_cache_path);
477 static int get_text_start_address(const char *exec, unsigned long *address)
482 int fd, ret = -ENOENT;
484 fd = open(exec, O_RDONLY);
488 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
492 if (gelf_getehdr(elf, &ehdr) == NULL)
495 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
498 *address = shdr.sh_addr - shdr.sh_offset;
506 * Convert trace point to probe point with debuginfo
508 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
509 struct perf_probe_point *pp,
512 struct debuginfo *dinfo = NULL;
513 unsigned long stext = 0;
514 u64 addr = tp->address;
517 /* convert the address to dwarf address */
523 ret = get_text_start_address(tp->module, &stext);
527 } else if (tp->symbol) {
528 /* If the module is given, this returns relative address */
529 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
530 false, !!tp->module);
536 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
537 tp->module ? : "kernel");
539 dinfo = debuginfo_cache__open(tp->module, verbose == 0);
541 ret = debuginfo__find_probe_point(dinfo,
542 (unsigned long)addr, pp);
547 pp->retprobe = tp->retprobe;
551 pr_debug("Failed to find corresponding probes from debuginfo.\n");
552 return ret ? : -ENOENT;
555 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
556 int ntevs, const char *exec)
559 unsigned long stext = 0;
564 ret = get_text_start_address(exec, &stext);
568 for (i = 0; i < ntevs && ret >= 0; i++) {
569 /* point.address is the addres of point.symbol + point.offset */
570 tevs[i].point.address -= stext;
571 tevs[i].point.module = strdup(exec);
572 if (!tevs[i].point.module) {
576 tevs[i].uprobes = true;
582 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
583 int ntevs, const char *module)
591 tmp = strrchr(module, '/');
593 /* This is a module path -- get the module name */
594 module = strdup(tmp + 1);
597 tmp = strchr(module, '.');
600 tmp = (char *)module; /* For free() */
603 for (i = 0; i < ntevs; i++) {
604 tevs[i].point.module = strdup(module);
605 if (!tevs[i].point.module) {
615 /* Post processing the probe events */
616 static int post_process_probe_trace_events(struct probe_trace_event *tevs,
617 int ntevs, const char *module,
620 struct ref_reloc_sym *reloc_sym;
625 return add_exec_to_probe_trace_events(tevs, ntevs, module);
627 /* Note that currently ref_reloc_sym based probe is not for drivers */
629 return add_module_to_probe_trace_events(tevs, ntevs, module);
631 reloc_sym = kernel_get_ref_reloc_sym();
633 pr_warning("Relocated base symbol is not found!\n");
637 for (i = 0; i < ntevs; i++) {
638 if (!tevs[i].point.address || tevs[i].point.retprobe)
640 /* If we found a wrong one, mark it by NULL symbol */
641 if (kprobe_warn_out_range(tevs[i].point.symbol,
642 tevs[i].point.address)) {
646 tmp = strdup(reloc_sym->name);
650 /* If we have no realname, use symbol for it */
651 if (!tevs[i].point.realname)
652 tevs[i].point.realname = tevs[i].point.symbol;
654 free(tevs[i].point.symbol);
655 tevs[i].point.symbol = tmp;
656 tevs[i].point.offset = tevs[i].point.address -
657 reloc_sym->unrelocated_addr;
662 /* Try to find perf_probe_event with debuginfo */
663 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
664 struct probe_trace_event **tevs)
666 bool need_dwarf = perf_probe_event_need_dwarf(pev);
667 struct perf_probe_point tmp;
668 struct debuginfo *dinfo;
671 dinfo = open_debuginfo(pev->target, !need_dwarf);
675 pr_debug("Could not open debuginfo. Try to use symbols.\n");
679 pr_debug("Try to find probe point from debuginfo.\n");
680 /* Searching trace events corresponding to a probe event */
681 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
683 if (ntevs == 0) { /* Not found, retry with an alternative */
684 ret = get_alternative_probe_event(dinfo, pev, &tmp);
686 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
688 * Write back to the original probe_event for
689 * setting appropriate (user given) event name
691 clear_perf_probe_point(&pev->point);
692 memcpy(&pev->point, &tmp, sizeof(tmp));
696 debuginfo__delete(dinfo);
698 if (ntevs > 0) { /* Succeeded to find trace events */
699 pr_debug("Found %d probe_trace_events.\n", ntevs);
700 ret = post_process_probe_trace_events(*tevs, ntevs,
701 pev->target, pev->uprobes);
702 if (ret < 0 || ret == ntevs) {
703 clear_probe_trace_events(*tevs, ntevs);
707 return ret < 0 ? ret : ntevs;
712 if (ntevs == 0) { /* No error but failed to find probe point. */
713 pr_warning("Probe point '%s' not found.\n",
714 synthesize_perf_probe_point(&pev->point));
717 /* Error path : ntevs < 0 */
718 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
721 pr_warning("Warning: No dwarf info found in the vmlinux - "
722 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
724 pr_debug("Trying to use symbols.\n");
731 #define LINEBUF_SIZE 256
732 #define NR_ADDITIONAL_LINES 2
734 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
736 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
737 const char *color = show_num ? "" : PERF_COLOR_BLUE;
738 const char *prefix = NULL;
741 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
746 prefix = show_num ? "%7d " : " ";
747 color_fprintf(stdout, color, prefix, l);
749 color_fprintf(stdout, color, "%s", buf);
751 } while (strchr(buf, '\n') == NULL);
756 pr_warning("File read error: %s\n",
757 strerror_r(errno, sbuf, sizeof(sbuf)));
763 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
765 int rv = __show_one_line(fp, l, skip, show_num);
767 pr_warning("Source file is shorter than expected.\n");
773 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
774 #define show_one_line(f,l) _show_one_line(f,l,false,false)
775 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
776 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
779 * Show line-range always requires debuginfo to find source file and
782 static int __show_line_range(struct line_range *lr, const char *module,
787 struct debuginfo *dinfo;
791 char sbuf[STRERR_BUFSIZE];
793 /* Search a line range */
794 dinfo = open_debuginfo(module, false);
798 ret = debuginfo__find_line_range(dinfo, lr);
799 if (!ret) { /* Not found, retry with an alternative */
800 ret = get_alternative_line_range(dinfo, lr, module, user);
802 ret = debuginfo__find_line_range(dinfo, lr);
804 debuginfo__delete(dinfo);
805 if (ret == 0 || ret == -ENOENT) {
806 pr_warning("Specified source line is not found.\n");
808 } else if (ret < 0) {
809 pr_warning("Debuginfo analysis failed.\n");
813 /* Convert source file path */
815 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
817 /* Free old path when new path is assigned */
822 pr_warning("Failed to find source file path.\n");
829 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
830 lr->start - lr->offset);
832 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
834 fp = fopen(lr->path, "r");
836 pr_warning("Failed to open %s: %s\n", lr->path,
837 strerror_r(errno, sbuf, sizeof(sbuf)));
840 /* Skip to starting line number */
841 while (l < lr->start) {
842 ret = skip_one_line(fp, l++);
847 intlist__for_each(ln, lr->line_list) {
848 for (; ln->i > l; l++) {
849 ret = show_one_line(fp, l - lr->offset);
853 ret = show_one_line_with_num(fp, l++ - lr->offset);
858 if (lr->end == INT_MAX)
859 lr->end = l + NR_ADDITIONAL_LINES;
860 while (l <= lr->end) {
861 ret = show_one_line_or_eof(fp, l++ - lr->offset);
870 int show_line_range(struct line_range *lr, const char *module, bool user)
874 ret = init_probe_symbol_maps(user);
877 ret = __show_line_range(lr, module, user);
878 exit_probe_symbol_maps();
883 static int show_available_vars_at(struct debuginfo *dinfo,
884 struct perf_probe_event *pev,
885 struct strfilter *_filter)
889 struct str_node *node;
890 struct variable_list *vls = NULL, *vl;
891 struct perf_probe_point tmp;
894 buf = synthesize_perf_probe_point(&pev->point);
897 pr_debug("Searching variables at %s\n", buf);
899 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
900 if (!ret) { /* Not found, retry with an alternative */
901 ret = get_alternative_probe_event(dinfo, pev, &tmp);
903 ret = debuginfo__find_available_vars_at(dinfo, pev,
905 /* Release the old probe_point */
906 clear_perf_probe_point(&tmp);
910 if (ret == 0 || ret == -ENOENT) {
911 pr_err("Failed to find the address of %s\n", buf);
914 pr_warning("Debuginfo analysis failed.\n");
918 /* Some variables are found */
919 fprintf(stdout, "Available variables at %s\n", buf);
920 for (i = 0; i < ret; i++) {
923 * A probe point might be converted to
924 * several trace points.
926 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
928 zfree(&vl->point.symbol);
931 strlist__for_each(node, vl->vars) {
932 var = strchr(node->s, '\t') + 1;
933 if (strfilter__compare(_filter, var)) {
934 fprintf(stdout, "\t\t%s\n", node->s);
938 strlist__delete(vl->vars);
941 fprintf(stdout, "\t\t(No matched variables)\n");
949 /* Show available variables on given probe point */
950 int show_available_vars(struct perf_probe_event *pevs, int npevs,
951 struct strfilter *_filter)
954 struct debuginfo *dinfo;
956 ret = init_probe_symbol_maps(pevs->uprobes);
960 dinfo = open_debuginfo(pevs->target, false);
968 for (i = 0; i < npevs && ret >= 0; i++)
969 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
971 debuginfo__delete(dinfo);
973 exit_probe_symbol_maps();
977 #else /* !HAVE_DWARF_SUPPORT */
979 static void debuginfo_cache__exit(void)
984 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
985 struct perf_probe_point *pp __maybe_unused,
986 bool is_kprobe __maybe_unused)
991 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
992 struct probe_trace_event **tevs __maybe_unused)
994 if (perf_probe_event_need_dwarf(pev)) {
995 pr_warning("Debuginfo-analysis is not supported.\n");
1002 int show_line_range(struct line_range *lr __maybe_unused,
1003 const char *module __maybe_unused,
1004 bool user __maybe_unused)
1006 pr_warning("Debuginfo-analysis is not supported.\n");
1010 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1011 int npevs __maybe_unused,
1012 struct strfilter *filter __maybe_unused)
1014 pr_warning("Debuginfo-analysis is not supported.\n");
1019 void line_range__clear(struct line_range *lr)
1025 intlist__delete(lr->line_list);
1026 memset(lr, 0, sizeof(*lr));
1029 int line_range__init(struct line_range *lr)
1031 memset(lr, 0, sizeof(*lr));
1032 lr->line_list = intlist__new(NULL);
1039 static int parse_line_num(char **ptr, int *val, const char *what)
1041 const char *start = *ptr;
1044 *val = strtol(*ptr, ptr, 0);
1045 if (errno || *ptr == start) {
1046 semantic_error("'%s' is not a valid number.\n", what);
1052 /* Check the name is good for event, group or function */
1053 static bool is_c_func_name(const char *name)
1055 if (!isalpha(*name) && *name != '_')
1057 while (*++name != '\0') {
1058 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1065 * Stuff 'lr' according to the line range described by 'arg'.
1066 * The line range syntax is described by:
1068 * SRC[:SLN[+NUM|-ELN]]
1069 * FNC[@SRC][:SLN[+NUM|-ELN]]
1071 int parse_line_range_desc(const char *arg, struct line_range *lr)
1073 char *range, *file, *name = strdup(arg);
1082 range = strchr(name, ':');
1086 err = parse_line_num(&range, &lr->start, "start line");
1090 if (*range == '+' || *range == '-') {
1091 const char c = *range++;
1093 err = parse_line_num(&range, &lr->end, "end line");
1098 lr->end += lr->start;
1100 * Adjust the number of lines here.
1101 * If the number of lines == 1, the
1102 * the end of line should be equal to
1103 * the start of line.
1109 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1112 if (lr->start > lr->end) {
1113 semantic_error("Start line must be smaller"
1114 " than end line.\n");
1117 if (*range != '\0') {
1118 semantic_error("Tailing with invalid str '%s'.\n", range);
1123 file = strchr(name, '@');
1126 lr->file = strdup(++file);
1127 if (lr->file == NULL) {
1131 lr->function = name;
1132 } else if (strchr(name, '/') || strchr(name, '.'))
1134 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1135 lr->function = name;
1136 else { /* Invalid name */
1137 semantic_error("'%s' is not a valid function name.\n", name);
1148 /* Parse probepoint definition. */
1149 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1151 struct perf_probe_point *pp = &pev->point;
1154 bool file_spec = false;
1157 * perf probe [EVENT=]SRC[:LN|;PTN]
1158 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1160 * TODO:Group name support
1165 ptr = strpbrk(arg, ";=@+%");
1166 if (ptr && *ptr == '=') { /* Event name */
1169 if (strchr(arg, ':')) {
1170 semantic_error("Group name is not supported yet.\n");
1173 if (!is_c_func_name(arg)) {
1174 semantic_error("%s is bad for event name -it must "
1175 "follow C symbol-naming rule.\n", arg);
1178 pev->event = strdup(arg);
1179 if (pev->event == NULL)
1186 * Check arg is function or file name and copy it.
1188 * We consider arg to be a file spec if and only if it satisfies
1189 * all of the below criteria::
1190 * - it does not include any of "+@%",
1191 * - it includes one of ":;", and
1192 * - it has a period '.' in the name.
1194 * Otherwise, we consider arg to be a function specification.
1196 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
1197 /* This is a file spec if it includes a '.' before ; or : */
1198 if (memchr(arg, '.', ptr - arg))
1202 ptr = strpbrk(arg, ";:+@%");
1222 * Keep pp->function even if this is absolute address,
1223 * so it can mark whether abs_address is valid.
1224 * Which make 'perf probe lib.bin 0x0' possible.
1226 * Note that checking length of tmp is not needed
1227 * because when we access tmp[1] we know tmp[0] is '0',
1228 * so tmp[1] should always valid (but could be '\0').
1230 if (tmp && !strncmp(tmp, "0x", 2)) {
1231 pp->abs_address = strtoul(pp->function, &tmp, 0);
1233 semantic_error("Invalid absolute address.\n");
1239 /* Parse other options */
1243 if (c == ';') { /* Lazy pattern must be the last part */
1244 pp->lazy_line = strdup(arg);
1245 if (pp->lazy_line == NULL)
1249 ptr = strpbrk(arg, ";:+@%");
1255 case ':': /* Line number */
1256 pp->line = strtoul(arg, &tmp, 0);
1258 semantic_error("There is non-digit char"
1259 " in line number.\n");
1263 case '+': /* Byte offset from a symbol */
1264 pp->offset = strtoul(arg, &tmp, 0);
1266 semantic_error("There is non-digit character"
1271 case '@': /* File name */
1273 semantic_error("SRC@SRC is not allowed.\n");
1276 pp->file = strdup(arg);
1277 if (pp->file == NULL)
1280 case '%': /* Probe places */
1281 if (strcmp(arg, "return") == 0) {
1283 } else { /* Others not supported yet */
1284 semantic_error("%%%s is not supported.\n", arg);
1288 default: /* Buggy case */
1289 pr_err("This program has a bug at %s:%d.\n",
1290 __FILE__, __LINE__);
1296 /* Exclusion check */
1297 if (pp->lazy_line && pp->line) {
1298 semantic_error("Lazy pattern can't be used with"
1303 if (pp->lazy_line && pp->offset) {
1304 semantic_error("Lazy pattern can't be used with offset.\n");
1308 if (pp->line && pp->offset) {
1309 semantic_error("Offset can't be used with line number.\n");
1313 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1314 semantic_error("File always requires line number or "
1319 if (pp->offset && !pp->function) {
1320 semantic_error("Offset requires an entry function.\n");
1324 if (pp->retprobe && !pp->function) {
1325 semantic_error("Return probe requires an entry function.\n");
1329 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1330 semantic_error("Offset/Line/Lazy pattern can't be used with "
1335 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1336 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1341 /* Parse perf-probe event argument */
1342 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1344 char *tmp, *goodname;
1345 struct perf_probe_arg_field **fieldp;
1347 pr_debug("parsing arg: %s into ", str);
1349 tmp = strchr(str, '=');
1351 arg->name = strndup(str, tmp - str);
1352 if (arg->name == NULL)
1354 pr_debug("name:%s ", arg->name);
1358 tmp = strchr(str, ':');
1359 if (tmp) { /* Type setting */
1361 arg->type = strdup(tmp + 1);
1362 if (arg->type == NULL)
1364 pr_debug("type:%s ", arg->type);
1367 tmp = strpbrk(str, "-.[");
1368 if (!is_c_varname(str) || !tmp) {
1369 /* A variable, register, symbol or special value */
1370 arg->var = strdup(str);
1371 if (arg->var == NULL)
1373 pr_debug("%s\n", arg->var);
1377 /* Structure fields or array element */
1378 arg->var = strndup(str, tmp - str);
1379 if (arg->var == NULL)
1381 goodname = arg->var;
1382 pr_debug("%s, ", arg->var);
1383 fieldp = &arg->field;
1386 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1387 if (*fieldp == NULL)
1389 if (*tmp == '[') { /* Array */
1391 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1392 (*fieldp)->ref = true;
1393 if (*tmp != ']' || tmp == str + 1) {
1394 semantic_error("Array index must be a"
1401 } else { /* Structure */
1404 (*fieldp)->ref = false;
1405 } else if (tmp[1] == '>') {
1407 (*fieldp)->ref = true;
1409 semantic_error("Argument parse error: %s\n",
1413 tmp = strpbrk(str, "-.[");
1416 (*fieldp)->name = strndup(str, tmp - str);
1417 if ((*fieldp)->name == NULL)
1420 goodname = (*fieldp)->name;
1421 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1422 fieldp = &(*fieldp)->next;
1425 (*fieldp)->name = strdup(str);
1426 if ((*fieldp)->name == NULL)
1429 goodname = (*fieldp)->name;
1430 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1432 /* If no name is specified, set the last field name (not array index)*/
1434 arg->name = strdup(goodname);
1435 if (arg->name == NULL)
1441 /* Parse perf-probe event command */
1442 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1445 int argc, i, ret = 0;
1447 argv = argv_split(cmd, &argc);
1449 pr_debug("Failed to split arguments.\n");
1452 if (argc - 1 > MAX_PROBE_ARGS) {
1453 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1457 /* Parse probe point */
1458 ret = parse_perf_probe_point(argv[0], pev);
1462 /* Copy arguments and ensure return probe has no C argument */
1463 pev->nargs = argc - 1;
1464 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1465 if (pev->args == NULL) {
1469 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1470 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1472 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1473 semantic_error("You can't specify local variable for"
1484 /* Return true if this perf_probe_event requires debuginfo */
1485 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1489 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1492 for (i = 0; i < pev->nargs; i++)
1493 if (is_c_varname(pev->args[i].var))
1499 /* Parse probe_events event into struct probe_point */
1500 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1502 struct probe_trace_point *tp = &tev->point;
1505 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1509 pr_debug("Parsing probe_events: %s\n", cmd);
1510 argv = argv_split(cmd, &argc);
1512 pr_debug("Failed to split arguments.\n");
1516 semantic_error("Too few probe arguments.\n");
1521 /* Scan event and group name. */
1522 argv0_str = strdup(argv[0]);
1523 if (argv0_str == NULL) {
1527 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1528 fmt2_str = strtok_r(NULL, "/", &fmt);
1529 fmt3_str = strtok_r(NULL, " \t", &fmt);
1530 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1531 || fmt3_str == NULL) {
1532 semantic_error("Failed to parse event name: %s\n", argv[0]);
1537 tev->group = strdup(fmt2_str);
1538 tev->event = strdup(fmt3_str);
1539 if (tev->group == NULL || tev->event == NULL) {
1543 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1545 tp->retprobe = (pr == 'r');
1547 /* Scan module name(if there), function name and offset */
1548 p = strchr(argv[1], ':');
1550 tp->module = strndup(argv[1], p - argv[1]);
1554 fmt1_str = strtok_r(p, "+", &fmt);
1555 /* only the address started with 0x */
1556 if (fmt1_str[0] == '0') {
1558 * Fix a special case:
1559 * if address == 0, kernel reports something like:
1560 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1561 * Newer kernel may fix that, but we want to
1562 * support old kernel also.
1564 if (strcmp(fmt1_str, "0x") == 0) {
1565 if (!argv[2] || strcmp(argv[2], "(null)")) {
1572 for (i = 2; argv[i + 1] != NULL; i++)
1573 argv[i] = argv[i + 1];
1578 tp->address = strtoul(fmt1_str, NULL, 0);
1580 /* Only the symbol-based probe has offset */
1581 tp->symbol = strdup(fmt1_str);
1582 if (tp->symbol == NULL) {
1586 fmt2_str = strtok_r(NULL, "", &fmt);
1587 if (fmt2_str == NULL)
1590 tp->offset = strtoul(fmt2_str, NULL, 10);
1593 tev->nargs = argc - 2;
1594 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1595 if (tev->args == NULL) {
1599 for (i = 0; i < tev->nargs; i++) {
1600 p = strchr(argv[i + 2], '=');
1601 if (p) /* We don't need which register is assigned. */
1605 tev->args[i].name = strdup(argv[i + 2]);
1606 /* TODO: parse regs and offset */
1607 tev->args[i].value = strdup(p);
1608 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1620 /* Compose only probe arg */
1621 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1623 struct perf_probe_arg_field *field = pa->field;
1627 if (pa->name && pa->var)
1628 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1630 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1637 if (field->name[0] == '[')
1638 ret = e_snprintf(tmp, len, "%s", field->name);
1640 ret = e_snprintf(tmp, len, "%s%s",
1641 field->ref ? "->" : ".", field->name);
1646 field = field->next;
1650 ret = e_snprintf(tmp, len, ":%s", pa->type);
1659 pr_debug("Failed to synthesize perf probe argument: %d\n", ret);
1663 /* Compose only probe point (not argument) */
1664 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1667 char offs[32] = "", line[32] = "", file[32] = "";
1670 buf = zalloc(MAX_CMDLEN);
1676 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1681 ret = e_snprintf(line, 32, ":%d", pp->line);
1689 tmp = strchr(pp->file + len - 30, '/');
1690 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1692 ret = e_snprintf(file, 32, "@%s", tmp);
1698 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1699 offs, pp->retprobe ? "%return" : "", line,
1702 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1708 pr_debug("Failed to synthesize perf probe point: %d\n", ret);
1714 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1719 buf = synthesize_perf_probe_point(&pev->point);
1724 for (i = 0; i < pev->nargs; i++) {
1725 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1738 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1739 char **buf, size_t *buflen,
1744 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1750 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1762 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1763 char *buf, size_t buflen)
1765 struct probe_trace_arg_ref *ref = arg->ref;
1769 /* Argument name or separator */
1771 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1773 ret = e_snprintf(buf, buflen, " ");
1779 /* Special case: @XXX */
1780 if (arg->value[0] == '@' && arg->ref)
1783 /* Dereferencing arguments */
1785 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1791 /* Print argument value */
1792 if (arg->value[0] == '@' && arg->ref)
1793 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1796 ret = e_snprintf(buf, buflen, "%s", arg->value);
1804 ret = e_snprintf(buf, buflen, ")");
1810 /* Print argument type */
1812 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1821 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1823 struct probe_trace_point *tp = &tev->point;
1827 buf = zalloc(MAX_CMDLEN);
1831 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1832 tev->group, tev->event);
1836 /* Uprobes must have tp->module */
1837 if (tev->uprobes && !tp->module)
1840 * If tp->address == 0, then this point must be a
1841 * absolute address uprobe.
1842 * try_to_find_absolute_address() should have made
1843 * tp->symbol to "0x0".
1845 if (tev->uprobes && !tp->address) {
1846 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
1850 /* Use the tp->address for uprobes */
1852 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s:0x%lx",
1853 tp->module, tp->address);
1854 else if (!strncmp(tp->symbol, "0x", 2))
1855 /* Absolute address. See try_to_find_absolute_address() */
1856 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s0x%lx",
1857 tp->module ?: "", tp->module ? ":" : "",
1860 ret = e_snprintf(buf + len, MAX_CMDLEN - len, "%s%s%s+%lu",
1861 tp->module ?: "", tp->module ? ":" : "",
1862 tp->symbol, tp->offset);
1868 for (i = 0; i < tev->nargs; i++) {
1869 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1882 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1883 struct perf_probe_point *pp,
1886 struct symbol *sym = NULL;
1888 u64 addr = tp->address;
1892 map = dso__new_map(tp->module);
1895 sym = map__find_symbol(map, addr, NULL);
1897 if (tp->symbol && !addr) {
1898 if (kernel_get_symbol_address_by_name(tp->symbol,
1899 &addr, true, false) < 0)
1904 sym = __find_kernel_function(addr, &map);
1911 pp->retprobe = tp->retprobe;
1912 pp->offset = addr - map->unmap_ip(map, sym->start);
1913 pp->function = strdup(sym->name);
1914 ret = pp->function ? 0 : -ENOMEM;
1917 if (map && !is_kprobe) {
1924 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1925 struct perf_probe_point *pp,
1931 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1934 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1938 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1941 pp->function = strdup(tp->symbol);
1942 pp->offset = tp->offset;
1944 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1947 pp->function = strdup(buf);
1950 if (pp->function == NULL)
1953 pp->retprobe = tp->retprobe;
1958 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1959 struct perf_probe_event *pev, bool is_kprobe)
1964 /* Convert event/group name */
1965 pev->event = strdup(tev->event);
1966 pev->group = strdup(tev->group);
1967 if (pev->event == NULL || pev->group == NULL)
1970 /* Convert trace_point to probe_point */
1971 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1975 /* Convert trace_arg to probe_arg */
1976 pev->nargs = tev->nargs;
1977 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1978 if (pev->args == NULL)
1980 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1981 if (tev->args[i].name)
1982 pev->args[i].name = strdup(tev->args[i].name);
1984 ret = synthesize_probe_trace_arg(&tev->args[i],
1986 pev->args[i].name = strdup(buf);
1988 if (pev->args[i].name == NULL && ret >= 0)
1993 clear_perf_probe_event(pev);
1998 void clear_perf_probe_event(struct perf_probe_event *pev)
2000 struct perf_probe_arg_field *field, *next;
2006 clear_perf_probe_point(&pev->point);
2008 for (i = 0; i < pev->nargs; i++) {
2009 free(pev->args[i].name);
2010 free(pev->args[i].var);
2011 free(pev->args[i].type);
2012 field = pev->args[i].field;
2015 zfree(&field->name);
2021 memset(pev, 0, sizeof(*pev));
2024 void clear_probe_trace_event(struct probe_trace_event *tev)
2026 struct probe_trace_arg_ref *ref, *next;
2031 free(tev->point.symbol);
2032 free(tev->point.realname);
2033 free(tev->point.module);
2034 for (i = 0; i < tev->nargs; i++) {
2035 free(tev->args[i].name);
2036 free(tev->args[i].value);
2037 free(tev->args[i].type);
2038 ref = tev->args[i].ref;
2046 memset(tev, 0, sizeof(*tev));
2049 struct kprobe_blacklist_node {
2050 struct list_head list;
2051 unsigned long start;
2056 static void kprobe_blacklist__delete(struct list_head *blacklist)
2058 struct kprobe_blacklist_node *node;
2060 while (!list_empty(blacklist)) {
2061 node = list_first_entry(blacklist,
2062 struct kprobe_blacklist_node, list);
2063 list_del(&node->list);
2069 static int kprobe_blacklist__load(struct list_head *blacklist)
2071 struct kprobe_blacklist_node *node;
2072 const char *__debugfs = debugfs__mountpoint();
2073 char buf[PATH_MAX], *p;
2077 if (__debugfs == NULL)
2080 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2084 fp = fopen(buf, "r");
2089 while (fgets(buf, PATH_MAX, fp)) {
2090 node = zalloc(sizeof(*node));
2095 INIT_LIST_HEAD(&node->list);
2096 list_add_tail(&node->list, blacklist);
2097 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2101 p = strchr(buf, '\t');
2104 if (p[strlen(p) - 1] == '\n')
2105 p[strlen(p) - 1] = '\0';
2107 p = (char *)"unknown";
2108 node->symbol = strdup(p);
2109 if (!node->symbol) {
2113 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2114 node->start, node->end, node->symbol);
2118 kprobe_blacklist__delete(blacklist);
2124 static struct kprobe_blacklist_node *
2125 kprobe_blacklist__find_by_address(struct list_head *blacklist,
2126 unsigned long address)
2128 struct kprobe_blacklist_node *node;
2130 list_for_each_entry(node, blacklist, list) {
2131 if (node->start <= address && address <= node->end)
2138 static LIST_HEAD(kprobe_blacklist);
2140 static void kprobe_blacklist__init(void)
2142 if (!list_empty(&kprobe_blacklist))
2145 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2146 pr_debug("No kprobe blacklist support, ignored\n");
2149 static void kprobe_blacklist__release(void)
2151 kprobe_blacklist__delete(&kprobe_blacklist);
2154 static bool kprobe_blacklist__listed(unsigned long address)
2156 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2159 static int perf_probe_event__sprintf(const char *group, const char *event,
2160 struct perf_probe_event *pev,
2162 struct strbuf *result)
2168 /* Synthesize only event probe point */
2169 place = synthesize_perf_probe_point(&pev->point);
2173 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2177 strbuf_addf(result, " %-20s (on %s", buf, place);
2179 strbuf_addf(result, " in %s", module);
2181 if (pev->nargs > 0) {
2182 strbuf_addstr(result, " with");
2183 for (i = 0; i < pev->nargs; i++) {
2184 ret = synthesize_perf_probe_arg(&pev->args[i],
2188 strbuf_addf(result, " %s", buf);
2191 strbuf_addch(result, ')');
2198 int show_perf_probe_event(const char *group, const char *event,
2199 struct perf_probe_event *pev,
2200 const char *module, bool use_stdout)
2202 struct strbuf buf = STRBUF_INIT;
2205 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2208 printf("%s\n", buf.buf);
2210 pr_info("%s\n", buf.buf);
2212 strbuf_release(&buf);
2217 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2218 struct strfilter *filter)
2222 /* At first, check the event name itself */
2223 if (strfilter__compare(filter, tev->event))
2226 /* Next, check the combination of name and group */
2227 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2229 return strfilter__compare(filter, tmp);
2232 static int __show_perf_probe_events(int fd, bool is_kprobe,
2233 struct strfilter *filter)
2236 struct probe_trace_event tev;
2237 struct perf_probe_event pev;
2238 struct strlist *rawlist;
2239 struct str_node *ent;
2241 memset(&tev, 0, sizeof(tev));
2242 memset(&pev, 0, sizeof(pev));
2244 rawlist = probe_file__get_rawlist(fd);
2248 strlist__for_each(ent, rawlist) {
2249 ret = parse_probe_trace_command(ent->s, &tev);
2251 if (!filter_probe_trace_event(&tev, filter))
2253 ret = convert_to_perf_probe_event(&tev, &pev,
2257 ret = show_perf_probe_event(pev.group, pev.event,
2258 &pev, tev.point.module,
2262 clear_perf_probe_event(&pev);
2263 clear_probe_trace_event(&tev);
2267 strlist__delete(rawlist);
2268 /* Cleanup cached debuginfo if needed */
2269 debuginfo_cache__exit();
2274 /* List up current perf-probe events */
2275 int show_perf_probe_events(struct strfilter *filter)
2277 int kp_fd, up_fd, ret;
2281 ret = init_probe_symbol_maps(false);
2285 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2290 ret = __show_perf_probe_events(kp_fd, true, filter);
2291 if (up_fd >= 0 && ret >= 0)
2292 ret = __show_perf_probe_events(up_fd, false, filter);
2297 exit_probe_symbol_maps();
2302 static int get_new_event_name(char *buf, size_t len, const char *base,
2303 struct strlist *namelist, bool allow_suffix)
2310 nbase = strdup(base);
2314 /* Cut off the dot suffixes (e.g. .const, .isra)*/
2315 p = strchr(nbase, '.');
2316 if (p && p != nbase)
2319 /* Try no suffix number */
2320 ret = e_snprintf(buf, len, "%s", nbase);
2322 pr_debug("snprintf() failed: %d\n", ret);
2325 if (!strlist__has_entry(namelist, buf))
2328 if (!allow_suffix) {
2329 pr_warning("Error: event \"%s\" already exists. "
2330 "(Use -f to force duplicates.)\n", buf);
2335 /* Try to add suffix */
2336 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2337 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2339 pr_debug("snprintf() failed: %d\n", ret);
2342 if (!strlist__has_entry(namelist, buf))
2345 if (i == MAX_EVENT_INDEX) {
2346 pr_warning("Too many events are on the same function.\n");
2353 /* Final validation */
2354 if (ret >= 0 && !is_c_func_name(buf)) {
2355 pr_warning("Internal error: \"%s\" is an invalid event name.\n",
2363 /* Warn if the current kernel's uprobe implementation is old */
2364 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2367 char *buf = synthesize_probe_trace_command(tev);
2369 /* Old uprobe event doesn't support memory dereference */
2370 if (!tev->uprobes || tev->nargs == 0 || !buf)
2373 for (i = 0; i < tev->nargs; i++)
2374 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2375 pr_warning("Please upgrade your kernel to at least "
2376 "3.14 to have access to feature %s\n",
2377 tev->args[i].value);
2384 /* Set new name from original perf_probe_event and namelist */
2385 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2386 struct perf_probe_event *pev,
2387 struct strlist *namelist,
2390 const char *event, *group;
2397 if (pev->point.function &&
2398 (strncmp(pev->point.function, "0x", 2) != 0) &&
2399 !strisglob(pev->point.function))
2400 event = pev->point.function;
2402 event = tev->point.realname;
2406 group = PERFPROBE_GROUP;
2408 /* Get an unused new event name */
2409 ret = get_new_event_name(buf, 64, event,
2410 namelist, allow_suffix);
2416 tev->event = strdup(event);
2417 tev->group = strdup(group);
2418 if (tev->event == NULL || tev->group == NULL)
2421 /* Add added event name to namelist */
2422 strlist__add(namelist, event);
2426 static int __add_probe_trace_events(struct perf_probe_event *pev,
2427 struct probe_trace_event *tevs,
2428 int ntevs, bool allow_suffix)
2431 struct probe_trace_event *tev = NULL;
2432 struct strlist *namelist;
2434 fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
2438 /* Get current event names */
2439 namelist = probe_file__get_namelist(fd);
2441 pr_debug("Failed to get current event list.\n");
2447 for (i = 0; i < ntevs; i++) {
2449 /* Skip if the symbol is out of .text or blacklisted */
2450 if (!tev->point.symbol)
2453 /* Set new name for tev (and update namelist) */
2454 ret = probe_trace_event__set_name(tev, pev, namelist,
2459 ret = probe_file__add_event(fd, tev);
2464 * Probes after the first probe which comes from same
2465 * user input are always allowed to add suffix, because
2466 * there might be several addresses corresponding to
2469 allow_suffix = true;
2471 if (ret == -EINVAL && pev->uprobes)
2472 warn_uprobe_event_compat(tev);
2474 strlist__delete(namelist);
2480 static int find_probe_functions(struct map *map, char *name,
2481 struct symbol **syms)
2485 struct rb_node *tmp;
2487 if (map__load(map, NULL) < 0)
2490 map__for_each_symbol(map, sym, tmp) {
2491 if (strglobmatch(sym->name, name)) {
2493 if (syms && found < probe_conf.max_probes)
2494 syms[found - 1] = sym;
2501 #define strdup_or_goto(str, label) \
2502 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2504 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2505 struct probe_trace_event *tev __maybe_unused,
2506 struct map *map __maybe_unused) { }
2509 * Find probe function addresses from map.
2510 * Return an error or the number of found probe_trace_event
2512 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2513 struct probe_trace_event **tevs)
2515 struct map *map = NULL;
2516 struct ref_reloc_sym *reloc_sym = NULL;
2518 struct symbol **syms = NULL;
2519 struct probe_trace_event *tev;
2520 struct perf_probe_point *pp = &pev->point;
2521 struct probe_trace_point *tp;
2522 int num_matched_functions;
2523 int ret, i, j, skipped = 0;
2525 map = get_target_map(pev->target, pev->uprobes);
2531 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2538 * Load matched symbols: Since the different local symbols may have
2539 * same name but different addresses, this lists all the symbols.
2541 num_matched_functions = find_probe_functions(map, pp->function, syms);
2542 if (num_matched_functions == 0) {
2543 pr_err("Failed to find symbol %s in %s\n", pp->function,
2544 pev->target ? : "kernel");
2547 } else if (num_matched_functions > probe_conf.max_probes) {
2548 pr_err("Too many functions matched in %s\n",
2549 pev->target ? : "kernel");
2554 /* Note that the symbols in the kmodule are not relocated */
2555 if (!pev->uprobes && !pp->retprobe && !pev->target) {
2556 reloc_sym = kernel_get_ref_reloc_sym();
2558 pr_warning("Relocated base symbol is not found!\n");
2564 /* Setup result trace-probe-events */
2565 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2573 for (j = 0; j < num_matched_functions; j++) {
2576 tev = (*tevs) + ret;
2578 if (ret == num_matched_functions) {
2579 pr_warning("Too many symbols are listed. Skip it.\n");
2584 if (pp->offset > sym->end - sym->start) {
2585 pr_warning("Offset %ld is bigger than the size of %s\n",
2586 pp->offset, sym->name);
2590 /* Add one probe point */
2591 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2593 /* Check the kprobe (not in module) is within .text */
2594 if (!pev->uprobes && !pev->target &&
2595 kprobe_warn_out_range(sym->name, tp->address)) {
2596 tp->symbol = NULL; /* Skip it */
2598 } else if (reloc_sym) {
2599 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2600 tp->offset = tp->address - reloc_sym->addr;
2602 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2603 tp->offset = pp->offset;
2605 tp->realname = strdup_or_goto(sym->name, nomem_out);
2607 tp->retprobe = pp->retprobe;
2609 tev->point.module = strdup_or_goto(pev->target,
2611 tev->uprobes = pev->uprobes;
2612 tev->nargs = pev->nargs;
2614 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2616 if (tev->args == NULL)
2619 for (i = 0; i < tev->nargs; i++) {
2620 if (pev->args[i].name)
2622 strdup_or_goto(pev->args[i].name,
2625 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2627 if (pev->args[i].type)
2629 strdup_or_goto(pev->args[i].type,
2632 arch__fix_tev_from_maps(pev, tev, map);
2634 if (ret == skipped) {
2640 put_target_map(map, pev->uprobes);
2647 clear_probe_trace_events(*tevs, num_matched_functions);
2652 static int try_to_find_absolute_address(struct perf_probe_event *pev,
2653 struct probe_trace_event **tevs)
2655 struct perf_probe_point *pp = &pev->point;
2656 struct probe_trace_event *tev;
2657 struct probe_trace_point *tp;
2660 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
2662 if (perf_probe_event_need_dwarf(pev))
2666 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
2669 * Only one tev can be generated by this.
2671 *tevs = zalloc(sizeof(*tev));
2679 * Don't use tp->offset, use address directly, because
2680 * in synthesize_probe_trace_command() address cannot be
2683 tp->address = pev->point.abs_address;
2684 tp->retprobe = pp->retprobe;
2685 tev->uprobes = pev->uprobes;
2689 * Give it a '0x' leading symbol name.
2690 * In __add_probe_trace_events, a NULL symbol is interpreted as
2693 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
2696 /* For kprobe, check range */
2697 if ((!tev->uprobes) &&
2698 (kprobe_warn_out_range(tev->point.symbol,
2699 tev->point.address))) {
2704 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
2708 tp->module = strdup(pev->target);
2714 tev->group = strdup(pev->group);
2720 tev->event = strdup(pev->event);
2725 tev->nargs = pev->nargs;
2726 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
2731 for (i = 0; i < tev->nargs; i++)
2732 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
2738 clear_probe_trace_events(*tevs, 1);
2744 bool __weak arch__prefers_symtab(void) { return false; }
2746 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2747 struct probe_trace_event **tevs)
2751 if (pev->uprobes && !pev->group) {
2752 /* Replace group name if not given */
2753 ret = convert_exec_to_group(pev->target, &pev->group);
2755 pr_warning("Failed to make a group name.\n");
2760 ret = try_to_find_absolute_address(pev, tevs);
2764 if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2765 ret = find_probe_trace_events_from_map(pev, tevs);
2767 return ret; /* Found in symbol table */
2770 /* Convert perf_probe_event with debuginfo */
2771 ret = try_to_find_probe_trace_events(pev, tevs);
2773 return ret; /* Found in debuginfo or got an error */
2775 return find_probe_trace_events_from_map(pev, tevs);
2778 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2782 /* Loop 1: convert all events */
2783 for (i = 0; i < npevs; i++) {
2784 /* Init kprobe blacklist if needed */
2785 if (!pevs[i].uprobes)
2786 kprobe_blacklist__init();
2787 /* Convert with or without debuginfo */
2788 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
2791 pevs[i].ntevs = ret;
2793 /* This just release blacklist only if allocated */
2794 kprobe_blacklist__release();
2799 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2803 /* Loop 2: add all events */
2804 for (i = 0; i < npevs; i++) {
2805 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
2807 probe_conf.force_add);
2814 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2818 /* Loop 3: cleanup and free trace events */
2819 for (i = 0; i < npevs; i++) {
2820 for (j = 0; j < pevs[i].ntevs; j++)
2821 clear_probe_trace_event(&pevs[i].tevs[j]);
2822 zfree(&pevs[i].tevs);
2824 clear_perf_probe_event(&pevs[i]);
2828 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2832 ret = init_probe_symbol_maps(pevs->uprobes);
2836 ret = convert_perf_probe_events(pevs, npevs);
2838 ret = apply_perf_probe_events(pevs, npevs);
2840 cleanup_perf_probe_events(pevs, npevs);
2842 exit_probe_symbol_maps();
2846 int del_perf_probe_events(struct strfilter *filter)
2848 int ret, ret2, ufd = -1, kfd = -1;
2849 char *str = strfilter__string(filter);
2854 /* Get current event names */
2855 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
2859 ret = probe_file__del_events(kfd, filter);
2860 if (ret < 0 && ret != -ENOENT)
2863 ret2 = probe_file__del_events(ufd, filter);
2864 if (ret2 < 0 && ret2 != -ENOENT) {
2881 /* TODO: don't use a global variable for filter ... */
2882 static struct strfilter *available_func_filter;
2885 * If a symbol corresponds to a function with global binding and
2886 * matches filter return 0. For all others return 1.
2888 static int filter_available_functions(struct map *map __maybe_unused,
2891 if (strfilter__compare(available_func_filter, sym->name))
2896 int show_available_funcs(const char *target, struct strfilter *_filter,
2902 ret = init_probe_symbol_maps(user);
2906 /* Get a symbol map */
2908 map = dso__new_map(target);
2910 map = kernel_get_module_map(target);
2912 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2916 /* Load symbols with given filter */
2917 available_func_filter = _filter;
2918 if (map__load(map, filter_available_functions)) {
2919 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2922 if (!dso__sorted_by_name(map->dso, map->type))
2923 dso__sort_by_name(map->dso, map->type);
2925 /* Show all (filtered) symbols */
2927 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2932 exit_probe_symbol_maps();
2937 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
2938 struct perf_probe_arg *pvar)
2940 tvar->value = strdup(pvar->var);
2941 if (tvar->value == NULL)
2944 tvar->type = strdup(pvar->type);
2945 if (tvar->type == NULL)
2949 tvar->name = strdup(pvar->name);
2950 if (tvar->name == NULL)