From: Tomas Glozar <tglozar@redhat.com>
To: Steven Rostedt <rostedt@goodmis.org>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, John Kacur <jkacur@redhat.com>,
Luis Goncalves <lgoncalv@redhat.com>,
Tomas Glozar <tglozar@redhat.com>
Subject: [PATCH 4/4] Documentation/rtla: Include BPF sample collection
Date: Tue, 11 Mar 2025 12:49:36 +0100 [thread overview]
Message-ID: <20250311114936.148012-5-tglozar@redhat.com> (raw)
In-Reply-To: <20250311114936.148012-1-tglozar@redhat.com>
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>
---
Documentation/tools/rtla/common_timerlat_description.rst | 8 ++++++++
tools/tracing/rtla/README.txt | 7 +++++++
2 files changed, 15 insertions(+)
diff --git a/Documentation/tools/rtla/common_timerlat_description.rst b/Documentation/tools/rtla/common_timerlat_description.rst
index 8cd3e717baa8..49fcae3ffdec 100644
--- a/Documentation/tools/rtla/common_timerlat_description.rst
+++ b/Documentation/tools/rtla/common_timerlat_description.rst
@@ -8,3 +8,11 @@ The *timerlat* tracer outputs information in two ways. It periodically
prints the timer latency at the timer *IRQ* handler and the *Thread*
handler. It also enables the trace of the most relevant information via
**osnoise:** tracepoints.
+
+The **rtla timerlat** tool sets the options of the *timerlat* tracer
+and collects and displays a summary of the results. By default,
+the collection is done synchronously in kernel space using a dedicated
+BPF program attached to the *timerlat* tracer. If either BPF or
+the **osnoise:timerlat_sample** tracepoint it attaches to is
+unavailable, the **rtla timerlat** tool falls back to using tracefs to
+process the data asynchronously in user space.
diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt
index dd5621038c55..43e98311d10f 100644
--- a/tools/tracing/rtla/README.txt
+++ b/tools/tracing/rtla/README.txt
@@ -13,6 +13,13 @@ RTLA depends on the following libraries and tools:
- libtraceevent
- libcpupower (optional, for --deepest-idle-state)
+For BPF sample collection support, the following extra dependencies are
+required:
+
+ - libbpf 1.0.0 or later
+ - bpftool with skeleton support
+ - clang with BPF CO-RE support
+
It also depends on python3-docutils to compile man pages.
For development, we suggest the following steps for compiling rtla:
--
2.48.1
next prev parent reply other threads:[~2025-03-11 12:16 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-11 11:49 [PATCH 0/4] Documentation/rtla: Cover BPF sample collection Tomas Glozar
2025-03-11 11:49 ` [PATCH 1/4] Documentation/rtla: Fix duplicate text about timerlat tracer Tomas Glozar
2025-03-11 11:49 ` [PATCH 2/4] Documentation/rtla: Fix typo in rtla-timerlat.rst Tomas Glozar
2025-03-11 11:49 ` [PATCH 3/4] Documentation/rtla: Fix typo in common_timerlat_description.rst Tomas Glozar
2025-03-11 11:49 ` Tomas Glozar [this message]
2025-03-11 13:07 ` [PATCH 4/4] Documentation/rtla: Include BPF sample collection Luis Claudio R. Goncalves
2025-03-11 13:20 ` Tomas Glozar
2025-03-17 22:47 ` Jonathan Corbet
2025-03-24 23:53 ` Steven Rostedt
2025-04-14 16:43 ` Jonathan Corbet
2025-03-11 13:09 ` [PATCH 0/4] Documentation/rtla: Cover " Luis Claudio R. Goncalves
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250311114936.148012-5-tglozar@redhat.com \
--to=tglozar@redhat.com \
--cc=corbet@lwn.net \
--cc=jkacur@redhat.com \
--cc=lgoncalv@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox