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