1/* $NetBSD: ntpd.h,v 1.12 2020/05/25 20:47:20 christos Exp $ */ 2 3/* 4 * ntpd.h - Prototypes and external variables for ntpd. 5 * 6 * Note the first half is primarily function prototypes, type 7 * declarations, and preprocessor macros, with variables declared 8 * primarily in the second half. 9 * 10 * Each half is further divided into sections for each source file. 11 */ 12 13#include "ntp.h" 14#include "ntp_stdlib.h" 15#include "ntp_syslog.h" 16#include "ntp_debug.h" 17#include "ntp_syslog.h" 18#include "ntp_select.h" 19#include "ntp_malloc.h" 20#include "ntp_refclock.h" 21#include "ntp_intres.h" 22#include "recvbuff.h" 23 24/* 25 * First half: ntpd types, functions, macros 26 * ----------------------------------------- 27 */ 28 29/* 30 * macro for debugging output - cut down on #ifdef pollution. 31 * 32 * DPRINTF() is for use by ntpd only, and compiles away to nothing 33 * without DEBUG (configure --disable-debugging). 34 * 35 * TRACE() is similar for libntp and utilities, which retain full 36 * debug capability even when compiled without DEBUG. 37 * 38 * The calling convention is not attractive: 39 * DPRINTF(debuglevel, (fmt, ...)); 40 * DPRINTF(2, ("shows #ifdef DEBUG and if debug >= %d\n", 2)); 41 */ 42#ifdef DEBUG 43# define DPRINTF(lvl, arg) \ 44 do { \ 45 if (debug >= (lvl)) \ 46 mprintf arg; \ 47 } while (0) 48#else 49# define DPRINTF(lvl, arg) do {} while (0) 50#endif 51 52 53/* nt_clockstuff.c */ 54#ifdef SYS_WINNT 55extern void win_time_stepped(void); 56#endif 57 58/* ntp_config.c */ 59#define TAI_1972 10 /* initial TAI offset (s) */ 60extern char *keysdir; /* crypto keys and leaptable directory */ 61extern char * saveconfigdir; /* ntpq saveconfig output directory */ 62 63extern void getconfig (int, char **); 64extern void ctl_clr_stats (void); 65extern int ctlclrtrap (sockaddr_u *, struct interface *, int); 66extern u_short ctlpeerstatus (struct peer *); 67extern int ctlsettrap (sockaddr_u *, struct interface *, int, int); 68extern u_short ctlsysstatus (void); 69extern void init_control (void); 70extern void process_control (struct recvbuf *, int); 71extern void report_event (int, struct peer *, const char *); 72extern int mprintf_event (int, struct peer *, const char *, ...) 73 NTP_PRINTF(3, 4); 74 75/* ntp_control.c */ 76/* 77 * Structure for translation tables between internal system 78 * variable indices and text format. 79 */ 80struct ctl_var { 81 u_short code; 82 u_short flags; 83 const char *text; 84}; 85/* 86 * Flag values 87 */ 88#define CAN_READ 0x01 89#define CAN_WRITE 0x02 90 91#define DEF 0x20 92#define PADDING 0x40 93#define EOV 0x80 94 95#define RO (CAN_READ) 96#define WO (CAN_WRITE) 97#define RW (CAN_READ|CAN_WRITE) 98 99extern char * add_var (struct ctl_var **, u_long, u_short); 100extern void free_varlist (struct ctl_var *); 101extern void set_var (struct ctl_var **, const char *, u_long, u_short); 102extern void set_sys_var (const char *, u_long, u_short); 103extern const char * get_ext_sys_var(const char *tag); 104 105/* ntp_io.c */ 106typedef struct interface_info { 107 endpt * ep; 108 u_char action; 109} interface_info_t; 110 111typedef void (*interface_receiver_t) (void *, interface_info_t *); 112 113extern void interface_enumerate (interface_receiver_t, void *); 114extern endpt * getinterface (sockaddr_u *, u_int32); 115extern endpt * select_peerinterface (struct peer *, sockaddr_u *, 116 endpt *); 117extern endpt * findinterface (sockaddr_u *); 118extern endpt * findbcastinter (sockaddr_u *); 119extern void enable_broadcast (endpt *, sockaddr_u *); 120extern void enable_multicast_if (endpt *, sockaddr_u *); 121extern void interface_update (interface_receiver_t, void *); 122#ifndef HAVE_IO_COMPLETION_PORT 123extern void io_handler (void); 124#endif 125extern void init_io (void); 126extern void io_open_sockets (void); 127extern void io_clr_stats (void); 128extern void io_setbclient (void); 129extern void io_unsetbclient (void); 130extern void io_multicast_add(sockaddr_u *); 131extern void io_multicast_del(sockaddr_u *); 132extern void sendpkt (sockaddr_u *, struct interface *, int, struct pkt *, int); 133#ifdef DEBUG 134extern void collect_timing (struct recvbuf *, const char *, int, l_fp *); 135#endif 136#ifdef HAVE_SIGNALED_IO 137extern void wait_for_signal (void); 138extern void unblock_io_and_alarm (void); 139extern void block_io_and_alarm (void); 140# define UNBLOCK_IO_AND_ALARM() unblock_io_and_alarm() 141# define BLOCK_IO_AND_ALARM() block_io_and_alarm() 142#else 143# define UNBLOCK_IO_AND_ALARM() do {} while (0) 144# define BLOCK_IO_AND_ALARM() do {} while (0) 145#endif 146#define latoa(pif) localaddrtoa(pif) 147extern const char * localaddrtoa(endpt *); 148 149/* ntp_loopfilter.c */ 150extern void init_loopfilter(void); 151extern int local_clock(struct peer *, double); 152extern void adj_host_clock(void); 153extern void loop_config(int, double); 154extern void select_loop(int); 155extern void huffpuff(void); 156extern u_long sys_clocktime; 157extern u_int sys_tai; 158extern int freq_cnt; 159 160/* ntp_monitor.c */ 161#define MON_HASH_SIZE ((size_t)1U << mon_hash_bits) 162#define MON_HASH_MASK (MON_HASH_SIZE - 1) 163#define MON_HASH(addr) (sock_hash(addr) & MON_HASH_MASK) 164extern void init_mon (void); 165extern void mon_start (int); 166extern void mon_stop (int); 167extern u_short ntp_monitor (struct recvbuf *, u_short); 168extern void mon_clearinterface(endpt *interface); 169 170/* ntp_peer.c */ 171extern void init_peer (void); 172extern struct peer *findexistingpeer(sockaddr_u *, const char *, 173 struct peer *, int, u_char, int *); 174extern struct peer *findpeer (struct recvbuf *, int, int *); 175extern struct peer *findpeerbyassoc(associd_t); 176extern void set_peerdstadr (struct peer *, endpt *); 177extern struct peer *newpeer (sockaddr_u *, const char *, endpt *, 178 int, u_char, u_char, u_char, u_char, 179 u_int, u_char, u_int32, 180 keyid_t, const char *); 181extern void peer_all_reset (void); 182extern void peer_clr_stats (void); 183extern struct peer *peer_config(sockaddr_u *, const char *, endpt *, 184 int, u_char, u_char, u_char, u_char, 185 u_int, u_int32, 186 keyid_t, const char *); 187extern void peer_reset (struct peer *); 188extern void refresh_all_peerinterfaces(void); 189extern void unpeer (struct peer *); 190extern void clear_all (void); 191extern int score_all (struct peer *); 192extern struct peer *findmanycastpeer(struct recvbuf *); 193extern void peer_cleanup (void); 194 195/* ntp_crypto.c */ 196#ifdef AUTOKEY 197extern int crypto_recv (struct peer *, struct recvbuf *); 198extern int crypto_xmit (struct peer *, struct pkt *, 199 struct recvbuf *, int, 200 struct exten *, keyid_t); 201extern keyid_t session_key (sockaddr_u *, sockaddr_u *, keyid_t, 202 keyid_t, u_long); 203extern int make_keylist (struct peer *, struct interface *); 204extern void key_expire (struct peer *); 205extern void crypto_update (void); 206extern void crypto_update_taichange(void); 207extern void crypto_config (int, char *); 208extern void crypto_setup (void); 209extern u_int crypto_ident (struct peer *); 210extern struct exten *crypto_args (struct peer *, u_int, associd_t, char *); 211extern int crypto_public (struct peer *, u_char *, u_int); 212extern void value_free (struct value *); 213extern char *iffpar_file; 214extern EVP_PKEY *iffpar_pkey; 215extern char *gqpar_file; 216extern EVP_PKEY *gqpar_pkey; 217extern char *mvpar_file; 218extern EVP_PKEY *mvpar_pkey; 219extern struct value tai_leap; 220#endif /* AUTOKEY */ 221 222/* ntp_proto.c */ 223extern void transmit (struct peer *); 224extern void receive (struct recvbuf *); 225extern void peer_clear (struct peer *, const char *); 226extern void process_packet (struct peer *, struct pkt *, u_int); 227extern void clock_select (void); 228extern void set_sys_leap (u_char); 229 230extern u_long leapsec; /* seconds to next leap (proximity class) */ 231extern int leapdif; /* TAI difference step at next leap second*/ 232extern int sys_orphan; 233extern double sys_mindisp; 234extern double sys_maxdist; 235 236extern char *sys_ident; /* identity scheme */ 237extern void poll_update (struct peer *, u_char, u_char); 238 239extern void clear (struct peer *); 240extern void clock_filter (struct peer *, double, double, double); 241extern void init_proto (void); 242extern void set_sys_tick_precision(double); 243extern void proto_config (int, u_long, double, sockaddr_u *); 244extern void proto_clr_stats (void); 245 246/* ntp_refclock.c */ 247#ifdef REFCLOCK 248extern int refclock_newpeer (struct peer *); 249extern void refclock_unpeer (struct peer *); 250extern void refclock_receive (struct peer *); 251extern void refclock_transmit (struct peer *); 252extern void init_refclock (void); 253#endif /* REFCLOCK */ 254 255/* ntp_request.c */ 256extern void init_request (void); 257extern void process_private (struct recvbuf *, int); 258extern void reset_auth_stats(void); 259 260/* ntp_restrict.c */ 261extern void init_restrict (void); 262extern void restrictions (sockaddr_u *, r4addr *); 263extern void hack_restrict (restrict_op, sockaddr_u *, sockaddr_u *, 264 short, u_short, u_short, u_long); 265extern void restrict_source (sockaddr_u *, int, u_long); 266extern void dump_restricts (void); 267 268/* ntp_timer.c */ 269extern void init_timer (void); 270extern void reinit_timer (void); 271extern void timer (void); 272extern void timer_clr_stats (void); 273extern void timer_interfacetimeout (u_long); 274extern volatile int interface_interval; 275extern u_long orphwait; /* orphan wait time */ 276#ifdef AUTOKEY 277extern char *sys_hostname; /* host name */ 278extern char *sys_groupname; /* group name */ 279extern char *group_name; /* group name */ 280extern u_char sys_revoke; /* keys revoke timeout */ 281extern u_char sys_automax; /* session key timeout */ 282#endif /* AUTOKEY */ 283 284/* ntp_util.c */ 285extern void init_util (void); 286extern void write_stats (void); 287extern void stats_config (int, const char *, int optflag); 288extern void record_peer_stats (sockaddr_u *, int, double, double, double, double); 289extern void record_proto_stats (char *); 290extern void record_loop_stats (double, double, double, double, int); 291extern void record_clock_stats (sockaddr_u *, const char *); 292extern int mprintf_clock_stats(sockaddr_u *, const char *, ...) 293 NTP_PRINTF(2, 3); 294extern void record_raw_stats (sockaddr_u *srcadr, sockaddr_u *dstadr, l_fp *t1, l_fp *t2, l_fp *t3, l_fp *t4, int leap, int version, int mode, int stratum, int ppoll, int precision, double root_delay, double root_dispersion, u_int32 refid, int len, u_char *extra); 295extern void check_leap_file (int is_daily_check, u_int32 ntptime, const time_t * systime); 296extern void record_crypto_stats (sockaddr_u *, const char *); 297#ifdef DEBUG 298extern void record_timing_stats (const char *); 299#endif 300extern char * fstostr(time_t); /* NTP timescale seconds */ 301 302/* ntpd.c */ 303extern void parse_cmdline_opts(int *, char ***); 304/* 305 * Signals we catch for debugging. 306 */ 307#define MOREDEBUGSIG SIGUSR1 308#define LESSDEBUGSIG SIGUSR2 309/* 310 * Signals which terminate us gracefully. 311 */ 312#ifndef SYS_WINNT 313# define SIGDIE1 SIGHUP 314# define SIGDIE2 SIGINT 315# define SIGDIE3 SIGQUIT 316# define SIGDIE4 SIGTERM 317#endif /* SYS_WINNT */ 318 319 320/* 321 * Last half: ntpd variables 322 * ------------------------- 323 */ 324 325/* ntp_config.c */ 326extern char const * progname; 327extern int saved_argc; 328extern char **saved_argv; 329extern char *sys_phone[]; /* ACTS phone numbers */ 330#if defined(HAVE_SCHED_SETSCHEDULER) 331extern int config_priority_override; 332extern int config_priority; 333#endif 334extern char *ntp_signd_socket; 335extern struct config_tree_tag *cfg_tree_history; 336 337#ifdef BC_LIST_FRAMEWORK_NOT_YET_USED 338/* 339 * backwards compatibility flags 340 */ 341typedef struct bc_entry_tag { 342 int token; 343 int enabled; 344} bc_entry; 345 346extern bc_entry bc_list[]; 347#endif 348 349/* ntp_control.c */ 350extern int num_ctl_traps; 351extern keyid_t ctl_auth_keyid; /* keyid used for authenticating write requests */ 352 353/* 354 * Statistic counters to keep track of requests and responses. 355 */ 356extern u_long ctltimereset; /* time stats reset */ 357extern u_long numctlreq; /* number of requests we've received */ 358extern u_long numctlbadpkts; /* number of bad control packets */ 359extern u_long numctlresponses; /* number of resp packets sent with data */ 360extern u_long numctlfrags; /* number of fragments sent */ 361extern u_long numctlerrors; /* number of error responses sent */ 362extern u_long numctltooshort; /* number of too short input packets */ 363extern u_long numctlinputresp; /* number of responses on input */ 364extern u_long numctlinputfrag; /* number of fragments on input */ 365extern u_long numctlinputerr; /* number of input pkts with err bit set */ 366extern u_long numctlbadoffset; /* number of input pkts with nonzero offset */ 367extern u_long numctlbadversion; /* number of input pkts with unknown version */ 368extern u_long numctldatatooshort; /* data too short for count */ 369extern u_long numctlbadop; /* bad op code found in packet */ 370extern u_long numasyncmsgs; /* number of async messages we've sent */ 371 372/* 373 * Other statistics of possible interest 374 */ 375extern volatile u_long packets_dropped; /* total number of packets dropped on reception */ 376extern volatile u_long packets_ignored; /* packets received on wild card interface */ 377extern volatile u_long packets_received;/* total number of packets received */ 378extern u_long packets_sent; /* total number of packets sent */ 379extern u_long packets_notsent; /* total number of packets which couldn't be sent */ 380 381extern volatile u_long handler_calls; /* number of calls to interrupt handler */ 382extern volatile u_long handler_pkts; /* number of pkts received by handler */ 383extern u_long io_timereset; /* time counters were reset */ 384 385/* ntp_io.c */ 386extern int disable_dynamic_updates; 387extern u_int sys_ifnum; /* next .ifnum to assign */ 388extern endpt * any_interface; /* IPv4 wildcard */ 389extern endpt * any6_interface; /* IPv6 wildcard */ 390extern endpt * loopback_interface; /* IPv4 loopback for refclocks */ 391extern endpt * ep_list; /* linked list */ 392 393/* ntp_loopfilter.c */ 394extern double drift_comp; /* clock frequency (s/s) */ 395extern double clock_stability; /* clock stability (s/s) */ 396extern double clock_max_back; /* max backward offset before step (s) */ 397extern double clock_max_fwd; /* max forward offset before step (s) */ 398extern double clock_panic; /* max offset before panic (s) */ 399extern double clock_phi; /* dispersion rate (s/s) */ 400extern double clock_minstep; /* step timeout (s) */ 401extern double clock_codec; /* codec frequency */ 402#ifdef KERNEL_PLL 403extern int pll_status; /* status bits for kernel pll */ 404#endif /* KERNEL_PLL */ 405 406/* 407 * Clock state machine control flags 408 */ 409extern int ntp_enable; /* clock discipline enabled */ 410extern int pll_control; /* kernel support available */ 411extern int kern_enable; /* kernel support enabled */ 412extern int hardpps_enable; /* kernel PPS discipline enabled */ 413extern int ext_enable; /* external clock enabled */ 414extern int cal_enable; /* refclock calibrate enable */ 415extern int allow_panic; /* allow panic correction (-g) */ 416extern int enable_panic_check; /* Can we check allow_panic's state? */ 417extern int force_step_once; /* always step time once at startup (-G) */ 418extern int mode_ntpdate; /* exit on first clock set (-q) */ 419extern int peer_ntpdate; /* count of ntpdate peers */ 420 421/* 422 * Clock state machine variables 423 */ 424extern u_char sys_poll; /* system poll interval (log2 s) */ 425extern int state; /* clock discipline state */ 426extern int tc_counter; /* poll-adjust counter */ 427extern u_long last_time; /* time of last clock update (s) */ 428extern double last_offset; /* last clock offset (s) */ 429extern u_char allan_xpt; /* Allan intercept (log2 s) */ 430extern double clock_jitter; /* clock jitter (s) */ 431extern double sys_offset; /* system offset (s) */ 432extern double sys_jitter; /* system jitter (s) */ 433 434/* ntp_monitor.c */ 435extern u_char mon_hash_bits; /* log2 size of hash table */ 436extern mon_entry ** mon_hash; /* MRU hash table */ 437extern mon_entry mon_mru_list; /* mru listhead */ 438extern u_int mon_enabled; /* MON_OFF (0) or other MON_* */ 439extern u_int mru_alloc; /* mru list + free list count */ 440extern u_int mru_entries; /* mru list count */ 441extern u_int mru_peakentries; /* highest mru_entries */ 442extern u_int mru_initalloc; /* entries to preallocate */ 443extern u_int mru_incalloc; /* allocation batch factor */ 444extern u_int mru_mindepth; /* preempt above this */ 445extern int mru_maxage; /* for entries older than */ 446extern u_int mru_maxdepth; /* MRU size hard limit */ 447extern int mon_age; /* preemption limit */ 448 449/* ntp_peer.c */ 450extern struct peer *peer_hash[NTP_HASH_SIZE]; /* peer hash table */ 451extern int peer_hash_count[NTP_HASH_SIZE]; /* count of in each bucket */ 452extern struct peer *assoc_hash[NTP_HASH_SIZE]; /* association ID hash table */ 453extern int assoc_hash_count[NTP_HASH_SIZE];/* count of in each bucket */ 454extern struct peer *peer_list; /* peer structures list */ 455extern int peer_count; /* count in peer_list */ 456extern int peer_free_count; /* count in peer_free */ 457 458/* 459 * Miscellaneous statistic counters which may be queried. 460 */ 461extern u_long peer_timereset; /* time stat counters were zeroed */ 462extern u_long findpeer_calls; /* number of calls to findpeer */ 463extern u_long assocpeer_calls; /* number of calls to findpeerbyassoc */ 464extern u_long peer_allocations; /* number of allocations from the free list */ 465extern u_long peer_demobilizations; /* number of structs freed to free list */ 466extern int total_peer_structs; /* number of peer structs in circulation */ 467extern int peer_associations; /* mobilized associations */ 468extern int peer_preempt; /* preemptable associations */ 469 470/* ntp_proto.c */ 471/* 472 * System variables are declared here. See Section 3.2 of the 473 * specification. 474 */ 475extern u_char sys_leap; /* system leap indicator */ 476extern u_char sys_stratum; /* system stratum */ 477extern s_char sys_precision; /* local clock precision */ 478extern double sys_rootdelay; /* roundtrip delay to primary source */ 479extern double sys_rootdisp; /* dispersion to primary source */ 480extern u_int32 sys_refid; /* reference id */ 481extern l_fp sys_reftime; /* last update time */ 482extern struct peer *sys_peer; /* current peer */ 483 484/* 485 * Nonspecified system state variables. 486 */ 487extern int sys_bclient; /* we set our time to broadcasts */ 488extern double sys_bdelay; /* broadcast client default delay */ 489extern int sys_authenticate; /* requre authentication for config */ 490extern l_fp sys_authdelay; /* authentication delay */ 491extern u_char sys_bcpollbstep; /* broadcast poll backstep gate */ 492extern u_long sys_epoch; /* last clock update time */ 493extern keyid_t sys_private; /* private value for session seed */ 494extern int sys_manycastserver; /* respond to manycast client pkts */ 495extern int sys_maxclock; /* maximum survivors */ 496extern int sys_minclock; /* minimum survivors */ 497extern int sys_minsane; /* minimum candidates */ 498extern int sys_floor; /* cluster stratum floor */ 499extern int sys_ceiling; /* cluster stratum ceiling */ 500extern u_char sys_ttl[MAX_TTL]; /* ttl mapping vector */ 501extern u_int sys_ttlmax; /* max ttl mapping vector index */ 502 503/* 504 * Statistics counters 505 */ 506extern u_long sys_badauth; /* bad authentication */ 507extern u_long sys_badlength; /* bad length or format */ 508extern u_long sys_declined; /* declined */ 509extern u_long sys_kodsent; /* KoD sent */ 510extern u_long sys_lamport; /* Lamport violation */ 511extern u_long sys_limitrejected; /* rate exceeded */ 512extern u_long sys_newversion; /* current version */ 513extern u_long sys_oldversion; /* old version */ 514extern u_long sys_processed; /* packets for this host */ 515extern u_long sys_received; /* packets received */ 516extern u_long sys_restricted; /* access denied */ 517extern u_long sys_stattime; /* time since reset */ 518extern u_long sys_tsrounding; /* timestamp rounding errors */ 519 520/* ntp_request.c */ 521extern keyid_t info_auth_keyid; /* keyid used to authenticate requests */ 522extern u_long auth_timereset; 523 524/* ntp_restrict.c */ 525extern restrict_u * restrictlist4; /* IPv4 restriction list */ 526extern restrict_u * restrictlist6; /* IPv6 restriction list */ 527extern int ntp_minpkt; 528extern u_char ntp_minpoll; 529 530/* ntp_scanner.c */ 531extern u_int32 conf_file_sum; /* Simple sum of characters */ 532 533/* ntp_signd.c */ 534#ifdef HAVE_NTP_SIGND 535extern void send_via_ntp_signd(struct recvbuf *, int, keyid_t, int, 536 struct pkt *); 537#endif 538 539/* ntp_timer.c */ 540extern volatile int alarm_flag; /* alarm flag */ 541extern volatile u_long alarm_overflow; 542extern u_long current_time; /* seconds since startup */ 543extern u_long timer_timereset; 544extern u_long timer_overflows; 545extern u_long timer_xmtcalls; 546extern int leap_sec_in_progress; 547#ifdef LEAP_SMEAR 548extern struct leap_smear_info leap_smear; 549extern int leap_smear_intv; 550#endif 551#ifdef SYS_WINNT 552HANDLE WaitableTimerHandle; 553#endif 554 555/* ntp_util.c */ 556extern char statsdir[MAXFILENAME]; 557extern int stats_control; /* write stats to fileset? */ 558extern int stats_write_period; /* # of seconds between writes. */ 559extern double stats_write_tolerance; 560extern double wander_threshold; 561 562/* ntpd.c */ 563extern int nofork; /* no-fork flag */ 564extern int initializing; /* initializing flag */ 565#ifdef HAVE_DROPROOT 566extern int droproot; /* flag: try to drop root privileges after startup */ 567extern int root_dropped; /* root has been dropped */ 568extern char *user; /* user to switch to */ 569extern char *group; /* group to switch to */ 570extern const char *chrootdir; /* directory to chroot() to */ 571#endif 572#ifdef HAVE_WORKING_FORK 573extern int daemon_pipe[2]; /* startup monitoring */ 574#endif 575 576/* ntservice.c */ 577#ifdef SYS_WINNT 578extern int accept_wildcard_if_for_winnt; 579#endif 580 581/* refclock_conf.c */ 582#ifdef REFCLOCK 583/* refclock configuration table */ 584extern struct refclock * const refclock_conf[]; 585extern u_char num_refclock_conf; 586#endif 587 588