2 * NTP client/server, based on OpenNTPD 3.9p1
4 * Author: Adam Tkac <vonsch@gmail.com>
6 * Licensed under GPLv2, see file LICENSE in this source tree.
8 * Parts of OpenNTPD clock syncronization code is replaced by
9 * code which is based on ntp-4.2.6, whuch carries the following
12 ***********************************************************************
14 * Copyright (c) University of Delaware 1992-2009 *
16 * Permission to use, copy, modify, and distribute this software and *
17 * its documentation for any purpose with or without fee is hereby *
18 * granted, provided that the above copyright notice appears in all *
19 * copies and that both the copyright notice and this permission *
20 * notice appear in supporting documentation, and that the name *
21 * University of Delaware not be used in advertising or publicity *
22 * pertaining to distribution of the software without specific, *
23 * written prior permission. The University of Delaware makes no *
24 * representations about the suitability this software for any *
25 * purpose. It is provided "as is" without express or implied *
28 ***********************************************************************
31 //usage:#define ntpd_trivial_usage
32 //usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..."
33 //usage:#define ntpd_full_usage "\n\n"
34 //usage: "NTP client/server\n"
35 //usage: "\n -d Verbose"
36 //usage: "\n -n Do not daemonize"
37 //usage: "\n -q Quit after clock is set"
38 //usage: "\n -N Run at high priority"
39 //usage: "\n -w Do not set time (only query peers), implies -n"
40 //usage: IF_FEATURE_NTPD_SERVER(
41 //usage: "\n -l Run as server on port 123"
43 //usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins"
44 //usage: "\n -p PEER Obtain time from PEER (may be repeated)"
48 #include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
49 #include <sys/timex.h>
50 #ifndef IPTOS_LOWDELAY
51 # define IPTOS_LOWDELAY 0x10
54 # error "Sorry, your kernel has to support IP_PKTINFO"
58 /* Verbosity control (max level of -dddd options accepted).
59 * max 5 is very talkative (and bloated). 2 is non-bloated,
60 * production level setting.
65 /* High-level description of the algorithm:
67 * We start running with very small poll_exp, BURSTPOLL,
68 * in order to quickly accumulate INITIAL_SAMPLES datapoints
69 * for each peer. Then, time is stepped if the offset is larger
70 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
71 * poll_exp to MINPOLL and enter frequency measurement step:
72 * we collect new datapoints but ignore them for WATCH_THRESHOLD
73 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
74 * offset and estimate frequency drift.
76 * (frequency measurement step seems to not be strictly needed,
77 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
80 * After this, we enter "steady state": we collect a datapoint,
81 * we select the best peer, if this datapoint is not a new one
82 * (IOW: if this datapoint isn't for selected peer), sleep
83 * and collect another one; otherwise, use its offset to update
84 * frequency drift, if offset is somewhat large, reduce poll_exp,
85 * otherwise increase poll_exp.
87 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
88 * happen, we assume that something "bad" happened (computer
89 * was hibernated, someone set totally wrong date, etc),
90 * then the time is stepped, all datapoints are discarded,
91 * and we go back to steady state.
94 #define RETRY_INTERVAL 5 /* on error, retry in N secs */
95 #define RESPONSE_INTERVAL 15 /* wait for reply up to N secs */
96 #define INITIAL_SAMPLES 4 /* how many samples do we want for init */
98 /* Clock discipline parameters and constants */
100 /* Step threshold (sec). std ntpd uses 0.128.
101 * Using exact power of 2 (1/8) results in smaller code */
102 #define STEP_THRESHOLD 0.125
103 #define WATCH_THRESHOLD 128 /* stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
104 /* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
105 //UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
107 #define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
108 #define BURSTPOLL 0 /* initial poll */
109 #define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
110 /* If offset > discipline_jitter * POLLADJ_GATE, and poll interval is >= 2^BIGPOLL,
111 * then it is decreased _at once_. (If < 2^BIGPOLL, it will be decreased _eventually_).
113 #define BIGPOLL 10 /* 2^10 sec ~= 17 min */
114 #define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
115 /* Actively lower poll when we see such big offsets.
116 * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
117 * if offset increases over ~0.04 sec */
118 #define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
119 #define MINDISP 0.01 /* minimum dispersion (sec) */
120 #define MAXDISP 16 /* maximum dispersion (sec) */
121 #define MAXSTRAT 16 /* maximum stratum (infinity metric) */
122 #define MAXDIST 1 /* distance threshold (sec) */
123 #define MIN_SELECTED 1 /* minimum intersection survivors */
124 #define MIN_CLUSTERED 3 /* minimum cluster survivors */
126 #define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
128 /* Poll-adjust threshold.
129 * When we see that offset is small enough compared to discipline jitter,
130 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
131 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
132 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
133 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
135 #define POLLADJ_LIMIT 40
136 /* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
137 * poll interval (we think we can't improve timekeeping
138 * by staying at smaller poll).
140 #define POLLADJ_GATE 4
141 #define TIMECONST_HACK_GATE 2
142 /* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
146 /* FLL loop gain [why it depends on MAXPOLL??] */
147 #define FLL (MAXPOLL + 1)
148 /* Parameter averaging constant */
157 NTP_MSGSIZE_NOAUTH = 48,
158 NTP_MSGSIZE = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
161 MODE_MASK = (7 << 0),
162 VERSION_MASK = (7 << 3),
166 /* Leap Second Codes (high order two bits of m_status) */
167 LI_NOWARNING = (0 << 6), /* no warning */
168 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
169 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
170 LI_ALARM = (3 << 6), /* alarm condition */
173 MODE_RES0 = 0, /* reserved */
174 MODE_SYM_ACT = 1, /* symmetric active */
175 MODE_SYM_PAS = 2, /* symmetric passive */
176 MODE_CLIENT = 3, /* client */
177 MODE_SERVER = 4, /* server */
178 MODE_BROADCAST = 5, /* broadcast */
179 MODE_RES1 = 6, /* reserved for NTP control message */
180 MODE_RES2 = 7, /* reserved for private use */
183 //TODO: better base selection
184 #define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
186 #define NUM_DATAPOINTS 8
199 uint8_t m_status; /* status of local clock and leap info */
201 uint8_t m_ppoll; /* poll value */
202 int8_t m_precision_exp;
203 s_fixedpt_t m_rootdelay;
204 s_fixedpt_t m_rootdisp;
206 l_fixedpt_t m_reftime;
207 l_fixedpt_t m_orgtime;
208 l_fixedpt_t m_rectime;
209 l_fixedpt_t m_xmttime;
211 uint8_t m_digest[NTP_DIGESTSIZE];
221 len_and_sockaddr *p_lsa;
223 /* when to send new query (if p_fd == -1)
224 * or when receive times out (if p_fd >= 0): */
227 uint32_t lastpkt_refid;
228 uint8_t lastpkt_status;
229 uint8_t lastpkt_stratum;
230 uint8_t reachable_bits;
231 double next_action_time;
233 double lastpkt_recv_time;
234 double lastpkt_delay;
235 double lastpkt_rootdelay;
236 double lastpkt_rootdisp;
237 /* produced by filter algorithm: */
238 double filter_offset;
239 double filter_dispersion;
240 double filter_jitter;
241 datapoint_t filter_datapoint[NUM_DATAPOINTS];
242 /* last sent packet: */
247 #define USING_KERNEL_PLL_LOOP 1
248 #define USING_INITIAL_FREQ_ESTIMATION 0
255 /* Insert new options above this line. */
256 /* Non-compat options: */
260 OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
261 /* We hijack some bits for other purposes */
267 /* total round trip delay to currently selected reference clock */
269 /* reference timestamp: time when the system clock was last set or corrected */
271 /* total dispersion to currently selected reference clock */
274 double last_script_run;
277 #if ENABLE_FEATURE_NTPD_SERVER
282 /* refid: 32-bit code identifying the particular server or reference clock
283 * in stratum 0 packets this is a four-character ASCII string,
284 * called the kiss code, used for debugging and monitoring
285 * in stratum 1 packets this is a four-character ASCII string
286 * assigned to the reference clock by IANA. Example: "GPS "
287 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
288 * of MD5 hash of IPv6
292 /* precision is defined as the larger of the resolution and time to
293 * read the clock, in log2 units. For instance, the precision of a
294 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
295 * system clock hardware representation is to the nanosecond.
297 * Delays, jitters of various kinds are clamped down to precision.
299 * If precision_sec is too large, discipline_jitter gets clamped to it
300 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
301 * interval grows even though we really can benefit from staying at
302 * smaller one, collecting non-lagged datapoits and correcting offset.
303 * (Lagged datapoits exist when poll_exp is large but we still have
304 * systematic offset error - the time distance between datapoints
305 * is significant and older datapoints have smaller offsets.
306 * This makes our offset estimation a bit smaller than reality)
307 * Due to this effect, setting G_precision_sec close to
308 * STEP_THRESHOLD isn't such a good idea - offsets may grow
309 * too big and we will step. I observed it with -6.
311 * OTOH, setting precision_sec far too small would result in futile
312 * attempts to syncronize to an unachievable precision.
314 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
315 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
316 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
318 #define G_precision_exp -9
320 * G_precision_exp is used only for construction outgoing packets.
321 * It's ok to set G_precision_sec to a slightly different value
322 * (One which is "nicer looking" in logs).
323 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
325 #define G_precision_sec 0.002
327 /* Bool. After set to 1, never goes back to 0: */
328 smallint initial_poll_complete;
330 #define STATE_NSET 0 /* initial state, "nothing is set" */
331 //#define STATE_FSET 1 /* frequency set from file */
332 #define STATE_SPIK 2 /* spike detected */
333 //#define STATE_FREQ 3 /* initial frequency */
334 #define STATE_SYNC 4 /* clock synchronized (normal operation) */
335 uint8_t discipline_state; // doc calls it c.state
336 uint8_t poll_exp; // s.poll
337 int polladj_count; // c.count
338 long kernel_freq_drift;
339 peer_t *last_update_peer;
340 double last_update_offset; // c.last
341 double last_update_recv_time; // s.t
342 double discipline_jitter; // c.jitter
343 double offset_to_jitter_ratio;
344 //double cluster_offset; // s.offset
345 //double cluster_jitter; // s.jitter
346 #if !USING_KERNEL_PLL_LOOP
347 double discipline_freq_drift; // c.freq
348 /* Maybe conditionally calculate wander? it's used only for logging */
349 double discipline_wander; // c.wander
352 #define G (*ptr_to_globals)
354 static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
357 #define VERB1 if (MAX_VERBOSE && G.verbose)
358 #define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
359 #define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
360 #define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
361 #define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
364 static double LOG2D(int a)
367 return 1.0 / (1UL << -a);
370 static ALWAYS_INLINE double SQUARE(double x)
374 static ALWAYS_INLINE double MAXD(double a, double b)
380 static ALWAYS_INLINE double MIND(double a, double b)
386 static NOINLINE double my_SQRT(double X)
393 double Xhalf = X * 0.5;
395 /* Fast and good approximation to 1/sqrt(X), black magic */
397 /*v.i = 0x5f3759df - (v.i >> 1);*/
398 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
399 invsqrt = v.f; /* better than 0.2% accuracy */
401 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
402 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
404 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
405 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
407 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
408 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
409 /* With 4 iterations, more than half results will be exact,
410 * at 6th iterations result stabilizes with about 72% results exact.
411 * We are well satisfied with 0.05% accuracy.
414 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
416 static ALWAYS_INLINE double SQRT(double X)
418 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
419 if (sizeof(float) != 4)
422 /* This avoids needing libm, saves about 0.5k on x86-32 */
430 gettimeofday(&tv, NULL); /* never fails */
431 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
436 d_to_tv(double d, struct timeval *tv)
438 tv->tv_sec = (long)d;
439 tv->tv_usec = (d - tv->tv_sec) * 1000000;
443 lfp_to_d(l_fixedpt_t lfp)
446 lfp.int_partl = ntohl(lfp.int_partl);
447 lfp.fractionl = ntohl(lfp.fractionl);
448 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
452 sfp_to_d(s_fixedpt_t sfp)
455 sfp.int_parts = ntohs(sfp.int_parts);
456 sfp.fractions = ntohs(sfp.fractions);
457 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
460 #if ENABLE_FEATURE_NTPD_SERVER
465 lfp.int_partl = (uint32_t)d;
466 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
467 lfp.int_partl = htonl(lfp.int_partl);
468 lfp.fractionl = htonl(lfp.fractionl);
475 sfp.int_parts = (uint16_t)d;
476 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
477 sfp.int_parts = htons(sfp.int_parts);
478 sfp.fractions = htons(sfp.fractions);
484 dispersion(const datapoint_t *dp)
486 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
490 root_distance(peer_t *p)
492 /* The root synchronization distance is the maximum error due to
493 * all causes of the local clock relative to the primary server.
494 * It is defined as half the total delay plus total dispersion
497 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
498 + p->lastpkt_rootdisp
499 + p->filter_dispersion
500 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
505 set_next(peer_t *p, unsigned t)
507 p->next_action_time = G.cur_time + t;
511 * Peer clock filter and its helpers
514 filter_datapoints(peer_t *p)
518 double minoff, maxoff, wavg, sum, w;
519 double x = x; /* for compiler */
520 double oldest_off = oldest_off;
521 double oldest_age = oldest_age;
522 double newest_off = newest_off;
523 double newest_age = newest_age;
525 minoff = maxoff = p->filter_datapoint[0].d_offset;
526 for (i = 1; i < NUM_DATAPOINTS; i++) {
527 if (minoff > p->filter_datapoint[i].d_offset)
528 minoff = p->filter_datapoint[i].d_offset;
529 if (maxoff < p->filter_datapoint[i].d_offset)
530 maxoff = p->filter_datapoint[i].d_offset;
533 idx = p->datapoint_idx; /* most recent datapoint */
535 * Drop two outliers and take weighted average of the rest:
536 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
537 * we use older6/32, not older6/64 since sum of weights should be 1:
538 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
544 * filter_dispersion = \ -------------
551 for (i = 0; i < NUM_DATAPOINTS; i++) {
553 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
555 p->filter_datapoint[idx].d_offset,
556 p->filter_datapoint[idx].d_dispersion, dispersion(&p->filter_datapoint[idx]),
557 G.cur_time - p->filter_datapoint[idx].d_recv_time,
558 (minoff == p->filter_datapoint[idx].d_offset || maxoff == p->filter_datapoint[idx].d_offset)
559 ? " (outlier by offset)" : ""
563 sum += dispersion(&p->filter_datapoint[idx]) / (2 << i);
565 if (minoff == p->filter_datapoint[idx].d_offset) {
566 minoff -= 1; /* so that we don't match it ever again */
568 if (maxoff == p->filter_datapoint[idx].d_offset) {
571 oldest_off = p->filter_datapoint[idx].d_offset;
572 oldest_age = G.cur_time - p->filter_datapoint[idx].d_recv_time;
575 newest_off = oldest_off;
576 newest_age = oldest_age;
583 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
585 p->filter_dispersion = sum;
586 wavg += x; /* add another older6/64 to form older6/32 */
587 /* Fix systematic underestimation with large poll intervals.
588 * Imagine that we still have a bit of uncorrected drift,
589 * and poll interval is big (say, 100 sec). Offsets form a progression:
590 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
591 * The algorithm above drops 0.0 and 0.7 as outliers,
592 * and then we have this estimation, ~25% off from 0.7:
593 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
595 x = oldest_age - newest_age;
597 x = newest_age / x; /* in above example, 100 / (600 - 100) */
598 if (x < 1) { /* paranoia check */
599 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
603 p->filter_offset = wavg;
605 /* +----- -----+ ^ 1/2
609 * filter_jitter = | --- * / (avg-offset_j) |
613 * where n is the number of valid datapoints in the filter (n > 1);
614 * if filter_jitter < precision then filter_jitter = precision
617 for (i = 0; i < NUM_DATAPOINTS; i++) {
618 sum += SQUARE(wavg - p->filter_datapoint[i].d_offset);
620 sum = SQRT(sum / NUM_DATAPOINTS);
621 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
623 VERB3 bb_error_msg("filter offset:%+f(corr:%e) disp:%f jitter:%f",
625 p->filter_dispersion,
630 reset_peer_stats(peer_t *p, double offset)
633 bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
635 for (i = 0; i < NUM_DATAPOINTS; i++) {
637 p->filter_datapoint[i].d_recv_time += offset;
638 if (p->filter_datapoint[i].d_offset != 0) {
639 p->filter_datapoint[i].d_offset -= offset;
640 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
642 // p->filter_datapoint[i].d_offset + offset,
643 // p->filter_datapoint[i].d_offset);
646 p->filter_datapoint[i].d_recv_time = G.cur_time;
647 p->filter_datapoint[i].d_offset = 0;
648 p->filter_datapoint[i].d_dispersion = MAXDISP;
652 p->lastpkt_recv_time += offset;
654 p->reachable_bits = 0;
655 p->lastpkt_recv_time = G.cur_time;
657 filter_datapoints(p); /* recalc p->filter_xxx */
658 VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
666 p = xzalloc(sizeof(*p));
667 p->p_lsa = xhost2sockaddr(s, 123);
668 p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
670 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
671 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
672 reset_peer_stats(p, 16 * STEP_THRESHOLD);
674 llist_add_to(&G.ntp_peers, p);
680 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
681 msg_t *msg, ssize_t len)
687 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
689 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
692 bb_perror_msg("send failed");
699 send_query_to_peer(peer_t *p)
701 /* Why do we need to bind()?
702 * See what happens when we don't bind:
704 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
705 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
706 * gettimeofday({1259071266, 327885}, NULL) = 0
707 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
708 * ^^^ we sent it from some source port picked by kernel.
709 * time(NULL) = 1259071266
710 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
711 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
712 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
713 * ^^^ this recv will receive packets to any local port!
715 * Uncomment this and use strace to see it in action:
717 #define PROBE_LOCAL_ADDR /* { len_and_sockaddr lsa; lsa.len = LSA_SIZEOF_SA; getsockname(p->query.fd, &lsa.u.sa, &lsa.len); } */
721 len_and_sockaddr *local_lsa;
723 family = p->p_lsa->u.sa.sa_family;
724 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
725 /* local_lsa has "null" address and port 0 now.
726 * bind() ensures we have a *particular port* selected by kernel
727 * and remembered in p->p_fd, thus later recv(p->p_fd)
728 * receives only packets sent to this port.
731 xbind(fd, &local_lsa->u.sa, local_lsa->len);
733 #if ENABLE_FEATURE_IPV6
734 if (family == AF_INET)
736 setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
740 /* Emit message _before_ attempted send. Think of a very short
741 * roundtrip networks: we need to go back to recv loop ASAP,
742 * to reduce delay. Printing messages after send works against that.
744 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
747 * Send out a random 64-bit number as our transmit time. The NTP
748 * server will copy said number into the originate field on the
749 * response that it sends us. This is totally legal per the SNTP spec.
751 * The impact of this is two fold: we no longer send out the current
752 * system time for the world to see (which may aid an attacker), and
753 * it gives us a (not very secure) way of knowing that we're not
754 * getting spoofed by an attacker that can't capture our traffic
755 * but can spoof packets from the NTP server we're communicating with.
757 * Save the real transmit timestamp locally.
759 p->p_xmt_msg.m_xmttime.int_partl = random();
760 p->p_xmt_msg.m_xmttime.fractionl = random();
761 p->p_xmttime = gettime1900d();
763 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
764 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
768 set_next(p, RETRY_INTERVAL);
772 p->reachable_bits <<= 1;
773 set_next(p, RESPONSE_INTERVAL);
777 /* Note that there is no provision to prevent several run_scripts
778 * to be done in quick succession. In fact, it happens rather often
779 * if initial syncronization results in a step.
780 * You will see "step" and then "stratum" script runs, sometimes
781 * as close as only 0.002 seconds apart.
782 * Script should be ready to deal with this.
784 static void run_script(const char *action, double offset)
787 char *env1, *env2, *env3, *env4;
792 argv[0] = (char*) G.script_name;
793 argv[1] = (char*) action;
796 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
798 env1 = xasprintf("%s=%u", "stratum", G.stratum);
800 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
802 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
804 env4 = xasprintf("%s=%f", "offset", offset);
806 /* Other items of potential interest: selected peer,
807 * rootdelay, reftime, rootdisp, refid, ntp_status,
808 * last_update_offset, last_update_recv_time, discipline_jitter,
809 * how many peers have reachable_bits = 0?
812 /* Don't want to wait: it may run hwclock --systohc, and that
813 * may take some time (seconds): */
814 /*spawn_and_wait(argv);*/
818 unsetenv("freq_drift_ppm");
819 unsetenv("poll_interval");
826 G.last_script_run = G.cur_time;
830 step_time(double offset)
834 struct timeval tvc, tvn;
835 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
838 gettimeofday(&tvc, NULL); /* never fails */
839 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
840 d_to_tv(dtime, &tvn);
841 if (settimeofday(&tvn, NULL) == -1)
842 bb_perror_msg_and_die("settimeofday");
846 strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", localtime(&tval));
847 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
850 strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", localtime(&tval));
851 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
853 /* Correct various fields which contain time-relative values: */
855 /* p->lastpkt_recv_time, p->next_action_time and such: */
856 for (item = G.ntp_peers; item != NULL; item = item->link) {
857 peer_t *pp = (peer_t *) item->data;
858 reset_peer_stats(pp, offset);
859 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
860 // offset, pp->next_action_time, pp->next_action_time + offset);
861 pp->next_action_time += offset;
864 G.cur_time += offset;
865 G.last_update_recv_time += offset;
866 G.last_script_run += offset;
871 * Selection and clustering, and their helpers
877 double opt_rd; /* optimization */
880 compare_point_edge(const void *aa, const void *bb)
882 const point_t *a = aa;
883 const point_t *b = bb;
884 if (a->edge < b->edge) {
887 return (a->edge > b->edge);
894 compare_survivor_metric(const void *aa, const void *bb)
896 const survivor_t *a = aa;
897 const survivor_t *b = bb;
898 if (a->metric < b->metric) {
901 return (a->metric > b->metric);
904 fit(peer_t *p, double rd)
906 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
907 /* One or zero bits in reachable_bits */
908 VERB3 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
911 #if 0 /* we filter out such packets earlier */
912 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
913 || p->lastpkt_stratum >= MAXSTRAT
915 VERB3 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
919 /* rd is root_distance(p) */
920 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
921 VERB3 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
925 // /* Do we have a loop? */
926 // if (p->refid == p->dstaddr || p->refid == s.refid)
931 select_and_cluster(void)
936 int size = 3 * G.peer_cnt;
937 /* for selection algorithm */
939 unsigned num_points, num_candidates;
941 unsigned num_falsetickers;
942 /* for cluster algorithm */
943 survivor_t survivor[size];
944 unsigned num_survivors;
950 if (G.initial_poll_complete) while (item != NULL) {
953 p = (peer_t *) item->data;
954 rd = root_distance(p);
955 offset = p->filter_offset;
961 VERB4 bb_error_msg("interval: [%f %f %f] %s",
967 point[num_points].p = p;
968 point[num_points].type = -1;
969 point[num_points].edge = offset - rd;
970 point[num_points].opt_rd = rd;
972 point[num_points].p = p;
973 point[num_points].type = 0;
974 point[num_points].edge = offset;
975 point[num_points].opt_rd = rd;
977 point[num_points].p = p;
978 point[num_points].type = 1;
979 point[num_points].edge = offset + rd;
980 point[num_points].opt_rd = rd;
984 num_candidates = num_points / 3;
985 if (num_candidates == 0) {
986 VERB3 bb_error_msg("no valid datapoints, no peer selected");
989 //TODO: sorting does not seem to be done in reference code
990 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
992 /* Start with the assumption that there are no falsetickers.
993 * Attempt to find a nonempty intersection interval containing
994 * the midpoints of all truechimers.
995 * If a nonempty interval cannot be found, increase the number
996 * of assumed falsetickers by one and try again.
997 * If a nonempty interval is found and the number of falsetickers
998 * is less than the number of truechimers, a majority has been found
999 * and the midpoint of each truechimer represents
1000 * the candidates available to the cluster algorithm.
1002 num_falsetickers = 0;
1005 unsigned num_midpoints = 0;
1010 for (i = 0; i < num_points; i++) {
1012 * if (point[i].type == -1) c++;
1013 * if (point[i].type == 1) c--;
1014 * and it's simpler to do it this way:
1017 if (c >= num_candidates - num_falsetickers) {
1018 /* If it was c++ and it got big enough... */
1019 low = point[i].edge;
1022 if (point[i].type == 0)
1026 for (i = num_points-1; i >= 0; i--) {
1028 if (c >= num_candidates - num_falsetickers) {
1029 high = point[i].edge;
1032 if (point[i].type == 0)
1035 /* If the number of midpoints is greater than the number
1036 * of allowed falsetickers, the intersection contains at
1037 * least one truechimer with no midpoint - bad.
1038 * Also, interval should be nonempty.
1040 if (num_midpoints <= num_falsetickers && low < high)
1043 if (num_falsetickers * 2 >= num_candidates) {
1044 VERB3 bb_error_msg("too many falsetickers:%d (candidates:%d), no peer selected",
1045 num_falsetickers, num_candidates);
1049 VERB3 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
1050 low, high, num_candidates, num_falsetickers);
1054 /* Construct a list of survivors (p, metric)
1055 * from the chime list, where metric is dominated
1056 * first by stratum and then by root distance.
1057 * All other things being equal, this is the order of preference.
1060 for (i = 0; i < num_points; i++) {
1061 if (point[i].edge < low || point[i].edge > high)
1064 survivor[num_survivors].p = p;
1065 /* x.opt_rd == root_distance(p); */
1066 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
1067 VERB4 bb_error_msg("survivor[%d] metric:%f peer:%s",
1068 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1071 /* There must be at least MIN_SELECTED survivors to satisfy the
1072 * correctness assertions. Ordinarily, the Byzantine criteria
1073 * require four survivors, but for the demonstration here, one
1076 if (num_survivors < MIN_SELECTED) {
1077 VERB3 bb_error_msg("num_survivors %d < %d, no peer selected",
1078 num_survivors, MIN_SELECTED);
1082 //looks like this is ONLY used by the fact that later we pick survivor[0].
1083 //we can avoid sorting then, just find the minimum once!
1084 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1086 /* For each association p in turn, calculate the selection
1087 * jitter p->sjitter as the square root of the sum of squares
1088 * (p->offset - q->offset) over all q associations. The idea is
1089 * to repeatedly discard the survivor with maximum selection
1090 * jitter until a termination condition is met.
1093 unsigned max_idx = max_idx;
1094 double max_selection_jitter = max_selection_jitter;
1095 double min_jitter = min_jitter;
1097 if (num_survivors <= MIN_CLUSTERED) {
1098 VERB3 bb_error_msg("num_survivors %d <= %d, not discarding more",
1099 num_survivors, MIN_CLUSTERED);
1103 /* To make sure a few survivors are left
1104 * for the clustering algorithm to chew on,
1105 * we stop if the number of survivors
1106 * is less than or equal to MIN_CLUSTERED (3).
1108 for (i = 0; i < num_survivors; i++) {
1109 double selection_jitter_sq;
1112 if (i == 0 || p->filter_jitter < min_jitter)
1113 min_jitter = p->filter_jitter;
1115 selection_jitter_sq = 0;
1116 for (j = 0; j < num_survivors; j++) {
1117 peer_t *q = survivor[j].p;
1118 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1120 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1121 max_selection_jitter = selection_jitter_sq;
1124 VERB5 bb_error_msg("survivor %d selection_jitter^2:%f",
1125 i, selection_jitter_sq);
1127 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
1128 VERB4 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
1129 max_idx, max_selection_jitter, min_jitter);
1131 /* If the maximum selection jitter is less than the
1132 * minimum peer jitter, then tossing out more survivors
1133 * will not lower the minimum peer jitter, so we might
1136 if (max_selection_jitter < min_jitter) {
1137 VERB3 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
1138 max_selection_jitter, min_jitter, num_survivors);
1142 /* Delete survivor[max_idx] from the list
1143 * and go around again.
1145 VERB5 bb_error_msg("dropping survivor %d", max_idx);
1147 while (max_idx < num_survivors) {
1148 survivor[max_idx] = survivor[max_idx + 1];
1154 /* Combine the offsets of the clustering algorithm survivors
1155 * using a weighted average with weight determined by the root
1156 * distance. Compute the selection jitter as the weighted RMS
1157 * difference between the first survivor and the remaining
1158 * survivors. In some cases the inherent clock jitter can be
1159 * reduced by not using this algorithm, especially when frequent
1160 * clockhopping is involved. bbox: thus we don't do it.
1164 for (i = 0; i < num_survivors; i++) {
1166 x = root_distance(p);
1168 z += p->filter_offset / x;
1169 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1171 //G.cluster_offset = z / y;
1172 //G.cluster_jitter = SQRT(w / y);
1175 /* Pick the best clock. If the old system peer is on the list
1176 * and at the same stratum as the first survivor on the list,
1177 * then don't do a clock hop. Otherwise, select the first
1178 * survivor on the list as the new system peer.
1181 if (G.last_update_peer
1182 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1184 /* Starting from 1 is ok here */
1185 for (i = 1; i < num_survivors; i++) {
1186 if (G.last_update_peer == survivor[i].p) {
1187 VERB4 bb_error_msg("keeping old synced peer");
1188 p = G.last_update_peer;
1193 G.last_update_peer = p;
1195 VERB3 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
1198 G.cur_time - p->lastpkt_recv_time
1205 * Local clock discipline and its helpers
1208 set_new_values(int disc_state, double offset, double recv_time)
1210 /* Enter new state and set state variables. Note we use the time
1211 * of the last clock filter sample, which must be earlier than
1214 VERB3 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
1215 disc_state, offset, recv_time);
1216 G.discipline_state = disc_state;
1217 G.last_update_offset = offset;
1218 G.last_update_recv_time = recv_time;
1220 /* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
1222 update_local_clock(peer_t *p)
1226 /* Note: can use G.cluster_offset instead: */
1227 double offset = p->filter_offset;
1228 double recv_time = p->lastpkt_recv_time;
1230 #if !USING_KERNEL_PLL_LOOP
1233 double since_last_update;
1234 double etemp, dtemp;
1236 abs_offset = fabs(offset);
1239 /* If needed, -S script can do it by looking at $offset
1240 * env var and killing parent */
1241 /* If the offset is too large, give up and go home */
1242 if (abs_offset > PANIC_THRESHOLD) {
1243 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1247 /* If this is an old update, for instance as the result
1248 * of a system peer change, avoid it. We never use
1249 * an old sample or the same sample twice.
1251 if (recv_time <= G.last_update_recv_time) {
1252 VERB3 bb_error_msg("same or older datapoint: %f >= %f, not using it",
1253 G.last_update_recv_time, recv_time);
1254 return 0; /* "leave poll interval as is" */
1257 /* Clock state machine transition function. This is where the
1258 * action is and defines how the system reacts to large time
1259 * and frequency errors.
1261 since_last_update = recv_time - G.reftime;
1262 #if !USING_KERNEL_PLL_LOOP
1265 #if USING_INITIAL_FREQ_ESTIMATION
1266 if (G.discipline_state == STATE_FREQ) {
1267 /* Ignore updates until the stepout threshold */
1268 if (since_last_update < WATCH_THRESHOLD) {
1269 VERB3 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
1270 WATCH_THRESHOLD - since_last_update);
1271 return 0; /* "leave poll interval as is" */
1273 # if !USING_KERNEL_PLL_LOOP
1274 freq_drift = (offset - G.last_update_offset) / since_last_update;
1279 /* There are two main regimes: when the
1280 * offset exceeds the step threshold and when it does not.
1282 if (abs_offset > STEP_THRESHOLD) {
1283 switch (G.discipline_state) {
1285 /* The first outlyer: ignore it, switch to SPIK state */
1286 VERB3 bb_error_msg("offset:%+f - spike detected", offset);
1287 G.discipline_state = STATE_SPIK;
1288 return -1; /* "decrease poll interval" */
1291 /* Ignore succeeding outlyers until either an inlyer
1292 * is found or the stepout threshold is exceeded.
1294 if (since_last_update < WATCH_THRESHOLD) {
1295 VERB3 bb_error_msg("spike detected, datapoint ignored, %f sec remains",
1296 WATCH_THRESHOLD - since_last_update);
1297 return -1; /* "decrease poll interval" */
1299 /* fall through: we need to step */
1302 /* Step the time and clamp down the poll interval.
1304 * In NSET state an initial frequency correction is
1305 * not available, usually because the frequency file has
1306 * not yet been written. Since the time is outside the
1307 * capture range, the clock is stepped. The frequency
1308 * will be set directly following the stepout interval.
1310 * In FSET state the initial frequency has been set
1311 * from the frequency file. Since the time is outside
1312 * the capture range, the clock is stepped immediately,
1313 * rather than after the stepout interval. Guys get
1314 * nervous if it takes 17 minutes to set the clock for
1317 * In SPIK state the stepout threshold has expired and
1318 * the phase is still above the step threshold. Note
1319 * that a single spike greater than the step threshold
1320 * is always suppressed, even at the longer poll
1323 VERB3 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
1325 if (option_mask32 & OPT_q) {
1326 /* We were only asked to set time once. Done. */
1330 G.polladj_count = 0;
1331 G.poll_exp = MINPOLL;
1332 G.stratum = MAXSTRAT;
1334 run_script("step", offset);
1336 #if USING_INITIAL_FREQ_ESTIMATION
1337 if (G.discipline_state == STATE_NSET) {
1338 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1339 return 1; /* "ok to increase poll interval" */
1343 set_new_values(STATE_SYNC, offset, recv_time);
1345 } else { /* abs_offset <= STEP_THRESHOLD */
1347 if (G.poll_exp < MINPOLL && G.initial_poll_complete) {
1348 VERB3 bb_error_msg("small offset:%+f, disabling burst mode", offset);
1349 G.polladj_count = 0;
1350 G.poll_exp = MINPOLL;
1353 /* Compute the clock jitter as the RMS of exponentially
1354 * weighted offset differences. Used by the poll adjust code.
1356 etemp = SQUARE(G.discipline_jitter);
1357 dtemp = SQUARE(offset - G.last_update_offset);
1358 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
1359 if (G.discipline_jitter < G_precision_sec)
1360 G.discipline_jitter = G_precision_sec;
1361 G.offset_to_jitter_ratio = fabs(offset) / G.discipline_jitter;
1362 VERB3 bb_error_msg("discipline jitter=%f", G.discipline_jitter);
1364 switch (G.discipline_state) {
1366 if (option_mask32 & OPT_q) {
1367 /* We were only asked to set time once.
1368 * The clock is precise enough, no need to step.
1372 #if USING_INITIAL_FREQ_ESTIMATION
1373 /* This is the first update received and the frequency
1374 * has not been initialized. The first thing to do
1375 * is directly measure the oscillator frequency.
1377 set_new_values(STATE_FREQ, offset, recv_time);
1379 set_new_values(STATE_SYNC, offset, recv_time);
1381 VERB3 bb_error_msg("transitioning to FREQ, datapoint ignored");
1382 return 0; /* "leave poll interval as is" */
1384 #if 0 /* this is dead code for now */
1386 /* This is the first update and the frequency
1387 * has been initialized. Adjust the phase, but
1388 * don't adjust the frequency until the next update.
1390 set_new_values(STATE_SYNC, offset, recv_time);
1391 /* freq_drift remains 0 */
1395 #if USING_INITIAL_FREQ_ESTIMATION
1397 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1398 * Correct the phase and frequency and switch to SYNC state.
1399 * freq_drift was already estimated (see code above)
1401 set_new_values(STATE_SYNC, offset, recv_time);
1406 #if !USING_KERNEL_PLL_LOOP
1407 /* Compute freq_drift due to PLL and FLL contributions.
1409 * The FLL and PLL frequency gain constants
1410 * depend on the poll interval and Allan
1411 * intercept. The FLL is not used below one-half
1412 * the Allan intercept. Above that the loop gain
1413 * increases in steps to 1 / AVG.
1415 if ((1 << G.poll_exp) > ALLAN / 2) {
1416 etemp = FLL - G.poll_exp;
1419 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1421 /* For the PLL the integration interval
1422 * (numerator) is the minimum of the update
1423 * interval and poll interval. This allows
1424 * oversampling, but not undersampling.
1426 etemp = MIND(since_last_update, (1 << G.poll_exp));
1427 dtemp = (4 * PLL) << G.poll_exp;
1428 freq_drift += offset * etemp / SQUARE(dtemp);
1430 set_new_values(STATE_SYNC, offset, recv_time);
1433 if (G.stratum != p->lastpkt_stratum + 1) {
1434 G.stratum = p->lastpkt_stratum + 1;
1435 run_script("stratum", offset);
1439 G.reftime = G.cur_time;
1440 G.ntp_status = p->lastpkt_status;
1441 G.refid = p->lastpkt_refid;
1442 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
1443 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
1444 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
1445 G.rootdisp = p->lastpkt_rootdisp + dtemp;
1446 VERB3 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
1448 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1449 * (Any other state does not reach this, they all return earlier)
1450 * By this time, freq_drift and offset are set
1451 * to values suitable for adjtimex.
1453 #if !USING_KERNEL_PLL_LOOP
1454 /* Calculate the new frequency drift and frequency stability (wander).
1455 * Compute the clock wander as the RMS of exponentially weighted
1456 * frequency differences. This is not used directly, but can,
1457 * along with the jitter, be a highly useful monitoring and
1460 dtemp = G.discipline_freq_drift + freq_drift;
1461 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
1462 etemp = SQUARE(G.discipline_wander);
1463 dtemp = SQUARE(dtemp);
1464 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1466 VERB3 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
1467 G.discipline_freq_drift,
1468 (long)(G.discipline_freq_drift * 65536e6),
1470 G.discipline_wander);
1473 memset(&tmx, 0, sizeof(tmx));
1474 if (adjtimex(&tmx) < 0)
1475 bb_perror_msg_and_die("adjtimex");
1476 VERB3 bb_error_msg("p adjtimex freq:%ld offset:%+ld constant:%ld status:0x%x",
1477 tmx.freq, tmx.offset, tmx.constant, tmx.status);
1480 memset(&tmx, 0, sizeof(tmx));
1482 //doesn't work, offset remains 0 (!) in kernel:
1483 //ntpd: set adjtimex freq:1786097 tmx.offset:77487
1484 //ntpd: prev adjtimex freq:1786097 tmx.offset:0
1485 //ntpd: cur adjtimex freq:1786097 tmx.offset:0
1486 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1487 /* 65536 is one ppm */
1488 tmx.freq = G.discipline_freq_drift * 65536e6;
1490 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
1491 tmx.offset = (offset * 1000000); /* usec */
1492 tmx.status = STA_PLL;
1493 if (G.ntp_status & LI_PLUSSEC)
1494 tmx.status |= STA_INS;
1495 if (G.ntp_status & LI_MINUSSEC)
1496 tmx.status |= STA_DEL;
1498 tmx.constant = G.poll_exp - 4;
1500 * The below if statement should be unnecessary, but...
1501 * It looks like Linux kernel's PLL is far too gentle in changing
1502 * tmx.freq in response to clock offset. Offset keeps growing
1503 * and eventually we fall back to smaller poll intervals.
1504 * We can make correction more agressive (about x2) by supplying
1505 * PLL time constant which is one less than the real one.
1506 * To be on a safe side, let's do it only if offset is significantly
1507 * larger than jitter.
1509 if (tmx.constant > 0 && G.offset_to_jitter_ratio > TIMECONST_HACK_GATE)
1512 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1513 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
1514 rc = adjtimex(&tmx);
1516 bb_perror_msg_and_die("adjtimex");
1517 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1518 * Not sure why. Perhaps it is normal.
1520 VERB3 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
1521 rc, tmx.freq, tmx.offset, tmx.status);
1522 G.kernel_freq_drift = tmx.freq / 65536;
1523 VERB2 bb_error_msg("update peer:%s, offset:%+f, jitter:%f, clock drift:%+.3f ppm, tc:%d",
1524 p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
1526 return 1; /* "ok to increase poll interval" */
1531 * We've got a new reply packet from a peer, process it
1535 retry_interval(void)
1537 /* Local problem, want to retry soon */
1538 unsigned interval, r;
1539 interval = RETRY_INTERVAL;
1541 interval += r % (unsigned)(RETRY_INTERVAL / 4);
1542 VERB3 bb_error_msg("chose retry interval:%u", interval);
1546 poll_interval(int exponent)
1548 unsigned interval, r;
1549 exponent = G.poll_exp + exponent;
1552 interval = 1 << exponent;
1554 interval += ((r & (interval-1)) >> 4) + ((r >> 8) & 1); /* + 1/16 of interval, max */
1555 VERB3 bb_error_msg("chose poll interval:%u (poll_exp:%d exp:%d)", interval, G.poll_exp, exponent);
1558 static NOINLINE void
1559 recv_and_process_peer_pkt(peer_t *p)
1564 double T1, T2, T3, T4;
1566 datapoint_t *datapoint;
1569 /* We can recvfrom here and check from.IP, but some multihomed
1570 * ntp servers reply from their *other IP*.
1571 * TODO: maybe we should check at least what we can: from.port == 123?
1573 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
1575 bb_perror_msg("recv(%s) error", p->p_dotted);
1576 if (errno == EHOSTUNREACH || errno == EHOSTDOWN
1577 || errno == ENETUNREACH || errno == ENETDOWN
1578 || errno == ECONNREFUSED || errno == EADDRNOTAVAIL
1581 //TODO: always do this?
1582 interval = retry_interval();
1583 goto set_next_and_close_sock;
1588 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1589 bb_error_msg("malformed packet received from %s", p->p_dotted);
1593 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1594 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1599 if ((msg.m_status & LI_ALARM) == LI_ALARM
1600 || msg.m_stratum == 0
1601 || msg.m_stratum > NTP_MAXSTRATUM
1603 // TODO: stratum 0 responses may have commands in 32-bit m_refid field:
1604 // "DENY", "RSTR" - peer does not like us at all
1605 // "RATE" - peer is overloaded, reduce polling freq
1606 interval = poll_interval(0);
1607 bb_error_msg("reply from %s: not synced, next query in %us", p->p_dotted, interval);
1608 goto set_next_and_close_sock;
1611 // /* Verify valid root distance */
1612 // if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1613 // return; /* invalid header values */
1615 p->lastpkt_status = msg.m_status;
1616 p->lastpkt_stratum = msg.m_stratum;
1617 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1618 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1619 p->lastpkt_refid = msg.m_refid;
1622 * From RFC 2030 (with a correction to the delay math):
1624 * Timestamp Name ID When Generated
1625 * ------------------------------------------------------------
1626 * Originate Timestamp T1 time request sent by client
1627 * Receive Timestamp T2 time request received by server
1628 * Transmit Timestamp T3 time reply sent by server
1629 * Destination Timestamp T4 time reply received by client
1631 * The roundtrip delay and local clock offset are defined as
1633 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1636 T2 = lfp_to_d(msg.m_rectime);
1637 T3 = lfp_to_d(msg.m_xmttime);
1640 p->lastpkt_recv_time = T4;
1642 VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1643 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1644 datapoint = &p->filter_datapoint[p->datapoint_idx];
1645 datapoint->d_recv_time = T4;
1646 datapoint->d_offset = ((T2 - T1) + (T3 - T4)) / 2;
1647 /* The delay calculation is a special case. In cases where the
1648 * server and client clocks are running at different rates and
1649 * with very fast networks, the delay can appear negative. In
1650 * order to avoid violating the Principle of Least Astonishment,
1651 * the delay is clamped not less than the system precision.
1653 p->lastpkt_delay = (T4 - T1) - (T3 - T2);
1654 if (p->lastpkt_delay < G_precision_sec)
1655 p->lastpkt_delay = G_precision_sec;
1656 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
1657 if (!p->reachable_bits) {
1658 /* 1st datapoint ever - replicate offset in every element */
1660 for (i = 0; i < NUM_DATAPOINTS; i++) {
1661 p->filter_datapoint[i].d_offset = datapoint->d_offset;
1665 p->reachable_bits |= 1;
1666 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
1667 bb_error_msg("reply from %s: reach 0x%02x offset %+f delay %f status 0x%02x strat %d refid 0x%08x rootdelay %f",
1670 datapoint->d_offset,
1675 p->lastpkt_rootdelay
1676 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1677 * m_reftime, m_orgtime, m_rectime, m_xmttime
1682 /* Muck with statictics and update the clock */
1683 filter_datapoints(p);
1684 q = select_and_cluster();
1688 if (!(option_mask32 & OPT_w)) {
1689 rc = update_local_clock(q);
1690 /* If drift is dangerously large, immediately
1691 * drop poll interval one step down.
1693 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
1694 VERB3 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
1699 /* else: no peer selected, rc = -1: we want to poll more often */
1702 /* Adjust the poll interval by comparing the current offset
1703 * with the clock jitter. If the offset is less than
1704 * the clock jitter times a constant, then the averaging interval
1705 * is increased, otherwise it is decreased. A bit of hysteresis
1706 * helps calm the dance. Works best using burst mode.
1709 bb_error_msg("offset:%+f POLLADJ_GATE*discipline_jitter:%f poll:%s",
1710 q->filter_offset, POLLADJ_GATE * G.discipline_jitter,
1711 fabs(q->filter_offset) < POLLADJ_GATE * G.discipline_jitter
1715 if (rc > 0 && G.offset_to_jitter_ratio < POLLADJ_GATE) {
1716 /* was += G.poll_exp but it is a bit
1717 * too optimistic for my taste at high poll_exp's */
1718 G.polladj_count += MINPOLL;
1719 if (G.polladj_count > POLLADJ_LIMIT) {
1720 G.polladj_count = 0;
1721 if (G.poll_exp < MAXPOLL) {
1723 VERB3 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1724 G.discipline_jitter, G.poll_exp);
1727 VERB3 bb_error_msg("polladj: incr:%d", G.polladj_count);
1730 G.polladj_count -= G.poll_exp * 2;
1731 if (G.polladj_count < -POLLADJ_LIMIT || G.poll_exp >= BIGPOLL) {
1733 G.polladj_count = 0;
1734 if (G.poll_exp > MINPOLL) {
1738 /* Correct p->next_action_time in each peer
1739 * which waits for sending, so that they send earlier.
1740 * Old pp->next_action_time are on the order
1741 * of t + (1 << old_poll_exp) + small_random,
1742 * we simply need to subtract ~half of that.
1744 for (item = G.ntp_peers; item != NULL; item = item->link) {
1745 peer_t *pp = (peer_t *) item->data;
1747 pp->next_action_time -= (1 << G.poll_exp);
1749 VERB3 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1750 G.discipline_jitter, G.poll_exp);
1753 VERB3 bb_error_msg("polladj: decr:%d", G.polladj_count);
1758 /* Decide when to send new query for this peer */
1759 interval = poll_interval(0);
1761 set_next_and_close_sock:
1762 set_next(p, interval);
1763 /* We do not expect any more packets from this peer for now.
1764 * Closing the socket informs kernel about it.
1765 * We open a new socket when we send a new query.
1773 #if ENABLE_FEATURE_NTPD_SERVER
1774 static NOINLINE void
1775 recv_and_process_client_pkt(void /*int fd*/)
1779 len_and_sockaddr *to;
1780 struct sockaddr *from;
1782 uint8_t query_status;
1783 l_fixedpt_t query_xmttime;
1785 to = get_sock_lsa(G.listen_fd);
1786 from = xzalloc(to->len);
1788 size = recv_from_to(G.listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
1789 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1792 if (errno == EAGAIN)
1794 bb_perror_msg_and_die("recv");
1796 addr = xmalloc_sockaddr2dotted_noport(from);
1797 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1802 query_status = msg.m_status;
1803 query_xmttime = msg.m_xmttime;
1805 /* Build a reply packet */
1806 memset(&msg, 0, sizeof(msg));
1807 msg.m_status = G.stratum < MAXSTRAT ? G.ntp_status : LI_ALARM;
1808 msg.m_status |= (query_status & VERSION_MASK);
1809 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
1810 MODE_SERVER : MODE_SYM_PAS;
1811 msg.m_stratum = G.stratum;
1812 msg.m_ppoll = G.poll_exp;
1813 msg.m_precision_exp = G_precision_exp;
1814 /* this time was obtained between poll() and recv() */
1815 msg.m_rectime = d_to_lfp(G.cur_time);
1816 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
1817 if (G.peer_cnt == 0) {
1818 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
1819 G.reftime = G.cur_time;
1821 msg.m_reftime = d_to_lfp(G.reftime);
1822 msg.m_orgtime = query_xmttime;
1823 msg.m_rootdelay = d_to_sfp(G.rootdelay);
1824 //simple code does not do this, fix simple code!
1825 msg.m_rootdisp = d_to_sfp(G.rootdisp);
1826 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
1827 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
1829 /* We reply from the local address packet was sent to,
1830 * this makes to/from look swapped here: */
1831 do_sendto(G.listen_fd,
1832 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
1841 /* Upstream ntpd's options:
1843 * -4 Force DNS resolution of host names to the IPv4 namespace.
1844 * -6 Force DNS resolution of host names to the IPv6 namespace.
1845 * -a Require cryptographic authentication for broadcast client,
1846 * multicast client and symmetric passive associations.
1847 * This is the default.
1848 * -A Do not require cryptographic authentication for broadcast client,
1849 * multicast client and symmetric passive associations.
1850 * This is almost never a good idea.
1851 * -b Enable the client to synchronize to broadcast servers.
1853 * Specify the name and path of the configuration file,
1854 * default /etc/ntp.conf
1855 * -d Specify debugging mode. This option may occur more than once,
1856 * with each occurrence indicating greater detail of display.
1858 * Specify debugging level directly.
1860 * Specify the name and path of the frequency file.
1861 * This is the same operation as the "driftfile FILE"
1862 * configuration command.
1863 * -g Normally, ntpd exits with a message to the system log
1864 * if the offset exceeds the panic threshold, which is 1000 s
1865 * by default. This option allows the time to be set to any value
1866 * without restriction; however, this can happen only once.
1867 * If the threshold is exceeded after that, ntpd will exit
1868 * with a message to the system log. This option can be used
1869 * with the -q and -x options. See the tinker command for other options.
1871 * Chroot the server to the directory jaildir. This option also implies
1872 * that the server attempts to drop root privileges at startup
1873 * (otherwise, chroot gives very little additional security).
1874 * You may need to also specify a -u option.
1876 * Specify the name and path of the symmetric key file,
1877 * default /etc/ntp/keys. This is the same operation
1878 * as the "keys FILE" configuration command.
1880 * Specify the name and path of the log file. The default
1881 * is the system log file. This is the same operation as
1882 * the "logfile FILE" configuration command.
1883 * -L Do not listen to virtual IPs. The default is to listen.
1885 * -N To the extent permitted by the operating system,
1886 * run the ntpd at the highest priority.
1888 * Specify the name and path of the file used to record the ntpd
1889 * process ID. This is the same operation as the "pidfile FILE"
1890 * configuration command.
1892 * To the extent permitted by the operating system,
1893 * run the ntpd at the specified priority.
1894 * -q Exit the ntpd just after the first time the clock is set.
1895 * This behavior mimics that of the ntpdate program, which is
1896 * to be retired. The -g and -x options can be used with this option.
1897 * Note: The kernel time discipline is disabled with this option.
1899 * Specify the default propagation delay from the broadcast/multicast
1900 * server to this client. This is necessary only if the delay
1901 * cannot be computed automatically by the protocol.
1903 * Specify the directory path for files created by the statistics
1904 * facility. This is the same operation as the "statsdir DIR"
1905 * configuration command.
1907 * Add a key number to the trusted key list. This option can occur
1910 * Specify a user, and optionally a group, to switch to.
1913 * Add a system variable listed by default.
1914 * -x Normally, the time is slewed if the offset is less than the step
1915 * threshold, which is 128 ms by default, and stepped if above
1916 * the threshold. This option sets the threshold to 600 s, which is
1917 * well within the accuracy window to set the clock manually.
1918 * Note: since the slew rate of typical Unix kernels is limited
1919 * to 0.5 ms/s, each second of adjustment requires an amortization
1920 * interval of 2000 s. Thus, an adjustment as much as 600 s
1921 * will take almost 14 days to complete. This option can be used
1922 * with the -g and -q options. See the tinker command for other options.
1923 * Note: The kernel time discipline is disabled with this option.
1926 /* By doing init in a separate function we decrease stack usage
1929 static NOINLINE void ntp_init(char **argv)
1937 bb_error_msg_and_die(bb_msg_you_must_be_root);
1939 /* Set some globals */
1940 G.stratum = MAXSTRAT;
1942 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
1943 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
1947 opt_complementary = "dd:p::wn"; /* d: counter; p: list; -w implies -n */
1948 opts = getopt32(argv,
1950 "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
1952 "46aAbgL", /* compat, ignored */
1953 &peers, &G.script_name, &G.verbose);
1954 if (!(opts & (OPT_p|OPT_l)))
1956 // if (opts & OPT_x) /* disable stepping, only slew is allowed */
1957 // G.time_was_stepped = 1;
1960 add_peers(llist_pop(&peers));
1962 /* -l but no peers: "stratum 1 server" mode */
1965 if (!(opts & OPT_n)) {
1966 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
1967 logmode = LOGMODE_NONE;
1969 #if ENABLE_FEATURE_NTPD_SERVER
1972 G.listen_fd = create_and_bind_dgram_or_die(NULL, 123);
1973 socket_want_pktinfo(G.listen_fd);
1974 setsockopt(G.listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
1977 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
1979 setpriority(PRIO_PROCESS, 0, -15);
1981 /* If network is up, syncronization occurs in ~10 seconds.
1982 * We give "ntpd -q" 10 seconds to get first reply,
1983 * then another 50 seconds to finish syncing.
1985 * I tested ntpd 4.2.6p1 and apparently it never exits
1986 * (will try forever), but it does not feel right.
1987 * The goal of -q is to act like ntpdate: set time
1988 * after a reasonably small period of polling, or fail.
1991 option_mask32 |= OPT_qq;
2008 int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2009 int ntpd_main(int argc UNUSED_PARAM, char **argv)
2017 memset(&G, 0, sizeof(G));
2018 SET_PTR_TO_GLOBALS(&G);
2022 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2023 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2024 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2025 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2027 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
2028 * packets to each peer.
2029 * NB: if some peer is not responding, we may end up sending
2030 * fewer packets to it and more to other peers.
2031 * NB2: sync usually happens using INITIAL_SAMPLES packets,
2032 * since last reply does not come back instantaneously.
2034 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
2036 while (!bb_got_signal) {
2042 /* Nothing between here and poll() blocks for any significant time */
2044 nextaction = G.cur_time + 3600;
2047 #if ENABLE_FEATURE_NTPD_SERVER
2048 if (G.listen_fd != -1) {
2049 pfd[0].fd = G.listen_fd;
2050 pfd[0].events = POLLIN;
2054 /* Pass over peer list, send requests, time out on receives */
2055 for (item = G.ntp_peers; item != NULL; item = item->link) {
2056 peer_t *p = (peer_t *) item->data;
2058 if (p->next_action_time <= G.cur_time) {
2059 if (p->p_fd == -1) {
2060 /* Time to send new req */
2062 G.initial_poll_complete = 1;
2064 send_query_to_peer(p);
2066 /* Timed out waiting for reply */
2069 timeout = poll_interval(-2); /* -2: try a bit sooner */
2070 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
2071 p->p_dotted, p->reachable_bits, timeout);
2072 set_next(p, timeout);
2076 if (p->next_action_time < nextaction)
2077 nextaction = p->next_action_time;
2080 /* Wait for reply from this peer */
2081 pfd[i].fd = p->p_fd;
2082 pfd[i].events = POLLIN;
2088 timeout = nextaction - G.cur_time;
2091 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
2093 /* Here we may block */
2095 if (i > (ENABLE_FEATURE_NTPD_SERVER && G.listen_fd != -1)) {
2096 /* We wait for at least one reply.
2097 * Poll for it, without wasting time for message.
2098 * Since replies often come under 1 second, this also
2099 * reduces clutter in logs.
2101 nfds = poll(pfd, i, 1000);
2107 bb_error_msg("poll %us, sockets:%u, poll interval:%us", timeout, i, 1 << G.poll_exp);
2109 nfds = poll(pfd, i, timeout * 1000);
2111 gettime1900d(); /* sets G.cur_time */
2113 if (G.script_name && G.cur_time - G.last_script_run > 11*60) {
2114 /* Useful for updating battery-backed RTC and such */
2115 run_script("periodic", G.last_update_offset);
2116 gettime1900d(); /* sets G.cur_time */
2121 /* Process any received packets */
2123 #if ENABLE_FEATURE_NTPD_SERVER
2124 if (G.listen_fd != -1) {
2125 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2127 recv_and_process_client_pkt(/*G.listen_fd*/);
2128 gettime1900d(); /* sets G.cur_time */
2133 for (; nfds != 0 && j < i; j++) {
2134 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
2136 * At init, alarm was set to 10 sec.
2137 * Now we did get a reply.
2138 * Increase timeout to 50 seconds to finish syncing.
2140 if (option_mask32 & OPT_qq) {
2141 option_mask32 &= ~OPT_qq;
2145 recv_and_process_peer_pkt(idx2peer[j]);
2146 gettime1900d(); /* sets G.cur_time */
2149 } /* while (!bb_got_signal) */
2151 kill_myself_with_sig(bb_got_signal);
2159 /*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2161 /*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2165 direct_freq(double fp_offset)
2169 * If the kernel is enabled, we need the residual offset to
2170 * calculate the frequency correction.
2172 if (pll_control && kern_enable) {
2173 memset(&ntv, 0, sizeof(ntv));
2176 clock_offset = ntv.offset / 1e9;
2177 #else /* STA_NANO */
2178 clock_offset = ntv.offset / 1e6;
2179 #endif /* STA_NANO */
2180 drift_comp = FREQTOD(ntv.freq);
2182 #endif /* KERNEL_PLL */
2183 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2189 set_freq(double freq) /* frequency update */
2197 * If the kernel is enabled, update the kernel frequency.
2199 if (pll_control && kern_enable) {
2200 memset(&ntv, 0, sizeof(ntv));
2201 ntv.modes = MOD_FREQUENCY;
2202 ntv.freq = DTOFREQ(drift_comp);
2204 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2205 report_event(EVNT_FSET, NULL, tbuf);
2207 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2208 report_event(EVNT_FSET, NULL, tbuf);
2210 #else /* KERNEL_PLL */
2211 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2212 report_event(EVNT_FSET, NULL, tbuf);
2213 #endif /* KERNEL_PLL */
2222 * This code segment works when clock adjustments are made using
2223 * precision time kernel support and the ntp_adjtime() system
2224 * call. This support is available in Solaris 2.6 and later,
2225 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2226 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2227 * DECstation 5000/240 and Alpha AXP, additional kernel
2228 * modifications provide a true microsecond clock and nanosecond
2229 * clock, respectively.
2231 * Important note: The kernel discipline is used only if the
2232 * step threshold is less than 0.5 s, as anything higher can
2233 * lead to overflow problems. This might occur if some misguided
2234 * lad set the step threshold to something ridiculous.
2236 if (pll_control && kern_enable) {
2238 #define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2241 * We initialize the structure for the ntp_adjtime()
2242 * system call. We have to convert everything to
2243 * microseconds or nanoseconds first. Do not update the
2244 * system variables if the ext_enable flag is set. In
2245 * this case, the external clock driver will update the
2246 * variables, which will be read later by the local
2247 * clock driver. Afterwards, remember the time and
2248 * frequency offsets for jitter and stability values and
2249 * to update the frequency file.
2251 memset(&ntv, 0, sizeof(ntv));
2253 ntv.modes = MOD_STATUS;
2256 ntv.modes = MOD_BITS | MOD_NANO;
2257 #else /* STA_NANO */
2258 ntv.modes = MOD_BITS;
2259 #endif /* STA_NANO */
2260 if (clock_offset < 0)
2265 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2266 ntv.constant = sys_poll;
2267 #else /* STA_NANO */
2268 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2269 ntv.constant = sys_poll - 4;
2270 #endif /* STA_NANO */
2271 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2272 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2273 ntv.status = STA_PLL;
2276 * Enable/disable the PPS if requested.
2279 if (!(pll_status & STA_PPSTIME))
2280 report_event(EVNT_KERN,
2281 NULL, "PPS enabled");
2282 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2284 if (pll_status & STA_PPSTIME)
2285 report_event(EVNT_KERN,
2286 NULL, "PPS disabled");
2287 ntv.status &= ~(STA_PPSTIME |
2290 if (sys_leap == LEAP_ADDSECOND)
2291 ntv.status |= STA_INS;
2292 else if (sys_leap == LEAP_DELSECOND)
2293 ntv.status |= STA_DEL;
2297 * Pass the stuff to the kernel. If it squeals, turn off
2298 * the pps. In any case, fetch the kernel offset,
2299 * frequency and jitter.
2301 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2302 if (!(ntv.status & STA_PPSSIGNAL))
2303 report_event(EVNT_KERN, NULL,
2306 pll_status = ntv.status;
2308 clock_offset = ntv.offset / 1e9;
2309 #else /* STA_NANO */
2310 clock_offset = ntv.offset / 1e6;
2311 #endif /* STA_NANO */
2312 clock_frequency = FREQTOD(ntv.freq);
2315 * If the kernel PPS is lit, monitor its performance.
2317 if (ntv.status & STA_PPSTIME) {
2319 clock_jitter = ntv.jitter / 1e9;
2320 #else /* STA_NANO */
2321 clock_jitter = ntv.jitter / 1e6;
2322 #endif /* STA_NANO */
2325 #if defined(STA_NANO) && NTP_API == 4
2327 * If the TAI changes, update the kernel TAI.
2329 if (loop_tai != sys_tai) {
2331 ntv.modes = MOD_TAI;
2332 ntv.constant = sys_tai;
2335 #endif /* STA_NANO */
2337 #endif /* KERNEL_PLL */