xref: /linux/Documentation/tools/rtla/rtla-osnoise-top.rst (revision 8a7c601e14576a22c2bbf7f67455ccf3f3d2737f)
1.. |tool| replace:: osnoise top
2
3===================
4rtla-osnoise-top
5===================
6-----------------------------------------------
7Display a summary of the operating system noise
8-----------------------------------------------
9
10:Manual section: 1
11
12SYNOPSIS
13========
14**rtla osnoise top** [*OPTIONS*]
15
16DESCRIPTION
17===========
18.. include:: common_osnoise_description.rst
19
20**rtla osnoise top** collects the periodic summary from the *osnoise* tracer,
21including the counters of the occurrence of the interference source,
22displaying the results in a user-friendly format.
23
24The tool also allows many configurations of the *osnoise* tracer and the
25collection of the tracer output.
26
27OPTIONS
28=======
29.. include:: common_osnoise_options.rst
30
31.. include:: common_top_options.rst
32
33.. include:: common_options.rst
34
35EXAMPLE
36=======
37In the example below, the **rtla osnoise top** tool is set to run with a
38real-time priority *FIFO:1*, on CPUs *0-3*, for *900ms* at each period
39(*1s* by default). The reason for reducing the runtime is to avoid starving
40the rtla tool. The tool is also set to run for *one minute* and to display
41a summary of the report at the end of the session::
42
43  [root@f34 ~]# rtla osnoise top -P F:1 -c 0-3 -r 900000 -d 1M -q
44                                          Operating System Noise
45  duration:   0 00:01:00 | time is in us
46  CPU Period       Runtime        Noise  % CPU Aval   Max Noise   Max Single          HW          NMI          IRQ      Softirq       Thread
47    0 #59         53100000       304896    99.42580        6978           56         549            0        53111         1590           13
48    1 #59         53100000       338339    99.36282        8092           24         399            0        53130         1448           31
49    2 #59         53100000       290842    99.45227        6582           39         855            0        53110         1406           12
50    3 #59         53100000       204935    99.61405        6251           33         290            0        53156         1460           12
51
52SEE ALSO
53========
54
55**rtla-osnoise**\(1), **rtla-osnoise-hist**\(1)
56
57Osnoise tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
58
59AUTHOR
60======
61Written by Daniel Bristot de Oliveira <bristot@kernel.org>
62
63.. include:: common_appendix.rst
64