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.
23 #include <sys/utsname.h>
24 #include <sys/types.h>
47 #include "trace-event.h" /* For __unused */
48 #include "probe-event.h"
49 #include "probe-finder.h"
51 #define MAX_CMDLEN 256
52 #define MAX_PROBE_ARGS 128
53 #define PERFPROBE_GROUP "probe"
55 bool probe_event_dry_run
; /* Dry run flag */
57 #define semantic_error(msg ...) pr_err("Semantic error :" msg)
59 /* If there is no space to write, returns -E2BIG. */
60 static int e_snprintf(char *str
, size_t size
, const char *format
, ...)
61 __attribute__((format(printf
, 3, 4)));
63 static int e_snprintf(char *str
, size_t size
, const char *format
, ...)
68 ret
= vsnprintf(str
, size
, format
, ap
);
75 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
);
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
;
177 /* Open new debuginfo of given module */
178 static struct debuginfo
*open_debuginfo(const char *module
)
182 /* A file path -- this is an offline module */
183 if (module
&& strchr(module
, '/'))
186 path
= kernel_get_module_path(module
);
189 pr_err("Failed to find path of %s module.\n",
194 return debuginfo__new(path
);
198 * Convert trace point to probe point with debuginfo
199 * Currently only handles kprobes.
201 static int kprobe_convert_to_perf_probe(struct probe_trace_point
*tp
,
202 struct perf_probe_point
*pp
)
208 struct debuginfo
*dinfo
;
210 sym
= __find_kernel_function_by_name(tp
->symbol
, &map
);
212 addr
= map
->unmap_ip(map
, sym
->start
+ tp
->offset
);
213 pr_debug("try to find %s+%ld@%" PRIx64
"\n", tp
->symbol
,
216 dinfo
= debuginfo__new_online_kernel(addr
);
218 ret
= debuginfo__find_probe_point(dinfo
,
219 (unsigned long)addr
, pp
);
220 debuginfo__delete(dinfo
);
222 pr_debug("Failed to open debuginfo at 0x%" PRIx64
"\n",
228 pr_debug("Failed to find corresponding probes from "
229 "debuginfo. Use kprobe event information.\n");
230 pp
->function
= strdup(tp
->symbol
);
231 if (pp
->function
== NULL
)
233 pp
->offset
= tp
->offset
;
235 pp
->retprobe
= tp
->retprobe
;
240 static int add_module_to_probe_trace_events(struct probe_trace_event
*tevs
,
241 int ntevs
, const char *module
)
249 tmp
= strrchr(module
, '/');
251 /* This is a module path -- get the module name */
252 module
= strdup(tmp
+ 1);
255 tmp
= strchr(module
, '.');
258 tmp
= (char *)module
; /* For free() */
261 for (i
= 0; i
< ntevs
; i
++) {
262 tevs
[i
].point
.module
= strdup(module
);
263 if (!tevs
[i
].point
.module
) {
275 /* Try to find perf_probe_event with debuginfo */
276 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
277 struct probe_trace_event
**tevs
,
278 int max_tevs
, const char *module
)
280 bool need_dwarf
= perf_probe_event_need_dwarf(pev
);
281 struct debuginfo
*dinfo
= open_debuginfo(module
);
286 pr_warning("Failed to open debuginfo file.\n");
289 pr_debug("Could not open debuginfo. Try to use symbols.\n");
293 /* Searching trace events corresponding to a probe event */
294 ntevs
= debuginfo__find_trace_events(dinfo
, pev
, tevs
, max_tevs
);
296 debuginfo__delete(dinfo
);
298 if (ntevs
> 0) { /* Succeeded to find trace events */
299 pr_debug("find %d probe_trace_events.\n", ntevs
);
301 ret
= add_module_to_probe_trace_events(*tevs
, ntevs
,
303 return ret
< 0 ? ret
: ntevs
;
306 if (ntevs
== 0) { /* No error but failed to find probe point. */
307 pr_warning("Probe point '%s' not found.\n",
308 synthesize_perf_probe_point(&pev
->point
));
311 /* Error path : ntevs < 0 */
312 pr_debug("An error occurred in debuginfo analysis (%d).\n", ntevs
);
313 if (ntevs
== -EBADF
) {
314 pr_warning("Warning: No dwarf info found in the vmlinux - "
315 "please rebuild kernel with CONFIG_DEBUG_INFO=y.\n");
317 pr_debug("Trying to use symbols.\n");
325 * Find a src file from a DWARF tag path. Prepend optional source path prefix
326 * and chop off leading directories that do not exist. Result is passed back as
327 * a newly allocated path on success.
328 * Return 0 if file was found and readable, -errno otherwise.
330 static int get_real_path(const char *raw_path
, const char *comp_dir
,
333 const char *prefix
= symbol_conf
.source_prefix
;
336 if (raw_path
[0] != '/' && comp_dir
)
337 /* If not an absolute path, try to use comp_dir */
340 if (access(raw_path
, R_OK
) == 0) {
341 *new_path
= strdup(raw_path
);
348 *new_path
= malloc((strlen(prefix
) + strlen(raw_path
) + 2));
353 sprintf(*new_path
, "%s/%s", prefix
, raw_path
);
355 if (access(*new_path
, R_OK
) == 0)
358 if (!symbol_conf
.source_prefix
)
359 /* In case of searching comp_dir, don't retry */
367 raw_path
= strchr(++raw_path
, '/');
383 #define LINEBUF_SIZE 256
384 #define NR_ADDITIONAL_LINES 2
386 static int __show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
388 char buf
[LINEBUF_SIZE
];
389 const char *color
= show_num
? "" : PERF_COLOR_BLUE
;
390 const char *prefix
= NULL
;
393 if (fgets(buf
, LINEBUF_SIZE
, fp
) == NULL
)
398 prefix
= show_num
? "%7d " : " ";
399 color_fprintf(stdout
, color
, prefix
, l
);
401 color_fprintf(stdout
, color
, "%s", buf
);
403 } while (strchr(buf
, '\n') == NULL
);
408 pr_warning("File read error: %s\n", strerror(errno
));
414 static int _show_one_line(FILE *fp
, int l
, bool skip
, bool show_num
)
416 int rv
= __show_one_line(fp
, l
, skip
, show_num
);
418 pr_warning("Source file is shorter than expected.\n");
424 #define show_one_line_with_num(f,l) _show_one_line(f,l,false,true)
425 #define show_one_line(f,l) _show_one_line(f,l,false,false)
426 #define skip_one_line(f,l) _show_one_line(f,l,true,false)
427 #define show_one_line_or_eof(f,l) __show_one_line(f,l,false,false)
430 * Show line-range always requires debuginfo to find source file and
433 int show_line_range(struct line_range
*lr
, const char *module
)
436 struct line_node
*ln
;
437 struct debuginfo
*dinfo
;
442 /* Search a line range */
443 ret
= init_vmlinux();
447 dinfo
= open_debuginfo(module
);
449 pr_warning("Failed to open debuginfo file.\n");
453 ret
= debuginfo__find_line_range(dinfo
, lr
);
454 debuginfo__delete(dinfo
);
456 pr_warning("Specified source line is not found.\n");
458 } else if (ret
< 0) {
459 pr_warning("Debuginfo analysis failed. (%d)\n", ret
);
463 /* Convert source file path */
465 ret
= get_real_path(tmp
, lr
->comp_dir
, &lr
->path
);
466 free(tmp
); /* Free old path */
468 pr_warning("Failed to find source file. (%d)\n", ret
);
475 fprintf(stdout
, "<%s@%s:%d>\n", lr
->function
, lr
->path
,
476 lr
->start
- lr
->offset
);
478 fprintf(stdout
, "<%s:%d>\n", lr
->path
, lr
->start
);
480 fp
= fopen(lr
->path
, "r");
482 pr_warning("Failed to open %s: %s\n", lr
->path
,
486 /* Skip to starting line number */
487 while (l
< lr
->start
) {
488 ret
= skip_one_line(fp
, l
++);
493 list_for_each_entry(ln
, &lr
->line_list
, list
) {
494 for (; ln
->line
> l
; l
++) {
495 ret
= show_one_line(fp
, l
- lr
->offset
);
499 ret
= show_one_line_with_num(fp
, l
++ - lr
->offset
);
504 if (lr
->end
== INT_MAX
)
505 lr
->end
= l
+ NR_ADDITIONAL_LINES
;
506 while (l
<= lr
->end
) {
507 ret
= show_one_line_or_eof(fp
, l
++ - lr
->offset
);
516 static int show_available_vars_at(struct debuginfo
*dinfo
,
517 struct perf_probe_event
*pev
,
518 int max_vls
, struct strfilter
*_filter
,
523 struct str_node
*node
;
524 struct variable_list
*vls
= NULL
, *vl
;
527 buf
= synthesize_perf_probe_point(&pev
->point
);
530 pr_debug("Searching variables at %s\n", buf
);
532 ret
= debuginfo__find_available_vars_at(dinfo
, pev
, &vls
,
535 pr_err("Failed to find variables at %s (%d)\n", buf
, ret
);
538 /* Some variables are found */
539 fprintf(stdout
, "Available variables at %s\n", buf
);
540 for (i
= 0; i
< ret
; i
++) {
543 * A probe point might be converted to
544 * several trace points.
546 fprintf(stdout
, "\t@<%s+%lu>\n", vl
->point
.symbol
,
548 free(vl
->point
.symbol
);
551 strlist__for_each(node
, vl
->vars
) {
552 var
= strchr(node
->s
, '\t') + 1;
553 if (strfilter__compare(_filter
, var
)) {
554 fprintf(stdout
, "\t\t%s\n", node
->s
);
558 strlist__delete(vl
->vars
);
561 fprintf(stdout
, "\t\t(No matched variables)\n");
569 /* Show available variables on given probe point */
570 int show_available_vars(struct perf_probe_event
*pevs
, int npevs
,
571 int max_vls
, const char *module
,
572 struct strfilter
*_filter
, bool externs
)
575 struct debuginfo
*dinfo
;
577 ret
= init_vmlinux();
581 dinfo
= open_debuginfo(module
);
583 pr_warning("Failed to open debuginfo file.\n");
589 for (i
= 0; i
< npevs
&& ret
>= 0; i
++)
590 ret
= show_available_vars_at(dinfo
, &pevs
[i
], max_vls
, _filter
,
593 debuginfo__delete(dinfo
);
597 #else /* !DWARF_SUPPORT */
599 static int kprobe_convert_to_perf_probe(struct probe_trace_point
*tp
,
600 struct perf_probe_point
*pp
)
604 sym
= __find_kernel_function_by_name(tp
->symbol
, NULL
);
606 pr_err("Failed to find symbol %s in kernel.\n", tp
->symbol
);
609 pp
->function
= strdup(tp
->symbol
);
610 if (pp
->function
== NULL
)
612 pp
->offset
= tp
->offset
;
613 pp
->retprobe
= tp
->retprobe
;
618 static int try_to_find_probe_trace_events(struct perf_probe_event
*pev
,
619 struct probe_trace_event
**tevs __unused
,
620 int max_tevs __unused
, const char *mod __unused
)
622 if (perf_probe_event_need_dwarf(pev
)) {
623 pr_warning("Debuginfo-analysis is not supported.\n");
629 int show_line_range(struct line_range
*lr __unused
, const char *module __unused
)
631 pr_warning("Debuginfo-analysis is not supported.\n");
635 int show_available_vars(struct perf_probe_event
*pevs __unused
,
636 int npevs __unused
, int max_vls __unused
,
637 const char *module __unused
,
638 struct strfilter
*filter __unused
,
639 bool externs __unused
)
641 pr_warning("Debuginfo-analysis is not supported.\n");
646 static int parse_line_num(char **ptr
, int *val
, const char *what
)
648 const char *start
= *ptr
;
651 *val
= strtol(*ptr
, ptr
, 0);
652 if (errno
|| *ptr
== start
) {
653 semantic_error("'%s' is not a valid number.\n", what
);
660 * Stuff 'lr' according to the line range described by 'arg'.
661 * The line range syntax is described by:
663 * SRC[:SLN[+NUM|-ELN]]
664 * FNC[@SRC][:SLN[+NUM|-ELN]]
666 int parse_line_range_desc(const char *arg
, struct line_range
*lr
)
668 char *range
, *file
, *name
= strdup(arg
);
677 range
= strchr(name
, ':');
681 err
= parse_line_num(&range
, &lr
->start
, "start line");
685 if (*range
== '+' || *range
== '-') {
686 const char c
= *range
++;
688 err
= parse_line_num(&range
, &lr
->end
, "end line");
693 lr
->end
+= lr
->start
;
695 * Adjust the number of lines here.
696 * If the number of lines == 1, the
697 * the end of line should be equal to
704 pr_debug("Line range is %d to %d\n", lr
->start
, lr
->end
);
707 if (lr
->start
> lr
->end
) {
708 semantic_error("Start line must be smaller"
709 " than end line.\n");
712 if (*range
!= '\0') {
713 semantic_error("Tailing with invalid str '%s'.\n", range
);
718 file
= strchr(name
, '@');
721 lr
->file
= strdup(++file
);
722 if (lr
->file
== NULL
) {
727 } else if (strchr(name
, '.'))
738 /* Check the name is good for event/group */
739 static bool check_event_name(const char *name
)
741 if (!isalpha(*name
) && *name
!= '_')
743 while (*++name
!= '\0') {
744 if (!isalpha(*name
) && !isdigit(*name
) && *name
!= '_')
750 /* Parse probepoint definition. */
751 static int parse_perf_probe_point(char *arg
, struct perf_probe_event
*pev
)
753 struct perf_probe_point
*pp
= &pev
->point
;
758 * perf probe [EVENT=]SRC[:LN|;PTN]
759 * perf probe [EVENT=]FUNC[@SRC][+OFFS|%return|:LN|;PAT]
761 * TODO:Group name support
764 ptr
= strpbrk(arg
, ";=@+%");
765 if (ptr
&& *ptr
== '=') { /* Event name */
768 if (strchr(arg
, ':')) {
769 semantic_error("Group name is not supported yet.\n");
772 if (!check_event_name(arg
)) {
773 semantic_error("%s is bad for event name -it must "
774 "follow C symbol-naming rule.\n", arg
);
777 pev
->event
= strdup(arg
);
778 if (pev
->event
== NULL
)
784 ptr
= strpbrk(arg
, ";:+@%");
794 /* Check arg is function or file and copy it */
795 if (strchr(tmp
, '.')) /* File */
800 /* Parse other options */
804 if (c
== ';') { /* Lazy pattern must be the last part */
805 pp
->lazy_line
= strdup(arg
);
806 if (pp
->lazy_line
== NULL
)
810 ptr
= strpbrk(arg
, ";:+@%");
816 case ':': /* Line number */
817 pp
->line
= strtoul(arg
, &tmp
, 0);
819 semantic_error("There is non-digit char"
820 " in line number.\n");
824 case '+': /* Byte offset from a symbol */
825 pp
->offset
= strtoul(arg
, &tmp
, 0);
827 semantic_error("There is non-digit character"
832 case '@': /* File name */
834 semantic_error("SRC@SRC is not allowed.\n");
837 pp
->file
= strdup(arg
);
838 if (pp
->file
== NULL
)
841 case '%': /* Probe places */
842 if (strcmp(arg
, "return") == 0) {
844 } else { /* Others not supported yet */
845 semantic_error("%%%s is not supported.\n", arg
);
849 default: /* Buggy case */
850 pr_err("This program has a bug at %s:%d.\n",
857 /* Exclusion check */
858 if (pp
->lazy_line
&& pp
->line
) {
859 semantic_error("Lazy pattern can't be used with"
864 if (pp
->lazy_line
&& pp
->offset
) {
865 semantic_error("Lazy pattern can't be used with offset.\n");
869 if (pp
->line
&& pp
->offset
) {
870 semantic_error("Offset can't be used with line number.\n");
874 if (!pp
->line
&& !pp
->lazy_line
&& pp
->file
&& !pp
->function
) {
875 semantic_error("File always requires line number or "
880 if (pp
->offset
&& !pp
->function
) {
881 semantic_error("Offset requires an entry function.\n");
885 if (pp
->retprobe
&& !pp
->function
) {
886 semantic_error("Return probe requires an entry function.\n");
890 if ((pp
->offset
|| pp
->line
|| pp
->lazy_line
) && pp
->retprobe
) {
891 semantic_error("Offset/Line/Lazy pattern can't be used with "
896 pr_debug("symbol:%s file:%s line:%d offset:%lu return:%d lazy:%s\n",
897 pp
->function
, pp
->file
, pp
->line
, pp
->offset
, pp
->retprobe
,
902 /* Parse perf-probe event argument */
903 static int parse_perf_probe_arg(char *str
, struct perf_probe_arg
*arg
)
905 char *tmp
, *goodname
;
906 struct perf_probe_arg_field
**fieldp
;
908 pr_debug("parsing arg: %s into ", str
);
910 tmp
= strchr(str
, '=');
912 arg
->name
= strndup(str
, tmp
- str
);
913 if (arg
->name
== NULL
)
915 pr_debug("name:%s ", arg
->name
);
919 tmp
= strchr(str
, ':');
920 if (tmp
) { /* Type setting */
922 arg
->type
= strdup(tmp
+ 1);
923 if (arg
->type
== NULL
)
925 pr_debug("type:%s ", arg
->type
);
928 tmp
= strpbrk(str
, "-.[");
929 if (!is_c_varname(str
) || !tmp
) {
930 /* A variable, register, symbol or special value */
931 arg
->var
= strdup(str
);
932 if (arg
->var
== NULL
)
934 pr_debug("%s\n", arg
->var
);
938 /* Structure fields or array element */
939 arg
->var
= strndup(str
, tmp
- str
);
940 if (arg
->var
== NULL
)
943 pr_debug("%s, ", arg
->var
);
944 fieldp
= &arg
->field
;
947 *fieldp
= zalloc(sizeof(struct perf_probe_arg_field
));
950 if (*tmp
== '[') { /* Array */
952 (*fieldp
)->index
= strtol(str
+ 1, &tmp
, 0);
953 (*fieldp
)->ref
= true;
954 if (*tmp
!= ']' || tmp
== str
+ 1) {
955 semantic_error("Array index must be a"
962 } else { /* Structure */
965 (*fieldp
)->ref
= false;
966 } else if (tmp
[1] == '>') {
968 (*fieldp
)->ref
= true;
970 semantic_error("Argument parse error: %s\n",
974 tmp
= strpbrk(str
, "-.[");
977 (*fieldp
)->name
= strndup(str
, tmp
- str
);
978 if ((*fieldp
)->name
== NULL
)
981 goodname
= (*fieldp
)->name
;
982 pr_debug("%s(%d), ", (*fieldp
)->name
, (*fieldp
)->ref
);
983 fieldp
= &(*fieldp
)->next
;
986 (*fieldp
)->name
= strdup(str
);
987 if ((*fieldp
)->name
== NULL
)
990 goodname
= (*fieldp
)->name
;
991 pr_debug("%s(%d)\n", (*fieldp
)->name
, (*fieldp
)->ref
);
993 /* If no name is specified, set the last field name (not array index)*/
995 arg
->name
= strdup(goodname
);
996 if (arg
->name
== NULL
)
1002 /* Parse perf-probe event command */
1003 int parse_perf_probe_command(const char *cmd
, struct perf_probe_event
*pev
)
1006 int argc
, i
, ret
= 0;
1008 argv
= argv_split(cmd
, &argc
);
1010 pr_debug("Failed to split arguments.\n");
1013 if (argc
- 1 > MAX_PROBE_ARGS
) {
1014 semantic_error("Too many probe arguments (%d).\n", argc
- 1);
1018 /* Parse probe point */
1019 ret
= parse_perf_probe_point(argv
[0], pev
);
1023 /* Copy arguments and ensure return probe has no C argument */
1024 pev
->nargs
= argc
- 1;
1025 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1026 if (pev
->args
== NULL
) {
1030 for (i
= 0; i
< pev
->nargs
&& ret
>= 0; i
++) {
1031 ret
= parse_perf_probe_arg(argv
[i
+ 1], &pev
->args
[i
]);
1033 is_c_varname(pev
->args
[i
].var
) && pev
->point
.retprobe
) {
1034 semantic_error("You can't specify local variable for"
1045 /* Return true if this perf_probe_event requires debuginfo */
1046 bool perf_probe_event_need_dwarf(struct perf_probe_event
*pev
)
1050 if (pev
->point
.file
|| pev
->point
.line
|| pev
->point
.lazy_line
)
1053 for (i
= 0; i
< pev
->nargs
; i
++)
1054 if (is_c_varname(pev
->args
[i
].var
))
1060 /* Parse probe_events event into struct probe_point */
1061 static int parse_probe_trace_command(const char *cmd
,
1062 struct probe_trace_event
*tev
)
1064 struct probe_trace_point
*tp
= &tev
->point
;
1070 pr_debug("Parsing probe_events: %s\n", cmd
);
1071 argv
= argv_split(cmd
, &argc
);
1073 pr_debug("Failed to split arguments.\n");
1077 semantic_error("Too few probe arguments.\n");
1082 /* Scan event and group name. */
1083 ret
= sscanf(argv
[0], "%c:%a[^/ \t]/%a[^ \t]",
1084 &pr
, (float *)(void *)&tev
->group
,
1085 (float *)(void *)&tev
->event
);
1087 semantic_error("Failed to parse event name: %s\n", argv
[0]);
1091 pr_debug("Group:%s Event:%s probe:%c\n", tev
->group
, tev
->event
, pr
);
1093 tp
->retprobe
= (pr
== 'r');
1095 /* Scan module name(if there), function name and offset */
1096 p
= strchr(argv
[1], ':');
1098 tp
->module
= strndup(argv
[1], p
- argv
[1]);
1102 ret
= sscanf(p
, "%a[^+]+%lu", (float *)(void *)&tp
->symbol
,
1107 tev
->nargs
= argc
- 2;
1108 tev
->args
= zalloc(sizeof(struct probe_trace_arg
) * tev
->nargs
);
1109 if (tev
->args
== NULL
) {
1113 for (i
= 0; i
< tev
->nargs
; i
++) {
1114 p
= strchr(argv
[i
+ 2], '=');
1115 if (p
) /* We don't need which register is assigned. */
1119 tev
->args
[i
].name
= strdup(argv
[i
+ 2]);
1120 /* TODO: parse regs and offset */
1121 tev
->args
[i
].value
= strdup(p
);
1122 if (tev
->args
[i
].name
== NULL
|| tev
->args
[i
].value
== NULL
) {
1133 /* Compose only probe arg */
1134 int synthesize_perf_probe_arg(struct perf_probe_arg
*pa
, char *buf
, size_t len
)
1136 struct perf_probe_arg_field
*field
= pa
->field
;
1140 if (pa
->name
&& pa
->var
)
1141 ret
= e_snprintf(tmp
, len
, "%s=%s", pa
->name
, pa
->var
);
1143 ret
= e_snprintf(tmp
, len
, "%s", pa
->name
? pa
->name
: pa
->var
);
1150 if (field
->name
[0] == '[')
1151 ret
= e_snprintf(tmp
, len
, "%s", field
->name
);
1153 ret
= e_snprintf(tmp
, len
, "%s%s",
1154 field
->ref
? "->" : ".", field
->name
);
1159 field
= field
->next
;
1163 ret
= e_snprintf(tmp
, len
, ":%s", pa
->type
);
1172 pr_debug("Failed to synthesize perf probe argument: %s\n",
1177 /* Compose only probe point (not argument) */
1178 static char *synthesize_perf_probe_point(struct perf_probe_point
*pp
)
1181 char offs
[32] = "", line
[32] = "", file
[32] = "";
1184 buf
= zalloc(MAX_CMDLEN
);
1190 ret
= e_snprintf(offs
, 32, "+%lu", pp
->offset
);
1195 ret
= e_snprintf(line
, 32, ":%d", pp
->line
);
1203 tmp
= strchr(pp
->file
+ len
- 30, '/');
1204 tmp
= tmp
? tmp
+ 1 : pp
->file
+ len
- 30;
1206 ret
= e_snprintf(file
, 32, "@%s", tmp
);
1212 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s%s%s%s", pp
->function
,
1213 offs
, pp
->retprobe
? "%return" : "", line
,
1216 ret
= e_snprintf(buf
, MAX_CMDLEN
, "%s%s", file
, line
);
1222 pr_debug("Failed to synthesize perf probe point: %s\n",
1230 char *synthesize_perf_probe_command(struct perf_probe_event
*pev
)
1235 buf
= synthesize_perf_probe_point(&pev
->point
);
1240 for (i
= 0; i
< pev
->nargs
; i
++) {
1241 ret
= e_snprintf(&buf
[len
], MAX_CMDLEN
- len
, " %s",
1254 static int __synthesize_probe_trace_arg_ref(struct probe_trace_arg_ref
*ref
,
1255 char **buf
, size_t *buflen
,
1260 depth
= __synthesize_probe_trace_arg_ref(ref
->next
, buf
,
1266 ret
= e_snprintf(*buf
, *buflen
, "%+ld(", ref
->offset
);
1278 static int synthesize_probe_trace_arg(struct probe_trace_arg
*arg
,
1279 char *buf
, size_t buflen
)
1281 struct probe_trace_arg_ref
*ref
= arg
->ref
;
1285 /* Argument name or separator */
1287 ret
= e_snprintf(buf
, buflen
, " %s=", arg
->name
);
1289 ret
= e_snprintf(buf
, buflen
, " ");
1295 /* Special case: @XXX */
1296 if (arg
->value
[0] == '@' && arg
->ref
)
1299 /* Dereferencing arguments */
1301 depth
= __synthesize_probe_trace_arg_ref(ref
, &buf
,
1307 /* Print argument value */
1308 if (arg
->value
[0] == '@' && arg
->ref
)
1309 ret
= e_snprintf(buf
, buflen
, "%s%+ld", arg
->value
,
1312 ret
= e_snprintf(buf
, buflen
, "%s", arg
->value
);
1320 ret
= e_snprintf(buf
, buflen
, ")");
1326 /* Print argument type */
1328 ret
= e_snprintf(buf
, buflen
, ":%s", arg
->type
);
1337 char *synthesize_probe_trace_command(struct probe_trace_event
*tev
)
1339 struct probe_trace_point
*tp
= &tev
->point
;
1343 buf
= zalloc(MAX_CMDLEN
);
1347 len
= e_snprintf(buf
, MAX_CMDLEN
, "%c:%s/%s %s%s%s+%lu",
1348 tp
->retprobe
? 'r' : 'p',
1349 tev
->group
, tev
->event
,
1350 tp
->module
?: "", tp
->module
? ":" : "",
1351 tp
->symbol
, tp
->offset
);
1355 for (i
= 0; i
< tev
->nargs
; i
++) {
1356 ret
= synthesize_probe_trace_arg(&tev
->args
[i
], buf
+ len
,
1369 static int convert_to_perf_probe_event(struct probe_trace_event
*tev
,
1370 struct perf_probe_event
*pev
)
1375 /* Convert event/group name */
1376 pev
->event
= strdup(tev
->event
);
1377 pev
->group
= strdup(tev
->group
);
1378 if (pev
->event
== NULL
|| pev
->group
== NULL
)
1381 /* Convert trace_point to probe_point */
1382 ret
= kprobe_convert_to_perf_probe(&tev
->point
, &pev
->point
);
1386 /* Convert trace_arg to probe_arg */
1387 pev
->nargs
= tev
->nargs
;
1388 pev
->args
= zalloc(sizeof(struct perf_probe_arg
) * pev
->nargs
);
1389 if (pev
->args
== NULL
)
1391 for (i
= 0; i
< tev
->nargs
&& ret
>= 0; i
++) {
1392 if (tev
->args
[i
].name
)
1393 pev
->args
[i
].name
= strdup(tev
->args
[i
].name
);
1395 ret
= synthesize_probe_trace_arg(&tev
->args
[i
],
1397 pev
->args
[i
].name
= strdup(buf
);
1399 if (pev
->args
[i
].name
== NULL
&& ret
>= 0)
1404 clear_perf_probe_event(pev
);
1409 void clear_perf_probe_event(struct perf_probe_event
*pev
)
1411 struct perf_probe_point
*pp
= &pev
->point
;
1412 struct perf_probe_arg_field
*field
, *next
;
1424 free(pp
->lazy_line
);
1425 for (i
= 0; i
< pev
->nargs
; i
++) {
1426 if (pev
->args
[i
].name
)
1427 free(pev
->args
[i
].name
);
1428 if (pev
->args
[i
].var
)
1429 free(pev
->args
[i
].var
);
1430 if (pev
->args
[i
].type
)
1431 free(pev
->args
[i
].type
);
1432 field
= pev
->args
[i
].field
;
1443 memset(pev
, 0, sizeof(*pev
));
1446 static void clear_probe_trace_event(struct probe_trace_event
*tev
)
1448 struct probe_trace_arg_ref
*ref
, *next
;
1455 if (tev
->point
.symbol
)
1456 free(tev
->point
.symbol
);
1457 if (tev
->point
.module
)
1458 free(tev
->point
.module
);
1459 for (i
= 0; i
< tev
->nargs
; i
++) {
1460 if (tev
->args
[i
].name
)
1461 free(tev
->args
[i
].name
);
1462 if (tev
->args
[i
].value
)
1463 free(tev
->args
[i
].value
);
1464 if (tev
->args
[i
].type
)
1465 free(tev
->args
[i
].type
);
1466 ref
= tev
->args
[i
].ref
;
1475 memset(tev
, 0, sizeof(*tev
));
1478 static int open_kprobe_events(bool readwrite
)
1481 const char *__debugfs
;
1484 __debugfs
= debugfs_find_mountpoint();
1485 if (__debugfs
== NULL
) {
1486 pr_warning("Debugfs is not mounted.\n");
1490 ret
= e_snprintf(buf
, PATH_MAX
, "%stracing/kprobe_events", __debugfs
);
1492 pr_debug("Opening %s write=%d\n", buf
, readwrite
);
1493 if (readwrite
&& !probe_event_dry_run
)
1494 ret
= open(buf
, O_RDWR
, O_APPEND
);
1496 ret
= open(buf
, O_RDONLY
, 0);
1500 if (errno
== ENOENT
)
1501 pr_warning("kprobe_events file does not exist - please"
1502 " rebuild kernel with CONFIG_KPROBE_EVENT.\n");
1504 pr_warning("Failed to open kprobe_events file: %s\n",
1510 /* Get raw string list of current kprobe_events */
1511 static struct strlist
*get_probe_trace_command_rawlist(int fd
)
1515 char buf
[MAX_CMDLEN
];
1519 sl
= strlist__new(true, NULL
);
1521 fp
= fdopen(dup(fd
), "r");
1523 p
= fgets(buf
, MAX_CMDLEN
, fp
);
1527 idx
= strlen(p
) - 1;
1530 ret
= strlist__add(sl
, buf
);
1532 pr_debug("strlist__add failed: %s\n", strerror(-ret
));
1533 strlist__delete(sl
);
1543 static int show_perf_probe_event(struct perf_probe_event
*pev
)
1549 /* Synthesize only event probe point */
1550 place
= synthesize_perf_probe_point(&pev
->point
);
1554 ret
= e_snprintf(buf
, 128, "%s:%s", pev
->group
, pev
->event
);
1558 printf(" %-20s (on %s", buf
, place
);
1560 if (pev
->nargs
> 0) {
1562 for (i
= 0; i
< pev
->nargs
; i
++) {
1563 ret
= synthesize_perf_probe_arg(&pev
->args
[i
],
1575 /* List up current perf-probe events */
1576 int show_perf_probe_events(void)
1579 struct probe_trace_event tev
;
1580 struct perf_probe_event pev
;
1581 struct strlist
*rawlist
;
1582 struct str_node
*ent
;
1585 ret
= init_vmlinux();
1589 memset(&tev
, 0, sizeof(tev
));
1590 memset(&pev
, 0, sizeof(pev
));
1592 fd
= open_kprobe_events(false);
1596 rawlist
= get_probe_trace_command_rawlist(fd
);
1601 strlist__for_each(ent
, rawlist
) {
1602 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1604 ret
= convert_to_perf_probe_event(&tev
, &pev
);
1606 ret
= show_perf_probe_event(&pev
);
1608 clear_perf_probe_event(&pev
);
1609 clear_probe_trace_event(&tev
);
1613 strlist__delete(rawlist
);
1618 /* Get current perf-probe event names */
1619 static struct strlist
*get_probe_trace_event_names(int fd
, bool include_group
)
1622 struct strlist
*sl
, *rawlist
;
1623 struct str_node
*ent
;
1624 struct probe_trace_event tev
;
1627 memset(&tev
, 0, sizeof(tev
));
1628 rawlist
= get_probe_trace_command_rawlist(fd
);
1629 sl
= strlist__new(true, NULL
);
1630 strlist__for_each(ent
, rawlist
) {
1631 ret
= parse_probe_trace_command(ent
->s
, &tev
);
1634 if (include_group
) {
1635 ret
= e_snprintf(buf
, 128, "%s:%s", tev
.group
,
1638 ret
= strlist__add(sl
, buf
);
1640 ret
= strlist__add(sl
, tev
.event
);
1641 clear_probe_trace_event(&tev
);
1645 strlist__delete(rawlist
);
1648 strlist__delete(sl
);
1654 static int write_probe_trace_event(int fd
, struct probe_trace_event
*tev
)
1657 char *buf
= synthesize_probe_trace_command(tev
);
1660 pr_debug("Failed to synthesize probe trace event.\n");
1664 pr_debug("Writing event: %s\n", buf
);
1665 if (!probe_event_dry_run
) {
1666 ret
= write(fd
, buf
, strlen(buf
));
1668 pr_warning("Failed to write event: %s\n",
1675 static int get_new_event_name(char *buf
, size_t len
, const char *base
,
1676 struct strlist
*namelist
, bool allow_suffix
)
1681 ret
= e_snprintf(buf
, len
, "%s", base
);
1683 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
1686 if (!strlist__has_entry(namelist
, buf
))
1689 if (!allow_suffix
) {
1690 pr_warning("Error: event \"%s\" already exists. "
1691 "(Use -f to force duplicates.)\n", base
);
1695 /* Try to add suffix */
1696 for (i
= 1; i
< MAX_EVENT_INDEX
; i
++) {
1697 ret
= e_snprintf(buf
, len
, "%s_%d", base
, i
);
1699 pr_debug("snprintf() failed: %s\n", strerror(-ret
));
1702 if (!strlist__has_entry(namelist
, buf
))
1705 if (i
== MAX_EVENT_INDEX
) {
1706 pr_warning("Too many events are on the same function.\n");
1713 static int __add_probe_trace_events(struct perf_probe_event
*pev
,
1714 struct probe_trace_event
*tevs
,
1715 int ntevs
, bool allow_suffix
)
1718 struct probe_trace_event
*tev
= NULL
;
1720 const char *event
, *group
;
1721 struct strlist
*namelist
;
1723 fd
= open_kprobe_events(true);
1726 /* Get current event names */
1727 namelist
= get_probe_trace_event_names(fd
, false);
1729 pr_debug("Failed to get current event list.\n");
1734 printf("Add new event%s\n", (ntevs
> 1) ? "s:" : ":");
1735 for (i
= 0; i
< ntevs
; i
++) {
1740 if (pev
->point
.function
)
1741 event
= pev
->point
.function
;
1743 event
= tev
->point
.symbol
;
1747 group
= PERFPROBE_GROUP
;
1749 /* Get an unused new event name */
1750 ret
= get_new_event_name(buf
, 64, event
,
1751 namelist
, allow_suffix
);
1756 tev
->event
= strdup(event
);
1757 tev
->group
= strdup(group
);
1758 if (tev
->event
== NULL
|| tev
->group
== NULL
) {
1762 ret
= write_probe_trace_event(fd
, tev
);
1765 /* Add added event name to namelist */
1766 strlist__add(namelist
, event
);
1768 /* Trick here - save current event/group */
1771 pev
->event
= tev
->event
;
1772 pev
->group
= tev
->group
;
1773 show_perf_probe_event(pev
);
1774 /* Trick here - restore current event/group */
1775 pev
->event
= (char *)event
;
1776 pev
->group
= (char *)group
;
1779 * Probes after the first probe which comes from same
1780 * user input are always allowed to add suffix, because
1781 * there might be several addresses corresponding to
1784 allow_suffix
= true;
1788 /* Show how to use the event. */
1789 printf("\nYou can now use it on all perf tools, such as:\n\n");
1790 printf("\tperf record -e %s:%s -aR sleep 1\n\n", tev
->group
,
1794 strlist__delete(namelist
);
1799 static int convert_to_probe_trace_events(struct perf_probe_event
*pev
,
1800 struct probe_trace_event
**tevs
,
1801 int max_tevs
, const char *module
)
1805 struct probe_trace_event
*tev
;
1807 /* Convert perf_probe_event with debuginfo */
1808 ret
= try_to_find_probe_trace_events(pev
, tevs
, max_tevs
, module
);
1810 return ret
; /* Found in debuginfo or got an error */
1812 /* Allocate trace event buffer */
1813 tev
= *tevs
= zalloc(sizeof(struct probe_trace_event
));
1817 /* Copy parameters */
1818 tev
->point
.symbol
= strdup(pev
->point
.function
);
1819 if (tev
->point
.symbol
== NULL
) {
1825 tev
->point
.module
= strdup(module
);
1826 if (tev
->point
.module
== NULL
) {
1832 tev
->point
.offset
= pev
->point
.offset
;
1833 tev
->point
.retprobe
= pev
->point
.retprobe
;
1834 tev
->nargs
= pev
->nargs
;
1836 tev
->args
= zalloc(sizeof(struct probe_trace_arg
)
1838 if (tev
->args
== NULL
) {
1842 for (i
= 0; i
< tev
->nargs
; i
++) {
1843 if (pev
->args
[i
].name
) {
1844 tev
->args
[i
].name
= strdup(pev
->args
[i
].name
);
1845 if (tev
->args
[i
].name
== NULL
) {
1850 tev
->args
[i
].value
= strdup(pev
->args
[i
].var
);
1851 if (tev
->args
[i
].value
== NULL
) {
1855 if (pev
->args
[i
].type
) {
1856 tev
->args
[i
].type
= strdup(pev
->args
[i
].type
);
1857 if (tev
->args
[i
].type
== NULL
) {
1865 /* Currently just checking function name from symbol map */
1866 sym
= __find_kernel_function_by_name(tev
->point
.symbol
, NULL
);
1868 pr_warning("Kernel symbol \'%s\' not found.\n",
1876 clear_probe_trace_event(tev
);
1882 struct __event_package
{
1883 struct perf_probe_event
*pev
;
1884 struct probe_trace_event
*tevs
;
1888 int add_perf_probe_events(struct perf_probe_event
*pevs
, int npevs
,
1889 int max_tevs
, const char *module
, bool force_add
)
1892 struct __event_package
*pkgs
;
1894 pkgs
= zalloc(sizeof(struct __event_package
) * npevs
);
1898 /* Init vmlinux path */
1899 ret
= init_vmlinux();
1905 /* Loop 1: convert all events */
1906 for (i
= 0; i
< npevs
; i
++) {
1907 pkgs
[i
].pev
= &pevs
[i
];
1908 /* Convert with or without debuginfo */
1909 ret
= convert_to_probe_trace_events(pkgs
[i
].pev
,
1915 pkgs
[i
].ntevs
= ret
;
1918 /* Loop 2: add all events */
1919 for (i
= 0; i
< npevs
; i
++) {
1920 ret
= __add_probe_trace_events(pkgs
[i
].pev
, pkgs
[i
].tevs
,
1921 pkgs
[i
].ntevs
, force_add
);
1926 /* Loop 3: cleanup and free trace events */
1927 for (i
= 0; i
< npevs
; i
++) {
1928 for (j
= 0; j
< pkgs
[i
].ntevs
; j
++)
1929 clear_probe_trace_event(&pkgs
[i
].tevs
[j
]);
1937 static int __del_trace_probe_event(int fd
, struct str_node
*ent
)
1943 /* Convert from perf-probe event to trace-probe event */
1944 ret
= e_snprintf(buf
, 128, "-:%s", ent
->s
);
1948 p
= strchr(buf
+ 2, ':');
1950 pr_debug("Internal error: %s should have ':' but not.\n",
1957 pr_debug("Writing event: %s\n", buf
);
1958 ret
= write(fd
, buf
, strlen(buf
));
1962 printf("Remove event: %s\n", ent
->s
);
1965 pr_warning("Failed to delete event: %s\n", strerror(-ret
));
1969 static int del_trace_probe_event(int fd
, const char *group
,
1970 const char *event
, struct strlist
*namelist
)
1973 struct str_node
*ent
, *n
;
1974 int found
= 0, ret
= 0;
1976 ret
= e_snprintf(buf
, 128, "%s:%s", group
, event
);
1978 pr_err("Failed to copy event.\n");
1982 if (strpbrk(buf
, "*?")) { /* Glob-exp */
1983 strlist__for_each_safe(ent
, n
, namelist
)
1984 if (strglobmatch(ent
->s
, buf
)) {
1986 ret
= __del_trace_probe_event(fd
, ent
);
1989 strlist__remove(namelist
, ent
);
1992 ent
= strlist__find(namelist
, buf
);
1995 ret
= __del_trace_probe_event(fd
, ent
);
1997 strlist__remove(namelist
, ent
);
2000 if (found
== 0 && ret
>= 0)
2001 pr_info("Info: Event \"%s\" does not exist.\n", buf
);
2006 int del_perf_probe_events(struct strlist
*dellist
)
2009 const char *group
, *event
;
2011 struct str_node
*ent
;
2012 struct strlist
*namelist
;
2014 fd
= open_kprobe_events(true);
2018 /* Get current event names */
2019 namelist
= get_probe_trace_event_names(fd
, true);
2020 if (namelist
== NULL
)
2023 strlist__for_each(ent
, dellist
) {
2024 str
= strdup(ent
->s
);
2029 pr_debug("Parsing: %s\n", str
);
2030 p
= strchr(str
, ':');
2039 pr_debug("Group: %s, Event: %s\n", group
, event
);
2040 ret
= del_trace_probe_event(fd
, group
, event
, namelist
);
2045 strlist__delete(namelist
);
2050 /* TODO: don't use a global variable for filter ... */
2051 static struct strfilter
*available_func_filter
;
2054 * If a symbol corresponds to a function with global binding and
2055 * matches filter return 0. For all others return 1.
2057 static int filter_available_functions(struct map
*map __unused
,
2060 if (sym
->binding
== STB_GLOBAL
&&
2061 strfilter__compare(available_func_filter
, sym
->name
))
2066 int show_available_funcs(const char *module
, struct strfilter
*_filter
)
2073 ret
= init_vmlinux();
2077 map
= kernel_get_module_map(module
);
2079 pr_err("Failed to find %s map.\n", (module
) ? : "kernel");
2082 available_func_filter
= _filter
;
2083 if (map__load(map
, filter_available_functions
)) {
2084 pr_err("Failed to load map.\n");
2087 if (!dso__sorted_by_name(map
->dso
, map
->type
))
2088 dso__sort_by_name(map
->dso
, map
->type
);
2090 dso__fprintf_symbols_by_name(map
->dso
, map
->type
, stdout
);