share/man/man9/microtime.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: src/share/man/man9/microtime.9,v 1.2.2.3 2001/12/17 11:30:18 ru Exp $
  26 .\"
  27 .Dd September 23, 2017
  28 .Dt MICROTIME 9
  29 .Os
  30 .Sh NAME
  31 .Nm microtime ,
  32 .Nm getmicrotime ,
  33 .Nm nanotime ,
  34 .Nm getnanotime
  35 .Nd get the current time
  36 .Sh SYNOPSIS
  37 .In sys/time.h
  38 .Ft void
  39 .Fn microtime "struct timeval *tv"
  40 .Ft void
  41 .Fn getmicrotime "struct timeval *tv"
  42 .Ft void
  43 .Fn nanotime "struct timespec *ts"
  44 .Ft void
  45 .Fn getnanotime "struct timespec *tsp"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn microtime
  49 and
  50 .Fn getmicrotime
  51 functions stores the system time as a
  52 .Ft struct timeval
  53 at the address specified by
  54 .Fa tv .
  55 The
  56 .Fn nanotime
  57 and
  58 .Fn getnanotime
  59 functions perform the same utility, but record the time as a
  60 .Ft struct timespec
  61 instead.
  62 .Pp
  63 .Fn Microtime
  64 and
  65 .Fn nanotime
  66 always query the timecounter to return the current time as precisely as
  67 possible.
  68 Whereas
  69 .Fn getmicrotime
  70 and
  71 .Fn getnanotime
  72 functions are abstractions which return a less precise, but
  73 faster to obtain, time.
  74 The
  75 .Fn getmicrouptime
  76 and
  77 .Fn getnanouptime
  78 functions will return a time which is up to 1/HZ previous to the call.
  79 .Pp
  80 The intent of the
  81 .Fn getmicrotime
  82 and
  83 .Fn getnanotime
  84 functions is to enforce the user's preference for timer accuracy versus
  85 execution time.
  86 .Sh SEE ALSO
  87 .Xr getmicrouptime 9 ,
  88 .Xr getnanouptime 9 ,
  89 .Xr microuptime 9 ,
  90 .Xr nanouptime 9 ,
  91 .Xr tvtohz 9
  92 .Sh HISTORY
  93 The
  94 .Nm
  95 and
  96 .Nm nanotime
  97 functions first appeared in
  98 .Fx 3.0
  99 but existed in other incarnations since
 100 .Bx 4.4
 101 .Sh AUTHORS
 102 This manual page was written by
 103 .An Kelly Yancey Aq Mt kbyanc@posi.net .