From: Daniel Bristot de Oliveira <bristot@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Kate Carcia <kcarcia@redhat.com>,
Daniel Bristot de Oliveira <bristot@kernel.org>,
Ingo Molnar <mingo@redhat.com>, Tom Zanussi <zanussi@kernel.org>,
Masami Hiramatsu <mhiramat@kernel.org>,
Juri Lelli <juri.lelli@redhat.com>,
Clark Williams <williams@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Thomas Gleixner <tglx@linutronix.de>,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
linux-rt-users@vger.kernel.org,
linux-trace-devel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [RFC 14/19] rtla: Add rtla osnoise man page
Date: Fri, 17 Sep 2021 17:43:57 +0200 [thread overview]
Message-ID: <9583858f4416df12aa8d79190038c9d4a22fda17.1631889858.git.bristot@kernel.org> (raw)
In-Reply-To: <cover.1631889858.git.bristot@kernel.org>
Man page for rtla osnoise command.
Cc: Steven Rostedt <rostedt@goodmis.org>
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: 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>
---
.../rtla/Documentation/rtla-osnoise.txt | 68 +++++++++++++++++++
1 file changed, 68 insertions(+)
create mode 100644 tools/tracing/rtla/Documentation/rtla-osnoise.txt
diff --git a/tools/tracing/rtla/Documentation/rtla-osnoise.txt b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
new file mode 100644
index 000000000000..2da49246b645
--- /dev/null
+++ b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
@@ -0,0 +1,68 @@
+rtla-osnoise(1)
+===============
+
+NAME
+----
+rtla-osnoise - Measure the operating system noise
+
+SYNOPSIS
+--------
+*rtla osnoise* [MODE] ...
+
+DESCRIPTION
+-----------
+The rtla-osnoise(1) tool is an interface for the osnoise tracer. The osnoise
+tracer dispatches a kernel thread per-cpu. These threads read the time in
+a loop while with preemption, softirqs and IRQs enabled, thus allowing all
+the sources of osnoise during its execution. The osnoise threads take note
+of the entry and exit point of any source of interferences, increasing a
+per-cpu interference counter. The osnoise tracer also saves an interference
+counter for each source of interference.
+
+The osnoise tracer outputs information in two ways. It periodically prints
+a summary of the noise of the operating system, including the counters of
+the occurrence of the source of interference. It also provides information
+for each noise via the osnoise tracepoints. The rtla-osnoise-top(1) mode
+display information about the periodic summary from the osnoise tracer.
+The rtla-osnoise-hist(1) mode display information about the noise using
+the *osnoise:* tracepoints. For further details, please refer to the
+respective man page.
+
+MODES
+-----
+*top*::
+ Prints the summary from osnoise tracer.
+*hist*::
+ Prints a histogram of osnoise 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-osnoise-top(1)_, _rtla-osnoise-hist(1)_
+
+Osnoise tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
+
+AUTHOR
+------
+Written by Daniel Bristot de Oliveira <bristot@kernel.org>
+
+REPORTING BUGS
+--------------
+Report bugs to <lkml@vger.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
next prev parent reply other threads:[~2021-09-17 15:47 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-17 15:43 [RFC 00/19] RTLA: An interface for osnoise/timerlat tracers Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 01/19] trace/osnoise: Do not follow tracing_cpumask Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 02/19] trace/osnoise: Split workload start from the tracer start Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 03/19] trace/osnoise: Use start/stop_per_cpu_kthreads() on osnoise_cpus_write() Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 04/19] trace/osnoise: Support a list of trace_array *tr Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 05/19] trace/osnoise: Allow multiple instances of the same tracer Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 06/19] rtla: Real-Time Linux Analysis tool Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 07/19] rtla: Helper functions for rtla Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 08/19] rtla: Add osnoise tool Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 09/19] rtla/osnoise: Add osnoise top mode Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 10/19] rtla/osnoise: Add the hist mode Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 11/19] rtla: Add timerlat tool and timelart top mode Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 12/19] rtla/timerlat: Add timerlat hist mode Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 13/19] rtla: Add Documentation Daniel Bristot de Oliveira
2021-09-17 15:43 ` Daniel Bristot de Oliveira [this message]
2021-09-17 15:43 ` [RFC 15/19] rtla: Add rtla osnoise top documentation Daniel Bristot de Oliveira
2021-09-17 15:43 ` [RFC 16/19] rtla: Add rtla osnoise hist documentation Daniel Bristot de Oliveira
2021-09-17 15:44 ` [RFC 17/19] rtla: Add rtla timerlat documentation Daniel Bristot de Oliveira
2021-09-17 15:44 ` [RFC 18/19] rtla: Add rtla timerlat top documentation Daniel Bristot de Oliveira
2021-09-17 15:44 ` [RFC 19/19] rtla: Add rtla timerlat hist documentation Daniel Bristot de Oliveira
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=9583858f4416df12aa8d79190038c9d4a22fda17.1631889858.git.bristot@kernel.org \
--to=bristot@kernel.org \
--cc=bigeasy@linutronix.de \
--cc=corbet@lwn.net \
--cc=juri.lelli@redhat.com \
--cc=kcarcia@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rt-users@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=mhiramat@kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=tglx@linutronix.de \
--cc=williams@redhat.com \
--cc=zanussi@kernel.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;
as well as URLs for NNTP newsgroup(s).