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: src/share/man/man7/clocks.7,v 1.9.2.5 2001/12/17 11:30:15 ru Exp $
  29 .\" "
  30 .Dd April 1, 1996
  31 .Os
  32 .Dt CLOCKS 7
  33 .Sh NAME
  34 .Nm clocks
  35 .Nd various system timers
  36 .Sh SYNOPSIS
  37 .In time.h
  38 .Sh DESCRIPTION
  39 .Ql 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 -offset XXX
  46 .It
  47 The scheduling clock.  This is a real clock with frequency that
  48 happens to be 100.  It isn't available to applications.
  49 .It
  50 The statistics clock.  This is a real clock with frequency that
  51 happens to be 128.  It isn't directly available to applications.
  52 .It
  53 The clock reported by
  54 .Xr clock 3 .
  55 This is a virtual clock with a frequency that happens to be 128.  Its
  56 actual frequency is given by the macro
  57 .Dv CLOCKS_PER_SEC .
  58 Note that
  59 .Dv CLOCKS_PER_SEC
  60 may be floating point.  Don't use
  61 .Fn clock
  62 in new programs under
  63 .Fx .
  64 It is feeble compared with
  65 .Xr getrusage 2 .
  66 It is provided for ANSI conformance.  It is implemented by calling
  67 .Fn getrusage
  68 and throwing away information and resolution.
  69 .It
  70 The clock reported by
  71 .Xr times 3 .
  72 This is a virtual clock with a frequency that happens to be 128.  Its
  73 actual frequency is given by the macro
  74 .Dv CLK_TCK
  75 (deprecated; don't use) and by
  76 .Fn sysconf SC_CLK_TCK
  77 and by
  78 .Xr sysctl 3 .
  79 Note that its frequency may be different from
  80 .Dv CLOCKS_PER_SEC .
  81 Don't use
  82 .Xr times 3
  83 in new programs under
  84 .Fx .
  85 It is feeble compared with
  86 .Xr gettimeofday 2
  87 together with
  88 .Fn getrusage .
  89 It is provided for POSIX
  90 conformance.  It is implemented by calling
  91 .Fn gettimeofday
  92 and
  93 .Fn getrusage
  94 and throwing away information and resolution.
  95 .It
  96 The profiling clock.  This is a real clock with frequency 1024.
  97 It is used mainly by
  98 .Xr moncontrol 3 ,
  99 .Xr kgmon 8
 100 and
 101 .Xr gprof 1 .
 102 Applications should determine its actual frequency using
 103 .Xr sysctl 3
 104 or by reading it from the header in the profiling data file.
 105 .It
 106 The mc14618a clock.  This is a real clock with a nominal frequency of
 107 32768.  It is divided down to give the statistic clock and the profiling
 108 clock.  It isn't available to applications.
 109 .It
 110 The microseconds clock.  This is a virtual clock with frequency
 111 1000000.  It is used for most timekeeping in
 112 .Bx
 113 and is exported
 114 to applications in
 115 .Xr getrusage 2 ,
 116 .Xr gettimeofday 2 ,
 117 .Xr select 2 ,
 118 .Xr getitimer 2 ,
 119 etc...  This is the clock that should normally be used
 120 by
 121 .Bx
 122 applications.
 123 .It
 124 The i8254 clock.  This is a real clock/timer with a nominal frequency of
 125 1193182.  It is divided down to give the scheduling clock.  It isn't
 126 available to applications.
 127 .It
 128 The TSC clock (64-bit register) on fifth-generation or later x86 systems.
 129 This is a real clock with a frequency that is equivalent to the number of
 130 cycles per second of the CPU(s).
 131 Its frequency can be found using the sysctl
 132 .Sy machdep.tsc_freq .
 133 It is used to interpolate between values of the scheduling clock.
 134 It is only available to applications in a purely machine-dependent manner.
 135 .El
 136 .Pp
 137 Summary: if
 138 .Ql HZ
 139 isn't 1000000 then the application is probably using the wrong clock.
 140 .Sh SEE ALSO
 141 .Xr gprof 1 ,
 142 .Xr getitimer 2 ,
 143 .Xr getrusage 2 ,
 144 .Xr gettimeofday 2 ,
 145 .Xr select 2 ,
 146 .Xr clock 3 ,
 147 .Xr moncontrol 3 ,
 148 .Xr times 3
 149 .Sh AUTHORS
 150 .An -nosplit
 151 This man page has been written by
 152 .An J\(:org Wunsch
 153 after a description posted by
 154 .An Bruce Evans .