2 * ntpd.h - Prototypes and external variables for ntpd.
4 * Note the first half is primarily function prototypes, type
5 * declarations, and preprocessor macros, with variables declared
6 * primarily in the second half.
8 * Each half is further divided into sections for each source file.
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"
23 * First half: ntpd types, functions, macros
24 * -----------------------------------------
28 * macro for debugging output - cut down on #ifdef pollution.
30 * DPRINTF() is for use by ntpd only, and compiles away to nothing
31 * without DEBUG (configure --disable-debugging).
33 * TRACE() is similar for libntp and utilities, which retain full
34 * debug capability even when compiled without DEBUG.
36 * The calling convention is not attractive:
37 * DPRINTF(debuglevel, (fmt, ...));
38 * DPRINTF(2, ("shows #ifdef DEBUG and if debug >= %d\n", 2));
41 # define DPRINTF(lvl, arg) \
47 # define DPRINTF(lvl, arg) do {} while (0)
53 extern void win_time_stepped(void);
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 */
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 *, ...)
75 * Structure for translation tables between internal system
76 * variable indices and text format.
87 #define CAN_WRITE 0x02
94 #define WO (CAN_WRITE)
95 #define RW (CAN_READ|CAN_WRITE)
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);
104 typedef struct interface_info {
109 typedef void (*interface_receiver_t) (void *, interface_info_t *);
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 *,
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);
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);
132 extern void collect_timing (struct recvbuf *, const char *, int, l_fp *);
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()
141 # define UNBLOCK_IO_AND_ALARM() do {} while (0)
142 # define BLOCK_IO_AND_ALARM() do {} while (0)
144 #define latoa(pif) localaddrtoa(pif)
145 extern const char * localaddrtoa(endpt *);
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;
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);
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 extern void peer_cleanup (void);
195 extern int crypto_recv (struct peer *, struct recvbuf *);
196 extern int crypto_xmit (struct peer *, struct pkt *,
197 struct recvbuf *, int,
198 struct exten *, keyid_t);
199 extern keyid_t session_key (sockaddr_u *, sockaddr_u *, keyid_t,
201 extern int make_keylist (struct peer *, struct interface *);
202 extern void key_expire (struct peer *);
203 extern void crypto_update (void);
204 extern void crypto_config (int, char *);
205 extern void crypto_setup (void);
206 extern u_int crypto_ident (struct peer *);
207 extern struct exten *crypto_args (struct peer *, u_int, associd_t, char *);
208 extern int crypto_public (struct peer *, u_char *, u_int);
209 extern void value_free (struct value *);
210 extern char *iffpar_file;
211 extern EVP_PKEY *iffpar_pkey;
212 extern char *gqpar_file;
213 extern EVP_PKEY *gqpar_pkey;
214 extern char *mvpar_file;
215 extern EVP_PKEY *mvpar_pkey;
216 extern struct value tai_leap;
220 extern void transmit (struct peer *);
221 extern void receive (struct recvbuf *);
222 extern void peer_clear (struct peer *, const char *);
223 extern void process_packet (struct peer *, struct pkt *, u_int);
224 extern void clock_select (void);
226 extern u_long leapsec; /* seconds to next leap (proximity class) */
227 extern int leapdif; /* TAI difference step at next leap second*/
228 extern int sys_orphan;
229 extern double sys_mindisp;
230 extern double sys_maxdist;
232 extern char *sys_ident; /* identity scheme */
233 extern void poll_update (struct peer *, u_char);
235 extern void clear (struct peer *);
236 extern void clock_filter (struct peer *, double, double, double);
237 extern void init_proto (void);
238 extern void set_sys_tick_precision(double);
239 extern void proto_config (int, u_long, double, sockaddr_u *);
240 extern void proto_clr_stats (void);
244 extern int refclock_newpeer (struct peer *);
245 extern void refclock_unpeer (struct peer *);
246 extern void refclock_receive (struct peer *);
247 extern void refclock_transmit (struct peer *);
248 extern void init_refclock (void);
249 #endif /* REFCLOCK */
252 extern void init_request (void);
253 extern void process_private (struct recvbuf *, int);
254 extern void reset_auth_stats(void);
257 extern void init_restrict (void);
258 extern u_short restrictions (sockaddr_u *);
259 extern void hack_restrict (int, sockaddr_u *, sockaddr_u *,
260 u_short, u_short, u_long);
261 extern void restrict_source (sockaddr_u *, int, u_long);
264 extern void init_timer (void);
265 extern void reinit_timer (void);
266 extern void timer (void);
267 extern void timer_clr_stats (void);
268 extern void timer_interfacetimeout (u_long);
269 extern volatile int interface_interval;
270 extern u_long orphwait; /* orphan wait time */
272 extern char *sys_hostname; /* host name */
273 extern char *sys_groupname; /* group name */
274 extern char *group_name; /* group name */
275 extern u_long sys_revoke; /* keys revoke timeout */
276 extern u_long sys_automax; /* session key timeout */
280 extern void init_util (void);
281 extern void write_stats (void);
282 extern void stats_config (int, const char *);
283 extern void record_peer_stats (sockaddr_u *, int, double, double, double, double);
284 extern void record_proto_stats (char *);
285 extern void record_loop_stats (double, double, double, double, int);
286 extern void record_clock_stats (sockaddr_u *, const char *);
287 extern int mprintf_clock_stats(sockaddr_u *, const char *, ...)
289 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);
290 extern void check_leap_file (int is_daily_check, u_int32 ntptime, const time_t * systime);
291 extern void record_crypto_stats (sockaddr_u *, const char *);
293 extern void record_timing_stats (const char *);
295 extern char * fstostr(time_t); /* NTP timescale seconds */
298 extern void parse_cmdline_opts(int *, char ***);
300 * Signals we catch for debugging.
302 #define MOREDEBUGSIG SIGUSR1
303 #define LESSDEBUGSIG SIGUSR2
305 * Signals which terminate us gracefully.
308 # define SIGDIE1 SIGHUP
309 # define SIGDIE2 SIGINT
310 # define SIGDIE3 SIGQUIT
311 # define SIGDIE4 SIGTERM
312 #endif /* SYS_WINNT */
316 * Last half: ntpd variables
317 * -------------------------
321 extern char const * progname;
322 extern char *sys_phone[]; /* ACTS phone numbers */
323 #if defined(HAVE_SCHED_SETSCHEDULER)
324 extern int config_priority_override;
325 extern int config_priority;
327 extern char *ntp_signd_socket;
328 extern struct config_tree_tag *cfg_tree_history;
330 #ifdef BC_LIST_FRAMEWORK_NOT_YET_USED
332 * backwards compatibility flags
334 typedef struct bc_entry_tag {
339 extern bc_entry bc_list[];
343 extern int num_ctl_traps;
344 extern keyid_t ctl_auth_keyid; /* keyid used for authenticating write requests */
347 * Statistic counters to keep track of requests and responses.
349 extern u_long ctltimereset; /* time stats reset */
350 extern u_long numctlreq; /* number of requests we've received */
351 extern u_long numctlbadpkts; /* number of bad control packets */
352 extern u_long numctlresponses; /* number of resp packets sent with data */
353 extern u_long numctlfrags; /* number of fragments sent */
354 extern u_long numctlerrors; /* number of error responses sent */
355 extern u_long numctltooshort; /* number of too short input packets */
356 extern u_long numctlinputresp; /* number of responses on input */
357 extern u_long numctlinputfrag; /* number of fragments on input */
358 extern u_long numctlinputerr; /* number of input pkts with err bit set */
359 extern u_long numctlbadoffset; /* number of input pkts with nonzero offset */
360 extern u_long numctlbadversion; /* number of input pkts with unknown version */
361 extern u_long numctldatatooshort; /* data too short for count */
362 extern u_long numctlbadop; /* bad op code found in packet */
363 extern u_long numasyncmsgs; /* number of async messages we've sent */
366 * Other statistics of possible interest
368 extern volatile u_long packets_dropped; /* total number of packets dropped on reception */
369 extern volatile u_long packets_ignored; /* packets received on wild card interface */
370 extern volatile u_long packets_received;/* total number of packets received */
371 extern u_long packets_sent; /* total number of packets sent */
372 extern u_long packets_notsent; /* total number of packets which couldn't be sent */
374 extern volatile u_long handler_calls; /* number of calls to interrupt handler */
375 extern volatile u_long handler_pkts; /* number of pkts received by handler */
376 extern u_long io_timereset; /* time counters were reset */
379 extern int disable_dynamic_updates;
380 extern u_int sys_ifnum; /* next .ifnum to assign */
381 extern endpt * any_interface; /* IPv4 wildcard */
382 extern endpt * any6_interface; /* IPv6 wildcard */
383 extern endpt * loopback_interface; /* IPv4 loopback for refclocks */
384 extern endpt * ep_list; /* linked list */
386 /* ntp_loopfilter.c */
387 extern double drift_comp; /* clock frequency (s/s) */
388 extern double clock_stability; /* clock stability (s/s) */
389 extern double clock_max_back; /* max backward offset before step (s) */
390 extern double clock_max_fwd; /* max forward offset before step (s) */
391 extern double clock_panic; /* max offset before panic (s) */
392 extern double clock_phi; /* dispersion rate (s/s) */
393 extern double clock_minstep; /* step timeout (s) */
394 extern double clock_codec; /* codec frequency */
396 extern int pll_status; /* status bits for kernel pll */
397 #endif /* KERNEL_PLL */
400 * Clock state machine control flags
402 extern int ntp_enable; /* clock discipline enabled */
403 extern int pll_control; /* kernel support available */
404 extern int kern_enable; /* kernel support enabled */
405 extern int hardpps_enable; /* kernel PPS discipline enabled */
406 extern int ext_enable; /* external clock enabled */
407 extern int cal_enable; /* refclock calibrate enable */
408 extern int allow_panic; /* allow panic correction (-g) */
409 extern int force_step_once; /* always step time once at startup (-G) */
410 extern int mode_ntpdate; /* exit on first clock set (-q) */
411 extern int peer_ntpdate; /* count of ntpdate peers */
414 * Clock state machine variables
416 extern u_char sys_poll; /* system poll interval (log2 s) */
417 extern int state; /* clock discipline state */
418 extern int tc_counter; /* poll-adjust counter */
419 extern u_long last_time; /* time of last clock update (s) */
420 extern double last_offset; /* last clock offset (s) */
421 extern u_char allan_xpt; /* Allan intercept (log2 s) */
422 extern double clock_jitter; /* clock jitter (s) */
423 extern double sys_offset; /* system offset (s) */
424 extern double sys_jitter; /* system jitter (s) */
427 extern u_char mon_hash_bits; /* log2 size of hash table */
428 extern mon_entry ** mon_hash; /* MRU hash table */
429 extern mon_entry mon_mru_list; /* mru listhead */
430 extern u_int mon_enabled; /* MON_OFF (0) or other MON_* */
431 extern u_int mru_alloc; /* mru list + free list count */
432 extern u_int mru_entries; /* mru list count */
433 extern u_int mru_peakentries; /* highest mru_entries */
434 extern u_int mru_initalloc; /* entries to preallocate */
435 extern u_int mru_incalloc; /* allocation batch factor */
436 extern u_int mru_mindepth; /* preempt above this */
437 extern int mru_maxage; /* for entries older than */
438 extern u_int mru_maxdepth; /* MRU size hard limit */
439 extern int mon_age; /* preemption limit */
442 extern struct peer *peer_hash[NTP_HASH_SIZE]; /* peer hash table */
443 extern int peer_hash_count[NTP_HASH_SIZE]; /* count of in each bucket */
444 extern struct peer *assoc_hash[NTP_HASH_SIZE]; /* association ID hash table */
445 extern int assoc_hash_count[NTP_HASH_SIZE];/* count of in each bucket */
446 extern struct peer *peer_list; /* peer structures list */
447 extern int peer_count; /* count in peer_list */
448 extern int peer_free_count; /* count in peer_free */
451 * Miscellaneous statistic counters which may be queried.
453 extern u_long peer_timereset; /* time stat counters were zeroed */
454 extern u_long findpeer_calls; /* number of calls to findpeer */
455 extern u_long assocpeer_calls; /* number of calls to findpeerbyassoc */
456 extern u_long peer_allocations; /* number of allocations from the free list */
457 extern u_long peer_demobilizations; /* number of structs freed to free list */
458 extern int total_peer_structs; /* number of peer structs in circulation */
459 extern int peer_associations; /* mobilized associations */
460 extern int peer_preempt; /* preemptable associations */
464 * System variables are declared here. See Section 3.2 of the
467 extern u_char sys_leap; /* system leap indicator */
468 extern u_char sys_stratum; /* system stratum */
469 extern s_char sys_precision; /* local clock precision */
470 extern double sys_rootdelay; /* roundtrip delay to primary source */
471 extern double sys_rootdisp; /* dispersion to primary source */
472 extern u_int32 sys_refid; /* reference id */
473 extern l_fp sys_reftime; /* last update time */
474 extern struct peer *sys_peer; /* current peer */
477 * Nonspecified system state variables.
479 extern int sys_bclient; /* we set our time to broadcasts */
480 extern double sys_bdelay; /* broadcast client default delay */
481 extern int sys_authenticate; /* requre authentication for config */
482 extern l_fp sys_authdelay; /* authentication delay */
483 extern u_long sys_epoch; /* last clock update time */
484 extern keyid_t sys_private; /* private value for session seed */
485 extern int sys_manycastserver; /* respond to manycast client pkts */
486 extern int sys_minclock; /* minimum survivors */
487 extern int sys_minsane; /* minimum candidates */
488 extern int sys_floor; /* cluster stratum floor */
489 extern int sys_ceiling; /* cluster stratum ceiling */
490 extern u_char sys_ttl[MAX_TTL]; /* ttl mapping vector */
491 extern int sys_ttlmax; /* max ttl mapping vector index */
494 * Statistics counters
496 extern u_long sys_stattime; /* time since reset */
497 extern u_long sys_received; /* packets received */
498 extern u_long sys_processed; /* packets for this host */
499 extern u_long sys_restricted; /* restricted packets */
500 extern u_long sys_newversion; /* current version */
501 extern u_long sys_oldversion; /* old version */
502 extern u_long sys_restricted; /* access denied */
503 extern u_long sys_badlength; /* bad length or format */
504 extern u_long sys_badauth; /* bad authentication */
505 extern u_long sys_declined; /* declined */
506 extern u_long sys_limitrejected; /* rate exceeded */
507 extern u_long sys_kodsent; /* KoD sent */
510 extern keyid_t info_auth_keyid; /* keyid used to authenticate requests */
511 extern u_long auth_timereset;
514 extern restrict_u * restrictlist4; /* IPv4 restriction list */
515 extern restrict_u * restrictlist6; /* IPv6 restriction list */
516 extern int ntp_minpkt;
517 extern u_char ntp_minpoll;
520 extern u_int32 conf_file_sum; /* Simple sum of characters */
523 #ifdef HAVE_NTP_SIGND
524 extern void send_via_ntp_signd(struct recvbuf *, int, keyid_t, int,
529 extern volatile int alarm_flag; /* alarm flag */
530 extern volatile u_long alarm_overflow;
531 extern u_long current_time; /* seconds since startup */
532 extern u_long timer_timereset;
533 extern u_long timer_overflows;
534 extern u_long timer_xmtcalls;
536 HANDLE WaitableTimerHandle;
540 extern char statsdir[MAXFILENAME];
541 extern int stats_control; /* write stats to fileset? */
542 extern int stats_write_period; /* # of seconds between writes. */
543 extern double stats_write_tolerance;
544 extern double wander_threshold;
547 extern int nofork; /* no-fork flag */
548 extern int initializing; /* initializing flag */
550 extern int droproot; /* flag: try to drop root privileges after startup */
551 extern int root_dropped; /* root has been dropped */
552 extern char *user; /* user to switch to */
553 extern char *group; /* group to switch to */
554 extern const char *chrootdir; /* directory to chroot() to */
556 #ifdef HAVE_WORKING_FORK
557 extern int waitsync_fd_to_close; /* -w/--wait-sync */
562 extern int accept_wildcard_if_for_winnt;
565 /* refclock_conf.c */
567 /* refclock configuration table */
568 extern struct refclock * const refclock_conf[];
569 extern u_char num_refclock_conf;