1/* $NetBSD: ntpd.h,v 1.3 2012/02/01 07:46:21 kardel Exp $ */ 2 3/* 4 * ntpd.h - Prototypes for ntpd. 5 */ 6 7#include "ntp.h" 8#include "ntp_debug.h" 9#include "ntp_syslog.h" 10#include "ntp_select.h" 11#include "ntp_malloc.h" 12#include "ntp_refclock.h" 13#include "recvbuff.h" 14 15/* ntp_config.c */ 16 17#define TAI_1972 10 /* initial TAI offset (s) */ 18extern char *keysdir; /* crypto keys and leaptable directory */ 19extern char * saveconfigdir; /* ntpq saveconfig output directory */ 20 21extern void getconfig (int, char **); 22extern void ctl_clr_stats (void); 23extern int ctlclrtrap (sockaddr_u *, struct interface *, int); 24extern u_short ctlpeerstatus (struct peer *); 25extern int ctlsettrap (sockaddr_u *, struct interface *, int, int); 26extern u_short ctlsysstatus (void); 27extern void init_control (void); 28extern void init_logging (char const *, int); 29extern void setup_logfile (void); 30extern void process_control (struct recvbuf *, int); 31extern void report_event (int, struct peer *, const char *); 32 33/* ntp_control.c */ 34/* 35 * Structure for translation tables between internal system 36 * variable indices and text format. 37 */ 38struct ctl_var { 39 u_short code; 40 u_short flags; 41 const char *text; 42}; 43/* 44 * Flag values 45 */ 46#define CAN_READ 0x01 47#define CAN_WRITE 0x02 48 49#define DEF 0x20 50#define PADDING 0x40 51#define EOV 0x80 52 53#define RO (CAN_READ) 54#define WO (CAN_WRITE) 55#define RW (CAN_READ|CAN_WRITE) 56 57extern char * add_var (struct ctl_var **, u_long, u_short); 58extern void free_varlist (struct ctl_var *); 59extern void set_var (struct ctl_var **, const char *, u_long, u_short); 60extern void set_sys_var (const char *, u_long, u_short); 61 62/* ntp_intres.c */ 63extern void ntp_res_name (sockaddr_u, u_short); 64extern void ntp_res_recv (void); 65extern void ntp_intres (void); 66#ifdef SYS_WINNT 67extern unsigned WINAPI ntp_intres_thread (void *); 68#endif 69 70/* ntp_io.c */ 71typedef struct interface_info { 72 endpt * ep; 73 u_char action; 74} interface_info_t; 75 76typedef void (*interface_receiver_t) (void *, interface_info_t *); 77 78extern int disable_dynamic_updates; 79 80extern void interface_enumerate (interface_receiver_t, void *); 81extern endpt * findinterface (sockaddr_u *); 82extern endpt * findbcastinter (sockaddr_u *); 83extern void enable_broadcast (endpt *, sockaddr_u *); 84extern void enable_multicast_if (endpt *, sockaddr_u *); 85extern void interface_update (interface_receiver_t, void *); 86 87extern void init_io (void); 88extern void io_open_sockets (void); 89extern void input_handler (l_fp *); 90extern void io_clr_stats (void); 91extern void io_setbclient (void); 92extern void io_unsetbclient (void); 93extern void io_multicast_add(sockaddr_u *); 94extern void io_multicast_del(sockaddr_u *); 95extern void sendpkt (sockaddr_u *, struct interface *, int, struct pkt *, int); 96#ifndef SYS_WINNT 97extern void kill_asyncio (int); 98#endif 99#ifdef DEBUG 100extern void collect_timing (struct recvbuf *, const char *, int, l_fp *); 101#endif 102#ifdef HAVE_SIGNALED_IO 103extern void wait_for_signal (void); 104extern void unblock_io_and_alarm (void); 105extern void block_io_and_alarm (void); 106#define UNBLOCK_IO_AND_ALARM() unblock_io_and_alarm() 107#define BLOCK_IO_AND_ALARM() block_io_and_alarm() 108#else 109#define UNBLOCK_IO_AND_ALARM() 110#define BLOCK_IO_AND_ALARM() 111#endif 112#define latoa(pif) localaddrtoa(pif) 113extern const char * localaddrtoa(endpt *); 114 115/* ntp_loopfilter.c */ 116extern void init_loopfilter(void); 117extern int local_clock(struct peer *, double); 118extern void adj_host_clock(void); 119extern void loop_config(int, double); 120extern void huffpuff(void); 121extern u_long sys_clocktime; 122extern u_int sys_tai; 123 124/* ntp_monitor.c */ 125extern void init_mon (void); 126extern void mon_start (int); 127extern void mon_stop (int); 128extern int ntp_monitor (struct recvbuf *, int); 129extern void ntp_monclearinterface (struct interface *interface); 130 131/* ntp_peer.c */ 132extern void init_peer (void); 133extern struct peer *findexistingpeer (sockaddr_u *, struct peer *, int, u_char); 134extern struct peer *findpeer (struct recvbuf *, int, int *); 135extern struct peer *findpeerbyassoc (u_int); 136extern void set_peerdstadr (struct peer *peer, struct interface *interface); 137extern struct peer *newpeer (sockaddr_u *, struct interface *, int, int, int, int, u_int, u_char, int, keyid_t); 138extern void peer_all_reset (void); 139extern void peer_clr_stats (void); 140extern struct peer *peer_config (sockaddr_u *, struct interface *, int, int, int, int, u_int, int, keyid_t, const u_char *); 141extern void peer_reset (struct peer *); 142extern void refresh_all_peerinterfaces (void); 143extern void unpeer (struct peer *); 144extern void clear_all (void); 145extern int score_all (struct peer *); 146extern struct peer *findmanycastpeer (struct recvbuf *); 147 148/* ntp_crypto.c */ 149#ifdef OPENSSL 150extern int crypto_recv (struct peer *, struct recvbuf *); 151extern int crypto_xmit (struct peer *, struct pkt *, 152 struct recvbuf *, int, 153 struct exten *, keyid_t); 154extern keyid_t session_key (sockaddr_u *, sockaddr_u *, keyid_t, 155 keyid_t, u_long); 156extern int make_keylist (struct peer *, struct interface *); 157extern void key_expire (struct peer *); 158extern void crypto_update (void); 159extern void crypto_config (int, char *); 160extern void crypto_setup (void); 161extern u_int crypto_ident (struct peer *); 162extern struct exten *crypto_args (struct peer *, u_int, associd_t, char *); 163extern int crypto_public (struct peer *, u_char *, u_int); 164extern void value_free (struct value *); 165extern char *iffpar_file; 166extern EVP_PKEY *iffpar_pkey; 167extern char *gqpar_file; 168extern EVP_PKEY *gqpar_pkey; 169extern char *mvpar_file; 170extern EVP_PKEY *mvpar_pkey; 171extern struct value tai_leap; 172#endif /* OPENSSL */ 173 174/* ntp_proto.c */ 175extern void transmit (struct peer *); 176extern void receive (struct recvbuf *); 177extern void peer_clear (struct peer *, const char *); 178extern void process_packet (struct peer *, struct pkt *, u_int); 179extern void clock_select (void); 180 181extern int leap_tai; /* TAI at next leap */ 182extern u_long leap_sec; /* next scheduled leap from file */ 183extern u_long leap_peers; /* next scheduled leap from peers */ 184extern u_long leapsec; /* seconds to next leap */ 185extern u_long leap_expire; /* leap information expiration */ 186extern int sys_orphan; 187extern double sys_mindisp; 188extern double sys_maxdist; 189 190/* 191 * there seems to be a bug in the IRIX 4 compiler which prevents 192 * u_char from beeing used in prototyped functions. 193 * This is also true AIX compiler. 194 * So give up and define it to be int. WLJ 195 */ 196extern void poll_update (struct peer *, int); 197 198extern void clear (struct peer *); 199extern void clock_filter (struct peer *, double, double, double); 200extern void init_proto (void); 201extern void proto_config (int, u_long, double, sockaddr_u *); 202extern void proto_clr_stats (void); 203 204#ifdef REFCLOCK 205/* ntp_refclock.c */ 206extern int refclock_newpeer (struct peer *); 207extern void refclock_unpeer (struct peer *); 208extern void refclock_receive (struct peer *); 209extern void refclock_transmit (struct peer *); 210extern void init_refclock (void); 211#endif /* REFCLOCK */ 212 213/* ntp_request.c */ 214extern void init_request (void); 215extern void process_private (struct recvbuf *, int); 216 217/* ntp_restrict.c */ 218extern void init_restrict (void); 219extern u_short restrictions (sockaddr_u *); 220extern void hack_restrict (int, sockaddr_u *, sockaddr_u *, u_short, u_short); 221 222/* ntp_timer.c */ 223extern void init_timer (void); 224extern void reinit_timer (void); 225extern void timer (void); 226extern void timer_clr_stats (void); 227extern void timer_interfacetimeout (u_long); 228extern volatile int interface_interval; 229#ifdef OPENSSL 230extern char *sys_hostname; /* host name */ 231extern char *sys_groupname; /* group name */ 232extern char *group_name; /* group name */ 233extern u_long sys_revoke; /* keys revoke timeout */ 234extern u_long sys_automax; /* session key timeout */ 235#endif /* OPENSSL */ 236 237/* ntp_util.c */ 238extern void init_util (void); 239extern void write_stats (void); 240extern void stats_config (int, const char *); 241extern void record_peer_stats (sockaddr_u *, int, double, double, double, double); 242extern void record_proto_stats (char *); 243extern void record_loop_stats (double, double, double, double, int); 244extern void record_clock_stats (sockaddr_u *, const char *); 245extern void record_raw_stats (sockaddr_u *, sockaddr_u *, l_fp *, l_fp *, l_fp *, l_fp *); 246extern u_long leap_month(u_long); 247extern void record_crypto_stats (sockaddr_u *, const char *); 248#ifdef DEBUG 249extern void record_timing_stats (const char *); 250#endif 251extern u_short sock_hash (sockaddr_u *); 252extern char * fstostr(time_t); /* NTP timescale seconds */ 253extern double old_drift; 254extern int drift_file_sw; 255extern double wander_threshold; 256extern double wander_resid; 257 258/* 259 * Variable declarations for ntpd. 260 */ 261/* ntp_config.c */ 262extern char const * progname; 263extern char *sys_phone[]; /* ACTS phone numbers */ 264#if defined(HAVE_SCHED_SETSCHEDULER) 265extern int config_priority_override; 266extern int config_priority; 267#endif 268extern char *ntp_signd_socket; 269extern struct config_tree *cfg_tree_history; 270 271#ifdef BC_LIST_FRAMEWORK_NOT_YET_USED 272/* 273 * backwards compatibility flags 274 */ 275typedef struct bc_entry_tag { 276 int token; 277 int enabled; 278} bc_entry; 279 280extern bc_entry bc_list[]; 281#endif 282 283/* ntp_control.c */ 284extern int num_ctl_traps; 285extern keyid_t ctl_auth_keyid; /* keyid used for authenticating write requests */ 286 287/* 288 * Statistic counters to keep track of requests and responses. 289 */ 290extern u_long ctltimereset; /* time stats reset */ 291extern u_long numctlreq; /* number of requests we've received */ 292extern u_long numctlbadpkts; /* number of bad control packets */ 293extern u_long numctlresponses; /* number of resp packets sent with data */ 294extern u_long numctlfrags; /* number of fragments sent */ 295extern u_long numctlerrors; /* number of error responses sent */ 296extern u_long numctltooshort; /* number of too short input packets */ 297extern u_long numctlinputresp; /* number of responses on input */ 298extern u_long numctlinputfrag; /* number of fragments on input */ 299extern u_long numctlinputerr; /* number of input pkts with err bit set */ 300extern u_long numctlbadoffset; /* number of input pkts with nonzero offset */ 301extern u_long numctlbadversion; /* number of input pkts with unknown version */ 302extern u_long numctldatatooshort; /* data too short for count */ 303extern u_long numctlbadop; /* bad op code found in packet */ 304extern u_long numasyncmsgs; /* number of async messages we've sent */ 305 306/* ntp_intres.c */ 307extern keyid_t req_keyid; /* request keyid */ 308extern int req_keytype; /* OpenSSL NID such as NID_md5 */ 309extern size_t req_hashlen; /* digest size for req_keytype */ 310extern char * req_file; /* name of the file with configuration info */ 311#ifdef SYS_WINNT 312extern HANDLE ResolverEventHandle; 313#else 314extern int resolver_pipe_fd[2]; /* used to let the resolver process alert the parent process */ 315#endif /* SYS_WINNT */ 316 317/* 318 * Other statistics of possible interest 319 */ 320extern volatile u_long packets_dropped; /* total number of packets dropped on reception */ 321extern volatile u_long packets_ignored; /* packets received on wild card interface */ 322extern volatile u_long packets_received;/* total number of packets received */ 323extern u_long packets_sent; /* total number of packets sent */ 324extern u_long packets_notsent; /* total number of packets which couldn't be sent */ 325 326extern volatile u_long handler_calls; /* number of calls to interrupt handler */ 327extern volatile u_long handler_pkts; /* number of pkts received by handler */ 328extern u_long io_timereset; /* time counters were reset */ 329 330/* 331 * Interface stuff 332 */ 333extern endpt * any_interface; /* IPv4 wildcard */ 334extern endpt * any6_interface; /* IPv6 wildcard */ 335extern endpt * loopback_interface; /* IPv4 loopback for refclocks */ 336 337/* 338 * File descriptor masks etc. for call to select 339 */ 340extern fd_set activefds; 341extern int maxactivefd; 342 343/* ntp_loopfilter.c */ 344extern double drift_comp; /* clock frequency (s/s) */ 345extern double clock_stability; /* clock stability (s/s) */ 346extern double clock_max; /* max offset before step (s) */ 347extern double clock_panic; /* max offset before panic (s) */ 348extern double clock_phi; /* dispersion rate (s/s) */ 349extern double clock_minstep; /* step timeout (s) */ 350extern double clock_codec; /* codec frequency */ 351#ifdef KERNEL_PLL 352extern int pll_status; /* status bits for kernel pll */ 353#endif /* KERNEL_PLL */ 354 355/* 356 * Clock state machine control flags 357 */ 358extern int ntp_enable; /* clock discipline enabled */ 359extern int pll_control; /* kernel support available */ 360extern int kern_enable; /* kernel support enabled */ 361extern int pps_enable; /* kernel PPS discipline enabled */ 362extern int ext_enable; /* external clock enabled */ 363extern int cal_enable; /* refclock calibrate enable */ 364extern int allow_panic; /* allow panic correction */ 365extern int mode_ntpdate; /* exit on first clock set */ 366extern int peer_ntpdate; /* count of ntpdate peers */ 367 368/* 369 * Clock state machine variables 370 */ 371extern u_char sys_poll; /* system poll interval (log2 s) */ 372extern int state; /* clock discipline state */ 373extern int tc_counter; /* poll-adjust counter */ 374extern u_long last_time; /* time of last clock update (s) */ 375extern double last_offset; /* last clock offset (s) */ 376extern u_char allan_xpt; /* Allan intercept (log2 s) */ 377extern double clock_jitter; /* clock jitter (s) */ 378extern double sys_offset; /* system offset (s) */ 379extern double sys_jitter; /* system jitter (s) */ 380 381/* ntp_monitor.c */ 382extern struct mon_data mon_mru_list; 383extern struct mon_data mon_fifo_list; 384extern int mon_enabled; 385 386/* ntp_peer.c */ 387extern struct peer *peer_hash[]; /* peer hash table */ 388extern int peer_hash_count[]; /* count of peers in each bucket */ 389extern struct peer *assoc_hash[]; /* association ID hash table */ 390extern int assoc_hash_count[]; 391extern int peer_free_count; 392 393/* 394 * Miscellaneous statistic counters which may be queried. 395 */ 396extern u_long peer_timereset; /* time stat counters were zeroed */ 397extern u_long findpeer_calls; /* number of calls to findpeer */ 398extern u_long assocpeer_calls; /* number of calls to findpeerbyassoc */ 399extern u_long peer_allocations; /* number of allocations from the free list */ 400extern u_long peer_demobilizations; /* number of structs freed to free list */ 401extern int total_peer_structs; /* number of peer structs in circulation */ 402extern int peer_associations; /* mobilized associations */ 403extern int peer_preempt; /* preemptable associations */ 404/* ntp_proto.c */ 405/* 406 * System variables are declared here. See Section 3.2 of the 407 * specification. 408 */ 409extern u_char sys_leap; /* system leap indicator */ 410extern u_char sys_stratum; /* system stratum */ 411extern s_char sys_precision; /* local clock precision */ 412extern double sys_rootdelay; /* roundtrip delay to primary source */ 413extern double sys_rootdisp; /* dispersion to primary source */ 414extern u_int32 sys_refid; /* reference id */ 415extern l_fp sys_reftime; /* last update time */ 416extern struct peer *sys_peer; /* current peer */ 417 418/* 419 * Nonspecified system state variables. 420 */ 421extern int sys_bclient; /* we set our time to broadcasts */ 422extern double sys_bdelay; /* broadcast client default delay */ 423extern int sys_authenticate; /* requre authentication for config */ 424extern l_fp sys_authdelay; /* authentication delay */ 425extern keyid_t sys_private; /* private value for session seed */ 426extern int sys_manycastserver; /* respond to manycast client pkts */ 427extern int sys_minclock; /* minimum survivors */ 428extern int sys_minsane; /* minimum candidates */ 429extern int sys_floor; /* cluster stratum floor */ 430extern int sys_ceiling; /* cluster stratum ceiling */ 431extern u_char sys_ttl[MAX_TTL]; /* ttl mapping vector */ 432extern int sys_ttlmax; /* max ttl mapping vector index */ 433 434/* 435 * Statistics counters 436 */ 437extern u_long sys_stattime; /* time since reset */ 438extern u_long sys_received; /* packets received */ 439extern u_long sys_processed; /* packets for this host */ 440extern u_long sys_restricted; /* restricted packets */ 441extern u_long sys_newversion; /* current version */ 442extern u_long sys_oldversion; /* old version */ 443extern u_long sys_restricted; /* access denied */ 444extern u_long sys_badlength; /* bad length or format */ 445extern u_long sys_badauth; /* bad authentication */ 446extern u_long sys_declined; /* declined */ 447extern u_long sys_limitrejected; /* rate exceeded */ 448extern u_long sys_kodsent; /* KoD sent */ 449 450/* ntp_refclock.c */ 451#ifdef REFCLOCK 452#ifdef PPS 453extern int fdpps; /* pps file descriptor */ 454#endif /* PPS */ 455#endif 456 457/* ntp_request.c */ 458extern keyid_t info_auth_keyid; /* keyid used to authenticate requests */ 459 460/* ntp_restrict.c */ 461extern restrict_u * restrictlist4; /* IPv4 restriction list */ 462extern restrict_u * restrictlist6; /* IPv6 restriction list */ 463extern int ntp_minpkt; 464extern int ntp_minpoll; 465extern int mon_age; /* monitor preempt age */ 466 467/* ntp_timer.c */ 468extern volatile int alarm_flag; /* alarm flag */ 469extern volatile u_long alarm_overflow; 470extern u_long current_time; /* current time (s) */ 471extern u_long timer_timereset; 472extern u_long timer_overflows; 473extern u_long timer_xmtcalls; 474 475/* ntp_util.c */ 476extern int stats_control; /* write stats to fileset? */ 477extern int stats_write_period; /* # of seconds between writes. */ 478extern double stats_write_tolerance; 479 480/* ntpd.c */ 481extern volatile int debug; /* debugging flag */ 482extern int nofork; /* no-fork flag */ 483extern int initializing; /* initializing flag */ 484#ifdef HAVE_DROPROOT 485extern int droproot; /* flag: try to drop root privileges after startup */ 486extern char *user; /* user to switch to */ 487extern char *group; /* group to switch to */ 488extern const char *chrootdir; /* directory to chroot to */ 489#endif 490 491/* refclock_conf.c */ 492#ifdef REFCLOCK 493/* refclock configuration table */ 494extern struct refclock * const refclock_conf[]; 495extern u_char num_refclock_conf; 496#endif 497 498/* ntp_signd.c */ 499#ifdef HAVE_NTP_SIGND 500extern void 501send_via_ntp_signd( 502 struct recvbuf *rbufp, /* receive packet pointer */ 503 int xmode, 504 keyid_t xkeyid, 505 int flags, 506 struct pkt *xpkt 507 ); 508#endif 509