/contrib/ntp/include/ntpd.h

https://bitbucket.org/freebsd/freebsd-head/ · C++ Header · 472 lines · 332 code · 54 blank · 86 comment · 0 complexity · e8560f109e2550b393004e59b4e24dd6 MD5 · raw file

  1. /*
  2. * ntpd.h - Prototypes for ntpd.
  3. */
  4. #include "ntp_syslog.h"
  5. #include "ntp_fp.h"
  6. #include "ntp.h"
  7. #include "ntp_debug.h"
  8. #include "ntp_select.h"
  9. #include "ntp_malloc.h"
  10. #include "ntp_refclock.h"
  11. #include "recvbuff.h"
  12. /* ntp_config.c */
  13. extern void getconfig P((int, char **));
  14. /* ntp_config.c */
  15. extern void ctl_clr_stats P((void));
  16. extern int ctlclrtrap P((struct sockaddr_storage *, struct interface *, int));
  17. extern u_short ctlpeerstatus P((struct peer *));
  18. extern int ctlsettrap P((struct sockaddr_storage *, struct interface *, int, int));
  19. extern u_short ctlsysstatus P((void));
  20. extern void init_control P((void));
  21. extern void process_control P((struct recvbuf *, int));
  22. extern void report_event P((int, struct peer *));
  23. extern double fabs P((double));
  24. extern double sqrt P((double));
  25. /* ntp_control.c */
  26. /*
  27. * Structure for translation tables between internal system
  28. * variable indices and text format.
  29. */
  30. struct ctl_var {
  31. u_short code;
  32. u_short flags;
  33. char *text;
  34. };
  35. /*
  36. * Flag values
  37. */
  38. #define CAN_READ 0x01
  39. #define CAN_WRITE 0x02
  40. #define DEF 0x20
  41. #define PADDING 0x40
  42. #define EOV 0x80
  43. #define RO (CAN_READ)
  44. #define WO (CAN_WRITE)
  45. #define RW (CAN_READ|CAN_WRITE)
  46. extern char * add_var P((struct ctl_var **, u_long, u_short));
  47. extern void free_varlist P((struct ctl_var *));
  48. extern void set_var P((struct ctl_var **, const char *, u_long, u_short));
  49. extern void set_sys_var P((const char *, u_long, u_short));
  50. /* ntp_intres.c */
  51. extern void ntp_res_name P((struct sockaddr_storage, u_short));
  52. extern void ntp_res_recv P((void));
  53. extern void ntp_intres P((void));
  54. /* ntp_io.c */
  55. typedef struct interface_info {
  56. struct interface *interface;
  57. u_char action;
  58. } interface_info_t;
  59. typedef void (*interface_receiver_t)(void *, interface_info_t *);
  60. extern volatile int disable_dynamic_updates;
  61. extern void interface_enumerate P((interface_receiver_t, void *));
  62. extern struct interface *findinterface P((struct sockaddr_storage *));
  63. extern struct interface *findbcastinter P((struct sockaddr_storage *));
  64. extern void enable_broadcast P((struct interface *, struct sockaddr_storage *));
  65. extern void enable_multicast_if P((struct interface *, struct sockaddr_storage *));
  66. extern void interface_dump P((struct interface *));
  67. extern void interface_update P((interface_receiver_t, void *));
  68. extern void init_io P((void));
  69. extern void input_handler P((l_fp *));
  70. extern void io_clr_stats P((void));
  71. extern void io_setbclient P((void));
  72. extern void io_unsetbclient P((void));
  73. extern void io_multicast_add P((struct sockaddr_storage));
  74. extern void io_multicast_del P((struct sockaddr_storage));
  75. extern void kill_asyncio P((int));
  76. extern void sendpkt P((struct sockaddr_storage *, struct interface *, int, struct pkt *, int));
  77. #ifdef DEBUG
  78. extern void collect_timing P((struct recvbuf *, const char *, int, l_fp *));
  79. #endif
  80. #ifdef HAVE_SIGNALED_IO
  81. extern void wait_for_signal P((void));
  82. extern void unblock_io_and_alarm P((void));
  83. extern void block_io_and_alarm P((void));
  84. #define UNBLOCK_IO_AND_ALARM() unblock_io_and_alarm()
  85. #define BLOCK_IO_AND_ALARM() block_io_and_alarm()
  86. #else
  87. #define UNBLOCK_IO_AND_ALARM()
  88. #define BLOCK_IO_AND_ALARM()
  89. #endif
  90. /* ntp_leap.c */
  91. extern void init_leap P((void));
  92. extern void leap_process P((void));
  93. extern int leap_setleap P((int, int));
  94. /*
  95. * there seems to be a bug in the IRIX 4 compiler which prevents
  96. * u_char from beeing used in prototyped functions.
  97. * This is also true AIX compiler.
  98. * So give up and define it to be int. WLJ
  99. */
  100. extern int leap_actual P((int));
  101. /* ntp_loopfilter.c */
  102. extern void init_loopfilter P((void));
  103. extern int local_clock P((struct peer *, double));
  104. extern void adj_host_clock P((void));
  105. extern void loop_config P((int, double));
  106. extern void huffpuff P((void));
  107. extern u_long sys_clocktime;
  108. extern u_long sys_tai;
  109. /* ntp_monitor.c */
  110. extern void init_mon P((void));
  111. extern void mon_start P((int));
  112. extern void mon_stop P((int));
  113. extern int ntp_monitor P((struct recvbuf *));
  114. extern void ntp_monclearinterface P((struct interface *interface));
  115. /* ntp_peer.c */
  116. extern void init_peer P((void));
  117. extern struct peer *findexistingpeer P((struct sockaddr_storage *, struct peer *, int));
  118. extern struct peer *findpeer P((struct sockaddr_storage *, struct interface *, int, int *));
  119. extern struct peer *findpeerbyassoc P((u_int));
  120. extern void set_peerdstadr P((struct peer *peer, struct interface *interface));
  121. extern struct peer *newpeer P((struct sockaddr_storage *, struct interface *, int, int, int, int, u_int, u_char, int, keyid_t));
  122. extern void peer_all_reset P((void));
  123. extern void peer_clr_stats P((void));
  124. extern struct peer *peer_config P((struct sockaddr_storage *, struct interface *, int, int, int, int, u_int, int, keyid_t, u_char *));
  125. extern void peer_reset P((struct peer *));
  126. extern int peer_unconfig P((struct sockaddr_storage *, struct interface *, int));
  127. extern void refresh_all_peerinterfaces P((void));
  128. extern void unpeer P((struct peer *));
  129. extern void clear_all P((void));
  130. #ifdef OPENSSL
  131. extern void expire_all P((void));
  132. #endif /* OPENSSL */
  133. extern struct peer *findmanycastpeer P((struct recvbuf *));
  134. /* ntp_crypto.c */
  135. #ifdef OPENSSL
  136. extern int crypto_recv P((struct peer *, struct recvbuf *));
  137. extern int crypto_xmit P((struct pkt *, struct sockaddr_storage *, int, struct exten *, keyid_t));
  138. extern keyid_t session_key P((struct sockaddr_storage *, struct sockaddr_storage *, keyid_t, keyid_t, u_long));
  139. extern int make_keylist P((struct peer *, struct interface *));
  140. extern void key_expire P((struct peer *));
  141. extern void crypto_update P((void));
  142. extern void crypto_config P((int, char *));
  143. extern void crypto_setup P((void));
  144. extern u_int crypto_ident P((struct peer *));
  145. extern struct exten *crypto_args P((struct peer *, u_int, char *));
  146. extern int crypto_public P((struct peer *, u_char *, u_int));
  147. extern void value_free P((struct value *));
  148. extern char *iffpar_file;
  149. extern EVP_PKEY *iffpar_pkey;
  150. extern char *gqpar_file;
  151. extern EVP_PKEY *gqpar_pkey;
  152. extern char *mvpar_file;
  153. extern EVP_PKEY *mvpar_pkey;
  154. extern struct value tai_leap;
  155. #endif /* OPENSSL */
  156. /* ntp_proto.c */
  157. extern void transmit P((struct peer *));
  158. extern void receive P((struct recvbuf *));
  159. extern void peer_crypto_clear P((struct peer *peer));
  160. extern void peer_clear P((struct peer *, char *));
  161. extern void process_packet P((struct peer *, struct pkt *));
  162. extern void clock_select P((void));
  163. extern void kod_proto P((void));
  164. /*
  165. * there seems to be a bug in the IRIX 4 compiler which prevents
  166. * u_char from beeing used in prototyped functions.
  167. * This is also true AIX compiler.
  168. * So give up and define it to be int. WLJ
  169. */
  170. extern void poll_update P((struct peer *, int));
  171. extern void clear P((struct peer *));
  172. extern void clock_filter P((struct peer *, double, double, double));
  173. extern void init_proto P((void));
  174. extern void proto_config P((int, u_long, double, struct sockaddr_storage*));
  175. extern void proto_clr_stats P((void));
  176. #ifdef REFCLOCK
  177. /* ntp_refclock.c */
  178. extern int refclock_newpeer P((struct peer *));
  179. extern void refclock_unpeer P((struct peer *));
  180. extern void refclock_receive P((struct peer *));
  181. extern void refclock_transmit P((struct peer *));
  182. extern void init_refclock P((void));
  183. #endif /* REFCLOCK */
  184. /* ntp_request.c */
  185. extern void init_request P((void));
  186. extern void process_private P((struct recvbuf *, int));
  187. /* ntp_restrict.c */
  188. extern void init_restrict P((void));
  189. extern int restrictions P((struct sockaddr_storage *, int));
  190. extern void hack_restrict P((int, struct sockaddr_storage *, struct sockaddr_storage *, int, int));
  191. /* ntp_timer.c */
  192. extern void init_timer P((void));
  193. extern void reinit_timer P((void));
  194. extern void timer P((void));
  195. extern void timer_clr_stats P((void));
  196. extern void timer_interfacetimeout P((u_long));
  197. extern volatile int interface_interval;
  198. #ifdef OPENSSL
  199. extern char *sys_hostname;
  200. extern l_fp sys_revoketime;
  201. #endif /* OPENSSL */
  202. /* ntp_util.c */
  203. extern void init_util P((void));
  204. extern void write_stats P((void));
  205. extern void stats_config P((int, const char *));
  206. extern void record_peer_stats P((struct sockaddr_storage *, int, double, double, double, double));
  207. extern void record_loop_stats P((double, double, double, double, int));
  208. extern void record_clock_stats P((struct sockaddr_storage *, const char *));
  209. extern void record_raw_stats P((struct sockaddr_storage *, struct sockaddr_storage *, l_fp *, l_fp *, l_fp *, l_fp *));
  210. extern void record_sys_stats P((void));
  211. extern void record_crypto_stats P((struct sockaddr_storage *, const char *));
  212. #ifdef DEBUG
  213. extern void record_timing_stats P((const char *));
  214. #endif
  215. extern int sock_hash P((struct sockaddr_storage *));
  216. extern double old_drift;
  217. /*
  218. * Variable declarations for ntpd.
  219. */
  220. /* ntp_config.c */
  221. extern char const * progname;
  222. extern char *sys_phone[]; /* ACTS phone numbers */
  223. #if defined(HAVE_SCHED_SETSCHEDULER)
  224. extern int config_priority_override;
  225. extern int config_priority;
  226. #endif
  227. /* ntp_control.c */
  228. extern int num_ctl_traps;
  229. extern keyid_t ctl_auth_keyid; /* keyid used for authenticating write requests */
  230. /*
  231. * Statistic counters to keep track of requests and responses.
  232. */
  233. extern u_long ctltimereset; /* time stats reset */
  234. extern u_long numctlreq; /* number of requests we've received */
  235. extern u_long numctlbadpkts; /* number of bad control packets */
  236. extern u_long numctlresponses; /* number of resp packets sent with data */
  237. extern u_long numctlfrags; /* number of fragments sent */
  238. extern u_long numctlerrors; /* number of error responses sent */
  239. extern u_long numctltooshort; /* number of too short input packets */
  240. extern u_long numctlinputresp; /* number of responses on input */
  241. extern u_long numctlinputfrag; /* number of fragments on input */
  242. extern u_long numctlinputerr; /* number of input pkts with err bit set */
  243. extern u_long numctlbadoffset; /* number of input pkts with nonzero offset */
  244. extern u_long numctlbadversion; /* number of input pkts with unknown version */
  245. extern u_long numctldatatooshort; /* data too short for count */
  246. extern u_long numctlbadop; /* bad op code found in packet */
  247. extern u_long numasyncmsgs; /* number of async messages we've sent */
  248. /* ntp_intres.c */
  249. extern keyid_t req_keyid; /* request keyid */
  250. extern char * req_file; /* name of the file with configuration info */
  251. #ifdef SYS_WINNT
  252. extern HANDLE ResolverEventHandle;
  253. #else
  254. extern int resolver_pipe_fd[2]; /* used to let the resolver process alert the parent process */
  255. #endif /* SYS_WINNT */
  256. /*
  257. * Other statistics of possible interest
  258. */
  259. extern volatile u_long packets_dropped; /* total number of packets dropped on reception */
  260. extern volatile u_long packets_ignored; /* packets received on wild card interface */
  261. extern volatile u_long packets_received;/* total number of packets received */
  262. extern u_long packets_sent; /* total number of packets sent */
  263. extern u_long packets_notsent; /* total number of packets which couldn't be sent */
  264. extern volatile u_long handler_calls; /* number of calls to interrupt handler */
  265. extern volatile u_long handler_pkts; /* number of pkts received by handler */
  266. extern u_long io_timereset; /* time counters were reset */
  267. /*
  268. * Interface stuff
  269. */
  270. extern struct interface *any_interface; /* default ipv4 interface */
  271. extern struct interface *any6_interface;/* default ipv6 interface */
  272. extern struct interface *loopback_interface; /* loopback interface */
  273. /*
  274. * File descriptor masks etc. for call to select
  275. */
  276. extern fd_set activefds;
  277. extern int maxactivefd;
  278. /* ntp_loopfilter.c */
  279. extern double drift_comp; /* clock frequency (s/s) */
  280. extern double clock_stability; /* clock stability (s/s) */
  281. extern double clock_max; /* max offset before step (s) */
  282. extern double clock_panic; /* max offset before panic (s) */
  283. extern double clock_phi; /* dispersion rate (s/s) */
  284. extern double clock_minstep; /* step timeout (s) */
  285. extern u_long pps_control; /* last pps sample time */
  286. #ifdef KERNEL_PLL
  287. extern int pll_status; /* status bits for kernel pll */
  288. #endif /* KERNEL_PLL */
  289. /*
  290. * Clock state machine control flags
  291. */
  292. extern int ntp_enable; /* clock discipline enabled */
  293. extern int pll_control; /* kernel support available */
  294. extern int kern_enable; /* kernel support enabled */
  295. extern int pps_enable; /* kernel PPS discipline enabled */
  296. extern int ext_enable; /* external clock enabled */
  297. extern int cal_enable; /* refclock calibrate enable */
  298. extern int allow_panic; /* allow panic correction */
  299. extern int mode_ntpdate; /* exit on first clock set */
  300. extern int peer_ntpdate; /* count of ntpdate peers */
  301. /*
  302. * Clock state machine variables
  303. */
  304. extern u_char sys_poll; /* system poll interval (log2 s) */
  305. extern int state; /* clock discipline state */
  306. extern int tc_counter; /* poll-adjust counter */
  307. extern u_long last_time; /* time of last clock update (s) */
  308. extern double last_offset; /* last clock offset (s) */
  309. extern double allan_xpt; /* Allan intercept (s) */
  310. extern double clock_jitter; /* clock jitter (s) */
  311. extern double sys_jitter; /* system jitter (s) */
  312. /* ntp_monitor.c */
  313. extern struct mon_data mon_mru_list;
  314. extern struct mon_data mon_fifo_list;
  315. extern int mon_enabled;
  316. /* ntp_peer.c */
  317. extern struct peer *peer_hash[]; /* peer hash table */
  318. extern int peer_hash_count[]; /* count of peers in each bucket */
  319. extern struct peer *assoc_hash[]; /* association ID hash table */
  320. extern int assoc_hash_count[];
  321. extern int peer_free_count;
  322. /*
  323. * Miscellaneous statistic counters which may be queried.
  324. */
  325. extern u_long peer_timereset; /* time stat counters were zeroed */
  326. extern u_long findpeer_calls; /* number of calls to findpeer */
  327. extern u_long assocpeer_calls; /* number of calls to findpeerbyassoc */
  328. extern u_long peer_allocations; /* number of allocations from the free list */
  329. extern u_long peer_demobilizations; /* number of structs freed to free list */
  330. extern int total_peer_structs; /* number of peer structs in circulation */
  331. extern int peer_associations; /* mobilized associations */
  332. extern int peer_preempt; /* preemptable associations */
  333. /* ntp_proto.c */
  334. /*
  335. * System variables are declared here. See Section 3.2 of the
  336. * specification.
  337. */
  338. extern u_char sys_leap; /* system leap indicator */
  339. extern u_char sys_stratum; /* stratum of system */
  340. extern s_char sys_precision; /* local clock precision */
  341. extern double sys_rootdelay; /* distance to current sync source */
  342. extern double sys_rootdispersion; /* dispersion of system clock */
  343. extern u_int32 sys_refid; /* reference source for local clock */
  344. extern l_fp sys_reftime; /* time we were last updated */
  345. extern struct peer *sys_peer; /* our current peer */
  346. extern struct peer *sys_pps; /* our current PPS peer */
  347. extern struct peer *sys_prefer; /* our cherished peer */
  348. extern u_long sys_automax; /* maximum session key lifetime */
  349. /*
  350. * Nonspecified system state variables.
  351. */
  352. extern int sys_bclient; /* we set our time to broadcasts */
  353. extern double sys_bdelay; /* broadcast client default delay */
  354. extern int sys_authenticate; /* requre authentication for config */
  355. extern l_fp sys_authdelay; /* authentication delay */
  356. extern keyid_t sys_private; /* private value for session seed */
  357. extern int sys_manycastserver; /* respond to manycast client pkts */
  358. extern int sys_minclock; /* minimum survivors */
  359. extern int sys_minsane; /* minimum candidates */
  360. extern int sys_floor; /* cluster stratum floor */
  361. extern int sys_ceiling; /* cluster stratum ceiling */
  362. extern u_char sys_ttl[]; /* ttl mapping vector */
  363. extern int sys_ttlmax; /* max ttl mapping vector index */
  364. extern int leap_next; /* leap consensus */
  365. /*
  366. * Statistics counters
  367. */
  368. extern u_long sys_stattime; /* time when we started recording */
  369. extern u_long sys_restricted; /* restricted packets */
  370. extern u_long sys_oldversionpkt; /* old version packets */
  371. extern u_long sys_newversionpkt; /* new version packets */
  372. extern u_long sys_unknownversion; /* don't know version packets */
  373. extern u_long sys_badlength; /* bad length or format */
  374. extern u_long sys_processed; /* packets processed */
  375. extern u_long sys_badauth; /* bad authentication */
  376. extern u_long sys_limitrejected; /* rate limit exceeded */
  377. extern u_long sys_received; /* packets received */
  378. /* ntp_refclock.c */
  379. #ifdef REFCLOCK
  380. #ifdef PPS
  381. extern int fdpps; /* pps file descriptor */
  382. #endif /* PPS */
  383. #endif
  384. /* ntp_request.c */
  385. extern keyid_t info_auth_keyid; /* keyid used to authenticate requests */
  386. /* ntp_restrict.c */
  387. extern struct restrictlist *restrictlist; /* the ipv4 restriction list */
  388. extern struct restrictlist6 *restrictlist6; /* the ipv6 restriction list */
  389. extern u_long res_min_interval;
  390. extern u_long res_avg_interval;
  391. extern u_long mon_age; /* monitor preempt age */
  392. /* ntp_timer.c */
  393. extern volatile int alarm_flag; /* alarm flag */
  394. extern u_char sys_revoke; /* keys revoke timeout (log2 s) */
  395. extern volatile u_long alarm_overflow;
  396. extern u_long current_time; /* current time (s) */
  397. extern u_long timer_timereset;
  398. extern u_long timer_overflows;
  399. extern u_long timer_xmtcalls;
  400. /* ntp_util.c */
  401. extern int stats_control; /* write stats to fileset? */
  402. extern int stats_write_period; /* # of seconds between writes. */
  403. extern double stats_write_tolerance;
  404. /* ntpd.c */
  405. extern volatile int debug; /* debugging flag */
  406. extern int nofork; /* no-fork flag */
  407. extern int initializing; /* initializing flag */
  408. #ifdef HAVE_DROPROOT
  409. extern int droproot; /* flag: try to drop root privileges after startup */
  410. extern char *user; /* user to switch to */
  411. extern char *group; /* group to switch to */
  412. extern char *chrootdir; /* directory to chroot to */
  413. #endif
  414. /* refclock_conf.c */
  415. #ifdef REFCLOCK
  416. extern struct refclock *refclock_conf[]; /* refclock configuration table */
  417. extern u_char num_refclock_conf;
  418. #endif