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 -I IFACE")"] [-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"
42 //usage: "\n -I IFACE Bind server to IFACE, implies -l"
44 //usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins"
45 //usage: "\n -p PEER Obtain time from PEER (may be repeated)"
46 //usage: IF_FEATURE_NTPD_CONF(
47 //usage: "\n If -p is not given, read /etc/ntp.conf"
50 // -l and -p options are not compatible with "standard" ntpd:
51 // it has them as "-l logfile" and "-p pidfile".
52 // -S and -w are not compat either, "standard" ntpd has no such opts.
56 #include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
57 #include <sys/resource.h> /* setpriority */
58 #include <sys/timex.h>
59 #ifndef IPTOS_LOWDELAY
60 # define IPTOS_LOWDELAY 0x10
64 /* Verbosity control (max level of -dddd options accepted).
65 * max 6 is very talkative (and bloated). 3 is non-bloated,
66 * production level setting.
71 /* High-level description of the algorithm:
73 * We start running with very small poll_exp, BURSTPOLL,
74 * in order to quickly accumulate INITIAL_SAMPLES datapoints
75 * for each peer. Then, time is stepped if the offset is larger
76 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
77 * poll_exp to MINPOLL and enter frequency measurement step:
78 * we collect new datapoints but ignore them for WATCH_THRESHOLD
79 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
80 * offset and estimate frequency drift.
82 * (frequency measurement step seems to not be strictly needed,
83 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
86 * After this, we enter "steady state": we collect a datapoint,
87 * we select the best peer, if this datapoint is not a new one
88 * (IOW: if this datapoint isn't for selected peer), sleep
89 * and collect another one; otherwise, use its offset to update
90 * frequency drift, if offset is somewhat large, reduce poll_exp,
91 * otherwise increase poll_exp.
93 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
94 * happen, we assume that something "bad" happened (computer
95 * was hibernated, someone set totally wrong date, etc),
96 * then the time is stepped, all datapoints are discarded,
97 * and we go back to steady state.
99 * Made some changes to speed up re-syncing after our clock goes bad
100 * (tested with suspending my laptop):
101 * - if largish offset (>= STEP_THRESHOLD * 8 == 1 sec) is seen
102 * from a peer, schedule next query for this peer soon
103 * without drastically lowering poll interval for everybody.
104 * This makes us collect enough data for step much faster:
105 * e.g. at poll = 10 (1024 secs), step was done within 5 minutes
106 * after first reply which indicated that our clock is 14 seconds off.
107 * - on step, do not discard d_dispersion data of the existing datapoints,
108 * do not clear reachable_bits. This prevents discarding first ~8
109 * datapoints after the step.
112 #define RETRY_INTERVAL 5 /* on error, retry in N secs */
113 #define RESPONSE_INTERVAL 15 /* wait for reply up to N secs */
114 #define INITIAL_SAMPLES 4 /* how many samples do we want for init */
115 #define BAD_DELAY_GROWTH 4 /* drop packet if its delay grew by more than this */
117 /* Clock discipline parameters and constants */
119 /* Step threshold (sec). std ntpd uses 0.128.
120 * Using exact power of 2 (1/8) results in smaller code */
121 #define STEP_THRESHOLD 0.125
122 #define WATCH_THRESHOLD 128 /* stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
123 /* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
124 //UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
126 #define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
127 #define BURSTPOLL 0 /* initial poll */
128 #define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
129 /* If we got largish offset from a peer, cap next query interval
130 * for this peer by this many seconds:
132 #define BIGOFF_INTERVAL (1 << 6)
133 /* If offset > discipline_jitter * POLLADJ_GATE, and poll interval is >= 2^BIGPOLL,
134 * then it is decreased _at once_. (If < 2^BIGPOLL, it will be decreased _eventually_).
136 #define BIGPOLL 10 /* 2^10 sec ~= 17 min */
137 #define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
138 /* Actively lower poll when we see such big offsets.
139 * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
140 * if offset increases over ~0.04 sec */
141 #define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
142 #define MINDISP 0.01 /* minimum dispersion (sec) */
143 #define MAXDISP 16 /* maximum dispersion (sec) */
144 #define MAXSTRAT 16 /* maximum stratum (infinity metric) */
145 #define MAXDIST 1 /* distance threshold (sec) */
146 #define MIN_SELECTED 1 /* minimum intersection survivors */
147 #define MIN_CLUSTERED 3 /* minimum cluster survivors */
149 #define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
151 /* Poll-adjust threshold.
152 * When we see that offset is small enough compared to discipline jitter,
153 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
154 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
155 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
156 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
158 #define POLLADJ_LIMIT 40
159 /* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
160 * poll interval (we think we can't improve timekeeping
161 * by staying at smaller poll).
163 #define POLLADJ_GATE 4
164 #define TIMECONST_HACK_GATE 2
165 /* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
169 /* FLL loop gain [why it depends on MAXPOLL??] */
170 #define FLL (MAXPOLL + 1)
171 /* Parameter averaging constant */
180 NTP_MSGSIZE_NOAUTH = 48,
181 NTP_MSGSIZE = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
184 MODE_MASK = (7 << 0),
185 VERSION_MASK = (7 << 3),
189 /* Leap Second Codes (high order two bits of m_status) */
190 LI_NOWARNING = (0 << 6), /* no warning */
191 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
192 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
193 LI_ALARM = (3 << 6), /* alarm condition */
196 MODE_RES0 = 0, /* reserved */
197 MODE_SYM_ACT = 1, /* symmetric active */
198 MODE_SYM_PAS = 2, /* symmetric passive */
199 MODE_CLIENT = 3, /* client */
200 MODE_SERVER = 4, /* server */
201 MODE_BROADCAST = 5, /* broadcast */
202 MODE_RES1 = 6, /* reserved for NTP control message */
203 MODE_RES2 = 7, /* reserved for private use */
206 //TODO: better base selection
207 #define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
209 #define NUM_DATAPOINTS 8
222 uint8_t m_status; /* status of local clock and leap info */
224 uint8_t m_ppoll; /* poll value */
225 int8_t m_precision_exp;
226 s_fixedpt_t m_rootdelay;
227 s_fixedpt_t m_rootdisp;
229 l_fixedpt_t m_reftime;
230 l_fixedpt_t m_orgtime;
231 l_fixedpt_t m_rectime;
232 l_fixedpt_t m_xmttime;
234 uint8_t m_digest[NTP_DIGESTSIZE];
244 len_and_sockaddr *p_lsa;
248 uint32_t lastpkt_refid;
249 uint8_t lastpkt_status;
250 uint8_t lastpkt_stratum;
251 uint8_t reachable_bits;
252 /* when to send new query (if p_fd == -1)
253 * or when receive times out (if p_fd >= 0): */
254 double next_action_time;
257 /* p_raw_delay is set even by "high delay" packets */
258 /* lastpkt_delay isn't */
259 double lastpkt_recv_time;
260 double lastpkt_delay;
261 double lastpkt_rootdelay;
262 double lastpkt_rootdisp;
263 /* produced by filter algorithm: */
264 double filter_offset;
265 double filter_dispersion;
266 double filter_jitter;
267 datapoint_t filter_datapoint[NUM_DATAPOINTS];
268 /* last sent packet: */
273 #define USING_KERNEL_PLL_LOOP 1
274 #define USING_INITIAL_FREQ_ESTIMATION 0
281 /* Insert new options above this line. */
282 /* Non-compat options: */
286 OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
287 OPT_I = (1 << 8) * ENABLE_FEATURE_NTPD_SERVER,
288 /* We hijack some bits for other purposes */
294 /* total round trip delay to currently selected reference clock */
296 /* reference timestamp: time when the system clock was last set or corrected */
298 /* total dispersion to currently selected reference clock */
301 double last_script_run;
304 #if ENABLE_FEATURE_NTPD_SERVER
307 # define G_listen_fd (G.listen_fd)
309 # define G_listen_fd (-1)
313 /* refid: 32-bit code identifying the particular server or reference clock
314 * in stratum 0 packets this is a four-character ASCII string,
315 * called the kiss code, used for debugging and monitoring
316 * in stratum 1 packets this is a four-character ASCII string
317 * assigned to the reference clock by IANA. Example: "GPS "
318 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
319 * of MD5 hash of IPv6
323 /* precision is defined as the larger of the resolution and time to
324 * read the clock, in log2 units. For instance, the precision of a
325 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
326 * system clock hardware representation is to the nanosecond.
328 * Delays, jitters of various kinds are clamped down to precision.
330 * If precision_sec is too large, discipline_jitter gets clamped to it
331 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
332 * interval grows even though we really can benefit from staying at
333 * smaller one, collecting non-lagged datapoits and correcting offset.
334 * (Lagged datapoits exist when poll_exp is large but we still have
335 * systematic offset error - the time distance between datapoints
336 * is significant and older datapoints have smaller offsets.
337 * This makes our offset estimation a bit smaller than reality)
338 * Due to this effect, setting G_precision_sec close to
339 * STEP_THRESHOLD isn't such a good idea - offsets may grow
340 * too big and we will step. I observed it with -6.
342 * OTOH, setting precision_sec far too small would result in futile
343 * attempts to syncronize to an unachievable precision.
345 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
346 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
347 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
349 #define G_precision_exp -9
351 * G_precision_exp is used only for construction outgoing packets.
352 * It's ok to set G_precision_sec to a slightly different value
353 * (One which is "nicer looking" in logs).
354 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
356 #define G_precision_sec 0.002
358 /* Bool. After set to 1, never goes back to 0: */
359 smallint initial_poll_complete;
361 #define STATE_NSET 0 /* initial state, "nothing is set" */
362 //#define STATE_FSET 1 /* frequency set from file */
363 //#define STATE_SPIK 2 /* spike detected */
364 //#define STATE_FREQ 3 /* initial frequency */
365 #define STATE_SYNC 4 /* clock synchronized (normal operation) */
366 uint8_t discipline_state; // doc calls it c.state
367 uint8_t poll_exp; // s.poll
368 int polladj_count; // c.count
369 long kernel_freq_drift;
370 peer_t *last_update_peer;
371 double last_update_offset; // c.last
372 double last_update_recv_time; // s.t
373 double discipline_jitter; // c.jitter
374 /* Since we only compare it with ints, can simplify code
375 * by not making this variable floating point:
377 unsigned offset_to_jitter_ratio;
378 //double cluster_offset; // s.offset
379 //double cluster_jitter; // s.jitter
380 #if !USING_KERNEL_PLL_LOOP
381 double discipline_freq_drift; // c.freq
382 /* Maybe conditionally calculate wander? it's used only for logging */
383 double discipline_wander; // c.wander
386 #define G (*ptr_to_globals)
388 static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
391 #define VERB1 if (MAX_VERBOSE && G.verbose)
392 #define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
393 #define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
394 #define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
395 #define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
396 #define VERB6 if (MAX_VERBOSE >= 6 && G.verbose >= 6)
399 static double LOG2D(int a)
402 return 1.0 / (1UL << -a);
405 static ALWAYS_INLINE double SQUARE(double x)
409 static ALWAYS_INLINE double MAXD(double a, double b)
415 static ALWAYS_INLINE double MIND(double a, double b)
421 static NOINLINE double my_SQRT(double X)
428 double Xhalf = X * 0.5;
430 /* Fast and good approximation to 1/sqrt(X), black magic */
432 /*v.i = 0x5f3759df - (v.i >> 1);*/
433 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
434 invsqrt = v.f; /* better than 0.2% accuracy */
436 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
437 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
439 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
440 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
442 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
443 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
444 /* With 4 iterations, more than half results will be exact,
445 * at 6th iterations result stabilizes with about 72% results exact.
446 * We are well satisfied with 0.05% accuracy.
449 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
451 static ALWAYS_INLINE double SQRT(double X)
453 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
454 if (sizeof(float) != 4)
457 /* This avoids needing libm, saves about 0.5k on x86-32 */
465 gettimeofday(&tv, NULL); /* never fails */
466 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
471 d_to_tv(double d, struct timeval *tv)
473 tv->tv_sec = (long)d;
474 tv->tv_usec = (d - tv->tv_sec) * 1000000;
478 lfp_to_d(l_fixedpt_t lfp)
481 lfp.int_partl = ntohl(lfp.int_partl);
482 lfp.fractionl = ntohl(lfp.fractionl);
483 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
487 sfp_to_d(s_fixedpt_t sfp)
490 sfp.int_parts = ntohs(sfp.int_parts);
491 sfp.fractions = ntohs(sfp.fractions);
492 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
495 #if ENABLE_FEATURE_NTPD_SERVER
500 lfp.int_partl = (uint32_t)d;
501 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
502 lfp.int_partl = htonl(lfp.int_partl);
503 lfp.fractionl = htonl(lfp.fractionl);
510 sfp.int_parts = (uint16_t)d;
511 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
512 sfp.int_parts = htons(sfp.int_parts);
513 sfp.fractions = htons(sfp.fractions);
519 dispersion(const datapoint_t *dp)
521 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
525 root_distance(peer_t *p)
527 /* The root synchronization distance is the maximum error due to
528 * all causes of the local clock relative to the primary server.
529 * It is defined as half the total delay plus total dispersion
532 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
533 + p->lastpkt_rootdisp
534 + p->filter_dispersion
535 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
540 set_next(peer_t *p, unsigned t)
542 p->next_action_time = G.cur_time + t;
546 * Peer clock filter and its helpers
549 filter_datapoints(peer_t *p)
556 /* Simulations have shown that use of *averaged* offset for p->filter_offset
557 * is in fact worse than simply using last received one: with large poll intervals
558 * (>= 2048) averaging code uses offset values which are outdated by hours,
559 * and time/frequency correction goes totally wrong when fed essentially bogus offsets.
562 double minoff, maxoff, w;
563 double x = x; /* for compiler */
564 double oldest_off = oldest_off;
565 double oldest_age = oldest_age;
566 double newest_off = newest_off;
567 double newest_age = newest_age;
569 fdp = p->filter_datapoint;
571 minoff = maxoff = fdp[0].d_offset;
572 for (i = 1; i < NUM_DATAPOINTS; i++) {
573 if (minoff > fdp[i].d_offset)
574 minoff = fdp[i].d_offset;
575 if (maxoff < fdp[i].d_offset)
576 maxoff = fdp[i].d_offset;
579 idx = p->datapoint_idx; /* most recent datapoint's index */
581 * Drop two outliers and take weighted average of the rest:
582 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
583 * we use older6/32, not older6/64 since sum of weights should be 1:
584 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
590 * filter_dispersion = \ -------------
597 for (i = 0; i < NUM_DATAPOINTS; i++) {
599 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
602 fdp[idx].d_dispersion, dispersion(&fdp[idx]),
603 G.cur_time - fdp[idx].d_recv_time,
604 (minoff == fdp[idx].d_offset || maxoff == fdp[idx].d_offset)
605 ? " (outlier by offset)" : ""
609 sum += dispersion(&fdp[idx]) / (2 << i);
611 if (minoff == fdp[idx].d_offset) {
612 minoff -= 1; /* so that we don't match it ever again */
614 if (maxoff == fdp[idx].d_offset) {
617 oldest_off = fdp[idx].d_offset;
618 oldest_age = G.cur_time - fdp[idx].d_recv_time;
621 newest_off = oldest_off;
622 newest_age = oldest_age;
629 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
631 p->filter_dispersion = sum;
632 wavg += x; /* add another older6/64 to form older6/32 */
633 /* Fix systematic underestimation with large poll intervals.
634 * Imagine that we still have a bit of uncorrected drift,
635 * and poll interval is big (say, 100 sec). Offsets form a progression:
636 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
637 * The algorithm above drops 0.0 and 0.7 as outliers,
638 * and then we have this estimation, ~25% off from 0.7:
639 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
641 x = oldest_age - newest_age;
643 x = newest_age / x; /* in above example, 100 / (600 - 100) */
644 if (x < 1) { /* paranoia check */
645 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
649 p->filter_offset = wavg;
653 fdp = p->filter_datapoint;
654 idx = p->datapoint_idx; /* most recent datapoint's index */
656 /* filter_offset: simply use the most recent value */
657 p->filter_offset = fdp[idx].d_offset;
661 * filter_dispersion = \ -------------
668 for (i = 0; i < NUM_DATAPOINTS; i++) {
669 sum += dispersion(&fdp[idx]) / (2 << i);
670 wavg += fdp[idx].d_offset;
671 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
673 wavg /= NUM_DATAPOINTS;
674 p->filter_dispersion = sum;
677 /* +----- -----+ ^ 1/2
681 * filter_jitter = | --- * / (avg-offset_j) |
685 * where n is the number of valid datapoints in the filter (n > 1);
686 * if filter_jitter < precision then filter_jitter = precision
689 for (i = 0; i < NUM_DATAPOINTS; i++) {
690 sum += SQUARE(wavg - fdp[i].d_offset);
692 sum = SQRT(sum / NUM_DATAPOINTS);
693 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
695 VERB4 bb_error_msg("filter offset:%+f disp:%f jitter:%f",
697 p->filter_dispersion,
702 reset_peer_stats(peer_t *p, double offset)
705 bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
707 /* Used to set p->filter_datapoint[i].d_dispersion = MAXDISP
708 * and clear reachable bits, but this proved to be too agressive:
709 * after step (tested with suspinding laptop for ~30 secs),
710 * this caused all previous data to be considered invalid,
711 * making us needing to collect full ~8 datapoins per peer
712 * after step in order to start trusting them.
713 * In turn, this was making poll interval decrease even after
714 * step was done. (Poll interval decreases already before step
715 * in this scenario, because we see large offsets and end up with
716 * no good peer to select).
719 for (i = 0; i < NUM_DATAPOINTS; i++) {
721 p->filter_datapoint[i].d_recv_time += offset;
722 if (p->filter_datapoint[i].d_offset != 0) {
723 p->filter_datapoint[i].d_offset -= offset;
724 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
726 // p->filter_datapoint[i].d_offset + offset,
727 // p->filter_datapoint[i].d_offset);
730 p->filter_datapoint[i].d_recv_time = G.cur_time;
731 p->filter_datapoint[i].d_offset = 0;
732 /*p->filter_datapoint[i].d_dispersion = MAXDISP;*/
736 p->lastpkt_recv_time += offset;
738 /*p->reachable_bits = 0;*/
739 p->lastpkt_recv_time = G.cur_time;
741 filter_datapoints(p); /* recalc p->filter_xxx */
742 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
746 add_peers(const char *s)
750 p = xzalloc(sizeof(*p));
751 p->p_lsa = xhost2sockaddr(s, 123);
752 p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
754 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
755 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
756 reset_peer_stats(p, 16 * STEP_THRESHOLD);
758 llist_add_to(&G.ntp_peers, p);
764 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
765 msg_t *msg, ssize_t len)
771 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
773 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
776 bb_perror_msg("send failed");
783 send_query_to_peer(peer_t *p)
785 /* Why do we need to bind()?
786 * See what happens when we don't bind:
788 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
789 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
790 * gettimeofday({1259071266, 327885}, NULL) = 0
791 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
792 * ^^^ we sent it from some source port picked by kernel.
793 * time(NULL) = 1259071266
794 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
795 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
796 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
797 * ^^^ this recv will receive packets to any local port!
799 * Uncomment this and use strace to see it in action:
801 #define PROBE_LOCAL_ADDR /* { len_and_sockaddr lsa; lsa.len = LSA_SIZEOF_SA; getsockname(p->query.fd, &lsa.u.sa, &lsa.len); } */
805 len_and_sockaddr *local_lsa;
807 family = p->p_lsa->u.sa.sa_family;
808 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
809 /* local_lsa has "null" address and port 0 now.
810 * bind() ensures we have a *particular port* selected by kernel
811 * and remembered in p->p_fd, thus later recv(p->p_fd)
812 * receives only packets sent to this port.
815 xbind(fd, &local_lsa->u.sa, local_lsa->len);
817 #if ENABLE_FEATURE_IPV6
818 if (family == AF_INET)
820 setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
824 /* Emit message _before_ attempted send. Think of a very short
825 * roundtrip networks: we need to go back to recv loop ASAP,
826 * to reduce delay. Printing messages after send works against that.
828 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
831 * Send out a random 64-bit number as our transmit time. The NTP
832 * server will copy said number into the originate field on the
833 * response that it sends us. This is totally legal per the SNTP spec.
835 * The impact of this is two fold: we no longer send out the current
836 * system time for the world to see (which may aid an attacker), and
837 * it gives us a (not very secure) way of knowing that we're not
838 * getting spoofed by an attacker that can't capture our traffic
839 * but can spoof packets from the NTP server we're communicating with.
841 * Save the real transmit timestamp locally.
843 p->p_xmt_msg.m_xmttime.int_partl = rand();
844 p->p_xmt_msg.m_xmttime.fractionl = rand();
845 p->p_xmttime = gettime1900d();
847 /* Were doing it only if sendto worked, but
848 * loss of sync detection needs reachable_bits updated
849 * even if sending fails *locally*:
850 * "network is unreachable" because cable was pulled?
851 * We still need to declare "unsync" if this condition persists.
853 p->reachable_bits <<= 1;
855 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
856 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
861 * We know that we sent nothing.
862 * We can retry *soon* without fearing
863 * that we are flooding the peer.
865 set_next(p, RETRY_INTERVAL);
869 set_next(p, RESPONSE_INTERVAL);
873 /* Note that there is no provision to prevent several run_scripts
874 * to be started in quick succession. In fact, it happens rather often
875 * if initial syncronization results in a step.
876 * You will see "step" and then "stratum" script runs, sometimes
877 * as close as only 0.002 seconds apart.
878 * Script should be ready to deal with this.
880 static void run_script(const char *action, double offset)
883 char *env1, *env2, *env3, *env4;
885 G.last_script_run = G.cur_time;
890 argv[0] = (char*) G.script_name;
891 argv[1] = (char*) action;
894 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
896 env1 = xasprintf("%s=%u", "stratum", G.stratum);
898 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
900 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
902 env4 = xasprintf("%s=%f", "offset", offset);
904 /* Other items of potential interest: selected peer,
905 * rootdelay, reftime, rootdisp, refid, ntp_status,
906 * last_update_offset, last_update_recv_time, discipline_jitter,
907 * how many peers have reachable_bits = 0?
910 /* Don't want to wait: it may run hwclock --systohc, and that
911 * may take some time (seconds): */
912 /*spawn_and_wait(argv);*/
916 unsetenv("freq_drift_ppm");
917 unsetenv("poll_interval");
926 step_time(double offset)
930 struct timeval tvc, tvn;
931 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
934 gettimeofday(&tvc, NULL); /* never fails */
935 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
936 d_to_tv(dtime, &tvn);
937 if (settimeofday(&tvn, NULL) == -1)
938 bb_perror_msg_and_die("settimeofday");
942 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
943 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
946 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
947 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
949 /* Correct various fields which contain time-relative values: */
952 G.cur_time += offset;
953 G.last_update_recv_time += offset;
954 G.last_script_run += offset;
956 /* p->lastpkt_recv_time, p->next_action_time and such: */
957 for (item = G.ntp_peers; item != NULL; item = item->link) {
958 peer_t *pp = (peer_t *) item->data;
959 reset_peer_stats(pp, offset);
960 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
961 // offset, pp->next_action_time, pp->next_action_time + offset);
962 pp->next_action_time += offset;
964 /* We wait for reply from this peer too.
965 * But due to step we are doing, reply's data is no longer
966 * useful (in fact, it'll be bogus). Stop waiting for it.
970 set_next(pp, RETRY_INTERVAL);
977 * Selection and clustering, and their helpers
983 double opt_rd; /* optimization */
986 compare_point_edge(const void *aa, const void *bb)
988 const point_t *a = aa;
989 const point_t *b = bb;
990 if (a->edge < b->edge) {
993 return (a->edge > b->edge);
1000 compare_survivor_metric(const void *aa, const void *bb)
1002 const survivor_t *a = aa;
1003 const survivor_t *b = bb;
1004 if (a->metric < b->metric) {
1007 return (a->metric > b->metric);
1010 fit(peer_t *p, double rd)
1012 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
1013 /* One or zero bits in reachable_bits */
1014 VERB4 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
1017 #if 0 /* we filter out such packets earlier */
1018 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
1019 || p->lastpkt_stratum >= MAXSTRAT
1021 VERB4 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
1025 /* rd is root_distance(p) */
1026 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
1027 VERB4 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
1031 // /* Do we have a loop? */
1032 // if (p->refid == p->dstaddr || p->refid == s.refid)
1037 select_and_cluster(void)
1042 int size = 3 * G.peer_cnt;
1043 /* for selection algorithm */
1044 point_t point[size];
1045 unsigned num_points, num_candidates;
1047 unsigned num_falsetickers;
1048 /* for cluster algorithm */
1049 survivor_t survivor[size];
1050 unsigned num_survivors;
1056 if (G.initial_poll_complete) while (item != NULL) {
1059 p = (peer_t *) item->data;
1060 rd = root_distance(p);
1061 offset = p->filter_offset;
1067 VERB5 bb_error_msg("interval: [%f %f %f] %s",
1073 point[num_points].p = p;
1074 point[num_points].type = -1;
1075 point[num_points].edge = offset - rd;
1076 point[num_points].opt_rd = rd;
1078 point[num_points].p = p;
1079 point[num_points].type = 0;
1080 point[num_points].edge = offset;
1081 point[num_points].opt_rd = rd;
1083 point[num_points].p = p;
1084 point[num_points].type = 1;
1085 point[num_points].edge = offset + rd;
1086 point[num_points].opt_rd = rd;
1090 num_candidates = num_points / 3;
1091 if (num_candidates == 0) {
1092 VERB3 bb_error_msg("no valid datapoints%s", ", no peer selected");
1095 //TODO: sorting does not seem to be done in reference code
1096 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
1098 /* Start with the assumption that there are no falsetickers.
1099 * Attempt to find a nonempty intersection interval containing
1100 * the midpoints of all truechimers.
1101 * If a nonempty interval cannot be found, increase the number
1102 * of assumed falsetickers by one and try again.
1103 * If a nonempty interval is found and the number of falsetickers
1104 * is less than the number of truechimers, a majority has been found
1105 * and the midpoint of each truechimer represents
1106 * the candidates available to the cluster algorithm.
1108 num_falsetickers = 0;
1111 unsigned num_midpoints = 0;
1116 for (i = 0; i < num_points; i++) {
1118 * if (point[i].type == -1) c++;
1119 * if (point[i].type == 1) c--;
1120 * and it's simpler to do it this way:
1123 if (c >= num_candidates - num_falsetickers) {
1124 /* If it was c++ and it got big enough... */
1125 low = point[i].edge;
1128 if (point[i].type == 0)
1132 for (i = num_points-1; i >= 0; i--) {
1134 if (c >= num_candidates - num_falsetickers) {
1135 high = point[i].edge;
1138 if (point[i].type == 0)
1141 /* If the number of midpoints is greater than the number
1142 * of allowed falsetickers, the intersection contains at
1143 * least one truechimer with no midpoint - bad.
1144 * Also, interval should be nonempty.
1146 if (num_midpoints <= num_falsetickers && low < high)
1149 if (num_falsetickers * 2 >= num_candidates) {
1150 VERB3 bb_error_msg("falsetickers:%d, candidates:%d%s",
1151 num_falsetickers, num_candidates,
1152 ", no peer selected");
1156 VERB4 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
1157 low, high, num_candidates, num_falsetickers);
1161 /* Construct a list of survivors (p, metric)
1162 * from the chime list, where metric is dominated
1163 * first by stratum and then by root distance.
1164 * All other things being equal, this is the order of preference.
1167 for (i = 0; i < num_points; i++) {
1168 if (point[i].edge < low || point[i].edge > high)
1171 survivor[num_survivors].p = p;
1172 /* x.opt_rd == root_distance(p); */
1173 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
1174 VERB5 bb_error_msg("survivor[%d] metric:%f peer:%s",
1175 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1178 /* There must be at least MIN_SELECTED survivors to satisfy the
1179 * correctness assertions. Ordinarily, the Byzantine criteria
1180 * require four survivors, but for the demonstration here, one
1183 if (num_survivors < MIN_SELECTED) {
1184 VERB3 bb_error_msg("survivors:%d%s",
1186 ", no peer selected");
1190 //looks like this is ONLY used by the fact that later we pick survivor[0].
1191 //we can avoid sorting then, just find the minimum once!
1192 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1194 /* For each association p in turn, calculate the selection
1195 * jitter p->sjitter as the square root of the sum of squares
1196 * (p->offset - q->offset) over all q associations. The idea is
1197 * to repeatedly discard the survivor with maximum selection
1198 * jitter until a termination condition is met.
1201 unsigned max_idx = max_idx;
1202 double max_selection_jitter = max_selection_jitter;
1203 double min_jitter = min_jitter;
1205 if (num_survivors <= MIN_CLUSTERED) {
1206 VERB4 bb_error_msg("num_survivors %d <= %d, not discarding more",
1207 num_survivors, MIN_CLUSTERED);
1211 /* To make sure a few survivors are left
1212 * for the clustering algorithm to chew on,
1213 * we stop if the number of survivors
1214 * is less than or equal to MIN_CLUSTERED (3).
1216 for (i = 0; i < num_survivors; i++) {
1217 double selection_jitter_sq;
1220 if (i == 0 || p->filter_jitter < min_jitter)
1221 min_jitter = p->filter_jitter;
1223 selection_jitter_sq = 0;
1224 for (j = 0; j < num_survivors; j++) {
1225 peer_t *q = survivor[j].p;
1226 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1228 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1229 max_selection_jitter = selection_jitter_sq;
1232 VERB6 bb_error_msg("survivor %d selection_jitter^2:%f",
1233 i, selection_jitter_sq);
1235 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
1236 VERB5 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
1237 max_idx, max_selection_jitter, min_jitter);
1239 /* If the maximum selection jitter is less than the
1240 * minimum peer jitter, then tossing out more survivors
1241 * will not lower the minimum peer jitter, so we might
1244 if (max_selection_jitter < min_jitter) {
1245 VERB4 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
1246 max_selection_jitter, min_jitter, num_survivors);
1250 /* Delete survivor[max_idx] from the list
1251 * and go around again.
1253 VERB6 bb_error_msg("dropping survivor %d", max_idx);
1255 while (max_idx < num_survivors) {
1256 survivor[max_idx] = survivor[max_idx + 1];
1262 /* Combine the offsets of the clustering algorithm survivors
1263 * using a weighted average with weight determined by the root
1264 * distance. Compute the selection jitter as the weighted RMS
1265 * difference between the first survivor and the remaining
1266 * survivors. In some cases the inherent clock jitter can be
1267 * reduced by not using this algorithm, especially when frequent
1268 * clockhopping is involved. bbox: thus we don't do it.
1272 for (i = 0; i < num_survivors; i++) {
1274 x = root_distance(p);
1276 z += p->filter_offset / x;
1277 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1279 //G.cluster_offset = z / y;
1280 //G.cluster_jitter = SQRT(w / y);
1283 /* Pick the best clock. If the old system peer is on the list
1284 * and at the same stratum as the first survivor on the list,
1285 * then don't do a clock hop. Otherwise, select the first
1286 * survivor on the list as the new system peer.
1289 if (G.last_update_peer
1290 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1292 /* Starting from 1 is ok here */
1293 for (i = 1; i < num_survivors; i++) {
1294 if (G.last_update_peer == survivor[i].p) {
1295 VERB5 bb_error_msg("keeping old synced peer");
1296 p = G.last_update_peer;
1301 G.last_update_peer = p;
1303 VERB4 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
1306 G.cur_time - p->lastpkt_recv_time
1313 * Local clock discipline and its helpers
1316 set_new_values(int disc_state, double offset, double recv_time)
1318 /* Enter new state and set state variables. Note we use the time
1319 * of the last clock filter sample, which must be earlier than
1322 VERB4 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
1323 disc_state, offset, recv_time);
1324 G.discipline_state = disc_state;
1325 G.last_update_offset = offset;
1326 G.last_update_recv_time = recv_time;
1328 /* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
1330 update_local_clock(peer_t *p)
1334 /* Note: can use G.cluster_offset instead: */
1335 double offset = p->filter_offset;
1336 double recv_time = p->lastpkt_recv_time;
1338 #if !USING_KERNEL_PLL_LOOP
1341 #if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
1342 double since_last_update;
1344 double etemp, dtemp;
1346 abs_offset = fabs(offset);
1349 /* If needed, -S script can do it by looking at $offset
1350 * env var and killing parent */
1351 /* If the offset is too large, give up and go home */
1352 if (abs_offset > PANIC_THRESHOLD) {
1353 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1357 /* If this is an old update, for instance as the result
1358 * of a system peer change, avoid it. We never use
1359 * an old sample or the same sample twice.
1361 if (recv_time <= G.last_update_recv_time) {
1362 VERB3 bb_error_msg("update from %s: same or older datapoint, not using it",
1364 return 0; /* "leave poll interval as is" */
1367 /* Clock state machine transition function. This is where the
1368 * action is and defines how the system reacts to large time
1369 * and frequency errors.
1371 #if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
1372 since_last_update = recv_time - G.reftime;
1374 #if !USING_KERNEL_PLL_LOOP
1377 #if USING_INITIAL_FREQ_ESTIMATION
1378 if (G.discipline_state == STATE_FREQ) {
1379 /* Ignore updates until the stepout threshold */
1380 if (since_last_update < WATCH_THRESHOLD) {
1381 VERB4 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
1382 WATCH_THRESHOLD - since_last_update);
1383 return 0; /* "leave poll interval as is" */
1385 # if !USING_KERNEL_PLL_LOOP
1386 freq_drift = (offset - G.last_update_offset) / since_last_update;
1391 /* There are two main regimes: when the
1392 * offset exceeds the step threshold and when it does not.
1394 if (abs_offset > STEP_THRESHOLD) {
1398 // This "spike state" seems to be useless, peer selection already drops
1399 // occassional "bad" datapoints. If we are here, there were _many_
1400 // large offsets. When a few first large offsets are seen,
1401 // we end up in "no valid datapoints, no peer selected" state.
1402 // Only when enough of them are seen (which means it's not a fluke),
1403 // we end up here. Looks like _our_ clock is off.
1404 switch (G.discipline_state) {
1406 /* The first outlyer: ignore it, switch to SPIK state */
1407 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1408 p->p_dotted, offset,
1410 G.discipline_state = STATE_SPIK;
1411 return -1; /* "decrease poll interval" */
1414 /* Ignore succeeding outlyers until either an inlyer
1415 * is found or the stepout threshold is exceeded.
1417 remains = WATCH_THRESHOLD - since_last_update;
1419 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1420 p->p_dotted, offset,
1421 ", datapoint ignored");
1422 return -1; /* "decrease poll interval" */
1424 /* fall through: we need to step */
1428 /* Step the time and clamp down the poll interval.
1430 * In NSET state an initial frequency correction is
1431 * not available, usually because the frequency file has
1432 * not yet been written. Since the time is outside the
1433 * capture range, the clock is stepped. The frequency
1434 * will be set directly following the stepout interval.
1436 * In FSET state the initial frequency has been set
1437 * from the frequency file. Since the time is outside
1438 * the capture range, the clock is stepped immediately,
1439 * rather than after the stepout interval. Guys get
1440 * nervous if it takes 17 minutes to set the clock for
1443 * In SPIK state the stepout threshold has expired and
1444 * the phase is still above the step threshold. Note
1445 * that a single spike greater than the step threshold
1446 * is always suppressed, even at the longer poll
1449 VERB4 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
1451 if (option_mask32 & OPT_q) {
1452 /* We were only asked to set time once. Done. */
1456 G.polladj_count = 0;
1457 G.poll_exp = MINPOLL;
1458 G.stratum = MAXSTRAT;
1460 run_script("step", offset);
1462 recv_time += offset;
1464 #if USING_INITIAL_FREQ_ESTIMATION
1465 if (G.discipline_state == STATE_NSET) {
1466 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1467 return 1; /* "ok to increase poll interval" */
1470 abs_offset = offset = 0;
1471 set_new_values(STATE_SYNC, offset, recv_time);
1473 } else { /* abs_offset <= STEP_THRESHOLD */
1475 /* Compute the clock jitter as the RMS of exponentially
1476 * weighted offset differences. Used by the poll adjust code.
1478 etemp = SQUARE(G.discipline_jitter);
1479 dtemp = SQUARE(offset - G.last_update_offset);
1480 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
1482 switch (G.discipline_state) {
1484 if (option_mask32 & OPT_q) {
1485 /* We were only asked to set time once.
1486 * The clock is precise enough, no need to step.
1490 #if USING_INITIAL_FREQ_ESTIMATION
1491 /* This is the first update received and the frequency
1492 * has not been initialized. The first thing to do
1493 * is directly measure the oscillator frequency.
1495 set_new_values(STATE_FREQ, offset, recv_time);
1497 set_new_values(STATE_SYNC, offset, recv_time);
1499 VERB4 bb_error_msg("transitioning to FREQ, datapoint ignored");
1500 return 0; /* "leave poll interval as is" */
1502 #if 0 /* this is dead code for now */
1504 /* This is the first update and the frequency
1505 * has been initialized. Adjust the phase, but
1506 * don't adjust the frequency until the next update.
1508 set_new_values(STATE_SYNC, offset, recv_time);
1509 /* freq_drift remains 0 */
1513 #if USING_INITIAL_FREQ_ESTIMATION
1515 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1516 * Correct the phase and frequency and switch to SYNC state.
1517 * freq_drift was already estimated (see code above)
1519 set_new_values(STATE_SYNC, offset, recv_time);
1524 #if !USING_KERNEL_PLL_LOOP
1525 /* Compute freq_drift due to PLL and FLL contributions.
1527 * The FLL and PLL frequency gain constants
1528 * depend on the poll interval and Allan
1529 * intercept. The FLL is not used below one-half
1530 * the Allan intercept. Above that the loop gain
1531 * increases in steps to 1 / AVG.
1533 if ((1 << G.poll_exp) > ALLAN / 2) {
1534 etemp = FLL - G.poll_exp;
1537 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1539 /* For the PLL the integration interval
1540 * (numerator) is the minimum of the update
1541 * interval and poll interval. This allows
1542 * oversampling, but not undersampling.
1544 etemp = MIND(since_last_update, (1 << G.poll_exp));
1545 dtemp = (4 * PLL) << G.poll_exp;
1546 freq_drift += offset * etemp / SQUARE(dtemp);
1548 set_new_values(STATE_SYNC, offset, recv_time);
1551 if (G.stratum != p->lastpkt_stratum + 1) {
1552 G.stratum = p->lastpkt_stratum + 1;
1553 run_script("stratum", offset);
1557 if (G.discipline_jitter < G_precision_sec)
1558 G.discipline_jitter = G_precision_sec;
1559 G.offset_to_jitter_ratio = abs_offset / G.discipline_jitter;
1561 G.reftime = G.cur_time;
1562 G.ntp_status = p->lastpkt_status;
1563 G.refid = p->lastpkt_refid;
1564 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
1565 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
1566 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
1567 G.rootdisp = p->lastpkt_rootdisp + dtemp;
1568 VERB4 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
1570 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1571 * (Any other state does not reach this, they all return earlier)
1572 * By this time, freq_drift and offset are set
1573 * to values suitable for adjtimex.
1575 #if !USING_KERNEL_PLL_LOOP
1576 /* Calculate the new frequency drift and frequency stability (wander).
1577 * Compute the clock wander as the RMS of exponentially weighted
1578 * frequency differences. This is not used directly, but can,
1579 * along with the jitter, be a highly useful monitoring and
1582 dtemp = G.discipline_freq_drift + freq_drift;
1583 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
1584 etemp = SQUARE(G.discipline_wander);
1585 dtemp = SQUARE(dtemp);
1586 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1588 VERB4 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
1589 G.discipline_freq_drift,
1590 (long)(G.discipline_freq_drift * 65536e6),
1592 G.discipline_wander);
1595 memset(&tmx, 0, sizeof(tmx));
1596 if (adjtimex(&tmx) < 0)
1597 bb_perror_msg_and_die("adjtimex");
1598 bb_error_msg("p adjtimex freq:%ld offset:%+ld status:0x%x tc:%ld",
1599 tmx.freq, tmx.offset, tmx.status, tmx.constant);
1602 memset(&tmx, 0, sizeof(tmx));
1604 //doesn't work, offset remains 0 (!) in kernel:
1605 //ntpd: set adjtimex freq:1786097 tmx.offset:77487
1606 //ntpd: prev adjtimex freq:1786097 tmx.offset:0
1607 //ntpd: cur adjtimex freq:1786097 tmx.offset:0
1608 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1609 /* 65536 is one ppm */
1610 tmx.freq = G.discipline_freq_drift * 65536e6;
1612 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
1613 tmx.offset = (offset * 1000000); /* usec */
1614 tmx.status = STA_PLL;
1615 if (G.ntp_status & LI_PLUSSEC)
1616 tmx.status |= STA_INS;
1617 if (G.ntp_status & LI_MINUSSEC)
1618 tmx.status |= STA_DEL;
1620 tmx.constant = G.poll_exp - 4;
1622 * The below if statement should be unnecessary, but...
1623 * It looks like Linux kernel's PLL is far too gentle in changing
1624 * tmx.freq in response to clock offset. Offset keeps growing
1625 * and eventually we fall back to smaller poll intervals.
1626 * We can make correction more agressive (about x2) by supplying
1627 * PLL time constant which is one less than the real one.
1628 * To be on a safe side, let's do it only if offset is significantly
1629 * larger than jitter.
1631 if (tmx.constant > 0 && G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
1634 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1635 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
1636 rc = adjtimex(&tmx);
1638 bb_perror_msg_and_die("adjtimex");
1639 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1640 * Not sure why. Perhaps it is normal.
1642 VERB4 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
1643 rc, tmx.freq, tmx.offset, tmx.status);
1644 G.kernel_freq_drift = tmx.freq / 65536;
1645 VERB2 bb_error_msg("update from:%s offset:%+f jitter:%f clock drift:%+.3fppm tc:%d",
1646 p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
1648 return 1; /* "ok to increase poll interval" */
1653 * We've got a new reply packet from a peer, process it
1657 retry_interval(void)
1659 /* Local problem, want to retry soon */
1660 unsigned interval, r;
1661 interval = RETRY_INTERVAL;
1663 interval += r % (unsigned)(RETRY_INTERVAL / 4);
1664 VERB4 bb_error_msg("chose retry interval:%u", interval);
1668 poll_interval(int exponent)
1670 unsigned interval, r, mask;
1671 exponent = G.poll_exp + exponent;
1674 interval = 1 << exponent;
1675 mask = ((interval-1) >> 4) | 1;
1677 interval += r & mask; /* ~ random(0..1) * interval/16 */
1678 VERB4 bb_error_msg("chose poll interval:%u (poll_exp:%d exp:%d)", interval, G.poll_exp, exponent);
1681 static NOINLINE void
1682 recv_and_process_peer_pkt(peer_t *p)
1687 double T1, T2, T3, T4;
1689 double prev_delay, delay;
1691 datapoint_t *datapoint;
1696 /* We can recvfrom here and check from.IP, but some multihomed
1697 * ntp servers reply from their *other IP*.
1698 * TODO: maybe we should check at least what we can: from.port == 123?
1700 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
1702 bb_perror_msg("recv(%s) error", p->p_dotted);
1703 if (errno == EHOSTUNREACH || errno == EHOSTDOWN
1704 || errno == ENETUNREACH || errno == ENETDOWN
1705 || errno == ECONNREFUSED || errno == EADDRNOTAVAIL
1708 //TODO: always do this?
1709 interval = retry_interval();
1710 goto set_next_and_ret;
1715 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1716 bb_error_msg("malformed packet received from %s", p->p_dotted);
1720 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1721 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1723 /* Somebody else's packet */
1727 /* We do not expect any more packets from this peer for now.
1728 * Closing the socket informs kernel about it.
1729 * We open a new socket when we send a new query.
1734 if ((msg.m_status & LI_ALARM) == LI_ALARM
1735 || msg.m_stratum == 0
1736 || msg.m_stratum > NTP_MAXSTRATUM
1738 // TODO: stratum 0 responses may have commands in 32-bit m_refid field:
1739 // "DENY", "RSTR" - peer does not like us at all
1740 // "RATE" - peer is overloaded, reduce polling freq
1741 bb_error_msg("reply from %s: peer is unsynced", p->p_dotted);
1742 goto pick_normal_interval;
1745 // /* Verify valid root distance */
1746 // if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1747 // return; /* invalid header values */
1750 * From RFC 2030 (with a correction to the delay math):
1752 * Timestamp Name ID When Generated
1753 * ------------------------------------------------------------
1754 * Originate Timestamp T1 time request sent by client
1755 * Receive Timestamp T2 time request received by server
1756 * Transmit Timestamp T3 time reply sent by server
1757 * Destination Timestamp T4 time reply received by client
1759 * The roundtrip delay and local clock offset are defined as
1761 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1764 T2 = lfp_to_d(msg.m_rectime);
1765 T3 = lfp_to_d(msg.m_xmttime);
1768 /* The delay calculation is a special case. In cases where the
1769 * server and client clocks are running at different rates and
1770 * with very fast networks, the delay can appear negative. In
1771 * order to avoid violating the Principle of Least Astonishment,
1772 * the delay is clamped not less than the system precision.
1774 delay = (T4 - T1) - (T3 - T2);
1775 if (delay < G_precision_sec)
1776 delay = G_precision_sec;
1778 * If this packet's delay is much bigger than the last one,
1779 * it's better to just ignore it than use its much less precise value.
1781 prev_delay = p->p_raw_delay;
1782 p->p_raw_delay = delay;
1783 if (p->reachable_bits && delay > prev_delay * BAD_DELAY_GROWTH) {
1784 bb_error_msg("reply from %s: delay %f is too high, ignoring", p->p_dotted, delay);
1785 goto pick_normal_interval;
1788 p->lastpkt_delay = delay;
1789 p->lastpkt_recv_time = T4;
1790 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1791 p->lastpkt_status = msg.m_status;
1792 p->lastpkt_stratum = msg.m_stratum;
1793 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1794 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1795 p->lastpkt_refid = msg.m_refid;
1797 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1798 datapoint = &p->filter_datapoint[p->datapoint_idx];
1799 datapoint->d_recv_time = T4;
1800 datapoint->d_offset = offset = ((T2 - T1) + (T3 - T4)) / 2;
1801 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
1802 if (!p->reachable_bits) {
1803 /* 1st datapoint ever - replicate offset in every element */
1805 for (i = 0; i < NUM_DATAPOINTS; i++) {
1806 p->filter_datapoint[i].d_offset = offset;
1810 p->reachable_bits |= 1;
1811 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
1812 bb_error_msg("reply from %s: offset:%+f delay:%f status:0x%02x strat:%d refid:0x%08x rootdelay:%f reach:0x%02x",
1819 p->lastpkt_rootdelay,
1821 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1822 * m_reftime, m_orgtime, m_rectime, m_xmttime
1827 /* Muck with statictics and update the clock */
1828 filter_datapoints(p);
1829 q = select_and_cluster();
1833 if (!(option_mask32 & OPT_w)) {
1834 rc = update_local_clock(q);
1835 /* If drift is dangerously large, immediately
1836 * drop poll interval one step down.
1838 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
1839 VERB4 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
1844 /* else: no peer selected, rc = -1: we want to poll more often */
1847 /* Adjust the poll interval by comparing the current offset
1848 * with the clock jitter. If the offset is less than
1849 * the clock jitter times a constant, then the averaging interval
1850 * is increased, otherwise it is decreased. A bit of hysteresis
1851 * helps calm the dance. Works best using burst mode.
1853 if (rc > 0 && G.offset_to_jitter_ratio <= POLLADJ_GATE) {
1854 /* was += G.poll_exp but it is a bit
1855 * too optimistic for my taste at high poll_exp's */
1856 G.polladj_count += MINPOLL;
1857 if (G.polladj_count > POLLADJ_LIMIT) {
1858 G.polladj_count = 0;
1859 if (G.poll_exp < MAXPOLL) {
1861 VERB4 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1862 G.discipline_jitter, G.poll_exp);
1865 VERB4 bb_error_msg("polladj: incr:%d", G.polladj_count);
1868 G.polladj_count -= G.poll_exp * 2;
1869 if (G.polladj_count < -POLLADJ_LIMIT || G.poll_exp >= BIGPOLL) {
1871 G.polladj_count = 0;
1872 if (G.poll_exp > MINPOLL) {
1876 /* Correct p->next_action_time in each peer
1877 * which waits for sending, so that they send earlier.
1878 * Old pp->next_action_time are on the order
1879 * of t + (1 << old_poll_exp) + small_random,
1880 * we simply need to subtract ~half of that.
1882 for (item = G.ntp_peers; item != NULL; item = item->link) {
1883 peer_t *pp = (peer_t *) item->data;
1885 pp->next_action_time -= (1 << G.poll_exp);
1887 VERB4 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1888 G.discipline_jitter, G.poll_exp);
1891 VERB4 bb_error_msg("polladj: decr:%d", G.polladj_count);
1896 /* Decide when to send new query for this peer */
1897 pick_normal_interval:
1898 interval = poll_interval(0);
1899 if (fabs(offset) >= STEP_THRESHOLD * 8 && interval > BIGOFF_INTERVAL) {
1900 /* If we are synced, offsets are less than STEP_THRESHOLD,
1901 * or at the very least not much larger than it.
1902 * Now we see a largish one.
1903 * Either this peer is feeling bad, or packet got corrupted,
1904 * or _our_ clock is wrong now and _all_ peers will show similar
1905 * largish offsets too.
1906 * I observed this with laptop suspend stopping clock.
1907 * In any case, it makes sense to make next request soonish:
1908 * cases 1 and 2: get a better datapoint,
1909 * case 3: allows to resync faster.
1911 interval = BIGOFF_INTERVAL;
1915 set_next(p, interval);
1918 #if ENABLE_FEATURE_NTPD_SERVER
1919 static NOINLINE void
1920 recv_and_process_client_pkt(void /*int fd*/)
1924 len_and_sockaddr *to;
1925 struct sockaddr *from;
1927 uint8_t query_status;
1928 l_fixedpt_t query_xmttime;
1930 to = get_sock_lsa(G_listen_fd);
1931 from = xzalloc(to->len);
1933 size = recv_from_to(G_listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
1934 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1937 if (errno == EAGAIN)
1939 bb_perror_msg_and_die("recv");
1941 addr = xmalloc_sockaddr2dotted_noport(from);
1942 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1947 query_status = msg.m_status;
1948 query_xmttime = msg.m_xmttime;
1950 /* Build a reply packet */
1951 memset(&msg, 0, sizeof(msg));
1952 msg.m_status = G.stratum < MAXSTRAT ? (G.ntp_status & LI_MASK) : LI_ALARM;
1953 msg.m_status |= (query_status & VERSION_MASK);
1954 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
1955 MODE_SERVER : MODE_SYM_PAS;
1956 msg.m_stratum = G.stratum;
1957 msg.m_ppoll = G.poll_exp;
1958 msg.m_precision_exp = G_precision_exp;
1959 /* this time was obtained between poll() and recv() */
1960 msg.m_rectime = d_to_lfp(G.cur_time);
1961 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
1962 if (G.peer_cnt == 0) {
1963 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
1964 G.reftime = G.cur_time;
1966 msg.m_reftime = d_to_lfp(G.reftime);
1967 msg.m_orgtime = query_xmttime;
1968 msg.m_rootdelay = d_to_sfp(G.rootdelay);
1969 //simple code does not do this, fix simple code!
1970 msg.m_rootdisp = d_to_sfp(G.rootdisp);
1971 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
1972 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
1974 /* We reply from the local address packet was sent to,
1975 * this makes to/from look swapped here: */
1976 do_sendto(G_listen_fd,
1977 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
1986 /* Upstream ntpd's options:
1988 * -4 Force DNS resolution of host names to the IPv4 namespace.
1989 * -6 Force DNS resolution of host names to the IPv6 namespace.
1990 * -a Require cryptographic authentication for broadcast client,
1991 * multicast client and symmetric passive associations.
1992 * This is the default.
1993 * -A Do not require cryptographic authentication for broadcast client,
1994 * multicast client and symmetric passive associations.
1995 * This is almost never a good idea.
1996 * -b Enable the client to synchronize to broadcast servers.
1998 * Specify the name and path of the configuration file,
1999 * default /etc/ntp.conf
2000 * -d Specify debugging mode. This option may occur more than once,
2001 * with each occurrence indicating greater detail of display.
2003 * Specify debugging level directly.
2005 * Specify the name and path of the frequency file.
2006 * This is the same operation as the "driftfile FILE"
2007 * configuration command.
2008 * -g Normally, ntpd exits with a message to the system log
2009 * if the offset exceeds the panic threshold, which is 1000 s
2010 * by default. This option allows the time to be set to any value
2011 * without restriction; however, this can happen only once.
2012 * If the threshold is exceeded after that, ntpd will exit
2013 * with a message to the system log. This option can be used
2014 * with the -q and -x options. See the tinker command for other options.
2016 * Chroot the server to the directory jaildir. This option also implies
2017 * that the server attempts to drop root privileges at startup
2018 * (otherwise, chroot gives very little additional security).
2019 * You may need to also specify a -u option.
2021 * Specify the name and path of the symmetric key file,
2022 * default /etc/ntp/keys. This is the same operation
2023 * as the "keys FILE" configuration command.
2025 * Specify the name and path of the log file. The default
2026 * is the system log file. This is the same operation as
2027 * the "logfile FILE" configuration command.
2028 * -L Do not listen to virtual IPs. The default is to listen.
2030 * -N To the extent permitted by the operating system,
2031 * run the ntpd at the highest priority.
2033 * Specify the name and path of the file used to record the ntpd
2034 * process ID. This is the same operation as the "pidfile FILE"
2035 * configuration command.
2037 * To the extent permitted by the operating system,
2038 * run the ntpd at the specified priority.
2039 * -q Exit the ntpd just after the first time the clock is set.
2040 * This behavior mimics that of the ntpdate program, which is
2041 * to be retired. The -g and -x options can be used with this option.
2042 * Note: The kernel time discipline is disabled with this option.
2044 * Specify the default propagation delay from the broadcast/multicast
2045 * server to this client. This is necessary only if the delay
2046 * cannot be computed automatically by the protocol.
2048 * Specify the directory path for files created by the statistics
2049 * facility. This is the same operation as the "statsdir DIR"
2050 * configuration command.
2052 * Add a key number to the trusted key list. This option can occur
2055 * Specify a user, and optionally a group, to switch to.
2058 * Add a system variable listed by default.
2059 * -x Normally, the time is slewed if the offset is less than the step
2060 * threshold, which is 128 ms by default, and stepped if above
2061 * the threshold. This option sets the threshold to 600 s, which is
2062 * well within the accuracy window to set the clock manually.
2063 * Note: since the slew rate of typical Unix kernels is limited
2064 * to 0.5 ms/s, each second of adjustment requires an amortization
2065 * interval of 2000 s. Thus, an adjustment as much as 600 s
2066 * will take almost 14 days to complete. This option can be used
2067 * with the -g and -q options. See the tinker command for other options.
2068 * Note: The kernel time discipline is disabled with this option.
2071 /* By doing init in a separate function we decrease stack usage
2074 static NOINLINE void ntp_init(char **argv)
2082 bb_error_msg_and_die(bb_msg_you_must_be_root);
2084 /* Set some globals */
2085 G.stratum = MAXSTRAT;
2087 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
2088 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
2092 opt_complementary = "dd:p::wn" /* -d: counter; -p: list; -w implies -n */
2093 IF_FEATURE_NTPD_SERVER(":Il"); /* -I implies -l */
2094 opts = getopt32(argv,
2096 "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
2097 IF_FEATURE_NTPD_SERVER("I:") /* compat */
2099 "46aAbgL", /* compat, ignored */
2100 &peers,&G.script_name,
2101 #if ENABLE_FEATURE_NTPD_SERVER
2106 // if (opts & OPT_x) /* disable stepping, only slew is allowed */
2107 // G.time_was_stepped = 1;
2110 add_peers(llist_pop(&peers));
2112 #if ENABLE_FEATURE_NTPD_CONF
2117 parser = config_open("/etc/ntp.conf");
2118 while (config_read(parser, token, 3, 1, "# \t", PARSE_NORMAL)) {
2119 if (strcmp(token[0], "server") == 0 && token[1]) {
2120 add_peers(token[1]);
2123 bb_error_msg("skipping %s:%u: unimplemented command '%s'",
2124 "/etc/ntp.conf", parser->lineno, token[0]
2127 config_close(parser);
2130 if (G.peer_cnt == 0) {
2131 if (!(opts & OPT_l))
2133 /* -l but no peers: "stratum 1 server" mode */
2136 #if ENABLE_FEATURE_NTPD_SERVER
2139 G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
2141 if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
2144 socket_want_pktinfo(G_listen_fd);
2145 setsockopt(G_listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
2148 if (!(opts & OPT_n)) {
2149 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
2150 logmode = LOGMODE_NONE;
2152 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
2154 setpriority(PRIO_PROCESS, 0, -15);
2156 /* If network is up, syncronization occurs in ~10 seconds.
2157 * We give "ntpd -q" 10 seconds to get first reply,
2158 * then another 50 seconds to finish syncing.
2160 * I tested ntpd 4.2.6p1 and apparently it never exits
2161 * (will try forever), but it does not feel right.
2162 * The goal of -q is to act like ntpdate: set time
2163 * after a reasonably small period of polling, or fail.
2166 option_mask32 |= OPT_qq;
2183 int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2184 int ntpd_main(int argc UNUSED_PARAM, char **argv)
2192 memset(&G, 0, sizeof(G));
2193 SET_PTR_TO_GLOBALS(&G);
2197 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2198 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2199 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2200 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2202 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
2203 * packets to each peer.
2204 * NB: if some peer is not responding, we may end up sending
2205 * fewer packets to it and more to other peers.
2206 * NB2: sync usually happens using INITIAL_SAMPLES packets,
2207 * since last reply does not come back instantaneously.
2209 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
2211 write_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2213 while (!bb_got_signal) {
2219 /* Nothing between here and poll() blocks for any significant time */
2221 nextaction = G.cur_time + 3600;
2224 #if ENABLE_FEATURE_NTPD_SERVER
2225 if (G_listen_fd != -1) {
2226 pfd[0].fd = G_listen_fd;
2227 pfd[0].events = POLLIN;
2231 /* Pass over peer list, send requests, time out on receives */
2232 for (item = G.ntp_peers; item != NULL; item = item->link) {
2233 peer_t *p = (peer_t *) item->data;
2235 if (p->next_action_time <= G.cur_time) {
2236 if (p->p_fd == -1) {
2237 /* Time to send new req */
2239 VERB4 bb_error_msg("disabling burst mode");
2240 G.polladj_count = 0;
2241 G.poll_exp = MINPOLL;
2242 G.initial_poll_complete = 1;
2244 send_query_to_peer(p);
2246 /* Timed out waiting for reply */
2249 timeout = poll_interval(-2); /* -2: try a bit sooner */
2250 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
2251 p->p_dotted, p->reachable_bits, timeout);
2252 set_next(p, timeout);
2256 if (p->next_action_time < nextaction)
2257 nextaction = p->next_action_time;
2260 /* Wait for reply from this peer */
2261 pfd[i].fd = p->p_fd;
2262 pfd[i].events = POLLIN;
2268 timeout = nextaction - G.cur_time;
2271 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
2273 /* Here we may block */
2275 if (i > (ENABLE_FEATURE_NTPD_SERVER && G_listen_fd != -1)) {
2276 /* We wait for at least one reply.
2277 * Poll for it, without wasting time for message.
2278 * Since replies often come under 1 second, this also
2279 * reduces clutter in logs.
2281 nfds = poll(pfd, i, 1000);
2287 bb_error_msg("poll:%us sockets:%u interval:%us", timeout, i, 1 << G.poll_exp);
2289 nfds = poll(pfd, i, timeout * 1000);
2291 gettime1900d(); /* sets G.cur_time */
2293 if (!bb_got_signal /* poll wasn't interrupted by a signal */
2294 && G.cur_time - G.last_script_run > 11*60
2296 /* Useful for updating battery-backed RTC and such */
2297 run_script("periodic", G.last_update_offset);
2298 gettime1900d(); /* sets G.cur_time */
2303 /* Process any received packets */
2305 #if ENABLE_FEATURE_NTPD_SERVER
2306 if (G.listen_fd != -1) {
2307 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2309 recv_and_process_client_pkt(/*G.listen_fd*/);
2310 gettime1900d(); /* sets G.cur_time */
2315 for (; nfds != 0 && j < i; j++) {
2316 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
2318 * At init, alarm was set to 10 sec.
2319 * Now we did get a reply.
2320 * Increase timeout to 50 seconds to finish syncing.
2322 if (option_mask32 & OPT_qq) {
2323 option_mask32 &= ~OPT_qq;
2327 recv_and_process_peer_pkt(idx2peer[j]);
2328 gettime1900d(); /* sets G.cur_time */
2333 if (G.ntp_peers && G.stratum != MAXSTRAT) {
2334 for (item = G.ntp_peers; item != NULL; item = item->link) {
2335 peer_t *p = (peer_t *) item->data;
2336 if (p->reachable_bits)
2337 goto have_reachable_peer;
2339 /* No peer responded for last 8 packets, panic */
2340 G.polladj_count = 0;
2341 G.poll_exp = MINPOLL;
2342 G.stratum = MAXSTRAT;
2343 run_script("unsync", 0.0);
2344 have_reachable_peer: ;
2346 } /* while (!bb_got_signal) */
2348 remove_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2349 kill_myself_with_sig(bb_got_signal);
2357 /*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2359 /*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2363 direct_freq(double fp_offset)
2367 * If the kernel is enabled, we need the residual offset to
2368 * calculate the frequency correction.
2370 if (pll_control && kern_enable) {
2371 memset(&ntv, 0, sizeof(ntv));
2374 clock_offset = ntv.offset / 1e9;
2375 #else /* STA_NANO */
2376 clock_offset = ntv.offset / 1e6;
2377 #endif /* STA_NANO */
2378 drift_comp = FREQTOD(ntv.freq);
2380 #endif /* KERNEL_PLL */
2381 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2387 set_freq(double freq) /* frequency update */
2395 * If the kernel is enabled, update the kernel frequency.
2397 if (pll_control && kern_enable) {
2398 memset(&ntv, 0, sizeof(ntv));
2399 ntv.modes = MOD_FREQUENCY;
2400 ntv.freq = DTOFREQ(drift_comp);
2402 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2403 report_event(EVNT_FSET, NULL, tbuf);
2405 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2406 report_event(EVNT_FSET, NULL, tbuf);
2408 #else /* KERNEL_PLL */
2409 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2410 report_event(EVNT_FSET, NULL, tbuf);
2411 #endif /* KERNEL_PLL */
2420 * This code segment works when clock adjustments are made using
2421 * precision time kernel support and the ntp_adjtime() system
2422 * call. This support is available in Solaris 2.6 and later,
2423 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2424 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2425 * DECstation 5000/240 and Alpha AXP, additional kernel
2426 * modifications provide a true microsecond clock and nanosecond
2427 * clock, respectively.
2429 * Important note: The kernel discipline is used only if the
2430 * step threshold is less than 0.5 s, as anything higher can
2431 * lead to overflow problems. This might occur if some misguided
2432 * lad set the step threshold to something ridiculous.
2434 if (pll_control && kern_enable) {
2436 #define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2439 * We initialize the structure for the ntp_adjtime()
2440 * system call. We have to convert everything to
2441 * microseconds or nanoseconds first. Do not update the
2442 * system variables if the ext_enable flag is set. In
2443 * this case, the external clock driver will update the
2444 * variables, which will be read later by the local
2445 * clock driver. Afterwards, remember the time and
2446 * frequency offsets for jitter and stability values and
2447 * to update the frequency file.
2449 memset(&ntv, 0, sizeof(ntv));
2451 ntv.modes = MOD_STATUS;
2454 ntv.modes = MOD_BITS | MOD_NANO;
2455 #else /* STA_NANO */
2456 ntv.modes = MOD_BITS;
2457 #endif /* STA_NANO */
2458 if (clock_offset < 0)
2463 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2464 ntv.constant = sys_poll;
2465 #else /* STA_NANO */
2466 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2467 ntv.constant = sys_poll - 4;
2468 #endif /* STA_NANO */
2469 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2470 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2471 ntv.status = STA_PLL;
2474 * Enable/disable the PPS if requested.
2477 if (!(pll_status & STA_PPSTIME))
2478 report_event(EVNT_KERN,
2479 NULL, "PPS enabled");
2480 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2482 if (pll_status & STA_PPSTIME)
2483 report_event(EVNT_KERN,
2484 NULL, "PPS disabled");
2485 ntv.status &= ~(STA_PPSTIME | STA_PPSFREQ);
2487 if (sys_leap == LEAP_ADDSECOND)
2488 ntv.status |= STA_INS;
2489 else if (sys_leap == LEAP_DELSECOND)
2490 ntv.status |= STA_DEL;
2494 * Pass the stuff to the kernel. If it squeals, turn off
2495 * the pps. In any case, fetch the kernel offset,
2496 * frequency and jitter.
2498 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2499 if (!(ntv.status & STA_PPSSIGNAL))
2500 report_event(EVNT_KERN, NULL,
2503 pll_status = ntv.status;
2505 clock_offset = ntv.offset / 1e9;
2506 #else /* STA_NANO */
2507 clock_offset = ntv.offset / 1e6;
2508 #endif /* STA_NANO */
2509 clock_frequency = FREQTOD(ntv.freq);
2512 * If the kernel PPS is lit, monitor its performance.
2514 if (ntv.status & STA_PPSTIME) {
2516 clock_jitter = ntv.jitter / 1e9;
2517 #else /* STA_NANO */
2518 clock_jitter = ntv.jitter / 1e6;
2519 #endif /* STA_NANO */
2522 #if defined(STA_NANO) && NTP_API == 4
2524 * If the TAI changes, update the kernel TAI.
2526 if (loop_tai != sys_tai) {
2528 ntv.modes = MOD_TAI;
2529 ntv.constant = sys_tai;
2532 #endif /* STA_NANO */
2534 #endif /* KERNEL_PLL */