share/man/man7/clocks.7

   1 .\"
   2 .\" Copyright (c) 1996 Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\" "
  30 .Dd January 18, 2008
  31 .Dt CLOCKS 7
  32 .Os
  33 .Sh NAME
  34 .Nm clocks
  35 .Nd various system timers
  36 .Sh SYNOPSIS
  37 .In time.h
  38 .Sh DESCRIPTION
  39 .Dv HZ
  40 is not part of the application interface in
  41 .Bx .
  42 .Pp
  43 There are many different real and virtual (timekeeping) clocks with
  44 different frequencies:
  45 .Bl -bullet
  46 .It
  47 The scheduling clock.
  48 This is a real clock with frequency that happens to be 100.
  49 It is not available to applications.
  50 .It
  51 The statistics clock.
  52 This is a real clock with frequency that happens to be 128.
  53 It is not directly available to applications.
  54 .It
  55 The clock reported by
  56 .Xr clock 3 .
  57 This is a virtual clock with a frequency that happens to be 128.
  58 Its actual frequency is given by the macro
  59 .Dv CLOCKS_PER_SEC .
  60 Note that
  61 .Dv CLOCKS_PER_SEC
  62 may be floating point.
  63 Do not use
  64 .Xr clock 3
  65 in new programs under
  66 .Fx .
  67 It is feeble compared with
  68 .Xr getrusage 2 .
  69 It is provided for
  70 .Tn ANSI
  71 conformance.
  72 It is implemented by calling
  73 .Xr getrusage 2
  74 and throwing away information and resolution.
  75 .It
  76 The clock reported by
  77 .Xr times 3 .
  78 This is a virtual clock with a frequency that happens to be 128.
  79 Its actual frequency is given by the macro
  80 .Dv CLK_TCK
  81 (deprecated; do not use) and by
  82 .Fn sysconf _SC_CLK_TCK
  83 and by
  84 .Xr sysctl 3 .
  85 Note that its frequency may be different from
  86 .Dv CLOCKS_PER_SEC .
  87 Do not use
  88 .Xr times 3
  89 in new programs under
  90 .Fx .
  91 It is feeble compared with
  92 .Xr gettimeofday 2
  93 together with
  94 .Xr getrusage 2 .
  95 It is provided for
  96 .Tn POSIX
  97 conformance.
  98 It is implemented by calling
  99 .Xr gettimeofday 2
 100 and
 101 .Xr getrusage 2
 102 and throwing away information and resolution.
 103 .It
 104 The profiling clock.
 105 This is a real clock with frequency 1024.
 106 It is used mainly by
 107 .Xr moncontrol 3
 108 and
 109 .Xr gprof 1 .
 110 Applications should determine its actual frequency using
 111 .Xr sysctl 3
 112 or by reading it from the header in the profiling data file.
 113 .It
 114 The mc146818a clock.
 115 This is a real clock with a nominal frequency of 32768.
 116 It is divided down to give the statistic clock and the profiling clock.
 117 It is not available to applications.
 118 .It
 119 The microseconds clock.
 120 This is a virtual clock with frequency 1000000.
 121 It is used for most timekeeping in
 122 .Bx
 123 and is exported to applications in
 124 .Xr getrusage 2 ,
 125 .Xr gettimeofday 2 ,
 126 .Xr select 2 ,
 127 .Xr getitimer 2 ,
 128 etc.
 129 This is the clock that should normally be used by
 130 .Bx
 131 applications.
 132 .It
 133 The i8254 clock.
 134 This is a real clock/timer with a nominal frequency of 1193182.
 135 It has three independent time counters to be used.
 136 It is divided down to give the scheduling clock.
 137 It is not available to applications.
 138 .It
 139 The TSC clock (64-bit register) on fifth-generation or later x86 systems.
 140 This is a real clock with a frequency that is equivalent to the number of
 141 cycles per second of the CPU(s).
 142 Its frequency can be found using the
 143 .Va machdep.tsc_freq
 144 sysctl, if it is available.
 145 It is used to interpolate between values of the scheduling clock.
 146 It can be accessed using the
 147 .Dv PMIOTSTAMP
 148 request of
 149 .Xr perfmon 4 .
 150 .It
 151 The ACPI clock.
 152 This is a real clock/timer with a nominal frequency of 3579545.
 153 It is accessed via a 24 or 32 bit register.
 154 Unlike the TSC clock, it maintains a constant tick rate even when the CPU
 155 sleeps or its clock rate changes.
 156 It is not available to applications.
 157 .El
 158 .Pp
 159 Summary: if
 160 .Dv HZ
 161 is not 1000000 then the application is probably using the wrong clock.
 162 .Sh SEE ALSO
 163 .Xr gprof 1 ,
 164 .Xr clock_gettime 2 ,
 165 .Xr getitimer 2 ,
 166 .Xr getrusage 2 ,
 167 .Xr gettimeofday 2 ,
 168 .Xr select 2 ,
 169 .Xr clock 3 ,
 170 .Xr moncontrol 3 ,
 171 .Xr times 3
 172 .Sh AUTHORS
 173 .An -nosplit
 174 This manual page was written by
 175 .An J\(:org Wunsch
 176 after a description posted by
 177 .An Bruce Evans .