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