Module Name: src
Committed By: maxv
Date: Wed Jul 12 17:38:15 UTC 2017
Modified Files:
src/usr.bin/pmc: pmc.1
Log Message:
Update.
To generate a diff of this commit:
cvs rdiff -u -r1.11 -r1.12 src/usr.bin/pmc/pmc.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/pmc/pmc.1
diff -u src/usr.bin/pmc/pmc.1:1.11 src/usr.bin/pmc/pmc.1:1.12
--- src/usr.bin/pmc/pmc.1:1.11 Fri Mar 10 15:34:17 2017
+++ src/usr.bin/pmc/pmc.1 Wed Jul 12 17:38:15 2017
@@ -1,4 +1,4 @@
-.\" $NetBSD: pmc.1,v 1.11 2017/03/10 15:34:17 wiz Exp $
+.\" $NetBSD: pmc.1,v 1.12 2017/07/12 17:38:15 maxv Exp $
.\"
.\" Copyright (c) 2017 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -58,7 +58,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd March 10, 2017
+.Dd July 12, 2017
.Dt PMC 1
.Os
.Sh NAME
@@ -71,7 +71,8 @@
.Sh DESCRIPTION
The
.Nm
-command can be used to control and inspect the state of CPUs in the system.
+tool can be used to control and inspect the state of the
+Performance-Monitoring Counters (PMCs) in the system.
.Pp
The first argument,
.Ar command ,
@@ -97,22 +98,28 @@ values of these counters.
.El
.Sh EXAMPLES
The following command prints the available counters.
-.Dl $ pmc list
+.Dl # pmc list
.Pp
The following command starts two counters.
The former will count the 'l2cache-access' events that are triggered from
userland, the latter will count the 'l1cache-access' events triggered from
both userland and the kernel.
-.Dl $ pmc start l2cache-access:u l1cache-access:uk
+.Dl # pmc start l2cache-access:u l1cache-access:uk
.Pp
Note that the two following commands are not exactly identical.
-.Dl $ pmc start l1cache-access:u l1cache-access:k
-.Dl $ pmc start l1cache-access:uk
+.Dl # pmc start l1cache-access:u l1cache-access:k
+.Dl # pmc start l1cache-access:uk
The former will start two different counters that have a different source but
track the same event.
The latter will start one counter that tracks the event from all sources;
it therefore does the sum of the two counters from the first command, but
takes only one counter to do so.
+.El
+.Sh INTERPRETING RESULTS
+For each PMC on each CPU, the value reported by the
+.Nm
+tool is the number of events counted, encoded in a 64bit integer.
+.El
.Sh DIAGNOSTICS
.Bl -diag
.It PMC support not compiled into the kernel
@@ -125,6 +132,13 @@ See
.Xr options 4
for details.
.El
+.Sh FILES
+.Pa src/sys/arch/x86/x86/pmc.c
+x86 implementation.
+.Pp
+.Pa src/usr.bin/pmc/pmc.c
+pmc tool.
+.El
.Sh SEE ALSO
.Xr options 4
.Sh HISTORY
@@ -132,9 +146,10 @@ The
.Nm
command first appeared in
.Nx 1.6 .
-It was revamped in 2017.
+It was revamped in
+.Nx 8.0 .
.Sh BUGS
The
.Nm
command currently only supports performance-monitoring counters
-on the i386 architecture.
+on the i386 and amd64 architectures.
