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