Module Name: src
Committed By: yamt
Date: Fri Dec 2 12:17:51 UTC 2011
Added Files:
src/share/man/man4: tprof.4
src/share/man/man4/man4.x86: tprof_amdpmi.4 tprof_pmi.4
Log Message:
some man pages
To generate a diff of this commit:
cvs rdiff -u -r0 -r1.1 src/share/man/man4/tprof.4
cvs rdiff -u -r0 -r1.1 src/share/man/man4/man4.x86/tprof_amdpmi.4 \
src/share/man/man4/man4.x86/tprof_pmi.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Added files:
Index: src/share/man/man4/tprof.4
diff -u /dev/null src/share/man/man4/tprof.4:1.1
--- /dev/null Fri Dec 2 12:17:51 2011
+++ src/share/man/man4/tprof.4 Fri Dec 2 12:17:51 2011
@@ -0,0 +1,71 @@
+.\" $NetBSD: tprof.4,v 1.1 2011/12/02 12:17:51 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (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 December 2, 2011
+.Dt TPROF 4
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm tprof
+.Nd a sampling based profiler
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.Cd pseudo-device tprof
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Nm
+driver provides kernel services necessary for
+.Xr tprof 8 .
+.Pp
+Specifically, it makes its backend driver collect profiling samples and
+provide them to the userland consumer.
+.Pp
+The API/ABI is currently undocumented and will likely change in future
+without keeping compatibility.
+.\" ------------------------------------------------------------
+.\".Sh EXAMPLES
+.\" ------------------------------------------------------------
+.Sh SEE ALSO
+.Xr tprof_amdpmi 4 ,
+.Xr tprof_pmi 4
+.Xr tprof 8
+.\" ------------------------------------------------------------
+.\".Sh HISTORY
+.\"The
+.\".Nm
+.\"driver first appeared in
+.\".Nx 4.0 .
+.\" ------------------------------------------------------------
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An YAMAMOTO Takashi .
+.\" ------------------------------------------------------------
+.Sh BUGS
+There is no way to configure multiple backend drivers statically.
Index: src/share/man/man4/man4.x86/tprof_amdpmi.4
diff -u /dev/null src/share/man/man4/man4.x86/tprof_amdpmi.4:1.1
--- /dev/null Fri Dec 2 12:17:51 2011
+++ src/share/man/man4/man4.x86/tprof_amdpmi.4 Fri Dec 2 12:17:51 2011
@@ -0,0 +1,66 @@
+.\" $NetBSD: tprof_amdpmi.4,v 1.1 2011/12/02 12:17:51 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (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 December 2, 2011
+.Dt TPROF_AMDPMI 4
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm tprof_amdpmi
+.Nd a tprof backend for AMD processors
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.Cd pseudo-device tprof_amdpmi
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Nm
+driver is a
+.Xr tprof 4
+backend driver, which uses performance-monitoring events available for
+some of AMD processors.
+.Pp
+It programs the processors so that "CPU Clocks not Halted" events
+(event select 0x76) to raise NMIs and the NMI handler collects
+a sample.
+.\" ------------------------------------------------------------
+.\".Sh EXAMPLES
+.\" ------------------------------------------------------------
+.Sh SEE ALSO
+.Xr tprof 4
+.\" ------------------------------------------------------------
+.\".Sh HISTORY
+.\"The
+.\".Nm
+.\"driver first appeared in
+.\".Nx 4.0 .
+.\" ------------------------------------------------------------
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An YAMAMOTO Takashi .
Index: src/share/man/man4/man4.x86/tprof_pmi.4
diff -u /dev/null src/share/man/man4/man4.x86/tprof_pmi.4:1.1
--- /dev/null Fri Dec 2 12:17:51 2011
+++ src/share/man/man4/man4.x86/tprof_pmi.4 Fri Dec 2 12:17:51 2011
@@ -0,0 +1,69 @@
+.\" $NetBSD: tprof_pmi.4,v 1.1 2011/12/02 12:17:51 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (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 December 2, 2011
+.Dt TPROF_PMI 4
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm tprof_pmi
+.Nd a tprof backend for Intel Pentium 4
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.Cd pseudo-device tprof_pmi
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Nm
+driver is a
+.Xr tprof 4
+backend driver, which uses performance-monitoring events available for
+Intel Pentium 4 (NetBurst) processors.
+.Pp
+It programs the processors so that global_power_events events
+(ESCR Event Select = 0x13) to raise NMIs and the NMI handler collects
+a sample.
+.\" ------------------------------------------------------------
+.\".Sh EXAMPLES
+.\" ------------------------------------------------------------
+.Sh SEE ALSO
+.Xr tprof 4
+.\" ------------------------------------------------------------
+.\".Sh HISTORY
+.\"The
+.\".Nm
+.\"driver first appeared in
+.\".Nx 4.0 .
+.\" ------------------------------------------------------------
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An YAMAMOTO Takashi .
+.\" ------------------------------------------------------------
+.Sh BUGS
+The name of this driver is too generic.
