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