lib/libc/sys/ntp_adjtime.2

   1 .\"
   2 .\" Copyright (c) 2003 Tom Rhodes
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/sys/ntp_adjtime.2,v 1.1.2.1 2003/04/22 17:31:18 trhodes Exp $
  27 .\"
  28 .Dd April 1, 2003
  29 .Dt NTP_ADJTIME 2
  30 .Os
  31 .Sh NAME
  32 .Nm ntp_adjtime
  33 .Nd NTP daemon application interface
  34 .Sh SYNOPSIS
  35 .In sys/types.h
  36 .In sys/timex.h
  37 .Ft int
  38 .Fn ntp_adjtime "struct timex *tp"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn ntp_adjtime
  42 system call is used as a kernel interface
  43 for the Network Time Protocol daemon,
  44 .Xr ntpd 8 .
  45 Certain fields of the
  46 .Vt timex
  47 structure are interpreted in either
  48 microseconds or nanoseconds, according to the state of the
  49 .Dv STA_NANO
  50 bit in the
  51 .Va status
  52 word.
  53 .Pp
  54 In the
  55 .Fx
  56 kernel, the
  57 .Fn ntp_adjtime
  58 and
  59 .Xr ntp_gettime 2
  60 system calls can be used to determine which
  61 resolution is in use, and to select either one at any time.
  62 The resolution selected affects the scaling of certain fields in the
  63 .Fn ntp_gettime
  64 and
  65 .Fn ntp_adjtime
  66 system calls.
  67 .Pp
  68 Take note that this
  69 .Tn API
  70 is extremely complex and stateful.
  71 Users should not attempt modification without first
  72 reviewing the
  73 .Xr ntpd 8
  74 sources in depth.
  75 .Bd -literal
  76 /*
  77  * NTP daemon interface (ntp_adjtime()) - used to discipline CPU clock
  78  * oscillator and determine status.
  79  *
  80  * Note: The offset, precision and jitter members are in microseconds if
  81  * STA_NANO is zero and nanoseconds if not.
  82  */
  83 struct timex {
  84         unsigned int modes;     /* clock mode bits (wo) */
  85         long    offset;         /* time offset (ns/us) (rw) */
  86         long    freq;           /* frequency offset (scaled PPM) (rw) */
  87         long    maxerror;       /* maximum error (us) (rw) */
  88         long    esterror;       /* estimated error (us) (rw) */
  89         int     status;         /* clock status bits (rw) */
  90         long    constant;       /* poll interval (log2 s) (rw) */
  91         long    precision;      /* clock precision (ns/us) (ro) */
  92         long    tolerance;      /* clock frequency tolerance (scaled
  93                                  * PPM) (ro) */
  94         /*
  95          * The following read-only structure members are implemented
  96          * only if the PPS signal discipline is configured in the
  97          * kernel. They are included in all configurations to insure
  98          * portability.
  99          */
 100         long    ppsfreq;        /* PPS frequency (scaled PPM) (ro) */
 101         long    jitter;         /* PPS jitter (ns/us) (ro) */
 102         int     shift;          /* interval duration (s) (shift) (ro) */
 103         long    stabil;         /* PPS stability (scaled PPM) (ro) */
 104         long    jitcnt;         /* jitter limit exceeded (ro) */
 105         long    calcnt;         /* calibration intervals (ro) */
 106         long    errcnt;         /* calibration errors (ro) */
 107         long    stbcnt;         /* stability limit exceeded (ro) */
 108 };
 109 .Ed
 110 .Pp
 111 Upon successful completion,
 112 .Fn ntp_adjtime
 113 will fill the
 114 .Fa tp
 115 argument with the current clock state.
 116 .Sh RETURN VALUES
 117 .Rv -std ntp_adjtime
 118 .Pp
 119 Possible states of the clock are:
 120 .Pp
 121 .Bl -tag -compact -width ".Dv TIME_ERROR"
 122 .It Dv TIME_OK
 123 Everything okay, no leap second warning.
 124 .It Dv TIME_INS
 125 insert leap second warning.
 126 .It Dv TIME_DEL
 127 delete leap second warning.
 128 .It Dv TIME_OOP
 129 Leap second in progress.
 130 .It Dv TIME_WAIT
 131 Leap second has occurred.
 132 .It Dv TIME_ERROR
 133 Clock not synchronized.
 134 .El
 135 .Sh ERRORS
 136 The
 137 .Fn ntp_gettime
 138 system call may return
 139 .Er EPERM
 140 if the caller
 141 does not have sufficient permissions.
 142 .Sh SEE ALSO
 143 .Xr ntp_gettime 2 ,
 144 .Xr ntpd 8
 145 .Sh AUTHORS
 146 This manual page was written by
 147 .An Tom Rhodes Aq trhodes@FreeBSD.org .