lkml.org 
[lkml]   [2022]   [Jan]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    Subject[for-next][PATCH 26/31] rtla: Add rtla osnoise hist documentation
    From: Daniel Bristot de Oliveira <bristot@kernel.org>

    Man page for rtla osnoise hist mode.

    Link: https://lkml.kernel.org/r/5e1bab917784d819bb562337942829dac8a7d362.1638182284.git.bristot@kernel.org

    Cc: Tao Zhou <tao.zhou@linux.dev>
    Cc: Ingo Molnar <mingo@redhat.com>
    Cc: Tom Zanussi <zanussi@kernel.org>
    Cc: Masami Hiramatsu <mhiramat@kernel.org>
    Cc: Juri Lelli <juri.lelli@redhat.com>
    Cc: Clark Williams <williams@redhat.com>
    Cc: John Kacur <jkacur@redhat.com>
    Cc: Peter Zijlstra <peterz@infradead.org>
    Cc: Thomas Gleixner <tglx@linutronix.de>
    Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
    Cc: Daniel Bristot de Oliveira <bristot@kernel.org>
    Cc: linux-rt-users@vger.kernel.org
    Cc: linux-trace-devel@vger.kernel.org
    Cc: linux-kernel@vger.kernel.org
    Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org>
    Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
    ---
    .../tools/rtla/common_hist_options.rst | 23 +++++++
    .../tools/rtla/rtla-osnoise-hist.rst | 66 +++++++++++++++++++
    2 files changed, 89 insertions(+)
    create mode 100644 Documentation/tools/rtla/common_hist_options.rst
    create mode 100644 Documentation/tools/rtla/rtla-osnoise-hist.rst

    diff --git a/Documentation/tools/rtla/common_hist_options.rst b/Documentation/tools/rtla/common_hist_options.rst
    new file mode 100644
    index 000000000000..0266cd08a6c9
    --- /dev/null
    +++ b/Documentation/tools/rtla/common_hist_options.rst
    @@ -0,0 +1,23 @@
    +**-b**, **--bucket-size** *N*
    +
    + Set the histogram bucket size (default *1*).
    +
    +**-e**, **--entries** *N*
    +
    + Set the number of entries of the histogram (default 256).
    +
    +**--no-header**
    +
    + Do not print header.
    +
    +**--no-summary**
    +
    + Do not print summary.
    +
    +**--no-index**
    +
    + Do not print index.
    +
    +**--with-zeros**
    +
    + Print zero only entries.
    diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst
    new file mode 100644
    index 000000000000..52298ddd8701
    --- /dev/null
    +++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst
    @@ -0,0 +1,66 @@
    +===================
    +rtla-osnoise-hist
    +===================
    +------------------------------------------------------
    +Display a histogram of the osnoise tracer samples
    +------------------------------------------------------
    +
    +:Manual section: 1
    +
    +SYNOPSIS
    +========
    +**rtla osnoise hist** [*OPTIONS*]
    +
    +DESCRIPTION
    +===========
    +.. include:: common_osnoise_description.rst
    +
    +The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
    +occurrence in a histogram, displaying the results in a user-friendly way.
    +The tool also allows many configurations of the *osnoise* tracer and the
    +collection of the tracer output.
    +
    +OPTIONS
    +=======
    +.. include:: common_osnoise_options.rst
    +
    +.. include:: common_hist_options.rst
    +
    +.. include:: common_options.rst
    +
    +EXAMPLE
    +=======
    +In the example below, *osnoise* tracer threads are set to run with real-time
    +priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by
    +default). The reason for reducing the runtime is to avoid starving the
    +**rtla** tool. The tool is also set to run for *one minute*. The output
    +histogram is set to group outputs in buckets of *10us* and *25* entries::
    +
    + [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -e 25
    + # RTLA osnoise histogram
    + # Time unit is microseconds (us)
    + # Duration: 0 00:01:00
    + 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
    + 0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377
    + 10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413
    + 20 8 5 12 2 13 24 20 41 29 53 39 39
    + 30 1 1 0 0 10 3 6 19 15 31 30 38
    + 40 0 0 0 0 0 4 2 7 2 3 8 11
    + 50 0 0 0 0 0 0 0 0 0 1 1 2
    + over: 0 0 0 0 0 0 0 0 0 0 0 0
    + count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880
    + min: 0 0 0 0 0 0 0 0 0 0 0 0
    + avg: 0 0 0 0 0 0 0 0 0 0 0 0
    + max: 30 30 20 20 30 40 40 40 40 50 50 50
    +
    +SEE ALSO
    +========
    +**rtla-osnoise**\(1), **rtla-osnoise-top**\(1)
    +
    +*osnoise* tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
    +
    +AUTHOR
    +======
    +Written by Daniel Bristot de Oliveira <bristot@kernel.org>
    +
    +.. include:: common_appendix.rst
    --
    2.33.0
    \
     
     \ /
      Last update: 2022-01-11 18:33    [W:4.112 / U:0.560 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site