From: Tomas Glozar <tglozar@redhat.com>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
Linux Trace Kernel <linux-trace-kernel@vger.kernel.org>,
John Kacur <jkacur@redhat.com>,
Luis Goncalves <lgoncalv@redhat.com>,
Costa Shulyupin <costa.shul@redhat.com>,
Crystal Wood <crwood@redhat.com>,
Wander Lairson Costa <wander@redhat.com>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Tomas Glozar <tglozar@redhat.com>
Subject: [PATCH 4/4] Documentation/rtla: Document --bpf-action option
Date: Fri, 17 Oct 2025 16:46:50 +0200 [thread overview]
Message-ID: <20251017144650.663238-5-tglozar@redhat.com> (raw)
In-Reply-To: <20251017144650.663238-1-tglozar@redhat.com>
Add new option --bpf-action into common_timerlat_options.txt, including
the format in which it takes the BPF program, and a reference to an
example.
Signed-off-by: Tomas Glozar <tglozar@redhat.com>
---
.../tools/rtla/common_timerlat_options.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/Documentation/tools/rtla/common_timerlat_options.rst b/Documentation/tools/rtla/common_timerlat_options.rst
index 1f5d024b53aa..1b7293ebc897 100644
--- a/Documentation/tools/rtla/common_timerlat_options.rst
+++ b/Documentation/tools/rtla/common_timerlat_options.rst
@@ -65,3 +65,21 @@
Set timerlat to run without workload, waiting for the user to dispatch a per-cpu
task that waits for a new period on the tracing/osnoise/per_cpu/cpu$ID/timerlat_fd.
See linux/tools/rtla/sample/timerlat_load.py for an example of user-load code.
+
+**--bpf-action** *bpf-program*
+
+ Loads a BPF program from an ELF file and executes it when a latency threshold is exceeded.
+
+ The BPF program must be a valid ELF file loadable with libbpf. The program must contain
+ a function named ``action_handler``, declared with ``SEC("tp/timerlat_action")`` for libbpf
+ to correctly detect the program type.
+
+ The program receives a ``struct trace_event_raw_timerlat_sample`` parameter
+ containing timerlat sample data.
+
+ A sample BPF action program is provided in ``tools/tracing/rtla/sample/timerlat_bpf_action.c``.
+ This example demonstrates how to create a BPF program that prints latency information when
+ thresholds are exceeded.
+
+ **Note**: BPF actions require BPF support to be available. If BPF is not available or disabled,
+ the tool will fall back to tracefs mode and BPF actions will not be supported.
--
2.51.0
prev parent reply other threads:[~2025-10-17 14:47 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-17 14:46 [PATCH 0/4] rtla/timerlat: Add --bpf-action option Tomas Glozar
2025-10-17 14:46 ` [PATCH 1/4] rtla/timerlat: Support tail call from BPF program Tomas Glozar
2025-10-17 14:46 ` [PATCH 2/4] rtla/timerlat: Add --bpf-action option Tomas Glozar
2025-10-20 14:04 ` Wander Lairson Costa
2025-10-20 17:51 ` Crystal Wood
2025-10-17 14:46 ` [PATCH 3/4] rtla/timerlat: Add example for BPF action program Tomas Glozar
2025-10-20 17:53 ` Crystal Wood
2025-10-21 14:54 ` Tomas Glozar
2025-10-21 15:58 ` Crystal Wood
2025-10-21 17:02 ` Steven Rostedt
2025-10-21 17:32 ` Crystal Wood
2025-10-23 7:27 ` Tomas Glozar
2025-10-24 1:49 ` Crystal Wood
2025-10-27 10:34 ` Tomas Glozar
2025-10-27 12:30 ` Crystal Wood
2025-10-17 14:46 ` Tomas Glozar [this message]
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=20251017144650.663238-5-tglozar@redhat.com \
--to=tglozar@redhat.com \
--cc=acme@kernel.org \
--cc=costa.shul@redhat.com \
--cc=crwood@redhat.com \
--cc=jkacur@redhat.com \
--cc=lgoncalv@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=wander@redhat.com \
/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;
as well as URLs for NNTP newsgroup(s).