<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Kprobe-based Event Tracing — The Linux Kernel documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=3918102e" />
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Fprobe-based Event Tracing" href="fprobetrace.html" />
<link rel="prev" title="Kernel Probes (Kprobes)" href="kprobes.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo.svg" alt="Logo of The Linux Kernel"/>
</a></p>
<h1 class="logo"><a href="../index.html">The Linux Kernel</a></h1>
<p class="blurb">6.18.50</p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<p>
<h3 class="kernel-toc-contents">Contents</h3>
<input type="checkbox" class="kernel-toc-toggle" id = "kernel-toc-toggle" checked>
<label class="kernel-toc-title" for="kernel-toc-toggle"></label>
<div class="kerneltoc" id="kerneltoc">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../process/development-process.html">Development process</a></li>
<li class="toctree-l1"><a class="reference internal" href="../process/submitting-patches.html">Submitting patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../process/code-of-conduct.html">Code of conduct</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintainer/index.html">Maintainer handbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../process/index.html">All development-process docs</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../core-api/index.html">Core API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../driver-api/index.html">Driver APIs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../subsystem-apis.html">Subsystems</a></li>
<li class="toctree-l1"><a class="reference internal" href="../locking/index.html">Locking</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../process/license-rules.html">Licensing rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../doc-guide/index.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev-tools/index.html">Development tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../dev-tools/testing-overview.html">Testing guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../kernel-hacking/index.html">Hacking guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Tracing</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="index.html#introduction-to-tracing">Introduction to Tracing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html#core-tracing-frameworks">Core Tracing Frameworks</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="ftrace.html">ftrace - Function Tracer</a></li>
<li class="toctree-l3"><a class="reference internal" href="ftrace-design.html">Function Tracer Design</a></li>
<li class="toctree-l3"><a class="reference internal" href="ftrace-uses.html">Using ftrace to hook to functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="kprobes.html">Kernel Probes (Kprobes)</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Kprobe-based Event Tracing</a></li>
<li class="toctree-l3"><a class="reference internal" href="fprobetrace.html">Fprobe-based Event Tracing</a></li>
<li class="toctree-l3"><a class="reference internal" href="eprobetrace.html">Eprobe - Event-based Probe Tracing</a></li>
<li class="toctree-l3"><a class="reference internal" href="fprobe.html">Fprobe - Function entry/exit probe</a></li>
<li class="toctree-l3"><a class="reference internal" href="ring-buffer-design.html">Lockless Ring Buffer Design</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="index.html#event-tracing-and-analysis">Event Tracing and Analysis</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#hardware-and-performance-tracing">Hardware and Performance Tracing</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#user-space-tracing">User-Space Tracing</a></li>
<li class="toctree-l2"><a class="reference internal" href="index.html#additional-resources">Additional Resources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../fault-injection/index.html">Fault injection</a></li>
<li class="toctree-l1"><a class="reference internal" href="../livepatch/index.html">Livepatching</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rust/index.html">Rust</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../admin-guide/index.html">Administration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../kbuild/index.html">Build system</a></li>
<li class="toctree-l1"><a class="reference internal" href="../admin-guide/reporting-issues.html">Reporting issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Userspace tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../userspace-api/index.html">Userspace API</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../firmware-guide/index.html">Firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../devicetree/index.html">Firmware and Devicetree</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../arch/index.html">CPU architectures</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../staging/index.html">Unsorted documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../translations/index.html">Translations</a></li>
</ul>
</div>
<script type="text/javascript"> <!--
var sbar = document.getElementsByClassName("sphinxsidebar")[0];
let currents = document.getElementsByClassName("current")
if (currents.length) {
sbar.scrollTop = currents[currents.length - 1].offsetTop;
}
--> </script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/trace/kprobetrace.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="kprobe-based-event-tracing">
<h1>Kprobe-based Event Tracing<a class="headerlink" href="#kprobe-based-event-tracing" title="Link to this heading">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Masami Hiramatsu</p>
</dd>
</dl>
<section id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>
<p>These events are similar to tracepoint-based events. Instead of tracepoints,
this is based on kprobes (kprobe and kretprobe). So it can probe wherever
kprobes can probe (this means, all functions except those with
__kprobes/nokprobe_inline annotation and those marked NOKPROBE_SYMBOL).
Unlike the tracepoint-based event, this can be added and removed
dynamically, on the fly.</p>
<p>To enable this feature, build your kernel with CONFIG_KPROBE_EVENTS=y.</p>
<p>Similar to the event tracer, this doesn’t need to be activated via
current_tracer. Instead of that, add probe points via
/sys/kernel/tracing/kprobe_events, and enable it via
/sys/kernel/tracing/events/kprobes/<EVENT>/enable.</p>
<p>You can also use /sys/kernel/tracing/dynamic_events instead of
kprobe_events. That interface will provide unified access to other
dynamic events too.</p>
</section>
<section id="synopsis-of-kprobe-events">
<h2>Synopsis of kprobe_events<a class="headerlink" href="#synopsis-of-kprobe-events" title="Link to this heading">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span> p[:[GRP/][EVENT]] [MOD:]SYM[+offs]|MEMADDR [FETCHARGS] : Set a probe
r[MAXACTIVE][:[GRP/][EVENT]] [MOD:]SYM[+0] [FETCHARGS] : Set a return probe
p[:[GRP/][EVENT]] [MOD:]SYM[+0]%return [FETCHARGS] : Set a return probe
-:[GRP/][EVENT] : Clear a probe
GRP : Group name. If omitted, use "kprobes" for it.
EVENT : Event name. If omitted, the event name is generated
based on SYM+offs or MEMADDR.
MOD : Module name which has given SYM.
SYM[+offs] : Symbol+offset where the probe is inserted.
SYM%return : Return address of the symbol
MEMADDR : Address where the probe is inserted.
MAXACTIVE : Maximum number of instances of the specified function that
can be probed simultaneously, or 0 for the default value
as defined in Documentation/trace/kprobes.rst section 1.3.1.
FETCHARGS : Arguments. Each probe can have up to 128 args.
%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)
$stackN : Fetch Nth entry of stack (N >= 0)
$stack : Fetch stack address.
$argN : Fetch the Nth function argument. (N >= 1) (\*1)
$retval : Fetch return value.(\*2)
$comm : Fetch current task comm.
+|-[u]OFFS(FETCHARG) : Fetch memory at FETCHARG +|- OFFS address.(\*3)(\*4)
\IMM : Store an immediate value to the argument.
NAME=FETCHARG : Set NAME as the argument name of FETCHARG.
FETCHARG:TYPE : Set TYPE as the type of FETCHARG. Currently, basic types
(u8/u16/u32/u64/s8/s16/s32/s64), hexadecimal types
(x8/x16/x32/x64), VFS layer common type(%pd/%pD), "char",
"string", "ustring", "symbol", "symstr" and bitfield are
supported.
(\*1) only for the probe on function entry (offs == 0). Note, this argument access
is best effort, because depending on the argument type, it may be passed on
the stack. But this only support the arguments via registers.
(\*2) only for return probe. Note that this is also best effort. Depending on the
return value type, it might be passed via a pair of registers. But this only
accesses one register.
(\*3) this is useful for fetching a field of data structures.
(\*4) "u" means user-space dereference. See :ref:`user_mem_access`.
</pre></div>
</div>
</section>
<section id="function-arguments-at-kretprobe">
<h2>Function arguments at kretprobe<a class="headerlink" href="#function-arguments-at-kretprobe" title="Link to this heading">¶</a></h2>
<p>Function arguments can be accessed at kretprobe using $arg<N> fetcharg. This
is useful to record the function parameter and return value at once, and
trace the difference of structure fields (for debugging a function whether it
correctly updates the given data structure or not).
See the <a class="reference internal" href="fprobetrace.html#fprobetrace-exit-args-sample"><span class="std std-ref">sample</span></a> in fprobe event for how
it works.</p>
</section>
<section id="types">
<span id="kprobetrace-types"></span><h2>Types<a class="headerlink" href="#types" title="Link to this heading">¶</a></h2>
<p>Several types are supported for fetchargs. Kprobe tracer will access memory
by given type. Prefix ‘s’ and ‘u’ means those types are signed and unsigned
respectively. ‘x’ prefix implies it is unsigned. Traced arguments are shown
in decimal (‘s’ and ‘u’) or hexadecimal (‘x’). Without type casting, ‘x32’
or ‘x64’ is used depends on the architecture (e.g. x86-32 uses x32, and
x86-64 uses x64).</p>
<p>These value types can be an array. To record array data, you can add ‘[N]’
(where N is a fixed number, less than 64) to the base type.
E.g. ‘x16[4]’ means an array of x16 (2-byte hex) with 4 elements.
Note that the array can be applied to memory type fetchargs, you can not
apply it to registers/stack-entries etc. (for example, ‘$stack1:x8[8]’ is
wrong, but ‘+8($stack):x8[8]’ is OK.)</p>
<p>Char type can be used to show the character value of traced arguments.</p>
<p>String type is a special type, which fetches a “null-terminated” string from
kernel space. This means it will fail and store NULL if the string container
has been paged out. “ustring” type is an alternative of string for user-space.
See <a class="reference internal" href="#user-mem-access"><span class="std std-ref">User Memory Access</span></a> for more info.</p>
<p>The string array type is a bit different from other types. For other base
types, <base-type>[1] is equal to <base-type> (e.g. +0(%di):x32[1] is same
as +0(%di):x32.) But string[1] is not equal to string. The string type itself
represents “char array”, but string array type represents “char * array”.
So, for example, +0(%di):string[1] is equal to +0(+0(%di)):string.
Bitfield is another special type, which takes 3 parameters, bit-width, bit-
offset, and container-size (usually 32). The syntax is:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>b<bit-width>@<bit-offset>/<container-size>
</pre></div>
</div>
<p>Symbol type(‘symbol’) is an alias of u32 or u64 type (depends on BITS_PER_LONG)
which shows given pointer in “symbol+offset” style.
On the other hand, symbol-string type (‘symstr’) converts the given address to
“symbol+offset/symbolsize” style and stores it as a null-terminated string.
With ‘symstr’ type, you can filter the event with wildcard pattern of the
symbols, and you don’t need to solve symbol name by yourself.
For $comm, the default type is “string”; any other type is invalid.</p>
<p>VFS layer common type(%pd/%pD) is a special type, which fetches dentry’s or
file’s name from <code class="xref c c-struct broken_xref docutils literal notranslate"><span class="pre">struct</span> <span class="pre">dentry</span></code>’s address or <a class="reference internal" href="../filesystems/api-summary.html#c.file" title="file"><code class="xref c c-struct docutils literal notranslate"><span class="pre">struct</span> <span class="pre">file</span></code></a>’s address.</p>
</section>
<section id="user-memory-access">
<span id="user-mem-access"></span><h2>User Memory Access<a class="headerlink" href="#user-memory-access" title="Link to this heading">¶</a></h2>
<p>Kprobe events supports user-space memory access. For that purpose, you can use
either user-space dereference syntax or ‘ustring’ type.</p>
<p>The user-space dereference syntax allows you to access a field of a data
structure in user-space. This is done by adding the “u” prefix to the
dereference syntax. For example, +u4(%si) means it will read memory from the
address in the register %si offset by 4, and the memory is expected to be in
user-space. You can use this for strings too, e.g. +u0(%si):string will read
a string from the address in the register %si that is expected to be in user-
space. ‘ustring’ is a shortcut way of performing the same task. That is,
+0(%si):ustring is equivalent to +u0(%si):string.</p>
<p>Note that kprobe-event provides the user-memory access syntax but it doesn’t
use it transparently. This means if you use normal dereference or string type
for user memory, it might fail, and may always fail on some architectures. The
user has to carefully check if the target data is in kernel or user space.</p>
</section>
<section id="per-probe-event-filtering">
<h2>Per-Probe Event Filtering<a class="headerlink" href="#per-probe-event-filtering" title="Link to this heading">¶</a></h2>
<p>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, it adds an event
under tracing/events/kprobes/<EVENT>, at the directory you can see ‘id’,
‘enable’, ‘format’, ‘filter’ and ‘trigger’.</p>
<dl class="simple">
<dt>enable:</dt><dd><p>You can enable/disable the probe by writing 1 or 0 on it.</p>
</dd>
<dt>format:</dt><dd><p>This shows the format of this probe event.</p>
</dd>
<dt>filter:</dt><dd><p>You can write filtering rules of this event.</p>
</dd>
<dt>id:</dt><dd><p>This shows the id of this probe event.</p>
</dd>
<dt>trigger:</dt><dd><p>This allows to install trigger commands which are executed when the event is
hit (for details, see <a class="reference internal" href="events.html"><span class="doc">Event Tracing</span></a>, section 6).</p>
</dd>
</dl>
</section>
<section id="event-profiling">
<h2>Event Profiling<a class="headerlink" href="#event-profiling" title="Link to this heading">¶</a></h2>
<p>You can check the total number of probe hits and probe miss-hits via
/sys/kernel/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.</p>
</section>
<section id="kernel-boot-parameter">
<h2>Kernel Boot Parameter<a class="headerlink" href="#kernel-boot-parameter" title="Link to this heading">¶</a></h2>
<p>You can add and enable new kprobe events when booting up the kernel by
“kprobe_event=” parameter. The parameter accepts a semicolon-delimited
kprobe events, which format is similar to the kprobe_events.
The difference is that the probe definition parameters are comma-delimited
instead of space. For example, adding myprobe event on do_sys_open like below:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>p:myprobe do_sys_open dfd=%ax filename=%dx flags=%cx mode=+4($stack)
</pre></div>
</div>
<p>should be below for kernel boot parameter (just replace spaces with comma):</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>p:myprobe,do_sys_open,dfd=%ax,filename=%dx,flags=%cx,mode=+4($stack)
</pre></div>
</div>
</section>
<section id="usage-examples">
<h2>Usage examples<a class="headerlink" href="#usage-examples" title="Link to this heading">¶</a></h2>
<p>To add a probe as a new event, write a new definition to kprobe_events
as below:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo 'p:myprobe do_sys_open dfd=%ax filename=%dx flags=%cx mode=+4($stack)' > /sys/kernel/tracing/kprobe_events
</pre></div>
</div>
<p>This sets a kprobe on the top of <code class="xref c c-func broken_xref docutils literal notranslate"><span class="pre">do_sys_open()</span></code> function with recording
1st to 4th arguments as “myprobe” event. Note, which register/stack entry is
assigned to each function argument depends on arch-specific ABI. If you unsure
the ABI, please try to use probe subcommand of perf-tools (you can find it
under tools/perf/).
As this example shows, users can choose more familiar names for each arguments.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo 'r:myretprobe do_sys_open $retval' >> /sys/kernel/tracing/kprobe_events
</pre></div>
</div>
<p>This sets a kretprobe on the return point of <code class="xref c c-func broken_xref docutils literal notranslate"><span class="pre">do_sys_open()</span></code> function with
recording return value as “myretprobe” event.
You can see the format of these events via
/sys/kernel/tracing/events/kprobes/<EVENT>/format.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cat /sys/kernel/tracing/events/kprobes/myprobe/format
name: myprobe
ID: 780
format:
field:unsigned short common_type; offset:0; size:2; signed:0;
field:unsigned char common_flags; offset:2; size:1; signed:0;
field:unsigned char common_preempt_count; offset:3; size:1;signed:0;
field:int common_pid; offset:4; size:4; signed:1;
field:unsigned long __probe_ip; offset:12; size:4; signed:0;
field:int __probe_nargs; offset:16; size:4; signed:1;
field:unsigned long dfd; offset:20; size:4; signed:0;
field:unsigned long filename; offset:24; size:4; signed:0;
field:unsigned long flags; offset:28; size:4; signed:0;
field:unsigned long mode; offset:32; size:4; signed:0;
print fmt: "(%lx) dfd=%lx filename=%lx flags=%lx mode=%lx", REC->__probe_ip,
REC->dfd, REC->filename, REC->flags, REC->mode
</pre></div>
</div>
<p>You can see that the event has 4 arguments as in the expressions you specified.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo > /sys/kernel/tracing/kprobe_events
</pre></div>
</div>
<p>This clears all probe points.</p>
<p>Or,</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo -:myprobe >> kprobe_events
</pre></div>
</div>
<p>This clears probe points selectively.</p>
<p>Right after definition, each event is disabled by default. For tracing these
events, you need to enable it.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo 1 > /sys/kernel/tracing/events/kprobes/myprobe/enable
echo 1 > /sys/kernel/tracing/events/kprobes/myretprobe/enable
</pre></div>
</div>
<p>Use the following command to start tracing in an interval.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span># echo 1 > tracing_on
Open something...
# echo 0 > tracing_on
</pre></div>
</div>
<p>And you can see the traced information via /sys/kernel/tracing/trace.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>cat /sys/kernel/tracing/trace
# tracer: nop
#
# TASK-PID CPU# TIMESTAMP FUNCTION
# | | | | |
<...>-1447 [001] 1038282.286875: myprobe: (do_sys_open+0x0/0xd6) dfd=3 filename=7fffd1ec4440 flags=8000 mode=0
<...>-1447 [001] 1038282.286878: myretprobe: (sys_openat+0xc/0xe <- do_sys_open) $retval=fffffffffffffffe
<...>-1447 [001] 1038282.286885: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=40413c flags=8000 mode=1b6
<...>-1447 [001] 1038282.286915: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $retval=3
<...>-1447 [001] 1038282.286969: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=4041c6 flags=98800 mode=10
<...>-1447 [001] 1038282.286976: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $retval=3
</pre></div>
</div>
<p>Each line shows when the kernel hits an event, and <- SYMBOL means kernel
returns from SYMBOL(e.g. “sys_open+0x1b/0x1d <- do_sys_open” means kernel
returns from do_sys_open to sys_open+0x1b).</p>
</section>
</section>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©The kernel development community.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
|
<a href="../_sources/trace/kprobetrace.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>