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>
44 #include "trace-event.h" /* For __maybe_unused */
45 #include "probe-event.h"
46 #include "probe-finder.h"
49 #define MAX_CMDLEN 256
50 #define MAX_PROBE_ARGS 128
51 #define PERFPROBE_GROUP "probe"
53 bool probe_event_dry_run; /* Dry run flag */
55 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
57 /* If there is no space to write, returns -E2BIG. */
58 static int e_snprintf(char *str, size_t size, const char *format, ...)
59 __attribute__((format(printf, 3, 4)));
61 static int e_snprintf(char *str, size_t size, const char *format, ...)
66 ret = vsnprintf(str, size, format, ap);
73 static char *synthesize_perf_probe_point(struct perf_probe_point *pp);
74 static int convert_name_to_addr(struct perf_probe_event *pev,
76 static struct machine machine;
78 /* Initialize symbol maps and path of vmlinux/modules */
79 static int init_vmlinux(void)
83 symbol_conf.sort_by_name = true;
84 if (symbol_conf.vmlinux_name == NULL)
85 symbol_conf.try_vmlinux_path = true;
87 pr_debug("Use vmlinux: %s\n", symbol_conf.vmlinux_name);
90 pr_debug("Failed to init symbol map.\n");
94 ret = machine__init(&machine, "", HOST_KERNEL_ID);
98 if (machine__create_kernel_maps(&machine) < 0) {
99 pr_debug("machine__create_kernel_maps() failed.\n");
104 pr_warning("Failed to init vmlinux path.\n");
108 static struct symbol *__find_kernel_function_by_name(const char *name,
111 return machine__find_kernel_function_by_name(&machine, name, mapp,
115 static struct map *kernel_get_module_map(const char *module)
118 struct map_groups *grp = &machine.kmaps;
120 /* A file path -- this is an offline module */
121 if (module && strchr(module, '/'))
122 return machine__new_module(&machine, 0, module);
127 for (nd = rb_first(&grp->maps[MAP__FUNCTION]); nd; nd = rb_next(nd)) {
128 struct map *pos = rb_entry(nd, struct map, rb_node);
129 if (strncmp(pos->dso->short_name + 1, module,
130 pos->dso->short_name_len - 2) == 0) {
137 static struct dso *kernel_get_module_dso(const char *module)
141 const char *vmlinux_name;
144 list_for_each_entry(dso, &machine.kernel_dsos, node) {
145 if (strncmp(dso->short_name + 1, module,
146 dso->short_name_len - 2) == 0)
149 pr_debug("Failed to find module %s.\n", module);
153 map = machine.vmlinux_maps[MAP__FUNCTION];
156 vmlinux_name = symbol_conf.vmlinux_name;
158 if (dso__load_vmlinux(dso, map, vmlinux_name, NULL) <= 0)
161 if (dso__load_vmlinux_path(dso, map, NULL) <= 0) {
162 pr_debug("Failed to load kernel map.\n");
170 const char *kernel_get_module_path(const char *module)
172 struct dso *dso = kernel_get_module_dso(module);
173 return (dso) ? dso->long_name : NULL;
176 static int init_user_exec(void)
180 symbol_conf.try_vmlinux_path = false;
181 symbol_conf.sort_by_name = true;
182 ret = symbol__init();
185 pr_debug("Failed to init symbol map.\n");
190 static int convert_to_perf_probe_point(struct probe_trace_point *tp,
191 struct perf_probe_point *pp)
193 pp->function = strdup(tp->symbol);
195 if (pp->function == NULL)
198 pp->offset = tp->offset;
199 pp->retprobe = tp->retprobe;
205 /* Open new debuginfo of given module */
206 static struct debuginfo *open_debuginfo(const char *module)
210 /* A file path -- this is an offline module */
211 if (module && strchr(module, '/'))
214 path = kernel_get_module_path(module);
217 pr_err("Failed to find path of %s module.\n",
222 return debuginfo__new(path);
226 * Convert trace point to probe point with debuginfo
227 * Currently only handles kprobes.
229 static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
230 struct perf_probe_point *pp)
236 struct debuginfo *dinfo;
238 sym = __find_kernel_function_by_name(tp->symbol, &map);
240 addr = map->unmap_ip(map, sym->start + tp->offset);
241 pr_debug("try to find %s+%ld@%" PRIx64 "\n", tp->symbol,
244 dinfo = debuginfo__new_online_kernel(addr);
246 ret = debuginfo__find_probe_point(dinfo,
247 (unsigned long)addr, pp);
248 debuginfo__delete(dinfo);
250 pr_debug("Failed to open debuginfo at 0x%" PRIx64 "\n",
256 pr_debug("Failed to find corresponding probes from "
257 "debuginfo. Use kprobe event information.\n");
258 return convert_to_perf_probe_point(tp, pp);
260 pp->retprobe = tp->retprobe;
265 static int add_module_to_probe_trace_events(struct probe_trace_event *tevs,
266 int ntevs, const char *module)
274 tmp = strrchr(module, '/');
276 /* This is a module path -- get the module name */
277 module = strdup(tmp + 1);
280 tmp = strchr(module, '.');
283 tmp = (char *)module; /* For free() */
286 for (i = 0; i < ntevs; i++) {
287 tevs[i].point.module = strdup(module);
288 if (!tevs[i].point.module) {
300 /* Try to find perf_probe_event with debuginfo */
301 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
302 struct probe_trace_event **tevs,
303 int max_tevs, const char *target)
305 bool need_dwarf = perf_probe_event_need_dwarf(pev);
306 struct debuginfo *dinfo;
311 pr_warning("Debuginfo-analysis is not yet supported"
312 " with -x/--exec option.\n");
315 return convert_name_to_addr(pev, target);
318 dinfo = open_debuginfo(target);
322 pr_warning("Failed to open debuginfo file.\n");
325 pr_debug("Could not open debuginfo. Try to use symbols.\n");
329 /* Searching trace events corresponding to a probe event */
330 ntevs = debuginfo__find_trace_events(dinfo, pev, tevs, max_tevs);
332 debuginfo__delete(dinfo);
334 if (ntevs > 0) { /* Succeeded to find trace events */
335 pr_debug("find %d probe_trace_events.\n", ntevs);
337 ret = add_module_to_probe_trace_events(*tevs, ntevs,
339 return ret < 0 ? ret : ntevs;
342 if (ntevs == 0) { /* No error but failed to find probe point. */
343 pr_warning("Probe point '%s' not found.\n",
344 synthesize_perf_probe_point(&pev->point));
347 /* Error path : ntevs < 0 */
348 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs);
349 if (ntevs == -EBADF) {
350 pr_warning("Warning: No dwarf info found in the vmlinux - "
351 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
353 pr_debug("Trying to use symbols.\n");
361 * Find a src file from a DWARF tag path. Prepend optional source path prefix
362 * and chop off leading directories that do not exist. Result is passed back as
363 * a newly allocated path on success.
364 * Return 0 if file was found and readable, -errno otherwise.
366 static int get_real_path(const char *raw_path, const char *comp_dir,
369 const char *prefix = symbol_conf.source_prefix;
372 if (raw_path[0] != '/' && comp_dir)
373 /* If not an absolute path, try to use comp_dir */
376 if (access(raw_path, R_OK) == 0) {
377 *new_path = strdup(raw_path);
384 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
389 sprintf(*new_path, "%s/%s", prefix, raw_path);
391 if (access(*new_path, R_OK) == 0)
394 if (!symbol_conf.source_prefix)
395 /* In case of searching comp_dir, don't retry */
403 raw_path = strchr(++raw_path, '/');
419 #define LINEBUF_SIZE 256
420 #define NR_ADDITIONAL_LINES 2
422 static int __show_one_line(FILE *fp, int l, bool skip, bool show_num)
424 char buf[LINEBUF_SIZE];
425 const char *color = show_num ? "" : PERF_COLOR_BLUE;
426 const char *prefix = NULL;
429 if (fgets(buf, LINEBUF_SIZE, fp) == NULL)
434 prefix = show_num ? "%7d " : " ";
435 color_fprintf(stdout, color, prefix, l);
437 color_fprintf(stdout, color, "%s", buf);
439 } while (strchr(buf, '\n') == NULL);
444 pr_warning("File read error: %s\n", strerror(errno));
450 static int _show_one_line(FILE *fp, int l, bool skip, bool show_num)
452 int rv = __show_one_line(fp, l, skip, show_num);
454 pr_warning("Source file is shorter than expected.\n");
460 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
461 #define show_one_line(f,l) _show_one_line(f,l,false,false)
462 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
463 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
466 * Show line-range always requires debuginfo to find source file and
469 int show_line_range(struct line_range *lr, const char *module)
472 struct line_node *ln;
473 struct debuginfo *dinfo;
478 /* Search a line range */
479 ret = init_vmlinux();
483 dinfo = open_debuginfo(module);
485 pr_warning("Failed to open debuginfo file.\n");
489 ret = debuginfo__find_line_range(dinfo, lr);
490 debuginfo__delete(dinfo);
492 pr_warning("Specified source line is not found.\n");
494 } else if (ret < 0) {
495 pr_warning("Debuginfo analysis failed. (%d)\n", ret);
499 /* Convert source file path */
501 ret = get_real_path(tmp, lr->comp_dir, &lr->path);
502 free(tmp); /* Free old path */
504 pr_warning("Failed to find source file. (%d)\n", ret);
511 fprintf(stdout, "<%s@%s:%d>\n", lr->function, lr->path,
512 lr->start - lr->offset);
514 fprintf(stdout, "<%s:%d>\n", lr->path, lr->start);
516 fp = fopen(lr->path, "r");
518 pr_warning("Failed to open %s: %s\n", lr->path,
522 /* Skip to starting line number */
523 while (l < lr->start) {
524 ret = skip_one_line(fp, l++);
529 list_for_each_entry(ln, &lr->line_list, list) {
530 for (; ln->line > l; l++) {
531 ret = show_one_line(fp, l - lr->offset);
535 ret = show_one_line_with_num(fp, l++ - lr->offset);
540 if (lr->end == INT_MAX)
541 lr->end = l + NR_ADDITIONAL_LINES;
542 while (l <= lr->end) {
543 ret = show_one_line_or_eof(fp, l++ - lr->offset);
552 static int show_available_vars_at(struct debuginfo *dinfo,
553 struct perf_probe_event *pev,
554 int max_vls, struct strfilter *_filter,
559 struct str_node *node;
560 struct variable_list *vls = NULL, *vl;
563 buf = synthesize_perf_probe_point(&pev->point);
566 pr_debug("Searching variables at %s\n", buf);
568 ret = debuginfo__find_available_vars_at(dinfo, pev, &vls,
571 pr_err("Failed to find variables at %s (%d)\n", buf, ret);
574 /* Some variables are found */
575 fprintf(stdout, "Available variables at %s\n", buf);
576 for (i = 0; i < ret; i++) {
579 * A probe point might be converted to
580 * several trace points.
582 fprintf(stdout, "\t@<%s+%lu>\n", vl->point.symbol,
584 free(vl->point.symbol);
587 strlist__for_each(node, vl->vars) {
588 var = strchr(node->s, '\t') + 1;
589 if (strfilter__compare(_filter, var)) {
590 fprintf(stdout, "\t\t%s\n", node->s);
594 strlist__delete(vl->vars);
597 fprintf(stdout, "\t\t(No matched variables)\n");
605 /* Show available variables on given probe point */
606 int show_available_vars(struct perf_probe_event *pevs, int npevs,
607 int max_vls, const char *module,
608 struct strfilter *_filter, bool externs)
611 struct debuginfo *dinfo;
613 ret = init_vmlinux();
617 dinfo = open_debuginfo(module);
619 pr_warning("Failed to open debuginfo file.\n");
625 for (i = 0; i < npevs && ret >= 0; i++)
626 ret = show_available_vars_at(dinfo, &pevs[i], max_vls, _filter,
629 debuginfo__delete(dinfo);
633 #else /* !DWARF_SUPPORT */
635 static int kprobe_convert_to_perf_probe(struct probe_trace_point *tp,
636 struct perf_probe_point *pp)
640 sym = __find_kernel_function_by_name(tp->symbol, NULL);
642 pr_err("Failed to find symbol %s in kernel.\n", tp->symbol);
646 return convert_to_perf_probe_point(tp, pp);
649 static int try_to_find_probe_trace_events(struct perf_probe_event *pev,
650 struct probe_trace_event **tevs __maybe_unused,
651 int max_tevs __maybe_unused, const char *target)
653 if (perf_probe_event_need_dwarf(pev)) {
654 pr_warning("Debuginfo-analysis is not supported.\n");
659 return convert_name_to_addr(pev, target);
664 int show_line_range(struct line_range *lr __maybe_unused,
665 const char *module __maybe_unused)
667 pr_warning("Debuginfo-analysis is not supported.\n");
671 int show_available_vars(struct perf_probe_event *pevs __maybe_unused,
672 int npevs __maybe_unused, int max_vls __maybe_unused,
673 const char *module __maybe_unused,
674 struct strfilter *filter __maybe_unused,
675 bool externs __maybe_unused)
677 pr_warning("Debuginfo-analysis is not supported.\n");
682 static int parse_line_num(char **ptr, int *val, const char *what)
684 const char *start = *ptr;
687 *val = strtol(*ptr, ptr, 0);
688 if (errno || *ptr == start) {
689 semantic_error("'%s' is not a valid number.\n", what);
696 * Stuff 'lr' according to the line range described by 'arg'.
697 * The line range syntax is described by:
699 * SRC[:SLN[+NUM|-ELN]]
700 * FNC[@SRC][:SLN[+NUM|-ELN]]
702 int parse_line_range_desc(const char *arg, struct line_range *lr)
704 char *range, *file, *name = strdup(arg);
713 range = strchr(name, ':');
717 err = parse_line_num(&range, &lr->start, "start line");
721 if (*range == '+' || *range == '-') {
722 const char c = *range++;
724 err = parse_line_num(&range, &lr->end, "end line");
729 lr->end += lr->start;
731 * Adjust the number of lines here.
732 * If the number of lines == 1, the
733 * the end of line should be equal to
740 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
743 if (lr->start > lr->end) {
744 semantic_error("Start line must be smaller"
745 " than end line.\n");
748 if (*range != '\0') {
749 semantic_error("Tailing with invalid str '%s'.\n", range);
754 file = strchr(name, '@');
757 lr->file = strdup(++file);
758 if (lr->file == NULL) {
763 } else if (strchr(name, '.'))
774 /* Check the name is good for event/group */
775 static bool check_event_name(const char *name)
777 if (!isalpha(*name) && *name != '_')
779 while (*++name != '\0') {
780 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
786 /* Parse probepoint definition. */
787 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
789 struct perf_probe_point *pp = &pev->point;
794 * perf probe [EVENT=]SRC[:LN|;PTN]
795 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
797 * TODO:Group name support
800 ptr = strpbrk(arg, ";=@+%");
801 if (ptr && *ptr == '=') { /* Event name */
804 if (strchr(arg, ':')) {
805 semantic_error("Group name is not supported yet.\n");
808 if (!check_event_name(arg)) {
809 semantic_error("%s is bad for event name -it must "
810 "follow C symbol-naming rule.\n", arg);
813 pev->event = strdup(arg);
814 if (pev->event == NULL)
820 ptr = strpbrk(arg, ";:+@%");
830 /* Check arg is function or file and copy it */
831 if (strchr(tmp, '.')) /* File */
836 /* Parse other options */
840 if (c == ';') { /* Lazy pattern must be the last part */
841 pp->lazy_line = strdup(arg);
842 if (pp->lazy_line == NULL)
846 ptr = strpbrk(arg, ";:+@%");
852 case ':': /* Line number */
853 pp->line = strtoul(arg, &tmp, 0);
855 semantic_error("There is non-digit char"
856 " in line number.\n");
860 case '+': /* Byte offset from a symbol */
861 pp->offset = strtoul(arg, &tmp, 0);
863 semantic_error("There is non-digit character"
868 case '@': /* File name */
870 semantic_error("SRC@SRC is not allowed.\n");
873 pp->file = strdup(arg);
874 if (pp->file == NULL)
877 case '%': /* Probe places */
878 if (strcmp(arg, "return") == 0) {
880 } else { /* Others not supported yet */
881 semantic_error("%%%s is not supported.\n", arg);
885 default: /* Buggy case */
886 pr_err("This program has a bug at %s:%d.\n",
893 /* Exclusion check */
894 if (pp->lazy_line && pp->line) {
895 semantic_error("Lazy pattern can't be used with"
900 if (pp->lazy_line && pp->offset) {
901 semantic_error("Lazy pattern can't be used with offset.\n");
905 if (pp->line && pp->offset) {
906 semantic_error("Offset can't be used with line number.\n");
910 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
911 semantic_error("File always requires line number or "
916 if (pp->offset && !pp->function) {
917 semantic_error("Offset requires an entry function.\n");
921 if (pp->retprobe && !pp->function) {
922 semantic_error("Return probe requires an entry function.\n");
926 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
927 semantic_error("Offset/Line/Lazy pattern can't be used with "
932 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
933 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
938 /* Parse perf-probe event argument */
939 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
941 char *tmp, *goodname;
942 struct perf_probe_arg_field **fieldp;
944 pr_debug("parsing arg: %s into ", str);
946 tmp = strchr(str, '=');
948 arg->name = strndup(str, tmp - str);
949 if (arg->name == NULL)
951 pr_debug("name:%s ", arg->name);
955 tmp = strchr(str, ':');
956 if (tmp) { /* Type setting */
958 arg->type = strdup(tmp + 1);
959 if (arg->type == NULL)
961 pr_debug("type:%s ", arg->type);
964 tmp = strpbrk(str, "-.[");
965 if (!is_c_varname(str) || !tmp) {
966 /* A variable, register, symbol or special value */
967 arg->var = strdup(str);
968 if (arg->var == NULL)
970 pr_debug("%s\n", arg->var);
974 /* Structure fields or array element */
975 arg->var = strndup(str, tmp - str);
976 if (arg->var == NULL)
979 pr_debug("%s, ", arg->var);
980 fieldp = &arg->field;
983 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
986 if (*tmp == '[') { /* Array */
988 (*fieldp)->index = strtol(str + 1, &tmp, 0);
989 (*fieldp)->ref = true;
990 if (*tmp != ']' || tmp == str + 1) {
991 semantic_error("Array index must be a"
998 } else { /* Structure */
1001 (*fieldp)->ref = false;
1002 } else if (tmp[1] == '>') {
1004 (*fieldp)->ref = true;
1006 semantic_error("Argument parse error: %s\n",
1010 tmp = strpbrk(str, "-.[");
1013 (*fieldp)->name = strndup(str, tmp - str);
1014 if ((*fieldp)->name == NULL)
1017 goodname = (*fieldp)->name;
1018 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1019 fieldp = &(*fieldp)->next;
1022 (*fieldp)->name = strdup(str);
1023 if ((*fieldp)->name == NULL)
1026 goodname = (*fieldp)->name;
1027 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1029 /* If no name is specified, set the last field name (not array index)*/
1031 arg->name = strdup(goodname);
1032 if (arg->name == NULL)
1038 /* Parse perf-probe event command */
1039 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1042 int argc, i, ret = 0;
1044 argv = argv_split(cmd, &argc);
1046 pr_debug("Failed to split arguments.\n");
1049 if (argc - 1 > MAX_PROBE_ARGS) {
1050 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1054 /* Parse probe point */
1055 ret = parse_perf_probe_point(argv[0], pev);
1059 /* Copy arguments and ensure return probe has no C argument */
1060 pev->nargs = argc - 1;
1061 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1062 if (pev->args == NULL) {
1066 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1067 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1069 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1070 semantic_error("You can't specify local variable for"
1081 /* Return true if this perf_probe_event requires debuginfo */
1082 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1086 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1089 for (i = 0; i < pev->nargs; i++)
1090 if (is_c_varname(pev->args[i].var))
1096 /* Parse probe_events event into struct probe_point */
1097 static int parse_probe_trace_command(const char *cmd,
1098 struct probe_trace_event *tev)
1100 struct probe_trace_point *tp = &tev->point;
1103 char *argv0_str = NULL, *fmt, *fmt1_str, *fmt2_str, *fmt3_str;
1107 pr_debug("Parsing probe_events: %s\n", cmd);
1108 argv = argv_split(cmd, &argc);
1110 pr_debug("Failed to split arguments.\n");
1114 semantic_error("Too few probe arguments.\n");
1119 /* Scan event and group name. */
1120 argv0_str = strdup(argv[0]);
1121 if (argv0_str == NULL) {
1125 fmt1_str = strtok_r(argv0_str, ":", &fmt);
1126 fmt2_str = strtok_r(NULL, "/", &fmt);
1127 fmt3_str = strtok_r(NULL, " \t", &fmt);
1128 if (fmt1_str == NULL || strlen(fmt1_str) != 1 || fmt2_str == NULL
1129 || fmt3_str == NULL) {
1130 semantic_error("Failed to parse event name: %s\n", argv[0]);
1135 tev->group = strdup(fmt2_str);
1136 tev->event = strdup(fmt3_str);
1137 if (tev->group == NULL || tev->event == NULL) {
1141 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1143 tp->retprobe = (pr == 'r');
1145 /* Scan module name(if there), function name and offset */
1146 p = strchr(argv[1], ':');
1148 tp->module = strndup(argv[1], p - argv[1]);
1152 fmt1_str = strtok_r(p, "+", &fmt);
1153 tp->symbol = strdup(fmt1_str);
1154 if (tp->symbol == NULL) {
1158 fmt2_str = strtok_r(NULL, "", &fmt);
1159 if (fmt2_str == NULL)
1162 tp->offset = strtoul(fmt2_str, NULL, 10);
1164 tev->nargs = argc - 2;
1165 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1166 if (tev->args == NULL) {
1170 for (i = 0; i < tev->nargs; i++) {
1171 p = strchr(argv[i + 2], '=');
1172 if (p) /* We don't need which register is assigned. */
1176 tev->args[i].name = strdup(argv[i + 2]);
1177 /* TODO: parse regs and offset */
1178 tev->args[i].value = strdup(p);
1179 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1191 /* Compose only probe arg */
1192 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1194 struct perf_probe_arg_field *field = pa->field;
1198 if (pa->name && pa->var)
1199 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1201 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1208 if (field->name[0] == '[')
1209 ret = e_snprintf(tmp, len, "%s", field->name);
1211 ret = e_snprintf(tmp, len, "%s%s",
1212 field->ref ? "->" : ".", field->name);
1217 field = field->next;
1221 ret = e_snprintf(tmp, len, ":%s", pa->type);
1230 pr_debug("Failed to synthesize perf probe argument: %s\n",
1235 /* Compose only probe point (not argument) */
1236 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1239 char offs[32] = "", line[32] = "", file[32] = "";
1242 buf = zalloc(MAX_CMDLEN);
1248 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1253 ret = e_snprintf(line, 32, ":%d", pp->line);
1261 tmp = strchr(pp->file + len - 30, '/');
1262 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1264 ret = e_snprintf(file, 32, "@%s", tmp);
1270 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1271 offs, pp->retprobe ? "%return" : "", line,
1274 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1280 pr_debug("Failed to synthesize perf probe point: %s\n",
1288 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1293 buf = synthesize_perf_probe_point(&pev->point);
1298 for (i = 0; i < pev->nargs; i++) {
1299 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1312 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1313 char **buf, size_t *buflen,
1318 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1324 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1336 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1337 char *buf, size_t buflen)
1339 struct probe_trace_arg_ref *ref = arg->ref;
1343 /* Argument name or separator */
1345 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1347 ret = e_snprintf(buf, buflen, " ");
1353 /* Special case: @XXX */
1354 if (arg->value[0] == '@' && arg->ref)
1357 /* Dereferencing arguments */
1359 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1365 /* Print argument value */
1366 if (arg->value[0] == '@' && arg->ref)
1367 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1370 ret = e_snprintf(buf, buflen, "%s", arg->value);
1378 ret = e_snprintf(buf, buflen, ")");
1384 /* Print argument type */
1386 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1395 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1397 struct probe_trace_point *tp = &tev->point;
1401 buf = zalloc(MAX_CMDLEN);
1406 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s:%s",
1407 tp->retprobe ? 'r' : 'p',
1408 tev->group, tev->event,
1409 tp->module, tp->symbol);
1411 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1412 tp->retprobe ? 'r' : 'p',
1413 tev->group, tev->event,
1414 tp->module ?: "", tp->module ? ":" : "",
1415 tp->symbol, tp->offset);
1420 for (i = 0; i < tev->nargs; i++) {
1421 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1434 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1435 struct perf_probe_event *pev, bool is_kprobe)
1440 /* Convert event/group name */
1441 pev->event = strdup(tev->event);
1442 pev->group = strdup(tev->group);
1443 if (pev->event == NULL || pev->group == NULL)
1446 /* Convert trace_point to probe_point */
1448 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1450 ret = convert_to_perf_probe_point(&tev->point, &pev->point);
1455 /* Convert trace_arg to probe_arg */
1456 pev->nargs = tev->nargs;
1457 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1458 if (pev->args == NULL)
1460 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1461 if (tev->args[i].name)
1462 pev->args[i].name = strdup(tev->args[i].name);
1464 ret = synthesize_probe_trace_arg(&tev->args[i],
1466 pev->args[i].name = strdup(buf);
1468 if (pev->args[i].name == NULL && ret >= 0)
1473 clear_perf_probe_event(pev);
1478 void clear_perf_probe_event(struct perf_probe_event *pev)
1480 struct perf_probe_point *pp = &pev->point;
1481 struct perf_probe_arg_field *field, *next;
1493 free(pp->lazy_line);
1494 for (i = 0; i < pev->nargs; i++) {
1495 if (pev->args[i].name)
1496 free(pev->args[i].name);
1497 if (pev->args[i].var)
1498 free(pev->args[i].var);
1499 if (pev->args[i].type)
1500 free(pev->args[i].type);
1501 field = pev->args[i].field;
1512 memset(pev, 0, sizeof(*pev));
1515 static void clear_probe_trace_event(struct probe_trace_event *tev)
1517 struct probe_trace_arg_ref *ref, *next;
1524 if (tev->point.symbol)
1525 free(tev->point.symbol);
1526 if (tev->point.module)
1527 free(tev->point.module);
1528 for (i = 0; i < tev->nargs; i++) {
1529 if (tev->args[i].name)
1530 free(tev->args[i].name);
1531 if (tev->args[i].value)
1532 free(tev->args[i].value);
1533 if (tev->args[i].type)
1534 free(tev->args[i].type);
1535 ref = tev->args[i].ref;
1544 memset(tev, 0, sizeof(*tev));
1547 static void print_warn_msg(const char *file, bool is_kprobe)
1550 if (errno == ENOENT) {
1554 config = "CONFIG_UPROBE_EVENTS";
1556 config = "CONFIG_KPROBE_EVENTS";
1558 pr_warning("%s file does not exist - please rebuild kernel"
1559 " with %s.\n", file, config);
1561 pr_warning("Failed to open %s file: %s\n", file,
1565 static int open_probe_events(const char *trace_file, bool readwrite,
1569 const char *__debugfs;
1572 __debugfs = debugfs_find_mountpoint();
1573 if (__debugfs == NULL) {
1574 pr_warning("Debugfs is not mounted.\n");
1578 ret = e_snprintf(buf, PATH_MAX, "%s/%s", __debugfs, trace_file);
1580 pr_debug("Opening %s write=%d\n", buf, readwrite);
1581 if (readwrite && !probe_event_dry_run)
1582 ret = open(buf, O_RDWR, O_APPEND);
1584 ret = open(buf, O_RDONLY, 0);
1587 print_warn_msg(buf, is_kprobe);
1592 static int open_kprobe_events(bool readwrite)
1594 return open_probe_events("tracing/kprobe_events", readwrite, true);
1597 static int open_uprobe_events(bool readwrite)
1599 return open_probe_events("tracing/uprobe_events", readwrite, false);
1602 /* Get raw string list of current kprobe_events or uprobe_events */
1603 static struct strlist *get_probe_trace_command_rawlist(int fd)
1607 char buf[MAX_CMDLEN];
1611 sl = strlist__new(true, NULL);
1613 fp = fdopen(dup(fd), "r");
1615 p = fgets(buf, MAX_CMDLEN, fp);
1619 idx = strlen(p) - 1;
1622 ret = strlist__add(sl, buf);
1624 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1625 strlist__delete(sl);
1635 static int show_perf_probe_event(struct perf_probe_event *pev)
1641 /* Synthesize only event probe point */
1642 place = synthesize_perf_probe_point(&pev->point);
1646 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1650 printf(" %-20s (on %s", buf, place);
1652 if (pev->nargs > 0) {
1654 for (i = 0; i < pev->nargs; i++) {
1655 ret = synthesize_perf_probe_arg(&pev->args[i],
1667 static int __show_perf_probe_events(int fd, bool is_kprobe)
1670 struct probe_trace_event tev;
1671 struct perf_probe_event pev;
1672 struct strlist *rawlist;
1673 struct str_node *ent;
1675 memset(&tev, 0, sizeof(tev));
1676 memset(&pev, 0, sizeof(pev));
1678 rawlist = get_probe_trace_command_rawlist(fd);
1682 strlist__for_each(ent, rawlist) {
1683 ret = parse_probe_trace_command(ent->s, &tev);
1685 ret = convert_to_perf_probe_event(&tev, &pev,
1688 ret = show_perf_probe_event(&pev);
1690 clear_perf_probe_event(&pev);
1691 clear_probe_trace_event(&tev);
1695 strlist__delete(rawlist);
1700 /* List up current perf-probe events */
1701 int show_perf_probe_events(void)
1706 fd = open_kprobe_events(false);
1711 ret = init_vmlinux();
1715 ret = __show_perf_probe_events(fd, true);
1718 fd = open_uprobe_events(false);
1720 ret = __show_perf_probe_events(fd, false);
1727 /* Get current perf-probe event names */
1728 static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1731 struct strlist *sl, *rawlist;
1732 struct str_node *ent;
1733 struct probe_trace_event tev;
1736 memset(&tev, 0, sizeof(tev));
1737 rawlist = get_probe_trace_command_rawlist(fd);
1738 sl = strlist__new(true, NULL);
1739 strlist__for_each(ent, rawlist) {
1740 ret = parse_probe_trace_command(ent->s, &tev);
1743 if (include_group) {
1744 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1747 ret = strlist__add(sl, buf);
1749 ret = strlist__add(sl, tev.event);
1750 clear_probe_trace_event(&tev);
1754 strlist__delete(rawlist);
1757 strlist__delete(sl);
1763 static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1766 char *buf = synthesize_probe_trace_command(tev);
1769 pr_debug("Failed to synthesize probe trace event.\n");
1773 pr_debug("Writing event: %s\n", buf);
1774 if (!probe_event_dry_run) {
1775 ret = write(fd, buf, strlen(buf));
1777 pr_warning("Failed to write event: %s\n",
1784 static int get_new_event_name(char *buf, size_t len, const char *base,
1785 struct strlist *namelist, bool allow_suffix)
1790 ret = e_snprintf(buf, len, "%s", base);
1792 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1795 if (!strlist__has_entry(namelist, buf))
1798 if (!allow_suffix) {
1799 pr_warning("Error: event \"%s\" already exists. "
1800 "(Use -f to force duplicates.)\n", base);
1804 /* Try to add suffix */
1805 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1806 ret = e_snprintf(buf, len, "%s_%d", base, i);
1808 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1811 if (!strlist__has_entry(namelist, buf))
1814 if (i == MAX_EVENT_INDEX) {
1815 pr_warning("Too many events are on the same function.\n");
1822 static int __add_probe_trace_events(struct perf_probe_event *pev,
1823 struct probe_trace_event *tevs,
1824 int ntevs, bool allow_suffix)
1827 struct probe_trace_event *tev = NULL;
1829 const char *event, *group;
1830 struct strlist *namelist;
1833 fd = open_uprobe_events(true);
1835 fd = open_kprobe_events(true);
1839 /* Get current event names */
1840 namelist = get_probe_trace_event_names(fd, false);
1842 pr_debug("Failed to get current event list.\n");
1847 printf("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
1848 for (i = 0; i < ntevs; i++) {
1853 if (pev->point.function)
1854 event = pev->point.function;
1856 event = tev->point.symbol;
1860 group = PERFPROBE_GROUP;
1862 /* Get an unused new event name */
1863 ret = get_new_event_name(buf, 64, event,
1864 namelist, allow_suffix);
1869 tev->event = strdup(event);
1870 tev->group = strdup(group);
1871 if (tev->event == NULL || tev->group == NULL) {
1875 ret = write_probe_trace_event(fd, tev);
1878 /* Add added event name to namelist */
1879 strlist__add(namelist, event);
1881 /* Trick here - save current event/group */
1884 pev->event = tev->event;
1885 pev->group = tev->group;
1886 show_perf_probe_event(pev);
1887 /* Trick here - restore current event/group */
1888 pev->event = (char *)event;
1889 pev->group = (char *)group;
1892 * Probes after the first probe which comes from same
1893 * user input are always allowed to add suffix, because
1894 * there might be several addresses corresponding to
1897 allow_suffix = true;
1901 /* Show how to use the event. */
1902 printf("\nYou can now use it in all perf tools, such as:\n\n");
1903 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1907 strlist__delete(namelist);
1912 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1913 struct probe_trace_event **tevs,
1914 int max_tevs, const char *target)
1918 struct probe_trace_event *tev;
1920 /* Convert perf_probe_event with debuginfo */
1921 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
1923 return ret; /* Found in debuginfo or got an error */
1925 /* Allocate trace event buffer */
1926 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1930 /* Copy parameters */
1931 tev->point.symbol = strdup(pev->point.function);
1932 if (tev->point.symbol == NULL) {
1938 tev->point.module = strdup(target);
1939 if (tev->point.module == NULL) {
1945 tev->point.offset = pev->point.offset;
1946 tev->point.retprobe = pev->point.retprobe;
1947 tev->nargs = pev->nargs;
1948 tev->uprobes = pev->uprobes;
1951 tev->args = zalloc(sizeof(struct probe_trace_arg)
1953 if (tev->args == NULL) {
1957 for (i = 0; i < tev->nargs; i++) {
1958 if (pev->args[i].name) {
1959 tev->args[i].name = strdup(pev->args[i].name);
1960 if (tev->args[i].name == NULL) {
1965 tev->args[i].value = strdup(pev->args[i].var);
1966 if (tev->args[i].value == NULL) {
1970 if (pev->args[i].type) {
1971 tev->args[i].type = strdup(pev->args[i].type);
1972 if (tev->args[i].type == NULL) {
1983 /* Currently just checking function name from symbol map */
1984 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1986 pr_warning("Kernel symbol \'%s\' not found.\n",
1990 } else if (tev->point.offset > sym->end - sym->start) {
1991 pr_warning("Offset specified is greater than size of %s\n",
2000 clear_probe_trace_event(tev);
2006 struct __event_package {
2007 struct perf_probe_event *pev;
2008 struct probe_trace_event *tevs;
2012 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
2013 int max_tevs, const char *target, bool force_add)
2016 struct __event_package *pkgs;
2019 pkgs = zalloc(sizeof(struct __event_package) * npevs);
2025 /* Init vmlinux path */
2026 ret = init_vmlinux();
2028 ret = init_user_exec();
2035 /* Loop 1: convert all events */
2036 for (i = 0; i < npevs; i++) {
2037 pkgs[i].pev = &pevs[i];
2038 /* Convert with or without debuginfo */
2039 ret = convert_to_probe_trace_events(pkgs[i].pev,
2045 pkgs[i].ntevs = ret;
2048 /* Loop 2: add all events */
2049 for (i = 0; i < npevs; i++) {
2050 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2051 pkgs[i].ntevs, force_add);
2056 /* Loop 3: cleanup and free trace events */
2057 for (i = 0; i < npevs; i++) {
2058 for (j = 0; j < pkgs[i].ntevs; j++)
2059 clear_probe_trace_event(&pkgs[i].tevs[j]);
2067 static int __del_trace_probe_event(int fd, struct str_node *ent)
2073 /* Convert from perf-probe event to trace-probe event */
2074 ret = e_snprintf(buf, 128, "-:%s", ent->s);
2078 p = strchr(buf + 2, ':');
2080 pr_debug("Internal error: %s should have ':' but not.\n",
2087 pr_debug("Writing event: %s\n", buf);
2088 ret = write(fd, buf, strlen(buf));
2094 printf("Removed event: %s\n", ent->s);
2097 pr_warning("Failed to delete event: %s\n", strerror(-ret));
2101 static int del_trace_probe_event(int fd, const char *buf,
2102 struct strlist *namelist)
2104 struct str_node *ent, *n;
2107 if (strpbrk(buf, "*?")) { /* Glob-exp */
2108 strlist__for_each_safe(ent, n, namelist)
2109 if (strglobmatch(ent->s, buf)) {
2110 ret = __del_trace_probe_event(fd, ent);
2113 strlist__remove(namelist, ent);
2116 ent = strlist__find(namelist, buf);
2118 ret = __del_trace_probe_event(fd, ent);
2120 strlist__remove(namelist, ent);
2127 int del_perf_probe_events(struct strlist *dellist)
2129 int ret = -1, ufd = -1, kfd = -1;
2131 const char *group, *event;
2133 struct str_node *ent;
2134 struct strlist *namelist = NULL, *unamelist = NULL;
2136 /* Get current event names */
2137 kfd = open_kprobe_events(true);
2141 namelist = get_probe_trace_event_names(kfd, true);
2142 ufd = open_uprobe_events(true);
2145 unamelist = get_probe_trace_event_names(ufd, true);
2147 if (namelist == NULL && unamelist == NULL)
2150 strlist__for_each(ent, dellist) {
2151 str = strdup(ent->s);
2156 pr_debug("Parsing: %s\n", str);
2157 p = strchr(str, ':');
2167 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2169 pr_err("Failed to copy event.");
2174 pr_debug("Group: %s, Event: %s\n", group, event);
2177 ret = del_trace_probe_event(kfd, buf, namelist);
2179 if (unamelist && ret != 0)
2180 ret = del_trace_probe_event(ufd, buf, unamelist);
2183 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2190 strlist__delete(namelist);
2195 strlist__delete(unamelist);
2202 /* TODO: don't use a global variable for filter ... */
2203 static struct strfilter *available_func_filter;
2206 * If a symbol corresponds to a function with global binding and
2207 * matches filter return 0. For all others return 1.
2209 static int filter_available_functions(struct map *map __maybe_unused,
2212 if (sym->binding == STB_GLOBAL &&
2213 strfilter__compare(available_func_filter, sym->name))
2218 static int __show_available_funcs(struct map *map)
2220 if (map__load(map, filter_available_functions)) {
2221 pr_err("Failed to load map.\n");
2224 if (!dso__sorted_by_name(map->dso, map->type))
2225 dso__sort_by_name(map->dso, map->type);
2227 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2231 static int available_kernel_funcs(const char *module)
2236 ret = init_vmlinux();
2240 map = kernel_get_module_map(module);
2242 pr_err("Failed to find %s map.\n", (module) ? : "kernel");
2245 return __show_available_funcs(map);
2248 static int available_user_funcs(const char *target)
2253 ret = init_user_exec();
2257 map = dso__new_map(target);
2258 ret = __show_available_funcs(map);
2259 dso__delete(map->dso);
2264 int show_available_funcs(const char *target, struct strfilter *_filter,
2268 available_func_filter = _filter;
2271 return available_kernel_funcs(target);
2273 return available_user_funcs(target);
2277 * uprobe_events only accepts address:
2278 * Convert function and any offset to address
2280 static int convert_name_to_addr(struct perf_probe_event *pev, const char *exec)
2282 struct perf_probe_point *pp = &pev->point;
2284 struct map *map = NULL;
2285 char *function = NULL, *name = NULL;
2287 unsigned long long vaddr = 0;
2289 if (!pp->function) {
2290 pr_warning("No function specified for uprobes");
2294 function = strdup(pp->function);
2296 pr_warning("Failed to allocate memory by strdup.\n");
2301 name = realpath(exec, NULL);
2303 pr_warning("Cannot find realpath for %s.\n", exec);
2306 map = dso__new_map(name);
2308 pr_warning("Cannot find appropriate DSO for %s.\n", exec);
2311 available_func_filter = strfilter__new(function, NULL);
2312 if (map__load(map, filter_available_functions)) {
2313 pr_err("Failed to load map.\n");
2317 sym = map__find_symbol_by_name(map, function, NULL);
2319 pr_warning("Cannot find %s in DSO %s\n", function, exec);
2323 if (map->start > sym->start)
2325 vaddr += sym->start + pp->offset + map->pgoff;
2329 pev->event = function;
2333 char *ptr1, *ptr2, *exec_copy;
2335 pev->group = zalloc(sizeof(char *) * 64);
2336 exec_copy = strdup(exec);
2339 pr_warning("Failed to copy exec string.\n");
2343 ptr1 = strdup(basename(exec_copy));
2345 ptr2 = strpbrk(ptr1, "-._");
2348 e_snprintf(pev->group, 64, "%s_%s", PERFPROBE_GROUP,
2355 pp->function = zalloc(sizeof(char *) * MAX_PROBE_ARGS);
2356 if (!pp->function) {
2358 pr_warning("Failed to allocate memory by zalloc.\n");
2361 e_snprintf(pp->function, MAX_PROBE_ARGS, "0x%llx", vaddr);
2366 dso__delete(map->dso);