2009-10-08 06:27:48 +08:00
|
|
|
Kprobe-based Event Tracer
|
2009-08-20 03:13:57 +08:00
|
|
|
=========================
|
|
|
|
|
|
|
|
Documentation is written by Masami Hiramatsu
|
|
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
--------
|
|
|
|
This tracer is similar to the events tracer which is based on Tracepoint
|
|
|
|
infrastructure. Instead of Tracepoint, this tracer is based on kprobes(kprobe
|
|
|
|
and kretprobe). It probes anywhere where kprobes can probe(this means, all
|
|
|
|
functions body except for __kprobes functions).
|
|
|
|
|
|
|
|
Unlike the function tracer, this tracer can probe instructions inside of
|
|
|
|
kernel functions. It allows you to check which instruction has been executed.
|
|
|
|
|
|
|
|
Unlike the Tracepoint based events tracer, this tracer can add and remove
|
|
|
|
probe points on the fly.
|
|
|
|
|
|
|
|
Similar to the events tracer, this tracer doesn't need to be activated via
|
|
|
|
current_tracer, instead of that, just set probe points via
|
|
|
|
/sys/kernel/debug/tracing/kprobe_events. And you can set filters on each
|
|
|
|
probe events via /sys/kernel/debug/tracing/events/kprobes/<EVENT>/filter.
|
|
|
|
|
|
|
|
|
|
|
|
Synopsis of kprobe_events
|
|
|
|
-------------------------
|
2009-09-11 07:53:53 +08:00
|
|
|
p[:[GRP/]EVENT] SYMBOL[+offs]|MEMADDR [FETCHARGS] : Set a probe
|
|
|
|
r[:[GRP/]EVENT] SYMBOL[+0] [FETCHARGS] : Set a return probe
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-09-11 07:53:53 +08:00
|
|
|
GRP : Group name. If omitted, use "kprobes" for it.
|
2009-09-11 07:53:14 +08:00
|
|
|
EVENT : Event name. If omitted, the event name is generated
|
|
|
|
based on SYMBOL+offs or MEMADDR.
|
|
|
|
SYMBOL[+offs] : Symbol+offset where the probe is inserted.
|
|
|
|
MEMADDR : Address where the probe is inserted.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-09-11 07:53:14 +08:00
|
|
|
FETCHARGS : Arguments. Each probe can have up to 128 args.
|
2009-08-20 03:13:57 +08:00
|
|
|
%REG : Fetch register REG
|
|
|
|
@ADDR : Fetch memory at ADDR (ADDR should be in kernel)
|
|
|
|
@SYM[+|-offs] : Fetch memory at SYM +|- offs (SYM should be a data symbol)
|
2009-10-08 06:27:40 +08:00
|
|
|
$sN : Fetch Nth entry of stack (N >= 0)
|
|
|
|
$sa : Fetch stack address.
|
|
|
|
$aN : Fetch function argument. (N >= 0)(*)
|
|
|
|
$rv : Fetch return value.(**)
|
2009-09-11 07:53:38 +08:00
|
|
|
+|-offs(FETCHARG) : Fetch memory at FETCHARG +|- offs address.(***)
|
|
|
|
NAME=FETCHARG: Set NAME as the argument name of FETCHARG.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
(*) aN may not correct on asmlinkaged functions and at the middle of
|
|
|
|
function body.
|
|
|
|
(**) only for return probe.
|
|
|
|
(***) this is useful for fetching a field of data structures.
|
|
|
|
|
|
|
|
|
|
|
|
Per-Probe Event Filtering
|
|
|
|
-------------------------
|
|
|
|
Per-probe event filtering feature allows you to set different filter on each
|
|
|
|
probe and gives you what arguments will be shown in trace buffer. If an event
|
|
|
|
name is specified right after 'p:' or 'r:' in kprobe_events, the tracer adds
|
|
|
|
an event under tracing/events/kprobes/<EVENT>, at the directory you can see
|
|
|
|
'id', 'enabled', 'format' and 'filter'.
|
|
|
|
|
|
|
|
enabled:
|
|
|
|
You can enable/disable the probe by writing 1 or 0 on it.
|
|
|
|
|
|
|
|
format:
|
2009-09-11 07:53:38 +08:00
|
|
|
This shows the format of this probe event.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
filter:
|
2009-09-11 07:53:38 +08:00
|
|
|
You can write filtering rules of this event.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-09-11 07:53:30 +08:00
|
|
|
id:
|
|
|
|
This shows the id of this probe event.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-08-14 04:35:42 +08:00
|
|
|
Event Profiling
|
|
|
|
---------------
|
|
|
|
You can check the total number of probe hits and probe miss-hits via
|
|
|
|
/sys/kernel/debug/tracing/kprobe_profile.
|
|
|
|
The first column is event name, the second is the number of probe hits,
|
|
|
|
the third is the number of probe miss-hits.
|
|
|
|
|
|
|
|
|
2009-08-20 03:13:57 +08:00
|
|
|
Usage examples
|
|
|
|
--------------
|
|
|
|
To add a probe as a new event, write a new definition to kprobe_events
|
|
|
|
as below.
|
|
|
|
|
2009-10-08 06:27:40 +08:00
|
|
|
echo p:myprobe do_sys_open dfd=$a0 filename=$a1 flags=$a2 mode=$a3 > /sys/kernel/debug/tracing/kprobe_events
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
This sets a kprobe on the top of do_sys_open() function with recording
|
2009-09-11 07:53:38 +08:00
|
|
|
1st to 4th arguments as "myprobe" event. As this example shows, users can
|
|
|
|
choose more familiar names for each arguments.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-10-08 06:27:48 +08:00
|
|
|
echo r:myretprobe do_sys_open $rv >> /sys/kernel/debug/tracing/kprobe_events
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
This sets a kretprobe on the return point of do_sys_open() function with
|
2009-10-08 06:27:48 +08:00
|
|
|
recording return value as "myretprobe" event.
|
2009-08-20 03:13:57 +08:00
|
|
|
You can see the format of these events via
|
|
|
|
/sys/kernel/debug/tracing/events/kprobes/<EVENT>/format.
|
|
|
|
|
|
|
|
cat /sys/kernel/debug/tracing/events/kprobes/myprobe/format
|
|
|
|
name: myprobe
|
2009-09-11 07:53:38 +08:00
|
|
|
ID: 75
|
2009-08-20 03:13:57 +08:00
|
|
|
format:
|
|
|
|
field:unsigned short common_type; offset:0; size:2;
|
|
|
|
field:unsigned char common_flags; offset:2; size:1;
|
|
|
|
field:unsigned char common_preempt_count; offset:3; size:1;
|
|
|
|
field:int common_pid; offset:4; size:4;
|
|
|
|
field:int common_tgid; offset:8; size:4;
|
|
|
|
|
|
|
|
field: unsigned long ip; offset:16;tsize:8;
|
|
|
|
field: int nargs; offset:24;tsize:4;
|
2009-09-11 07:53:38 +08:00
|
|
|
field: unsigned long dfd; offset:32;tsize:8;
|
|
|
|
field: unsigned long filename; offset:40;tsize:8;
|
|
|
|
field: unsigned long flags; offset:48;tsize:8;
|
|
|
|
field: unsigned long mode; offset:56;tsize:8;
|
2009-08-20 03:13:57 +08:00
|
|
|
|
2009-09-11 07:53:45 +08:00
|
|
|
print fmt: "(%lx) dfd=%lx filename=%lx flags=%lx mode=%lx", REC->ip, REC->dfd, REC->filename, REC->flags, REC->mode
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
|
2009-09-11 07:53:38 +08:00
|
|
|
You can see that the event has 4 arguments as in the expressions you specified.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
echo > /sys/kernel/debug/tracing/kprobe_events
|
|
|
|
|
2009-09-15 04:49:37 +08:00
|
|
|
This clears all probe points.
|
|
|
|
|
|
|
|
Right after definition, each event is disabled by default. For tracing these
|
|
|
|
events, you need to enable it.
|
|
|
|
|
|
|
|
echo 1 > /sys/kernel/debug/tracing/events/kprobes/myprobe/enable
|
|
|
|
echo 1 > /sys/kernel/debug/tracing/events/kprobes/myretprobe/enable
|
|
|
|
|
|
|
|
And you can see the traced information via /sys/kernel/debug/tracing/trace.
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
cat /sys/kernel/debug/tracing/trace
|
|
|
|
# tracer: nop
|
|
|
|
#
|
|
|
|
# TASK-PID CPU# TIMESTAMP FUNCTION
|
|
|
|
# | | | | |
|
2009-09-11 07:53:45 +08:00
|
|
|
<...>-1447 [001] 1038282.286875: myprobe: (do_sys_open+0x0/0xd6) dfd=3 filename=7fffd1ec4440 flags=8000 mode=0
|
2009-10-08 06:27:48 +08:00
|
|
|
<...>-1447 [001] 1038282.286878: myretprobe: (sys_openat+0xc/0xe <- do_sys_open) $rv=fffffffffffffffe
|
2009-09-11 07:53:45 +08:00
|
|
|
<...>-1447 [001] 1038282.286885: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=40413c flags=8000 mode=1b6
|
2009-10-08 06:27:48 +08:00
|
|
|
<...>-1447 [001] 1038282.286915: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $rv=3
|
2009-09-11 07:53:45 +08:00
|
|
|
<...>-1447 [001] 1038282.286969: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=4041c6 flags=98800 mode=10
|
2009-10-08 06:27:48 +08:00
|
|
|
<...>-1447 [001] 1038282.286976: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $rv=3
|
2009-08-20 03:13:57 +08:00
|
|
|
|
|
|
|
|
2009-09-11 07:53:45 +08:00
|
|
|
Each line shows when the kernel hits an event, and <- SYMBOL means kernel
|
2009-08-20 03:13:57 +08:00
|
|
|
returns from SYMBOL(e.g. "sys_open+0x1b/0x1d <- do_sys_open" means kernel
|
|
|
|
returns from do_sys_open to sys_open+0x1b).
|
|
|
|
|
|
|
|
|