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: src/share/man/man9/microuptime.9,v 1.2.2.2 2001/12/17 11:30:18 ru Exp $
  26 .\"
  27 .Dd January 3, 2000
  28 .Dt MICROUPTIME 9
  29 .Os
  30 .Sh NAME
  31 .Nm microuptime ,
  32 .Nm getmicrouptime ,
  33 .Nm nanouptime ,
  34 .Nm getnanouptime
  35 .Nd get the time elapsed since boot
  36 .Sh SYNOPSIS
  37 .In sys/time.h
  38 .Ft void
  39 .Fn microuptime "struct timeval *tv"
  40 .Ft void
  41 .Fn getmicrouptime "struct timeval *tv"
  42 .Ft void
  43 .Fn nanouptime "struct timespec *ts"
  44 .Ft void
  45 .Fn getnanouptime "struct timespec *tsp"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn microuptime
  49 and
  50 .Fn getmicrouptime
  51 functions store the time elapsed since boot as a
  52 .Ft struct timeval
  53 at the address specified by
  54 .Fa tv .
  55 The
  56 .Fn nanouptime
  57 and
  58 .Fn getnanouptime
  59 functions perform the same utility, but record the elapsed time as a
  60 .Ft struct timespec
  61 instead.
  62 .Pp
  63 .Fn Microuptime
  64 and
  65 .Fn nanouptime
  66 always query the timecounter to return the current time as precisely as
  67 possible.
  68 Whereas
  69 .Fn getmicrouptime
  70 and
  71 .Fn getnanouptime
  72 functions are abstractions which can alternately return a less precise, but
  73 faster to obtain, time.
  74 This behaviour can be toggled via the
  75 kern.timecounter.method sysctl variable:
  76 .Bl -tag -width ABC
  77 .It Dv 0
  78 sacrifice precision in favor of faster code execution
  79 .It Dv 1
  80 return the more precise time (the same as calling
  81 .Fn microuptime
  82 or
  83 .Fn nanouptime ) .
  84 .El
  85 .Pp
  86 The intent of the
  87 .Fn getmicrouptime
  88 and
  89 .Fn getnanouptime
  90 functions is to enforce the user's preference for timer accuracy versus
  91 execution time.
  92 .Sh SEE ALSO
  93 .Xr getmicrotime 9 ,
  94 .Xr getnanotime 9 ,
  95 .Xr microtime 9 ,
  96 .Xr nanotime 9 ,
  97 .Xr tvtohz 9
  98 .Sh DIAGNOSTICS
  99 Buggy hardware can cause "calcru negative..." when kern.timecounter.method
 100 is set to 0.
 101 .Sh AUTHORS
 102 This manual page was written by
 103 .An Kelly Yancey Aq kbyanc@posi.net .