summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbrooks <brooks@FreeBSD.org>2013-07-25 20:53:15 +0000
committerbrooks <brooks@FreeBSD.org>2013-07-25 20:53:15 +0000
commit0f2f7957393d210c4606f7096c07a8f0bcebc03c (patch)
treead44691e1addba0d21f967167fc74cb9be073bd6
parent44afceea6d3a60d1a7a1c65c0c73d00a05bc85e3 (diff)
downloadFreeBSD-src-0f2f7957393d210c4606f7096c07a8f0bcebc03c.zip
FreeBSD-src-0f2f7957393d210c4606f7096c07a8f0bcebc03c.tar.gz
Document the sbinuptime() and getsbinuptime() functions introduced in
r247452. Sponsored by: DARPA, AFRL
-rw-r--r--share/man/man9/Makefile4
-rw-r--r--share/man/man9/microuptime.925
2 files changed, 23 insertions, 6 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 2409ffb..86e89a7 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -954,7 +954,9 @@ MLINKS+=microuptime.9 binuptime.9 \
microuptime.9 getbinuptime.9 \
microuptime.9 getmicrouptime.9 \
microuptime.9 getnanouptime.9 \
- microuptime.9 nanouptime.9
+ microuptime.9 getsbinuptime.9 \
+ microuptime.9 nanouptime.9 \
+ microuptime.9 sbinuptime.9
MLINKS+=mi_switch.9 cpu_switch.9 \
mi_switch.9 cpu_throw.9
MLINKS+=mtx_pool.9 mtx_pool_alloc.9 \
diff --git a/share/man/man9/microuptime.9 b/share/man/man9/microuptime.9
index 8f9985f..5a9a71b 100644
--- a/share/man/man9/microuptime.9
+++ b/share/man/man9/microuptime.9
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd September 16, 2004
+.Dd July 25, 2013
.Dt MICROUPTIME 9
.Os
.Sh NAME
@@ -33,7 +33,9 @@
.Nm microuptime ,
.Nm getmicrouptime ,
.Nm nanouptime ,
-.Nm getnanouptime
+.Nm getnanouptime ,
+.Nm sbinuptime ,
+.Nm getsbinuptime
.Nd get the time elapsed since boot
.Sh SYNOPSIS
.In sys/time.h
@@ -49,6 +51,10 @@
.Fn nanouptime "struct timespec *ts"
.Ft void
.Fn getnanouptime "struct timespec *tsp"
+.Ft sbintime_t
+.Fn sbinuptime "void"
+.Ft sbintime_t
+.Fn getsbinuptime "void"
.Sh DESCRIPTION
The
.Fn binuptime
@@ -71,28 +77,37 @@ and
.Fn getnanouptime
functions store the elapsed time as a
.Vt "struct timespec" .
+The
+.Fn sbinuptime
+and
+.Fn getsbinuptime
+functions return the time elapsed since boot as a
+.Vt "sbintime_t" .
.Pp
The
.Fn binuptime ,
.Fn microuptime ,
+.Fn nanouptime ,
and
-.Fn nanouptime
+.Fn sbinuptime
functions
always query the timecounter to return the current time as precisely as
possible.
Whereas
.Fn getbinuptime ,
.Fn getmicrouptime ,
+.Fn getnanouptime ,
and
-.Fn getnanouptime
+.Fn getsbinuptime
functions are abstractions which return a less precise, but
faster to obtain, time.
.Pp
The intent of the
.Fn getbinuptime ,
.Fn getmicrouptime ,
+.Fn getnanouptime ,
and
-.Fn getnanouptime
+.Fn getsbinuptime
functions is to enforce the user's preference for timer accuracy versus
execution time.
.Sh SEE ALSO
OpenPOWER on IntegriCloud