aboutsummaryrefslogtreecommitdiff
path: root/share/man/man9/microuptime.9
diff options
context:
space:
mode:
authorBrooks Davis <brooks@FreeBSD.org>2013-07-25 20:53:15 +0000
committerBrooks Davis <brooks@FreeBSD.org>2013-07-25 20:53:15 +0000
commitf1bd660622f79e7493b62544e9230fd983f935dc (patch)
treead44691e1addba0d21f967167fc74cb9be073bd6 /share/man/man9/microuptime.9
parentb6dda50adc1769e8d48072dde63f534557e26bf7 (diff)
downloadsrc-f1bd660622f79e7493b62544e9230fd983f935dc.tar.gz
src-f1bd660622f79e7493b62544e9230fd983f935dc.zip
Document the sbinuptime() and getsbinuptime() functions introduced in
r247452. Sponsored by: DARPA, AFRL
Notes
Notes: svn path=/head/; revision=253660
Diffstat (limited to 'share/man/man9/microuptime.9')
-rw-r--r--share/man/man9/microuptime.925
1 files changed, 20 insertions, 5 deletions
diff --git a/share/man/man9/microuptime.9 b/share/man/man9/microuptime.9
index 8f9985f72aa9..5a9a71befd48 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