.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "RTLA-OSNOISE" 1 "" ""
.SH NAME
rtla-osnoise \- Measure the operating system noise
.SH SYNOPSIS
.sp
\fBrtla osnoise\fP [\fIMODE\fP] ...
.SH DESCRIPTION
.sp
The \fBrtla osnoise\fP tool is an interface for the \fIosnoise\fP tracer. The
\fIosnoise\fP tracer dispatches a kernel thread per\-cpu. These threads read the
time in a loop while with preemption, softirq and IRQs enabled, thus
allowing all the sources of operating system noise during its execution.
The \fIosnoise\fP\(aqs tracer threads take note of the delta between each time
read, along with an interference counter of all sources of interference.
At the end of each period, the \fIosnoise\fP tracer displays a summary of
the results.
.sp
The \fIosnoise\fP 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 \fBosnoise:\fP tracepoints. The \fBrtla osnoise top\fP
mode displays information about the periodic summary from the \fIosnoise\fP tracer.
The \fBrtla osnoise hist\fP mode displays information about the noise using
the \fBosnoise:\fP tracepoints. For further details, please refer to the
respective man page.
.SH MODES
.sp
\fBtop\fP
.INDENT 0.0
.INDENT 3.5
Prints the summary from osnoise tracer.
.UNINDENT
.UNINDENT
.sp
\fBhist\fP
.INDENT 0.0
.INDENT 3.5
Prints a histogram of osnoise samples.
.UNINDENT
.UNINDENT
.sp
If no MODE is given, the top mode is called, passing the arguments.
.SH OPTIONS
.sp
\fB\-h\fP, \fB\-\-help\fP
.INDENT 0.0
.INDENT 3.5
Display the help text.
.UNINDENT
.UNINDENT
.sp
For other options, see the man page for the corresponding mode.
.SH SEE ALSO
.sp
\fBrtla\-osnoise\-top\fP(1), \fBrtla\-osnoise\-hist\fP(1)
.sp
Osnoise tracer documentation: <\fI\%https://www.kernel.org/doc/html/latest/trace/osnoise\-tracer.html\fP>
.SH AUTHOR
.sp
Written by Daniel Bristot de Oliveira <\fI\%bristot@kernel.org\fP>
.SH REPORTING BUGS
.sp
Report bugs to <\fI\%linux\-kernel@vger.kernel.org\fP>
and <\fI\%linux\-trace\-devel@vger.kernel.org\fP>
.SH LICENSE
.sp
\fBrtla\fP is Free Software licensed under the GNU GPLv2
.SH COPYING
.sp
Copyright (C) 2021 Red Hat, Inc. Free use of this software is granted under
the terms of the GNU Public License (GPL).
.\" Generated by docutils manpage writer.
.