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);
270 * '.gnu.linkonce.this_module' section of kernel module elf directly
271 * maps to 'struct module' from linux/module.h. This section contains
272 * actual module name which will be used by kernel after loading it.
273 * But, we cannot use 'struct module' here since linux/module.h is not
274 * exposed to user-space. Offset of 'name' has remained same from long
275 * time, so hardcoding it here.
278 #define MOD_NAME_OFFSET 24
280 #define MOD_NAME_OFFSET 12
284 * @module can be module name of module file path. In case of path,
285 * inspect elf and find out what is actual module name.
286 * Caller has to free mod_name after using it.
288 static char *find_module_name(const char *module)
296 char *mod_name = NULL;
298 fd = open(module, O_RDONLY);
302 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
306 if (gelf_getehdr(elf, &ehdr) == NULL)
309 sec = elf_section_by_name(elf, &ehdr, &shdr,
310 ".gnu.linkonce.this_module", NULL);
314 data = elf_getdata(sec, NULL);
315 if (!data || !data->d_buf)
318 mod_name = strdup((char *)data->d_buf + MOD_NAME_OFFSET);
327 #ifdef HAVE_DWARF_SUPPORT
329 static int kernel_get_module_dso(const char *module, struct dso **pdso)
333 const char *vmlinux_name;
337 char module_name[128];
339 snprintf(module_name, sizeof(module_name), "[%s]", module);
340 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
345 pr_debug("Failed to find module %s.\n", module);
349 map = machine__kernel_map(host_machine);
352 vmlinux_name = symbol_conf.vmlinux_name;
355 ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
357 ret = dso__load_vmlinux_path(dso, map, NULL);
364 * Some binaries like glibc have special symbols which are on the symbol
365 * table, but not in the debuginfo. If we can find the address of the
366 * symbol from map, we can translate the address back to the probe point.
368 static int find_alternative_probe_point(struct debuginfo *dinfo,
369 struct perf_probe_point *pp,
370 struct perf_probe_point *result,
371 const char *target, bool uprobes)
373 struct map *map = NULL;
378 /* This can work only for function-name based one */
379 if (!pp->function || pp->file)
382 map = get_target_map(target, uprobes);
386 /* Find the address of given function */
387 map__for_each_symbol_by_name(map, pp->function, sym) {
389 address = sym->start;
391 address = map->unmap_ip(map, sym->start);
398 pr_debug("Symbol %s address found : %" PRIx64 "\n",
399 pp->function, address);
401 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
404 ret = (!ret) ? -ENOENT : ret;
406 result->offset += pp->offset;
407 result->line += pp->line;
408 result->retprobe = pp->retprobe;
413 put_target_map(map, uprobes);
418 static int get_alternative_probe_event(struct debuginfo *dinfo,
419 struct perf_probe_event *pev,
420 struct perf_probe_point *tmp)
424 memcpy(tmp, &pev->point, sizeof(*tmp));
425 memset(&pev->point, 0, sizeof(pev->point));
426 ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
427 pev->target, pev->uprobes);
429 memcpy(&pev->point, tmp, sizeof(*tmp));
434 static int get_alternative_line_range(struct debuginfo *dinfo,
435 struct line_range *lr,
436 const char *target, bool user)
438 struct perf_probe_point pp = { .function = lr->function,
441 struct perf_probe_point result;
444 memset(&result, 0, sizeof(result));
446 if (lr->end != INT_MAX)
447 len = lr->end - lr->start;
448 ret = find_alternative_probe_point(dinfo, &pp, &result,
451 lr->function = result.function;
452 lr->file = result.file;
453 lr->start = result.line;
454 if (lr->end != INT_MAX)
455 lr->end = lr->start + len;
456 clear_perf_probe_point(&pp);
461 /* Open new debuginfo of given module */
462 static struct debuginfo *open_debuginfo(const char *module, bool silent)
464 const char *path = module;
465 char reason[STRERR_BUFSIZE];
466 struct debuginfo *ret = NULL;
467 struct dso *dso = NULL;
470 if (!module || !strchr(module, '/')) {
471 err = kernel_get_module_dso(module, &dso);
473 if (!dso || dso->load_errno == 0) {
474 if (!strerror_r(-err, reason, STRERR_BUFSIZE))
475 strcpy(reason, "(unknown)");
477 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
479 pr_err("Failed to find the path for %s: %s\n",
480 module ?: "kernel", reason);
483 path = dso->long_name;
485 ret = debuginfo__new(path);
486 if (!ret && !silent) {
487 pr_warning("The %s file has no debug information.\n", path);
488 if (!module || !strtailcmp(path, ".ko"))
489 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
491 pr_warning("Rebuild with -g, ");
492 pr_warning("or install an appropriate debuginfo package.\n");
497 /* For caching the last debuginfo */
498 static struct debuginfo *debuginfo_cache;
499 static char *debuginfo_cache_path;
501 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
503 const char *path = module;
505 /* If the module is NULL, it should be the kernel. */
509 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
512 /* Copy module path */
513 free(debuginfo_cache_path);
514 debuginfo_cache_path = strdup(path);
515 if (!debuginfo_cache_path) {
516 debuginfo__delete(debuginfo_cache);
517 debuginfo_cache = NULL;
521 debuginfo_cache = open_debuginfo(module, silent);
522 if (!debuginfo_cache)
523 zfree(&debuginfo_cache_path);
525 return debuginfo_cache;
528 static void debuginfo_cache__exit(void)
530 debuginfo__delete(debuginfo_cache);
531 debuginfo_cache = NULL;
532 zfree(&debuginfo_cache_path);
536 static int get_text_start_address(const char *exec, unsigned long *address)
541 int fd, ret = -ENOENT;
543 fd = open(exec, O_RDONLY);
547 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
553 if (gelf_getehdr(elf, &ehdr) == NULL)
556 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
559 *address = shdr.sh_addr - shdr.sh_offset;
570 * Convert trace point to probe point with debuginfo
572 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
573 struct perf_probe_point *pp,
576 struct debuginfo *dinfo = NULL;
577 unsigned long stext = 0;
578 u64 addr = tp->address;
581 /* convert the address to dwarf address */
587 ret = get_text_start_address(tp->module, &stext);
591 } else if (tp->symbol) {
592 /* If the module is given, this returns relative address */
593 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
594 false, !!tp->module);
600 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
601 tp->module ? : "kernel");
603 dinfo = debuginfo_cache__open(tp->module, verbose == 0);
605 ret = debuginfo__find_probe_point(dinfo,
606 (unsigned long)addr, pp);
611 pp->retprobe = tp->retprobe;
615 pr_debug("Failed to find corresponding probes from debuginfo.\n");
616 return ret ? : -ENOENT;
619 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
620 int ntevs, const char *exec)
623 unsigned long stext = 0;
628 ret = get_text_start_address(exec, &stext);
632 for (i = 0; i < ntevs && ret >= 0; i++) {
633 /* point.address is the addres of point.symbol + point.offset */
634 tevs[i].point.address -= stext;
635 tevs[i].point.module = strdup(exec);
636 if (!tevs[i].point.module) {
640 tevs[i].uprobes = true;
646 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
647 int ntevs, const char *module)
650 char *mod_name = NULL;
655 mod_name = find_module_name(module);
657 for (i = 0; i < ntevs; i++) {
658 tevs[i].point.module =
659 strdup(mod_name ? mod_name : module);
660 if (!tevs[i].point.module) {
670 /* Post processing the probe events */
671 static int post_process_probe_trace_events(struct probe_trace_event *tevs,
672 int ntevs, const char *module,
675 struct ref_reloc_sym *reloc_sym;
680 return add_exec_to_probe_trace_events(tevs, ntevs, module);
682 /* Note that currently ref_reloc_sym based probe is not for drivers */
684 return add_module_to_probe_trace_events(tevs, ntevs, module);
686 reloc_sym = kernel_get_ref_reloc_sym();
688 pr_warning("Relocated base symbol is not found!\n");
692 for (i = 0; i < ntevs; i++) {
693 if (!tevs[i].point.address || tevs[i].point.retprobe)
695 /* If we found a wrong one, mark it by NULL symbol */
696 if (kprobe_warn_out_range(tevs[i].point.symbol,
697 tevs[i].point.address)) {
701 tmp = strdup(reloc_sym->name);
705 /* If we have no realname, use symbol for it */
706 if (!tevs[i].point.realname)
707 tevs[i].point.realname = tevs[i].point.symbol;
709 free(tevs[i].point.symbol);
710 tevs[i].point.symbol = tmp;
711 tevs[i].point.offset = tevs[i].point.address -
712 reloc_sym->unrelocated_addr;
717 /* Try to find perf_probe_event with debuginfo */
718 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
719 struct probe_trace_event **tevs)
721 bool need_dwarf = perf_probe_event_need_dwarf(pev);
722 struct perf_probe_point tmp;
723 struct debuginfo *dinfo;
726 dinfo = open_debuginfo(pev->target, !need_dwarf);
730 pr_debug("Could not open debuginfo. Try to use symbols.\n");
734 pr_debug("Try to find probe point from debuginfo.\n");
735 /* Searching trace events corresponding to a probe event */
736 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
738 if (ntevs == 0) { /* Not found, retry with an alternative */
739 ret = get_alternative_probe_event(dinfo, pev, &tmp);
741 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
743 * Write back to the original probe_event for
744 * setting appropriate (user given) event name
746 clear_perf_probe_point(&pev->point);
747 memcpy(&pev->point, &tmp, sizeof(tmp));
751 debuginfo__delete(dinfo);
753 if (ntevs > 0) { /* Succeeded to find trace events */
754 pr_debug("Found %d probe_trace_events.\n", ntevs);
755 ret = post_process_probe_trace_events(*tevs, ntevs,
756 pev->target, pev->uprobes);
757 if (ret < 0 || ret == ntevs) {
758 clear_probe_trace_events(*tevs, ntevs);
762 return ret < 0 ? ret : ntevs;
767 if (ntevs == 0) { /* No error but failed to find probe point. */
768 pr_warning("Probe point '%s' not found.\n",
769 synthesize_perf_probe_point(&pev->point));
772 /* Error path : ntevs < 0 */
773 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
776 pr_warning("Warning: No dwarf info found in the vmlinux - "
777 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
779 pr_debug("Trying to use symbols.\n");
786 #define LINEBUF_SIZE 256
787 #define NR_ADDITIONAL_LINES 2
789 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
791 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
792 const char *color = show_num ? "" : PERF_COLOR_BLUE;
793 const char *prefix = NULL;
796 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
801 prefix = show_num ? "%7d " : " ";
802 color_fprintf(stdout, color, prefix, l);
804 color_fprintf(stdout, color, "%s", buf);
806 } while (strchr(buf, '\n') == NULL);
811 pr_warning("File read error: %s\n",
812 strerror_r(errno, sbuf, sizeof(sbuf)));
818 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
820 int rv = __show_one_line(fp, l, skip, show_num);
822 pr_warning("Source file is shorter than expected.\n");
828 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
829 #define show_one_line(f,l) _show_one_line(f,l,false,false)
830 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
831 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
834 * Show line-range always requires debuginfo to find source file and
837 static int __show_line_range(struct line_range *lr, const char *module,
842 struct debuginfo *dinfo;
846 char sbuf[STRERR_BUFSIZE];
848 /* Search a line range */
849 dinfo = open_debuginfo(module, false);
853 ret = debuginfo__find_line_range(dinfo, lr);
854 if (!ret) { /* Not found, retry with an alternative */
855 ret = get_alternative_line_range(dinfo, lr, module, user);
857 ret = debuginfo__find_line_range(dinfo, lr);
859 debuginfo__delete(dinfo);
860 if (ret == 0 || ret == -ENOENT) {
861 pr_warning("Specified source line is not found.\n");
863 } else if (ret < 0) {
864 pr_warning("Debuginfo analysis failed.\n");
868 /* Convert source file path */
870 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
872 /* Free old path when new path is assigned */
877 pr_warning("Failed to find source file path.\n");
884 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
885 lr->start - lr->offset);
887 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
889 fp = fopen(lr->path, "r");
891 pr_warning("Failed to open %s: %s\n", lr->path,
892 strerror_r(errno, sbuf, sizeof(sbuf)));
895 /* Skip to starting line number */
896 while (l < lr->start) {
897 ret = skip_one_line(fp, l++);
902 intlist__for_each(ln, lr->line_list) {
903 for (; ln->i > l; l++) {
904 ret = show_one_line(fp, l - lr->offset);
908 ret = show_one_line_with_num(fp, l++ - lr->offset);
913 if (lr->end == INT_MAX)
914 lr->end = l + NR_ADDITIONAL_LINES;
915 while (l <= lr->end) {
916 ret = show_one_line_or_eof(fp, l++ - lr->offset);
925 int show_line_range(struct line_range *lr, const char *module, bool user)
929 ret = init_probe_symbol_maps(user);
932 ret = __show_line_range(lr, module, user);
933 exit_probe_symbol_maps();
938 static int show_available_vars_at(struct debuginfo *dinfo,
939 struct perf_probe_event *pev,
940 struct strfilter *_filter)
944 struct str_node *node;
945 struct variable_list *vls = NULL, *vl;
946 struct perf_probe_point tmp;
949 buf = synthesize_perf_probe_point(&pev->point);
952 pr_debug("Searching variables at %s\n", buf);
954 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
955 if (!ret) { /* Not found, retry with an alternative */
956 ret = get_alternative_probe_event(dinfo, pev, &tmp);
958 ret = debuginfo__find_available_vars_at(dinfo, pev,
960 /* Release the old probe_point */
961 clear_perf_probe_point(&tmp);
965 if (ret == 0 || ret == -ENOENT) {
966 pr_err("Failed to find the address of %s\n", buf);
969 pr_warning("Debuginfo analysis failed.\n");
973 /* Some variables are found */
974 fprintf(stdout, "Available variables at %s\n", buf);
975 for (i = 0; i < ret; i++) {
978 * A probe point might be converted to
979 * several trace points.
981 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
983 zfree(&vl->point.symbol);
986 strlist__for_each(node, vl->vars) {
987 var = strchr(node->s, '\t') + 1;
988 if (strfilter__compare(_filter, var)) {
989 fprintf(stdout, "\t\t%s\n", node->s);
993 strlist__delete(vl->vars);
996 fprintf(stdout, "\t\t(No matched variables)\n");
1004 /* Show available variables on given probe point */
1005 int show_available_vars(struct perf_probe_event *pevs, int npevs,
1006 struct strfilter *_filter)
1009 struct debuginfo *dinfo;
1011 ret = init_probe_symbol_maps(pevs->uprobes);
1015 dinfo = open_debuginfo(pevs->target, false);
1023 for (i = 0; i < npevs && ret >= 0; i++)
1024 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1026 debuginfo__delete(dinfo);
1028 exit_probe_symbol_maps();
1032 #else /* !HAVE_DWARF_SUPPORT */
1034 static void debuginfo_cache__exit(void)
1039 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1040 struct perf_probe_point *pp __maybe_unused,
1041 bool is_kprobe __maybe_unused)
1046 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1047 struct probe_trace_event **tevs __maybe_unused)
1049 if (perf_probe_event_need_dwarf(pev)) {
1050 pr_warning("Debuginfo-analysis is not supported.\n");
1057 int show_line_range(struct line_range *lr __maybe_unused,
1058 const char *module __maybe_unused,
1059 bool user __maybe_unused)
1061 pr_warning("Debuginfo-analysis is not supported.\n");
1065 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1066 int npevs __maybe_unused,
1067 struct strfilter *filter __maybe_unused)
1069 pr_warning("Debuginfo-analysis is not supported.\n");
1074 void line_range__clear(struct line_range *lr)
1080 intlist__delete(lr->line_list);
1081 memset(lr, 0, sizeof(*lr));
1084 int line_range__init(struct line_range *lr)
1086 memset(lr, 0, sizeof(*lr));
1087 lr->line_list = intlist__new(NULL);
1094 static int parse_line_num(char **ptr, int *val, const char *what)
1096 const char *start = *ptr;
1099 *val = strtol(*ptr, ptr, 0);
1100 if (errno || *ptr == start) {
1101 semantic_error("'%s' is not a valid number.\n", what);
1107 /* Check the name is good for event, group or function */
1108 static bool is_c_func_name(const char *name)
1110 if (!isalpha(*name) && *name != '_')
1112 while (*++name != '\0') {
1113 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1120 * Stuff 'lr' according to the line range described by 'arg'.
1121 * The line range syntax is described by:
1123 * SRC[:SLN[+NUM|-ELN]]
1124 * FNC[@SRC][:SLN[+NUM|-ELN]]
1126 int parse_line_range_desc(const char *arg, struct line_range *lr)
1128 char *range, *file, *name = strdup(arg);
1137 range = strchr(name, ':');
1141 err = parse_line_num(&range, &lr->start, "start line");
1145 if (*range == '+' || *range == '-') {
1146 const char c = *range++;
1148 err = parse_line_num(&range, &lr->end, "end line");
1153 lr->end += lr->start;
1155 * Adjust the number of lines here.
1156 * If the number of lines == 1, the
1157 * the end of line should be equal to
1158 * the start of line.
1164 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1167 if (lr->start > lr->end) {
1168 semantic_error("Start line must be smaller"
1169 " than end line.\n");
1172 if (*range != '\0') {
1173 semantic_error("Tailing with invalid str '%s'.\n", range);
1178 file = strchr(name, '@');
1181 lr->file = strdup(++file);
1182 if (lr->file == NULL) {
1186 lr->function = name;
1187 } else if (strchr(name, '/') || strchr(name, '.'))
1189 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1190 lr->function = name;
1191 else { /* Invalid name */
1192 semantic_error("'%s' is not a valid function name.\n", name);
1203 /* Parse probepoint definition. */
1204 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1206 struct perf_probe_point *pp = &pev->point;
1209 bool file_spec = false;
1212 * perf probe [EVENT=]SRC[:LN|;PTN]
1213 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1215 * TODO:Group name support
1220 ptr = strpbrk(arg, ";=@+%");
1221 if (ptr && *ptr == '=') { /* Event name */
1224 if (strchr(arg, ':')) {
1225 semantic_error("Group name is not supported yet.\n");
1228 if (!is_c_func_name(arg)) {
1229 semantic_error("%s is bad for event name -it must "
1230 "follow C symbol-naming rule.\n", arg);
1233 pev->event = strdup(arg);
1234 if (pev->event == NULL)
1241 * Check arg is function or file name and copy it.
1243 * We consider arg to be a file spec if and only if it satisfies
1244 * all of the below criteria::
1245 * - it does not include any of "+@%",
1246 * - it includes one of ":;", and
1247 * - it has a period '.' in the name.
1249 * Otherwise, we consider arg to be a function specification.
1251 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
1252 /* This is a file spec if it includes a '.' before ; or : */
1253 if (memchr(arg, '.', ptr - arg))
1257 ptr = strpbrk(arg, ";:+@%");
1277 * Keep pp->function even if this is absolute address,
1278 * so it can mark whether abs_address is valid.
1279 * Which make 'perf probe lib.bin 0x0' possible.
1281 * Note that checking length of tmp is not needed
1282 * because when we access tmp[1] we know tmp[0] is '0',
1283 * so tmp[1] should always valid (but could be '\0').
1285 if (tmp && !strncmp(tmp, "0x", 2)) {
1286 pp->abs_address = strtoul(pp->function, &tmp, 0);
1288 semantic_error("Invalid absolute address.\n");
1294 /* Parse other options */
1298 if (c == ';') { /* Lazy pattern must be the last part */
1299 pp->lazy_line = strdup(arg);
1300 if (pp->lazy_line == NULL)
1304 ptr = strpbrk(arg, ";:+@%");
1310 case ':': /* Line number */
1311 pp->line = strtoul(arg, &tmp, 0);
1313 semantic_error("There is non-digit char"
1314 " in line number.\n");
1318 case '+': /* Byte offset from a symbol */
1319 pp->offset = strtoul(arg, &tmp, 0);
1321 semantic_error("There is non-digit character"
1326 case '@': /* File name */
1328 semantic_error("SRC@SRC is not allowed.\n");
1331 pp->file = strdup(arg);
1332 if (pp->file == NULL)
1335 case '%': /* Probe places */
1336 if (strcmp(arg, "return") == 0) {
1338 } else { /* Others not supported yet */
1339 semantic_error("%%%s is not supported.\n", arg);
1343 default: /* Buggy case */
1344 pr_err("This program has a bug at %s:%d.\n",
1345 __FILE__, __LINE__);
1351 /* Exclusion check */
1352 if (pp->lazy_line && pp->line) {
1353 semantic_error("Lazy pattern can't be used with"
1358 if (pp->lazy_line && pp->offset) {
1359 semantic_error("Lazy pattern can't be used with offset.\n");
1363 if (pp->line && pp->offset) {
1364 semantic_error("Offset can't be used with line number.\n");
1368 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1369 semantic_error("File always requires line number or "
1374 if (pp->offset && !pp->function) {
1375 semantic_error("Offset requires an entry function.\n");
1379 if (pp->retprobe && !pp->function) {
1380 semantic_error("Return probe requires an entry function.\n");
1384 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1385 semantic_error("Offset/Line/Lazy pattern can't be used with "
1390 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1391 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1396 /* Parse perf-probe event argument */
1397 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1399 char *tmp, *goodname;
1400 struct perf_probe_arg_field **fieldp;
1402 pr_debug("parsing arg: %s into ", str);
1404 tmp = strchr(str, '=');
1406 arg->name = strndup(str, tmp - str);
1407 if (arg->name == NULL)
1409 pr_debug("name:%s ", arg->name);
1413 tmp = strchr(str, ':');
1414 if (tmp) { /* Type setting */
1416 arg->type = strdup(tmp + 1);
1417 if (arg->type == NULL)
1419 pr_debug("type:%s ", arg->type);
1422 tmp = strpbrk(str, "-.[");
1423 if (!is_c_varname(str) || !tmp) {
1424 /* A variable, register, symbol or special value */
1425 arg->var = strdup(str);
1426 if (arg->var == NULL)
1428 pr_debug("%s\n", arg->var);
1432 /* Structure fields or array element */
1433 arg->var = strndup(str, tmp - str);
1434 if (arg->var == NULL)
1436 goodname = arg->var;
1437 pr_debug("%s, ", arg->var);
1438 fieldp = &arg->field;
1441 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1442 if (*fieldp == NULL)
1444 if (*tmp == '[') { /* Array */
1446 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1447 (*fieldp)->ref = true;
1448 if (*tmp != ']' || tmp == str + 1) {
1449 semantic_error("Array index must be a"
1456 } else { /* Structure */
1459 (*fieldp)->ref = false;
1460 } else if (tmp[1] == '>') {
1462 (*fieldp)->ref = true;
1464 semantic_error("Argument parse error: %s\n",
1468 tmp = strpbrk(str, "-.[");
1471 (*fieldp)->name = strndup(str, tmp - str);
1472 if ((*fieldp)->name == NULL)
1475 goodname = (*fieldp)->name;
1476 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1477 fieldp = &(*fieldp)->next;
1480 (*fieldp)->name = strdup(str);
1481 if ((*fieldp)->name == NULL)
1484 goodname = (*fieldp)->name;
1485 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1487 /* If no name is specified, set the last field name (not array index)*/
1489 arg->name = strdup(goodname);
1490 if (arg->name == NULL)
1496 /* Parse perf-probe event command */
1497 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1500 int argc, i, ret = 0;
1502 argv = argv_split(cmd, &argc);
1504 pr_debug("Failed to split arguments.\n");
1507 if (argc - 1 > MAX_PROBE_ARGS) {
1508 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1512 /* Parse probe point */
1513 ret = parse_perf_probe_point(argv[0], pev);
1517 /* Copy arguments and ensure return probe has no C argument */
1518 pev->nargs = argc - 1;
1519 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1520 if (pev->args == NULL) {
1524 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1525 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1527 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1528 semantic_error("You can't specify local variable for"
1539 /* Return true if this perf_probe_event requires debuginfo */
1540 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1544 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1547 for (i = 0; i < pev->nargs; i++)
1548 if (is_c_varname(pev->args[i].var))
1554 /* Parse probe_events event into struct probe_point */
1555 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1557 struct probe_trace_point *tp = &tev->point;
1560 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1564 pr_debug("Parsing probe_events: %s\n", cmd);
1565 argv = argv_split(cmd, &argc);
1567 pr_debug("Failed to split arguments.\n");
1571 semantic_error("Too few probe arguments.\n");
1576 /* Scan event and group name. */
1577 argv0_str = strdup(argv[0]);
1578 if (argv0_str == NULL) {
1582 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1583 fmt2_str = strtok_r(NULL, "/", &fmt);
1584 fmt3_str = strtok_r(NULL, " \t", &fmt);
1585 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1586 || fmt3_str == NULL) {
1587 semantic_error("Failed to parse event name: %s\n", argv[0]);
1592 tev->group = strdup(fmt2_str);
1593 tev->event = strdup(fmt3_str);
1594 if (tev->group == NULL || tev->event == NULL) {
1598 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1600 tp->retprobe = (pr == 'r');
1602 /* Scan module name(if there), function name and offset */
1603 p = strchr(argv[1], ':');
1605 tp->module = strndup(argv[1], p - argv[1]);
1609 fmt1_str = strtok_r(p, "+", &fmt);
1610 /* only the address started with 0x */
1611 if (fmt1_str[0] == '0') {
1613 * Fix a special case:
1614 * if address == 0, kernel reports something like:
1615 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1616 * Newer kernel may fix that, but we want to
1617 * support old kernel also.
1619 if (strcmp(fmt1_str, "0x") == 0) {
1620 if (!argv[2] || strcmp(argv[2], "(null)")) {
1627 for (i = 2; argv[i + 1] != NULL; i++)
1628 argv[i] = argv[i + 1];
1633 tp->address = strtoul(fmt1_str, NULL, 0);
1635 /* Only the symbol-based probe has offset */
1636 tp->symbol = strdup(fmt1_str);
1637 if (tp->symbol == NULL) {
1641 fmt2_str = strtok_r(NULL, "", &fmt);
1642 if (fmt2_str == NULL)
1645 tp->offset = strtoul(fmt2_str, NULL, 10);
1648 tev->nargs = argc - 2;
1649 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1650 if (tev->args == NULL) {
1654 for (i = 0; i < tev->nargs; i++) {
1655 p = strchr(argv[i + 2], '=');
1656 if (p) /* We don't need which register is assigned. */
1660 tev->args[i].name = strdup(argv[i + 2]);
1661 /* TODO: parse regs and offset */
1662 tev->args[i].value = strdup(p);
1663 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1675 /* Compose only probe arg */
1676 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1678 struct perf_probe_arg_field *field = pa->field;
1683 if (strbuf_init(&buf, 64) < 0)
1686 if (pa->name && pa->var)
1687 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1689 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1694 if (field->name[0] == '[')
1695 err = strbuf_addstr(&buf, field->name);
1697 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1699 field = field->next;
1705 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1708 ret = strbuf_detach(&buf, NULL);
1710 strbuf_release(&buf);
1714 /* Compose only probe point (not argument) */
1715 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1718 char *tmp, *ret = NULL;
1721 if (strbuf_init(&buf, 64) < 0)
1725 if (strbuf_addstr(&buf, pp->function) < 0)
1728 err = strbuf_addf(&buf, "+%lu", pp->offset);
1730 err = strbuf_addf(&buf, ":%d", pp->line);
1731 else if (pp->retprobe)
1732 err = strbuf_addstr(&buf, "%return");
1740 tmp = strchr(pp->file + len - 30, '/');
1741 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1743 err = strbuf_addf(&buf, "@%s", tmp);
1744 if (!err && !pp->function && pp->line)
1745 err = strbuf_addf(&buf, ":%d", pp->line);
1748 ret = strbuf_detach(&buf, NULL);
1750 strbuf_release(&buf);
1755 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1760 buf = synthesize_perf_probe_point(&pev->point);
1765 for (i = 0; i < pev->nargs; i++) {
1766 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1779 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1780 struct strbuf *buf, int depth)
1784 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1789 err = strbuf_addf(buf, "%+ld(", ref->offset);
1790 return (err < 0) ? err : depth;
1793 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1796 struct probe_trace_arg_ref *ref = arg->ref;
1799 /* Argument name or separator */
1801 err = strbuf_addf(buf, " %s=", arg->name);
1803 err = strbuf_addch(buf, ' ');
1807 /* Special case: @XXX */
1808 if (arg->value[0] == '@' && arg->ref)
1811 /* Dereferencing arguments */
1813 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
1818 /* Print argument value */
1819 if (arg->value[0] == '@' && arg->ref)
1820 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
1822 err = strbuf_addstr(buf, arg->value);
1825 while (!err && depth--)
1826 err = strbuf_addch(buf, ')');
1828 /* Print argument type */
1829 if (!err && arg->type)
1830 err = strbuf_addf(buf, ":%s", arg->type);
1835 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1837 struct probe_trace_point *tp = &tev->point;
1842 /* Uprobes must have tp->module */
1843 if (tev->uprobes && !tp->module)
1846 if (strbuf_init(&buf, 32) < 0)
1849 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1850 tev->group, tev->event) < 0)
1853 * If tp->address == 0, then this point must be a
1854 * absolute address uprobe.
1855 * try_to_find_absolute_address() should have made
1856 * tp->symbol to "0x0".
1858 if (tev->uprobes && !tp->address) {
1859 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
1863 /* Use the tp->address for uprobes */
1865 err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address);
1866 else if (!strncmp(tp->symbol, "0x", 2))
1867 /* Absolute address. See try_to_find_absolute_address() */
1868 err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
1869 tp->module ? ":" : "", tp->address);
1871 err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
1872 tp->module ? ":" : "", tp->symbol, tp->offset);
1876 for (i = 0; i < tev->nargs; i++)
1877 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
1880 ret = strbuf_detach(&buf, NULL);
1882 strbuf_release(&buf);
1886 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1887 struct perf_probe_point *pp,
1890 struct symbol *sym = NULL;
1892 u64 addr = tp->address;
1896 map = dso__new_map(tp->module);
1899 sym = map__find_symbol(map, addr, NULL);
1901 if (tp->symbol && !addr) {
1902 if (kernel_get_symbol_address_by_name(tp->symbol,
1903 &addr, true, false) < 0)
1908 sym = __find_kernel_function(addr, &map);
1915 pp->retprobe = tp->retprobe;
1916 pp->offset = addr - map->unmap_ip(map, sym->start);
1917 pp->function = strdup(sym->name);
1918 ret = pp->function ? 0 : -ENOMEM;
1921 if (map && !is_kprobe) {
1928 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1929 struct perf_probe_point *pp,
1935 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1938 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1942 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1945 pp->function = strdup(tp->symbol);
1946 pp->offset = tp->offset;
1948 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1951 pp->function = strdup(buf);
1954 if (pp->function == NULL)
1957 pp->retprobe = tp->retprobe;
1962 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1963 struct perf_probe_event *pev, bool is_kprobe)
1965 struct strbuf buf = STRBUF_INIT;
1968 /* Convert event/group name */
1969 pev->event = strdup(tev->event);
1970 pev->group = strdup(tev->group);
1971 if (pev->event == NULL || pev->group == NULL)
1974 /* Convert trace_point to probe_point */
1975 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1979 /* Convert trace_arg to probe_arg */
1980 pev->nargs = tev->nargs;
1981 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1982 if (pev->args == NULL)
1984 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1985 if (tev->args[i].name)
1986 pev->args[i].name = strdup(tev->args[i].name);
1988 if ((ret = strbuf_init(&buf, 32)) < 0)
1990 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
1991 pev->args[i].name = strbuf_detach(&buf, NULL);
1993 if (pev->args[i].name == NULL && ret >= 0)
1998 clear_perf_probe_event(pev);
2003 void clear_perf_probe_event(struct perf_probe_event *pev)
2005 struct perf_probe_arg_field *field, *next;
2011 clear_perf_probe_point(&pev->point);
2013 for (i = 0; i < pev->nargs; i++) {
2014 free(pev->args[i].name);
2015 free(pev->args[i].var);
2016 free(pev->args[i].type);
2017 field = pev->args[i].field;
2020 zfree(&field->name);
2026 memset(pev, 0, sizeof(*pev));
2029 void clear_probe_trace_event(struct probe_trace_event *tev)
2031 struct probe_trace_arg_ref *ref, *next;
2036 free(tev->point.symbol);
2037 free(tev->point.realname);
2038 free(tev->point.module);
2039 for (i = 0; i < tev->nargs; i++) {
2040 free(tev->args[i].name);
2041 free(tev->args[i].value);
2042 free(tev->args[i].type);
2043 ref = tev->args[i].ref;
2051 memset(tev, 0, sizeof(*tev));
2054 struct kprobe_blacklist_node {
2055 struct list_head list;
2056 unsigned long start;
2061 static void kprobe_blacklist__delete(struct list_head *blacklist)
2063 struct kprobe_blacklist_node *node;
2065 while (!list_empty(blacklist)) {
2066 node = list_first_entry(blacklist,
2067 struct kprobe_blacklist_node, list);
2068 list_del(&node->list);
2074 static int kprobe_blacklist__load(struct list_head *blacklist)
2076 struct kprobe_blacklist_node *node;
2077 const char *__debugfs = debugfs__mountpoint();
2078 char buf[PATH_MAX], *p;
2082 if (__debugfs == NULL)
2085 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2089 fp = fopen(buf, "r");
2094 while (fgets(buf, PATH_MAX, fp)) {
2095 node = zalloc(sizeof(*node));
2100 INIT_LIST_HEAD(&node->list);
2101 list_add_tail(&node->list, blacklist);
2102 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2106 p = strchr(buf, '\t');
2109 if (p[strlen(p) - 1] == '\n')
2110 p[strlen(p) - 1] = '\0';
2112 p = (char *)"unknown";
2113 node->symbol = strdup(p);
2114 if (!node->symbol) {
2118 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2119 node->start, node->end, node->symbol);
2123 kprobe_blacklist__delete(blacklist);
2129 static struct kprobe_blacklist_node *
2130 kprobe_blacklist__find_by_address(struct list_head *blacklist,
2131 unsigned long address)
2133 struct kprobe_blacklist_node *node;
2135 list_for_each_entry(node, blacklist, list) {
2136 if (node->start <= address && address <= node->end)
2143 static LIST_HEAD(kprobe_blacklist);
2145 static void kprobe_blacklist__init(void)
2147 if (!list_empty(&kprobe_blacklist))
2150 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2151 pr_debug("No kprobe blacklist support, ignored\n");
2154 static void kprobe_blacklist__release(void)
2156 kprobe_blacklist__delete(&kprobe_blacklist);
2159 static bool kprobe_blacklist__listed(unsigned long address)
2161 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2164 static int perf_probe_event__sprintf(const char *group, const char *event,
2165 struct perf_probe_event *pev,
2167 struct strbuf *result)
2172 if (asprintf(&buf, "%s:%s", group, event) < 0)
2174 ret = strbuf_addf(result, " %-20s (on ", buf);
2179 /* Synthesize only event probe point */
2180 buf = synthesize_perf_probe_point(&pev->point);
2183 ret = strbuf_addstr(result, buf);
2187 ret = strbuf_addf(result, " in %s", module);
2189 if (!ret && pev->nargs > 0) {
2190 ret = strbuf_add(result, " with", 5);
2191 for (i = 0; !ret && i < pev->nargs; i++) {
2192 buf = synthesize_perf_probe_arg(&pev->args[i]);
2195 ret = strbuf_addf(result, " %s", buf);
2200 ret = strbuf_addch(result, ')');
2206 int show_perf_probe_event(const char *group, const char *event,
2207 struct perf_probe_event *pev,
2208 const char *module, bool use_stdout)
2210 struct strbuf buf = STRBUF_INIT;
2213 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2216 printf("%s\n", buf.buf);
2218 pr_info("%s\n", buf.buf);
2220 strbuf_release(&buf);
2225 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2226 struct strfilter *filter)
2230 /* At first, check the event name itself */
2231 if (strfilter__compare(filter, tev->event))
2234 /* Next, check the combination of name and group */
2235 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2237 return strfilter__compare(filter, tmp);
2240 static int __show_perf_probe_events(int fd, bool is_kprobe,
2241 struct strfilter *filter)
2244 struct probe_trace_event tev;
2245 struct perf_probe_event pev;
2246 struct strlist *rawlist;
2247 struct str_node *ent;
2249 memset(&tev, 0, sizeof(tev));
2250 memset(&pev, 0, sizeof(pev));
2252 rawlist = probe_file__get_rawlist(fd);
2256 strlist__for_each(ent, rawlist) {
2257 ret = parse_probe_trace_command(ent->s, &tev);
2259 if (!filter_probe_trace_event(&tev, filter))
2261 ret = convert_to_perf_probe_event(&tev, &pev,
2265 ret = show_perf_probe_event(pev.group, pev.event,
2266 &pev, tev.point.module,
2270 clear_perf_probe_event(&pev);
2271 clear_probe_trace_event(&tev);
2275 strlist__delete(rawlist);
2276 /* Cleanup cached debuginfo if needed */
2277 debuginfo_cache__exit();
2282 /* List up current perf-probe events */
2283 int show_perf_probe_events(struct strfilter *filter)
2285 int kp_fd, up_fd, ret;
2289 ret = init_probe_symbol_maps(false);
2293 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2298 ret = __show_perf_probe_events(kp_fd, true, filter);
2299 if (up_fd >= 0 && ret >= 0)
2300 ret = __show_perf_probe_events(up_fd, false, filter);
2305 exit_probe_symbol_maps();
2310 static int get_new_event_name(char *buf, size_t len, const char *base,
2311 struct strlist *namelist, bool allow_suffix)
2318 nbase = strdup(base);
2322 /* Cut off the dot suffixes (e.g. .const, .isra)*/
2323 p = strchr(nbase, '.');
2324 if (p && p != nbase)
2327 /* Try no suffix number */
2328 ret = e_snprintf(buf, len, "%s", nbase);
2330 pr_debug("snprintf() failed: %d\n", ret);
2333 if (!strlist__has_entry(namelist, buf))
2336 if (!allow_suffix) {
2337 pr_warning("Error: event \"%s\" already exists.\n"
2338 " Hint: Remove existing event by 'perf probe -d'\n"
2339 " or force duplicates by 'perf probe -f'\n"
2340 " or set 'force=yes' in BPF source.\n",
2346 /* Try to add suffix */
2347 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2348 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2350 pr_debug("snprintf() failed: %d\n", ret);
2353 if (!strlist__has_entry(namelist, buf))
2356 if (i == MAX_EVENT_INDEX) {
2357 pr_warning("Too many events are on the same function.\n");
2366 /* Warn if the current kernel's uprobe implementation is old */
2367 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2370 char *buf = synthesize_probe_trace_command(tev);
2372 /* Old uprobe event doesn't support memory dereference */
2373 if (!tev->uprobes || tev->nargs == 0 || !buf)
2376 for (i = 0; i < tev->nargs; i++)
2377 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2378 pr_warning("Please upgrade your kernel to at least "
2379 "3.14 to have access to feature %s\n",
2380 tev->args[i].value);
2387 /* Set new name from original perf_probe_event and namelist */
2388 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2389 struct perf_probe_event *pev,
2390 struct strlist *namelist,
2393 const char *event, *group;
2400 if (pev->point.function &&
2401 (strncmp(pev->point.function, "0x", 2) != 0) &&
2402 !strisglob(pev->point.function))
2403 event = pev->point.function;
2405 event = tev->point.realname;
2409 group = PERFPROBE_GROUP;
2411 /* Get an unused new event name */
2412 ret = get_new_event_name(buf, 64, event,
2413 namelist, allow_suffix);
2419 tev->event = strdup(event);
2420 tev->group = strdup(group);
2421 if (tev->event == NULL || tev->group == NULL)
2424 /* Add added event name to namelist */
2425 strlist__add(namelist, event);
2429 static int __add_probe_trace_events(struct perf_probe_event *pev,
2430 struct probe_trace_event *tevs,
2431 int ntevs, bool allow_suffix)
2434 struct probe_trace_event *tev = NULL;
2435 struct strlist *namelist;
2437 fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
2441 /* Get current event names */
2442 namelist = probe_file__get_namelist(fd);
2444 pr_debug("Failed to get current event list.\n");
2450 for (i = 0; i < ntevs; i++) {
2452 /* Skip if the symbol is out of .text or blacklisted */
2453 if (!tev->point.symbol)
2456 /* Set new name for tev (and update namelist) */
2457 ret = probe_trace_event__set_name(tev, pev, namelist,
2462 ret = probe_file__add_event(fd, tev);
2467 * Probes after the first probe which comes from same
2468 * user input are always allowed to add suffix, because
2469 * there might be several addresses corresponding to
2472 allow_suffix = true;
2474 if (ret == -EINVAL && pev->uprobes)
2475 warn_uprobe_event_compat(tev);
2477 strlist__delete(namelist);
2483 static int find_probe_functions(struct map *map, char *name,
2484 struct symbol **syms)
2488 struct rb_node *tmp;
2490 if (map__load(map, NULL) < 0)
2493 map__for_each_symbol(map, sym, tmp) {
2494 if (strglobmatch(sym->name, name)) {
2496 if (syms && found < probe_conf.max_probes)
2497 syms[found - 1] = sym;
2504 #define strdup_or_goto(str, label) \
2505 ({ char *__p = strdup(str); if (!__p) goto label; __p; })
2507 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2508 struct probe_trace_event *tev __maybe_unused,
2509 struct map *map __maybe_unused,
2510 struct symbol *sym __maybe_unused) { }
2513 * Find probe function addresses from map.
2514 * Return an error or the number of found probe_trace_event
2516 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2517 struct probe_trace_event **tevs)
2519 struct map *map = NULL;
2520 struct ref_reloc_sym *reloc_sym = NULL;
2522 struct symbol **syms = NULL;
2523 struct probe_trace_event *tev;
2524 struct perf_probe_point *pp = &pev->point;
2525 struct probe_trace_point *tp;
2526 int num_matched_functions;
2527 int ret, i, j, skipped = 0;
2530 map = get_target_map(pev->target, pev->uprobes);
2536 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2543 * Load matched symbols: Since the different local symbols may have
2544 * same name but different addresses, this lists all the symbols.
2546 num_matched_functions = find_probe_functions(map, pp->function, syms);
2547 if (num_matched_functions == 0) {
2548 pr_err("Failed to find symbol %s in %s\n", pp->function,
2549 pev->target ? : "kernel");
2552 } else if (num_matched_functions > probe_conf.max_probes) {
2553 pr_err("Too many functions matched in %s\n",
2554 pev->target ? : "kernel");
2559 /* Note that the symbols in the kmodule are not relocated */
2560 if (!pev->uprobes && !pp->retprobe && !pev->target) {
2561 reloc_sym = kernel_get_ref_reloc_sym();
2563 pr_warning("Relocated base symbol is not found!\n");
2569 /* Setup result trace-probe-events */
2570 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2578 for (j = 0; j < num_matched_functions; j++) {
2581 tev = (*tevs) + ret;
2583 if (ret == num_matched_functions) {
2584 pr_warning("Too many symbols are listed. Skip it.\n");
2589 if (pp->offset > sym->end - sym->start) {
2590 pr_warning("Offset %ld is bigger than the size of %s\n",
2591 pp->offset, sym->name);
2595 /* Add one probe point */
2596 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2598 /* Check the kprobe (not in module) is within .text */
2599 if (!pev->uprobes && !pev->target &&
2600 kprobe_warn_out_range(sym->name, tp->address)) {
2601 tp->symbol = NULL; /* Skip it */
2603 } else if (reloc_sym) {
2604 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2605 tp->offset = tp->address - reloc_sym->addr;
2607 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2608 tp->offset = pp->offset;
2610 tp->realname = strdup_or_goto(sym->name, nomem_out);
2612 tp->retprobe = pp->retprobe;
2615 tev->point.module = strdup_or_goto(pev->target,
2618 mod_name = find_module_name(pev->target);
2620 strdup(mod_name ? mod_name : pev->target);
2622 if (!tev->point.module)
2626 tev->uprobes = pev->uprobes;
2627 tev->nargs = pev->nargs;
2629 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2631 if (tev->args == NULL)
2634 for (i = 0; i < tev->nargs; i++) {
2635 if (pev->args[i].name)
2637 strdup_or_goto(pev->args[i].name,
2640 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2642 if (pev->args[i].type)
2644 strdup_or_goto(pev->args[i].type,
2647 arch__fix_tev_from_maps(pev, tev, map, sym);
2649 if (ret == skipped) {
2655 put_target_map(map, pev->uprobes);
2662 clear_probe_trace_events(*tevs, num_matched_functions);
2667 static int try_to_find_absolute_address(struct perf_probe_event *pev,
2668 struct probe_trace_event **tevs)
2670 struct perf_probe_point *pp = &pev->point;
2671 struct probe_trace_event *tev;
2672 struct probe_trace_point *tp;
2675 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
2677 if (perf_probe_event_need_dwarf(pev))
2681 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
2684 * Only one tev can be generated by this.
2686 *tevs = zalloc(sizeof(*tev));
2694 * Don't use tp->offset, use address directly, because
2695 * in synthesize_probe_trace_command() address cannot be
2698 tp->address = pev->point.abs_address;
2699 tp->retprobe = pp->retprobe;
2700 tev->uprobes = pev->uprobes;
2704 * Give it a '0x' leading symbol name.
2705 * In __add_probe_trace_events, a NULL symbol is interpreted as
2708 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
2711 /* For kprobe, check range */
2712 if ((!tev->uprobes) &&
2713 (kprobe_warn_out_range(tev->point.symbol,
2714 tev->point.address))) {
2719 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
2723 tp->module = strdup(pev->target);
2729 tev->group = strdup(pev->group);
2735 tev->event = strdup(pev->event);
2740 tev->nargs = pev->nargs;
2741 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
2746 for (i = 0; i < tev->nargs; i++)
2747 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
2753 clear_probe_trace_events(*tevs, 1);
2759 bool __weak arch__prefers_symtab(void) { return false; }
2761 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2762 struct probe_trace_event **tevs)
2767 /* Set group name if not given */
2768 if (!pev->uprobes) {
2769 pev->group = strdup(PERFPROBE_GROUP);
2770 ret = pev->group ? 0 : -ENOMEM;
2772 ret = convert_exec_to_group(pev->target, &pev->group);
2774 pr_warning("Failed to make a group name.\n");
2779 ret = try_to_find_absolute_address(pev, tevs);
2783 if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2784 ret = find_probe_trace_events_from_map(pev, tevs);
2786 return ret; /* Found in symbol table */
2789 /* Convert perf_probe_event with debuginfo */
2790 ret = try_to_find_probe_trace_events(pev, tevs);
2792 return ret; /* Found in debuginfo or got an error */
2794 return find_probe_trace_events_from_map(pev, tevs);
2797 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2801 /* Loop 1: convert all events */
2802 for (i = 0; i < npevs; i++) {
2803 /* Init kprobe blacklist if needed */
2804 if (!pevs[i].uprobes)
2805 kprobe_blacklist__init();
2806 /* Convert with or without debuginfo */
2807 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
2810 pevs[i].ntevs = ret;
2812 /* This just release blacklist only if allocated */
2813 kprobe_blacklist__release();
2818 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2822 /* Loop 2: add all events */
2823 for (i = 0; i < npevs; i++) {
2824 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
2826 probe_conf.force_add);
2833 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2837 /* Loop 3: cleanup and free trace events */
2838 for (i = 0; i < npevs; i++) {
2839 for (j = 0; j < pevs[i].ntevs; j++)
2840 clear_probe_trace_event(&pevs[i].tevs[j]);
2841 zfree(&pevs[i].tevs);
2843 clear_perf_probe_event(&pevs[i]);
2847 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2851 ret = init_probe_symbol_maps(pevs->uprobes);
2855 ret = convert_perf_probe_events(pevs, npevs);
2857 ret = apply_perf_probe_events(pevs, npevs);
2859 cleanup_perf_probe_events(pevs, npevs);
2861 exit_probe_symbol_maps();
2865 int del_perf_probe_events(struct strfilter *filter)
2867 int ret, ret2, ufd = -1, kfd = -1;
2868 char *str = strfilter__string(filter);
2873 /* Get current event names */
2874 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
2878 ret = probe_file__del_events(kfd, filter);
2879 if (ret < 0 && ret != -ENOENT)
2882 ret2 = probe_file__del_events(ufd, filter);
2883 if (ret2 < 0 && ret2 != -ENOENT) {
2900 /* TODO: don't use a global variable for filter ... */
2901 static struct strfilter *available_func_filter;
2904 * If a symbol corresponds to a function with global binding and
2905 * matches filter return 0. For all others return 1.
2907 static int filter_available_functions(struct map *map __maybe_unused,
2910 if (strfilter__compare(available_func_filter, sym->name))
2915 int show_available_funcs(const char *target, struct strfilter *_filter,
2921 ret = init_probe_symbol_maps(user);
2925 /* Get a symbol map */
2927 map = dso__new_map(target);
2929 map = kernel_get_module_map(target);
2931 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
2935 /* Load symbols with given filter */
2936 available_func_filter = _filter;
2937 if (map__load(map, filter_available_functions)) {
2938 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
2941 if (!dso__sorted_by_name(map->dso, map->type))
2942 dso__sort_by_name(map->dso, map->type);
2944 /* Show all (filtered) symbols */
2946 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2951 exit_probe_symbol_maps();
2956 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
2957 struct perf_probe_arg *pvar)
2959 tvar->value = strdup(pvar->var);
2960 if (tvar->value == NULL)
2963 tvar->type = strdup(pvar->type);
2964 if (tvar->type == NULL)
2968 tvar->name = strdup(pvar->name);
2969 if (tvar->name == NULL)