svn commit: r281705 - in head: cddl/contrib/opensolaris/cmd/dtrace share/man/man4 share/man/man9
Author: markj
Date: Sat Apr 18 21:00:36 2015
New Revision: 281705
URL: https://svnweb.freebsd.org/changeset/base/281705
Log:
Add manual pages for the io, ip, proc, sched, tcp and udp DTrace providers.
The format of these pages is somewhat experimental, so they may be subject
to further tweaking.
Differential Revision:https://reviews.freebsd.org/D2170
Reviewed by: bcr, rpaulo
MFC after:2 weeks
Added:
head/share/man/man4/dtrace-io.4 (contents, props changed)
head/share/man/man4/dtrace-ip.4 (contents, props changed)
head/share/man/man4/dtrace-proc.4 (contents, props changed)
head/share/man/man4/dtrace-sched.4 (contents, props changed)
head/share/man/man4/dtrace-tcp.4 (contents, props changed)
head/share/man/man4/dtrace-udp.4 (contents, props changed)
Modified:
head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
head/share/man/man4/Makefile
head/share/man/man9/SDT.9
Modified: head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
==
--- head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 Sat Apr 18 20:55:55
2015(r281704)
+++ head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 Sat Apr 18 21:00:36
2015(r281705)
@@ -21,7 +21,7 @@
.\
.\ $FreeBSD$
.\
-.Dd October 5, 2013
+.Dd April 18, 2015
.Dt DTRACE 1
.Os
.Sh NAME
@@ -670,7 +670,8 @@ Invalid command line options or argument
.Sh SEE ALSO
.Xr cpp 1 ,
.Xr dtruss 1 ,
-.Xr elf 5
+.Xr elf 5 ,
+.Xr SDT 9
.Rs
.%T Solaris Dynamic Tracing Guide
.Re
Modified: head/share/man/man4/Makefile
==
--- head/share/man/man4/MakefileSat Apr 18 20:55:55 2015
(r281704)
+++ head/share/man/man4/MakefileSat Apr 18 21:00:36 2015
(r281705)
@@ -121,6 +121,12 @@ MAN= aac.4 \
dpt.4 \
ds1307.4 \
ds3231.4 \
+ ${_dtrace_io.4} \
+ ${_dtrace_ip.4} \
+ ${_dtrace_proc.4} \
+ ${_dtrace_sched.4} \
+ ${_dtrace_tcp.4} \
+ ${_dtrace_udp.4} \
dummynet.4 \
ed.4 \
edsc.4 \
@@ -812,6 +818,15 @@ SUBDIR=man4.${MACHINE_CPUARCH}
_ccd.4=ccd.4
.endif
+.if ${MK_CDDL} != no
+_dtrace_io.4= dtrace-io.4
+_dtrace_ip.4= dtrace-ip.4
+_dtrace_proc.4=dtrace-proc.4
+_dtrace_sched.4= dtrace-sched.4
+_dtrace_tcp.4= dtrace-tcp.4
+_dtrace_udp.4= dtrace-udp.4
+.endif
+
.if ${MK_ISCSI} != no
MAN+= iscsi.4
MAN+= iscsi_initiator.4
Added: head/share/man/man4/dtrace-io.4
==
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/share/man/man4/dtrace-io.4 Sat Apr 18 21:00:36 2015
(r281705)
@@ -0,0 +1,123 @@
+.\ Copyright (c) 2015 Mark Johnston ma...@freebsd.org
+.\ 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.
+.\
+.\ $FreeBSD$
+.\
+.Dd April 18, 2015
+.Dt DTRACE-IO 4
+.Os
+.Sh NAME
+.Nm dtrace-io
+.Nd a DTrace provider for tracing events related to disk I/O
+.Sh SYNOPSIS
+.Fn io:::start struct bio * struct devstat *
+.Fn io:::done struct bio * struct devstat *
+.Sh DESCRIPTION
+The
+.Nm io
+provider allows the tracing of disk I/O events.
+The
+.Fn io:::start
+probe fires when a I/O request is about to be sent to the backing driver of a
+.Xr disk 9
+object.
+This occurs after all
+.Xr GEOM 4
+transformations have been performed on the request.
+The
+.Fn io:::done
+probe fires when a I/O request is completed.
+Both probes take a
+.Vt struct bio *
+representing the I/O request as their first argument.
+The second argument is a
+.Vt struct devstat *
+for the
Re: svn commit: r281705 - in head: cddl/contrib/opensolaris/cmd/dtrace share/man/man4 share/man/man9
Thank you for doing this!
On 18/04/2015 22:00, Mark Johnston wrote:
Author: markj
Date: Sat Apr 18 21:00:36 2015
New Revision: 281705
URL: https://svnweb.freebsd.org/changeset/base/281705
Log:
Add manual pages for the io, ip, proc, sched, tcp and udp DTrace providers.
The format of these pages is somewhat experimental, so they may be subject
to further tweaking.
Differential Revision: https://reviews.freebsd.org/D2170
Reviewed by: bcr, rpaulo
MFC after: 2 weeks
Added:
head/share/man/man4/dtrace-io.4 (contents, props changed)
head/share/man/man4/dtrace-ip.4 (contents, props changed)
head/share/man/man4/dtrace-proc.4 (contents, props changed)
head/share/man/man4/dtrace-sched.4 (contents, props changed)
head/share/man/man4/dtrace-tcp.4 (contents, props changed)
head/share/man/man4/dtrace-udp.4 (contents, props changed)
Modified:
head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
head/share/man/man4/Makefile
head/share/man/man9/SDT.9
Modified: head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1
==
--- head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 Sat Apr 18 20:55:55
2015(r281704)
+++ head/cddl/contrib/opensolaris/cmd/dtrace/dtrace.1 Sat Apr 18 21:00:36
2015(r281705)
@@ -21,7 +21,7 @@
.\
.\ $FreeBSD$
.\
-.Dd October 5, 2013
+.Dd April 18, 2015
.Dt DTRACE 1
.Os
.Sh NAME
@@ -670,7 +670,8 @@ Invalid command line options or argument
.Sh SEE ALSO
.Xr cpp 1 ,
.Xr dtruss 1 ,
-.Xr elf 5
+.Xr elf 5 ,
+.Xr SDT 9
.Rs
.%T Solaris Dynamic Tracing Guide
.Re
Modified: head/share/man/man4/Makefile
==
--- head/share/man/man4/MakefileSat Apr 18 20:55:55 2015
(r281704)
+++ head/share/man/man4/MakefileSat Apr 18 21:00:36 2015
(r281705)
@@ -121,6 +121,12 @@ MAN= aac.4 \
dpt.4 \
ds1307.4 \
ds3231.4 \
+ ${_dtrace_io.4} \
+ ${_dtrace_ip.4} \
+ ${_dtrace_proc.4} \
+ ${_dtrace_sched.4} \
+ ${_dtrace_tcp.4} \
+ ${_dtrace_udp.4} \
dummynet.4 \
ed.4 \
edsc.4 \
@@ -812,6 +818,15 @@ SUBDIR=man4.${MACHINE_CPUARCH}
_ccd.4= ccd.4
.endif
+.if ${MK_CDDL} != no
+_dtrace_io.4= dtrace-io.4
+_dtrace_ip.4= dtrace-ip.4
+_dtrace_proc.4=dtrace-proc.4
+_dtrace_sched.4= dtrace-sched.4
+_dtrace_tcp.4= dtrace-tcp.4
+_dtrace_udp.4= dtrace-udp.4
+.endif
+
.if ${MK_ISCSI} != no
MAN+= iscsi.4
MAN+= iscsi_initiator.4
Added: head/share/man/man4/dtrace-io.4
==
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ head/share/man/man4/dtrace-io.4 Sat Apr 18 21:00:36 2015
(r281705)
@@ -0,0 +1,123 @@
+.\ Copyright (c) 2015 Mark Johnston ma...@freebsd.org
+.\ 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.
+.\
+.\ $FreeBSD$
+.\
+.Dd April 18, 2015
+.Dt DTRACE-IO 4
+.Os
+.Sh NAME
+.Nm dtrace-io
+.Nd a DTrace provider for tracing events related to disk I/O
+.Sh SYNOPSIS
+.Fn io:::start struct bio * struct devstat *
+.Fn io:::done struct bio * struct devstat *
+.Sh DESCRIPTION
+The
+.Nm io
+provider allows the tracing of disk I/O events.
+The
+.Fn io:::start
+probe fires when a I/O request is about to be sent to the backing driver of a
+.Xr disk 9
+object.
+This occurs after all
+.Xr GEOM 4
+transformations have been performed on the request.
+The
+.Fn io:::done
+probe fires when a I/O request is completed.
+Both probes take a
+.Vt struct bio *
+representing the I/O
