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