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

   1 /*      $NetBSD$        */
   2
   3 /*
   4  * ntp_request.h - definitions for the ntpd remote query facility
   5  */
   6
   7 #ifndef NTP_REQUEST_H
   8 #define NTP_REQUEST_H
   9
  10 #include "stddef.h"
  11 #include "ntp_types.h"
  12 #include "recvbuff.h"
  13
  14 /*
  15  * A mode 7 packet is used exchanging data between an NTP server
  16  * and a client for purposes other than time synchronization, e.g.
  17  * monitoring, statistics gathering and configuration.  A mode 7
  18  * packet has the following format:
  19  *
  20  *    0                   1                   2                   3
  21  *    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  22  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  23  *   |R|M| VN  | Mode|A|  Sequence   | Implementation|   Req Code    |
  24  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  25  *   |  Err  | Number of data items  |  MBZ  |   Size of data item   |
  26  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  27  *   |                                                               |
  28  *   |            Data (Minimum 0 octets, maximum 500 octets)        |
  29  *   |                                                               |
  30  *                            [...]
  31  *   |                                                               |
  32  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  33  *   |               Encryption Keyid (when A bit set)               |
  34  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  35  *   |                                                               |
  36  *   |          Message Authentication Code (when A bit set)         |
  37  *   |                                                               |
  38  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  39  *
  40  * where the fields are (note that the client sends requests, the server
  41  * responses):
  42  *
  43  * Response Bit:  This packet is a response (if clear, packet is a request).
  44  *
  45  * More Bit:    Set for all packets but the last in a response which
  46  *              requires more than one packet.
  47  *
  48  * Version Number: 2 for current version
  49  *
  50  * Mode:        Always 7
  51  *
  52  * Authenticated bit: If set, this packet is authenticated.
  53  *
  54  * Sequence number: For a multipacket response, contains the sequence
  55  *              number of this packet.  0 is the first in the sequence,
  56  *              127 (or less) is the last.  The More Bit must be set in
  57  *              all packets but the last.
  58  *
  59  * Implementation number: The number of the implementation this request code
  60  *              is defined by.  An implementation number of zero is used
  61  *              for requst codes/data formats which all implementations
  62  *              agree on.  Implementation number 255 is reserved (for
  63  *              extensions, in case we run out).
  64  *
  65  * Request code: An implementation-specific code which specifies the
  66  *              operation to be (which has been) performed and/or the
  67  *              format and semantics of the data included in the packet.
  68  *
  69  * Err:         Must be 0 for a request.  For a response, holds an error
  70  *              code relating to the request.  If nonzero, the operation
  71  *              requested wasn't performed.
  72  *
  73  *              0 - no error
  74  *              1 - incompatable implementation number
  75  *              2 - unimplemented request code
  76  *              3 - format error (wrong data items, data size, packet size etc.)
  77  *              4 - no data available (e.g. request for details on unknown peer)
  78  *              5-6 I don't know
  79  *              7 - authentication failure (i.e. permission denied)
  80  *
  81  * Number of data items: number of data items in packet.  0 to 500
  82  *
  83  * MBZ:         A reserved data field, must be zero in requests and responses.
  84  *
  85  * Size of data item: size of each data item in packet.  0 to 500
  86  *
  87  * Data:        Variable sized area containing request/response data.  For
  88  *              requests and responses the size in octets must be greater
  89  *              than or equal to the product of the number of data items
  90  *              and the size of a data item.  For requests the data area
  91  *              must be exactly 40 octets in length.  For responses the
  92  *              data area may be any length between 0 and 500 octets
  93  *              inclusive.
  94  *
  95  * Message Authentication Code: Same as NTP spec, in definition and function.
  96  *              May optionally be included in requests which require
  97  *              authentication, is never included in responses.
  98  *
  99  * The version number, mode and keyid have the same function and are
 100  * in the same location as a standard NTP packet.  The request packet
 101  * is the same size as a standard NTP packet to ease receive buffer
 102  * management, and to allow the same encryption procedure to be used
 103  * both on mode 7 and standard NTP packets.  The mac is included when
 104  * it is required that a request be authenticated, the keyid should be
 105  * zero in requests in which the mac is not included.
 106  *
 107  * The data format depends on the implementation number/request code pair
 108  * and whether the packet is a request or a response.  The only requirement
 109  * is that data items start in the octet immediately following the size
 110  * word and that data items be concatenated without padding between (i.e.
 111  * if the data area is larger than data_items*size, all padding is at
 112  * the end).  Padding is ignored, other than for encryption purposes.
 113  * Implementations using encryption might want to include a time stamp
 114  * or other data in the request packet padding.  The key used for requests
 115  * is implementation defined, but key 15 is suggested as a default.
 116  */
 117
 118 /*
 119  * union of raw addresses to save space
 120  */
 121 union addrun
 122 {
 123         struct in6_addr addr6;
 124         struct in_addr  addr;
 125 };
 126
 127 /*
 128  * A request packet.  These are almost a fixed length.
 129  */
 130 struct req_pkt {
 131         u_char rm_vn_mode;              /* response, more, version, mode */
 132         u_char auth_seq;                /* key, sequence number */
 133         u_char implementation;          /* implementation number */
 134         u_char request;                 /* request number */
 135         u_short err_nitems;             /* error code/number of data items */
 136         u_short mbz_itemsize;           /* item size */
 137         char data[MAXFILENAME + 48];    /* data area [32 prev](176 byte max) */
 138                                         /* struct conf_peer must fit */
 139         l_fp tstamp;                    /* time stamp, for authentication */
 140         keyid_t keyid;                  /* (optional) encryption key */
 141         char mac[MAX_MAC_LEN-sizeof(keyid_t)]; /* (optional) auth code */
 142 };
 143
 144 /*
 145  * The req_pkt_tail structure is used by ntpd to adjust for different
 146  * packet sizes that may arrive.
 147  */
 148 struct req_pkt_tail {
 149         l_fp tstamp;                    /* time stamp, for authentication */
 150         keyid_t keyid;                  /* (optional) encryption key */
 151         char mac[MAX_MAC_LEN-sizeof(keyid_t)]; /* (optional) auth code */
 152 };
 153
 154 /* MODE_PRIVATE request packet header length before optional items. */
 155 #define REQ_LEN_HDR     (offsetof(struct req_pkt, data))
 156 /* MODE_PRIVATE request packet fixed length without MAC. */
 157 #define REQ_LEN_NOMAC   (offsetof(struct req_pkt, keyid))
 158 /* MODE_PRIVATE req_pkt_tail minimum size (16 octet digest) */
 159 #define REQ_TAIL_MIN    \
 160         (sizeof(struct req_pkt_tail) - (MAX_MAC_LEN - MAX_MD5_LEN))
 161
 162 /*
 163  * A MODE_PRIVATE response packet.  The length here is variable, this
 164  * is a maximally sized one.  Note that this implementation doesn't
 165  * authenticate responses.
 166  */
 167 #define RESP_HEADER_SIZE        (offsetof(struct resp_pkt, data))
 168 #define RESP_DATA_SIZE          (500)
 169
 170 struct resp_pkt {
 171         u_char rm_vn_mode;              /* response, more, version, mode */
 172         u_char auth_seq;                /* key, sequence number */
 173         u_char implementation;          /* implementation number */
 174         u_char request;                 /* request number */
 175         u_short err_nitems;             /* error code/number of data items */
 176         u_short mbz_itemsize;           /* item size */
 177         char data[RESP_DATA_SIZE];      /* data area */
 178 };
 179
 180
 181 /*
 182  * Information error codes
 183  */
 184 #define INFO_OKAY       0
 185 #define INFO_ERR_IMPL   1       /* incompatable implementation */
 186 #define INFO_ERR_REQ    2       /* unknown request code */
 187 #define INFO_ERR_FMT    3       /* format error */
 188 #define INFO_ERR_NODATA 4       /* no data for this request */
 189 #define INFO_ERR_AUTH   7       /* authentication failure */
 190
 191 /*
 192  * Maximum sequence number.
 193  */
 194 #define MAXSEQ  127
 195
 196
 197 /*
 198  * Bit setting macros for multifield items.
 199  */
 200 #define RESP_BIT        0x80
 201 #define MORE_BIT        0x40
 202
 203 #define ISRESPONSE(rm_vn_mode)  (((rm_vn_mode)&RESP_BIT)!=0)
 204 #define ISMORE(rm_vn_mode)      (((rm_vn_mode)&MORE_BIT)!=0)
 205 #define INFO_VERSION(rm_vn_mode) ((u_char)(((rm_vn_mode)>>3)&0x7))
 206 #define INFO_MODE(rm_vn_mode)   ((rm_vn_mode)&0x7)
 207
 208 #define RM_VN_MODE(resp, more, version)         \
 209                                 ((u_char)(((resp)?RESP_BIT:0)\
 210                                 |((more)?MORE_BIT:0)\
 211                                 |((version?version:(NTP_OLDVERSION+1))<<3)\
 212                                 |(MODE_PRIVATE)))
 213
 214 #define INFO_IS_AUTH(auth_seq)  (((auth_seq) & 0x80) != 0)
 215 #define INFO_SEQ(auth_seq)      ((auth_seq)&0x7f)
 216 #define AUTH_SEQ(auth, seq)     ((u_char)((((auth)!=0)?0x80:0)|((seq)&0x7f)))
 217
 218 #define INFO_ERR(err_nitems)    ((u_short)((ntohs(err_nitems)>>12)&0xf))
 219 #define INFO_NITEMS(err_nitems) ((u_short)(ntohs(err_nitems)&0xfff))
 220 #define ERR_NITEMS(err, nitems) (htons((u_short)((((u_short)(err)<<12)&0xf000)\
 221                                 |((u_short)(nitems)&0xfff))))
 222
 223 #define INFO_MBZ(mbz_itemsize)  ((ntohs(mbz_itemsize)>>12)&0xf)
 224 #define INFO_ITEMSIZE(mbz_itemsize)     ((u_short)(ntohs(mbz_itemsize)&0xfff))
 225 #define MBZ_ITEMSIZE(itemsize)  (htons((u_short)(itemsize)))
 226
 227
 228 /*
 229  * Implementation numbers.  One for universal use and one for ntpd.
 230  */
 231 #define IMPL_UNIV       0
 232 #define IMPL_XNTPD_OLD  2       /* Used by pre ipv6 ntpdc */
 233 #define IMPL_XNTPD      3       /* Used by post ipv6 ntpdc */
 234
 235 /*
 236  * Some limits related to authentication.  Frames which are
 237  * authenticated must include a time stamp which differs from
 238  * the receive time stamp by no more than 10 seconds.
 239  */
 240 #define INFO_TS_MAXSKEW 10.
 241
 242 /*
 243  * Universal request codes go here.  There aren't any.
 244  */
 245
 246 /*
 247  * NTPD request codes go here.
 248  */
 249 #define REQ_PEER_LIST           0       /* return list of peers */
 250 #define REQ_PEER_LIST_SUM       1       /* return summary info for all peers */
 251 #define REQ_PEER_INFO           2       /* get standard information on peer */
 252 #define REQ_PEER_STATS          3       /* get statistics for peer */
 253 #define REQ_SYS_INFO            4       /* get system information */
 254 #define REQ_SYS_STATS           5       /* get system stats */
 255 #define REQ_IO_STATS            6       /* get I/O stats */
 256 #define REQ_MEM_STATS           7       /* stats related to peer list maint */
 257 #define REQ_LOOP_INFO           8       /* info from the loop filter */
 258 #define REQ_TIMER_STATS         9       /* get timer stats */
 259 #define REQ_CONFIG              10      /* configure a new peer */
 260 #define REQ_UNCONFIG            11      /* unconfigure an existing peer */
 261 #define REQ_SET_SYS_FLAG        12      /* set system flags */
 262 #define REQ_CLR_SYS_FLAG        13      /* clear system flags */
 263 #define REQ_MONITOR             14      /* (not used) */
 264 #define REQ_NOMONITOR           15      /* (not used) */
 265 #define REQ_GET_RESTRICT        16      /* return restrict list */
 266 #define REQ_RESADDFLAGS         17      /* add flags to restrict list */
 267 #define REQ_RESSUBFLAGS         18      /* remove flags from restrict list */
 268 #define REQ_UNRESTRICT          19      /* remove entry from restrict list */
 269 #define REQ_MON_GETLIST         20      /* return data collected by monitor */
 270 #define REQ_RESET_STATS         21      /* reset stat counters */
 271 #define REQ_RESET_PEER          22      /* reset peer stat counters */
 272 #define REQ_REREAD_KEYS         23      /* reread the encryption key file */
 273 #define REQ_DO_DIRTY_HACK       24      /* (not used) */
 274 #define REQ_DONT_DIRTY_HACK     25      /* (not used) */
 275 #define REQ_TRUSTKEY            26      /* add a trusted key */
 276 #define REQ_UNTRUSTKEY          27      /* remove a trusted key */
 277 #define REQ_AUTHINFO            28      /* return authentication info */
 278 #define REQ_TRAPS               29      /* return currently set traps */
 279 #define REQ_ADD_TRAP            30      /* add a trap */
 280 #define REQ_CLR_TRAP            31      /* clear a trap */
 281 #define REQ_REQUEST_KEY         32      /* define a new request keyid */
 282 #define REQ_CONTROL_KEY         33      /* define a new control keyid */
 283 #define REQ_GET_CTLSTATS        34      /* get stats from the control module */
 284 #define REQ_GET_LEAPINFO        35      /* (not used) */
 285 #define REQ_GET_CLOCKINFO       36      /* get clock information */
 286 #define REQ_SET_CLKFUDGE        37      /* set clock fudge factors */
 287 #define REQ_GET_KERNEL          38      /* get kernel pll/pps information */
 288 #define REQ_GET_CLKBUGINFO      39      /* get clock debugging info */
 289 #define REQ_SET_PRECISION       41      /* (not used) */
 290 #define REQ_MON_GETLIST_1       42      /* return collected v1 monitor data */
 291 #define REQ_HOSTNAME_ASSOCID    43      /* Here is a hostname + assoc_id */
 292 #define REQ_IF_STATS            44      /* get interface statistics */
 293 #define REQ_IF_RELOAD           45      /* reload interface list */
 294
 295 /* Determine size of pre-v6 version of structures */
 296 #define v4sizeof(type)          offsetof(type, v6_flag)
 297
 298 /*
 299  * Flags in the peer information returns
 300  */
 301 #define INFO_FLAG_CONFIG        0x1
 302 #define INFO_FLAG_SYSPEER       0x2
 303 #define INFO_FLAG_BURST         0x4
 304 #define INFO_FLAG_REFCLOCK      0x8
 305 #define INFO_FLAG_PREFER        0x10
 306 #define INFO_FLAG_AUTHENABLE    0x20
 307 #define INFO_FLAG_SEL_CANDIDATE 0x40
 308 #define INFO_FLAG_SHORTLIST     0x80
 309 #define INFO_FLAG_IBURST        0x100
 310
 311 /*
 312  * Flags in the system information returns
 313  */
 314 #define INFO_FLAG_BCLIENT       0x1
 315 #define INFO_FLAG_AUTHENTICATE  0x2
 316 #define INFO_FLAG_NTP           0x4
 317 #define INFO_FLAG_KERNEL        0x8
 318 #define INFO_FLAG_MONITOR       0x40
 319 #define INFO_FLAG_FILEGEN       0x80
 320 #define INFO_FLAG_CAL           0x10
 321 #define INFO_FLAG_PPS_SYNC      0x20
 322
 323 /*
 324  * Peer list structure.  Used to return raw lists of peers.  It goes
 325  * without saying that everything returned is in network byte order.
 326  * Well, it *would* have gone without saying, but somebody said it.
 327  */
 328 struct info_peer_list {
 329         u_int32 addr;           /* address of peer */
 330         u_short port;           /* port number of peer */
 331         u_char hmode;           /* mode for this peer */
 332         u_char flags;           /* flags (from above) */
 333         u_int v6_flag;          /* is this v6 or not */
 334         u_int unused1;          /* (unused) padding for addr6 */
 335         struct in6_addr addr6;  /* v6 address of peer */
 336 };
 337
 338
 339 /*
 340  * Peer summary structure.  Sort of the info that ntpdc returns by default.
 341  */
 342 struct info_peer_summary {
 343         u_int32 dstadr;         /* local address (zero for undetermined) */
 344         u_int32 srcadr;         /* source address */
 345         u_short srcport;        /* source port */
 346         u_char stratum;         /* stratum of peer */
 347         s_char hpoll;           /* host polling interval */
 348         s_char ppoll;           /* peer polling interval */
 349         u_char reach;           /* reachability register */
 350         u_char flags;           /* flags, from above */
 351         u_char hmode;           /* peer mode */
 352         s_fp delay;             /* peer.estdelay */
 353         l_fp offset;            /* peer.estoffset */
 354         u_fp dispersion;        /* peer.estdisp */
 355         u_int v6_flag;                  /* is this v6 or not */
 356         u_int unused1;                  /* (unused) padding for dstadr6 */
 357         struct in6_addr dstadr6;        /* local address (v6) */
 358         struct in6_addr srcadr6;        /* source address (v6) */
 359 };
 360
 361
 362 /*
 363  * Peer information structure.
 364  */
 365 struct info_peer {
 366         u_int32 dstadr;         /* local address */
 367         u_int32 srcadr;         /* source address */
 368         u_short srcport;        /* remote port */
 369         u_char flags;           /* peer flags */
 370         u_char leap;            /* peer.leap */
 371         u_char hmode;           /* peer.hmode */
 372         u_char pmode;           /* peer.pmode */
 373         u_char stratum;         /* peer.stratum */
 374         u_char ppoll;           /* peer.ppoll */
 375         u_char hpoll;           /* peer.hpoll */
 376         s_char precision;       /* peer.precision */
 377         u_char version;         /* peer.version */
 378         u_char unused8;
 379         u_char reach;           /* peer.reach */
 380         u_char unreach;         /* peer.unreach */
 381         u_char flash;           /* old peer.flash */
 382         u_char ttl;             /* peer.ttl */
 383         u_short flash2;         /* new peer.flash */
 384         associd_t associd;      /* association ID */
 385         keyid_t keyid;          /* peer.keyid */
 386         u_int32 pkeyid;         /* unused */
 387         u_int32 refid;          /* peer.refid */
 388         u_int32 timer;          /* peer.timer */
 389         s_fp rootdelay;         /* peer.delay */
 390         u_fp rootdispersion;    /* peer.dispersion */
 391         l_fp reftime;           /* peer.reftime */
 392         l_fp org;               /* peer.org */
 393         l_fp rec;               /* peer.rec */
 394         l_fp xmt;               /* peer.xmt */
 395         s_fp filtdelay[NTP_SHIFT];      /* delay shift register */
 396         l_fp filtoffset[NTP_SHIFT];     /* offset shift register */
 397         u_char order[NTP_SHIFT];        /* order of peers from last filter */
 398         s_fp delay;             /* peer.estdelay */
 399         u_fp dispersion;        /* peer.estdisp */
 400         l_fp offset;            /* peer.estoffset */
 401         u_fp selectdisp;        /* peer select dispersion */
 402         int32 unused1;          /* (obsolete) */
 403         int32 unused2;
 404         int32 unused3;
 405         int32 unused4;
 406         int32 unused5;
 407         int32 unused6;
 408         int32 unused7;
 409         s_fp estbdelay;         /* broadcast offset */
 410         u_int v6_flag;                  /* is this v6 or not */
 411         u_int unused9;                  /* (unused) padding for dstadr6 */
 412         struct in6_addr dstadr6;        /* local address (v6-like) */
 413         struct in6_addr srcadr6;        /* sources address (v6-like) */
 414 };
 415
 416
 417 /*
 418  * Peer statistics structure
 419  */
 420 struct info_peer_stats {
 421         u_int32 dstadr;         /* local address */
 422         u_int32 srcadr;         /* remote address */
 423         u_short srcport;        /* remote port */
 424         u_short flags;          /* peer flags */
 425         u_int32 timereset;      /* time counters were reset */
 426         u_int32 timereceived;   /* time since a packet received */
 427         u_int32 timetosend;     /* time until a packet sent */
 428         u_int32 timereachable;  /* time peer has been reachable */
 429         u_int32 sent;           /* number sent */
 430         u_int32 unused1;        /* (unused) */
 431         u_int32 processed;      /* number processed */
 432         u_int32 unused2;        /* (unused) */
 433         u_int32 badauth;        /* bad authentication */
 434         u_int32 bogusorg;       /* bogus origin */
 435         u_int32 oldpkt;         /* duplicate */
 436         u_int32 unused3;        /* (unused) */
 437         u_int32 unused4;        /* (unused) */
 438         u_int32 seldisp;        /* bad dispersion */
 439         u_int32 selbroken;      /* bad reference time */
 440         u_int32 unused5;        /* (unused) */
 441         u_char candidate;       /* select order */
 442         u_char unused6;         /* (unused) */
 443         u_char unused7;         /* (unused) */
 444         u_char unused8;         /* (unused) */
 445         u_int v6_flag;                  /* is this v6 or not */
 446         u_int unused9;                  /* (unused) padding for dstadr6 */
 447         struct in6_addr dstadr6;        /* local address */
 448         struct in6_addr srcadr6;        /* remote address */
 449 };
 450
 451
 452 /*
 453  * Loop filter variables
 454  */
 455 struct info_loop {
 456         l_fp last_offset;
 457         l_fp drift_comp;
 458         u_int32 compliance;
 459         u_int32 watchdog_timer;
 460 };
 461
 462
 463 /*
 464  * System info.  Mostly the sys.* variables, plus a few unique to
 465  * the implementation.
 466  */
 467 struct info_sys {
 468         u_int32 peer;           /* system peer address (v4) */
 469         u_char peer_mode;       /* mode we are syncing to peer in */
 470         u_char leap;            /* system leap bits */
 471         u_char stratum;         /* our stratum */
 472         s_char precision;       /* local clock precision */
 473         s_fp rootdelay;         /* delay from sync source */
 474         u_fp rootdispersion;    /* dispersion from sync source */
 475         u_int32 refid;          /* reference ID of sync source */
 476         l_fp reftime;           /* system reference time */
 477         u_int32 poll;           /* system poll interval */
 478         u_char flags;           /* system flags */
 479         u_char unused1;         /* unused */
 480         u_char unused2;         /* unused */
 481         u_char unused3;         /* unused */
 482         s_fp bdelay;            /* default broadcast offset */
 483         s_fp frequency;         /* frequency residual (scaled ppm)  */
 484         l_fp authdelay;         /* default authentication delay */
 485         u_fp stability;         /* clock stability (scaled ppm) */
 486         u_int v6_flag;          /* is this v6 or not */
 487         u_int unused4;          /* unused, padding for peer6 */
 488         struct in6_addr peer6;  /* system peer address (v6) */
 489 };
 490
 491
 492 /*
 493  * System stats.  These are collected in the protocol module
 494  */
 495 struct info_sys_stats {
 496         u_int32 timeup;         /* time since restart */
 497         u_int32 timereset;      /* time since reset */
 498         u_int32 denied;         /* access denied */
 499         u_int32 oldversionpkt;  /* recent version */
 500         u_int32 newversionpkt;  /* current version */
 501         u_int32 unknownversion; /* bad version */
 502         u_int32 badlength;      /* bad length or format */
 503         u_int32 processed;      /* packets processed */
 504         u_int32 badauth;        /* bad authentication */
 505         u_int32 received;       /* packets received */
 506         u_int32 limitrejected;  /* rate exceeded */
 507 };
 508
 509
 510 /*
 511  * System stats - old version
 512  */
 513 struct old_info_sys_stats {
 514         u_int32 timeup;         /* time since restart */
 515         u_int32 timereset;      /* time since reset */
 516         u_int32 denied;         /* access denied */
 517         u_int32 oldversionpkt;  /* recent version */
 518         u_int32 newversionpkt;  /* current version */
 519         u_int32 unknownversion; /* bad version */
 520         u_int32 badlength;      /* bad length or format */
 521         u_int32 processed;      /* packets processed */
 522         u_int32 badauth;        /* bad authentication */
 523         u_int32 wanderhold;     /* (not used) */
 524 };
 525
 526
 527 /*
 528  * Peer memory statistics.  Collected in the peer module.
 529  */
 530 struct info_mem_stats {
 531         u_int32 timereset;      /* time since reset */
 532         u_short totalpeermem;
 533         u_short freepeermem;
 534         u_int32 findpeer_calls;
 535         u_int32 allocations;
 536         u_int32 demobilizations;
 537         u_char hashcount[NTP_HASH_SIZE];
 538 };
 539
 540
 541 /*
 542  * I/O statistics.  Collected in the I/O module
 543  */
 544 struct info_io_stats {
 545         u_int32 timereset;      /* time since reset */
 546         u_short totalrecvbufs;  /* total receive bufs */
 547         u_short freerecvbufs;   /* free buffers */
 548         u_short fullrecvbufs;   /* full buffers */
 549         u_short lowwater;       /* number of times we've added buffers */
 550         u_int32 dropped;        /* dropped packets */
 551         u_int32 ignored;        /* ignored packets */
 552         u_int32 received;       /* received packets */
 553         u_int32 sent;           /* packets sent */
 554         u_int32 notsent;        /* packets not sent */
 555         u_int32 interrupts;     /* interrupts we've handled */
 556         u_int32 int_received;   /* received by interrupt handler */
 557 };
 558
 559
 560 /*
 561  * Timer stats.  Guess where from.
 562  */
 563 struct info_timer_stats {
 564         u_int32 timereset;      /* time since reset */
 565         u_int32 alarms;         /* alarms we've handled */
 566         u_int32 overflows;      /* timer overflows */
 567         u_int32 xmtcalls;       /* calls to xmit */
 568 };
 569
 570
 571 /*
 572  * Structure for passing peer configuration information
 573  */
 574 struct old_conf_peer {
 575         u_int32 peeraddr;       /* address to poll */
 576         u_char hmode;           /* mode, either broadcast, active or client */
 577         u_char version;         /* version number to poll with */
 578         u_char minpoll;         /* min host poll interval */
 579         u_char maxpoll;         /* max host poll interval */
 580         u_char flags;           /* flags for this request */
 581         u_char ttl;             /* time to live (multicast) or refclock mode */
 582         u_short unused;         /* unused */
 583         keyid_t keyid;          /* key to use for this association */
 584 };
 585
 586 struct conf_peer {
 587         u_int32 peeraddr;       /* address to poll */
 588         u_char hmode;           /* mode, either broadcast, active or client */
 589         u_char version;         /* version number to poll with */
 590         u_char minpoll;         /* min host poll interval */
 591         u_char maxpoll;         /* max host poll interval */
 592         u_char flags;           /* flags for this request */
 593         u_char ttl;             /* time to live (multicast) or refclock mode */
 594         u_short unused1;        /* unused */
 595         keyid_t keyid;          /* key to use for this association */
 596         char keystr[MAXFILENAME]; /* public key file name*/
 597         u_int v6_flag;          /* is this v6 or not */
 598         u_int unused2;                  /* unused, padding for peeraddr6 */
 599         struct in6_addr peeraddr6;      /* ipv6 address to poll */
 600 };
 601
 602 #define CONF_FLAG_AUTHENABLE    0x01
 603 #define CONF_FLAG_PREFER        0x02
 604 #define CONF_FLAG_BURST         0x04
 605 #define CONF_FLAG_IBURST        0x08
 606 #define CONF_FLAG_NOSELECT      0x10
 607 #define CONF_FLAG_SKEY          0x20
 608
 609 /*
 610  * Structure for passing peer deletion information.  Currently
 611  * we only pass the address and delete all configured peers with
 612  * this addess.
 613  */
 614 struct conf_unpeer {
 615         u_int32 peeraddr;               /* address of peer */
 616         u_int v6_flag;                  /* is this v6 or not */
 617         struct in6_addr peeraddr6;      /* address of peer (v6) */
 618 };
 619
 620 /*
 621  * Structure for carrying system flags.
 622  */
 623 struct conf_sys_flags {
 624         u_int32 flags;
 625 };
 626
 627 /*
 628  * System flags we can set/clear
 629  */
 630 #define SYS_FLAG_BCLIENT        0x01
 631 #define SYS_FLAG_PPS            0x02
 632 #define SYS_FLAG_NTP            0x04
 633 #define SYS_FLAG_KERNEL         0x08
 634 #define SYS_FLAG_MONITOR        0x10
 635 #define SYS_FLAG_FILEGEN        0x20
 636 #define SYS_FLAG_AUTH           0x40
 637 #define SYS_FLAG_CAL            0x80
 638
 639 /*
 640  * Structure used for returning restrict entries
 641  */
 642 struct info_restrict {
 643         u_int32 addr;           /* match address */
 644         u_int32 mask;           /* match mask */
 645         u_int32 count;          /* number of packets matched */
 646         u_short flags;          /* restrict flags */
 647         u_short mflags;         /* match flags */
 648         u_int v6_flag;          /* is this v6 or not */
 649         u_int unused1;          /* unused, padding for addr6 */
 650         struct in6_addr addr6;  /* match address (v6) */
 651         struct in6_addr mask6;  /* match mask (v6) */
 652 };
 653
 654
 655 /*
 656  * Structure used for specifying restrict entries
 657  */
 658 struct conf_restrict {
 659         u_int32 addr;           /* match address */
 660         u_int32 mask;           /* match mask */
 661         u_short flags;          /* restrict flags */
 662         u_short mflags;         /* match flags */
 663         u_int v6_flag;          /* is this v6 or not */
 664         struct in6_addr addr6;  /* match address (v6) */
 665         struct in6_addr mask6;  /* match mask (v6) */
 666 };
 667
 668
 669 /*
 670  * Structure used for returning monitor data
 671  */
 672 struct info_monitor_1 {
 673         u_int32 lasttime;       /* last packet from this host */
 674         u_int32 firsttime;      /* first time we received a packet */
 675         u_int32 restr;          /* restrict bits (was named lastdrop) */
 676         u_int32 count;          /* count of packets received */
 677         u_int32 addr;           /* host address V4 style */
 678         u_int32 daddr;          /* destination host address */
 679         u_int32 flags;          /* flags about destination */
 680         u_short port;           /* port number of last reception */
 681         u_char mode;            /* mode of last packet */
 682         u_char version;         /* version number of last packet */
 683         u_int v6_flag;          /* is this v6 or not */
 684         u_int unused1;          /* unused, padding for addr6 */
 685         struct in6_addr addr6;  /* host address V6 style */
 686         struct in6_addr daddr6; /* host address V6 style */
 687 };
 688
 689
 690 /*
 691  * Structure used for returning monitor data
 692  */
 693 struct info_monitor {
 694         u_int32 lasttime;       /* last packet from this host */
 695         u_int32 firsttime;      /* first time we received a packet */
 696         u_int32 restr;          /* restrict bits (was named lastdrop) */
 697         u_int32 count;          /* count of packets received */
 698         u_int32 addr;           /* host address */
 699         u_short port;           /* port number of last reception */
 700         u_char mode;            /* mode of last packet */
 701         u_char version;         /* version number of last packet */
 702         u_int v6_flag;          /* is this v6 or not */
 703         u_int unused1;          /* unused, padding for addr6 */
 704         struct in6_addr addr6;  /* host v6 address */
 705 };
 706
 707 /*
 708  * Structure used for returning monitor data (old format)
 709  */
 710 struct old_info_monitor {
 711         u_int32 lasttime;       /* last packet from this host */
 712         u_int32 firsttime;      /* first time we received a packet */
 713         u_int32 count;          /* count of packets received */
 714         u_int32 addr;           /* host address */
 715         u_short port;           /* port number of last reception */
 716         u_char mode;            /* mode of last packet */
 717         u_char version;         /* version number of last packet */
 718         u_int v6_flag;          /* is this v6 or not */
 719         struct in6_addr addr6;  /* host address  (v6)*/
 720 };
 721
 722 /*
 723  * Structure used for passing indication of flags to clear
 724  */
 725 struct reset_flags {
 726         u_int32 flags;
 727 };
 728
 729 #define RESET_FLAG_ALLPEERS     0x01
 730 #define RESET_FLAG_IO           0x02
 731 #define RESET_FLAG_SYS          0x04
 732 #define RESET_FLAG_MEM          0x08
 733 #define RESET_FLAG_TIMER        0x10
 734 #define RESET_FLAG_AUTH         0x20
 735 #define RESET_FLAG_CTL          0x40
 736
 737 #define RESET_ALLFLAGS \
 738         (RESET_FLAG_ALLPEERS|RESET_FLAG_IO|RESET_FLAG_SYS \
 739         |RESET_FLAG_MEM|RESET_FLAG_TIMER|RESET_FLAG_AUTH|RESET_FLAG_CTL)
 740
 741 /*
 742  * Structure used to return information concerning the authentication
 743  * module.
 744  */
 745 struct info_auth {
 746         u_int32 timereset;      /* time counters were reset */
 747         u_int32 numkeys;        /* number of keys we know */
 748         u_int32 numfreekeys;    /* number of free keys */
 749         u_int32 keylookups;     /* calls to authhavekey() */
 750         u_int32 keynotfound;    /* requested key unknown */
 751         u_int32 encryptions;    /* number of encryptions */
 752         u_int32 decryptions;    /* number of decryptions */
 753         u_int32 expired;        /* number of expired keys */
 754         u_int32 keyuncached;    /* calls to encrypt/decrypt with uncached key */
 755 };
 756
 757
 758 /*
 759  * Structure used to pass trap information to the client
 760  */
 761 struct info_trap {
 762         u_int32 local_address;  /* local interface addres (v4) */
 763         u_int32 trap_address;   /* remote client's addres (v4) */
 764         u_short trap_port;      /* remote port number */
 765         u_short sequence;       /* sequence number */
 766         u_int32 settime;        /* time trap last set */
 767         u_int32 origtime;       /* time trap originally set */
 768         u_int32 resets;         /* number of resets on this trap */
 769         u_int32 flags;          /* trap flags, as defined in ntp_control.h */
 770         u_int v6_flag;                  /* is this v6 or not */
 771         struct in6_addr local_address6; /* local interface address (v6) */
 772         struct in6_addr trap_address6;  /* remote client's address (v6) */
 773 };
 774
 775 /*
 776  * Structure used to pass add/clear trap information to the client
 777  */
 778 struct conf_trap {
 779         u_int32 local_address;  /* remote client's address */
 780         u_int32 trap_address;   /* local interface address */
 781         u_short trap_port;      /* remote client's port */
 782         u_short unused;         /* (unused) */
 783         u_int v6_flag;                  /* is this v6 or not */
 784         struct in6_addr local_address6; /* local interface address (v6) */
 785         struct in6_addr trap_address6;  /* remote client's address (v6) */
 786 };
 787
 788
 789 /*
 790  * Structure used to return statistics from the control module
 791  */
 792 struct info_control {
 793         u_int32 ctltimereset;
 794         u_int32 numctlreq;      /* number of requests we've received */
 795         u_int32 numctlbadpkts;  /* number of bad control packets */
 796         u_int32 numctlresponses;        /* # resp packets sent */
 797         u_int32 numctlfrags;    /* # of fragments sent */
 798         u_int32 numctlerrors;   /* number of error responses sent */
 799         u_int32 numctltooshort; /* number of too short input packets */
 800         u_int32 numctlinputresp;        /* number of responses on input */
 801         u_int32 numctlinputfrag;        /* number of fragments on input */
 802         u_int32 numctlinputerr; /* # input pkts with err bit set */
 803         u_int32 numctlbadoffset;        /* # input pkts with nonzero offset */
 804         u_int32 numctlbadversion;       /* # input pkts with unknown version */
 805         u_int32 numctldatatooshort;     /* data too short for count */
 806         u_int32 numctlbadop;    /* bad op code found in packet */
 807         u_int32 numasyncmsgs;           /* # async messages we've sent */
 808 };
 809
 810
 811 /*
 812  * Structure used to return clock information
 813  */
 814 struct info_clock {
 815         u_int32 clockadr;
 816         u_char type;
 817         u_char flags;
 818         u_char lastevent;
 819         u_char currentstatus;
 820         u_int32 polls;
 821         u_int32 noresponse;
 822         u_int32 badformat;
 823         u_int32 baddata;
 824         u_int32 timestarted;
 825         l_fp fudgetime1;
 826         l_fp fudgetime2;
 827         int32 fudgeval1;
 828         int32 fudgeval2;
 829 };
 830
 831
 832 /*
 833  * Structure used for setting clock fudge factors
 834  */
 835 struct conf_fudge {
 836         u_int32 clockadr;
 837         u_int32 which;
 838         l_fp fudgetime;
 839         int32 fudgeval_flags;
 840 };
 841
 842 #define FUDGE_TIME1     1
 843 #define FUDGE_TIME2     2
 844 #define FUDGE_VAL1      3
 845 #define FUDGE_VAL2      4
 846 #define FUDGE_FLAGS     5
 847
 848
 849 /*
 850  * Structure used for returning clock debugging info
 851  */
 852 #define NUMCBUGVALUES   16
 853 #define NUMCBUGTIMES    32
 854
 855 struct info_clkbug {
 856         u_int32 clockadr;
 857         u_char nvalues;
 858         u_char ntimes;
 859         u_short svalues;
 860         u_int32 stimes;
 861         u_int32 values[NUMCBUGVALUES];
 862         l_fp times[NUMCBUGTIMES];
 863 };
 864
 865 /*
 866  * Structure used for returning kernel pll/PPS information
 867  */
 868 struct info_kernel {
 869         int32 offset;
 870         int32 freq;
 871         int32 maxerror;
 872         int32 esterror;
 873         u_short status;
 874         u_short shift;
 875         int32 constant;
 876         int32 precision;
 877         int32 tolerance;
 878
 879 /*
 880  * Variables used only if PPS signal discipline is implemented
 881  */
 882         int32 ppsfreq;
 883         int32 jitter;
 884         int32 stabil;
 885         int32 jitcnt;
 886         int32 calcnt;
 887         int32 errcnt;
 888         int32 stbcnt;
 889 };
 890
 891 /*
 892  * interface statistics
 893  */
 894 struct info_if_stats {
 895         union addrun unaddr;            /* address */
 896         union addrun unbcast;           /* broadcast */
 897         union addrun unmask;            /* mask */
 898         u_int32 v6_flag;                /* is this v6 */
 899         char name[32];                  /* name of interface */
 900         int32 flags;                    /* interface flags */
 901         int32 last_ttl;                 /* last TTL specified */
 902         int32 num_mcast;                /* No. of IP addresses in multicast socket */
 903         int32 received;                 /* number of incoming packets */
 904         int32 sent;                     /* number of outgoing packets */
 905         int32 notsent;                  /* number of send failures */
 906         int32 uptime;                   /* number of seconds this interface was active */
 907         u_int32 scopeid;                /* Scope used for Multicasting */
 908         u_int32 ifindex;                /* interface index - from system */
 909         u_int32 ifnum;                  /* sequential interface number */
 910         u_int32 peercnt;                /* number of peers referencinf this interface - informational only */
 911         u_short family;                 /* Address family */
 912         u_char ignore_packets;          /* Specify whether the packet should be ignored */
 913         u_char action;                  /* reason the item is listed */
 914         int32 _filler0;                 /* pad to a 64 bit size boundary */
 915 };
 916
 917 #define IFS_EXISTS      1       /* just exists */
 918 #define IFS_CREATED     2       /* was just created */
 919 #define IFS_DELETED     3       /* was just delete */
 920
 921 /*
 922  * Info returned with IP -> hostname lookup
 923  */
 924 /* 144 might need to become 32, matching data[] member of req_pkt */
 925 #define NTP_MAXHOSTNAME (32 - sizeof(u_int32) - sizeof(u_short))
 926 struct info_dns_assoc {
 927         u_int32 peeraddr;       /* peer address (HMS: being careful...) */
 928         associd_t associd;      /* association ID */
 929         char hostname[NTP_MAXHOSTNAME]; /* hostname */
 930 };
 931
 932 /*
 933  * function declarations
 934  */
 935 int get_packet_mode(struct recvbuf *rbufp); /* Return packet mode */
 936
 937 #endif /* NTP_REQUEST_H */