Add new manpages for:

	microtime(9)
	nanotime(9)
	getmicrotime(9)
	getnanotime(9)
	microuptime(9)
	nanouptime(9)
	getmicrouptime(9)
	getnanouptime(9)
	tvtohz(9)

Based on PR:	docs/15889
Submitted by:	Kelly Yancey <kbyanc@posi.net>

4 files changed, 276 insertions, 1 deletions

diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 89d7887..03ec9f7 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -17,7 +17,8 @@ MAN9=	MD5.9 \
 	make_dev.9 microseq.9 mi_switch.9 namei.9 panic.9 physio.9 posix4.9 \
 	psignal.9 resettodr.9 rtalloc.9 rtentry.9 sleep.9 spl.9 \
 	store.9 style.9 suser.9 time.9 timeout.9 uio.9 \
-	vget.9 vnode.9 vput.9 vref.9 vrele.9 vslock.9
+	vget.9 vnode.9 vput.9 vref.9 vrele.9 vslock.9 \
+	microtime.9 microuptime.9 tvtohz.9
 
 MAN9+=	device.9 device_add_child.9 device_delete_child.9 device_enable.9 \
 	device_find_child.9 device_get_children.9 \
@@ -99,4 +100,9 @@ MLINKS+=devclass_add_driver.9 devclass_find_driver.9
 MLINKS+=BUS_READ_IVAR.9 BUS_WRITE_IVAR.9
 MLINKS+=bus_generic_read_ivar.9 bus_generic_write_ivar.9
 
+MLINKS+=microtime.9 getmicrotime.9 microtime.9 nanotime.9
+MLINKS+=microtime.9 getnanotime.9
+MLINKS+=microuptime.9 getmicrouptime.9 microuptime.9 nanouptime.9
+MLINKS+=microuptime.9 getnanouptime.9
+
 .include <bsd.prog.mk>
diff --git a/share/man/man9/microtime.9 b/share/man/man9/microtime.9
new file mode 100644
index 0000000..c5ebfc5
--- /dev/null
+++ b/share/man/man9/microtime.9
@@ -0,0 +1,110 @@
+.\" Copyright (c) 2000 Kelly Yancey
+.\" 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 January 3, 2000
+.Dt MICROTIME 9
+.Os FreeBSD
+.Sh NAME
+.Nm microtime ,
+.Nm getmicrotime ,
+.Nm nanotime ,
+.Nm getnanotime
+.Nd get the current time
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Ft void
+.Fn microtime "struct timeval *tv"
+.Ft void
+.Fn getmicrotime "struct timeval *tv"
+.Ft void
+.Fn nanotime "struct timespec *ts"
+.Ft void
+.Fn getnanotime "struct timespec *tsp"
+.Sh DESCRIPTION
+The
+.Fn microtime
+and
+.Fn getmicrotime
+functons stores the system time as a
+.Ft struct timeval
+at the address specified by
+.Fa tv .
+The
+.Fn nanotime
+and
+.Fn getnanotime
+functions perform the same utility, but record the time as a
+.Ft struct timespec
+instead.
+.Pp
+.Fn Microtime
+and
+.Fn nanotime
+always query the timecounter to return the current time as precisely as
+possible. Whereas
+.Fn getmicrotime
+and
+.Fn getnanotime
+functions are abstractions which can alternately return a less precise, but
+faster to obtain, time. This behaviour can be toggled via the
+kern.timecounter.method sysctl variable:
+.Bl -tag -width ABC
+.It Dv 0
+sacrifice precision in favor of faster code execution
+.It Dv 1
+return the more precise time (the same as calling
+.Fn microtime
+or
+.Fn nanotime ) .
+.El
+.Pp
+The intent of the
+.Fn getmicrotime
+and
+.Fn getnanotime
+functions is to enforce the user's preference for timer accuracy versus
+execution time.
+.Sh SEE ALSO
+.Xr getmicrouptime 9 ,
+.Xr getnanouptime 9 ,
+.Xr microuptime 9 ,
+.Xr nanouptime 9 ,
+.Xr tvtohz 9
+.Sh DIAGNOSTICS
+Buggy hardware can cause "calcru negative..." when kern.timecounter.method
+is set to 0.
+.Sh HISTORY
+The
+.Nm microtime
+and
+.Nm nanotime
+functions first appeared in
+.Fx 3.0
+but existed in other incarnations since
+.Bx 4.4
+.Sh AUTHORS
+This manual page was written by
+.An Kelly Yancey Aq kbyanc@posi.net .
diff --git a/share/man/man9/microuptime.9 b/share/man/man9/microuptime.9
new file mode 100644
index 0000000..39fc7ac
--- /dev/null
+++ b/share/man/man9/microuptime.9
@@ -0,0 +1,101 @@
+.\" Copyright (c) 2000 Kelly Yancey
+.\" 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 January 3, 2000
+.Dt MICROUPTIME 9
+.Os FreeBSD
+.Sh NAME
+.Nm microuptime ,
+.Nm getmicrouptime ,
+.Nm nanouptime ,
+.Nm getnanouptime
+.Nd get the time elapsed since boot
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Ft void
+.Fn microuptime "struct timeval *tv"
+.Ft void
+.Fn getmicrouptime "struct timeval *tv"
+.Ft void
+.Fn nanouptime "struct timespec *ts"
+.Ft void
+.Fn getnanouptime "struct timespec *tsp"
+.Sh DESCRIPTION
+The
+.Fn microuptime
+and
+.Fn getmicrouptime
+functions store the time elapsed since boot as a
+.Ft struct timeval
+at the address specified by
+.Fa tv .
+The
+.Fn nanouptime
+and
+.Fn getnanouptime
+functions perform the same utility, but record the elapsed time as a
+.Ft struct timespec
+instead.
+.Pp
+.Fn Microuptime
+and
+.Fn nanouptime
+always query the timecounter to return the current time as precisely as
+possible. Whereas
+.Fn getmicrouptime
+and
+.Fn getnanouptime
+functions are abstractions which can alternately return a less precise, but
+faster to obtain, time. This behaviour can be toggled via the
+kern.timecounter.method sysctl variable:
+.Bl -tag -width ABC
+.It Dv 0
+sacrifice precision in favor of faster code execution
+.It Dv 1
+return the more precise time (the same as calling
+.Fn microuptime
+or
+.Fn nanouptime ) .
+.El
+.Pp
+The intent of the
+.Fn getmicrouptime
+and
+.Fn getnanouptime
+functions is to enforce the user's preference for timer accuracy versus
+execution time.
+.Sh SEE ALSO
+.Xr getmicrotime 9 ,
+.Xr getnanotime 9 ,
+.Xr microtime 9 ,
+.Xr nanotime 9 ,
+.Xr tvtohz 9
+.Sh DIAGNOSTICS
+Buggy hardware can cause "calcru negative..." when kern.timecounter.method
+is set to 0.
+.Sh AUTHORS
+This manual page was written by
+.An Kelly Yancey Aq kbyanc@posi.net .
diff --git a/share/man/man9/tvtohz.9 b/share/man/man9/tvtohz.9
new file mode 100644
index 0000000..641f165
--- /dev/null
+++ b/share/man/man9/tvtohz.9
@@ -0,0 +1,58 @@
+.\" Copyright (c) 2000 Kelly Yancey
+.\" 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 January 3, 2000
+.Dt TVTOHZ 9
+.Os FreeBSD
+.Sh NAME
+.Nm tvtohz
+.Nd convert time interval to tick count
+.Sh SYNOPSIS
+.Fd #include <sys/time.h>
+.Ft int
+.Fn tvtohz "struct timeval *tv"
+.Sh DESCRIPTION
+The
+.Fn tvtohz
+function accepts a single argument
+.Fa tv
+which specifies the time interval over which to calculate the number
+of system ticks that would elapse.
+.Sh RETURN VALUES
+Returns the integral number of system ticks expected to elapse in the given
+interval, including the current tick.
+.Sh SEE ALSO
+.Xr microtime 9 ,
+.Xr microuptime 9 ,
+.Xr timeout 9
+.Sh HISTORY
+The
+.Nm
+function first appeared in
+.Fx 3.0
+.Sh AUTHORS
+This manual page was written by
+.An Kelly Yancey Aq kbyanc@posi.net .