Skip to content

Commit d358dfe

Browse files
Daniel Bristot de Oliveirarostedt
authored andcommitted
Documentation/osnoise: Add osnoise/options documentation
Add the documentation about the osnoise/options file, the options, and some additional explanation about the OSNOISE_WORKLOAD option. Link: https://lkml.kernel.org/r/fde5567a4bae364f67fd1e9a644d1d62862618a6.1670623111.git.bristot@kernel.org Cc: Daniel Bristot de Oliveira <[email protected]> Cc: Juri Lelli <[email protected]> Cc: Clark Williams <[email protected]> Cc: Masami Hiramatsu <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Bagas Sanjaya <[email protected]> Signed-off-by: Daniel Bristot de Oliveira <[email protected]> Reviewed-by: Bagas Sanjaya <[email protected]> Signed-off-by: Steven Rostedt (Google) <[email protected]>
1 parent b5dce20 commit d358dfe

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

Documentation/trace/osnoise-tracer.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ Note that the example above shows a high number of HW noise samples.
9292
The reason being is that this sample was taken on a virtual machine,
9393
and the host interference is detected as a hardware interference.
9494

95-
Tracer options
96-
---------------------
95+
Tracer Configuration
96+
--------------------
9797

9898
The tracer has a set of options inside the osnoise directory, they are:
9999

@@ -115,6 +115,22 @@ The tracer has a set of options inside the osnoise directory, they are:
115115
NO_OSNOISE_WORKLOAD disables the OSNOISE_WORKLOAD option. The
116116
special DEAFAULTS option resets all options to the default value.
117117

118+
Tracer Options
119+
--------------
120+
121+
The osnoise/options file exposes a set of on/off configuration options for
122+
the osnoise tracer. These options are:
123+
124+
- DEFAULTS: reset the options to the default value.
125+
- OSNOISE_WORKLOAD: do not dispatch osnoise workload (see dedicated
126+
section below).
127+
- PANIC_ON_STOP: call panic() if the tracer stops. This option serves to
128+
capture a vmcore.
129+
- OSNOISE_PREEMPT_DISABLE: disable preemption while running the osnoise
130+
workload, allowing only IRQ and hardware-related noise.
131+
- OSNOISE_IRQ_DISABLE: disable IRQs while running the osnoise workload,
132+
allowing only NMIs and hardware-related noise, like hwlat tracer.
133+
118134
Additional Tracing
119135
------------------
120136

0 commit comments

Comments
 (0)