diff options
Diffstat (limited to 'include/ntpd.h')
| -rw-r--r-- | include/ntpd.h | 568 |
1 files changed, 568 insertions, 0 deletions
diff --git a/include/ntpd.h b/include/ntpd.h new file mode 100644 index 0000000..51d8f2a --- /dev/null +++ b/include/ntpd.h @@ -0,0 +1,568 @@ +/* + * ntpd.h - Prototypes and external variables for ntpd. + * + * Note the first half is primarily function prototypes, type + * declarations, and preprocessor macros, with variables declared + * primarily in the second half. + * + * Each half is further divided into sections for each source file. + */ + +#include "ntp.h" +#include "ntp_stdlib.h" +#include "ntp_syslog.h" +#include "ntp_debug.h" +#include "ntp_syslog.h" +#include "ntp_select.h" +#include "ntp_malloc.h" +#include "ntp_refclock.h" +#include "ntp_intres.h" +#include "recvbuff.h" + +/* + * First half: ntpd types, functions, macros + * ----------------------------------------- + */ + +/* + * macro for debugging output - cut down on #ifdef pollution. + * + * DPRINTF() is for use by ntpd only, and compiles away to nothing + * without DEBUG (configure --disable-debugging). + * + * TRACE() is similar for libntp and utilities, which retain full + * debug capability even when compiled without DEBUG. + * + * The calling convention is not attractive: + * DPRINTF(debuglevel, (fmt, ...)); + * DPRINTF(2, ("shows #ifdef DEBUG and if debug >= %d\n", 2)); + */ +#ifdef DEBUG +# define DPRINTF(lvl, arg) \ + do { \ + if (debug >= (lvl)) \ + mprintf arg; \ + } while (0) +#else +# define DPRINTF(lvl, arg) do {} while (0) +#endif + + +/* nt_clockstuff.c */ +#ifdef SYS_WINNT +extern void win_time_stepped(void); +#endif + +/* ntp_config.c */ +#define TAI_1972 10 /* initial TAI offset (s) */ +extern char *keysdir; /* crypto keys and leaptable directory */ +extern char * saveconfigdir; /* ntpq saveconfig output directory */ + +extern void getconfig (int, char **); +extern void ctl_clr_stats (void); +extern int ctlclrtrap (sockaddr_u *, struct interface *, int); +extern u_short ctlpeerstatus (struct peer *); +extern int ctlsettrap (sockaddr_u *, struct interface *, int, int); +extern u_short ctlsysstatus (void); +extern void init_control (void); +extern void process_control (struct recvbuf *, int); +extern void report_event (int, struct peer *, const char *); +extern int mprintf_event (int, struct peer *, const char *, ...) + NTP_PRINTF(3, 4); + +/* ntp_control.c */ +/* + * Structure for translation tables between internal system + * variable indices and text format. + */ +struct ctl_var { + u_short code; + u_short flags; + char *text; +}; +/* + * Flag values + */ +#define CAN_READ 0x01 +#define CAN_WRITE 0x02 + +#define DEF 0x20 +#define PADDING 0x40 +#define EOV 0x80 + +#define RO (CAN_READ) +#define WO (CAN_WRITE) +#define RW (CAN_READ|CAN_WRITE) + +extern char * add_var (struct ctl_var **, u_long, u_short); +extern void free_varlist (struct ctl_var *); +extern void set_var (struct ctl_var **, const char *, u_long, u_short); +extern void set_sys_var (const char *, u_long, u_short); +extern const char * get_ext_sys_var(const char *tag); + +/* ntp_io.c */ +typedef struct interface_info { + endpt * ep; + u_char action; +} interface_info_t; + +typedef void (*interface_receiver_t) (void *, interface_info_t *); + +extern void interface_enumerate (interface_receiver_t, void *); +extern endpt * getinterface (sockaddr_u *, u_int32); +extern endpt * select_peerinterface (struct peer *, sockaddr_u *, + endpt *); +extern endpt * findinterface (sockaddr_u *); +extern endpt * findbcastinter (sockaddr_u *); +extern void enable_broadcast (endpt *, sockaddr_u *); +extern void enable_multicast_if (endpt *, sockaddr_u *); +extern void interface_update (interface_receiver_t, void *); +#ifndef HAVE_IO_COMPLETION_PORT +extern void io_handler (void); +#endif +extern void init_io (void); +extern void io_open_sockets (void); +extern void io_clr_stats (void); +extern void io_setbclient (void); +extern void io_unsetbclient (void); +extern void io_multicast_add(sockaddr_u *); +extern void io_multicast_del(sockaddr_u *); +extern void sendpkt (sockaddr_u *, struct interface *, int, struct pkt *, int); +#ifdef DEBUG +extern void collect_timing (struct recvbuf *, const char *, int, l_fp *); +#endif +#ifdef HAVE_SIGNALED_IO +extern void wait_for_signal (void); +extern void unblock_io_and_alarm (void); +extern void block_io_and_alarm (void); +# define UNBLOCK_IO_AND_ALARM() unblock_io_and_alarm() +# define BLOCK_IO_AND_ALARM() block_io_and_alarm() +#else +# define UNBLOCK_IO_AND_ALARM() do {} while (0) +# define BLOCK_IO_AND_ALARM() do {} while (0) +#endif +#define latoa(pif) localaddrtoa(pif) +extern const char * localaddrtoa(endpt *); + +/* ntp_loopfilter.c */ +extern void init_loopfilter(void); +extern int local_clock(struct peer *, double); +extern void adj_host_clock(void); +extern void loop_config(int, double); +extern void select_loop(int); +extern void huffpuff(void); +extern u_long sys_clocktime; +extern u_int sys_tai; +extern int freq_cnt; + +/* ntp_monitor.c */ +#define MON_HASH_SIZE (1U << mon_hash_bits) +#define MON_HASH_MASK (MON_HASH_SIZE - 1) +#define MON_HASH(addr) (sock_hash(addr) & MON_HASH_MASK) +extern void init_mon (void); +extern void mon_start (int); +extern void mon_stop (int); +extern u_short ntp_monitor (struct recvbuf *, u_short); +extern void mon_clearinterface(endpt *interface); + +/* ntp_peer.c */ +extern void init_peer (void); +extern struct peer *findexistingpeer(sockaddr_u *, const char *, + struct peer *, int, u_char); +extern struct peer *findpeer (struct recvbuf *, int, int *); +extern struct peer *findpeerbyassoc(associd_t); +extern void set_peerdstadr (struct peer *, endpt *); +extern struct peer *newpeer (sockaddr_u *, const char *, + endpt *, u_char, u_char, + u_char, u_char, u_int, u_char, u_int32, + keyid_t, const char *); +extern void peer_all_reset (void); +extern void peer_clr_stats (void); +extern struct peer *peer_config(sockaddr_u *, const char *, + endpt *, u_char, u_char, + u_char, u_char, u_int, u_int32, + keyid_t, const char *); +extern void peer_reset (struct peer *); +extern void refresh_all_peerinterfaces(void); +extern void unpeer (struct peer *); +extern void clear_all (void); +extern int score_all (struct peer *); +extern struct peer *findmanycastpeer(struct recvbuf *); + +/* ntp_crypto.c */ +#ifdef AUTOKEY +extern int crypto_recv (struct peer *, struct recvbuf *); +extern int crypto_xmit (struct peer *, struct pkt *, + struct recvbuf *, int, + struct exten *, keyid_t); +extern keyid_t session_key (sockaddr_u *, sockaddr_u *, keyid_t, + keyid_t, u_long); +extern int make_keylist (struct peer *, struct interface *); +extern void key_expire (struct peer *); +extern void crypto_update (void); +extern void crypto_config (int, char *); +extern void crypto_setup (void); +extern u_int crypto_ident (struct peer *); +extern struct exten *crypto_args (struct peer *, u_int, associd_t, char *); +extern int crypto_public (struct peer *, u_char *, u_int); +extern void value_free (struct value *); +extern char *iffpar_file; +extern EVP_PKEY *iffpar_pkey; +extern char *gqpar_file; +extern EVP_PKEY *gqpar_pkey; +extern char *mvpar_file; +extern EVP_PKEY *mvpar_pkey; +extern struct value tai_leap; +#endif /* AUTOKEY */ + +/* ntp_proto.c */ +extern void transmit (struct peer *); +extern void receive (struct recvbuf *); +extern void peer_clear (struct peer *, char *); +extern void process_packet (struct peer *, struct pkt *, u_int); +extern void clock_select (void); + +extern u_long leapsec; /* seconds to next leap (proximity class) */ +extern int leapdif; /* TAI difference step at next leap second*/ +extern int sys_orphan; +extern double sys_mindisp; +extern double sys_maxdist; + +extern char *sys_ident; /* identity scheme */ +extern void poll_update (struct peer *, u_char); + +extern void clear (struct peer *); +extern void clock_filter (struct peer *, double, double, double); +extern void init_proto (void); +extern void set_sys_tick_precision(double); +extern void proto_config (int, u_long, double, sockaddr_u *); +extern void proto_clr_stats (void); + +/* ntp_refclock.c */ +#ifdef REFCLOCK +extern int refclock_newpeer (struct peer *); +extern void refclock_unpeer (struct peer *); +extern void refclock_receive (struct peer *); +extern void refclock_transmit (struct peer *); +extern void init_refclock (void); +#endif /* REFCLOCK */ + +/* ntp_request.c */ +extern void init_request (void); +extern void process_private (struct recvbuf *, int); +extern void reset_auth_stats(void); + +/* ntp_restrict.c */ +extern void init_restrict (void); +extern u_short restrictions (sockaddr_u *); +extern void hack_restrict (int, sockaddr_u *, sockaddr_u *, + u_short, u_short, u_long); +extern void restrict_source (sockaddr_u *, int, u_long); + +/* ntp_timer.c */ +extern void init_timer (void); +extern void reinit_timer (void); +extern void timer (void); +extern void timer_clr_stats (void); +extern void timer_interfacetimeout (u_long); +extern volatile int interface_interval; +extern u_long orphwait; /* orphan wait time */ +#ifdef AUTOKEY +extern char *sys_hostname; /* host name */ +extern char *sys_groupname; /* group name */ +extern char *group_name; /* group name */ +extern u_long sys_revoke; /* keys revoke timeout */ +extern u_long sys_automax; /* session key timeout */ +#endif /* AUTOKEY */ + +/* ntp_util.c */ +extern void init_util (void); +extern void write_stats (void); +extern void stats_config (int, const char *); +extern void record_peer_stats (sockaddr_u *, int, double, double, double, double); +extern void record_proto_stats (char *); +extern void record_loop_stats (double, double, double, double, int); +extern void record_clock_stats (sockaddr_u *, const char *); +extern int mprintf_clock_stats(sockaddr_u *, const char *, ...) + NTP_PRINTF(2, 3); +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 poll, int precision, double root_delay, double root_dispersion, u_int32 refid); +extern void check_leap_file (int is_daily_check, u_int32 ntptime, const time_t * systime); +extern void record_crypto_stats (sockaddr_u *, const char *); +#ifdef DEBUG +extern void record_timing_stats (const char *); +#endif +extern char * fstostr(time_t); /* NTP timescale seconds */ + +/* ntpd.c */ +extern void parse_cmdline_opts(int *, char ***); +/* + * Signals we catch for debugging. + */ +#define MOREDEBUGSIG SIGUSR1 +#define LESSDEBUGSIG SIGUSR2 +/* + * Signals which terminate us gracefully. + */ +#ifndef SYS_WINNT +# define SIGDIE1 SIGHUP +# define SIGDIE2 SIGINT +# define SIGDIE3 SIGQUIT +# define SIGDIE4 SIGTERM +#endif /* SYS_WINNT */ + + +/* + * Last half: ntpd variables + * ------------------------- + */ + +/* ntp_config.c */ +extern char const * progname; +extern char *sys_phone[]; /* ACTS phone numbers */ +#if defined(HAVE_SCHED_SETSCHEDULER) +extern int config_priority_override; +extern int config_priority; +#endif +extern char *ntp_signd_socket; +extern struct config_tree_tag *cfg_tree_history; + +#ifdef BC_LIST_FRAMEWORK_NOT_YET_USED +/* + * backwards compatibility flags + */ +typedef struct bc_entry_tag { + int token; + int enabled; +} bc_entry; + +extern bc_entry bc_list[]; +#endif + +/* ntp_control.c */ +extern int num_ctl_traps; +extern keyid_t ctl_auth_keyid; /* keyid used for authenticating write requests */ + +/* + * Statistic counters to keep track of requests and responses. + */ +extern u_long ctltimereset; /* time stats reset */ +extern u_long numctlreq; /* number of requests we've received */ +extern u_long numctlbadpkts; /* number of bad control packets */ +extern u_long numctlresponses; /* number of resp packets sent with data */ +extern u_long numctlfrags; /* number of fragments sent */ +extern u_long numctlerrors; /* number of error responses sent */ +extern u_long numctltooshort; /* number of too short input packets */ +extern u_long numctlinputresp; /* number of responses on input */ +extern u_long numctlinputfrag; /* number of fragments on input */ +extern u_long numctlinputerr; /* number of input pkts with err bit set */ +extern u_long numctlbadoffset; /* number of input pkts with nonzero offset */ +extern u_long numctlbadversion; /* number of input pkts with unknown version */ +extern u_long numctldatatooshort; /* data too short for count */ +extern u_long numctlbadop; /* bad op code found in packet */ +extern u_long numasyncmsgs; /* number of async messages we've sent */ + +/* + * Other statistics of possible interest + */ +extern volatile u_long packets_dropped; /* total number of packets dropped on reception */ +extern volatile u_long packets_ignored; /* packets received on wild card interface */ +extern volatile u_long packets_received;/* total number of packets received */ +extern u_long packets_sent; /* total number of packets sent */ +extern u_long packets_notsent; /* total number of packets which couldn't be sent */ + +extern volatile u_long handler_calls; /* number of calls to interrupt handler */ +extern volatile u_long handler_pkts; /* number of pkts received by handler */ +extern u_long io_timereset; /* time counters were reset */ + +/* ntp_io.c */ +extern int disable_dynamic_updates; +extern u_int sys_ifnum; /* next .ifnum to assign */ +extern endpt * any_interface; /* IPv4 wildcard */ +extern endpt * any6_interface; /* IPv6 wildcard */ +extern endpt * loopback_interface; /* IPv4 loopback for refclocks */ +extern endpt * ep_list; /* linked list */ + +/* ntp_loopfilter.c */ +extern double drift_comp; /* clock frequency (s/s) */ +extern double clock_stability; /* clock stability (s/s) */ +extern double clock_max; /* max offset before step (s) */ +extern double clock_panic; /* max offset before panic (s) */ +extern double clock_phi; /* dispersion rate (s/s) */ +extern double clock_minstep; /* step timeout (s) */ +extern double clock_codec; /* codec frequency */ +#ifdef KERNEL_PLL +extern int pll_status; /* status bits for kernel pll */ +#endif /* KERNEL_PLL */ + +/* + * Clock state machine control flags + */ +extern int ntp_enable; /* clock discipline enabled */ +extern int pll_control; /* kernel support available */ +extern int kern_enable; /* kernel support enabled */ +extern int hardpps_enable; /* kernel PPS discipline enabled */ +extern int ext_enable; /* external clock enabled */ +extern int cal_enable; /* refclock calibrate enable */ +extern int allow_panic; /* allow panic correction */ +extern int mode_ntpdate; /* exit on first clock set */ +extern int peer_ntpdate; /* count of ntpdate peers */ + +/* + * Clock state machine variables + */ +extern u_char sys_poll; /* system poll interval (log2 s) */ +extern int state; /* clock discipline state */ +extern int tc_counter; /* poll-adjust counter */ +extern u_long last_time; /* time of last clock update (s) */ +extern double last_offset; /* last clock offset (s) */ +extern u_char allan_xpt; /* Allan intercept (log2 s) */ +extern double clock_jitter; /* clock jitter (s) */ +extern double sys_offset; /* system offset (s) */ +extern double sys_jitter; /* system jitter (s) */ + +/* ntp_monitor.c */ +extern u_char mon_hash_bits; /* log2 size of hash table */ +extern mon_entry ** mon_hash; /* MRU hash table */ +extern mon_entry mon_mru_list; /* mru listhead */ +extern u_int mon_enabled; /* MON_OFF (0) or other MON_* */ +extern u_int mru_alloc; /* mru list + free list count */ +extern u_int mru_entries; /* mru list count */ +extern u_int mru_peakentries; /* highest mru_entries */ +extern u_int mru_initalloc; /* entries to preallocate */ +extern u_int mru_incalloc; /* allocation batch factor */ +extern u_int mru_mindepth; /* preempt above this */ +extern int mru_maxage; /* for entries older than */ +extern u_int mru_maxdepth; /* MRU size hard limit */ +extern int mon_age; /* preemption limit */ + +/* ntp_peer.c */ +extern struct peer *peer_hash[NTP_HASH_SIZE]; /* peer hash table */ +extern int peer_hash_count[NTP_HASH_SIZE]; /* count of in each bucket */ +extern struct peer *assoc_hash[NTP_HASH_SIZE]; /* association ID hash table */ +extern int assoc_hash_count[NTP_HASH_SIZE];/* count of in each bucket */ +extern struct peer *peer_list; /* peer structures list */ +extern int peer_count; /* count in peer_list */ +extern int peer_free_count; /* count in peer_free */ + +/* + * Miscellaneous statistic counters which may be queried. + */ +extern u_long peer_timereset; /* time stat counters were zeroed */ +extern u_long findpeer_calls; /* number of calls to findpeer */ +extern u_long assocpeer_calls; /* number of calls to findpeerbyassoc */ +extern u_long peer_allocations; /* number of allocations from the free list */ +extern u_long peer_demobilizations; /* number of structs freed to free list */ +extern int total_peer_structs; /* number of peer structs in circulation */ +extern int peer_associations; /* mobilized associations */ +extern int peer_preempt; /* preemptable associations */ + +/* ntp_proto.c */ +/* + * System variables are declared here. See Section 3.2 of the + * specification. + */ +extern u_char sys_leap; /* system leap indicator */ +extern u_char sys_stratum; /* system stratum */ +extern s_char sys_precision; /* local clock precision */ +extern double sys_rootdelay; /* roundtrip delay to primary source */ +extern double sys_rootdisp; /* dispersion to primary source */ +extern u_int32 sys_refid; /* reference id */ +extern l_fp sys_reftime; /* last update time */ +extern struct peer *sys_peer; /* current peer */ + +/* + * Nonspecified system state variables. + */ +extern int sys_bclient; /* we set our time to broadcasts */ +extern double sys_bdelay; /* broadcast client default delay */ +extern int sys_authenticate; /* requre authentication for config */ +extern l_fp sys_authdelay; /* authentication delay */ +extern u_long sys_epoch; /* last clock update time */ +extern keyid_t sys_private; /* private value for session seed */ +extern int sys_manycastserver; /* respond to manycast client pkts */ +extern int sys_minclock; /* minimum survivors */ +extern int sys_minsane; /* minimum candidates */ +extern int sys_floor; /* cluster stratum floor */ +extern int sys_ceiling; /* cluster stratum ceiling */ +extern u_char sys_ttl[MAX_TTL]; /* ttl mapping vector */ +extern int sys_ttlmax; /* max ttl mapping vector index */ + +/* + * Statistics counters + */ +extern u_long sys_stattime; /* time since reset */ +extern u_long sys_received; /* packets received */ +extern u_long sys_processed; /* packets for this host */ +extern u_long sys_restricted; /* restricted packets */ +extern u_long sys_newversion; /* current version */ +extern u_long sys_oldversion; /* old version */ +extern u_long sys_restricted; /* access denied */ +extern u_long sys_badlength; /* bad length or format */ +extern u_long sys_badauth; /* bad authentication */ +extern u_long sys_declined; /* declined */ +extern u_long sys_limitrejected; /* rate exceeded */ +extern u_long sys_kodsent; /* KoD sent */ + +/* ntp_request.c */ +extern keyid_t info_auth_keyid; /* keyid used to authenticate requests */ +extern u_long auth_timereset; + +/* ntp_restrict.c */ +extern restrict_u * restrictlist4; /* IPv4 restriction list */ +extern restrict_u * restrictlist6; /* IPv6 restriction list */ +extern int ntp_minpkt; +extern u_char ntp_minpoll; + +/* ntp_scanner.c */ +extern u_int32 conf_file_sum; /* Simple sum of characters */ + +/* ntp_signd.c */ +#ifdef HAVE_NTP_SIGND +extern void send_via_ntp_signd(struct recvbuf *, int, keyid_t, int, + struct pkt *); +#endif + +/* ntp_timer.c */ +extern volatile int alarm_flag; /* alarm flag */ +extern volatile u_long alarm_overflow; +extern u_long current_time; /* seconds since startup */ +extern u_long timer_timereset; +extern u_long timer_overflows; +extern u_long timer_xmtcalls; +#ifdef SYS_WINNT +HANDLE WaitableTimerHandle; +#endif + +/* ntp_util.c */ +extern char statsdir[MAXFILENAME]; +extern int stats_control; /* write stats to fileset? */ +extern int stats_write_period; /* # of seconds between writes. */ +extern double stats_write_tolerance; +extern double wander_threshold; + +/* ntpd.c */ +extern int nofork; /* no-fork flag */ +extern int initializing; /* initializing flag */ +#ifdef HAVE_DROPROOT +extern int droproot; /* flag: try to drop root privileges after startup */ +extern int root_dropped; /* root has been dropped */ +extern char *user; /* user to switch to */ +extern char *group; /* group to switch to */ +extern const char *chrootdir; /* directory to chroot() to */ +#endif +#ifdef HAVE_WORKING_FORK +extern int waitsync_fd_to_close; /* -w/--wait-sync */ +#endif + +/* ntservice.c */ +#ifdef SYS_WINNT +extern int accept_wildcard_if_for_winnt; +#endif + +/* refclock_conf.c */ +#ifdef REFCLOCK +/* refclock configuration table */ +extern struct refclock * const refclock_conf[]; +extern u_char num_refclock_conf; +#endif + |