From: Bixuan Cui <cuibixuan@huawei.com>
To: <peterz@infradead.org>, <mingo@redhat.com>, <acme@kernel.org>,
<mark.rutland@arm.com>, <alexander.shishkin@linux.intel.com>,
<jolsa@redhat.com>, <namhyung@kernel.org>,
<linux-kernel@vger.kernel.org>
Cc: <john.wanghui@huawei.com>
Subject: [PATCH 2/2] perf tools: Add documentation for 'perf irq' command
Date: Tue, 12 Jan 2021 20:55:58 +0800 [thread overview]
Message-ID: <20210112125558.72989-3-cuibixuan@huawei.com> (raw)
In-Reply-To: <20210112125558.72989-1-cuibixuan@huawei.com>
Add documentation for 'perf irq' command.
Signed-off-by: Bixuan Cui <cuibixuan@huawei.com>
---
tools/perf/Documentation/perf-irq.txt | 58 +++++++++++++++++++++++++++
tools/perf/command-list.txt | 1 +
2 files changed, 59 insertions(+)
create mode 100644 tools/perf/Documentation/perf-irq.txt
diff --git a/tools/perf/Documentation/perf-irq.txt b/tools/perf/Documentation/perf-irq.txt
new file mode 100644
index 000000000000..8c0e388dad59
--- /dev/null
+++ b/tools/perf/Documentation/perf-irq.txt
@@ -0,0 +1,58 @@
+perf-irq(1)
+=============
+
+NAME
+----
+perf-irq - Tool to trace/measure hardware interrupts
+
+SYNOPSIS
+--------
+[verse]
+'perf irq' {record|timeconsume|script}
+
+DESCRIPTION
+-----------
+There are several variants of 'perf irq':
+
+ 'perf irq record <command>' to record the irq handler events
+ of an arbitrary workload.
+
+ 'perf irq script' to see a detailed trace of the workload that
+ was recorded (aliased to 'perf script' for now).
+
+ 'perf irq timeconsume' to calculate the time consumed by each
+ hardware interrupt processing function.
+
+ Example usage:
+ perf irq record -- sleep 1
+ perf irq timeconsume
+
+ By default it shows the individual irq events, including the irq name,
+ cpu(execute the hardware interrupt processing function), time consumed,
+ entry time and exit time for the each hardware irq:
+
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ Irq name | CPU | Time consume us | Handler entry time | Handler exit time
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ enp2s0f2-tx-0 | [0006] | 0.000001 s | 6631263.313329 s | 6631263.313330 s
+
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ Irq name | CPU | Time consume us | Handler entry time | Handler exit time
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ megasas | [0013] | 0.000003 s | 6631263.209564 s | 6631263.209567 s
+
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ Irq name | CPU | Time consume us | Handler entry time | Handler exit time
+ -------------------------------------------------------------------------------------------------------------------------------------------
+ acpi | [0016] | 0.000018 s | 6631263.085787 s | 6631263.085805 s
+
+
+OPTIONS for 'perf irq'
+----------------------------
+
+--cpus::
+ Show just entries with activities for the given CPUs.
+
+SEE ALSO
+--------
+linkperf:perf-record[1]
diff --git a/tools/perf/command-list.txt b/tools/perf/command-list.txt
index bc6c585f74fc..c5224ea3ac71 100644
--- a/tools/perf/command-list.txt
+++ b/tools/perf/command-list.txt
@@ -26,6 +26,7 @@ perf-report mainporcelain common
perf-sched mainporcelain common
perf-script mainporcelain common
perf-stat mainporcelain common
+perf-irq mainporcelain common
perf-test mainporcelain common
perf-timechart mainporcelain common
perf-top mainporcelain common
--
2.17.1
next prev parent reply other threads:[~2021-01-12 13:15 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-12 12:55 [PATCH 0/2] perf tools: add 'perf irq' to measure the hardware interrupts Bixuan Cui
2021-01-12 12:55 ` [PATCH 1/2] " Bixuan Cui
2021-01-12 19:50 ` Alexei Budankov
2021-01-14 7:29 ` Bixuan Cui
2021-01-12 12:55 ` Bixuan Cui [this message]
2021-01-12 19:51 ` [PATCH 2/2] perf tools: Add documentation for 'perf irq' command Alexei Budankov
2021-01-13 0:59 [PATCH 0/2] perf tools: add 'perf irq' to measure the hardware interrupts Bixuan Cui
2021-01-13 0:59 ` [PATCH 2/2] perf tools: Add documentation for 'perf irq' command Bixuan Cui
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=20210112125558.72989-3-cuibixuan@huawei.com \
--to=cuibixuan@huawei.com \
--cc=acme@kernel.org \
--cc=alexander.shishkin@linux.intel.com \
--cc=john.wanghui@huawei.com \
--cc=jolsa@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
/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
all inboxes | Powered by JetHome®