share/man/man9/get_cyclecount.9

   1 .\" Copyright (c) 2000 Mark R V Murray
   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 March 15, 2011
  28 .Dt GET_CYCLECOUNT 9
  29 .Os
  30 .Sh NAME
  31 .Nm get_cyclecount
  32 .Nd get the CPU's fast counter register contents
  33 .Sh SYNOPSIS
  34 .In sys/param.h
  35 .In sys/systm.h
  36 .In machine/cpu.h
  37 .Ft u_int64_t
  38 .Fn get_cyclecount "void"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn get_cyclecount
  42 function uses a register
  43 available in most modern CPUs
  44 to return a value
  45 that is monotonically increasing
  46 inside each CPU.
  47 .Pp
  48 On SMP systems,
  49 there will be a number of
  50 separate monotonic sequences,
  51 one for each CPU running.
  52 The value in the SMP case is
  53 selected from one of these sequences,
  54 dependent on which CPU
  55 was scheduled to service the request.
  56 .Pp
  57 The speed and the maximum value
  58 of each counter
  59 is CPU-dependent.
  60 Some CPUs
  61 (such as the
  62 .Tn Intel
  63 80486)
  64 do not have such a register,
  65 so
  66 .Fn get_cyclecount
  67 on these platforms
  68 returns a (monotonic) combination of numbers
  69 represented by the
  70 structure returned by
  71 .Xr binuptime 9 .
  72 .Pp
  73 The
  74 .Tn AMD64
  75 and
  76 .Tn Intel 64
  77 processors use the
  78 .Li TSC
  79 register.
  80 .Pp
  81 The
  82 .Tn IA64
  83 processors use the
  84 .Li AR.ITC
  85 register.
  86 .Sh SEE ALSO
  87 .Xr binuptime 9
  88 .Sh HISTORY
  89 The
  90 .Fn get_cyclecount
  91 function first appeared in
  92 .Fx 5.0 .
  93 .Sh AUTHORS
  94 This manual page was written by
  95 .An Mark Murray Aq markm@FreeBSD.org .