Skip to content

Commit 59d1eaa

Browse files
Documentation/rtla: Include BPF sample collection
JIRA: https://issues.redhat.com/browse/RHEL-117873 commit 770840a Author: Tomas Glozar <tglozar@redhat.com> Date: Tue Mar 11 12:49:36 2025 +0100 Documentation/rtla: Include BPF sample collection Add dependencies needed to build rtla with BPF sample collection support to README, and document both ways of sample collection in the manpages. Signed-off-by: Tomas Glozar <tglozar@redhat.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-5-tglozar@redhat.com Signed-off-by: Tomas Glozar <tglozar@redhat.com>
1 parent ce35f9e commit 59d1eaa

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

Documentation/tools/rtla/common_timerlat_description.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,11 @@ The *timerlat* tracer outputs information in two ways. It periodically
88
prints the timer latency at the timer *IRQ* handler and the *Thread*
99
handler. It also enables the trace of the most relevant information via
1010
**osnoise:** tracepoints.
11+
12+
The **rtla timerlat** tool sets the options of the *timerlat* tracer
13+
and collects and displays a summary of the results. By default,
14+
the collection is done synchronously in kernel space using a dedicated
15+
BPF program attached to the *timerlat* tracer. If either BPF or
16+
the **osnoise:timerlat_sample** tracepoint it attaches to is
17+
unavailable, the **rtla timerlat** tool falls back to using tracefs to
18+
process the data asynchronously in user space.

tools/tracing/rtla/README.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ RTLA depends on the following libraries and tools:
1313
- libtraceevent
1414
- libcpupower (optional, for --deepest-idle-state)
1515

16+
For BPF sample collection support, the following extra dependencies are
17+
required:
18+
19+
- libbpf 1.0.0 or later
20+
- bpftool with skeleton support
21+
- clang with BPF CO-RE support
22+
1623
It also depends on python3-docutils to compile man pages.
1724

1825
For development, we suggest the following steps for compiling rtla:

0 commit comments

Comments
 (0)