external/bsd/ntp/dist/include/ntp.h

   1 /*      $NetBSD$        */
   2
   3 /*
   4  * ntp.h - NTP definitions for the masses
   5  */
   6 #ifndef NTP_H
   7 #define NTP_H
   8
   9 #include <math.h>
  10
  11 #include <ntp_fp.h>
  12 #include <ntp_types.h>
  13 #include <ntp_stdlib.h>
  14 #ifdef OPENSSL
  15 #include <ntp_crypto.h>
  16 #endif /* OPENSSL */
  17 #include <ntp_random.h>
  18 #include <ntp_net.h>
  19
  20 #include <isc/boolean.h>
  21
  22 /*
  23  * Calendar arithmetic - contributed by G. Healton
  24  */
  25 #define YEAR_BREAK 500          /* years < this are tm_year values:
  26                                  * Break < AnyFourDigitYear && Break >
  27                                  * Anytm_yearYear */
  28
  29 #define YEAR_PIVOT 98           /* 97/98: years < this are year 2000+
  30                                  * FYI: official UNIX pivot year is
  31                                  * 68/69 */
  32
  33 /*
  34  * Number of Days since 1 BC Gregorian to 1 January of given year
  35  */
  36 #define julian0(year)   (((year) * 365 ) + ((year) > 0 ? (((year) + 3) \
  37                             / 4 - ((year - 1) / 100) + ((year - 1) / \
  38                             400)) : 0))
  39
  40 /*
  41  * Number of days since start of NTP time to 1 January of given year
  42  */
  43 #define ntp0(year)      (julian0(year) - julian0(1900))
  44
  45 /*
  46  * Number of days since start of UNIX time to 1 January of given year
  47  */
  48 #define unix0(year)     (julian0(year) - julian0(1970))
  49
  50 /*
  51  * LEAP YEAR test for full 4-digit years (e.g, 1999, 2010)
  52  */
  53 #define isleap_4(y)     ((y) % 4 == 0 && !((y) % 100 == 0 && !(y % \
  54                             400 == 0)))
  55
  56 /*
  57  * LEAP YEAR test for tm_year (struct tm) years (e.g, 99, 110)
  58  */
  59 #define isleap_tm(y)    ((y) % 4 == 0 && !((y) % 100 == 0 && !(((y) \
  60                             + 1900) % 400 == 0)))
  61
  62 /*
  63  * to convert simple two-digit years to tm_year style years:
  64  *
  65  *      if (year < YEAR_PIVOT)
  66  *              year += 100;
  67  *
  68  * to convert either two-digit OR tm_year years to four-digit years:
  69  *
  70  *      if (year < YEAR_PIVOT)
  71  *              year += 100;
  72  *
  73  *      if (year < YEAR_BREAK)
  74  *              year += 1900;
  75  */
  76
  77 /*
  78  * How to get signed characters.  On machines where signed char works,
  79  * use it. On machines where signed char doesn't work, char had better
  80  * be signed.
  81  */
  82 #ifdef NEED_S_CHAR_TYPEDEF
  83 # if SIZEOF_SIGNED_CHAR
  84 typedef signed char s_char;
  85 # else
  86 typedef char s_char;
  87 # endif
  88   /* XXX: Why is this sequent bit INSIDE this test? */
  89 # ifdef sequent
  90 #  undef SO_RCVBUF
  91 #  undef SO_SNDBUF
  92 # endif
  93 #endif
  94 #ifndef TRUE
  95 # define TRUE 1
  96 #endif /* TRUE */
  97 #ifndef FALSE
  98 # define FALSE 0
  99 #endif /* FALSE */
 100
 101 /*
 102  * NTP protocol parameters.  See section 3.2.6 of the specification.
 103  */
 104 #define NTP_VERSION     ((u_char)4) /* current version number */
 105 #define NTP_OLDVERSION  ((u_char)1) /* oldest credible version */
 106 #define NTP_PORT        123     /* included for non-unix machines */
 107
 108 /*
 109  * Poll interval parameters
 110  */
 111 #define NTP_UNREACH     10      /* poll unreach threshold */
 112 #define NTP_MINPOLL     3       /* log2 min poll interval (8 s) */
 113 #define NTP_MINDPOLL    6       /* log2 default min poll (64 s) */
 114 #define NTP_MAXDPOLL    10      /* log2 default max poll (~17 m) */
 115 #define NTP_MAXPOLL     17      /* log2 max poll interval (~36 h) */
 116 #define NTP_RETRY       3       /* max packet retries */
 117 #define NTP_MINPKT      1       /* log2 min interburst interval (2 s) */
 118
 119 /*
 120  * Clock filter algorithm tuning parameters
 121  */
 122 #define MAXDISPERSE     16.     /* max dispersion */
 123 #define NTP_SHIFT       8       /* clock filter stages */
 124 #define NTP_FWEIGHT     .5      /* clock filter weight */
 125
 126 /*
 127  * Selection algorithm tuning parameters
 128  */
 129 #define NTP_MINCLOCK    3       /* min survivors */
 130 #define NTP_MAXCLOCK    10      /* max candidates */
 131 #define NTP_MAXASSOC    50      /* max associations */
 132 #define MINDISPERSE     .001    /* min distance */
 133 #define MAXDISTANCE     1.5     /* max root distance (select threshold) */
 134 #define CLOCK_SGATE     3.      /* popcorn spike gate */
 135 #define HUFFPUFF        900     /* huff-n'-puff sample interval (s) */
 136 #define MAXHOP          2       /* anti-clockhop threshold */
 137 #define MAX_TTL         8       /* max ttl mapping vector size */
 138 #define BEACON          7200    /* manycast beacon interval */
 139 #define NTP_MAXEXTEN    2048    /* max extension field size */
 140
 141 /*
 142  * Miscellaneous stuff
 143  */
 144 #define NTP_MAXKEY      65535   /* max authentication key number */
 145 #define KEY_TYPE_MD5    NID_md5 /* MD5 digest NID */
 146 /*
 147  * Limits of things
 148  */
 149 #define MAXFILENAME     128     /* max length of file name */
 150 #define MAXHOSTNAME     512     /* max length of host/node name */
 151 #define NTP_MAXSTRLEN   256     /* max string length */
 152
 153 /*
 154  * Operations for jitter calculations (these use doubles).
 155  *
 156  * Note that we carefully separate the jitter component from the
 157  * dispersion component (frequency error plus precision). The frequency
 158  * error component is computed as CLOCK_PHI times the difference between
 159  * the epoch of the time measurement and the reference time. The
 160  * precision component is computed as the square root of the mean of the
 161  * squares of a zero-mean, uniform distribution of unit maximum
 162  * amplitude. Whether this makes statistical sense may be arguable.
 163  */
 164 #define SQUARE(x) ((x) * (x))
 165 #define SQRT(x) (sqrt(x))
 166 #define DIFF(x, y) (SQUARE((x) - (y)))
 167 #define LOGTOD(a)       ((a) < 0 ? 1. / (1L << -(a)) : \
 168                             1L << (int)(a)) /* log2 to double */
 169 #define UNIVAR(x)       (SQUARE(.28867513 * LOGTOD(x))) /* std uniform distr */
 170 #define ULOGTOD(a)      (1L << (int)(a)) /* ulog2 to double */
 171
 172 #define EVENT_TIMEOUT   0       /* one second, that is */
 173
 174
 175 /*
 176  * The interface structure is used to hold the addresses and socket
 177  * numbers of each of the interfaces we are using.
 178  */
 179 struct interface {
 180         struct interface *link; /* interface list link */
 181         SOCKET fd;              /* socket this is opened on */
 182         SOCKET bfd;             /* socket for receiving broadcasts */
 183         sockaddr_u sin;         /* interface address */
 184         sockaddr_u bcast;       /* broadcast address */
 185         sockaddr_u mask;        /* interface mask */
 186         char name[32];          /* name of interface */
 187         u_short family;         /* Address family */
 188         u_short phase;          /* phase in update cycle */
 189         int flags;              /* interface flags */
 190         int last_ttl;           /* last TTL specified */
 191         u_int32 addr_refid;     /* IPv4 addr or IPv6 hash */
 192         int num_mcast;          /* No. of IP addresses in multicast socket */
 193         u_long starttime;       /* current_time as of creation of interface structure */
 194         volatile long received; /* number of incoming packets */
 195         long sent;              /* number of outgoing packets */
 196         long notsent;           /* number of send failures */
 197         u_int scopeid;          /* Scope used for Multicasting */
 198         u_int ifnum;            /* sequential interface instance count */
 199         isc_boolean_t ignore_packets; /* listen-read-drop this? */
 200         struct peer *peers;     /* list of peers for the interface */
 201         u_int peercnt;          /* peers referencing this interface */
 202 };
 203
 204 /*
 205  * Flags for interfaces
 206  */
 207 #define INT_UP          0x001   /* Interface is up */
 208 #define INT_PPP         0x002   /* Point-to-point interface */
 209 #define INT_LOOPBACK    0x004   /* the loopback interface */
 210 #define INT_BROADCAST   0x008   /* can broadcast out this interface */
 211 #define INT_MULTICAST   0x010   /* can multicast out this interface */
 212 #define INT_BCASTOPEN   0x020   /* broadcast socket is open */
 213 #define INT_MCASTOPEN   0x040   /* multicasting enabled */
 214 #define INT_WILDCARD    0x080   /* wildcard interface - usually skipped */
 215 #define INT_MCASTIF     0x100   /* bound directly to MCAST address */
 216
 217 /*
 218  * Define flasher bits (tests 1 through 11 in packet procedure)
 219  * These reveal the state at the last grumble from the peer and are
 220  * most handy for diagnosing problems, even if not strictly a state
 221  * variable in the spec. These are recorded in the peer structure.
 222  *
 223  * Packet errors
 224  */
 225 #define TEST1           0X0001  /* duplicate packet */
 226 #define TEST2           0x0002  /* bogus packet */
 227 #define TEST3           0x0004  /* protocol unsynchronized */
 228 #define TEST4           0x0008  /* access denied */
 229 #define TEST5           0x0010  /* bad authentication */
 230 #define TEST6           0x0020  /* bad synch or stratum */
 231 #define TEST7           0x0040  /* bad header */
 232 #define TEST8           0x0080  /* bad autokey */
 233 #define TEST9           0x0100  /* bad crypto */
 234 #define PKT_TEST_MASK   (TEST1 | TEST2 | TEST3 | TEST4 | TEST5 |\
 235                         TEST6 | TEST7 | TEST8 | TEST9)
 236 /*
 237  * Peer errors
 238  */
 239 #define TEST10          0x0200  /* peer bad synch or stratum */
 240 #define TEST11          0x0400  /* peer distance exceeded */
 241 #define TEST12          0x0800  /* peer synchronization loop */
 242 #define TEST13          0x1000  /* peer unreacable */
 243 #define PEER_TEST_MASK  (TEST10 | TEST11 | TEST12 | TEST13)
 244
 245 /*
 246  * The peer structure. Holds state information relating to the guys
 247  * we are peering with. Most of this stuff is from section 3.2 of the
 248  * spec.
 249  */
 250 struct peer {
 251         struct peer *next;      /* link pointer in peer hash */
 252         struct peer *ass_next;  /* link pointer in associd hash */
 253         struct peer *ilink;     /* list of peers for interface */
 254         sockaddr_u srcadr;      /* address of remote host */
 255         struct interface *dstadr; /* local address (interface) */
 256         associd_t associd;      /* association ID */
 257         u_char  version;        /* version number */
 258         u_char  hmode;          /* local association mode */
 259         u_char  hpoll;          /* local poll interval */
 260         u_char  minpoll;        /* min poll interval */
 261         u_char  maxpoll;        /* max poll interval */
 262         u_int   flags;          /* association flags */
 263         u_char  cast_flags;     /* additional flags */
 264         u_char  last_event;     /* last peer error code */
 265         u_char  num_events;     /* number of error events */
 266         u_char  ttl;            /* ttl/refclock mode */
 267
 268         /*
 269          * Variables used by reference clock support
 270          */
 271 #ifdef REFCLOCK
 272         struct refclockproc *procptr; /* refclock structure pointer */
 273         u_char  refclktype;     /* reference clock type */
 274         u_char  refclkunit;     /* reference clock unit number */
 275         u_char  sstclktype;     /* clock type for system status word */
 276 #endif /* REFCLOCK */
 277
 278         /*
 279          * Variables set by received packet
 280          */
 281         u_char  leap;           /* local leap indicator */
 282         u_char  pmode;          /* remote association mode */
 283         u_char  stratum;        /* remote stratum */
 284         u_char  ppoll;          /* remote poll interval */
 285         s_char  precision;      /* remote clock precision */
 286         double  rootdelay;      /* roundtrip delay to primary source */
 287         double  rootdisp;       /* dispersion to primary source */
 288         u_int32 refid;          /* remote reference ID */
 289         l_fp    reftime;        /* update epoch */
 290
 291         /*
 292          * Variables used by authenticated client
 293          */
 294         keyid_t keyid;          /* current key ID */
 295 #ifdef OPENSSL
 296 #define clear_to_zero opcode
 297         u_int32 opcode;         /* last request opcode */
 298         associd_t assoc;        /* peer association ID */
 299         u_int32 crypto;         /* peer status word */
 300         EVP_PKEY *pkey;         /* public key */
 301         const EVP_MD *digest;   /* message digest algorithm */
 302         char    *subject;       /* certificate subject name */
 303         char    *issuer;        /* certificate issuer name */
 304         struct cert_info *xinfo; /* issuer certificate */
 305         keyid_t pkeyid;         /* previous key ID */
 306         keyid_t hcookie;        /* host cookie */
 307         keyid_t pcookie;        /* peer cookie */
 308         const struct pkey_info *ident_pkey; /* identity key */
 309         BIGNUM  *iffval;        /* identity challenge (IFF, GQ, MV) */
 310         const BIGNUM *grpkey;   /* identity challenge key (GQ) */
 311         struct value cookval;   /* receive cookie values */
 312         struct value recval;    /* receive autokey values */
 313         struct exten *cmmd;     /* extension pointer */
 314         u_long  refresh;        /* next refresh epoch */
 315
 316         /*
 317          * Variables used by authenticated server
 318          */
 319         keyid_t *keylist;       /* session key ID list */
 320         int     keynumber;      /* current key number */
 321         struct value encrypt;   /* send encrypt values */
 322         struct value sndval;    /* send autokey values */
 323 #else /* OPENSSL */
 324 #define clear_to_zero status
 325 #endif /* OPENSSL */
 326
 327         /*
 328          * Ephemeral state variables
 329          */
 330         u_char  status;         /* peer status */
 331         u_char  reach;          /* reachability register */
 332         int     flash;          /* protocol error test tally bits */
 333         u_long  epoch;          /* reference epoch */
 334         int     burst;          /* packets remaining in burst */
 335         int     retry;          /* retry counter */
 336         int     flip;           /* interleave mode control */
 337         int     filter_nextpt;  /* index into filter shift register */
 338         double  filter_delay[NTP_SHIFT]; /* delay shift register */
 339         double  filter_offset[NTP_SHIFT]; /* offset shift register */
 340         double  filter_disp[NTP_SHIFT]; /* dispersion shift register */
 341         u_long  filter_epoch[NTP_SHIFT]; /* epoch shift register */
 342         u_char  filter_order[NTP_SHIFT]; /* filter sort index */
 343         l_fp    rec;            /* receive time stamp */
 344         l_fp    xmt;            /* transmit time stamp */
 345         l_fp    dst;            /* destination timestamp */
 346         l_fp    aorg;           /* origin timestamp */
 347         l_fp    borg;           /* alternate origin timestamp */
 348         double  offset;         /* peer clock offset */
 349         double  delay;          /* peer roundtrip delay */
 350         double  jitter;         /* peer jitter (squares) */
 351         double  disp;           /* peer dispersion */
 352         double  xleave;         /* interleave delay */
 353         double  bias;           /* bias for NIC asymmetry */
 354
 355         /*
 356          * Variables used to correct for packet length and asymmetry.
 357          */
 358         double  t21;            /* outbound packet delay */
 359         int     t21_bytes;      /* outbound packet length */
 360         int     t21_last;       /* last outbound packet length */
 361         double  r21;            /* outbound data rate */
 362         double  t34;            /* inbound packet delay */
 363         int     t34_bytes;      /* inbound packet length */
 364         double  r34;            /* inbound data rate */
 365
 366         /*
 367          * End of clear-to-zero area
 368          */
 369         u_long  update;         /* receive epoch */
 370 #define end_clear_to_zero update
 371         int     unreach;        /* watchdog counter */
 372         int     throttle;       /* rate control */
 373         u_long  outdate;        /* send time last packet */
 374         u_long  nextdate;       /* send time next packet */
 375         u_long  nextaction;     /* peer local activity timeout (refclocks) */
 376         void (*action) (struct peer *); /* action timeout function */
 377
 378         /*
 379          * Statistic counters
 380          */
 381         u_long  timereset;      /* time stat counters were reset */
 382         u_long  timereceived;   /* last packet received time */
 383         u_long  timereachable;  /* last reachable/unreachable time */
 384
 385         u_long  sent;           /* packets sent */
 386         u_long  received;       /* packets received */
 387         u_long  processed;      /* packets processed */
 388         u_long  badauth;        /* bad authentication (TEST5) */
 389         u_long  bogusorg;       /* bogus origin (TEST2, TEST3) */
 390         u_long  oldpkt;         /* old duplicate (TEST1) */
 391         u_long  seldisptoolarge; /* bad header (TEST6, TEST7) */
 392         u_long  selbroken;      /* KoD received */
 393 };
 394
 395 /*
 396  * Values for peer.leap, sys_leap
 397  */
 398 #define LEAP_NOWARNING  0x0     /* normal, no leap second warning */
 399 #define LEAP_ADDSECOND  0x1     /* last minute of day has 61 seconds */
 400 #define LEAP_DELSECOND  0x2     /* last minute of day has 59 seconds */
 401 #define LEAP_NOTINSYNC  0x3     /* overload, clock is free running */
 402
 403 /*
 404  * Values for peer mode and packet mode. Only the modes through
 405  * MODE_BROADCAST and MODE_BCLIENT appear in the transition
 406  * function. MODE_CONTROL and MODE_PRIVATE can appear in packets,
 407  * but those never survive to the transition function.
 408  * is a
 409  */
 410 #define MODE_UNSPEC     0       /* unspecified (old version) */
 411 #define MODE_ACTIVE     1       /* symmetric active mode */
 412 #define MODE_PASSIVE    2       /* symmetric passive mode */
 413 #define MODE_CLIENT     3       /* client mode */
 414 #define MODE_SERVER     4       /* server mode */
 415 #define MODE_BROADCAST  5       /* broadcast mode */
 416 /*
 417  * These can appear in packets
 418  */
 419 #define MODE_CONTROL    6       /* control mode */
 420 #define MODE_PRIVATE    7       /* private mode */
 421 /*
 422  * This is a madeup mode for broadcast client.
 423  */
 424 #define MODE_BCLIENT    6       /* broadcast client mode */
 425
 426 /*
 427  * Values for peer.stratum, sys_stratum
 428  */
 429 #define STRATUM_REFCLOCK ((u_char)0) /* default stratum */
 430 /* A stratum of 0 in the packet is mapped to 16 internally */
 431 #define STRATUM_PKT_UNSPEC ((u_char)0) /* unspecified in packet */
 432 #define STRATUM_UNSPEC  ((u_char)16) /* unspecified */
 433
 434 /*
 435  * Values for peer.flags
 436  */
 437 #define FLAG_CONFIG     0x0001  /* association was configured */
 438 #define FLAG_PREEMPT    0x0002  /* preemptable association */
 439 #define FLAG_AUTHENTIC  0x0004  /* last message was authentic */
 440 #define FLAG_REFCLOCK   0x0008  /* this is actually a reference clock */
 441 #define FLAG_SYSPEER    0x0010  /* system peer */
 442 #define FLAG_PREFER     0x0020  /* prefer peer */
 443 #define FLAG_BURST      0x0040  /* burst mode */
 444 #define FLAG_PPS        0x0080  /* steered by PPS */
 445 #define FLAG_IBURST     0x0100  /* initial burst mode */
 446 #define FLAG_NOSELECT   0x0200  /* never select */
 447 #define FLAG_TRUE       0x0400  /* force truechimer */
 448 #define FLAG_SKEY       0x0800  /* autokey authentication */
 449 #define FLAG_XLEAVE     0x1000  /* interleaved protocol */
 450 #define FLAG_XB         0x2000  /* interleaved broadcast */
 451 #define FLAG_XBOGUS     0x4000  /* interleaved bogus packet */
 452 #ifdef  OPENSSL
 453 #define FLAG_ASSOC      0x8000  /* autokey request */
 454 #endif /* OPENSSL */
 455
 456 /*
 457  * Definitions for the clear() routine.  We use memset() to clear
 458  * the parts of the peer structure which go to zero.  These are
 459  * used to calculate the start address and length of the area.
 460  */
 461 #define CLEAR_TO_ZERO(p)        ((char *)&((p)->clear_to_zero))
 462 #define END_CLEAR_TO_ZERO(p)    ((char *)&((p)->end_clear_to_zero))
 463 #define LEN_CLEAR_TO_ZERO       (END_CLEAR_TO_ZERO((struct peer *)0) \
 464                                     - CLEAR_TO_ZERO((struct peer *)0))
 465 #define CRYPTO_TO_ZERO(p)       ((char *)&((p)->clear_to_zero))
 466 #define END_CRYPTO_TO_ZERO(p)   ((char *)&((p)->end_clear_to_zero))
 467 #define LEN_CRYPTO_TO_ZERO      (END_CRYPTO_TO_ZERO((struct peer *)0) \
 468                                     - CRYPTO_TO_ZERO((struct peer *)0))
 469
 470 /*
 471  * Reference clock identifiers (for pps signal)
 472  */
 473 #define PPSREFID (u_int32)"PPS "        /* used when pps controls stratum>1 */
 474
 475 /*
 476  * Reference clock types.  Added as necessary.
 477  */
 478 #define REFCLK_NONE             0       /* unknown or missing */
 479 #define REFCLK_LOCALCLOCK       1       /* external (e.g., lockclock) */
 480 #define REFCLK_GPS_TRAK         2       /* TRAK 8810 GPS Receiver */
 481 #define REFCLK_WWV_PST          3       /* PST/Traconex 1020 WWV/H */
 482 #define REFCLK_SPECTRACOM       4       /* Spectracom (generic) Receivers */
 483 #define REFCLK_TRUETIME         5       /* TrueTime (generic) Receivers */
 484 #define REFCLK_IRIG_AUDIO       6       /* IRIG-B/W audio decoder */
 485 #define REFCLK_CHU_AUDIO        7       /* CHU audio demodulator/decoder */
 486 #define REFCLK_PARSE            8       /* generic driver (usually DCF77,GPS,MSF) */
 487 #define REFCLK_GPS_MX4200       9       /* Magnavox MX4200 GPS */
 488 #define REFCLK_GPS_AS2201       10      /* Austron 2201A GPS */
 489 #define REFCLK_GPS_ARBITER      11      /* Arbiter 1088A/B/ GPS */
 490 #define REFCLK_IRIG_TPRO        12      /* KSI/Odetics TPRO-S IRIG */
 491 #define REFCLK_ATOM_LEITCH      13      /* Leitch CSD 5300 Master Clock */
 492 #define REFCLK_MSF_EES          14      /* EES M201 MSF Receiver */
 493 #define REFCLK_GPSTM_TRUE       15      /* OLD TrueTime GPS/TM-TMD Receiver */
 494 #define REFCLK_IRIG_BANCOMM     16      /* Bancomm GPS/IRIG Interface */
 495 #define REFCLK_GPS_DATUM        17      /* Datum Programmable Time System */
 496 #define REFCLK_ACTS             18      /* Generic Auto Computer Time Service */
 497 #define REFCLK_WWV_HEATH        19      /* Heath GC1000 WWV/WWVH Receiver */
 498 #define REFCLK_GPS_NMEA         20      /* NMEA based GPS clock */
 499 #define REFCLK_GPS_VME          21      /* TrueTime GPS-VME Interface */
 500 #define REFCLK_ATOM_PPS         22      /* 1-PPS Clock Discipline */
 501 #define REFCLK_PTB_ACTS         23      /* replaced by REFCLK_ACTS */
 502 #define REFCLK_USNO             24      /* replaced by REFCLK_ACTS */
 503 #define REFCLK_GPS_HP           26      /* HP 58503A Time/Frequency Receiver */
 504 #define REFCLK_ARCRON_MSF       27      /* ARCRON MSF radio clock. */
 505 #define REFCLK_SHM              28      /* clock attached thru shared memory */
 506 #define REFCLK_PALISADE         29      /* Trimble Navigation Palisade GPS */
 507 #define REFCLK_ONCORE           30      /* Motorola UT Oncore GPS */
 508 #define REFCLK_GPS_JUPITER      31      /* Rockwell Jupiter GPS receiver */
 509 #define REFCLK_CHRONOLOG        32      /* Chrono-log K WWVB receiver */
 510 #define REFCLK_DUMBCLOCK        33      /* Dumb localtime clock */
 511 #define REFCLK_ULINK            34      /* Ultralink M320 WWVB receiver */
 512 #define REFCLK_PCF              35      /* Conrad parallel port radio clock */
 513 #define REFCLK_WWV_AUDIO        36      /* WWV/H audio demodulator/decoder */
 514 #define REFCLK_FG               37      /* Forum Graphic GPS */
 515 #define REFCLK_HOPF_SERIAL      38      /* hopf DCF77/GPS serial receiver  */
 516 #define REFCLK_HOPF_PCI         39      /* hopf DCF77/GPS PCI receiver  */
 517 #define REFCLK_JJY              40      /* JJY receiver  */
 518 #define REFCLK_TT560            41      /* TrueTime 560 IRIG-B decoder */
 519 #define REFCLK_ZYFER            42      /* Zyfer GPStarplus receiver  */
 520 #define REFCLK_RIPENCC          43      /* RIPE NCC Trimble driver */
 521 #define REFCLK_NEOCLOCK4X       44      /* NeoClock4X DCF77 or TDF receiver */
 522 #define REFCLK_MAX              44      /* NeoClock4X DCF77 or TDF receiver */
 523
 524
 525 /*
 526  * NTP packet format.  The mac field is optional.  It isn't really
 527  * an l_fp either, but for now declaring it that way is convenient.
 528  * See Appendix A in the specification.
 529  *
 530  * Note that all u_fp and l_fp values arrive in network byte order
 531  * and must be converted (except the mac, which isn't, really).
 532  */
 533 struct pkt {
 534         u_char  li_vn_mode;     /* peer leap indicator */
 535         u_char  stratum;        /* peer stratum */
 536         u_char  ppoll;          /* peer poll interval */
 537         s_char  precision;      /* peer clock precision */
 538         u_fp    rootdelay;      /* roundtrip delay to primary source */
 539         u_fp    rootdisp;       /* dispersion to primary source*/
 540         u_int32 refid;          /* reference id */
 541         l_fp    reftime;        /* last update time */
 542         l_fp    org;            /* originate time stamp */
 543         l_fp    rec;            /* receive time stamp */
 544         l_fp    xmt;            /* transmit time stamp */
 545
 546 #define LEN_PKT_NOMAC   (12 * sizeof(u_int32)) /* min header length */
 547 #define MIN_MAC_LEN     (1 * sizeof(u_int32))   /* crypto_NAK */
 548 #define MAX_MD5_LEN     (5 * sizeof(u_int32))   /* MD5 */
 549 #define MAX_MAC_LEN     (6 * sizeof(u_int32))   /* SHA */
 550
 551         /*
 552          * The length of the packet less MAC must be a multiple of 64
 553          * with an RSA modulus and Diffie-Hellman prime of 256 octets
 554          * and maximum host name of 128 octets, the maximum autokey
 555          * command is 152 octets and maximum autokey response is 460
 556          * octets. A packet can contain no more than one command and one
 557          * response, so the maximum total extension field length is 864
 558          * octets. But, to handle humungus certificates, the bank must
 559          * be broke.
 560          */
 561 #ifdef OPENSSL
 562         u_int32 exten[NTP_MAXEXTEN / 4]; /* max extension field */
 563 #else /* OPENSSL */
 564         u_int32 exten[1];       /* misused */
 565 #endif /* OPENSSL */
 566         u_char  mac[MAX_MAC_LEN]; /* mac */
 567 };
 568
 569 /*
 570  * Stuff for extracting things from li_vn_mode
 571  */
 572 #define PKT_MODE(li_vn_mode)    ((u_char)((li_vn_mode) & 0x7))
 573 #define PKT_VERSION(li_vn_mode) ((u_char)(((li_vn_mode) >> 3) & 0x7))
 574 #define PKT_LEAP(li_vn_mode)    ((u_char)(((li_vn_mode) >> 6) & 0x3))
 575
 576 /*
 577  * Stuff for putting things back into li_vn_mode
 578  */
 579 #define PKT_LI_VN_MODE(li, vn, md) \
 580         ((u_char)((((li) << 6) & 0xc0) | (((vn) << 3) & 0x38) | ((md) & 0x7)))
 581
 582
 583 /*
 584  * Dealing with stratum.  0 gets mapped to 16 incoming, and back to 0
 585  * on output.
 586  */
 587 #define PKT_TO_STRATUM(s)       ((u_char)(((s) == (STRATUM_PKT_UNSPEC)) ?\
 588                                 (STRATUM_UNSPEC) : (s)))
 589
 590 #define STRATUM_TO_PKT(s)       ((u_char)(((s) == (STRATUM_UNSPEC)) ?\
 591                                 (STRATUM_PKT_UNSPEC) : (s)))
 592
 593 /*
 594  * Event codes. Used for reporting errors/events to the control module
 595  */
 596 #define PEER_EVENT      0x080   /* this is a peer event */
 597 #define CRPT_EVENT      0x100   /* this is a crypto event */
 598
 599 /*
 600  * System event codes
 601  */
 602 #define EVNT_UNSPEC     0       /* unspecified */
 603 #define EVNT_NSET       1       /* freq not set */
 604 #define EVNT_FSET       2       /* freq set */
 605 #define EVNT_SPIK       3       /* spike detect */
 606 #define EVNT_FREQ       4       /* freq mode */
 607 #define EVNT_SYNC       5       /* clock sync */
 608 #define EVNT_SYSRESTART 6       /* restart */
 609 #define EVNT_SYSFAULT   7       /* panic stop */
 610 #define EVNT_NOPEER     8       /* no sys peer */
 611 #define EVNT_ARMED      9       /* leap armed */
 612 #define EVNT_DISARMED   10      /* leap disarmed */
 613 #define EVNT_LEAP       11      /* leap event */
 614 #define EVNT_CLOCKRESET 12      /* clock step */
 615 #define EVNT_KERN       13      /* kernel event */
 616 #define EVNT_TAI        14      /* TAI */
 617 #define EVNT_LEAPVAL    15      /* stale leapsecond values */
 618 #define EVNT_CLKHOP     16      /* clockhop */
 619
 620 /*
 621  * Peer event codes
 622  */
 623 #define PEVNT_MOBIL     (1 | PEER_EVENT) /* mobilize */
 624 #define PEVNT_DEMOBIL   (2 | PEER_EVENT) /* demobilize */
 625 #define PEVNT_UNREACH   (3 | PEER_EVENT) /* unreachable */
 626 #define PEVNT_REACH     (4 | PEER_EVENT) /* reachable */
 627 #define PEVNT_RESTART   (5 | PEER_EVENT) /* restart */
 628 #define PEVNT_REPLY     (6 | PEER_EVENT) /* no reply */
 629 #define PEVNT_RATE      (7 | PEER_EVENT) /* rate exceeded */
 630 #define PEVNT_DENY      (8 | PEER_EVENT) /* access denied */
 631 #define PEVNT_ARMED     (9 | PEER_EVENT) /* leap armed */
 632 #define PEVNT_NEWPEER   (10 | PEER_EVENT) /* sys peer */
 633 #define PEVNT_CLOCK     (11 | PEER_EVENT) /* clock event */
 634 #define PEVNT_AUTH      (12 | PEER_EVENT) /* bad auth */
 635 #define PEVNT_POPCORN   (13 | PEER_EVENT) /* popcorn */
 636 #define PEVNT_XLEAVE    (14 | PEER_EVENT) /* interleave mode */
 637 #define PEVNT_XERR      (15 | PEER_EVENT) /* interleave error */
 638 #define PEVNT_TAI       (16 | PEER_EVENT) /* TAI */
 639
 640 /*
 641  * Clock event codes
 642  */
 643 #define CEVNT_NOMINAL   0       /* unspecified */
 644 #define CEVNT_TIMEOUT   1       /* no reply */
 645 #define CEVNT_BADREPLY  2       /* bad format */
 646 #define CEVNT_FAULT     3       /* fault */
 647 #define CEVNT_PROP      4       /* bad signal */
 648 #define CEVNT_BADDATE   5       /* bad date */
 649 #define CEVNT_BADTIME   6       /* bad time */
 650 #define CEVNT_MAX       CEVNT_BADTIME
 651
 652 /*
 653  * Very misplaced value.  Default port through which we send traps.
 654  */
 655 #define TRAPPORT        18447
 656
 657
 658 /*
 659  * To speed lookups, peers are hashed by the low order bits of the
 660  * remote IP address. These definitions relate to that.
 661  */
 662 #define NTP_HASH_SIZE   128
 663 #define NTP_HASH_MASK   (NTP_HASH_SIZE-1)
 664 #define NTP_HASH_ADDR(src)      sock_hash(src)
 665
 666 /*
 667  * min, min3 and max.  Makes it easier to transliterate the spec without
 668  * thinking about it.
 669  */
 670 #define min(a,b)        (((a) < (b)) ? (a) : (b))
 671 #define max(a,b)        (((a) > (b)) ? (a) : (b))
 672 #define min3(a,b,c)     min(min((a),(b)), (c))
 673
 674
 675 /*
 676  * Configuration items.  These are for the protocol module (proto_config())
 677  */
 678 #define PROTO_BROADCLIENT       1
 679 #define PROTO_PRECISION         2       /* (not used) */
 680 #define PROTO_AUTHENTICATE      3
 681 #define PROTO_BROADDELAY        4
 682 #define PROTO_AUTHDELAY         5       /* (not used) */
 683 #define PROTO_MULTICAST_ADD     6
 684 #define PROTO_MULTICAST_DEL     7
 685 #define PROTO_NTP               8
 686 #define PROTO_KERNEL            9
 687 #define PROTO_MONITOR           10
 688 #define PROTO_FILEGEN           11
 689 #define PROTO_PPS               12
 690 #define PROTO_CAL               13
 691 #define PROTO_MINCLOCK          14
 692 #define PROTO_MAXCLOCK          15
 693 #define PROTO_MINSANE           16
 694 #define PROTO_FLOOR             17
 695 #define PROTO_CEILING           18
 696 #define PROTO_COHORT            19
 697 #define PROTO_CALLDELAY         20
 698 #define PROTO_MINDISP           21
 699 #define PROTO_MAXDIST           22
 700 #define PROTO_ADJ               23
 701 #define PROTO_MAXHOP            24
 702 #define PROTO_BEACON            25
 703 #define PROTO_ORPHAN            26
 704
 705 /*
 706  * Configuration items for the loop filter
 707  */
 708 #define LOOP_DRIFTINIT          1       /* set initial frequency offset */
 709 #define LOOP_DRIFTCOMP          2       /* set frequency offset */
 710 #define LOOP_MAX                3       /* set step offset */
 711 #define LOOP_PANIC              4       /* set panic offseet */
 712 #define LOOP_PHI                5       /* set dispersion rate */
 713 #define LOOP_MINSTEP            6       /* set step timeout */
 714 #define LOOP_MINPOLL            7       /* set min poll interval (log2 s) */
 715 #define LOOP_ALLAN              8       /* set minimum Allan intercept */
 716 #define LOOP_HUFFPUFF           9       /* set huff-n'-puff filter length */
 717 #define LOOP_FREQ               10      /* set initial frequency */
 718 #define LOOP_KERN_CLEAR         11      /* reset kernel pll parameters */
 719 #define LOOP_CODEC              12      /* set audio codec frequency */
 720 #define LOOP_LEAP               13      /* insert leap after second 23:59 */
 721
 722 /*
 723  * Configuration items for the stats printer
 724  */
 725 #define STATS_FREQ_FILE         1       /* configure drift file */
 726 #define STATS_STATSDIR          2       /* directory prefix for stats files */
 727 #define STATS_PID_FILE          3       /* configure ntpd PID file */
 728 #define STATS_LEAP_FILE         4       /* configure ntpd leapseconds file */
 729
 730 #define MJD_1900                15020   /* MJD for 1 Jan 1900 */
 731
 732 /*
 733  * Default parameters.  We use these in the absence of something better.
 734  */
 735 #define INADDR_NTP      0xe0000101      /* NTP multicast address 224.0.1.1 */
 736
 737 /*
 738  * Structure used optionally for monitoring when this is turned on.
 739  */
 740 struct mon_data {
 741         struct mon_data *hash_next;     /* next structure in hash list */
 742         struct mon_data *mru_next;      /* next structure in MRU list */
 743         struct mon_data *mru_prev;      /* previous structure in MRU list */
 744         int     flags;                  /* restrict flags */
 745         int     leak;                   /* leaky bucket accumulator */
 746         int     count;                  /* total packet count */
 747         u_long  firsttime;              /* first time found */
 748         u_long  lasttime;               /* last time found */
 749         sockaddr_u rmtadr;              /* address of remote host */
 750         struct interface *interface;    /* interface on which this arrived */
 751         u_short rmtport;                /* remote port last came from */
 752         u_char  mode;                   /* packet mode */
 753         u_char  version;                /* packet version */
 754         u_char  cast_flags;             /* flags MDF_?CAST */
 755 };
 756
 757 /*
 758  * Values for cast_flags
 759  */
 760 #define MDF_UCAST       0x01            /* unicast */
 761 #define MDF_MCAST       0x02            /* multicast */
 762 #define MDF_BCAST       0x04            /* broadcast */
 763 #define MDF_LCAST       0x08            /* localcast */
 764 #define MDF_ACAST       0x10            /* manycast */
 765 #define MDF_BCLNT       0x20            /* broadcast client */
 766 #define MDF_ACLNT       0x40            /* manycast client */
 767
 768 /*
 769  * Values used with mon_enabled to indicate reason for enabling monitoring
 770  */
 771 #define MON_OFF    0x00                 /* no monitoring */
 772 #define MON_ON     0x01                 /* monitoring explicitly enabled */
 773 #define MON_RES    0x02                 /* implicit monitoring for RES_LIMITED */
 774 /*
 775  * Structure used for restrictlist entries
 776  */
 777 struct restrictlist {
 778         struct restrictlist *next;      /* link to next entry */
 779         u_int32 addr;                   /* Ipv4 host address (host byte order) */
 780         u_int32 mask;                   /* Ipv4 mask for address (host byte order) */
 781         u_long count;                   /* number of packets matched */
 782         u_short flags;                  /* accesslist flags */
 783         u_short mflags;                 /* match flags */
 784 };
 785
 786 struct restrictlist6 {
 787         struct restrictlist6 *next;     /* link to next entry */
 788         struct in6_addr addr6;          /* Ipv6 host address */
 789         struct in6_addr mask6;          /* Ipv6 mask address */
 790         u_long count;                   /* number of packets matched */
 791         u_short flags;                  /* accesslist flags */
 792         u_short mflags;                 /* match flags */
 793 };
 794
 795
 796 /*
 797  * Access flags
 798  */
 799 #define RES_IGNORE              0x0001  /* ignore packet */
 800 #define RES_DONTSERVE           0x0002  /* access denied */
 801 #define RES_DONTTRUST           0x0004  /* authentication required */
 802 #define RES_VERSION             0x0008  /* version mismatch */
 803 #define RES_NOPEER              0x0010  /* new association denied */
 804 #define RES_LIMITED             0x0020  /* packet rate exceeded */
 805 #define RES_FLAGS               (RES_IGNORE | RES_DONTSERVE |\
 806                                     RES_DONTTRUST | RES_VERSION |\
 807                                     RES_NOPEER | RES_LIMITED)
 808
 809 #define RES_NOQUERY             0x0040  /* mode 6/7 packet denied */
 810 #define RES_NOMODIFY            0x0080  /* mode 6/7 modify denied */
 811 #define RES_NOTRAP              0x0100  /* mode 6/7 set trap denied */
 812 #define RES_LPTRAP              0x0200  /* mode 6/7 low priority trap */
 813
 814 #define RES_KOD                 0x0400  /* send kiss of death packet */
 815 #define RES_MSSNTP              0x0800  /* enable MS-SNTP authentication */
 816 #define RES_TIMEOUT             0x1000  /* timeout this entry */
 817
 818 #define RES_ALLFLAGS            (RES_FLAGS | RES_NOQUERY |\
 819                                     RES_NOMODIFY | RES_NOTRAP |\
 820                                     RES_LPTRAP | RES_KOD |\
 821                                     RES_MSSNTP | RES_TIMEOUT)
 822
 823 /*
 824  * Match flags
 825  */
 826 #define RESM_INTERFACE          0x1000  /* this is an interface */
 827 #define RESM_NTPONLY            0x2000  /* match ntp port only */
 828
 829 /*
 830  * Restriction configuration ops
 831  */
 832 #define RESTRICT_FLAGS          1       /* add flags to restrict entry */
 833 #define RESTRICT_UNFLAG         2       /* remove flags from restrict entry */
 834 #define RESTRICT_REMOVE         3       /* remove a restrict entry */
 835 #define RESTRICT_REMOVEIF       4       /* remove an interface restrict entry */
 836
 837 /*
 838  * Endpoint structure for the select algorithm
 839  */
 840 struct endpoint {
 841         double  val;                    /* offset of endpoint */
 842         int     type;                   /* interval entry/exit */
 843 };
 844
 845 /*
 846  * Association matching AM[] return codes
 847  */
 848 #define AM_ERR          -1              /* error */
 849 #define AM_NOMATCH      0               /* no match */
 850 #define AM_PROCPKT      1               /* server/symmetric packet */
 851 #define AM_BCST         2               /* broadcast packet */
 852 #define AM_FXMIT        3               /* client packet */
 853 #define AM_MANYCAST     4               /* manycast packet */
 854 #define AM_NEWPASS      5               /* new passive */
 855 #define AM_NEWBCL       6               /* new broadcast */
 856 #define AM_POSSBCL      7               /* discard broadcast */
 857
 858 /* NetInfo configuration locations */
 859 #ifdef HAVE_NETINFO
 860 #define NETINFO_CONFIG_DIR "/config/ntp"
 861 #endif
 862
 863 #endif /* NTP_H */