[lkml]   [2021]   [Nov]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
Patch in this message
Subject[PATCH V8 09/14] rtla: Add rtla osnoise man page
Man page for rtla osnoise command.

Cc: Steven Rostedt <>
Cc: Ingo Molnar <>
Cc: Tom Zanussi <>
Cc: Masami Hiramatsu <>
Cc: Juri Lelli <>
Cc: Clark Williams <>
Cc: John Kacur <>
Cc: Peter Zijlstra <>
Cc: Thomas Gleixner <>
Cc: Sebastian Andrzej Siewior <>
Cc: Daniel Bristot de Oliveira <>
Signed-off-by: Daniel Bristot de Oliveira <>
.../tools/rtla/common_osnoise_description.rst | 8 +++
Documentation/tools/rtla/rtla-osnoise.rst | 59 +++++++++++++++++++
2 files changed, 67 insertions(+)
create mode 100644 Documentation/tools/rtla/common_osnoise_description.rst
create mode 100644 Documentation/tools/rtla/rtla-osnoise.rst

diff --git a/Documentation/tools/rtla/common_osnoise_description.rst b/Documentation/tools/rtla/common_osnoise_description.rst
new file mode 100644
index 000000000000..8973c5df888f
--- /dev/null
+++ b/Documentation/tools/rtla/common_osnoise_description.rst
@@ -0,0 +1,8 @@
+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.
diff --git a/Documentation/tools/rtla/rtla-osnoise.rst b/Documentation/tools/rtla/rtla-osnoise.rst
new file mode 100644
index 000000000000..c129b206ce34
--- /dev/null
+++ b/Documentation/tools/rtla/rtla-osnoise.rst
@@ -0,0 +1,59 @@
+Measure the operating system noise
+:Manual section: 1
+**rtla osnoise** [*MODE*] ...
+.. 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.
+ Prints the summary from osnoise tracer.
+ Prints a histogram of osnoise samples.
+If no MODE is given, the top mode is called, passing the arguments.
+**-h**, **--help**
+ Display the help text.
+For other options, see the man page for the corresponding mode.
+**rtla-osnoise-top**\(1), **rtla-osnoise-hist**\(1)
+Osnoise tracer documentation: <>
+Written by Daniel Bristot de Oliveira <>
+.. include:: common_appendix.rst
 \ /
  Last update: 2021-11-29 12:13    [W:0.166 / U:5.328 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site