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 struct machine *host_machine;
72 /* Initialize symbol maps and path of vmlinux/modules */
73 int init_probe_symbol_maps(bool user_only)
77 symbol_conf.sort_by_name = true;
78 symbol_conf.allow_aliases = true;
79 ret = symbol__init(NULL);
81 pr_debug("Failed to init symbol map.\n");
85 if (host_machine || user_only) /* already initialized */
88 if (symbol_conf.vmlinux_name)
89 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
91 host_machine = machine__new_host();
93 pr_debug("machine__new_host() failed.\n");
99 pr_warning("Failed to init vmlinux path.\n");
103 void exit_probe_symbol_maps(void)
105 machine__delete(host_machine);
110 static struct symbol *__find_kernel_function_by_name(const char *name,
113 return machine__find_kernel_function_by_name(host_machine, name, mapp,
117 static struct symbol *__find_kernel_function(u64 addr, struct map **mapp)
119 return machine__find_kernel_function(host_machine, addr, mapp, NULL);
122 static struct ref_reloc_sym *kernel_get_ref_reloc_sym(void)
124 /* kmap->ref_reloc_sym should be set if host_machine is initialized */
126 struct map *map = machine__kernel_map(host_machine);
128 if (map__load(map, NULL) < 0)
131 kmap = map__kmap(map);
134 return kmap->ref_reloc_sym;
137 static int kernel_get_symbol_address_by_name(const char *name, u64 *addr,
138 bool reloc, bool reladdr)
140 struct ref_reloc_sym *reloc_sym;
144 /* ref_reloc_sym is just a label. Need a special fix*/
145 reloc_sym = kernel_get_ref_reloc_sym();
146 if (reloc_sym && strcmp(name, reloc_sym->name) == 0)
147 *addr = (reloc) ? reloc_sym->addr : reloc_sym->unrelocated_addr;
149 sym = __find_kernel_function_by_name(name, &map);
152 *addr = map->unmap_ip(map, sym->start) -
153 ((reloc) ? 0 : map->reloc) -
154 ((reladdr) ? map->start : 0);
159 static struct map *kernel_get_module_map(const char *module)
161 struct map_groups *grp = &host_machine->kmaps;
162 struct maps *maps = &grp->maps[MAP__FUNCTION];
165 /* A file path -- this is an offline module */
166 if (module && strchr(module, '/'))
167 return machine__findnew_module_map(host_machine, 0, module);
172 for (pos = maps__first(maps); pos; pos = map__next(pos)) {
173 if (strncmp(pos->dso->short_name + 1, module,
174 pos->dso->short_name_len - 2) == 0) {
181 static struct map *get_target_map(const char *target, bool user)
183 /* Init maps of given executable or kernel */
185 return dso__new_map(target);
187 return kernel_get_module_map(target);
190 static void put_target_map(struct map *map, bool user)
193 /* Only the user map needs to be released */
199 static int convert_exec_to_group(const char *exec, char **result)
201 char *ptr1, *ptr2, *exec_copy;
205 exec_copy = strdup(exec);
209 ptr1 = basename(exec_copy);
215 ptr2 = strpbrk(ptr1, "-._");
218 ret = e_snprintf(buf, 64, "%s_%s", PERFPROBE_GROUP, ptr1);
222 *result = strdup(buf);
223 ret = *result ? 0 : -ENOMEM;
230 static void clear_perf_probe_point(struct perf_probe_point *pp)
237 static void clear_probe_trace_events(struct probe_trace_event *tevs, int ntevs)
241 for (i = 0; i < ntevs; i++)
242 clear_probe_trace_event(tevs + i);
245 static bool kprobe_blacklist__listed(unsigned long address);
246 static bool kprobe_warn_out_range(const char *symbol, unsigned long address)
251 /* Get the address of _etext for checking non-probable text symbol */
252 ret = kernel_get_symbol_address_by_name("_etext", &etext_addr,
255 if (ret == 0 && etext_addr < address)
256 pr_warning("%s is out of .text, skip it.\n", symbol);
257 else if (kprobe_blacklist__listed(address))
258 pr_warning("%s is blacklisted function, skip it.\n", symbol);
267 * '.gnu.linkonce.this_module' section of kernel module elf directly
268 * maps to 'struct module' from linux/module.h. This section contains
269 * actual module name which will be used by kernel after loading it.
270 * But, we cannot use 'struct module' here since linux/module.h is not
271 * exposed to user-space. Offset of 'name' has remained same from long
272 * time, so hardcoding it here.
275 #define MOD_NAME_OFFSET 24
277 #define MOD_NAME_OFFSET 12
281 * @module can be module name of module file path. In case of path,
282 * inspect elf and find out what is actual module name.
283 * Caller has to free mod_name after using it.
285 static char *find_module_name(const char *module)
293 char *mod_name = NULL;
295 fd = open(module, O_RDONLY);
299 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
303 if (gelf_getehdr(elf, &ehdr) == NULL)
306 sec = elf_section_by_name(elf, &ehdr, &shdr,
307 ".gnu.linkonce.this_module", NULL);
311 data = elf_getdata(sec, NULL);
312 if (!data || !data->d_buf)
315 mod_name = strdup((char *)data->d_buf + MOD_NAME_OFFSET);
324 #ifdef HAVE_DWARF_SUPPORT
326 static int kernel_get_module_dso(const char *module, struct dso **pdso)
330 const char *vmlinux_name;
334 char module_name[128];
336 snprintf(module_name, sizeof(module_name), "[%s]", module);
337 map = map_groups__find_by_name(&host_machine->kmaps, MAP__FUNCTION, module_name);
342 pr_debug("Failed to find module %s.\n", module);
346 map = machine__kernel_map(host_machine);
349 vmlinux_name = symbol_conf.vmlinux_name;
352 ret = dso__load_vmlinux(dso, map, vmlinux_name, false, NULL);
354 ret = dso__load_vmlinux_path(dso, map, NULL);
361 * Some binaries like glibc have special symbols which are on the symbol
362 * table, but not in the debuginfo. If we can find the address of the
363 * symbol from map, we can translate the address back to the probe point.
365 static int find_alternative_probe_point(struct debuginfo *dinfo,
366 struct perf_probe_point *pp,
367 struct perf_probe_point *result,
368 const char *target, bool uprobes)
370 struct map *map = NULL;
375 /* This can work only for function-name based one */
376 if (!pp->function || pp->file)
379 map = get_target_map(target, uprobes);
383 /* Find the address of given function */
384 map__for_each_symbol_by_name(map, pp->function, sym) {
386 address = sym->start;
388 address = map->unmap_ip(map, sym->start);
395 pr_debug("Symbol %s address found : %" PRIx64 "\n",
396 pp->function, address);
398 ret = debuginfo__find_probe_point(dinfo, (unsigned long)address,
401 ret = (!ret) ? -ENOENT : ret;
403 result->offset += pp->offset;
404 result->line += pp->line;
405 result->retprobe = pp->retprobe;
410 put_target_map(map, uprobes);
415 static int get_alternative_probe_event(struct debuginfo *dinfo,
416 struct perf_probe_event *pev,
417 struct perf_probe_point *tmp)
421 memcpy(tmp, &pev->point, sizeof(*tmp));
422 memset(&pev->point, 0, sizeof(pev->point));
423 ret = find_alternative_probe_point(dinfo, tmp, &pev->point,
424 pev->target, pev->uprobes);
426 memcpy(&pev->point, tmp, sizeof(*tmp));
431 static int get_alternative_line_range(struct debuginfo *dinfo,
432 struct line_range *lr,
433 const char *target, bool user)
435 struct perf_probe_point pp = { .function = lr->function,
438 struct perf_probe_point result;
441 memset(&result, 0, sizeof(result));
443 if (lr->end != INT_MAX)
444 len = lr->end - lr->start;
445 ret = find_alternative_probe_point(dinfo, &pp, &result,
448 lr->function = result.function;
449 lr->file = result.file;
450 lr->start = result.line;
451 if (lr->end != INT_MAX)
452 lr->end = lr->start + len;
453 clear_perf_probe_point(&pp);
458 /* Open new debuginfo of given module */
459 static struct debuginfo *open_debuginfo(const char *module, bool silent)
461 const char *path = module;
462 char reason[STRERR_BUFSIZE];
463 struct debuginfo *ret = NULL;
464 struct dso *dso = NULL;
467 if (!module || !strchr(module, '/')) {
468 err = kernel_get_module_dso(module, &dso);
470 if (!dso || dso->load_errno == 0) {
471 if (!strerror_r(-err, reason, STRERR_BUFSIZE))
472 strcpy(reason, "(unknown)");
474 dso__strerror_load(dso, reason, STRERR_BUFSIZE);
476 pr_err("Failed to find the path for %s: %s\n",
477 module ?: "kernel", reason);
480 path = dso->long_name;
482 ret = debuginfo__new(path);
483 if (!ret && !silent) {
484 pr_warning("The %s file has no debug information.\n", path);
485 if (!module || !strtailcmp(path, ".ko"))
486 pr_warning("Rebuild with CONFIG_DEBUG_INFO=y, ");
488 pr_warning("Rebuild with -g, ");
489 pr_warning("or install an appropriate debuginfo package.\n");
494 /* For caching the last debuginfo */
495 static struct debuginfo *debuginfo_cache;
496 static char *debuginfo_cache_path;
498 static struct debuginfo *debuginfo_cache__open(const char *module, bool silent)
500 const char *path = module;
502 /* If the module is NULL, it should be the kernel. */
506 if (debuginfo_cache_path && !strcmp(debuginfo_cache_path, path))
509 /* Copy module path */
510 free(debuginfo_cache_path);
511 debuginfo_cache_path = strdup(path);
512 if (!debuginfo_cache_path) {
513 debuginfo__delete(debuginfo_cache);
514 debuginfo_cache = NULL;
518 debuginfo_cache = open_debuginfo(module, silent);
519 if (!debuginfo_cache)
520 zfree(&debuginfo_cache_path);
522 return debuginfo_cache;
525 static void debuginfo_cache__exit(void)
527 debuginfo__delete(debuginfo_cache);
528 debuginfo_cache = NULL;
529 zfree(&debuginfo_cache_path);
533 static int get_text_start_address(const char *exec, unsigned long *address)
538 int fd, ret = -ENOENT;
540 fd = open(exec, O_RDONLY);
544 elf = elf_begin(fd, PERF_ELF_C_READ_MMAP, NULL);
550 if (gelf_getehdr(elf, &ehdr) == NULL)
553 if (!elf_section_by_name(elf, &ehdr, &shdr, ".text", NULL))
556 *address = shdr.sh_addr - shdr.sh_offset;
567 * Convert trace point to probe point with debuginfo
569 static int find_perf_probe_point_from_dwarf(struct probe_trace_point *tp,
570 struct perf_probe_point *pp,
573 struct debuginfo *dinfo = NULL;
574 unsigned long stext = 0;
575 u64 addr = tp->address;
578 /* convert the address to dwarf address */
584 ret = get_text_start_address(tp->module, &stext);
588 } else if (tp->symbol) {
589 /* If the module is given, this returns relative address */
590 ret = kernel_get_symbol_address_by_name(tp->symbol, &addr,
591 false, !!tp->module);
597 pr_debug("try to find information at %" PRIx64 " in %s\n", addr,
598 tp->module ? : "kernel");
600 dinfo = debuginfo_cache__open(tp->module, verbose == 0);
602 ret = debuginfo__find_probe_point(dinfo,
603 (unsigned long)addr, pp);
608 pp->retprobe = tp->retprobe;
612 pr_debug("Failed to find corresponding probes from debuginfo.\n");
613 return ret ? : -ENOENT;
616 static int add_exec_to_probe_trace_events(struct probe_trace_event *tevs,
617 int ntevs, const char *exec)
620 unsigned long stext = 0;
625 ret = get_text_start_address(exec, &stext);
629 for (i = 0; i < ntevs && ret >= 0; i++) {
630 /* point.address is the addres of point.symbol + point.offset */
631 tevs[i].point.address -= stext;
632 tevs[i].point.module = strdup(exec);
633 if (!tevs[i].point.module) {
637 tevs[i].uprobes = true;
643 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
644 int ntevs, const char *module)
647 char *mod_name = NULL;
652 mod_name = find_module_name(module);
654 for (i = 0; i < ntevs; i++) {
655 tevs[i].point.module =
656 strdup(mod_name ? mod_name : module);
657 if (!tevs[i].point.module) {
667 /* Post processing the probe events */
668 static int post_process_probe_trace_events(struct probe_trace_event *tevs,
669 int ntevs, const char *module,
672 struct ref_reloc_sym *reloc_sym;
677 return add_exec_to_probe_trace_events(tevs, ntevs, module);
679 /* Note that currently ref_reloc_sym based probe is not for drivers */
681 return add_module_to_probe_trace_events(tevs, ntevs, module);
683 reloc_sym = kernel_get_ref_reloc_sym();
685 pr_warning("Relocated base symbol is not found!\n");
689 for (i = 0; i < ntevs; i++) {
690 if (!tevs[i].point.address || tevs[i].point.retprobe)
692 /* If we found a wrong one, mark it by NULL symbol */
693 if (kprobe_warn_out_range(tevs[i].point.symbol,
694 tevs[i].point.address)) {
698 tmp = strdup(reloc_sym->name);
702 /* If we have no realname, use symbol for it */
703 if (!tevs[i].point.realname)
704 tevs[i].point.realname = tevs[i].point.symbol;
706 free(tevs[i].point.symbol);
707 tevs[i].point.symbol = tmp;
708 tevs[i].point.offset = tevs[i].point.address -
709 reloc_sym->unrelocated_addr;
714 /* Try to find perf_probe_event with debuginfo */
715 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
716 struct probe_trace_event **tevs)
718 bool need_dwarf = perf_probe_event_need_dwarf(pev);
719 struct perf_probe_point tmp;
720 struct debuginfo *dinfo;
723 dinfo = open_debuginfo(pev->target, !need_dwarf);
727 pr_debug("Could not open debuginfo. Try to use symbols.\n");
731 pr_debug("Try to find probe point from debuginfo.\n");
732 /* Searching trace events corresponding to a probe event */
733 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
735 if (ntevs == 0) { /* Not found, retry with an alternative */
736 ret = get_alternative_probe_event(dinfo, pev, &tmp);
738 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs);
740 * Write back to the original probe_event for
741 * setting appropriate (user given) event name
743 clear_perf_probe_point(&pev->point);
744 memcpy(&pev->point, &tmp, sizeof(tmp));
748 debuginfo__delete(dinfo);
750 if (ntevs > 0) { /* Succeeded to find trace events */
751 pr_debug("Found %d probe_trace_events.\n", ntevs);
752 ret = post_process_probe_trace_events(*tevs, ntevs,
753 pev->target, pev->uprobes);
754 if (ret < 0 || ret == ntevs) {
755 clear_probe_trace_events(*tevs, ntevs);
759 return ret < 0 ? ret : ntevs;
764 if (ntevs == 0) { /* No error but failed to find probe point. */
765 pr_warning("Probe point '%s' not found.\n",
766 synthesize_perf_probe_point(&pev->point));
769 /* Error path : ntevs < 0 */
770 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
773 pr_warning("Warning: No dwarf info found in the vmlinux - "
774 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
776 pr_debug("Trying to use symbols.\n");
783 #define LINEBUF_SIZE 256
784 #define NR_ADDITIONAL_LINES 2
786 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
788 char buf[LINEBUF_SIZE], sbuf[STRERR_BUFSIZE];
789 const char *color = show_num ? "" : PERF_COLOR_BLUE;
790 const char *prefix = NULL;
793 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
798 prefix = show_num ? "%7d " : " ";
799 color_fprintf(stdout, color, prefix, l);
801 color_fprintf(stdout, color, "%s", buf);
803 } while (strchr(buf, '\n') == NULL);
808 pr_warning("File read error: %s\n",
809 strerror_r(errno, sbuf, sizeof(sbuf)));
815 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
817 int rv = __show_one_line(fp, l, skip, show_num);
819 pr_warning("Source file is shorter than expected.\n");
825 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
826 #define show_one_line(f,l) _show_one_line(f,l,false,false)
827 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
828 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
831 * Show line-range always requires debuginfo to find source file and
834 static int __show_line_range(struct line_range *lr, const char *module,
839 struct debuginfo *dinfo;
843 char sbuf[STRERR_BUFSIZE];
845 /* Search a line range */
846 dinfo = open_debuginfo(module, false);
850 ret = debuginfo__find_line_range(dinfo, lr);
851 if (!ret) { /* Not found, retry with an alternative */
852 ret = get_alternative_line_range(dinfo, lr, module, user);
854 ret = debuginfo__find_line_range(dinfo, lr);
856 debuginfo__delete(dinfo);
857 if (ret == 0 || ret == -ENOENT) {
858 pr_warning("Specified source line is not found.\n");
860 } else if (ret < 0) {
861 pr_warning("Debuginfo analysis failed.\n");
865 /* Convert source file path */
867 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
869 /* Free old path when new path is assigned */
874 pr_warning("Failed to find source file path.\n");
881 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
882 lr->start - lr->offset);
884 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
886 fp = fopen(lr->path, "r");
888 pr_warning("Failed to open %s: %s\n", lr->path,
889 strerror_r(errno, sbuf, sizeof(sbuf)));
892 /* Skip to starting line number */
893 while (l < lr->start) {
894 ret = skip_one_line(fp, l++);
899 intlist__for_each_entry(ln, lr->line_list) {
900 for (; ln->i > l; l++) {
901 ret = show_one_line(fp, l - lr->offset);
905 ret = show_one_line_with_num(fp, l++ - lr->offset);
910 if (lr->end == INT_MAX)
911 lr->end = l + NR_ADDITIONAL_LINES;
912 while (l <= lr->end) {
913 ret = show_one_line_or_eof(fp, l++ - lr->offset);
922 int show_line_range(struct line_range *lr, const char *module, bool user)
926 ret = init_probe_symbol_maps(user);
929 ret = __show_line_range(lr, module, user);
930 exit_probe_symbol_maps();
935 static int show_available_vars_at(struct debuginfo *dinfo,
936 struct perf_probe_event *pev,
937 struct strfilter *_filter)
941 struct str_node *node;
942 struct variable_list *vls = NULL, *vl;
943 struct perf_probe_point tmp;
946 buf = synthesize_perf_probe_point(&pev->point);
949 pr_debug("Searching variables at %s\n", buf);
951 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls);
952 if (!ret) { /* Not found, retry with an alternative */
953 ret = get_alternative_probe_event(dinfo, pev, &tmp);
955 ret = debuginfo__find_available_vars_at(dinfo, pev,
957 /* Release the old probe_point */
958 clear_perf_probe_point(&tmp);
962 if (ret == 0 || ret == -ENOENT) {
963 pr_err("Failed to find the address of %s\n", buf);
966 pr_warning("Debuginfo analysis failed.\n");
970 /* Some variables are found */
971 fprintf(stdout, "Available variables at %s\n", buf);
972 for (i = 0; i < ret; i++) {
975 * A probe point might be converted to
976 * several trace points.
978 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
980 zfree(&vl->point.symbol);
983 strlist__for_each_entry(node, vl->vars) {
984 var = strchr(node->s, '\t') + 1;
985 if (strfilter__compare(_filter, var)) {
986 fprintf(stdout, "\t\t%s\n", node->s);
990 strlist__delete(vl->vars);
993 fprintf(stdout, "\t\t(No matched variables)\n");
1001 /* Show available variables on given probe point */
1002 int show_available_vars(struct perf_probe_event *pevs, int npevs,
1003 struct strfilter *_filter)
1006 struct debuginfo *dinfo;
1008 ret = init_probe_symbol_maps(pevs->uprobes);
1012 dinfo = open_debuginfo(pevs->target, false);
1020 for (i = 0; i < npevs && ret >= 0; i++)
1021 ret = show_available_vars_at(dinfo, &pevs[i], _filter);
1023 debuginfo__delete(dinfo);
1025 exit_probe_symbol_maps();
1029 #else /* !HAVE_DWARF_SUPPORT */
1031 static void debuginfo_cache__exit(void)
1036 find_perf_probe_point_from_dwarf(struct probe_trace_point *tp __maybe_unused,
1037 struct perf_probe_point *pp __maybe_unused,
1038 bool is_kprobe __maybe_unused)
1043 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
1044 struct probe_trace_event **tevs __maybe_unused)
1046 if (perf_probe_event_need_dwarf(pev)) {
1047 pr_warning("Debuginfo-analysis is not supported.\n");
1054 int show_line_range(struct line_range *lr __maybe_unused,
1055 const char *module __maybe_unused,
1056 bool user __maybe_unused)
1058 pr_warning("Debuginfo-analysis is not supported.\n");
1062 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
1063 int npevs __maybe_unused,
1064 struct strfilter *filter __maybe_unused)
1066 pr_warning("Debuginfo-analysis is not supported.\n");
1071 void line_range__clear(struct line_range *lr)
1077 intlist__delete(lr->line_list);
1078 memset(lr, 0, sizeof(*lr));
1081 int line_range__init(struct line_range *lr)
1083 memset(lr, 0, sizeof(*lr));
1084 lr->line_list = intlist__new(NULL);
1091 static int parse_line_num(char **ptr, int *val, const char *what)
1093 const char *start = *ptr;
1096 *val = strtol(*ptr, ptr, 0);
1097 if (errno || *ptr == start) {
1098 semantic_error("'%s' is not a valid number.\n", what);
1104 /* Check the name is good for event, group or function */
1105 static bool is_c_func_name(const char *name)
1107 if (!isalpha(*name) && *name != '_')
1109 while (*++name != '\0') {
1110 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
1117 * Stuff 'lr' according to the line range described by 'arg'.
1118 * The line range syntax is described by:
1120 * SRC[:SLN[+NUM|-ELN]]
1121 * FNC[@SRC][:SLN[+NUM|-ELN]]
1123 int parse_line_range_desc(const char *arg, struct line_range *lr)
1125 char *range, *file, *name = strdup(arg);
1134 range = strchr(name, ':');
1138 err = parse_line_num(&range, &lr->start, "start line");
1142 if (*range == '+' || *range == '-') {
1143 const char c = *range++;
1145 err = parse_line_num(&range, &lr->end, "end line");
1150 lr->end += lr->start;
1152 * Adjust the number of lines here.
1153 * If the number of lines == 1, the
1154 * the end of line should be equal to
1155 * the start of line.
1161 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
1164 if (lr->start > lr->end) {
1165 semantic_error("Start line must be smaller"
1166 " than end line.\n");
1169 if (*range != '\0') {
1170 semantic_error("Tailing with invalid str '%s'.\n", range);
1175 file = strchr(name, '@');
1178 lr->file = strdup(++file);
1179 if (lr->file == NULL) {
1183 lr->function = name;
1184 } else if (strchr(name, '/') || strchr(name, '.'))
1186 else if (is_c_func_name(name))/* We reuse it for checking funcname */
1187 lr->function = name;
1188 else { /* Invalid name */
1189 semantic_error("'%s' is not a valid function name.\n", name);
1200 /* Parse probepoint definition. */
1201 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
1203 struct perf_probe_point *pp = &pev->point;
1206 bool file_spec = false;
1209 * perf probe [GRP:][EVENT=]SRC[:LN|;PTN]
1210 * perf probe [GRP:][EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
1215 ptr = strpbrk(arg, ";=@+%");
1216 if (ptr && *ptr == '=') { /* Event name */
1219 ptr = strchr(arg, ':');
1222 if (!is_c_func_name(arg))
1224 pev->group = strdup(arg);
1230 if (!is_c_func_name(arg)) {
1232 semantic_error("%s is bad for event name -it must "
1233 "follow C symbol-naming rule.\n", arg);
1236 pev->event = strdup(arg);
1237 if (pev->event == NULL)
1243 * Check arg is function or file name and copy it.
1245 * We consider arg to be a file spec if and only if it satisfies
1246 * all of the below criteria::
1247 * - it does not include any of "+@%",
1248 * - it includes one of ":;", and
1249 * - it has a period '.' in the name.
1251 * Otherwise, we consider arg to be a function specification.
1253 if (!strpbrk(arg, "+@%") && (ptr = strpbrk(arg, ";:")) != NULL) {
1254 /* This is a file spec if it includes a '.' before ; or : */
1255 if (memchr(arg, '.', ptr - arg))
1259 ptr = strpbrk(arg, ";:+@%");
1279 * Keep pp->function even if this is absolute address,
1280 * so it can mark whether abs_address is valid.
1281 * Which make 'perf probe lib.bin 0x0' possible.
1283 * Note that checking length of tmp is not needed
1284 * because when we access tmp[1] we know tmp[0] is '0',
1285 * so tmp[1] should always valid (but could be '\0').
1287 if (tmp && !strncmp(tmp, "0x", 2)) {
1288 pp->abs_address = strtoul(pp->function, &tmp, 0);
1290 semantic_error("Invalid absolute address.\n");
1296 /* Parse other options */
1300 if (c == ';') { /* Lazy pattern must be the last part */
1301 pp->lazy_line = strdup(arg);
1302 if (pp->lazy_line == NULL)
1306 ptr = strpbrk(arg, ";:+@%");
1312 case ':': /* Line number */
1313 pp->line = strtoul(arg, &tmp, 0);
1315 semantic_error("There is non-digit char"
1316 " in line number.\n");
1320 case '+': /* Byte offset from a symbol */
1321 pp->offset = strtoul(arg, &tmp, 0);
1323 semantic_error("There is non-digit character"
1328 case '@': /* File name */
1330 semantic_error("SRC@SRC is not allowed.\n");
1333 pp->file = strdup(arg);
1334 if (pp->file == NULL)
1337 case '%': /* Probe places */
1338 if (strcmp(arg, "return") == 0) {
1340 } else { /* Others not supported yet */
1341 semantic_error("%%%s is not supported.\n", arg);
1345 default: /* Buggy case */
1346 pr_err("This program has a bug at %s:%d.\n",
1347 __FILE__, __LINE__);
1353 /* Exclusion check */
1354 if (pp->lazy_line && pp->line) {
1355 semantic_error("Lazy pattern can't be used with"
1360 if (pp->lazy_line && pp->offset) {
1361 semantic_error("Lazy pattern can't be used with offset.\n");
1365 if (pp->line && pp->offset) {
1366 semantic_error("Offset can't be used with line number.\n");
1370 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
1371 semantic_error("File always requires line number or "
1376 if (pp->offset && !pp->function) {
1377 semantic_error("Offset requires an entry function.\n");
1381 if (pp->retprobe && !pp->function) {
1382 semantic_error("Return probe requires an entry function.\n");
1386 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
1387 semantic_error("Offset/Line/Lazy pattern can't be used with "
1392 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
1393 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
1398 /* Parse perf-probe event argument */
1399 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
1401 char *tmp, *goodname;
1402 struct perf_probe_arg_field **fieldp;
1404 pr_debug("parsing arg: %s into ", str);
1406 tmp = strchr(str, '=');
1408 arg->name = strndup(str, tmp - str);
1409 if (arg->name == NULL)
1411 pr_debug("name:%s ", arg->name);
1415 tmp = strchr(str, ':');
1416 if (tmp) { /* Type setting */
1418 arg->type = strdup(tmp + 1);
1419 if (arg->type == NULL)
1421 pr_debug("type:%s ", arg->type);
1424 tmp = strpbrk(str, "-.[");
1425 if (!is_c_varname(str) || !tmp) {
1426 /* A variable, register, symbol or special value */
1427 arg->var = strdup(str);
1428 if (arg->var == NULL)
1430 pr_debug("%s\n", arg->var);
1434 /* Structure fields or array element */
1435 arg->var = strndup(str, tmp - str);
1436 if (arg->var == NULL)
1438 goodname = arg->var;
1439 pr_debug("%s, ", arg->var);
1440 fieldp = &arg->field;
1443 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
1444 if (*fieldp == NULL)
1446 if (*tmp == '[') { /* Array */
1448 (*fieldp)->index = strtol(str + 1, &tmp, 0);
1449 (*fieldp)->ref = true;
1450 if (*tmp != ']' || tmp == str + 1) {
1451 semantic_error("Array index must be a"
1458 } else { /* Structure */
1461 (*fieldp)->ref = false;
1462 } else if (tmp[1] == '>') {
1464 (*fieldp)->ref = true;
1466 semantic_error("Argument parse error: %s\n",
1470 tmp = strpbrk(str, "-.[");
1473 (*fieldp)->name = strndup(str, tmp - str);
1474 if ((*fieldp)->name == NULL)
1477 goodname = (*fieldp)->name;
1478 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1479 fieldp = &(*fieldp)->next;
1482 (*fieldp)->name = strdup(str);
1483 if ((*fieldp)->name == NULL)
1486 goodname = (*fieldp)->name;
1487 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1489 /* If no name is specified, set the last field name (not array index)*/
1491 arg->name = strdup(goodname);
1492 if (arg->name == NULL)
1498 /* Parse perf-probe event command */
1499 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1502 int argc, i, ret = 0;
1504 argv = argv_split(cmd, &argc);
1506 pr_debug("Failed to split arguments.\n");
1509 if (argc - 1 > MAX_PROBE_ARGS) {
1510 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1514 /* Parse probe point */
1515 ret = parse_perf_probe_point(argv[0], pev);
1519 /* Copy arguments and ensure return probe has no C argument */
1520 pev->nargs = argc - 1;
1521 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1522 if (pev->args == NULL) {
1526 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1527 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1529 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1530 semantic_error("You can't specify local variable for"
1541 /* Return true if this perf_probe_event requires debuginfo */
1542 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1546 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1549 for (i = 0; i < pev->nargs; i++)
1550 if (is_c_varname(pev->args[i].var))
1556 /* Parse probe_events event into struct probe_point */
1557 int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev)
1559 struct probe_trace_point *tp = &tev->point;
1562 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1566 pr_debug("Parsing probe_events: %s\n", cmd);
1567 argv = argv_split(cmd, &argc);
1569 pr_debug("Failed to split arguments.\n");
1573 semantic_error("Too few probe arguments.\n");
1578 /* Scan event and group name. */
1579 argv0_str = strdup(argv[0]);
1580 if (argv0_str == NULL) {
1584 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1585 fmt2_str = strtok_r(NULL, "/", &fmt);
1586 fmt3_str = strtok_r(NULL, " \t", &fmt);
1587 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1588 || fmt3_str == NULL) {
1589 semantic_error("Failed to parse event name: %s\n", argv[0]);
1594 tev->group = strdup(fmt2_str);
1595 tev->event = strdup(fmt3_str);
1596 if (tev->group == NULL || tev->event == NULL) {
1600 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1602 tp->retprobe = (pr == 'r');
1604 /* Scan module name(if there), function name and offset */
1605 p = strchr(argv[1], ':');
1607 tp->module = strndup(argv[1], p - argv[1]);
1615 fmt1_str = strtok_r(p, "+", &fmt);
1616 /* only the address started with 0x */
1617 if (fmt1_str[0] == '0') {
1619 * Fix a special case:
1620 * if address == 0, kernel reports something like:
1621 * p:probe_libc/abs_0 /lib/libc-2.18.so:0x (null) arg1=%ax
1622 * Newer kernel may fix that, but we want to
1623 * support old kernel also.
1625 if (strcmp(fmt1_str, "0x") == 0) {
1626 if (!argv[2] || strcmp(argv[2], "(null)")) {
1633 for (i = 2; argv[i + 1] != NULL; i++)
1634 argv[i] = argv[i + 1];
1639 tp->address = strtoul(fmt1_str, NULL, 0);
1641 /* Only the symbol-based probe has offset */
1642 tp->symbol = strdup(fmt1_str);
1643 if (tp->symbol == NULL) {
1647 fmt2_str = strtok_r(NULL, "", &fmt);
1648 if (fmt2_str == NULL)
1651 tp->offset = strtoul(fmt2_str, NULL, 10);
1654 tev->nargs = argc - 2;
1655 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1656 if (tev->args == NULL) {
1660 for (i = 0; i < tev->nargs; i++) {
1661 p = strchr(argv[i + 2], '=');
1662 if (p) /* We don't need which register is assigned. */
1666 tev->args[i].name = strdup(argv[i + 2]);
1667 /* TODO: parse regs and offset */
1668 tev->args[i].value = strdup(p);
1669 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1681 /* Compose only probe arg */
1682 char *synthesize_perf_probe_arg(struct perf_probe_arg *pa)
1684 struct perf_probe_arg_field *field = pa->field;
1689 if (strbuf_init(&buf, 64) < 0)
1692 if (pa->name && pa->var)
1693 err = strbuf_addf(&buf, "%s=%s", pa->name, pa->var);
1695 err = strbuf_addstr(&buf, pa->name ?: pa->var);
1700 if (field->name[0] == '[')
1701 err = strbuf_addstr(&buf, field->name);
1703 err = strbuf_addf(&buf, "%s%s", field->ref ? "->" : ".",
1705 field = field->next;
1711 if (strbuf_addf(&buf, ":%s", pa->type) < 0)
1714 ret = strbuf_detach(&buf, NULL);
1716 strbuf_release(&buf);
1720 /* Compose only probe point (not argument) */
1721 char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1724 char *tmp, *ret = NULL;
1727 if (strbuf_init(&buf, 64) < 0)
1731 if (strbuf_addstr(&buf, pp->function) < 0)
1734 err = strbuf_addf(&buf, "+%lu", pp->offset);
1736 err = strbuf_addf(&buf, ":%d", pp->line);
1737 else if (pp->retprobe)
1738 err = strbuf_addstr(&buf, "%return");
1746 tmp = strchr(pp->file + len - 30, '/');
1747 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1749 err = strbuf_addf(&buf, "@%s", tmp);
1750 if (!err && !pp->function && pp->line)
1751 err = strbuf_addf(&buf, ":%d", pp->line);
1754 ret = strbuf_detach(&buf, NULL);
1756 strbuf_release(&buf);
1760 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1763 char *tmp, *ret = NULL;
1766 if (strbuf_init(&buf, 64))
1769 if (strbuf_addf(&buf, "%s:%s=", pev->group ?: PERFPROBE_GROUP,
1773 tmp = synthesize_perf_probe_point(&pev->point);
1774 if (!tmp || strbuf_addstr(&buf, tmp) < 0)
1778 for (i = 0; i < pev->nargs; i++) {
1779 tmp = synthesize_perf_probe_arg(pev->args + i);
1780 if (!tmp || strbuf_addf(&buf, " %s", tmp) < 0)
1785 ret = strbuf_detach(&buf, NULL);
1787 strbuf_release(&buf);
1791 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1792 struct strbuf *buf, int depth)
1796 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1801 err = strbuf_addf(buf, "%+ld(", ref->offset);
1802 return (err < 0) ? err : depth;
1805 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1808 struct probe_trace_arg_ref *ref = arg->ref;
1811 /* Argument name or separator */
1813 err = strbuf_addf(buf, " %s=", arg->name);
1815 err = strbuf_addch(buf, ' ');
1819 /* Special case: @XXX */
1820 if (arg->value[0] == '@' && arg->ref)
1823 /* Dereferencing arguments */
1825 depth = __synthesize_probe_trace_arg_ref(ref, buf, 1);
1830 /* Print argument value */
1831 if (arg->value[0] == '@' && arg->ref)
1832 err = strbuf_addf(buf, "%s%+ld", arg->value, arg->ref->offset);
1834 err = strbuf_addstr(buf, arg->value);
1837 while (!err && depth--)
1838 err = strbuf_addch(buf, ')');
1840 /* Print argument type */
1841 if (!err && arg->type)
1842 err = strbuf_addf(buf, ":%s", arg->type);
1847 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1849 struct probe_trace_point *tp = &tev->point;
1854 /* Uprobes must have tp->module */
1855 if (tev->uprobes && !tp->module)
1858 if (strbuf_init(&buf, 32) < 0)
1861 if (strbuf_addf(&buf, "%c:%s/%s ", tp->retprobe ? 'r' : 'p',
1862 tev->group, tev->event) < 0)
1865 * If tp->address == 0, then this point must be a
1866 * absolute address uprobe.
1867 * try_to_find_absolute_address() should have made
1868 * tp->symbol to "0x0".
1870 if (tev->uprobes && !tp->address) {
1871 if (!tp->symbol || strcmp(tp->symbol, "0x0"))
1875 /* Use the tp->address for uprobes */
1877 err = strbuf_addf(&buf, "%s:0x%lx", tp->module, tp->address);
1878 else if (!strncmp(tp->symbol, "0x", 2))
1879 /* Absolute address. See try_to_find_absolute_address() */
1880 err = strbuf_addf(&buf, "%s%s0x%lx", tp->module ?: "",
1881 tp->module ? ":" : "", tp->address);
1883 err = strbuf_addf(&buf, "%s%s%s+%lu", tp->module ?: "",
1884 tp->module ? ":" : "", tp->symbol, tp->offset);
1888 for (i = 0; i < tev->nargs; i++)
1889 if (synthesize_probe_trace_arg(&tev->args[i], &buf) < 0)
1892 ret = strbuf_detach(&buf, NULL);
1894 strbuf_release(&buf);
1898 static int find_perf_probe_point_from_map(struct probe_trace_point *tp,
1899 struct perf_probe_point *pp,
1902 struct symbol *sym = NULL;
1904 u64 addr = tp->address;
1908 map = dso__new_map(tp->module);
1911 sym = map__find_symbol(map, addr, NULL);
1913 if (tp->symbol && !addr) {
1914 if (kernel_get_symbol_address_by_name(tp->symbol,
1915 &addr, true, false) < 0)
1920 sym = __find_kernel_function(addr, &map);
1927 pp->retprobe = tp->retprobe;
1928 pp->offset = addr - map->unmap_ip(map, sym->start);
1929 pp->function = strdup(sym->name);
1930 ret = pp->function ? 0 : -ENOMEM;
1933 if (map && !is_kprobe) {
1940 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
1941 struct perf_probe_point *pp,
1947 ret = find_perf_probe_point_from_dwarf(tp, pp, is_kprobe);
1950 ret = find_perf_probe_point_from_map(tp, pp, is_kprobe);
1954 pr_debug("Failed to find probe point from both of dwarf and map.\n");
1957 pp->function = strdup(tp->symbol);
1958 pp->offset = tp->offset;
1960 ret = e_snprintf(buf, 128, "0x%" PRIx64, (u64)tp->address);
1963 pp->function = strdup(buf);
1966 if (pp->function == NULL)
1969 pp->retprobe = tp->retprobe;
1974 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1975 struct perf_probe_event *pev, bool is_kprobe)
1977 struct strbuf buf = STRBUF_INIT;
1980 /* Convert event/group name */
1981 pev->event = strdup(tev->event);
1982 pev->group = strdup(tev->group);
1983 if (pev->event == NULL || pev->group == NULL)
1986 /* Convert trace_point to probe_point */
1987 ret = convert_to_perf_probe_point(&tev->point, &pev->point, is_kprobe);
1991 /* Convert trace_arg to probe_arg */
1992 pev->nargs = tev->nargs;
1993 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1994 if (pev->args == NULL)
1996 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1997 if (tev->args[i].name)
1998 pev->args[i].name = strdup(tev->args[i].name);
2000 if ((ret = strbuf_init(&buf, 32)) < 0)
2002 ret = synthesize_probe_trace_arg(&tev->args[i], &buf);
2003 pev->args[i].name = strbuf_detach(&buf, NULL);
2005 if (pev->args[i].name == NULL && ret >= 0)
2010 clear_perf_probe_event(pev);
2015 void clear_perf_probe_event(struct perf_probe_event *pev)
2017 struct perf_probe_arg_field *field, *next;
2023 clear_perf_probe_point(&pev->point);
2025 for (i = 0; i < pev->nargs; i++) {
2026 free(pev->args[i].name);
2027 free(pev->args[i].var);
2028 free(pev->args[i].type);
2029 field = pev->args[i].field;
2032 zfree(&field->name);
2038 memset(pev, 0, sizeof(*pev));
2041 #define strdup_or_goto(str, label) \
2042 ({ char *__p = NULL; if (str && !(__p = strdup(str))) goto label; __p; })
2044 static int perf_probe_point__copy(struct perf_probe_point *dst,
2045 struct perf_probe_point *src)
2047 dst->file = strdup_or_goto(src->file, out_err);
2048 dst->function = strdup_or_goto(src->function, out_err);
2049 dst->lazy_line = strdup_or_goto(src->lazy_line, out_err);
2050 dst->line = src->line;
2051 dst->retprobe = src->retprobe;
2052 dst->offset = src->offset;
2056 clear_perf_probe_point(dst);
2060 static int perf_probe_arg__copy(struct perf_probe_arg *dst,
2061 struct perf_probe_arg *src)
2063 struct perf_probe_arg_field *field, **ppfield;
2065 dst->name = strdup_or_goto(src->name, out_err);
2066 dst->var = strdup_or_goto(src->var, out_err);
2067 dst->type = strdup_or_goto(src->type, out_err);
2070 ppfield = &(dst->field);
2072 *ppfield = zalloc(sizeof(*field));
2075 (*ppfield)->name = strdup_or_goto(field->name, out_err);
2076 (*ppfield)->index = field->index;
2077 (*ppfield)->ref = field->ref;
2078 field = field->next;
2079 ppfield = &((*ppfield)->next);
2086 int perf_probe_event__copy(struct perf_probe_event *dst,
2087 struct perf_probe_event *src)
2091 dst->event = strdup_or_goto(src->event, out_err);
2092 dst->group = strdup_or_goto(src->group, out_err);
2093 dst->target = strdup_or_goto(src->target, out_err);
2094 dst->uprobes = src->uprobes;
2096 if (perf_probe_point__copy(&dst->point, &src->point) < 0)
2099 dst->args = zalloc(sizeof(struct perf_probe_arg) * src->nargs);
2102 dst->nargs = src->nargs;
2104 for (i = 0; i < src->nargs; i++)
2105 if (perf_probe_arg__copy(&dst->args[i], &src->args[i]) < 0)
2110 clear_perf_probe_event(dst);
2114 void clear_probe_trace_event(struct probe_trace_event *tev)
2116 struct probe_trace_arg_ref *ref, *next;
2121 free(tev->point.symbol);
2122 free(tev->point.realname);
2123 free(tev->point.module);
2124 for (i = 0; i < tev->nargs; i++) {
2125 free(tev->args[i].name);
2126 free(tev->args[i].value);
2127 free(tev->args[i].type);
2128 ref = tev->args[i].ref;
2136 memset(tev, 0, sizeof(*tev));
2139 struct kprobe_blacklist_node {
2140 struct list_head list;
2141 unsigned long start;
2146 static void kprobe_blacklist__delete(struct list_head *blacklist)
2148 struct kprobe_blacklist_node *node;
2150 while (!list_empty(blacklist)) {
2151 node = list_first_entry(blacklist,
2152 struct kprobe_blacklist_node, list);
2153 list_del(&node->list);
2159 static int kprobe_blacklist__load(struct list_head *blacklist)
2161 struct kprobe_blacklist_node *node;
2162 const char *__debugfs = debugfs__mountpoint();
2163 char buf[PATH_MAX], *p;
2167 if (__debugfs == NULL)
2170 ret = e_snprintf(buf, PATH_MAX, "%s/kprobes/blacklist", __debugfs);
2174 fp = fopen(buf, "r");
2179 while (fgets(buf, PATH_MAX, fp)) {
2180 node = zalloc(sizeof(*node));
2185 INIT_LIST_HEAD(&node->list);
2186 list_add_tail(&node->list, blacklist);
2187 if (sscanf(buf, "0x%lx-0x%lx", &node->start, &node->end) != 2) {
2191 p = strchr(buf, '\t');
2194 if (p[strlen(p) - 1] == '\n')
2195 p[strlen(p) - 1] = '\0';
2197 p = (char *)"unknown";
2198 node->symbol = strdup(p);
2199 if (!node->symbol) {
2203 pr_debug2("Blacklist: 0x%lx-0x%lx, %s\n",
2204 node->start, node->end, node->symbol);
2208 kprobe_blacklist__delete(blacklist);
2214 static struct kprobe_blacklist_node *
2215 kprobe_blacklist__find_by_address(struct list_head *blacklist,
2216 unsigned long address)
2218 struct kprobe_blacklist_node *node;
2220 list_for_each_entry(node, blacklist, list) {
2221 if (node->start <= address && address <= node->end)
2228 static LIST_HEAD(kprobe_blacklist);
2230 static void kprobe_blacklist__init(void)
2232 if (!list_empty(&kprobe_blacklist))
2235 if (kprobe_blacklist__load(&kprobe_blacklist) < 0)
2236 pr_debug("No kprobe blacklist support, ignored\n");
2239 static void kprobe_blacklist__release(void)
2241 kprobe_blacklist__delete(&kprobe_blacklist);
2244 static bool kprobe_blacklist__listed(unsigned long address)
2246 return !!kprobe_blacklist__find_by_address(&kprobe_blacklist, address);
2249 static int perf_probe_event__sprintf(const char *group, const char *event,
2250 struct perf_probe_event *pev,
2252 struct strbuf *result)
2257 if (asprintf(&buf, "%s:%s", group, event) < 0)
2259 ret = strbuf_addf(result, " %-20s (on ", buf);
2264 /* Synthesize only event probe point */
2265 buf = synthesize_perf_probe_point(&pev->point);
2268 ret = strbuf_addstr(result, buf);
2272 ret = strbuf_addf(result, " in %s", module);
2274 if (!ret && pev->nargs > 0) {
2275 ret = strbuf_add(result, " with", 5);
2276 for (i = 0; !ret && i < pev->nargs; i++) {
2277 buf = synthesize_perf_probe_arg(&pev->args[i]);
2280 ret = strbuf_addf(result, " %s", buf);
2285 ret = strbuf_addch(result, ')');
2291 int show_perf_probe_event(const char *group, const char *event,
2292 struct perf_probe_event *pev,
2293 const char *module, bool use_stdout)
2295 struct strbuf buf = STRBUF_INIT;
2298 ret = perf_probe_event__sprintf(group, event, pev, module, &buf);
2301 printf("%s\n", buf.buf);
2303 pr_info("%s\n", buf.buf);
2305 strbuf_release(&buf);
2310 static bool filter_probe_trace_event(struct probe_trace_event *tev,
2311 struct strfilter *filter)
2315 /* At first, check the event name itself */
2316 if (strfilter__compare(filter, tev->event))
2319 /* Next, check the combination of name and group */
2320 if (e_snprintf(tmp, 128, "%s:%s", tev->group, tev->event) < 0)
2322 return strfilter__compare(filter, tmp);
2325 static int __show_perf_probe_events(int fd, bool is_kprobe,
2326 struct strfilter *filter)
2329 struct probe_trace_event tev;
2330 struct perf_probe_event pev;
2331 struct strlist *rawlist;
2332 struct str_node *ent;
2334 memset(&tev, 0, sizeof(tev));
2335 memset(&pev, 0, sizeof(pev));
2337 rawlist = probe_file__get_rawlist(fd);
2341 strlist__for_each_entry(ent, rawlist) {
2342 ret = parse_probe_trace_command(ent->s, &tev);
2344 if (!filter_probe_trace_event(&tev, filter))
2346 ret = convert_to_perf_probe_event(&tev, &pev,
2350 ret = show_perf_probe_event(pev.group, pev.event,
2351 &pev, tev.point.module,
2355 clear_perf_probe_event(&pev);
2356 clear_probe_trace_event(&tev);
2360 strlist__delete(rawlist);
2361 /* Cleanup cached debuginfo if needed */
2362 debuginfo_cache__exit();
2367 /* List up current perf-probe events */
2368 int show_perf_probe_events(struct strfilter *filter)
2370 int kp_fd, up_fd, ret;
2374 if (probe_conf.cache)
2375 return probe_cache__show_all_caches(filter);
2377 ret = init_probe_symbol_maps(false);
2381 ret = probe_file__open_both(&kp_fd, &up_fd, 0);
2386 ret = __show_perf_probe_events(kp_fd, true, filter);
2387 if (up_fd >= 0 && ret >= 0)
2388 ret = __show_perf_probe_events(up_fd, false, filter);
2393 exit_probe_symbol_maps();
2398 static int get_new_event_name(char *buf, size_t len, const char *base,
2399 struct strlist *namelist, bool allow_suffix)
2406 nbase = strdup(base);
2410 /* Cut off the dot suffixes (e.g. .const, .isra)*/
2411 p = strchr(nbase, '.');
2412 if (p && p != nbase)
2415 /* Try no suffix number */
2416 ret = e_snprintf(buf, len, "%s", nbase);
2418 pr_debug("snprintf() failed: %d\n", ret);
2421 if (!strlist__has_entry(namelist, buf))
2424 if (!allow_suffix) {
2425 pr_warning("Error: event \"%s\" already exists.\n"
2426 " Hint: Remove existing event by 'perf probe -d'\n"
2427 " or force duplicates by 'perf probe -f'\n"
2428 " or set 'force=yes' in BPF source.\n",
2434 /* Try to add suffix */
2435 for (i = 1; i < MAX_EVENT_INDEX; i++) {
2436 ret = e_snprintf(buf, len, "%s_%d", nbase, i);
2438 pr_debug("snprintf() failed: %d\n", ret);
2441 if (!strlist__has_entry(namelist, buf))
2444 if (i == MAX_EVENT_INDEX) {
2445 pr_warning("Too many events are on the same function.\n");
2454 /* Warn if the current kernel's uprobe implementation is old */
2455 static void warn_uprobe_event_compat(struct probe_trace_event *tev)
2458 char *buf = synthesize_probe_trace_command(tev);
2460 /* Old uprobe event doesn't support memory dereference */
2461 if (!tev->uprobes || tev->nargs == 0 || !buf)
2464 for (i = 0; i < tev->nargs; i++)
2465 if (strglobmatch(tev->args[i].value, "[$@+-]*")) {
2466 pr_warning("Please upgrade your kernel to at least "
2467 "3.14 to have access to feature %s\n",
2468 tev->args[i].value);
2475 /* Set new name from original perf_probe_event and namelist */
2476 static int probe_trace_event__set_name(struct probe_trace_event *tev,
2477 struct perf_probe_event *pev,
2478 struct strlist *namelist,
2481 const char *event, *group;
2485 /* If probe_event or trace_event already have the name, reuse it */
2488 else if (tev->event)
2491 /* Or generate new one from probe point */
2492 if (pev->point.function &&
2493 (strncmp(pev->point.function, "0x", 2) != 0) &&
2494 !strisglob(pev->point.function))
2495 event = pev->point.function;
2497 event = tev->point.realname;
2501 else if (tev->group)
2504 group = PERFPROBE_GROUP;
2506 /* Get an unused new event name */
2507 ret = get_new_event_name(buf, 64, event,
2508 namelist, allow_suffix);
2514 tev->event = strdup(event);
2515 tev->group = strdup(group);
2516 if (tev->event == NULL || tev->group == NULL)
2519 /* Add added event name to namelist */
2520 strlist__add(namelist, event);
2524 static int __add_probe_trace_events(struct perf_probe_event *pev,
2525 struct probe_trace_event *tevs,
2526 int ntevs, bool allow_suffix)
2529 struct probe_trace_event *tev = NULL;
2530 struct probe_cache *cache = NULL;
2531 struct strlist *namelist;
2533 fd = probe_file__open(PF_FL_RW | (pev->uprobes ? PF_FL_UPROBE : 0));
2537 /* Get current event names */
2538 namelist = probe_file__get_namelist(fd);
2540 pr_debug("Failed to get current event list.\n");
2546 for (i = 0; i < ntevs; i++) {
2548 /* Skip if the symbol is out of .text or blacklisted */
2549 if (!tev->point.symbol && !pev->uprobes)
2552 /* Set new name for tev (and update namelist) */
2553 ret = probe_trace_event__set_name(tev, pev, namelist,
2558 ret = probe_file__add_event(fd, tev);
2563 * Probes after the first probe which comes from same
2564 * user input are always allowed to add suffix, because
2565 * there might be several addresses corresponding to
2568 allow_suffix = true;
2570 if (ret == -EINVAL && pev->uprobes)
2571 warn_uprobe_event_compat(tev);
2572 if (ret == 0 && probe_conf.cache) {
2573 cache = probe_cache__new(pev->target);
2575 probe_cache__add_entry(cache, pev, tevs, ntevs) < 0 ||
2576 probe_cache__commit(cache) < 0)
2577 pr_warning("Failed to add event to probe cache\n");
2578 probe_cache__delete(cache);
2581 strlist__delete(namelist);
2587 static int find_probe_functions(struct map *map, char *name,
2588 struct symbol **syms)
2592 struct rb_node *tmp;
2594 if (map__load(map, NULL) < 0)
2597 map__for_each_symbol(map, sym, tmp) {
2598 if (strglobmatch(sym->name, name)) {
2600 if (syms && found < probe_conf.max_probes)
2601 syms[found - 1] = sym;
2608 void __weak arch__fix_tev_from_maps(struct perf_probe_event *pev __maybe_unused,
2609 struct probe_trace_event *tev __maybe_unused,
2610 struct map *map __maybe_unused,
2611 struct symbol *sym __maybe_unused) { }
2614 * Find probe function addresses from map.
2615 * Return an error or the number of found probe_trace_event
2617 static int find_probe_trace_events_from_map(struct perf_probe_event *pev,
2618 struct probe_trace_event **tevs)
2620 struct map *map = NULL;
2621 struct ref_reloc_sym *reloc_sym = NULL;
2623 struct symbol **syms = NULL;
2624 struct probe_trace_event *tev;
2625 struct perf_probe_point *pp = &pev->point;
2626 struct probe_trace_point *tp;
2627 int num_matched_functions;
2628 int ret, i, j, skipped = 0;
2631 map = get_target_map(pev->target, pev->uprobes);
2637 syms = malloc(sizeof(struct symbol *) * probe_conf.max_probes);
2644 * Load matched symbols: Since the different local symbols may have
2645 * same name but different addresses, this lists all the symbols.
2647 num_matched_functions = find_probe_functions(map, pp->function, syms);
2648 if (num_matched_functions == 0) {
2649 pr_err("Failed to find symbol %s in %s\n", pp->function,
2650 pev->target ? : "kernel");
2653 } else if (num_matched_functions > probe_conf.max_probes) {
2654 pr_err("Too many functions matched in %s\n",
2655 pev->target ? : "kernel");
2660 /* Note that the symbols in the kmodule are not relocated */
2661 if (!pev->uprobes && !pp->retprobe && !pev->target) {
2662 reloc_sym = kernel_get_ref_reloc_sym();
2664 pr_warning("Relocated base symbol is not found!\n");
2670 /* Setup result trace-probe-events */
2671 *tevs = zalloc(sizeof(*tev) * num_matched_functions);
2679 for (j = 0; j < num_matched_functions; j++) {
2682 tev = (*tevs) + ret;
2684 if (ret == num_matched_functions) {
2685 pr_warning("Too many symbols are listed. Skip it.\n");
2690 if (pp->offset > sym->end - sym->start) {
2691 pr_warning("Offset %ld is bigger than the size of %s\n",
2692 pp->offset, sym->name);
2696 /* Add one probe point */
2697 tp->address = map->unmap_ip(map, sym->start) + pp->offset;
2699 /* Check the kprobe (not in module) is within .text */
2700 if (!pev->uprobes && !pev->target &&
2701 kprobe_warn_out_range(sym->name, tp->address)) {
2702 tp->symbol = NULL; /* Skip it */
2704 } else if (reloc_sym) {
2705 tp->symbol = strdup_or_goto(reloc_sym->name, nomem_out);
2706 tp->offset = tp->address - reloc_sym->addr;
2708 tp->symbol = strdup_or_goto(sym->name, nomem_out);
2709 tp->offset = pp->offset;
2711 tp->realname = strdup_or_goto(sym->name, nomem_out);
2713 tp->retprobe = pp->retprobe;
2716 tev->point.module = strdup_or_goto(pev->target,
2719 mod_name = find_module_name(pev->target);
2721 strdup(mod_name ? mod_name : pev->target);
2723 if (!tev->point.module)
2727 tev->uprobes = pev->uprobes;
2728 tev->nargs = pev->nargs;
2730 tev->args = zalloc(sizeof(struct probe_trace_arg) *
2732 if (tev->args == NULL)
2735 for (i = 0; i < tev->nargs; i++) {
2736 if (pev->args[i].name)
2738 strdup_or_goto(pev->args[i].name,
2741 tev->args[i].value = strdup_or_goto(pev->args[i].var,
2743 if (pev->args[i].type)
2745 strdup_or_goto(pev->args[i].type,
2748 arch__fix_tev_from_maps(pev, tev, map, sym);
2750 if (ret == skipped) {
2756 put_target_map(map, pev->uprobes);
2763 clear_probe_trace_events(*tevs, num_matched_functions);
2768 static int try_to_find_absolute_address(struct perf_probe_event *pev,
2769 struct probe_trace_event **tevs)
2771 struct perf_probe_point *pp = &pev->point;
2772 struct probe_trace_event *tev;
2773 struct probe_trace_point *tp;
2776 if (!(pev->point.function && !strncmp(pev->point.function, "0x", 2)))
2778 if (perf_probe_event_need_dwarf(pev))
2782 * This is 'perf probe /lib/libc.so 0xabcd'. Try to probe at
2785 * Only one tev can be generated by this.
2787 *tevs = zalloc(sizeof(*tev));
2795 * Don't use tp->offset, use address directly, because
2796 * in synthesize_probe_trace_command() address cannot be
2799 tp->address = pev->point.abs_address;
2800 tp->retprobe = pp->retprobe;
2801 tev->uprobes = pev->uprobes;
2805 * Give it a '0x' leading symbol name.
2806 * In __add_probe_trace_events, a NULL symbol is interpreted as
2809 if (asprintf(&tp->symbol, "0x%lx", tp->address) < 0)
2812 /* For kprobe, check range */
2813 if ((!tev->uprobes) &&
2814 (kprobe_warn_out_range(tev->point.symbol,
2815 tev->point.address))) {
2820 if (asprintf(&tp->realname, "abs_%lx", tp->address) < 0)
2824 tp->module = strdup(pev->target);
2830 tev->group = strdup(pev->group);
2836 tev->event = strdup(pev->event);
2841 tev->nargs = pev->nargs;
2842 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
2847 for (i = 0; i < tev->nargs; i++)
2848 copy_to_probe_trace_arg(&tev->args[i], &pev->args[i]);
2854 clear_probe_trace_events(*tevs, 1);
2860 bool __weak arch__prefers_symtab(void) { return false; }
2862 static int find_probe_trace_events_from_cache(struct perf_probe_event *pev,
2863 struct probe_trace_event **tevs)
2865 struct probe_cache *cache;
2866 struct probe_cache_entry *entry;
2867 struct probe_trace_event *tev;
2868 struct str_node *node;
2871 cache = probe_cache__new(pev->target);
2875 entry = probe_cache__find(cache, pev);
2881 ret = strlist__nr_entries(entry->tevlist);
2882 if (ret > probe_conf.max_probes) {
2883 pr_debug("Too many entries matched in the cache of %s\n",
2884 pev->target ? : "kernel");
2889 *tevs = zalloc(ret * sizeof(*tev));
2896 strlist__for_each_entry(node, entry->tevlist) {
2897 tev = &(*tevs)[i++];
2898 ret = parse_probe_trace_command(node->s, tev);
2901 /* Set the uprobes attribute as same as original */
2902 tev->uprobes = pev->uprobes;
2907 probe_cache__delete(cache);
2911 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
2912 struct probe_trace_event **tevs)
2917 /* Set group name if not given */
2918 if (!pev->uprobes) {
2919 pev->group = strdup(PERFPROBE_GROUP);
2920 ret = pev->group ? 0 : -ENOMEM;
2922 ret = convert_exec_to_group(pev->target, &pev->group);
2924 pr_warning("Failed to make a group name.\n");
2929 ret = try_to_find_absolute_address(pev, tevs);
2933 /* At first, we need to lookup cache entry */
2934 ret = find_probe_trace_events_from_cache(pev, tevs);
2936 return ret; /* Found in probe cache */
2938 if (arch__prefers_symtab() && !perf_probe_event_need_dwarf(pev)) {
2939 ret = find_probe_trace_events_from_map(pev, tevs);
2941 return ret; /* Found in symbol table */
2944 /* Convert perf_probe_event with debuginfo */
2945 ret = try_to_find_probe_trace_events(pev, tevs);
2947 return ret; /* Found in debuginfo or got an error */
2949 return find_probe_trace_events_from_map(pev, tevs);
2952 int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2956 /* Loop 1: convert all events */
2957 for (i = 0; i < npevs; i++) {
2958 /* Init kprobe blacklist if needed */
2959 if (!pevs[i].uprobes)
2960 kprobe_blacklist__init();
2961 /* Convert with or without debuginfo */
2962 ret = convert_to_probe_trace_events(&pevs[i], &pevs[i].tevs);
2965 pevs[i].ntevs = ret;
2967 /* This just release blacklist only if allocated */
2968 kprobe_blacklist__release();
2973 int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2977 /* Loop 2: add all events */
2978 for (i = 0; i < npevs; i++) {
2979 ret = __add_probe_trace_events(&pevs[i], pevs[i].tevs,
2981 probe_conf.force_add);
2988 void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs)
2992 /* Loop 3: cleanup and free trace events */
2993 for (i = 0; i < npevs; i++) {
2994 for (j = 0; j < pevs[i].ntevs; j++)
2995 clear_probe_trace_event(&pevs[i].tevs[j]);
2996 zfree(&pevs[i].tevs);
2998 clear_perf_probe_event(&pevs[i]);
3002 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs)
3006 ret = init_probe_symbol_maps(pevs->uprobes);
3010 ret = convert_perf_probe_events(pevs, npevs);
3012 ret = apply_perf_probe_events(pevs, npevs);
3014 cleanup_perf_probe_events(pevs, npevs);
3016 exit_probe_symbol_maps();
3020 int del_perf_probe_events(struct strfilter *filter)
3022 int ret, ret2, ufd = -1, kfd = -1;
3023 char *str = strfilter__string(filter);
3028 /* Get current event names */
3029 ret = probe_file__open_both(&kfd, &ufd, PF_FL_RW);
3033 ret = probe_file__del_events(kfd, filter);
3034 if (ret < 0 && ret != -ENOENT)
3037 ret2 = probe_file__del_events(ufd, filter);
3038 if (ret2 < 0 && ret2 != -ENOENT) {
3055 /* TODO: don't use a global variable for filter ... */
3056 static struct strfilter *available_func_filter;
3059 * If a symbol corresponds to a function with global binding and
3060 * matches filter return 0. For all others return 1.
3062 static int filter_available_functions(struct map *map __maybe_unused,
3065 if (strfilter__compare(available_func_filter, sym->name))
3070 int show_available_funcs(const char *target, struct strfilter *_filter,
3076 ret = init_probe_symbol_maps(user);
3080 /* Get a symbol map */
3082 map = dso__new_map(target);
3084 map = kernel_get_module_map(target);
3086 pr_err("Failed to get a map for %s\n", (target) ? : "kernel");
3090 /* Load symbols with given filter */
3091 available_func_filter = _filter;
3092 if (map__load(map, filter_available_functions)) {
3093 pr_err("Failed to load symbols in %s\n", (target) ? : "kernel");
3096 if (!dso__sorted_by_name(map->dso, map->type))
3097 dso__sort_by_name(map->dso, map->type);
3099 /* Show all (filtered) symbols */
3101 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
3106 exit_probe_symbol_maps();
3111 int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
3112 struct perf_probe_arg *pvar)
3114 tvar->value = strdup(pvar->var);
3115 if (tvar->value == NULL)
3118 tvar->type = strdup(pvar->type);
3119 if (tvar->type == NULL)
3123 tvar->name = strdup(pvar->name);
3124 if (tvar->name == NULL)