Commit 496082df authored by Daniel Bristot de Oliveira's avatar Daniel Bristot de Oliveira Committed by Steven Rostedt
Browse files

rtla: Add rtla osnoise man page 

Man page for rtla osnoise command.

Link: https://lkml.kernel.org/r/304747c602e46f6396e3bb75dfdcb42ae3656dca.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: default avatarDaniel Bristot de Oliveira <bristot@kernel.org>
Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent d40d48e1

Documentation/tools/rtla/common_osnoise_description.rst

0 → 100644
+8 −0
Original line number Diff line number Diff line 
The **rtla osnoise** 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, softirq and IRQs enabled, thus

allowing all the sources of operating systme noise during its execution.

The *osnoise*'s 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 *osnoise* tracer displays a summary of

the results.

Documentation/tools/rtla/rtla-osnoise.rst

0 → 100644
+59 −0
Original line number Diff line number Diff line 
===============

rtla-osnoise

===============

------------------------------------------------------------------

Measure the operating system noise

------------------------------------------------------------------



:Manual section: 1



SYNOPSIS

========

**rtla osnoise** [*MODE*] ...



DESCRIPTION

===========



.. include:: common_osnoise_description.rst



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**

mode displays information about the periodic summary from the *osnoise* tracer.

The **rtla osnoise hist** mode displays 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>



.. include:: common_appendix.rst