xref: /linux/Documentation/tools/rtla/rtla-osnoise-hist.rst (revision d68a29a6a229f8b4f3b19dbcd0bb02881316d642)
1.. |tool| replace:: osnoise hist
2
3===================
4rtla-osnoise-hist
5===================
6------------------------------------------------------
7Display a histogram of the osnoise tracer samples
8------------------------------------------------------
9
10:Manual section: 1
11
12SYNOPSIS
13========
14**rtla osnoise hist** [*OPTIONS*]
15
16DESCRIPTION
17===========
18.. include:: common_osnoise_description.rst
19
20The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
21occurrence in a histogram, displaying the results in a user-friendly way.
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_hist_options.rst
30
31.. include:: common_options.rst
32
33EXAMPLE
34=======
35In the example below, *osnoise* tracer threads are set to run with real-time
36priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by
37default). The reason for reducing the runtime is to avoid starving the
38**rtla** tool. The tool is also set to run for *one minute*. The output
39histogram is set to group outputs in buckets of *10us* and *25* entries::
40
41  [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -E 25
42  # RTLA osnoise histogram
43  # Time unit is microseconds (us)
44  # Duration:   0 00:01:00
45  Index   CPU-000   CPU-001   CPU-002   CPU-003   CPU-004   CPU-005   CPU-006   CPU-007   CPU-008   CPU-009   CPU-010   CPU-011
46  0         42982     46287     51779     53740     52024     44817     49898     36500     50408     50128     49523     52377
47  10        12224      8356      2912       878      2667     10155      4573     18894      4214      4836      5708      2413
48  20            8         5        12         2        13        24        20        41        29        53        39        39
49  30            1         1         0         0        10         3         6        19        15        31        30        38
50  40            0         0         0         0         0         4         2         7         2         3         8        11
51  50            0         0         0         0         0         0         0         0         0         1         1         2
52  over:         0         0         0         0         0         0         0         0         0         0         0         0
53  count:    55215     54649     54703     54620     54714     55003     54499     55461     54668     55052     55309     54880
54  min:          0         0         0         0         0         0         0         0         0         0         0         0
55  avg:          0         0         0         0         0         0         0         0         0         0         0         0
56  max:         30        30        20        20        30        40        40        40        40        50        50        50
57
58SEE ALSO
59========
60**rtla-osnoise**\(1), **rtla-osnoise-top**\(1)
61
62*osnoise* tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
63
64AUTHOR
65======
66Written by Daniel Bristot de Oliveira <bristot@kernel.org>
67
68.. include:: common_appendix.rst
69