Skip to content

Commit 29380d4

Browse files
Daniel Bristot de Oliveirarostedt
authored andcommitted
rtla: Add rtla timerlat documentation
Man page for rtla timerlat tool. Link: https://lkml.kernel.org/r/78678b8d024bf5a3a79f831ac9441b96e8d2f56e.1639158831.git.bristot@kernel.org Cc: Tao Zhou <tao.zhou@linux.dev> Cc: Ingo Molnar <mingo@redhat.com> Cc: Tom Zanussi <zanussi@kernel.org> Cc: Masami Hiramatsu <mhiramat@kernel.org> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Clark Williams <williams@redhat.com> Cc: John Kacur <jkacur@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
1 parent e7041c6 commit 29380d4

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
The **rtla timerlat** tool is an interface for the *timerlat* tracer. The
2+
*timerlat* tracer dispatches a kernel thread per-cpu. These threads
3+
set a periodic timer to wake themselves up and go back to sleep. After
4+
the wakeup, they collect and generate useful information for the
5+
debugging of operating system timer latency.
6+
7+
The *timerlat* tracer outputs information in two ways. It periodically
8+
prints the timer latency at the timer *IRQ* handler and the *Thread*
9+
handler. It also enable the trace of the most relevant information via
10+
**osnoise:** tracepoints.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
================
2+
rtla-timerlat
3+
================
4+
-------------------------------------------
5+
Measures the operating system timer latency
6+
-------------------------------------------
7+
8+
:Manual section: 1
9+
10+
SYNOPSIS
11+
========
12+
**rtla timerlat** [*MODE*] ...
13+
14+
DESCRIPTION
15+
===========
16+
17+
.. include:: common_timerlat_description.rst
18+
19+
The *timerlat* tracer outputs information in two ways. It periodically
20+
prints the timer latency at the timer *IRQ* handler and the *Thread* handler.
21+
It also provides information for each noise via the **osnoise:** tracepoints.
22+
The **rtla timerlat top** mode displays a summary of the periodic output
23+
from the *timerlat* tracer. The **rtla hist hist** mode displays a histogram
24+
of each tracer event occurrence. For further details, please refer to the
25+
respective man page.
26+
27+
MODES
28+
=====
29+
**top**
30+
31+
Prints the summary from *timerlat* tracer.
32+
33+
**hist**
34+
35+
Prints a histogram of timerlat samples.
36+
37+
If no *MODE* is given, the top mode is called, passing the arguments.
38+
39+
OPTIONS
40+
=======
41+
**-h**, **--help**
42+
43+
Display the help text.
44+
45+
For other options, see the man page for the corresponding mode.
46+
47+
SEE ALSO
48+
========
49+
**rtla-timerlat-top**\(1), **rtla-timerlat-hist**\(1)
50+
51+
*timerlat* tracer documentation: <https://www.kernel.org/doc/html/latest/trace/timerlat-tracer.html>
52+
53+
AUTHOR
54+
======
55+
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
56+
57+
.. include:: common_appendix.rst

0 commit comments

Comments
 (0)