linux-kernel - [PATCH V3 17/19] rtla: Add rtla timerlat documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <3a8fc13db9ee5a79db0c9b5ca3aa69ba14a6955c.1634574261.git.bristot@kernel.org>
Date:   Mon, 18 Oct 2021 18:48:30 +0200
From:   Daniel Bristot de Oliveira <bristot@...nel.org>
To:     Steven Rostedt <rostedt@...dmis.org>
Cc:     Daniel Bristot de Oliveira <bristot@...nel.org>,
        Ingo Molnar <mingo@...hat.com>,
        Tom Zanussi <zanussi@...nel.org>,
        Masami Hiramatsu <mhiramat@...nel.org>,
        Juri Lelli <juri.lelli@...hat.com>,
        Clark Williams <williams@...hat.com>,
        John Kacur <jkacur@...hat.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
        linux-rt-users@...r.kernel.org, linux-trace-devel@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH V3 17/19] rtla: Add rtla timerlat documentation

Man page for rtla timerlat tool.

Cc: Steven Rostedt <rostedt@...dmis.org>
Cc: Ingo Molnar <mingo@...hat.com>
Cc: Tom Zanussi <zanussi@...nel.org>
Cc: Masami Hiramatsu <mhiramat@...nel.org>
Cc: Juri Lelli <juri.lelli@...hat.com>
Cc: Clark Williams <williams@...hat.com>
Cc: John Kacur <jkacur@...hat.com>
Cc: Peter Zijlstra <peterz@...radead.org>
Cc: Thomas Gleixner <tglx@...utronix.de>
Cc: Sebastian Andrzej Siewior <bigeasy@...utronix.de>
Cc: Daniel Bristot de Oliveira <bristot@...nel.org>
Cc: linux-rt-users@...r.kernel.org
Cc: linux-trace-devel@...r.kernel.org
Cc: linux-kernel@...r.kernel.org
Signed-off-by: Daniel Bristot de Oliveira <bristot@...nel.org>
---
 .../rtla/Documentation/rtla-timerlat.txt      | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 tools/tracing/rtla/Documentation/rtla-timerlat.txt

diff --git a/tools/tracing/rtla/Documentation/rtla-timerlat.txt b/tools/tracing/rtla/Documentation/rtla-timerlat.txt
new file mode 100644
index 000000000000..2b5ef9a9d6b0
--- /dev/null
+++ b/tools/tracing/rtla/Documentation/rtla-timerlat.txt
@@ -0,0 +1,65 @@
+rtla-timerlat(1)
+================
+
+NAME
+----
+rtla-timerlat - Measures the operating system timer latency
+
+SYNOPSIS
+--------
+*rtla timerlat* [MODE] ...
+
+DESCRIPTION
+-----------
+The rtla-timerlat(1) tool is an interface for the timerlat tracer. The
+timerlat tracer dispatches a kernel thread per-cpu. These threads set
+a periodic timer to wake themselves up and go back to sleep. After the
+wakeup, they collect and generate useful information for the debugging
+of operating system timer latency.
+
+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 provides information for each noise via the osnoise tracepoints.
+The rtla-timerlat-top(1) mode displays a summary of the periodic output
+from the timerlat tracer. The rtla-hist-hist(1) mode displays a histogram of
+each tracer event occurrence. For further details, please refer to the
+respective man page.
+
+MODES
+-----
+*top*::
+  Prints the summary from timerlat tracer.
+*hist*::
+  Prints a histogram of timerlat samples.
+
+If no MODE is given, the top mode is called, passing the arguments.
+
+OPTIONS
+-------
+*-h*, *--help*::
+  Display the help text.
+
+For other options, see the man page for the corresponding mode.
+
+SEE ALSO
+--------
+_rtla-timerlat-top(1)_, _rtla-timerlat-hist(1)_
+
+Timerlat tracer documentation: <https://www.kernel.org/doc/html/latest/trace/timerlat-tracer.html>
+
+AUTHOR
+------
+Written by Daniel Bristot de Oliveira <bristot@...nel.org>
+
+REPORTING BUGS
+--------------
+Report bugs to <lkml@...r.kernel.org>
+
+LICENSE
+-------
+rtla is Free Software licensed under the GNU GPLv2
+
+COPYING
+-------
+Copyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
-- 
2.31.1