share/man/man9/microuptime.9

   1 .\" Copyright (c) 2000 Kelly Yancey
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd September 16, 2004
  28 .Dt MICROUPTIME 9
  29 .Os
  30 .Sh NAME
  31 .Nm binuptime ,
  32 .Nm getbinuptime ,
  33 .Nm microuptime ,
  34 .Nm getmicrouptime ,
  35 .Nm nanouptime ,
  36 .Nm getnanouptime
  37 .Nd get the time elapsed since boot
  38 .Sh SYNOPSIS
  39 .In sys/time.h
  40 .Ft void
  41 .Fn binuptime "struct bintime *bt"
  42 .Ft void
  43 .Fn getbinuptime "struct bintime *bt"
  44 .Ft void
  45 .Fn microuptime "struct timeval *tv"
  46 .Ft void
  47 .Fn getmicrouptime "struct timeval *tv"
  48 .Ft void
  49 .Fn nanouptime "struct timespec *ts"
  50 .Ft void
  51 .Fn getnanouptime "struct timespec *tsp"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn binuptime
  55 and
  56 .Fn getbinuptime
  57 functions store the time elapsed since boot as a
  58 .Vt "struct bintime"
  59 at the address specified by
  60 .Fa bt .
  61 The
  62 .Fn microuptime
  63 and
  64 .Fn getmicrouptime
  65 functions perform the same utility, but record the elapsed time as a
  66 .Vt "struct timeval"
  67 instead.
  68 Similarly the
  69 .Fn nanouptime
  70 and
  71 .Fn getnanouptime
  72 functions store the elapsed time as a
  73 .Vt "struct timespec" .
  74 .Pp
  75 The
  76 .Fn binuptime ,
  77 .Fn microuptime ,
  78 and
  79 .Fn nanouptime
  80 functions
  81 always query the timecounter to return the current time as precisely as
  82 possible.
  83 Whereas
  84 .Fn getbinuptime ,
  85 .Fn getmicrouptime ,
  86 and
  87 .Fn getnanouptime
  88 functions are abstractions which return a less precise, but
  89 faster to obtain, time.
  90 .Pp
  91 The intent of the
  92 .Fn getbinuptime ,
  93 .Fn getmicrouptime ,
  94 and
  95 .Fn getnanouptime
  96 functions is to enforce the user's preference for timer accuracy versus
  97 execution time.
  98 .Sh SEE ALSO
  99 .Xr bintime 9 ,
 100 .Xr getbintime 9 ,
 101 .Xr getmicrotime 9 ,
 102 .Xr getnanotime 9 ,
 103 .Xr microtime 9 ,
 104 .Xr nanotime 9 ,
 105 .Xr tvtohz 9
 106 .Sh AUTHORS
 107 This manual page was written by
 108 .An Kelly Yancey Aq kbyanc@posi.net .