Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Documentation/rtla: Document SIGINT behavior
The behavior of RTLA on receiving SIGINT is currently undocumented.
Describe it in RTLA's common appendix that appears in man pages for all
RTLA tools to avoid confusion.
Suggested-by: Attila Fazekas <afazekas@redhat.com>
Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/20260324123229.152424-1-tglozar@redhat.com
Signed-off-by: Tomas Glozar <tglozar@redhat.com>
+21
+21
Documentation/tools/rtla/common_appendix.txt
+21
Documentation/tools/rtla/common_appendix.txt
···
1
1
.. SPDX-License-Identifier: GPL-2.0
2
2
3
+
SIGINT BEHAVIOR
4
+
===============
5
+
6
+
On the first SIGINT, RTLA exits after collecting all outstanding samples up to
7
+
the point of receiving the signal.
8
+
9
+
When receiving more than one SIGINT, RTLA discards any outstanding samples, and
10
+
exits while displaying only samples that have already been processed.
11
+
12
+
If SIGINT is received during RTLA cleanup, RTLA exits immediately via
13
+
the default signal handler.
14
+
15
+
Note: For the purpose of SIGINT behavior, the expiry of duration specified via
16
+
the -d/--duration option is treated as equivalent to receiving a SIGINT. For
17
+
example, a SIGINT received after duration expired but samples have not been
18
+
processed yet will drop any outstanding samples.
19
+
20
+
Also note that when using the timerlat tool in BPF mode, samples are processed
21
+
in-kernel; RTLA only copies them out to display them to the user. A second
22
+
SIGINT does not affect in-kernel sample aggregation.
23
+
3
24
EXIT STATUS
4
25
===========
5
26