Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

authored by

Tomas Glozar and committed by
Jonathan Corbet
770840a0 e7d3b24e

+15
+8
Documentation/tools/rtla/common_timerlat_description.rst
··· 8 8 prints the timer latency at the timer *IRQ* handler and the *Thread* 9 9 handler. It also enables the trace of the most relevant information via 10 10 **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.
+7
tools/tracing/rtla/README.txt
··· 13 13 - libtraceevent 14 14 - libcpupower (optional, for --deepest-idle-state) 15 15 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 + 16 23 It also depends on python3-docutils to compile man pages. 17 24 18 25 For development, we suggest the following steps for compiling rtla: