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