From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Daniel Bristot de Oliveira <bristot@kernel.org>,
Steven Rostedt <rostedt@goodmis.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Juri Lelli <juri.lelli@redhat.com>,
Clark Williams <williams@redhat.com>,
linux-trace-devel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH V2 6/6] Documentation/rtla: Add hwnoise man page
Date: Wed, 1 Feb 2023 16:10:55 +0700 [thread overview]
Message-ID: <Y9osn4sEj7F+Uwhd@debian.me> (raw)
In-Reply-To: <0e9d6b25a88b23bfea11e0cb9b95b5b0845b670b.1675181734.git.bristot@kernel.org>
[-- Attachment #1: Type: text/plain, Size: 5583 bytes --]
On Tue, Jan 31, 2023 at 05:30:07PM +0100, Daniel Bristot de Oliveira wrote:
> diff --git a/Documentation/tools/rtla/rtla-hwnoise.rst b/Documentation/tools/rtla/rtla-hwnoise.rst
> new file mode 100644
> index 000000000000..fb1c52bbc00b
> --- /dev/null
> +++ b/Documentation/tools/rtla/rtla-hwnoise.rst
> @@ -0,0 +1,107 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +============
> +rtla-hwnoise
> +============
> +------------------------------------------
> +Detect and quantify hardware-related noise
> +------------------------------------------
> +
> +:Manual section: 1
> +
> +SYNOPSIS
> +========
> +
> +**rtla hwnoise** [*OPTIONS*]
> +
> +DESCRIPTION
> +===========
> +
> +**rtla hwnoise** collects the periodic summary from the *osnoise* tracer
> +running with *interrupts disabled*. By disabling interrupts, and the scheduling
> +of threads as a consequence, only non-maskable interrupts and hardware-related
> +noise is allowed.
> +
> +The tool also allows the configurations of the *osnoise* tracer and the
> +collection of the tracer output.
> +
> +OPTIONS
> +=======
> +.. include:: common_osnoise_options.rst
> +
> +.. include:: common_top_options.rst
> +
> +.. include:: common_options.rst
> +
> +EXAMPLE
> +=======
> +In the example below, the **rtla hwnoise** tool is set to run on CPUs *1-7*
> +on a system with 8 cores/16 threads with hyper-threading enabled.
> +
> +The tool is set to detect any noise higher than *one microsecond*,
> +to run for *ten minutes*, displaying a summary of the report at the
> +end of the session::
> +
> + # rtla hwnoise -c 1-7 -T 1 -d 10m -q
> + Hardware-related Noise
> + duration: 0 00:10:00 | time is in us
> + CPU Period Runtime Noise % CPU Aval Max Noise Max Single HW NMI
> + 1 #599 599000000 138 99.99997 3 3 4 74
> + 2 #599 599000000 85 99.99998 3 3 4 75
> + 3 #599 599000000 86 99.99998 4 3 6 75
> + 4 #599 599000000 81 99.99998 4 4 2 75
> + 5 #599 599000000 85 99.99998 2 2 2 75
> + 6 #599 599000000 76 99.99998 2 2 0 75
> + 7 #599 599000000 77 99.99998 3 3 0 75
> +
> +
> +The first column shows the *CPU*, and the second column shows how many
> +*Periods* the tool ran during the session. The *Runtime* is the time
> +the tool effectively runs on the CPU. The *Noise* column is the sum of
> +all noise that the tool observed, and the *% CPU Aval* is the relation
> +between the *Runtime* and *Noise*.
> +
> +The *Max Noise* column is the maximum hardware noise the tool detected in a
> +single period, and the *Max Single* is the maximum single noise seen.
> +
> +The *HW* and *NMI* columns show the total number of *hardware* and *NMI* noise
> +occurrence observed by the tool.
> +
> +For example, *CPU 3* ran *599* periods of *1 second Runtime*. The CPU received
> +*86 us* of noise during the entire execution, leaving *99.99997 %* of CPU time
> +for the application. In the worst single period, the CPU caused *4 us* of
> +noise to the application, but it was certainly caused by more than one single
> +noise, as the *Max Single* noise was of *3 us*. The CPU has *HW noise,* at a
> +rate of *six occurrences*/*ten minutes*. The CPU also has *NMIs*, at a higher
> +frequency: around *seven per second*.
> +
> +The tool should report *0* hardware-related noise in the ideal situation.
> +For example, by disabling hyper-threading to remove the hardware noise,
> +and disabling the TSC watchdog to remove the NMI (it is possible to identify
> +this using tracing options of **rtla hwnoise**), it was possible to reach
> +the ideal situation in the same hardware::
> +
> + # rtla hwnoise -c 1-7 -T 1 -d 10m -q
> + Hardware-related Noise
> + duration: 0 00:10:00 | time is in us
> + CPU Period Runtime Noise % CPU Aval Max Noise Max Single HW NMI
> + 1 #599 599000000 0 100.00000 0 0 0 0
> + 2 #599 599000000 0 100.00000 0 0 0 0
> + 3 #599 599000000 0 100.00000 0 0 0 0
> + 4 #599 599000000 0 100.00000 0 0 0 0
> + 5 #599 599000000 0 100.00000 0 0 0 0
> + 6 #599 599000000 0 100.00000 0 0 0 0
> + 7 #599 599000000 0 100.00000 0 0 0 0
> +
> +SEE ALSO
> +========
> +
> +**rtla-osnoise**\(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
LGTM, thanks!
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
prev parent reply other threads:[~2023-02-01 9:11 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-31 16:30 [PATCH V2 0/6] rtla: Add hwnoise tool Daniel Bristot de Oliveira
2023-01-31 16:30 ` [PATCH V2 1/6] rtla/osnoise: Add helper functions to manipulate osnoise/options Daniel Bristot de Oliveira
2023-02-01 19:23 ` Steven Rostedt
2023-02-07 20:04 ` Daniel Bristot de Oliveira
2023-02-01 19:25 ` Steven Rostedt
2023-01-31 16:30 ` [PATCH V2 2/6] rtla/osnoise: Add OSNOISE_IRQ_DISABLE option Daniel Bristot de Oliveira
2023-01-31 16:30 ` [PATCH V2 3/6] rtla/osnoise: Add the mode abstraction Daniel Bristot de Oliveira
2023-01-31 16:30 ` [PATCH V2 4/6] rtla/osnoise_top: Pass the params to the usage function Daniel Bristot de Oliveira
2023-01-31 16:30 ` [PATCH V2 5/6] rtla: Add hwnoise tool Daniel Bristot de Oliveira
2023-01-31 16:30 ` [PATCH V2 6/6] Documentation/rtla: Add hwnoise man page Daniel Bristot de Oliveira
2023-02-01 9:10 ` Bagas Sanjaya [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y9osn4sEj7F+Uwhd@debian.me \
--to=bagasdotme@gmail.com \
--cc=bristot@kernel.org \
--cc=corbet@lwn.net \
--cc=juri.lelli@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=williams@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).