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 __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 __unused,
651 int max_tevs __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 __unused, const char *module __unused)
666 pr_warning("Debuginfo-analysis is not supported.\n");
670 int show_available_vars(struct perf_probe_event *pevs __unused,
671 int npevs __unused, int max_vls __unused,
672 const char *module __unused,
673 struct strfilter *filter __unused,
674 bool externs __unused)
676 pr_warning("Debuginfo-analysis is not supported.\n");
681 static int parse_line_num(char **ptr, int *val, const char *what)
683 const char *start = *ptr;
686 *val = strtol(*ptr, ptr, 0);
687 if (errno || *ptr == start) {
688 semantic_error("'%s' is not a valid number.\n", what);
695 * Stuff 'lr' according to the line range described by 'arg'.
696 * The line range syntax is described by:
698 * SRC[:SLN[+NUM|-ELN]]
699 * FNC[@SRC][:SLN[+NUM|-ELN]]
701 int parse_line_range_desc(const char *arg, struct line_range *lr)
703 char *range, *file, *name = strdup(arg);
712 range = strchr(name, ':');
716 err = parse_line_num(&range, &lr->start, "start line");
720 if (*range == '+' || *range == '-') {
721 const char c = *range++;
723 err = parse_line_num(&range, &lr->end, "end line");
728 lr->end += lr->start;
730 * Adjust the number of lines here.
731 * If the number of lines == 1, the
732 * the end of line should be equal to
739 pr_debug("Line range is %d to %d\n", lr->start, lr->end);
742 if (lr->start > lr->end) {
743 semantic_error("Start line must be smaller"
744 " than end line.\n");
747 if (*range != '\0') {
748 semantic_error("Tailing with invalid str '%s'.\n", range);
753 file = strchr(name, '@');
756 lr->file = strdup(++file);
757 if (lr->file == NULL) {
762 } else if (strchr(name, '.'))
773 /* Check the name is good for event/group */
774 static bool check_event_name(const char *name)
776 if (!isalpha(*name) && *name != '_')
778 while (*++name != '\0') {
779 if (!isalpha(*name) && !isdigit(*name) && *name != '_')
785 /* Parse probepoint definition. */
786 static int parse_perf_probe_point(char *arg, struct perf_probe_event *pev)
788 struct perf_probe_point *pp = &pev->point;
793 * perf probe [EVENT=]SRC[:LN|;PTN]
794 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
796 * TODO:Group name support
799 ptr = strpbrk(arg, ";=@+%");
800 if (ptr && *ptr == '=') { /* Event name */
803 if (strchr(arg, ':')) {
804 semantic_error("Group name is not supported yet.\n");
807 if (!check_event_name(arg)) {
808 semantic_error("%s is bad for event name -it must "
809 "follow C symbol-naming rule.\n", arg);
812 pev->event = strdup(arg);
813 if (pev->event == NULL)
819 ptr = strpbrk(arg, ";:+@%");
829 /* Check arg is function or file and copy it */
830 if (strchr(tmp, '.')) /* File */
835 /* Parse other options */
839 if (c == ';') { /* Lazy pattern must be the last part */
840 pp->lazy_line = strdup(arg);
841 if (pp->lazy_line == NULL)
845 ptr = strpbrk(arg, ";:+@%");
851 case ':': /* Line number */
852 pp->line = strtoul(arg, &tmp, 0);
854 semantic_error("There is non-digit char"
855 " in line number.\n");
859 case '+': /* Byte offset from a symbol */
860 pp->offset = strtoul(arg, &tmp, 0);
862 semantic_error("There is non-digit character"
867 case '@': /* File name */
869 semantic_error("SRC@SRC is not allowed.\n");
872 pp->file = strdup(arg);
873 if (pp->file == NULL)
876 case '%': /* Probe places */
877 if (strcmp(arg, "return") == 0) {
879 } else { /* Others not supported yet */
880 semantic_error("%%%s is not supported.\n", arg);
884 default: /* Buggy case */
885 pr_err("This program has a bug at %s:%d.\n",
892 /* Exclusion check */
893 if (pp->lazy_line && pp->line) {
894 semantic_error("Lazy pattern can't be used with"
899 if (pp->lazy_line && pp->offset) {
900 semantic_error("Lazy pattern can't be used with offset.\n");
904 if (pp->line && pp->offset) {
905 semantic_error("Offset can't be used with line number.\n");
909 if (!pp->line && !pp->lazy_line && pp->file && !pp->function) {
910 semantic_error("File always requires line number or "
915 if (pp->offset && !pp->function) {
916 semantic_error("Offset requires an entry function.\n");
920 if (pp->retprobe && !pp->function) {
921 semantic_error("Return probe requires an entry function.\n");
925 if ((pp->offset || pp->line || pp->lazy_line) && pp->retprobe) {
926 semantic_error("Offset/Line/Lazy pattern can't be used with "
931 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
932 pp->function, pp->file, pp->line, pp->offset, pp->retprobe,
937 /* Parse perf-probe event argument */
938 static int parse_perf_probe_arg(char *str, struct perf_probe_arg *arg)
940 char *tmp, *goodname;
941 struct perf_probe_arg_field **fieldp;
943 pr_debug("parsing arg: %s into ", str);
945 tmp = strchr(str, '=');
947 arg->name = strndup(str, tmp - str);
948 if (arg->name == NULL)
950 pr_debug("name:%s ", arg->name);
954 tmp = strchr(str, ':');
955 if (tmp) { /* Type setting */
957 arg->type = strdup(tmp + 1);
958 if (arg->type == NULL)
960 pr_debug("type:%s ", arg->type);
963 tmp = strpbrk(str, "-.[");
964 if (!is_c_varname(str) || !tmp) {
965 /* A variable, register, symbol or special value */
966 arg->var = strdup(str);
967 if (arg->var == NULL)
969 pr_debug("%s\n", arg->var);
973 /* Structure fields or array element */
974 arg->var = strndup(str, tmp - str);
975 if (arg->var == NULL)
978 pr_debug("%s, ", arg->var);
979 fieldp = &arg->field;
982 *fieldp = zalloc(sizeof(struct perf_probe_arg_field));
985 if (*tmp == '[') { /* Array */
987 (*fieldp)->index = strtol(str + 1, &tmp, 0);
988 (*fieldp)->ref = true;
989 if (*tmp != ']' || tmp == str + 1) {
990 semantic_error("Array index must be a"
997 } else { /* Structure */
1000 (*fieldp)->ref = false;
1001 } else if (tmp[1] == '>') {
1003 (*fieldp)->ref = true;
1005 semantic_error("Argument parse error: %s\n",
1009 tmp = strpbrk(str, "-.[");
1012 (*fieldp)->name = strndup(str, tmp - str);
1013 if ((*fieldp)->name == NULL)
1016 goodname = (*fieldp)->name;
1017 pr_debug("%s(%d), ", (*fieldp)->name, (*fieldp)->ref);
1018 fieldp = &(*fieldp)->next;
1021 (*fieldp)->name = strdup(str);
1022 if ((*fieldp)->name == NULL)
1025 goodname = (*fieldp)->name;
1026 pr_debug("%s(%d)\n", (*fieldp)->name, (*fieldp)->ref);
1028 /* If no name is specified, set the last field name (not array index)*/
1030 arg->name = strdup(goodname);
1031 if (arg->name == NULL)
1037 /* Parse perf-probe event command */
1038 int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev)
1041 int argc, i, ret = 0;
1043 argv = argv_split(cmd, &argc);
1045 pr_debug("Failed to split arguments.\n");
1048 if (argc - 1 > MAX_PROBE_ARGS) {
1049 semantic_error("Too many probe arguments (%d).\n", argc - 1);
1053 /* Parse probe point */
1054 ret = parse_perf_probe_point(argv[0], pev);
1058 /* Copy arguments and ensure return probe has no C argument */
1059 pev->nargs = argc - 1;
1060 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1061 if (pev->args == NULL) {
1065 for (i = 0; i < pev->nargs && ret >= 0; i++) {
1066 ret = parse_perf_probe_arg(argv[i + 1], &pev->args[i]);
1068 is_c_varname(pev->args[i].var) && pev->point.retprobe) {
1069 semantic_error("You can't specify local variable for"
1080 /* Return true if this perf_probe_event requires debuginfo */
1081 bool perf_probe_event_need_dwarf(struct perf_probe_event *pev)
1085 if (pev->point.file || pev->point.line || pev->point.lazy_line)
1088 for (i = 0; i < pev->nargs; i++)
1089 if (is_c_varname(pev->args[i].var))
1095 /* Parse probe_events event into struct probe_point */
1096 static int parse_probe_trace_command(const char *cmd,
1097 struct probe_trace_event *tev)
1099 struct probe_trace_point *tp = &tev->point;
1105 pr_debug("Parsing probe_events: %s\n", cmd);
1106 argv = argv_split(cmd, &argc);
1108 pr_debug("Failed to split arguments.\n");
1112 semantic_error("Too few probe arguments.\n");
1117 /* Scan event and group name. */
1118 ret = sscanf(argv[0], "%c:%a[^/ \t]/%a[^ \t]",
1119 &pr, (float *)(void *)&tev->group,
1120 (float *)(void *)&tev->event);
1122 semantic_error("Failed to parse event name: %s\n", argv[0]);
1126 pr_debug("Group:%s Event:%s probe:%c\n", tev->group, tev->event, pr);
1128 tp->retprobe = (pr == 'r');
1130 /* Scan module name(if there), function name and offset */
1131 p = strchr(argv[1], ':');
1133 tp->module = strndup(argv[1], p - argv[1]);
1137 ret = sscanf(p, "%a[^+]+%lu", (float *)(void *)&tp->symbol,
1142 tev->nargs = argc - 2;
1143 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1144 if (tev->args == NULL) {
1148 for (i = 0; i < tev->nargs; i++) {
1149 p = strchr(argv[i + 2], '=');
1150 if (p) /* We don't need which register is assigned. */
1154 tev->args[i].name = strdup(argv[i + 2]);
1155 /* TODO: parse regs and offset */
1156 tev->args[i].value = strdup(p);
1157 if (tev->args[i].name == NULL || tev->args[i].value == NULL) {
1168 /* Compose only probe arg */
1169 int synthesize_perf_probe_arg(struct perf_probe_arg *pa, char *buf, size_t len)
1171 struct perf_probe_arg_field *field = pa->field;
1175 if (pa->name && pa->var)
1176 ret = e_snprintf(tmp, len, "%s=%s", pa->name, pa->var);
1178 ret = e_snprintf(tmp, len, "%s", pa->name ? pa->name : pa->var);
1185 if (field->name[0] == '[')
1186 ret = e_snprintf(tmp, len, "%s", field->name);
1188 ret = e_snprintf(tmp, len, "%s%s",
1189 field->ref ? "->" : ".", field->name);
1194 field = field->next;
1198 ret = e_snprintf(tmp, len, ":%s", pa->type);
1207 pr_debug("Failed to synthesize perf probe argument: %s\n",
1212 /* Compose only probe point (not argument) */
1213 static char *synthesize_perf_probe_point(struct perf_probe_point *pp)
1216 char offs[32] = "", line[32] = "", file[32] = "";
1219 buf = zalloc(MAX_CMDLEN);
1225 ret = e_snprintf(offs, 32, "+%lu", pp->offset);
1230 ret = e_snprintf(line, 32, ":%d", pp->line);
1238 tmp = strchr(pp->file + len - 30, '/');
1239 tmp = tmp ? tmp + 1 : pp->file + len - 30;
1241 ret = e_snprintf(file, 32, "@%s", tmp);
1247 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s%s%s%s", pp->function,
1248 offs, pp->retprobe ? "%return" : "", line,
1251 ret = e_snprintf(buf, MAX_CMDLEN, "%s%s", file, line);
1257 pr_debug("Failed to synthesize perf probe point: %s\n",
1265 char *synthesize_perf_probe_command(struct perf_probe_event *pev)
1270 buf = synthesize_perf_probe_point(&pev->point);
1275 for (i = 0; i < pev->nargs; i++) {
1276 ret = e_snprintf(&buf[len], MAX_CMDLEN - len, " %s",
1289 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref *ref,
1290 char **buf, size_t *buflen,
1295 depth = __synthesize_probe_trace_arg_ref(ref->next, buf,
1301 ret = e_snprintf(*buf, *buflen, "%+ld(", ref->offset);
1313 static int synthesize_probe_trace_arg(struct probe_trace_arg *arg,
1314 char *buf, size_t buflen)
1316 struct probe_trace_arg_ref *ref = arg->ref;
1320 /* Argument name or separator */
1322 ret = e_snprintf(buf, buflen, " %s=", arg->name);
1324 ret = e_snprintf(buf, buflen, " ");
1330 /* Special case: @XXX */
1331 if (arg->value[0] == '@' && arg->ref)
1334 /* Dereferencing arguments */
1336 depth = __synthesize_probe_trace_arg_ref(ref, &buf,
1342 /* Print argument value */
1343 if (arg->value[0] == '@' && arg->ref)
1344 ret = e_snprintf(buf, buflen, "%s%+ld", arg->value,
1347 ret = e_snprintf(buf, buflen, "%s", arg->value);
1355 ret = e_snprintf(buf, buflen, ")");
1361 /* Print argument type */
1363 ret = e_snprintf(buf, buflen, ":%s", arg->type);
1372 char *synthesize_probe_trace_command(struct probe_trace_event *tev)
1374 struct probe_trace_point *tp = &tev->point;
1378 buf = zalloc(MAX_CMDLEN);
1383 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s:%s",
1384 tp->retprobe ? 'r' : 'p',
1385 tev->group, tev->event,
1386 tp->module, tp->symbol);
1388 len = e_snprintf(buf, MAX_CMDLEN, "%c:%s/%s %s%s%s+%lu",
1389 tp->retprobe ? 'r' : 'p',
1390 tev->group, tev->event,
1391 tp->module ?: "", tp->module ? ":" : "",
1392 tp->symbol, tp->offset);
1397 for (i = 0; i < tev->nargs; i++) {
1398 ret = synthesize_probe_trace_arg(&tev->args[i], buf + len,
1411 static int convert_to_perf_probe_event(struct probe_trace_event *tev,
1412 struct perf_probe_event *pev, bool is_kprobe)
1417 /* Convert event/group name */
1418 pev->event = strdup(tev->event);
1419 pev->group = strdup(tev->group);
1420 if (pev->event == NULL || pev->group == NULL)
1423 /* Convert trace_point to probe_point */
1425 ret = kprobe_convert_to_perf_probe(&tev->point, &pev->point);
1427 ret = convert_to_perf_probe_point(&tev->point, &pev->point);
1432 /* Convert trace_arg to probe_arg */
1433 pev->nargs = tev->nargs;
1434 pev->args = zalloc(sizeof(struct perf_probe_arg) * pev->nargs);
1435 if (pev->args == NULL)
1437 for (i = 0; i < tev->nargs && ret >= 0; i++) {
1438 if (tev->args[i].name)
1439 pev->args[i].name = strdup(tev->args[i].name);
1441 ret = synthesize_probe_trace_arg(&tev->args[i],
1443 pev->args[i].name = strdup(buf);
1445 if (pev->args[i].name == NULL && ret >= 0)
1450 clear_perf_probe_event(pev);
1455 void clear_perf_probe_event(struct perf_probe_event *pev)
1457 struct perf_probe_point *pp = &pev->point;
1458 struct perf_probe_arg_field *field, *next;
1470 free(pp->lazy_line);
1471 for (i = 0; i < pev->nargs; i++) {
1472 if (pev->args[i].name)
1473 free(pev->args[i].name);
1474 if (pev->args[i].var)
1475 free(pev->args[i].var);
1476 if (pev->args[i].type)
1477 free(pev->args[i].type);
1478 field = pev->args[i].field;
1489 memset(pev, 0, sizeof(*pev));
1492 static void clear_probe_trace_event(struct probe_trace_event *tev)
1494 struct probe_trace_arg_ref *ref, *next;
1501 if (tev->point.symbol)
1502 free(tev->point.symbol);
1503 if (tev->point.module)
1504 free(tev->point.module);
1505 for (i = 0; i < tev->nargs; i++) {
1506 if (tev->args[i].name)
1507 free(tev->args[i].name);
1508 if (tev->args[i].value)
1509 free(tev->args[i].value);
1510 if (tev->args[i].type)
1511 free(tev->args[i].type);
1512 ref = tev->args[i].ref;
1521 memset(tev, 0, sizeof(*tev));
1524 static void print_warn_msg(const char *file, bool is_kprobe)
1527 if (errno == ENOENT) {
1531 config = "CONFIG_UPROBE_EVENTS";
1533 config = "CONFIG_KPROBE_EVENTS";
1535 pr_warning("%s file does not exist - please rebuild kernel"
1536 " with %s.\n", file, config);
1538 pr_warning("Failed to open %s file: %s\n", file,
1542 static int open_probe_events(const char *trace_file, bool readwrite,
1546 const char *__debugfs;
1549 __debugfs = debugfs_find_mountpoint();
1550 if (__debugfs == NULL) {
1551 pr_warning("Debugfs is not mounted.\n");
1555 ret = e_snprintf(buf, PATH_MAX, "%s/%s", __debugfs, trace_file);
1557 pr_debug("Opening %s write=%d\n", buf, readwrite);
1558 if (readwrite && !probe_event_dry_run)
1559 ret = open(buf, O_RDWR, O_APPEND);
1561 ret = open(buf, O_RDONLY, 0);
1564 print_warn_msg(buf, is_kprobe);
1569 static int open_kprobe_events(bool readwrite)
1571 return open_probe_events("tracing/kprobe_events", readwrite, true);
1574 static int open_uprobe_events(bool readwrite)
1576 return open_probe_events("tracing/uprobe_events", readwrite, false);
1579 /* Get raw string list of current kprobe_events or uprobe_events */
1580 static struct strlist *get_probe_trace_command_rawlist(int fd)
1584 char buf[MAX_CMDLEN];
1588 sl = strlist__new(true, NULL);
1590 fp = fdopen(dup(fd), "r");
1592 p = fgets(buf, MAX_CMDLEN, fp);
1596 idx = strlen(p) - 1;
1599 ret = strlist__add(sl, buf);
1601 pr_debug("strlist__add failed: %s\n", strerror(-ret));
1602 strlist__delete(sl);
1612 static int show_perf_probe_event(struct perf_probe_event *pev)
1618 /* Synthesize only event probe point */
1619 place = synthesize_perf_probe_point(&pev->point);
1623 ret = e_snprintf(buf, 128, "%s:%s", pev->group, pev->event);
1627 printf(" %-20s (on %s", buf, place);
1629 if (pev->nargs > 0) {
1631 for (i = 0; i < pev->nargs; i++) {
1632 ret = synthesize_perf_probe_arg(&pev->args[i],
1644 static int __show_perf_probe_events(int fd, bool is_kprobe)
1647 struct probe_trace_event tev;
1648 struct perf_probe_event pev;
1649 struct strlist *rawlist;
1650 struct str_node *ent;
1652 memset(&tev, 0, sizeof(tev));
1653 memset(&pev, 0, sizeof(pev));
1655 rawlist = get_probe_trace_command_rawlist(fd);
1659 strlist__for_each(ent, rawlist) {
1660 ret = parse_probe_trace_command(ent->s, &tev);
1662 ret = convert_to_perf_probe_event(&tev, &pev,
1665 ret = show_perf_probe_event(&pev);
1667 clear_perf_probe_event(&pev);
1668 clear_probe_trace_event(&tev);
1672 strlist__delete(rawlist);
1677 /* List up current perf-probe events */
1678 int show_perf_probe_events(void)
1683 fd = open_kprobe_events(false);
1688 ret = init_vmlinux();
1692 ret = __show_perf_probe_events(fd, true);
1695 fd = open_uprobe_events(false);
1697 ret = __show_perf_probe_events(fd, false);
1704 /* Get current perf-probe event names */
1705 static struct strlist *get_probe_trace_event_names(int fd, bool include_group)
1708 struct strlist *sl, *rawlist;
1709 struct str_node *ent;
1710 struct probe_trace_event tev;
1713 memset(&tev, 0, sizeof(tev));
1714 rawlist = get_probe_trace_command_rawlist(fd);
1715 sl = strlist__new(true, NULL);
1716 strlist__for_each(ent, rawlist) {
1717 ret = parse_probe_trace_command(ent->s, &tev);
1720 if (include_group) {
1721 ret = e_snprintf(buf, 128, "%s:%s", tev.group,
1724 ret = strlist__add(sl, buf);
1726 ret = strlist__add(sl, tev.event);
1727 clear_probe_trace_event(&tev);
1731 strlist__delete(rawlist);
1734 strlist__delete(sl);
1740 static int write_probe_trace_event(int fd, struct probe_trace_event *tev)
1743 char *buf = synthesize_probe_trace_command(tev);
1746 pr_debug("Failed to synthesize probe trace event.\n");
1750 pr_debug("Writing event: %s\n", buf);
1751 if (!probe_event_dry_run) {
1752 ret = write(fd, buf, strlen(buf));
1754 pr_warning("Failed to write event: %s\n",
1761 static int get_new_event_name(char *buf, size_t len, const char *base,
1762 struct strlist *namelist, bool allow_suffix)
1767 ret = e_snprintf(buf, len, "%s", base);
1769 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1772 if (!strlist__has_entry(namelist, buf))
1775 if (!allow_suffix) {
1776 pr_warning("Error: event \"%s\" already exists. "
1777 "(Use -f to force duplicates.)\n", base);
1781 /* Try to add suffix */
1782 for (i = 1; i < MAX_EVENT_INDEX; i++) {
1783 ret = e_snprintf(buf, len, "%s_%d", base, i);
1785 pr_debug("snprintf() failed: %s\n", strerror(-ret));
1788 if (!strlist__has_entry(namelist, buf))
1791 if (i == MAX_EVENT_INDEX) {
1792 pr_warning("Too many events are on the same function.\n");
1799 static int __add_probe_trace_events(struct perf_probe_event *pev,
1800 struct probe_trace_event *tevs,
1801 int ntevs, bool allow_suffix)
1804 struct probe_trace_event *tev = NULL;
1806 const char *event, *group;
1807 struct strlist *namelist;
1810 fd = open_uprobe_events(true);
1812 fd = open_kprobe_events(true);
1816 /* Get current event names */
1817 namelist = get_probe_trace_event_names(fd, false);
1819 pr_debug("Failed to get current event list.\n");
1824 printf("Added new event%s\n", (ntevs > 1) ? "s:" : ":");
1825 for (i = 0; i < ntevs; i++) {
1830 if (pev->point.function)
1831 event = pev->point.function;
1833 event = tev->point.symbol;
1837 group = PERFPROBE_GROUP;
1839 /* Get an unused new event name */
1840 ret = get_new_event_name(buf, 64, event,
1841 namelist, allow_suffix);
1846 tev->event = strdup(event);
1847 tev->group = strdup(group);
1848 if (tev->event == NULL || tev->group == NULL) {
1852 ret = write_probe_trace_event(fd, tev);
1855 /* Add added event name to namelist */
1856 strlist__add(namelist, event);
1858 /* Trick here - save current event/group */
1861 pev->event = tev->event;
1862 pev->group = tev->group;
1863 show_perf_probe_event(pev);
1864 /* Trick here - restore current event/group */
1865 pev->event = (char *)event;
1866 pev->group = (char *)group;
1869 * Probes after the first probe which comes from same
1870 * user input are always allowed to add suffix, because
1871 * there might be several addresses corresponding to
1874 allow_suffix = true;
1878 /* Show how to use the event. */
1879 printf("\nYou can now use it in all perf tools, such as:\n\n");
1880 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev->group,
1884 strlist__delete(namelist);
1889 static int convert_to_probe_trace_events(struct perf_probe_event *pev,
1890 struct probe_trace_event **tevs,
1891 int max_tevs, const char *target)
1895 struct probe_trace_event *tev;
1897 /* Convert perf_probe_event with debuginfo */
1898 ret = try_to_find_probe_trace_events(pev, tevs, max_tevs, target);
1900 return ret; /* Found in debuginfo or got an error */
1902 /* Allocate trace event buffer */
1903 tev = *tevs = zalloc(sizeof(struct probe_trace_event));
1907 /* Copy parameters */
1908 tev->point.symbol = strdup(pev->point.function);
1909 if (tev->point.symbol == NULL) {
1915 tev->point.module = strdup(target);
1916 if (tev->point.module == NULL) {
1922 tev->point.offset = pev->point.offset;
1923 tev->point.retprobe = pev->point.retprobe;
1924 tev->nargs = pev->nargs;
1925 tev->uprobes = pev->uprobes;
1928 tev->args = zalloc(sizeof(struct probe_trace_arg)
1930 if (tev->args == NULL) {
1934 for (i = 0; i < tev->nargs; i++) {
1935 if (pev->args[i].name) {
1936 tev->args[i].name = strdup(pev->args[i].name);
1937 if (tev->args[i].name == NULL) {
1942 tev->args[i].value = strdup(pev->args[i].var);
1943 if (tev->args[i].value == NULL) {
1947 if (pev->args[i].type) {
1948 tev->args[i].type = strdup(pev->args[i].type);
1949 if (tev->args[i].type == NULL) {
1960 /* Currently just checking function name from symbol map */
1961 sym = __find_kernel_function_by_name(tev->point.symbol, NULL);
1963 pr_warning("Kernel symbol \'%s\' not found.\n",
1967 } else if (tev->point.offset > sym->end - sym->start) {
1968 pr_warning("Offset specified is greater than size of %s\n",
1977 clear_probe_trace_event(tev);
1983 struct __event_package {
1984 struct perf_probe_event *pev;
1985 struct probe_trace_event *tevs;
1989 int add_perf_probe_events(struct perf_probe_event *pevs, int npevs,
1990 int max_tevs, const char *target, bool force_add)
1993 struct __event_package *pkgs;
1996 pkgs = zalloc(sizeof(struct __event_package) * npevs);
2002 /* Init vmlinux path */
2003 ret = init_vmlinux();
2005 ret = init_user_exec();
2012 /* Loop 1: convert all events */
2013 for (i = 0; i < npevs; i++) {
2014 pkgs[i].pev = &pevs[i];
2015 /* Convert with or without debuginfo */
2016 ret = convert_to_probe_trace_events(pkgs[i].pev,
2022 pkgs[i].ntevs = ret;
2025 /* Loop 2: add all events */
2026 for (i = 0; i < npevs; i++) {
2027 ret = __add_probe_trace_events(pkgs[i].pev, pkgs[i].tevs,
2028 pkgs[i].ntevs, force_add);
2033 /* Loop 3: cleanup and free trace events */
2034 for (i = 0; i < npevs; i++) {
2035 for (j = 0; j < pkgs[i].ntevs; j++)
2036 clear_probe_trace_event(&pkgs[i].tevs[j]);
2044 static int __del_trace_probe_event(int fd, struct str_node *ent)
2050 /* Convert from perf-probe event to trace-probe event */
2051 ret = e_snprintf(buf, 128, "-:%s", ent->s);
2055 p = strchr(buf + 2, ':');
2057 pr_debug("Internal error: %s should have ':' but not.\n",
2064 pr_debug("Writing event: %s\n", buf);
2065 ret = write(fd, buf, strlen(buf));
2071 printf("Removed event: %s\n", ent->s);
2074 pr_warning("Failed to delete event: %s\n", strerror(-ret));
2078 static int del_trace_probe_event(int fd, const char *buf,
2079 struct strlist *namelist)
2081 struct str_node *ent, *n;
2084 if (strpbrk(buf, "*?")) { /* Glob-exp */
2085 strlist__for_each_safe(ent, n, namelist)
2086 if (strglobmatch(ent->s, buf)) {
2087 ret = __del_trace_probe_event(fd, ent);
2090 strlist__remove(namelist, ent);
2093 ent = strlist__find(namelist, buf);
2095 ret = __del_trace_probe_event(fd, ent);
2097 strlist__remove(namelist, ent);
2104 int del_perf_probe_events(struct strlist *dellist)
2106 int ret = -1, ufd = -1, kfd = -1;
2108 const char *group, *event;
2110 struct str_node *ent;
2111 struct strlist *namelist = NULL, *unamelist = NULL;
2113 /* Get current event names */
2114 kfd = open_kprobe_events(true);
2118 namelist = get_probe_trace_event_names(kfd, true);
2119 ufd = open_uprobe_events(true);
2122 unamelist = get_probe_trace_event_names(ufd, true);
2124 if (namelist == NULL && unamelist == NULL)
2127 strlist__for_each(ent, dellist) {
2128 str = strdup(ent->s);
2133 pr_debug("Parsing: %s\n", str);
2134 p = strchr(str, ':');
2144 ret = e_snprintf(buf, 128, "%s:%s", group, event);
2146 pr_err("Failed to copy event.");
2151 pr_debug("Group: %s, Event: %s\n", group, event);
2154 ret = del_trace_probe_event(kfd, buf, namelist);
2156 if (unamelist && ret != 0)
2157 ret = del_trace_probe_event(ufd, buf, unamelist);
2160 pr_info("Info: Event \"%s\" does not exist.\n", buf);
2168 strlist__delete(namelist);
2175 strlist__delete(unamelist);
2183 /* TODO: don't use a global variable for filter ... */
2184 static struct strfilter *available_func_filter;
2187 * If a symbol corresponds to a function with global binding and
2188 * matches filter return 0. For all others return 1.
2190 static int filter_available_functions(struct map *map __unused,
2193 if (sym->binding == STB_GLOBAL &&
2194 strfilter__compare(available_func_filter, sym->name))
2199 static int __show_available_funcs(struct map *map)
2201 if (map__load(map, filter_available_functions)) {
2202 pr_err("Failed to load map.\n");
2205 if (!dso__sorted_by_name(map->dso, map->type))
2206 dso__sort_by_name(map->dso, map->type);
2208 dso__fprintf_symbols_by_name(map->dso, map->type, stdout);
2212 static int available_kernel_funcs(const char *module)
2217 ret = init_vmlinux();
2221 map = kernel_get_module_map(module);
2223 pr_err("Failed to find %s map.\n", (module) ? : "kernel");
2226 return __show_available_funcs(map);
2229 static int available_user_funcs(const char *target)
2234 ret = init_user_exec();
2238 map = dso__new_map(target);
2239 ret = __show_available_funcs(map);
2240 dso__delete(map->dso);
2245 int show_available_funcs(const char *target, struct strfilter *_filter,
2249 available_func_filter = _filter;
2252 return available_kernel_funcs(target);
2254 return available_user_funcs(target);
2258 * uprobe_events only accepts address:
2259 * Convert function and any offset to address
2261 static int convert_name_to_addr(struct perf_probe_event *pev, const char *exec)
2263 struct perf_probe_point *pp = &pev->point;
2265 struct map *map = NULL;
2266 char *function = NULL, *name = NULL;
2268 unsigned long long vaddr = 0;
2270 if (!pp->function) {
2271 pr_warning("No function specified for uprobes");
2275 function = strdup(pp->function);
2277 pr_warning("Failed to allocate memory by strdup.\n");
2282 name = realpath(exec, NULL);
2284 pr_warning("Cannot find realpath for %s.\n", exec);
2287 map = dso__new_map(name);
2289 pr_warning("Cannot find appropriate DSO for %s.\n", exec);
2292 available_func_filter = strfilter__new(function, NULL);
2293 if (map__load(map, filter_available_functions)) {
2294 pr_err("Failed to load map.\n");
2298 sym = map__find_symbol_by_name(map, function, NULL);
2300 pr_warning("Cannot find %s in DSO %s\n", function, exec);
2304 if (map->start > sym->start)
2306 vaddr += sym->start + pp->offset + map->pgoff;
2310 pev->event = function;
2316 pev->group = zalloc(sizeof(char *) * 64);
2317 ptr1 = strdup(basename(exec));
2319 ptr2 = strpbrk(ptr1, "-._");
2322 e_snprintf(pev->group, 64, "%s_%s", PERFPROBE_GROUP,
2328 pp->function = zalloc(sizeof(char *) * MAX_PROBE_ARGS);
2329 if (!pp->function) {
2331 pr_warning("Failed to allocate memory by zalloc.\n");
2334 e_snprintf(pp->function, MAX_PROBE_ARGS, "0x%llx", vaddr);
2339 dso__delete(map->dso);