lkml.org 
[lkml]   [2021]   [Oct]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH V3 14/19] rtla: Add rtla osnoise man page
    Date
    Man page for rtla osnoise command.

    Cc: Steven Rostedt <rostedt@goodmis.org>
    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>
    ---
    .../rtla/Documentation/rtla-osnoise.txt | 68 +++++++++++++++++++
    1 file changed, 68 insertions(+)
    create mode 100644 tools/tracing/rtla/Documentation/rtla-osnoise.txt

    diff --git a/tools/tracing/rtla/Documentation/rtla-osnoise.txt b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
    new file mode 100644
    index 000000000000..2da49246b645
    --- /dev/null
    +++ b/tools/tracing/rtla/Documentation/rtla-osnoise.txt
    @@ -0,0 +1,68 @@
    +rtla-osnoise(1)
    +===============
    +
    +NAME
    +----
    +rtla-osnoise - Measure the operating system noise
    +
    +SYNOPSIS
    +--------
    +*rtla osnoise* [MODE] ...
    +
    +DESCRIPTION
    +-----------
    +The rtla-osnoise(1) tool is an interface for the osnoise tracer. The osnoise
    +tracer dispatches a kernel thread per-cpu. These threads read the time in
    +a loop while with preemption, softirqs and IRQs enabled, thus allowing all
    +the sources of osnoise during its execution. The osnoise threads take note
    +of the entry and exit point of any source of interferences, increasing a
    +per-cpu interference counter. The osnoise tracer also saves an interference
    +counter for each source of interference.
    +
    +The osnoise tracer outputs information in two ways. It periodically prints
    +a summary of the noise of the operating system, including the counters of
    +the occurrence of the source of interference. It also provides information
    +for each noise via the osnoise tracepoints. The rtla-osnoise-top(1) mode
    +display information about the periodic summary from the osnoise tracer.
    +The rtla-osnoise-hist(1) mode display information about the noise using
    +the *osnoise:* tracepoints. For further details, please refer to the
    +respective man page.
    +
    +MODES
    +-----
    +*top*::
    + Prints the summary from osnoise tracer.
    +*hist*::
    + Prints a histogram of osnoise samples.
    +
    +If no MODE is given, the top mode is called, passing the arguments.
    +
    +OPTIONS
    +-------
    +*-h*, *--help*::
    +Display the help text.
    +
    +For other options, see the man page for the corresponding mode.
    +
    +SEE ALSO
    +--------
    +_rtla-osnoise-top(1)_, _rtla-osnoise-hist(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>
    +
    +REPORTING BUGS
    +--------------
    +Report bugs to <lkml@vger.kernel.org>
    +
    +LICENSE
    +-------
    +rtla is Free Software licensed under the GNU GPLv2
    +
    +COPYING
    +-------
    +Copyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under
    +the terms of the GNU Public License (GPL).
    --
    2.31.1
    \
     
     \ /
      Last update: 2021-10-18 18:51    [W:4.099 / U:0.480 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site