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