a8738951fae4ef284c98eff5061206822a952154
[oweals/busybox.git] / networking / ntpd.c
1 /*
2  * NTP client/server, based on OpenNTPD 3.9p1
3  *
4  * Author: Adam Tkac <vonsch@gmail.com>
5  *
6  * Licensed under GPLv2, see file LICENSE in this source tree.
7  *
8  * Parts of OpenNTPD clock syncronization code is replaced by
9  * code which is based on ntp-4.2.6, whuch carries the following
10  * copyright notice:
11  *
12  ***********************************************************************
13  *                                                                     *
14  * Copyright (c) University of Delaware 1992-2009                      *
15  *                                                                     *
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          *
26  * warranty.                                                           *
27  *                                                                     *
28  ***********************************************************************
29  */
30
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"
42 //usage:        )
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)"
45
46 #include "libbb.h"
47 #include <math.h>
48 #include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
49 #include <sys/timex.h>
50 #ifndef IPTOS_LOWDELAY
51 # define IPTOS_LOWDELAY 0x10
52 #endif
53 #ifndef IP_PKTINFO
54 # error "Sorry, your kernel has to support IP_PKTINFO"
55 #endif
56
57
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.
61  */
62 #define MAX_VERBOSE     2
63
64
65 /* High-level description of the algorithm:
66  *
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.
75  *
76  * (frequency measurement step seems to not be strictly needed,
77  * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
78  * define set to 0)
79  *
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.
86  *
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.
92  */
93
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 */
97
98 /* Clock discipline parameters and constants */
99
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) */
106
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 #define BIGPOLL         10      /* drop to lower poll at any trouble (10: 17 min) */
111 #define MAXPOLL         12      /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
112 /* Actively lower poll when we see such big offsets.
113  * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
114  * if offset increases over ~0.04 sec */
115 #define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
116 #define MINDISP         0.01    /* minimum dispersion (sec) */
117 #define MAXDISP         16      /* maximum dispersion (sec) */
118 #define MAXSTRAT        16      /* maximum stratum (infinity metric) */
119 #define MAXDIST         1       /* distance threshold (sec) */
120 #define MIN_SELECTED    1       /* minimum intersection survivors */
121 #define MIN_CLUSTERED   3       /* minimum cluster survivors */
122
123 #define MAXDRIFT        0.000500 /* frequency drift we can correct (500 PPM) */
124
125 /* Poll-adjust threshold.
126  * When we see that offset is small enough compared to discipline jitter,
127  * we grow a counter: += MINPOLL. When it goes over POLLADJ_LIMIT,
128  * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
129  * and when it goes below -POLLADJ_LIMIT, we poll_exp--
130  * (bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
131  */
132 #define POLLADJ_LIMIT   40
133 /* If offset < POLLADJ_GATE * discipline_jitter, then we can increase
134  * poll interval (we think we can't improve timekeeping
135  * by staying at smaller poll).
136  */
137 #define POLLADJ_GATE    4
138 /* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
139 #define ALLAN           512
140 /* PLL loop gain */
141 #define PLL             65536
142 /* FLL loop gain [why it depends on MAXPOLL??] */
143 #define FLL             (MAXPOLL + 1)
144 /* Parameter averaging constant */
145 #define AVG             4
146
147
148 enum {
149         NTP_VERSION     = 4,
150         NTP_MAXSTRATUM  = 15,
151
152         NTP_DIGESTSIZE     = 16,
153         NTP_MSGSIZE_NOAUTH = 48,
154         NTP_MSGSIZE        = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
155
156         /* Status Masks */
157         MODE_MASK       = (7 << 0),
158         VERSION_MASK    = (7 << 3),
159         VERSION_SHIFT   = 3,
160         LI_MASK         = (3 << 6),
161
162         /* Leap Second Codes (high order two bits of m_status) */
163         LI_NOWARNING    = (0 << 6),    /* no warning */
164         LI_PLUSSEC      = (1 << 6),    /* add a second (61 seconds) */
165         LI_MINUSSEC     = (2 << 6),    /* minus a second (59 seconds) */
166         LI_ALARM        = (3 << 6),    /* alarm condition */
167
168         /* Mode values */
169         MODE_RES0       = 0,    /* reserved */
170         MODE_SYM_ACT    = 1,    /* symmetric active */
171         MODE_SYM_PAS    = 2,    /* symmetric passive */
172         MODE_CLIENT     = 3,    /* client */
173         MODE_SERVER     = 4,    /* server */
174         MODE_BROADCAST  = 5,    /* broadcast */
175         MODE_RES1       = 6,    /* reserved for NTP control message */
176         MODE_RES2       = 7,    /* reserved for private use */
177 };
178
179 //TODO: better base selection
180 #define OFFSET_1900_1970 2208988800UL  /* 1970 - 1900 in seconds */
181
182 #define NUM_DATAPOINTS  8
183
184 typedef struct {
185         uint32_t int_partl;
186         uint32_t fractionl;
187 } l_fixedpt_t;
188
189 typedef struct {
190         uint16_t int_parts;
191         uint16_t fractions;
192 } s_fixedpt_t;
193
194 typedef struct {
195         uint8_t     m_status;     /* status of local clock and leap info */
196         uint8_t     m_stratum;
197         uint8_t     m_ppoll;      /* poll value */
198         int8_t      m_precision_exp;
199         s_fixedpt_t m_rootdelay;
200         s_fixedpt_t m_rootdisp;
201         uint32_t    m_refid;
202         l_fixedpt_t m_reftime;
203         l_fixedpt_t m_orgtime;
204         l_fixedpt_t m_rectime;
205         l_fixedpt_t m_xmttime;
206         uint32_t    m_keyid;
207         uint8_t     m_digest[NTP_DIGESTSIZE];
208 } msg_t;
209
210 typedef struct {
211         double d_recv_time;
212         double d_offset;
213         double d_dispersion;
214 } datapoint_t;
215
216 typedef struct {
217         len_and_sockaddr *p_lsa;
218         char             *p_dotted;
219         /* when to send new query (if p_fd == -1)
220          * or when receive times out (if p_fd >= 0): */
221         int              p_fd;
222         int              datapoint_idx;
223         uint32_t         lastpkt_refid;
224         uint8_t          lastpkt_status;
225         uint8_t          lastpkt_stratum;
226         uint8_t          reachable_bits;
227         double           next_action_time;
228         double           p_xmttime;
229         double           lastpkt_recv_time;
230         double           lastpkt_delay;
231         double           lastpkt_rootdelay;
232         double           lastpkt_rootdisp;
233         /* produced by filter algorithm: */
234         double           filter_offset;
235         double           filter_dispersion;
236         double           filter_jitter;
237         datapoint_t      filter_datapoint[NUM_DATAPOINTS];
238         /* last sent packet: */
239         msg_t            p_xmt_msg;
240 } peer_t;
241
242
243 #define USING_KERNEL_PLL_LOOP          1
244 #define USING_INITIAL_FREQ_ESTIMATION  0
245
246 enum {
247         OPT_n = (1 << 0),
248         OPT_q = (1 << 1),
249         OPT_N = (1 << 2),
250         OPT_x = (1 << 3),
251         /* Insert new options above this line. */
252         /* Non-compat options: */
253         OPT_w = (1 << 4),
254         OPT_p = (1 << 5),
255         OPT_S = (1 << 6),
256         OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
257         /* We hijack some bits for other purposes */
258         OPT_qq = (1 << 31),
259 };
260
261 struct globals {
262         double   cur_time;
263         /* total round trip delay to currently selected reference clock */
264         double   rootdelay;
265         /* reference timestamp: time when the system clock was last set or corrected */
266         double   reftime;
267         /* total dispersion to currently selected reference clock */
268         double   rootdisp;
269
270         double   last_script_run;
271         char     *script_name;
272         llist_t  *ntp_peers;
273 #if ENABLE_FEATURE_NTPD_SERVER
274         int      listen_fd;
275 #endif
276         unsigned verbose;
277         unsigned peer_cnt;
278         /* refid: 32-bit code identifying the particular server or reference clock
279          *  in stratum 0 packets this is a four-character ASCII string,
280          *  called the kiss code, used for debugging and monitoring
281          *  in stratum 1 packets this is a four-character ASCII string
282          *  assigned to the reference clock by IANA. Example: "GPS "
283          *  in stratum 2+ packets, it's IPv4 address or 4 first bytes of MD5 hash of IPv6
284          */
285         uint32_t refid;
286         uint8_t  ntp_status;
287         /* precision is defined as the larger of the resolution and time to
288          * read the clock, in log2 units.  For instance, the precision of a
289          * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
290          * system clock hardware representation is to the nanosecond.
291          *
292          * Delays, jitters of various kinds are clamper down to precision.
293          *
294          * If precision_sec is too large, discipline_jitter gets clamped to it
295          * and if offset is much smaller than discipline_jitter, poll interval
296          * grows even though we really can benefit from staying at smaller one,
297          * collecting non-lagged datapoits and correcting the offset.
298          * (Lagged datapoits exist when poll_exp is large but we still have
299          * systematic offset error - the time distance between datapoints
300          * is significat and older datapoints have smaller offsets.
301          * This makes our offset estimation a bit smaller than reality)
302          * Due to this effect, setting G_precision_sec close to
303          * STEP_THRESHOLD isn't such a good idea - offsets may grow
304          * too big and we will step. I observed it with -6.
305          *
306          * OTOH, setting precision too small would result in futile attempts
307          * to syncronize to the unachievable precision.
308          *
309          * -6 is 1/64 sec, -7 is 1/128 sec and so on.
310          */
311 #define G_precision_exp  -8
312 #define G_precision_sec  (1.0 / (1 << (- G_precision_exp)))
313         uint8_t  stratum;
314         /* Bool. After set to 1, never goes back to 0: */
315         smallint initial_poll_complete;
316
317 #define STATE_NSET      0       /* initial state, "nothing is set" */
318 //#define STATE_FSET    1       /* frequency set from file */
319 #define STATE_SPIK      2       /* spike detected */
320 //#define STATE_FREQ    3       /* initial frequency */
321 #define STATE_SYNC      4       /* clock synchronized (normal operation) */
322         uint8_t  discipline_state;      // doc calls it c.state
323         uint8_t  poll_exp;              // s.poll
324         int      polladj_count;         // c.count
325         long     kernel_freq_drift;
326         peer_t   *last_update_peer;
327         double   last_update_offset;    // c.last
328         double   last_update_recv_time; // s.t
329         double   discipline_jitter;     // c.jitter
330         //double   cluster_offset;        // s.offset
331         //double   cluster_jitter;        // s.jitter
332 #if !USING_KERNEL_PLL_LOOP
333         double   discipline_freq_drift; // c.freq
334         /* Maybe conditionally calculate wander? it's used only for logging */
335         double   discipline_wander;     // c.wander
336 #endif
337 };
338 #define G (*ptr_to_globals)
339
340 static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
341
342
343 #define VERB1 if (MAX_VERBOSE && G.verbose)
344 #define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
345 #define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
346 #define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
347 #define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
348
349
350 static double LOG2D(int a)
351 {
352         if (a < 0)
353                 return 1.0 / (1UL << -a);
354         return 1UL << a;
355 }
356 static ALWAYS_INLINE double SQUARE(double x)
357 {
358         return x * x;
359 }
360 static ALWAYS_INLINE double MAXD(double a, double b)
361 {
362         if (a > b)
363                 return a;
364         return b;
365 }
366 static ALWAYS_INLINE double MIND(double a, double b)
367 {
368         if (a < b)
369                 return a;
370         return b;
371 }
372 static NOINLINE double my_SQRT(double X)
373 {
374         union {
375                 float   f;
376                 int32_t i;
377         } v;
378         double invsqrt;
379         double Xhalf = X * 0.5;
380
381         /* Fast and good approximation to 1/sqrt(X), black magic */
382         v.f = X;
383         /*v.i = 0x5f3759df - (v.i >> 1);*/
384         v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
385         invsqrt = v.f; /* better than 0.2% accuracy */
386
387         /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
388          * f(x) = 1/(x*x) - X  (f==0 when x = 1/sqrt(X))
389          * f'(x) = -2/(x*x*x)
390          * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
391          * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
392          */
393         invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
394         /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
395         /* With 4 iterations, more than half results will be exact,
396          * at 6th iterations result stabilizes with about 72% results exact.
397          * We are well satisfied with 0.05% accuracy.
398          */
399
400         return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
401 }
402 static ALWAYS_INLINE double SQRT(double X)
403 {
404         /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
405         if (sizeof(float) != 4)
406                 return sqrt(X);
407
408         /* This avoids needing libm, saves about 0.5k on x86-32 */
409         return my_SQRT(X);
410 }
411
412 static double
413 gettime1900d(void)
414 {
415         struct timeval tv;
416         gettimeofday(&tv, NULL); /* never fails */
417         G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
418         return G.cur_time;
419 }
420
421 static void
422 d_to_tv(double d, struct timeval *tv)
423 {
424         tv->tv_sec = (long)d;
425         tv->tv_usec = (d - tv->tv_sec) * 1000000;
426 }
427
428 static double
429 lfp_to_d(l_fixedpt_t lfp)
430 {
431         double ret;
432         lfp.int_partl = ntohl(lfp.int_partl);
433         lfp.fractionl = ntohl(lfp.fractionl);
434         ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
435         return ret;
436 }
437 static double
438 sfp_to_d(s_fixedpt_t sfp)
439 {
440         double ret;
441         sfp.int_parts = ntohs(sfp.int_parts);
442         sfp.fractions = ntohs(sfp.fractions);
443         ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
444         return ret;
445 }
446 #if ENABLE_FEATURE_NTPD_SERVER
447 static l_fixedpt_t
448 d_to_lfp(double d)
449 {
450         l_fixedpt_t lfp;
451         lfp.int_partl = (uint32_t)d;
452         lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
453         lfp.int_partl = htonl(lfp.int_partl);
454         lfp.fractionl = htonl(lfp.fractionl);
455         return lfp;
456 }
457 static s_fixedpt_t
458 d_to_sfp(double d)
459 {
460         s_fixedpt_t sfp;
461         sfp.int_parts = (uint16_t)d;
462         sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
463         sfp.int_parts = htons(sfp.int_parts);
464         sfp.fractions = htons(sfp.fractions);
465         return sfp;
466 }
467 #endif
468
469 static double
470 dispersion(const datapoint_t *dp)
471 {
472         return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
473 }
474
475 static double
476 root_distance(peer_t *p)
477 {
478         /* The root synchronization distance is the maximum error due to
479          * all causes of the local clock relative to the primary server.
480          * It is defined as half the total delay plus total dispersion
481          * plus peer jitter.
482          */
483         return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
484                 + p->lastpkt_rootdisp
485                 + p->filter_dispersion
486                 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
487                 + p->filter_jitter;
488 }
489
490 static void
491 set_next(peer_t *p, unsigned t)
492 {
493         p->next_action_time = G.cur_time + t;
494 }
495
496 /*
497  * Peer clock filter and its helpers
498  */
499 static void
500 filter_datapoints(peer_t *p)
501 {
502         int i, idx;
503         int got_newest;
504         double minoff, maxoff, wavg, sum, w;
505         double x = x; /* for compiler */
506         double oldest_off = oldest_off;
507         double oldest_age = oldest_age;
508         double newest_off = newest_off;
509         double newest_age = newest_age;
510
511         minoff = maxoff = p->filter_datapoint[0].d_offset;
512         for (i = 1; i < NUM_DATAPOINTS; i++) {
513                 if (minoff > p->filter_datapoint[i].d_offset)
514                         minoff = p->filter_datapoint[i].d_offset;
515                 if (maxoff < p->filter_datapoint[i].d_offset)
516                         maxoff = p->filter_datapoint[i].d_offset;
517         }
518
519         idx = p->datapoint_idx; /* most recent datapoint */
520         /* Average offset:
521          * Drop two outliers and take weighted average of the rest:
522          * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
523          * we use older6/32, not older6/64 since sum of weights should be 1:
524          * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
525          */
526         wavg = 0;
527         w = 0.5;
528         /*                     n-1
529          *                     ---    dispersion(i)
530          * filter_dispersion =  \     -------------
531          *                      /       (i+1)
532          *                     ---     2
533          *                     i=0
534          */
535         got_newest = 0;
536         sum = 0;
537         for (i = 0; i < NUM_DATAPOINTS; i++) {
538                 VERB4 {
539                         bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
540                                 i,
541                                 p->filter_datapoint[idx].d_offset,
542                                 p->filter_datapoint[idx].d_dispersion, dispersion(&p->filter_datapoint[idx]),
543                                 G.cur_time - p->filter_datapoint[idx].d_recv_time,
544                                 (minoff == p->filter_datapoint[idx].d_offset || maxoff == p->filter_datapoint[idx].d_offset)
545                                         ? " (outlier by offset)" : ""
546                         );
547                 }
548
549                 sum += dispersion(&p->filter_datapoint[idx]) / (2 << i);
550
551                 if (minoff == p->filter_datapoint[idx].d_offset) {
552                         minoff -= 1; /* so that we don't match it ever again */
553                 } else
554                 if (maxoff == p->filter_datapoint[idx].d_offset) {
555                         maxoff += 1;
556                 } else {
557                         oldest_off = p->filter_datapoint[idx].d_offset;
558                         oldest_age = G.cur_time - p->filter_datapoint[idx].d_recv_time;
559                         if (!got_newest) {
560                                 got_newest = 1;
561                                 newest_off = oldest_off;
562                                 newest_age = oldest_age;
563                         }
564                         x = oldest_off * w;
565                         wavg += x;
566                         w /= 2;
567                 }
568
569                 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
570         }
571         p->filter_dispersion = sum;
572         wavg += x; /* add another older6/64 to form older6/32 */
573         /* Fix systematic underestimation with large poll intervals.
574          * Imagine that we still have a bit of uncorrected drift,
575          * and poll interval is big (say, 100 sec). Offsets form a progression:
576          * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
577          * The algorithm above drops 0.0 and 0.7 as outliers,
578          * and then we have this estimation, ~25% off from 0.7:
579          * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
580          */
581         x = oldest_age - newest_age;
582         if (x != 0) {
583                 x = newest_age / x; /* in above example, 100 / (600 - 100) */
584                 if (x < 1) { /* paranoia check */
585                         x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
586                         wavg += x;
587                 }
588         }
589         p->filter_offset = wavg;
590
591         /*                  +-----                 -----+ ^ 1/2
592          *                  |       n-1                 |
593          *                  |       ---                 |
594          *                  |  1    \                2  |
595          * filter_jitter =  | --- * /  (avg-offset_j)   |
596          *                  |  n    ---                 |
597          *                  |       j=0                 |
598          *                  +-----                 -----+
599          * where n is the number of valid datapoints in the filter (n > 1);
600          * if filter_jitter < precision then filter_jitter = precision
601          */
602         sum = 0;
603         for (i = 0; i < NUM_DATAPOINTS; i++) {
604                 sum += SQUARE(wavg - p->filter_datapoint[i].d_offset);
605         }
606         sum = SQRT(sum / NUM_DATAPOINTS);
607         p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
608
609         VERB3 bb_error_msg("filter offset:%+f(corr:%e) disp:%f jitter:%f",
610                         p->filter_offset, x,
611                         p->filter_dispersion,
612                         p->filter_jitter);
613 }
614
615 static void
616 reset_peer_stats(peer_t *p, double offset)
617 {
618         int i;
619         bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
620
621         for (i = 0; i < NUM_DATAPOINTS; i++) {
622                 if (small_ofs) {
623                         p->filter_datapoint[i].d_recv_time += offset;
624                         if (p->filter_datapoint[i].d_offset != 0) {
625                                 p->filter_datapoint[i].d_offset -= offset;
626                                 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
627                                 //      i,
628                                 //      p->filter_datapoint[i].d_offset + offset,
629                                 //      p->filter_datapoint[i].d_offset);
630                         }
631                 } else {
632                         p->filter_datapoint[i].d_recv_time  = G.cur_time;
633                         p->filter_datapoint[i].d_offset     = 0;
634                         p->filter_datapoint[i].d_dispersion = MAXDISP;
635                 }
636         }
637         if (small_ofs) {
638                 p->lastpkt_recv_time += offset;
639         } else {
640                 p->reachable_bits = 0;
641                 p->lastpkt_recv_time = G.cur_time;
642         }
643         filter_datapoints(p); /* recalc p->filter_xxx */
644         VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
645 }
646
647 static void
648 add_peers(char *s)
649 {
650         peer_t *p;
651
652         p = xzalloc(sizeof(*p));
653         p->p_lsa = xhost2sockaddr(s, 123);
654         p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
655         p->p_fd = -1;
656         p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
657         p->next_action_time = G.cur_time; /* = set_next(p, 0); */
658         reset_peer_stats(p, 16 * STEP_THRESHOLD);
659
660         llist_add_to(&G.ntp_peers, p);
661         G.peer_cnt++;
662 }
663
664 static int
665 do_sendto(int fd,
666                 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
667                 msg_t *msg, ssize_t len)
668 {
669         ssize_t ret;
670
671         errno = 0;
672         if (!from) {
673                 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
674         } else {
675                 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
676         }
677         if (ret != len) {
678                 bb_perror_msg("send failed");
679                 return -1;
680         }
681         return 0;
682 }
683
684 static void
685 send_query_to_peer(peer_t *p)
686 {
687         /* Why do we need to bind()?
688          * See what happens when we don't bind:
689          *
690          * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
691          * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
692          * gettimeofday({1259071266, 327885}, NULL) = 0
693          * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
694          * ^^^ we sent it from some source port picked by kernel.
695          * time(NULL)              = 1259071266
696          * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
697          * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
698          * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
699          * ^^^ this recv will receive packets to any local port!
700          *
701          * Uncomment this and use strace to see it in action:
702          */
703 #define PROBE_LOCAL_ADDR /* { len_and_sockaddr lsa; lsa.len = LSA_SIZEOF_SA; getsockname(p->query.fd, &lsa.u.sa, &lsa.len); } */
704
705         if (p->p_fd == -1) {
706                 int fd, family;
707                 len_and_sockaddr *local_lsa;
708
709                 family = p->p_lsa->u.sa.sa_family;
710                 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
711                 /* local_lsa has "null" address and port 0 now.
712                  * bind() ensures we have a *particular port* selected by kernel
713                  * and remembered in p->p_fd, thus later recv(p->p_fd)
714                  * receives only packets sent to this port.
715                  */
716                 PROBE_LOCAL_ADDR
717                 xbind(fd, &local_lsa->u.sa, local_lsa->len);
718                 PROBE_LOCAL_ADDR
719 #if ENABLE_FEATURE_IPV6
720                 if (family == AF_INET)
721 #endif
722                         setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
723                 free(local_lsa);
724         }
725
726         /*
727          * Send out a random 64-bit number as our transmit time.  The NTP
728          * server will copy said number into the originate field on the
729          * response that it sends us.  This is totally legal per the SNTP spec.
730          *
731          * The impact of this is two fold: we no longer send out the current
732          * system time for the world to see (which may aid an attacker), and
733          * it gives us a (not very secure) way of knowing that we're not
734          * getting spoofed by an attacker that can't capture our traffic
735          * but can spoof packets from the NTP server we're communicating with.
736          *
737          * Save the real transmit timestamp locally.
738          */
739         p->p_xmt_msg.m_xmttime.int_partl = random();
740         p->p_xmt_msg.m_xmttime.fractionl = random();
741         p->p_xmttime = gettime1900d();
742
743         if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
744                         &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
745         ) {
746                 close(p->p_fd);
747                 p->p_fd = -1;
748                 set_next(p, RETRY_INTERVAL);
749                 return;
750         }
751
752         p->reachable_bits <<= 1;
753         VERB1 bb_error_msg("sent query to %s", p->p_dotted);
754         set_next(p, RESPONSE_INTERVAL);
755 }
756
757
758 /* Note that there is no provision to prevent several run_scripts
759  * to be done in quick succession. In fact, it happens rather often
760  * if initial syncronization results in a step.
761  * You will see "step" and then "stratum" script runs, sometimes
762  * as close as only 0.002 seconds apart.
763  * Script should be ready to deal with this.
764  */
765 static void run_script(const char *action, double offset)
766 {
767         char *argv[3];
768         char *env1, *env2, *env3, *env4;
769
770         if (!G.script_name)
771                 return;
772
773         argv[0] = (char*) G.script_name;
774         argv[1] = (char*) action;
775         argv[2] = NULL;
776
777         VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
778
779         env1 = xasprintf("%s=%u", "stratum", G.stratum);
780         putenv(env1);
781         env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
782         putenv(env2);
783         env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
784         putenv(env3);
785         env4 = xasprintf("%s=%f", "offset", offset);
786         putenv(env4);
787         /* Other items of potential interest: selected peer,
788          * rootdelay, reftime, rootdisp, refid, ntp_status,
789          * last_update_offset, last_update_recv_time, discipline_jitter,
790          * how many peers have reachable_bits = 0?
791          */
792
793         /* Don't want to wait: it may run hwclock --systohc, and that
794          * may take some time (seconds): */
795         /*spawn_and_wait(argv);*/
796         spawn(argv);
797
798         unsetenv("stratum");
799         unsetenv("freq_drift_ppm");
800         unsetenv("poll_interval");
801         unsetenv("offset");
802         free(env1);
803         free(env2);
804         free(env3);
805         free(env4);
806
807         G.last_script_run = G.cur_time;
808 }
809
810 static NOINLINE void
811 step_time(double offset)
812 {
813         llist_t *item;
814         double dtime;
815         struct timeval tvc, tvn;
816         char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
817         time_t tval;
818
819         gettimeofday(&tvc, NULL); /* never fails */
820         dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
821         d_to_tv(dtime, &tvn);
822         if (settimeofday(&tvn, NULL) == -1)
823                 bb_perror_msg_and_die("settimeofday");
824
825         VERB2 {
826                 tval = tvc.tv_sec;
827                 strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", localtime(&tval));
828                 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
829         }
830         tval = tvn.tv_sec;
831         strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", localtime(&tval));
832         bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
833
834         /* Correct various fields which contain time-relative values: */
835
836         /* p->lastpkt_recv_time, p->next_action_time and such: */
837         for (item = G.ntp_peers; item != NULL; item = item->link) {
838                 peer_t *pp = (peer_t *) item->data;
839                 reset_peer_stats(pp, offset);
840                 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
841                 //      offset, pp->next_action_time, pp->next_action_time + offset);
842                 pp->next_action_time += offset;
843         }
844         /* Globals: */
845         G.cur_time += offset;
846         G.last_update_recv_time += offset;
847         G.last_script_run += offset;
848 }
849
850
851 /*
852  * Selection and clustering, and their helpers
853  */
854 typedef struct {
855         peer_t *p;
856         int    type;
857         double edge;
858         double opt_rd; /* optimization */
859 } point_t;
860 static int
861 compare_point_edge(const void *aa, const void *bb)
862 {
863         const point_t *a = aa;
864         const point_t *b = bb;
865         if (a->edge < b->edge) {
866                 return -1;
867         }
868         return (a->edge > b->edge);
869 }
870 typedef struct {
871         peer_t *p;
872         double metric;
873 } survivor_t;
874 static int
875 compare_survivor_metric(const void *aa, const void *bb)
876 {
877         const survivor_t *a = aa;
878         const survivor_t *b = bb;
879         if (a->metric < b->metric) {
880                 return -1;
881         }
882         return (a->metric > b->metric);
883 }
884 static int
885 fit(peer_t *p, double rd)
886 {
887         if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
888                 /* One or zero bits in reachable_bits */
889                 VERB3 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
890                 return 0;
891         }
892 #if 0 /* we filter out such packets earlier */
893         if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
894          || p->lastpkt_stratum >= MAXSTRAT
895         ) {
896                 VERB3 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
897                 return 0;
898         }
899 #endif
900         /* rd is root_distance(p) */
901         if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
902                 VERB3 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
903                 return 0;
904         }
905 //TODO
906 //      /* Do we have a loop? */
907 //      if (p->refid == p->dstaddr || p->refid == s.refid)
908 //              return 0;
909         return 1;
910 }
911 static peer_t*
912 select_and_cluster(void)
913 {
914         peer_t     *p;
915         llist_t    *item;
916         int        i, j;
917         int        size = 3 * G.peer_cnt;
918         /* for selection algorithm */
919         point_t    point[size];
920         unsigned   num_points, num_candidates;
921         double     low, high;
922         unsigned   num_falsetickers;
923         /* for cluster algorithm */
924         survivor_t survivor[size];
925         unsigned   num_survivors;
926
927         /* Selection */
928
929         num_points = 0;
930         item = G.ntp_peers;
931         if (G.initial_poll_complete) while (item != NULL) {
932                 double rd, offset;
933
934                 p = (peer_t *) item->data;
935                 rd = root_distance(p);
936                 offset = p->filter_offset;
937                 if (!fit(p, rd)) {
938                         item = item->link;
939                         continue;
940                 }
941
942                 VERB4 bb_error_msg("interval: [%f %f %f] %s",
943                                 offset - rd,
944                                 offset,
945                                 offset + rd,
946                                 p->p_dotted
947                 );
948                 point[num_points].p = p;
949                 point[num_points].type = -1;
950                 point[num_points].edge = offset - rd;
951                 point[num_points].opt_rd = rd;
952                 num_points++;
953                 point[num_points].p = p;
954                 point[num_points].type = 0;
955                 point[num_points].edge = offset;
956                 point[num_points].opt_rd = rd;
957                 num_points++;
958                 point[num_points].p = p;
959                 point[num_points].type = 1;
960                 point[num_points].edge = offset + rd;
961                 point[num_points].opt_rd = rd;
962                 num_points++;
963                 item = item->link;
964         }
965         num_candidates = num_points / 3;
966         if (num_candidates == 0) {
967                 VERB3 bb_error_msg("no valid datapoints, no peer selected");
968                 return NULL;
969         }
970 //TODO: sorting does not seem to be done in reference code
971         qsort(point, num_points, sizeof(point[0]), compare_point_edge);
972
973         /* Start with the assumption that there are no falsetickers.
974          * Attempt to find a nonempty intersection interval containing
975          * the midpoints of all truechimers.
976          * If a nonempty interval cannot be found, increase the number
977          * of assumed falsetickers by one and try again.
978          * If a nonempty interval is found and the number of falsetickers
979          * is less than the number of truechimers, a majority has been found
980          * and the midpoint of each truechimer represents
981          * the candidates available to the cluster algorithm.
982          */
983         num_falsetickers = 0;
984         while (1) {
985                 int c;
986                 unsigned num_midpoints = 0;
987
988                 low = 1 << 9;
989                 high = - (1 << 9);
990                 c = 0;
991                 for (i = 0; i < num_points; i++) {
992                         /* We want to do:
993                          * if (point[i].type == -1) c++;
994                          * if (point[i].type == 1) c--;
995                          * and it's simpler to do it this way:
996                          */
997                         c -= point[i].type;
998                         if (c >= num_candidates - num_falsetickers) {
999                                 /* If it was c++ and it got big enough... */
1000                                 low = point[i].edge;
1001                                 break;
1002                         }
1003                         if (point[i].type == 0)
1004                                 num_midpoints++;
1005                 }
1006                 c = 0;
1007                 for (i = num_points-1; i >= 0; i--) {
1008                         c += point[i].type;
1009                         if (c >= num_candidates - num_falsetickers) {
1010                                 high = point[i].edge;
1011                                 break;
1012                         }
1013                         if (point[i].type == 0)
1014                                 num_midpoints++;
1015                 }
1016                 /* If the number of midpoints is greater than the number
1017                  * of allowed falsetickers, the intersection contains at
1018                  * least one truechimer with no midpoint - bad.
1019                  * Also, interval should be nonempty.
1020                  */
1021                 if (num_midpoints <= num_falsetickers && low < high)
1022                         break;
1023                 num_falsetickers++;
1024                 if (num_falsetickers * 2 >= num_candidates) {
1025                         VERB3 bb_error_msg("too many falsetickers:%d (candidates:%d), no peer selected",
1026                                         num_falsetickers, num_candidates);
1027                         return NULL;
1028                 }
1029         }
1030         VERB3 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
1031                         low, high, num_candidates, num_falsetickers);
1032
1033         /* Clustering */
1034
1035         /* Construct a list of survivors (p, metric)
1036          * from the chime list, where metric is dominated
1037          * first by stratum and then by root distance.
1038          * All other things being equal, this is the order of preference.
1039          */
1040         num_survivors = 0;
1041         for (i = 0; i < num_points; i++) {
1042                 if (point[i].edge < low || point[i].edge > high)
1043                         continue;
1044                 p = point[i].p;
1045                 survivor[num_survivors].p = p;
1046                 /* x.opt_rd == root_distance(p); */
1047                 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
1048                 VERB4 bb_error_msg("survivor[%d] metric:%f peer:%s",
1049                         num_survivors, survivor[num_survivors].metric, p->p_dotted);
1050                 num_survivors++;
1051         }
1052         /* There must be at least MIN_SELECTED survivors to satisfy the
1053          * correctness assertions. Ordinarily, the Byzantine criteria
1054          * require four survivors, but for the demonstration here, one
1055          * is acceptable.
1056          */
1057         if (num_survivors < MIN_SELECTED) {
1058                 VERB3 bb_error_msg("num_survivors %d < %d, no peer selected",
1059                                 num_survivors, MIN_SELECTED);
1060                 return NULL;
1061         }
1062
1063 //looks like this is ONLY used by the fact that later we pick survivor[0].
1064 //we can avoid sorting then, just find the minimum once!
1065         qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1066
1067         /* For each association p in turn, calculate the selection
1068          * jitter p->sjitter as the square root of the sum of squares
1069          * (p->offset - q->offset) over all q associations. The idea is
1070          * to repeatedly discard the survivor with maximum selection
1071          * jitter until a termination condition is met.
1072          */
1073         while (1) {
1074                 unsigned max_idx = max_idx;
1075                 double max_selection_jitter = max_selection_jitter;
1076                 double min_jitter = min_jitter;
1077
1078                 if (num_survivors <= MIN_CLUSTERED) {
1079                         VERB3 bb_error_msg("num_survivors %d <= %d, not discarding more",
1080                                         num_survivors, MIN_CLUSTERED);
1081                         break;
1082                 }
1083
1084                 /* To make sure a few survivors are left
1085                  * for the clustering algorithm to chew on,
1086                  * we stop if the number of survivors
1087                  * is less than or equal to MIN_CLUSTERED (3).
1088                  */
1089                 for (i = 0; i < num_survivors; i++) {
1090                         double selection_jitter_sq;
1091
1092                         p = survivor[i].p;
1093                         if (i == 0 || p->filter_jitter < min_jitter)
1094                                 min_jitter = p->filter_jitter;
1095
1096                         selection_jitter_sq = 0;
1097                         for (j = 0; j < num_survivors; j++) {
1098                                 peer_t *q = survivor[j].p;
1099                                 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1100                         }
1101                         if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1102                                 max_selection_jitter = selection_jitter_sq;
1103                                 max_idx = i;
1104                         }
1105                         VERB5 bb_error_msg("survivor %d selection_jitter^2:%f",
1106                                         i, selection_jitter_sq);
1107                 }
1108                 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
1109                 VERB4 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
1110                                 max_idx, max_selection_jitter, min_jitter);
1111
1112                 /* If the maximum selection jitter is less than the
1113                  * minimum peer jitter, then tossing out more survivors
1114                  * will not lower the minimum peer jitter, so we might
1115                  * as well stop.
1116                  */
1117                 if (max_selection_jitter < min_jitter) {
1118                         VERB3 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
1119                                         max_selection_jitter, min_jitter, num_survivors);
1120                         break;
1121                 }
1122
1123                 /* Delete survivor[max_idx] from the list
1124                  * and go around again.
1125                  */
1126                 VERB5 bb_error_msg("dropping survivor %d", max_idx);
1127                 num_survivors--;
1128                 while (max_idx < num_survivors) {
1129                         survivor[max_idx] = survivor[max_idx + 1];
1130                         max_idx++;
1131                 }
1132         }
1133
1134         if (0) {
1135                 /* Combine the offsets of the clustering algorithm survivors
1136                  * using a weighted average with weight determined by the root
1137                  * distance. Compute the selection jitter as the weighted RMS
1138                  * difference between the first survivor and the remaining
1139                  * survivors. In some cases the inherent clock jitter can be
1140                  * reduced by not using this algorithm, especially when frequent
1141                  * clockhopping is involved. bbox: thus we don't do it.
1142                  */
1143                 double x, y, z, w;
1144                 y = z = w = 0;
1145                 for (i = 0; i < num_survivors; i++) {
1146                         p = survivor[i].p;
1147                         x = root_distance(p);
1148                         y += 1 / x;
1149                         z += p->filter_offset / x;
1150                         w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1151                 }
1152                 //G.cluster_offset = z / y;
1153                 //G.cluster_jitter = SQRT(w / y);
1154         }
1155
1156         /* Pick the best clock. If the old system peer is on the list
1157          * and at the same stratum as the first survivor on the list,
1158          * then don't do a clock hop. Otherwise, select the first
1159          * survivor on the list as the new system peer.
1160          */
1161         p = survivor[0].p;
1162         if (G.last_update_peer
1163          && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1164         ) {
1165                 /* Starting from 1 is ok here */
1166                 for (i = 1; i < num_survivors; i++) {
1167                         if (G.last_update_peer == survivor[i].p) {
1168                                 VERB4 bb_error_msg("keeping old synced peer");
1169                                 p = G.last_update_peer;
1170                                 goto keep_old;
1171                         }
1172                 }
1173         }
1174         G.last_update_peer = p;
1175  keep_old:
1176         VERB3 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
1177                         p->p_dotted,
1178                         p->filter_offset,
1179                         G.cur_time - p->lastpkt_recv_time
1180         );
1181         return p;
1182 }
1183
1184
1185 /*
1186  * Local clock discipline and its helpers
1187  */
1188 static void
1189 set_new_values(int disc_state, double offset, double recv_time)
1190 {
1191         /* Enter new state and set state variables. Note we use the time
1192          * of the last clock filter sample, which must be earlier than
1193          * the current time.
1194          */
1195         VERB3 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
1196                         disc_state, offset, recv_time);
1197         G.discipline_state = disc_state;
1198         G.last_update_offset = offset;
1199         G.last_update_recv_time = recv_time;
1200 }
1201 /* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
1202 static NOINLINE int
1203 update_local_clock(peer_t *p)
1204 {
1205         int rc;
1206         struct timex tmx;
1207         /* Note: can use G.cluster_offset instead: */
1208         double offset = p->filter_offset;
1209         double recv_time = p->lastpkt_recv_time;
1210         double abs_offset;
1211 #if !USING_KERNEL_PLL_LOOP
1212         double freq_drift;
1213 #endif
1214         double since_last_update;
1215         double etemp, dtemp;
1216
1217         abs_offset = fabs(offset);
1218
1219 #if 0
1220         /* If needed, -S script can do it by looking at $offset
1221          * env var and killing parent */
1222         /* If the offset is too large, give up and go home */
1223         if (abs_offset > PANIC_THRESHOLD) {
1224                 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1225         }
1226 #endif
1227
1228         /* If this is an old update, for instance as the result
1229          * of a system peer change, avoid it. We never use
1230          * an old sample or the same sample twice.
1231          */
1232         if (recv_time <= G.last_update_recv_time) {
1233                 VERB3 bb_error_msg("same or older datapoint: %f >= %f, not using it",
1234                                 G.last_update_recv_time, recv_time);
1235                 return 0; /* "leave poll interval as is" */
1236         }
1237
1238         /* Clock state machine transition function. This is where the
1239          * action is and defines how the system reacts to large time
1240          * and frequency errors.
1241          */
1242         since_last_update = recv_time - G.reftime;
1243 #if !USING_KERNEL_PLL_LOOP
1244         freq_drift = 0;
1245 #endif
1246 #if USING_INITIAL_FREQ_ESTIMATION
1247         if (G.discipline_state == STATE_FREQ) {
1248                 /* Ignore updates until the stepout threshold */
1249                 if (since_last_update < WATCH_THRESHOLD) {
1250                         VERB3 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
1251                                         WATCH_THRESHOLD - since_last_update);
1252                         return 0; /* "leave poll interval as is" */
1253                 }
1254 # if !USING_KERNEL_PLL_LOOP
1255                 freq_drift = (offset - G.last_update_offset) / since_last_update;
1256 # endif
1257         }
1258 #endif
1259
1260         /* There are two main regimes: when the
1261          * offset exceeds the step threshold and when it does not.
1262          */
1263         if (abs_offset > STEP_THRESHOLD) {
1264                 switch (G.discipline_state) {
1265                 case STATE_SYNC:
1266                         /* The first outlyer: ignore it, switch to SPIK state */
1267                         VERB3 bb_error_msg("offset:%+f - spike detected", offset);
1268                         G.discipline_state = STATE_SPIK;
1269                         return -1; /* "decrease poll interval" */
1270
1271                 case STATE_SPIK:
1272                         /* Ignore succeeding outlyers until either an inlyer
1273                          * is found or the stepout threshold is exceeded.
1274                          */
1275                         if (since_last_update < WATCH_THRESHOLD) {
1276                                 VERB3 bb_error_msg("spike detected, datapoint ignored, %f sec remains",
1277                                                 WATCH_THRESHOLD - since_last_update);
1278                                 return -1; /* "decrease poll interval" */
1279                         }
1280                         /* fall through: we need to step */
1281                 } /* switch */
1282
1283                 /* Step the time and clamp down the poll interval.
1284                  *
1285                  * In NSET state an initial frequency correction is
1286                  * not available, usually because the frequency file has
1287                  * not yet been written. Since the time is outside the
1288                  * capture range, the clock is stepped. The frequency
1289                  * will be set directly following the stepout interval.
1290                  *
1291                  * In FSET state the initial frequency has been set
1292                  * from the frequency file. Since the time is outside
1293                  * the capture range, the clock is stepped immediately,
1294                  * rather than after the stepout interval. Guys get
1295                  * nervous if it takes 17 minutes to set the clock for
1296                  * the first time.
1297                  *
1298                  * In SPIK state the stepout threshold has expired and
1299                  * the phase is still above the step threshold. Note
1300                  * that a single spike greater than the step threshold
1301                  * is always suppressed, even at the longer poll
1302                  * intervals.
1303                  */
1304                 VERB3 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
1305                 step_time(offset);
1306                 if (option_mask32 & OPT_q) {
1307                         /* We were only asked to set time once. Done. */
1308                         exit(0);
1309                 }
1310
1311                 G.polladj_count = 0;
1312                 G.poll_exp = MINPOLL;
1313                 G.stratum = MAXSTRAT;
1314
1315                 run_script("step", offset);
1316
1317 #if USING_INITIAL_FREQ_ESTIMATION
1318                 if (G.discipline_state == STATE_NSET) {
1319                         set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1320                         return 1; /* "ok to increase poll interval" */
1321                 }
1322 #endif
1323                 set_new_values(STATE_SYNC, /*offset:*/ 0, recv_time);
1324
1325         } else { /* abs_offset <= STEP_THRESHOLD */
1326
1327                 if (G.poll_exp < MINPOLL && G.initial_poll_complete) {
1328                         VERB3 bb_error_msg("small offset:%+f, disabling burst mode", offset);
1329                         G.polladj_count = 0;
1330                         G.poll_exp = MINPOLL;
1331                 }
1332
1333                 /* Compute the clock jitter as the RMS of exponentially
1334                  * weighted offset differences. Used by the poll adjust code.
1335                  */
1336                 etemp = SQUARE(G.discipline_jitter);
1337                 dtemp = SQUARE(MAXD(fabs(offset - G.last_update_offset), G_precision_sec));
1338                 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
1339                 VERB3 bb_error_msg("discipline jitter=%f", G.discipline_jitter);
1340
1341                 switch (G.discipline_state) {
1342                 case STATE_NSET:
1343                         if (option_mask32 & OPT_q) {
1344                                 /* We were only asked to set time once.
1345                                  * The clock is precise enough, no need to step.
1346                                  */
1347                                 exit(0);
1348                         }
1349 #if USING_INITIAL_FREQ_ESTIMATION
1350                         /* This is the first update received and the frequency
1351                          * has not been initialized. The first thing to do
1352                          * is directly measure the oscillator frequency.
1353                          */
1354                         set_new_values(STATE_FREQ, offset, recv_time);
1355 #else
1356                         set_new_values(STATE_SYNC, offset, recv_time);
1357 #endif
1358                         VERB3 bb_error_msg("transitioning to FREQ, datapoint ignored");
1359                         return 0; /* "leave poll interval as is" */
1360
1361 #if 0 /* this is dead code for now */
1362                 case STATE_FSET:
1363                         /* This is the first update and the frequency
1364                          * has been initialized. Adjust the phase, but
1365                          * don't adjust the frequency until the next update.
1366                          */
1367                         set_new_values(STATE_SYNC, offset, recv_time);
1368                         /* freq_drift remains 0 */
1369                         break;
1370 #endif
1371
1372 #if USING_INITIAL_FREQ_ESTIMATION
1373                 case STATE_FREQ:
1374                         /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1375                          * Correct the phase and frequency and switch to SYNC state.
1376                          * freq_drift was already estimated (see code above)
1377                          */
1378                         set_new_values(STATE_SYNC, offset, recv_time);
1379                         break;
1380 #endif
1381
1382                 default:
1383 #if !USING_KERNEL_PLL_LOOP
1384                         /* Compute freq_drift due to PLL and FLL contributions.
1385                          *
1386                          * The FLL and PLL frequency gain constants
1387                          * depend on the poll interval and Allan
1388                          * intercept. The FLL is not used below one-half
1389                          * the Allan intercept. Above that the loop gain
1390                          * increases in steps to 1 / AVG.
1391                          */
1392                         if ((1 << G.poll_exp) > ALLAN / 2) {
1393                                 etemp = FLL - G.poll_exp;
1394                                 if (etemp < AVG)
1395                                         etemp = AVG;
1396                                 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1397                         }
1398                         /* For the PLL the integration interval
1399                          * (numerator) is the minimum of the update
1400                          * interval and poll interval. This allows
1401                          * oversampling, but not undersampling.
1402                          */
1403                         etemp = MIND(since_last_update, (1 << G.poll_exp));
1404                         dtemp = (4 * PLL) << G.poll_exp;
1405                         freq_drift += offset * etemp / SQUARE(dtemp);
1406 #endif
1407                         set_new_values(STATE_SYNC, offset, recv_time);
1408                         break;
1409                 }
1410                 if (G.stratum != p->lastpkt_stratum + 1) {
1411                         G.stratum = p->lastpkt_stratum + 1;
1412                         run_script("stratum", offset);
1413                 }
1414         }
1415
1416         G.reftime = G.cur_time;
1417         G.ntp_status = p->lastpkt_status;
1418         G.refid = p->lastpkt_refid;
1419         G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
1420         dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
1421         dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
1422         G.rootdisp = p->lastpkt_rootdisp + dtemp;
1423         VERB3 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
1424
1425         /* We are in STATE_SYNC now, but did not do adjtimex yet.
1426          * (Any other state does not reach this, they all return earlier)
1427          * By this time, freq_drift and G.last_update_offset are set
1428          * to values suitable for adjtimex.
1429          */
1430 #if !USING_KERNEL_PLL_LOOP
1431         /* Calculate the new frequency drift and frequency stability (wander).
1432          * Compute the clock wander as the RMS of exponentially weighted
1433          * frequency differences. This is not used directly, but can,
1434          * along with the jitter, be a highly useful monitoring and
1435          * debugging tool.
1436          */
1437         dtemp = G.discipline_freq_drift + freq_drift;
1438         G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
1439         etemp = SQUARE(G.discipline_wander);
1440         dtemp = SQUARE(dtemp);
1441         G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1442
1443         VERB3 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
1444                         G.discipline_freq_drift,
1445                         (long)(G.discipline_freq_drift * 65536e6),
1446                         freq_drift,
1447                         G.discipline_wander);
1448 #endif
1449         VERB3 {
1450                 memset(&tmx, 0, sizeof(tmx));
1451                 if (adjtimex(&tmx) < 0)
1452                         bb_perror_msg_and_die("adjtimex");
1453                 VERB3 bb_error_msg("p adjtimex freq:%ld offset:%+ld constant:%ld status:0x%x",
1454                                 tmx.freq, tmx.offset, tmx.constant, tmx.status);
1455         }
1456
1457         memset(&tmx, 0, sizeof(tmx));
1458 #if 0
1459 //doesn't work, offset remains 0 (!) in kernel:
1460 //ntpd:  set adjtimex freq:1786097 tmx.offset:77487
1461 //ntpd: prev adjtimex freq:1786097 tmx.offset:0
1462 //ntpd:  cur adjtimex freq:1786097 tmx.offset:0
1463         tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1464         /* 65536 is one ppm */
1465         tmx.freq = G.discipline_freq_drift * 65536e6;
1466         tmx.offset = G.last_update_offset * 1000000; /* usec */
1467 #endif
1468         tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
1469         tmx.offset = (G.last_update_offset * 1000000); /* usec */
1470                         /* + (G.last_update_offset < 0 ? -0.5 : 0.5) - too small to bother */
1471         tmx.status = STA_PLL;
1472         if (G.ntp_status & LI_PLUSSEC)
1473                 tmx.status |= STA_INS;
1474         if (G.ntp_status & LI_MINUSSEC)
1475                 tmx.status |= STA_DEL;
1476         tmx.constant = G.poll_exp - 4;
1477         //tmx.esterror = (u_int32)(clock_jitter * 1e6);
1478         //tmx.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
1479         rc = adjtimex(&tmx);
1480         if (rc < 0)
1481                 bb_perror_msg_and_die("adjtimex");
1482         /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1483          * Not sure why. Perhaps it is normal.
1484          */
1485         VERB3 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld constant:%ld status:0x%x",
1486                                 rc, tmx.freq, tmx.offset, tmx.constant, tmx.status);
1487 #if 0
1488         VERB3 {
1489                 /* always gives the same output as above msg */
1490                 memset(&tmx, 0, sizeof(tmx));
1491                 if (adjtimex(&tmx) < 0)
1492                         bb_perror_msg_and_die("adjtimex");
1493                 VERB3 bb_error_msg("c adjtimex freq:%ld offset:%+ld constant:%ld status:0x%x",
1494                                 tmx.freq, tmx.offset, tmx.constant, tmx.status);
1495         }
1496 #endif
1497         G.kernel_freq_drift = tmx.freq / 65536;
1498         VERB2 bb_error_msg("update peer:%s, offset:%+f, clock drift:%+ld ppm",
1499                         p->p_dotted, G.last_update_offset, G.kernel_freq_drift);
1500
1501         return 1; /* "ok to increase poll interval" */
1502 }
1503
1504
1505 /*
1506  * We've got a new reply packet from a peer, process it
1507  * (helpers first)
1508  */
1509 static unsigned
1510 retry_interval(void)
1511 {
1512         /* Local problem, want to retry soon */
1513         unsigned interval, r;
1514         interval = RETRY_INTERVAL;
1515         r = random();
1516         interval += r % (unsigned)(RETRY_INTERVAL / 4);
1517         VERB3 bb_error_msg("chose retry interval:%u", interval);
1518         return interval;
1519 }
1520 static unsigned
1521 poll_interval(int exponent)
1522 {
1523         unsigned interval, r;
1524         exponent = G.poll_exp + exponent;
1525         if (exponent < 0)
1526                 exponent = 0;
1527         interval = 1 << exponent;
1528         r = random();
1529         interval += ((r & (interval-1)) >> 4) + ((r >> 8) & 1); /* + 1/16 of interval, max */
1530         VERB3 bb_error_msg("chose poll interval:%u (poll_exp:%d exp:%d)", interval, G.poll_exp, exponent);
1531         return interval;
1532 }
1533 static NOINLINE void
1534 recv_and_process_peer_pkt(peer_t *p)
1535 {
1536         int         rc;
1537         ssize_t     size;
1538         msg_t       msg;
1539         double      T1, T2, T3, T4;
1540         unsigned    interval;
1541         datapoint_t *datapoint;
1542         peer_t      *q;
1543
1544         /* We can recvfrom here and check from.IP, but some multihomed
1545          * ntp servers reply from their *other IP*.
1546          * TODO: maybe we should check at least what we can: from.port == 123?
1547          */
1548         size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
1549         if (size == -1) {
1550                 bb_perror_msg("recv(%s) error", p->p_dotted);
1551                 if (errno == EHOSTUNREACH || errno == EHOSTDOWN
1552                  || errno == ENETUNREACH || errno == ENETDOWN
1553                  || errno == ECONNREFUSED || errno == EADDRNOTAVAIL
1554                  || errno == EAGAIN
1555                 ) {
1556 //TODO: always do this?
1557                         interval = retry_interval();
1558                         goto set_next_and_close_sock;
1559                 }
1560                 xfunc_die();
1561         }
1562
1563         if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1564                 bb_error_msg("malformed packet received from %s", p->p_dotted);
1565                 goto bail;
1566         }
1567
1568         if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1569          || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1570         ) {
1571                 goto bail;
1572         }
1573
1574         if ((msg.m_status & LI_ALARM) == LI_ALARM
1575          || msg.m_stratum == 0
1576          || msg.m_stratum > NTP_MAXSTRATUM
1577         ) {
1578 // TODO: stratum 0 responses may have commands in 32-bit m_refid field:
1579 // "DENY", "RSTR" - peer does not like us at all
1580 // "RATE" - peer is overloaded, reduce polling freq
1581                 interval = poll_interval(0);
1582                 bb_error_msg("reply from %s: not synced, next query in %us", p->p_dotted, interval);
1583                 goto set_next_and_close_sock;
1584         }
1585
1586 //      /* Verify valid root distance */
1587 //      if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1588 //              return;                 /* invalid header values */
1589
1590         p->lastpkt_status = msg.m_status;
1591         p->lastpkt_stratum = msg.m_stratum;
1592         p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1593         p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1594         p->lastpkt_refid = msg.m_refid;
1595
1596         /*
1597          * From RFC 2030 (with a correction to the delay math):
1598          *
1599          * Timestamp Name          ID   When Generated
1600          * ------------------------------------------------------------
1601          * Originate Timestamp     T1   time request sent by client
1602          * Receive Timestamp       T2   time request received by server
1603          * Transmit Timestamp      T3   time reply sent by server
1604          * Destination Timestamp   T4   time reply received by client
1605          *
1606          * The roundtrip delay and local clock offset are defined as
1607          *
1608          * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1609          */
1610         T1 = p->p_xmttime;
1611         T2 = lfp_to_d(msg.m_rectime);
1612         T3 = lfp_to_d(msg.m_xmttime);
1613         T4 = G.cur_time;
1614
1615         p->lastpkt_recv_time = T4;
1616
1617         VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1618         p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1619         datapoint = &p->filter_datapoint[p->datapoint_idx];
1620         datapoint->d_recv_time = T4;
1621         datapoint->d_offset    = ((T2 - T1) + (T3 - T4)) / 2;
1622         /* The delay calculation is a special case. In cases where the
1623          * server and client clocks are running at different rates and
1624          * with very fast networks, the delay can appear negative. In
1625          * order to avoid violating the Principle of Least Astonishment,
1626          * the delay is clamped not less than the system precision.
1627          */
1628         p->lastpkt_delay = (T4 - T1) - (T3 - T2);
1629         if (p->lastpkt_delay < G_precision_sec)
1630                 p->lastpkt_delay = G_precision_sec;
1631         datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
1632         if (!p->reachable_bits) {
1633                 /* 1st datapoint ever - replicate offset in every element */
1634                 int i;
1635                 for (i = 1; i < NUM_DATAPOINTS; i++) {
1636                         p->filter_datapoint[i].d_offset = datapoint->d_offset;
1637                 }
1638         }
1639
1640         p->reachable_bits |= 1;
1641         if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
1642                 bb_error_msg("reply from %s: reach 0x%02x offset %+f delay %f status 0x%02x strat %d refid 0x%08x rootdelay %f",
1643                         p->p_dotted,
1644                         p->reachable_bits,
1645                         datapoint->d_offset,
1646                         p->lastpkt_delay,
1647                         p->lastpkt_status,
1648                         p->lastpkt_stratum,
1649                         p->lastpkt_refid,
1650                         p->lastpkt_rootdelay
1651                         /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1652                          * m_reftime, m_orgtime, m_rectime, m_xmttime
1653                          */
1654                 );
1655         }
1656
1657         /* Muck with statictics and update the clock */
1658         filter_datapoints(p);
1659         q = select_and_cluster();
1660         rc = -1;
1661         if (q) {
1662                 rc = 0;
1663                 if (!(option_mask32 & OPT_w)) {
1664                         rc = update_local_clock(q);
1665                         /* If drift is dangerously large, immediately
1666                          * drop poll interval one step down.
1667                          */
1668                         if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
1669                                 VERB3 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
1670                                 goto poll_down;
1671                         }
1672                 }
1673         }
1674         /* else: no peer selected, rc = -1: we want to poll more often */
1675
1676         if (rc != 0) {
1677                 /* Adjust the poll interval by comparing the current offset
1678                  * with the clock jitter. If the offset is less than
1679                  * the clock jitter times a constant, then the averaging interval
1680                  * is increased, otherwise it is decreased. A bit of hysteresis
1681                  * helps calm the dance. Works best using burst mode.
1682                  */
1683                 VERB4 if (rc > 0) {
1684                         bb_error_msg("offset:%+f POLLADJ_GATE*discipline_jitter:%f poll:%s",
1685                                 q->filter_offset, POLLADJ_GATE * G.discipline_jitter,
1686                                 fabs(q->filter_offset) < POLLADJ_GATE * G.discipline_jitter
1687                                         ? "grows" : "falls"
1688                         );
1689                 }
1690                 if (rc > 0 && fabs(q->filter_offset) < POLLADJ_GATE * G.discipline_jitter) {
1691                         /* was += G.poll_exp but it is a bit
1692                          * too optimistic for my taste at high poll_exp's */
1693                         G.polladj_count += MINPOLL;
1694                         if (G.polladj_count > POLLADJ_LIMIT) {
1695                                 G.polladj_count = 0;
1696                                 if (G.poll_exp < MAXPOLL) {
1697                                         G.poll_exp++;
1698                                         VERB3 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1699                                                         G.discipline_jitter, G.poll_exp);
1700                                 }
1701                         } else {
1702                                 VERB3 bb_error_msg("polladj: incr:%d", G.polladj_count);
1703                         }
1704                 } else {
1705                         G.polladj_count -= G.poll_exp * 2;
1706                         if (G.polladj_count < -POLLADJ_LIMIT || G.poll_exp >= BIGPOLL) {
1707  poll_down:
1708                                 G.polladj_count = 0;
1709                                 if (G.poll_exp > MINPOLL) {
1710                                         llist_t *item;
1711
1712                                         G.poll_exp--;
1713                                         /* Correct p->next_action_time in each peer
1714                                          * which waits for sending, so that they send earlier.
1715                                          * Old pp->next_action_time are on the order
1716                                          * of t + (1 << old_poll_exp) + small_random,
1717                                          * we simply need to subtract ~half of that.
1718                                          */
1719                                         for (item = G.ntp_peers; item != NULL; item = item->link) {
1720                                                 peer_t *pp = (peer_t *) item->data;
1721                                                 if (pp->p_fd < 0)
1722                                                         pp->next_action_time -= (1 << G.poll_exp);
1723                                         }
1724                                         VERB3 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1725                                                         G.discipline_jitter, G.poll_exp);
1726                                 }
1727                         } else {
1728                                 VERB3 bb_error_msg("polladj: decr:%d", G.polladj_count);
1729                         }
1730                 }
1731         }
1732
1733         /* Decide when to send new query for this peer */
1734         interval = poll_interval(0);
1735
1736  set_next_and_close_sock:
1737         set_next(p, interval);
1738         /* We do not expect any more packets from this peer for now.
1739          * Closing the socket informs kernel about it.
1740          * We open a new socket when we send a new query.
1741          */
1742         close(p->p_fd);
1743         p->p_fd = -1;
1744  bail:
1745         return;
1746 }
1747
1748 #if ENABLE_FEATURE_NTPD_SERVER
1749 static NOINLINE void
1750 recv_and_process_client_pkt(void /*int fd*/)
1751 {
1752         ssize_t          size;
1753         //uint8_t          version;
1754         len_and_sockaddr *to;
1755         struct sockaddr  *from;
1756         msg_t            msg;
1757         uint8_t          query_status;
1758         l_fixedpt_t      query_xmttime;
1759
1760         to = get_sock_lsa(G.listen_fd);
1761         from = xzalloc(to->len);
1762
1763         size = recv_from_to(G.listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
1764         if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1765                 char *addr;
1766                 if (size < 0) {
1767                         if (errno == EAGAIN)
1768                                 goto bail;
1769                         bb_perror_msg_and_die("recv");
1770                 }
1771                 addr = xmalloc_sockaddr2dotted_noport(from);
1772                 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1773                 free(addr);
1774                 goto bail;
1775         }
1776
1777         query_status = msg.m_status;
1778         query_xmttime = msg.m_xmttime;
1779
1780         /* Build a reply packet */
1781         memset(&msg, 0, sizeof(msg));
1782         msg.m_status = G.stratum < MAXSTRAT ? G.ntp_status : LI_ALARM;
1783         msg.m_status |= (query_status & VERSION_MASK);
1784         msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
1785                          MODE_SERVER : MODE_SYM_PAS;
1786         msg.m_stratum = G.stratum;
1787         msg.m_ppoll = G.poll_exp;
1788         msg.m_precision_exp = G_precision_exp;
1789         /* this time was obtained between poll() and recv() */
1790         msg.m_rectime = d_to_lfp(G.cur_time);
1791         msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
1792         if (G.peer_cnt == 0) {
1793                 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
1794                 G.reftime = G.cur_time;
1795         }
1796         msg.m_reftime = d_to_lfp(G.reftime);
1797         msg.m_orgtime = query_xmttime;
1798         msg.m_rootdelay = d_to_sfp(G.rootdelay);
1799 //simple code does not do this, fix simple code!
1800         msg.m_rootdisp = d_to_sfp(G.rootdisp);
1801         //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
1802         msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
1803
1804         /* We reply from the local address packet was sent to,
1805          * this makes to/from look swapped here: */
1806         do_sendto(G.listen_fd,
1807                 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
1808                 &msg, size);
1809
1810  bail:
1811         free(to);
1812         free(from);
1813 }
1814 #endif
1815
1816 /* Upstream ntpd's options:
1817  *
1818  * -4   Force DNS resolution of host names to the IPv4 namespace.
1819  * -6   Force DNS resolution of host names to the IPv6 namespace.
1820  * -a   Require cryptographic authentication for broadcast client,
1821  *      multicast client and symmetric passive associations.
1822  *      This is the default.
1823  * -A   Do not require cryptographic authentication for broadcast client,
1824  *      multicast client and symmetric passive associations.
1825  *      This is almost never a good idea.
1826  * -b   Enable the client to synchronize to broadcast servers.
1827  * -c conffile
1828  *      Specify the name and path of the configuration file,
1829  *      default /etc/ntp.conf
1830  * -d   Specify debugging mode. This option may occur more than once,
1831  *      with each occurrence indicating greater detail of display.
1832  * -D level
1833  *      Specify debugging level directly.
1834  * -f driftfile
1835  *      Specify the name and path of the frequency file.
1836  *      This is the same operation as the "driftfile FILE"
1837  *      configuration command.
1838  * -g   Normally, ntpd exits with a message to the system log
1839  *      if the offset exceeds the panic threshold, which is 1000 s
1840  *      by default. This option allows the time to be set to any value
1841  *      without restriction; however, this can happen only once.
1842  *      If the threshold is exceeded after that, ntpd will exit
1843  *      with a message to the system log. This option can be used
1844  *      with the -q and -x options. See the tinker command for other options.
1845  * -i jaildir
1846  *      Chroot the server to the directory jaildir. This option also implies
1847  *      that the server attempts to drop root privileges at startup
1848  *      (otherwise, chroot gives very little additional security).
1849  *      You may need to also specify a -u option.
1850  * -k keyfile
1851  *      Specify the name and path of the symmetric key file,
1852  *      default /etc/ntp/keys. This is the same operation
1853  *      as the "keys FILE" configuration command.
1854  * -l logfile
1855  *      Specify the name and path of the log file. The default
1856  *      is the system log file. This is the same operation as
1857  *      the "logfile FILE" configuration command.
1858  * -L   Do not listen to virtual IPs. The default is to listen.
1859  * -n   Don't fork.
1860  * -N   To the extent permitted by the operating system,
1861  *      run the ntpd at the highest priority.
1862  * -p pidfile
1863  *      Specify the name and path of the file used to record the ntpd
1864  *      process ID. This is the same operation as the "pidfile FILE"
1865  *      configuration command.
1866  * -P priority
1867  *      To the extent permitted by the operating system,
1868  *      run the ntpd at the specified priority.
1869  * -q   Exit the ntpd just after the first time the clock is set.
1870  *      This behavior mimics that of the ntpdate program, which is
1871  *      to be retired. The -g and -x options can be used with this option.
1872  *      Note: The kernel time discipline is disabled with this option.
1873  * -r broadcastdelay
1874  *      Specify the default propagation delay from the broadcast/multicast
1875  *      server to this client. This is necessary only if the delay
1876  *      cannot be computed automatically by the protocol.
1877  * -s statsdir
1878  *      Specify the directory path for files created by the statistics
1879  *      facility. This is the same operation as the "statsdir DIR"
1880  *      configuration command.
1881  * -t key
1882  *      Add a key number to the trusted key list. This option can occur
1883  *      more than once.
1884  * -u user[:group]
1885  *      Specify a user, and optionally a group, to switch to.
1886  * -v variable
1887  * -V variable
1888  *      Add a system variable listed by default.
1889  * -x   Normally, the time is slewed if the offset is less than the step
1890  *      threshold, which is 128 ms by default, and stepped if above
1891  *      the threshold. This option sets the threshold to 600 s, which is
1892  *      well within the accuracy window to set the clock manually.
1893  *      Note: since the slew rate of typical Unix kernels is limited
1894  *      to 0.5 ms/s, each second of adjustment requires an amortization
1895  *      interval of 2000 s. Thus, an adjustment as much as 600 s
1896  *      will take almost 14 days to complete. This option can be used
1897  *      with the -g and -q options. See the tinker command for other options.
1898  *      Note: The kernel time discipline is disabled with this option.
1899  */
1900
1901 /* By doing init in a separate function we decrease stack usage
1902  * in main loop.
1903  */
1904 static NOINLINE void ntp_init(char **argv)
1905 {
1906         unsigned opts;
1907         llist_t *peers;
1908
1909         srandom(getpid());
1910
1911         if (getuid())
1912                 bb_error_msg_and_die(bb_msg_you_must_be_root);
1913
1914         /* Set some globals */
1915         G.stratum = MAXSTRAT;
1916         if (BURSTPOLL != 0)
1917                 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
1918         G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
1919
1920         /* Parse options */
1921         peers = NULL;
1922         opt_complementary = "dd:p::wn"; /* d: counter; p: list; -w implies -n */
1923         opts = getopt32(argv,
1924                         "nqNx" /* compat */
1925                         "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
1926                         "d" /* compat */
1927                         "46aAbgL", /* compat, ignored */
1928                         &peers, &G.script_name, &G.verbose);
1929         if (!(opts & (OPT_p|OPT_l)))
1930                 bb_show_usage();
1931 //      if (opts & OPT_x) /* disable stepping, only slew is allowed */
1932 //              G.time_was_stepped = 1;
1933         if (peers) {
1934                 while (peers)
1935                         add_peers(llist_pop(&peers));
1936         } else {
1937                 /* -l but no peers: "stratum 1 server" mode */
1938                 G.stratum = 1;
1939         }
1940         if (!(opts & OPT_n)) {
1941                 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
1942                 logmode = LOGMODE_NONE;
1943         }
1944 #if ENABLE_FEATURE_NTPD_SERVER
1945         G.listen_fd = -1;
1946         if (opts & OPT_l) {
1947                 G.listen_fd = create_and_bind_dgram_or_die(NULL, 123);
1948                 socket_want_pktinfo(G.listen_fd);
1949                 setsockopt(G.listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
1950         }
1951 #endif
1952         /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
1953         if (opts & OPT_N)
1954                 setpriority(PRIO_PROCESS, 0, -15);
1955
1956         /* If network is up, syncronization occurs in ~10 seconds.
1957          * We give "ntpd -q" 10 seconds to get first reply,
1958          * then another 50 seconds to finish syncing.
1959          *
1960          * I tested ntpd 4.2.6p1 and apparently it never exits
1961          * (will try forever), but it does not feel right.
1962          * The goal of -q is to act like ntpdate: set time
1963          * after a reasonably small period of polling, or fail.
1964          */
1965         if (opts & OPT_q) {
1966                 option_mask32 |= OPT_qq;
1967                 alarm(10);
1968         }
1969
1970         bb_signals(0
1971                 | (1 << SIGTERM)
1972                 | (1 << SIGINT)
1973                 | (1 << SIGALRM)
1974                 , record_signo
1975         );
1976         bb_signals(0
1977                 | (1 << SIGPIPE)
1978                 | (1 << SIGCHLD)
1979                 , SIG_IGN
1980         );
1981 }
1982
1983 int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
1984 int ntpd_main(int argc UNUSED_PARAM, char **argv)
1985 {
1986 #undef G
1987         struct globals G;
1988         struct pollfd *pfd;
1989         peer_t **idx2peer;
1990         unsigned cnt;
1991
1992         memset(&G, 0, sizeof(G));
1993         SET_PTR_TO_GLOBALS(&G);
1994
1995         ntp_init(argv);
1996
1997         /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
1998         cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
1999         idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2000         pfd = xzalloc(sizeof(pfd[0]) * cnt);
2001
2002         /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
2003          * packets to each peer.
2004          * NB: if some peer is not responding, we may end up sending
2005          * fewer packets to it and more to other peers.
2006          * NB2: sync usually happens using INITIAL_SAMPLES packets,
2007          * since last reply does not come back instantaneously.
2008          */
2009         cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
2010
2011         while (!bb_got_signal) {
2012                 llist_t *item;
2013                 unsigned i, j;
2014                 int nfds, timeout;
2015                 double nextaction;
2016
2017                 /* Nothing between here and poll() blocks for any significant time */
2018
2019                 nextaction = G.cur_time + 3600;
2020
2021                 i = 0;
2022 #if ENABLE_FEATURE_NTPD_SERVER
2023                 if (G.listen_fd != -1) {
2024                         pfd[0].fd = G.listen_fd;
2025                         pfd[0].events = POLLIN;
2026                         i++;
2027                 }
2028 #endif
2029                 /* Pass over peer list, send requests, time out on receives */
2030                 for (item = G.ntp_peers; item != NULL; item = item->link) {
2031                         peer_t *p = (peer_t *) item->data;
2032
2033                         if (p->next_action_time <= G.cur_time) {
2034                                 if (p->p_fd == -1) {
2035                                         /* Time to send new req */
2036                                         if (--cnt == 0) {
2037                                                 G.initial_poll_complete = 1;
2038                                         }
2039                                         send_query_to_peer(p);
2040                                 } else {
2041                                         /* Timed out waiting for reply */
2042                                         close(p->p_fd);
2043                                         p->p_fd = -1;
2044                                         timeout = poll_interval(-2); /* -2: try a bit sooner */
2045                                         bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
2046                                                         p->p_dotted, p->reachable_bits, timeout);
2047                                         set_next(p, timeout);
2048                                 }
2049                         }
2050
2051                         if (p->next_action_time < nextaction)
2052                                 nextaction = p->next_action_time;
2053
2054                         if (p->p_fd >= 0) {
2055                                 /* Wait for reply from this peer */
2056                                 pfd[i].fd = p->p_fd;
2057                                 pfd[i].events = POLLIN;
2058                                 idx2peer[i] = p;
2059                                 i++;
2060                         }
2061                 }
2062
2063                 timeout = nextaction - G.cur_time;
2064                 if (timeout < 0)
2065                         timeout = 0;
2066                 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
2067
2068                 /* Here we may block */
2069                 VERB2 bb_error_msg("poll %us, sockets:%u, poll interval:%us", timeout, i, 1 << G.poll_exp);
2070                 nfds = poll(pfd, i, timeout * 1000);
2071                 gettime1900d(); /* sets G.cur_time */
2072                 if (nfds <= 0) {
2073                         if (G.script_name && G.cur_time - G.last_script_run > 11*60) {
2074                                 /* Useful for updating battery-backed RTC and such */
2075                                 run_script("periodic", G.last_update_offset);
2076                                 gettime1900d(); /* sets G.cur_time */
2077                         }
2078                         continue;
2079                 }
2080
2081                 /* Process any received packets */
2082                 j = 0;
2083 #if ENABLE_FEATURE_NTPD_SERVER
2084                 if (G.listen_fd != -1) {
2085                         if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2086                                 nfds--;
2087                                 recv_and_process_client_pkt(/*G.listen_fd*/);
2088                                 gettime1900d(); /* sets G.cur_time */
2089                         }
2090                         j = 1;
2091                 }
2092 #endif
2093                 for (; nfds != 0 && j < i; j++) {
2094                         if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
2095                                 /*
2096                                  * At init, alarm was set to 10 sec.
2097                                  * Now we did get a reply.
2098                                  * Increase timeout to 50 seconds to finish syncing.
2099                                  */
2100                                 if (option_mask32 & OPT_qq) {
2101                                         option_mask32 &= ~OPT_qq;
2102                                         alarm(50);
2103                                 }
2104                                 nfds--;
2105                                 recv_and_process_peer_pkt(idx2peer[j]);
2106                                 gettime1900d(); /* sets G.cur_time */
2107                         }
2108                 }
2109         } /* while (!bb_got_signal) */
2110
2111         kill_myself_with_sig(bb_got_signal);
2112 }
2113
2114
2115
2116
2117
2118
2119 /*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2120
2121 /*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2122
2123 #if 0
2124 static double
2125 direct_freq(double fp_offset)
2126 {
2127 #ifdef KERNEL_PLL
2128         /*
2129          * If the kernel is enabled, we need the residual offset to
2130          * calculate the frequency correction.
2131          */
2132         if (pll_control && kern_enable) {
2133                 memset(&ntv, 0, sizeof(ntv));
2134                 ntp_adjtime(&ntv);
2135 #ifdef STA_NANO
2136                 clock_offset = ntv.offset / 1e9;
2137 #else /* STA_NANO */
2138                 clock_offset = ntv.offset / 1e6;
2139 #endif /* STA_NANO */
2140                 drift_comp = FREQTOD(ntv.freq);
2141         }
2142 #endif /* KERNEL_PLL */
2143         set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2144         wander_resid = 0;
2145         return drift_comp;
2146 }
2147
2148 static void
2149 set_freq(double freq) /* frequency update */
2150 {
2151         char tbuf[80];
2152
2153         drift_comp = freq;
2154
2155 #ifdef KERNEL_PLL
2156         /*
2157          * If the kernel is enabled, update the kernel frequency.
2158          */
2159         if (pll_control && kern_enable) {
2160                 memset(&ntv, 0, sizeof(ntv));
2161                 ntv.modes = MOD_FREQUENCY;
2162                 ntv.freq = DTOFREQ(drift_comp);
2163                 ntp_adjtime(&ntv);
2164                 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2165                 report_event(EVNT_FSET, NULL, tbuf);
2166         } else {
2167                 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2168                 report_event(EVNT_FSET, NULL, tbuf);
2169         }
2170 #else /* KERNEL_PLL */
2171         snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2172         report_event(EVNT_FSET, NULL, tbuf);
2173 #endif /* KERNEL_PLL */
2174 }
2175
2176 ...
2177 ...
2178 ...
2179
2180 #ifdef KERNEL_PLL
2181         /*
2182          * This code segment works when clock adjustments are made using
2183          * precision time kernel support and the ntp_adjtime() system
2184          * call. This support is available in Solaris 2.6 and later,
2185          * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2186          * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2187          * DECstation 5000/240 and Alpha AXP, additional kernel
2188          * modifications provide a true microsecond clock and nanosecond
2189          * clock, respectively.
2190          *
2191          * Important note: The kernel discipline is used only if the
2192          * step threshold is less than 0.5 s, as anything higher can
2193          * lead to overflow problems. This might occur if some misguided
2194          * lad set the step threshold to something ridiculous.
2195          */
2196         if (pll_control && kern_enable) {
2197
2198 #define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2199
2200                 /*
2201                  * We initialize the structure for the ntp_adjtime()
2202                  * system call. We have to convert everything to
2203                  * microseconds or nanoseconds first. Do not update the
2204                  * system variables if the ext_enable flag is set. In
2205                  * this case, the external clock driver will update the
2206                  * variables, which will be read later by the local
2207                  * clock driver. Afterwards, remember the time and
2208                  * frequency offsets for jitter and stability values and
2209                  * to update the frequency file.
2210                  */
2211                 memset(&ntv,  0, sizeof(ntv));
2212                 if (ext_enable) {
2213                         ntv.modes = MOD_STATUS;
2214                 } else {
2215 #ifdef STA_NANO
2216                         ntv.modes = MOD_BITS | MOD_NANO;
2217 #else /* STA_NANO */
2218                         ntv.modes = MOD_BITS;
2219 #endif /* STA_NANO */
2220                         if (clock_offset < 0)
2221                                 dtemp = -.5;
2222                         else
2223                                 dtemp = .5;
2224 #ifdef STA_NANO
2225                         ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2226                         ntv.constant = sys_poll;
2227 #else /* STA_NANO */
2228                         ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2229                         ntv.constant = sys_poll - 4;
2230 #endif /* STA_NANO */
2231                         ntv.esterror = (u_int32)(clock_jitter * 1e6);
2232                         ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2233                         ntv.status = STA_PLL;
2234
2235                         /*
2236                          * Enable/disable the PPS if requested.
2237                          */
2238                         if (pps_enable) {
2239                                 if (!(pll_status & STA_PPSTIME))
2240                                         report_event(EVNT_KERN,
2241                                             NULL, "PPS enabled");
2242                                 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2243                         } else {
2244                                 if (pll_status & STA_PPSTIME)
2245                                         report_event(EVNT_KERN,
2246                                             NULL, "PPS disabled");
2247                                 ntv.status &= ~(STA_PPSTIME |
2248                                     STA_PPSFREQ);
2249                         }
2250                         if (sys_leap == LEAP_ADDSECOND)
2251                                 ntv.status |= STA_INS;
2252                         else if (sys_leap == LEAP_DELSECOND)
2253                                 ntv.status |= STA_DEL;
2254                 }
2255
2256                 /*
2257                  * Pass the stuff to the kernel. If it squeals, turn off
2258                  * the pps. In any case, fetch the kernel offset,
2259                  * frequency and jitter.
2260                  */
2261                 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2262                         if (!(ntv.status & STA_PPSSIGNAL))
2263                                 report_event(EVNT_KERN, NULL,
2264                                     "PPS no signal");
2265                 }
2266                 pll_status = ntv.status;
2267 #ifdef STA_NANO
2268                 clock_offset = ntv.offset / 1e9;
2269 #else /* STA_NANO */
2270                 clock_offset = ntv.offset / 1e6;
2271 #endif /* STA_NANO */
2272                 clock_frequency = FREQTOD(ntv.freq);
2273
2274                 /*
2275                  * If the kernel PPS is lit, monitor its performance.
2276                  */
2277                 if (ntv.status & STA_PPSTIME) {
2278 #ifdef STA_NANO
2279                         clock_jitter = ntv.jitter / 1e9;
2280 #else /* STA_NANO */
2281                         clock_jitter = ntv.jitter / 1e6;
2282 #endif /* STA_NANO */
2283                 }
2284
2285 #if defined(STA_NANO) && NTP_API == 4
2286                 /*
2287                  * If the TAI changes, update the kernel TAI.
2288                  */
2289                 if (loop_tai != sys_tai) {
2290                         loop_tai = sys_tai;
2291                         ntv.modes = MOD_TAI;
2292                         ntv.constant = sys_tai;
2293                         ntp_adjtime(&ntv);
2294                 }
2295 #endif /* STA_NANO */
2296         }
2297 #endif /* KERNEL_PLL */
2298 #endif