blob: 33cb1dcb18a58d81299d598453a4499fb358b4c2 [file] [log] [blame]
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001/*
2 * NTP client/server, based on OpenNTPD 3.9p1
3 *
Adam Tkac4bf88d92015-01-04 17:46:08 +01004 * Busybox port author: Adam Tkac (C) 2009 <vonsch@gmail.com>
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01005 *
Adam Tkac4bf88d92015-01-04 17:46:08 +01006 * 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 ***********************************************************************
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010024 *
25 * Parts of OpenNTPD clock syncronization code is replaced by
Adam Tkac4bf88d92015-01-04 17:46:08 +010026 * code which is based on ntp-4.2.6, which carries the following
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010027 * copyright notice:
28 *
Adam Tkac4bf88d92015-01-04 17:46:08 +010029 * 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.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010041 ***********************************************************************
42 */
Pere Orga5bc8c002011-04-11 03:29:49 +020043
44//usage:#define ntpd_trivial_usage
Denys Vlasenko278842d2014-07-15 15:06:54 +020045//usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l -I IFACE")"] [-S PROG] [-p PEER]..."
Pere Orga5bc8c002011-04-11 03:29:49 +020046//usage:#define ntpd_full_usage "\n\n"
47//usage: "NTP client/server\n"
Pere Orga5bc8c002011-04-11 03:29:49 +020048//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: IF_FEATURE_NTPD_SERVER(
54//usage: "\n -l Run as server on port 123"
Denys Vlasenko278842d2014-07-15 15:06:54 +020055//usage: "\n -I IFACE Bind server to IFACE, implies -l"
Pere Orga5bc8c002011-04-11 03:29:49 +020056//usage: )
57//usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins"
58//usage: "\n -p PEER Obtain time from PEER (may be repeated)"
Denys Vlasenko504fe452014-03-23 15:06:38 +010059//usage: IF_FEATURE_NTPD_CONF(
60//usage: "\n If -p is not given, read /etc/ntp.conf"
61//usage: )
62
63// -l and -p options are not compatible with "standard" ntpd:
64// it has them as "-l logfile" and "-p pidfile".
65// -S and -w are not compat either, "standard" ntpd has no such opts.
Pere Orga5bc8c002011-04-11 03:29:49 +020066
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010067#include "libbb.h"
68#include <math.h>
69#include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
Mike Frysingerc5fe9f72012-07-05 23:19:09 -040070#include <sys/resource.h> /* setpriority */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010071#include <sys/timex.h>
72#ifndef IPTOS_LOWDELAY
73# define IPTOS_LOWDELAY 0x10
74#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010075
76
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010077/* Verbosity control (max level of -dddd options accepted).
Denys Vlasenkoa14958c2013-12-04 16:32:09 +010078 * max 6 is very talkative (and bloated). 3 is non-bloated,
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010079 * production level setting.
80 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +010081#define MAX_VERBOSE 3
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010082
83
Denys Vlasenko65d722b2010-01-11 02:14:04 +010084/* High-level description of the algorithm:
85 *
86 * We start running with very small poll_exp, BURSTPOLL,
Leonid Lisovskiy894ef602010-10-20 22:36:51 +020087 * in order to quickly accumulate INITIAL_SAMPLES datapoints
Denys Vlasenko65d722b2010-01-11 02:14:04 +010088 * for each peer. Then, time is stepped if the offset is larger
89 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
90 * poll_exp to MINPOLL and enter frequency measurement step:
91 * we collect new datapoints but ignore them for WATCH_THRESHOLD
92 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
93 * offset and estimate frequency drift.
94 *
Denys Vlasenko5b9a9102010-01-17 01:05:58 +010095 * (frequency measurement step seems to not be strictly needed,
96 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
97 * define set to 0)
98 *
Denys Vlasenko65d722b2010-01-11 02:14:04 +010099 * After this, we enter "steady state": we collect a datapoint,
100 * we select the best peer, if this datapoint is not a new one
101 * (IOW: if this datapoint isn't for selected peer), sleep
102 * and collect another one; otherwise, use its offset to update
103 * frequency drift, if offset is somewhat large, reduce poll_exp,
104 * otherwise increase poll_exp.
105 *
106 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
107 * happen, we assume that something "bad" happened (computer
108 * was hibernated, someone set totally wrong date, etc),
109 * then the time is stepped, all datapoints are discarded,
110 * and we go back to steady state.
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100111 *
112 * Made some changes to speed up re-syncing after our clock goes bad
113 * (tested with suspending my laptop):
114 * - if largish offset (>= STEP_THRESHOLD * 8 == 1 sec) is seen
115 * from a peer, schedule next query for this peer soon
116 * without drastically lowering poll interval for everybody.
117 * This makes us collect enough data for step much faster:
118 * e.g. at poll = 10 (1024 secs), step was done within 5 minutes
119 * after first reply which indicated that our clock is 14 seconds off.
120 * - on step, do not discard d_dispersion data of the existing datapoints,
121 * do not clear reachable_bits. This prevents discarding first ~8
122 * datapoints after the step.
Denys Vlasenko65d722b2010-01-11 02:14:04 +0100123 */
124
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +0100125#define INITIAL_SAMPLES 4 /* how many samples do we want for init */
126#define BAD_DELAY_GROWTH 4 /* drop packet if its delay grew by more than this */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100127
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200128#define RETRY_INTERVAL 32 /* on send/recv error, retry in N secs (need to be power of 2) */
129#define NOREPLY_INTERVAL 512 /* sent, but got no reply: cap next query by this many seconds */
130#define RESPONSE_INTERVAL 16 /* wait for reply up to N secs */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100131
132/* Step threshold (sec). std ntpd uses 0.128.
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200133 * Using exact power of 2 (1/8) results in smaller code
134 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100135#define STEP_THRESHOLD 0.125
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200136/* Stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
137#define WATCH_THRESHOLD 128
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100138/* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100139//UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100140
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200141/*
142 * If we got |offset| > BIGOFF from a peer, cap next query interval
143 * for this peer by this many seconds:
144 */
145#define BIGOFF (STEP_THRESHOLD * 8)
146#define BIGOFF_INTERVAL (1 << 7) /* 128 s */
147
Denys Vlasenko12628b72010-01-11 01:31:59 +0100148#define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
Denys Vlasenkofb132e42010-10-29 11:46:52 +0200149#define BURSTPOLL 0 /* initial poll */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100150#define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200151/*
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200152 * If offset > discipline_jitter * POLLADJ_GATE, and poll interval is > 2^BIGPOLL,
153 * then it is decreased _at once_. (If <= 2^BIGPOLL, it will be decreased _eventually_).
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100154 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200155#define BIGPOLL 9 /* 2^9 sec ~= 8.5 min */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100156#define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200157/*
158 * Actively lower poll when we see such big offsets.
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100159 * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200160 * if offset increases over ~0.04 sec
161 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +0200162//#define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100163#define MINDISP 0.01 /* minimum dispersion (sec) */
164#define MAXDISP 16 /* maximum dispersion (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100165#define MAXSTRAT 16 /* maximum stratum (infinity metric) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100166#define MAXDIST 1 /* distance threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100167#define MIN_SELECTED 1 /* minimum intersection survivors */
168#define MIN_CLUSTERED 3 /* minimum cluster survivors */
169
170#define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100171
172/* Poll-adjust threshold.
173 * When we see that offset is small enough compared to discipline jitter,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100174 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
Denys Vlasenko61313112010-01-01 19:56:16 +0100175 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100176 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
177 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100178 */
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100179#define POLLADJ_LIMIT 40
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100180/* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100181 * poll interval (we think we can't improve timekeeping
182 * by staying at smaller poll).
183 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100184#define POLLADJ_GATE 4
Denys Vlasenko132b0442012-03-05 00:51:48 +0100185#define TIMECONST_HACK_GATE 2
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100186/* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100187#define ALLAN 512
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100188/* PLL loop gain */
Denys Vlasenko61313112010-01-01 19:56:16 +0100189#define PLL 65536
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100190/* FLL loop gain [why it depends on MAXPOLL??] */
Denys Vlasenko61313112010-01-01 19:56:16 +0100191#define FLL (MAXPOLL + 1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100192/* Parameter averaging constant */
Denys Vlasenko61313112010-01-01 19:56:16 +0100193#define AVG 4
194
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100195
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100196enum {
197 NTP_VERSION = 4,
198 NTP_MAXSTRATUM = 15,
199
200 NTP_DIGESTSIZE = 16,
201 NTP_MSGSIZE_NOAUTH = 48,
202 NTP_MSGSIZE = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
203
204 /* Status Masks */
205 MODE_MASK = (7 << 0),
206 VERSION_MASK = (7 << 3),
207 VERSION_SHIFT = 3,
208 LI_MASK = (3 << 6),
209
210 /* Leap Second Codes (high order two bits of m_status) */
211 LI_NOWARNING = (0 << 6), /* no warning */
212 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
213 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
214 LI_ALARM = (3 << 6), /* alarm condition */
215
216 /* Mode values */
217 MODE_RES0 = 0, /* reserved */
218 MODE_SYM_ACT = 1, /* symmetric active */
219 MODE_SYM_PAS = 2, /* symmetric passive */
220 MODE_CLIENT = 3, /* client */
221 MODE_SERVER = 4, /* server */
222 MODE_BROADCAST = 5, /* broadcast */
223 MODE_RES1 = 6, /* reserved for NTP control message */
224 MODE_RES2 = 7, /* reserved for private use */
225};
226
227//TODO: better base selection
228#define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
229
230#define NUM_DATAPOINTS 8
231
232typedef struct {
233 uint32_t int_partl;
234 uint32_t fractionl;
235} l_fixedpt_t;
236
237typedef struct {
238 uint16_t int_parts;
239 uint16_t fractions;
240} s_fixedpt_t;
241
242typedef struct {
243 uint8_t m_status; /* status of local clock and leap info */
244 uint8_t m_stratum;
245 uint8_t m_ppoll; /* poll value */
246 int8_t m_precision_exp;
247 s_fixedpt_t m_rootdelay;
248 s_fixedpt_t m_rootdisp;
249 uint32_t m_refid;
250 l_fixedpt_t m_reftime;
251 l_fixedpt_t m_orgtime;
252 l_fixedpt_t m_rectime;
253 l_fixedpt_t m_xmttime;
254 uint32_t m_keyid;
255 uint8_t m_digest[NTP_DIGESTSIZE];
256} msg_t;
257
258typedef struct {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100259 double d_offset;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100260 double d_recv_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100261 double d_dispersion;
262} datapoint_t;
263
264typedef struct {
265 len_and_sockaddr *p_lsa;
266 char *p_dotted;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100267 int p_fd;
268 int datapoint_idx;
269 uint32_t lastpkt_refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100270 uint8_t lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100271 uint8_t lastpkt_stratum;
Denys Vlasenko0b002812010-01-03 08:59:59 +0100272 uint8_t reachable_bits;
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200273 /* when to send new query (if p_fd == -1)
274 * or when receive times out (if p_fd >= 0): */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100275 double next_action_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100276 double p_xmttime;
Denys Vlasenkod531f932014-04-19 19:00:16 +0200277 double p_raw_delay;
278 /* p_raw_delay is set even by "high delay" packets */
279 /* lastpkt_delay isn't */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100280 double lastpkt_recv_time;
281 double lastpkt_delay;
282 double lastpkt_rootdelay;
283 double lastpkt_rootdisp;
284 /* produced by filter algorithm: */
285 double filter_offset;
286 double filter_dispersion;
287 double filter_jitter;
288 datapoint_t filter_datapoint[NUM_DATAPOINTS];
289 /* last sent packet: */
290 msg_t p_xmt_msg;
291} peer_t;
292
293
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100294#define USING_KERNEL_PLL_LOOP 1
295#define USING_INITIAL_FREQ_ESTIMATION 0
296
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100297enum {
298 OPT_n = (1 << 0),
299 OPT_q = (1 << 1),
300 OPT_N = (1 << 2),
301 OPT_x = (1 << 3),
302 /* Insert new options above this line. */
303 /* Non-compat options: */
Denys Vlasenko4168fdd2010-01-04 00:19:13 +0100304 OPT_w = (1 << 4),
305 OPT_p = (1 << 5),
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100306 OPT_S = (1 << 6),
307 OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko278842d2014-07-15 15:06:54 +0200308 OPT_I = (1 << 8) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko8e23faf2011-04-07 01:45:20 +0200309 /* We hijack some bits for other purposes */
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100310 OPT_qq = (1 << 31),
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100311};
312
313struct globals {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100314 double cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100315 /* total round trip delay to currently selected reference clock */
316 double rootdelay;
317 /* reference timestamp: time when the system clock was last set or corrected */
318 double reftime;
319 /* total dispersion to currently selected reference clock */
320 double rootdisp;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100321
322 double last_script_run;
323 char *script_name;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100324 llist_t *ntp_peers;
325#if ENABLE_FEATURE_NTPD_SERVER
326 int listen_fd;
Denys Vlasenko278842d2014-07-15 15:06:54 +0200327 char *if_name;
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +0200328# define G_listen_fd (G.listen_fd)
329#else
330# define G_listen_fd (-1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100331#endif
332 unsigned verbose;
333 unsigned peer_cnt;
334 /* refid: 32-bit code identifying the particular server or reference clock
Denys Vlasenko74584b82012-03-02 01:22:40 +0100335 * in stratum 0 packets this is a four-character ASCII string,
336 * called the kiss code, used for debugging and monitoring
337 * in stratum 1 packets this is a four-character ASCII string
338 * assigned to the reference clock by IANA. Example: "GPS "
339 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
340 * of MD5 hash of IPv6
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100341 */
342 uint32_t refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100343 uint8_t ntp_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100344 /* precision is defined as the larger of the resolution and time to
345 * read the clock, in log2 units. For instance, the precision of a
346 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
347 * system clock hardware representation is to the nanosecond.
348 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100349 * Delays, jitters of various kinds are clamped down to precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100350 *
351 * If precision_sec is too large, discipline_jitter gets clamped to it
Denys Vlasenko74584b82012-03-02 01:22:40 +0100352 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
353 * interval grows even though we really can benefit from staying at
354 * smaller one, collecting non-lagged datapoits and correcting offset.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100355 * (Lagged datapoits exist when poll_exp is large but we still have
356 * systematic offset error - the time distance between datapoints
Denys Vlasenko74584b82012-03-02 01:22:40 +0100357 * is significant and older datapoints have smaller offsets.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100358 * This makes our offset estimation a bit smaller than reality)
359 * Due to this effect, setting G_precision_sec close to
360 * STEP_THRESHOLD isn't such a good idea - offsets may grow
361 * too big and we will step. I observed it with -6.
362 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100363 * OTOH, setting precision_sec far too small would result in futile
364 * attempts to syncronize to an unachievable precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100365 *
366 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
Denys Vlasenko74584b82012-03-02 01:22:40 +0100367 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
368 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100369 */
Denys Vlasenko74584b82012-03-02 01:22:40 +0100370#define G_precision_exp -9
371 /*
372 * G_precision_exp is used only for construction outgoing packets.
373 * It's ok to set G_precision_sec to a slightly different value
374 * (One which is "nicer looking" in logs).
375 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
376 */
377#define G_precision_sec 0.002
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100378 uint8_t stratum;
379 /* Bool. After set to 1, never goes back to 0: */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100380 smallint initial_poll_complete;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100381
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100382#define STATE_NSET 0 /* initial state, "nothing is set" */
383//#define STATE_FSET 1 /* frequency set from file */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +0100384//#define STATE_SPIK 2 /* spike detected */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100385//#define STATE_FREQ 3 /* initial frequency */
386#define STATE_SYNC 4 /* clock synchronized (normal operation) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100387 uint8_t discipline_state; // doc calls it c.state
388 uint8_t poll_exp; // s.poll
389 int polladj_count; // c.count
Denys Vlasenko61313112010-01-01 19:56:16 +0100390 long kernel_freq_drift;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100391 peer_t *last_update_peer;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100392 double last_update_offset; // c.last
Denys Vlasenko61313112010-01-01 19:56:16 +0100393 double last_update_recv_time; // s.t
394 double discipline_jitter; // c.jitter
Denys Vlasenko547ee792012-03-05 10:18:00 +0100395 /* Since we only compare it with ints, can simplify code
396 * by not making this variable floating point:
397 */
398 unsigned offset_to_jitter_ratio;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100399 //double cluster_offset; // s.offset
400 //double cluster_jitter; // s.jitter
Denys Vlasenko61313112010-01-01 19:56:16 +0100401#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100402 double discipline_freq_drift; // c.freq
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100403 /* Maybe conditionally calculate wander? it's used only for logging */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100404 double discipline_wander; // c.wander
Denys Vlasenko61313112010-01-01 19:56:16 +0100405#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100406};
407#define G (*ptr_to_globals)
408
409static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
410
411
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100412#define VERB1 if (MAX_VERBOSE && G.verbose)
413#define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
414#define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
415#define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
416#define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100417#define VERB6 if (MAX_VERBOSE >= 6 && G.verbose >= 6)
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100418
419
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100420static double LOG2D(int a)
421{
422 if (a < 0)
423 return 1.0 / (1UL << -a);
424 return 1UL << a;
425}
426static ALWAYS_INLINE double SQUARE(double x)
427{
428 return x * x;
429}
430static ALWAYS_INLINE double MAXD(double a, double b)
431{
432 if (a > b)
433 return a;
434 return b;
435}
436static ALWAYS_INLINE double MIND(double a, double b)
437{
438 if (a < b)
439 return a;
440 return b;
441}
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100442static NOINLINE double my_SQRT(double X)
443{
444 union {
445 float f;
446 int32_t i;
447 } v;
448 double invsqrt;
449 double Xhalf = X * 0.5;
450
451 /* Fast and good approximation to 1/sqrt(X), black magic */
452 v.f = X;
453 /*v.i = 0x5f3759df - (v.i >> 1);*/
454 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
455 invsqrt = v.f; /* better than 0.2% accuracy */
456
457 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
458 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
459 * f'(x) = -2/(x*x*x)
460 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
461 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
462 */
463 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
464 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
465 /* With 4 iterations, more than half results will be exact,
466 * at 6th iterations result stabilizes with about 72% results exact.
467 * We are well satisfied with 0.05% accuracy.
468 */
469
470 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
471}
472static ALWAYS_INLINE double SQRT(double X)
473{
474 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
475 if (sizeof(float) != 4)
476 return sqrt(X);
477
Denys Vlasenko2d3253d2010-01-03 21:52:46 +0100478 /* This avoids needing libm, saves about 0.5k on x86-32 */
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100479 return my_SQRT(X);
480}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100481
482static double
483gettime1900d(void)
484{
485 struct timeval tv;
486 gettimeofday(&tv, NULL); /* never fails */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100487 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
488 return G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100489}
490
491static void
492d_to_tv(double d, struct timeval *tv)
493{
494 tv->tv_sec = (long)d;
495 tv->tv_usec = (d - tv->tv_sec) * 1000000;
496}
497
498static double
499lfp_to_d(l_fixedpt_t lfp)
500{
501 double ret;
502 lfp.int_partl = ntohl(lfp.int_partl);
503 lfp.fractionl = ntohl(lfp.fractionl);
504 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
505 return ret;
506}
507static double
508sfp_to_d(s_fixedpt_t sfp)
509{
510 double ret;
511 sfp.int_parts = ntohs(sfp.int_parts);
512 sfp.fractions = ntohs(sfp.fractions);
513 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
514 return ret;
515}
516#if ENABLE_FEATURE_NTPD_SERVER
517static l_fixedpt_t
518d_to_lfp(double d)
519{
520 l_fixedpt_t lfp;
521 lfp.int_partl = (uint32_t)d;
522 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
523 lfp.int_partl = htonl(lfp.int_partl);
524 lfp.fractionl = htonl(lfp.fractionl);
525 return lfp;
526}
527static s_fixedpt_t
528d_to_sfp(double d)
529{
530 s_fixedpt_t sfp;
531 sfp.int_parts = (uint16_t)d;
532 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
533 sfp.int_parts = htons(sfp.int_parts);
534 sfp.fractions = htons(sfp.fractions);
535 return sfp;
536}
537#endif
538
539static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100540dispersion(const datapoint_t *dp)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100541{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100542 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100543}
544
545static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100546root_distance(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100547{
548 /* The root synchronization distance is the maximum error due to
549 * all causes of the local clock relative to the primary server.
550 * It is defined as half the total delay plus total dispersion
551 * plus peer jitter.
552 */
553 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
554 + p->lastpkt_rootdisp
555 + p->filter_dispersion
Denys Vlasenko0b002812010-01-03 08:59:59 +0100556 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100557 + p->filter_jitter;
558}
559
560static void
561set_next(peer_t *p, unsigned t)
562{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100563 p->next_action_time = G.cur_time + t;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100564}
565
566/*
567 * Peer clock filter and its helpers
568 */
569static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100570filter_datapoints(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100571{
572 int i, idx;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100573 double sum, wavg;
574 datapoint_t *fdp;
575
576#if 0
577/* Simulations have shown that use of *averaged* offset for p->filter_offset
578 * is in fact worse than simply using last received one: with large poll intervals
579 * (>= 2048) averaging code uses offset values which are outdated by hours,
580 * and time/frequency correction goes totally wrong when fed essentially bogus offsets.
581 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100582 int got_newest;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100583 double minoff, maxoff, w;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100584 double x = x; /* for compiler */
585 double oldest_off = oldest_off;
586 double oldest_age = oldest_age;
587 double newest_off = newest_off;
588 double newest_age = newest_age;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100589
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100590 fdp = p->filter_datapoint;
591
592 minoff = maxoff = fdp[0].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100593 for (i = 1; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100594 if (minoff > fdp[i].d_offset)
595 minoff = fdp[i].d_offset;
596 if (maxoff < fdp[i].d_offset)
597 maxoff = fdp[i].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100598 }
599
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100600 idx = p->datapoint_idx; /* most recent datapoint's index */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100601 /* Average offset:
602 * Drop two outliers and take weighted average of the rest:
603 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
604 * we use older6/32, not older6/64 since sum of weights should be 1:
605 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
606 */
607 wavg = 0;
608 w = 0.5;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100609 /* n-1
610 * --- dispersion(i)
611 * filter_dispersion = \ -------------
612 * / (i+1)
613 * --- 2
614 * i=0
615 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100616 got_newest = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100617 sum = 0;
618 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100619 VERB5 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100620 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
621 i,
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100622 fdp[idx].d_offset,
623 fdp[idx].d_dispersion, dispersion(&fdp[idx]),
624 G.cur_time - fdp[idx].d_recv_time,
625 (minoff == fdp[idx].d_offset || maxoff == fdp[idx].d_offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100626 ? " (outlier by offset)" : ""
627 );
628 }
629
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100630 sum += dispersion(&fdp[idx]) / (2 << i);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100631
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100632 if (minoff == fdp[idx].d_offset) {
Denys Vlasenkoe4844b82010-01-01 21:59:49 +0100633 minoff -= 1; /* so that we don't match it ever again */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100634 } else
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100635 if (maxoff == fdp[idx].d_offset) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100636 maxoff += 1;
637 } else {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100638 oldest_off = fdp[idx].d_offset;
639 oldest_age = G.cur_time - fdp[idx].d_recv_time;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100640 if (!got_newest) {
641 got_newest = 1;
642 newest_off = oldest_off;
643 newest_age = oldest_age;
644 }
645 x = oldest_off * w;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100646 wavg += x;
647 w /= 2;
648 }
649
650 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
651 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100652 p->filter_dispersion = sum;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100653 wavg += x; /* add another older6/64 to form older6/32 */
654 /* Fix systematic underestimation with large poll intervals.
655 * Imagine that we still have a bit of uncorrected drift,
656 * and poll interval is big (say, 100 sec). Offsets form a progression:
657 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
658 * The algorithm above drops 0.0 and 0.7 as outliers,
659 * and then we have this estimation, ~25% off from 0.7:
660 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
661 */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100662 x = oldest_age - newest_age;
663 if (x != 0) {
664 x = newest_age / x; /* in above example, 100 / (600 - 100) */
665 if (x < 1) { /* paranoia check */
666 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
667 wavg += x;
668 }
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100669 }
670 p->filter_offset = wavg;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100671
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100672#else
673
674 fdp = p->filter_datapoint;
675 idx = p->datapoint_idx; /* most recent datapoint's index */
676
677 /* filter_offset: simply use the most recent value */
678 p->filter_offset = fdp[idx].d_offset;
679
680 /* n-1
681 * --- dispersion(i)
682 * filter_dispersion = \ -------------
683 * / (i+1)
684 * --- 2
685 * i=0
686 */
687 wavg = 0;
688 sum = 0;
689 for (i = 0; i < NUM_DATAPOINTS; i++) {
690 sum += dispersion(&fdp[idx]) / (2 << i);
691 wavg += fdp[idx].d_offset;
692 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
693 }
694 wavg /= NUM_DATAPOINTS;
695 p->filter_dispersion = sum;
696#endif
697
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100698 /* +----- -----+ ^ 1/2
699 * | n-1 |
700 * | --- |
701 * | 1 \ 2 |
702 * filter_jitter = | --- * / (avg-offset_j) |
703 * | n --- |
704 * | j=0 |
705 * +----- -----+
706 * where n is the number of valid datapoints in the filter (n > 1);
707 * if filter_jitter < precision then filter_jitter = precision
708 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100709 sum = 0;
710 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100711 sum += SQUARE(wavg - fdp[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100712 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100713 sum = SQRT(sum / NUM_DATAPOINTS);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100714 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
715
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100716 VERB4 bb_error_msg("filter offset:%+f disp:%f jitter:%f",
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100717 p->filter_offset,
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100718 p->filter_dispersion,
719 p->filter_jitter);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100720}
721
722static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100723reset_peer_stats(peer_t *p, double offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100724{
725 int i;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100726 bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
727
Denys Vlasenko777be102013-12-07 17:29:03 +0100728 /* Used to set p->filter_datapoint[i].d_dispersion = MAXDISP
729 * and clear reachable bits, but this proved to be too agressive:
730 * after step (tested with suspinding laptop for ~30 secs),
731 * this caused all previous data to be considered invalid,
732 * making us needing to collect full ~8 datapoins per peer
733 * after step in order to start trusting them.
734 * In turn, this was making poll interval decrease even after
735 * step was done. (Poll interval decreases already before step
736 * in this scenario, because we see large offsets and end up with
737 * no good peer to select).
738 */
739
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100740 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100741 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200742 p->filter_datapoint[i].d_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100743 if (p->filter_datapoint[i].d_offset != 0) {
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100744 p->filter_datapoint[i].d_offset -= offset;
745 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
746 // i,
747 // p->filter_datapoint[i].d_offset + offset,
748 // p->filter_datapoint[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100749 }
750 } else {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100751 p->filter_datapoint[i].d_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100752 p->filter_datapoint[i].d_offset = 0;
Denys Vlasenko777be102013-12-07 17:29:03 +0100753 /*p->filter_datapoint[i].d_dispersion = MAXDISP;*/
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100754 }
755 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100756 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200757 p->lastpkt_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100758 } else {
Denys Vlasenko777be102013-12-07 17:29:03 +0100759 /*p->reachable_bits = 0;*/
Denys Vlasenko0b002812010-01-03 08:59:59 +0100760 p->lastpkt_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100761 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100762 filter_datapoints(p); /* recalc p->filter_xxx */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +0100763 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100764}
765
766static void
Denys Vlasenko504fe452014-03-23 15:06:38 +0100767add_peers(const char *s)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100768{
769 peer_t *p;
770
771 p = xzalloc(sizeof(*p));
772 p->p_lsa = xhost2sockaddr(s, 123);
773 p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
774 p->p_fd = -1;
775 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100776 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
777 reset_peer_stats(p, 16 * STEP_THRESHOLD);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100778
779 llist_add_to(&G.ntp_peers, p);
780 G.peer_cnt++;
781}
782
783static int
784do_sendto(int fd,
785 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
786 msg_t *msg, ssize_t len)
787{
788 ssize_t ret;
789
790 errno = 0;
791 if (!from) {
792 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
793 } else {
794 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
795 }
796 if (ret != len) {
797 bb_perror_msg("send failed");
798 return -1;
799 }
800 return 0;
801}
802
Denys Vlasenko0b002812010-01-03 08:59:59 +0100803static void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100804send_query_to_peer(peer_t *p)
805{
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100806 /* Why do we need to bind()?
807 * See what happens when we don't bind:
808 *
809 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
810 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
811 * gettimeofday({1259071266, 327885}, NULL) = 0
812 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
813 * ^^^ we sent it from some source port picked by kernel.
814 * time(NULL) = 1259071266
815 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
816 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
817 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
818 * ^^^ this recv will receive packets to any local port!
819 *
820 * Uncomment this and use strace to see it in action:
821 */
822#define PROBE_LOCAL_ADDR /* { len_and_sockaddr lsa; lsa.len = LSA_SIZEOF_SA; getsockname(p->query.fd, &lsa.u.sa, &lsa.len); } */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100823
824 if (p->p_fd == -1) {
825 int fd, family;
826 len_and_sockaddr *local_lsa;
827
828 family = p->p_lsa->u.sa.sa_family;
829 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
830 /* local_lsa has "null" address and port 0 now.
831 * bind() ensures we have a *particular port* selected by kernel
832 * and remembered in p->p_fd, thus later recv(p->p_fd)
833 * receives only packets sent to this port.
834 */
835 PROBE_LOCAL_ADDR
836 xbind(fd, &local_lsa->u.sa, local_lsa->len);
837 PROBE_LOCAL_ADDR
838#if ENABLE_FEATURE_IPV6
839 if (family == AF_INET)
840#endif
841 setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
842 free(local_lsa);
843 }
844
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100845 /* Emit message _before_ attempted send. Think of a very short
846 * roundtrip networks: we need to go back to recv loop ASAP,
847 * to reduce delay. Printing messages after send works against that.
848 */
849 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
850
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100851 /*
852 * Send out a random 64-bit number as our transmit time. The NTP
853 * server will copy said number into the originate field on the
854 * response that it sends us. This is totally legal per the SNTP spec.
855 *
856 * The impact of this is two fold: we no longer send out the current
857 * system time for the world to see (which may aid an attacker), and
858 * it gives us a (not very secure) way of knowing that we're not
859 * getting spoofed by an attacker that can't capture our traffic
860 * but can spoof packets from the NTP server we're communicating with.
861 *
862 * Save the real transmit timestamp locally.
863 */
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +0100864 p->p_xmt_msg.m_xmttime.int_partl = rand();
865 p->p_xmt_msg.m_xmttime.fractionl = rand();
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100866 p->p_xmttime = gettime1900d();
867
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200868 /* Were doing it only if sendto worked, but
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +0200869 * loss of sync detection needs reachable_bits updated
870 * even if sending fails *locally*:
871 * "network is unreachable" because cable was pulled?
872 * We still need to declare "unsync" if this condition persists.
873 */
874 p->reachable_bits <<= 1;
875
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100876 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
877 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
878 ) {
879 close(p->p_fd);
880 p->p_fd = -1;
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200881 /*
882 * We know that we sent nothing.
883 * We can retry *soon* without fearing
884 * that we are flooding the peer.
885 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100886 set_next(p, RETRY_INTERVAL);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100887 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100888 }
889
Denys Vlasenko0b002812010-01-03 08:59:59 +0100890 set_next(p, RESPONSE_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100891}
892
893
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100894/* Note that there is no provision to prevent several run_scripts
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200895 * to be started in quick succession. In fact, it happens rather often
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100896 * if initial syncronization results in a step.
897 * You will see "step" and then "stratum" script runs, sometimes
898 * as close as only 0.002 seconds apart.
899 * Script should be ready to deal with this.
900 */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100901static void run_script(const char *action, double offset)
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100902{
903 char *argv[3];
Denys Vlasenko12628b72010-01-11 01:31:59 +0100904 char *env1, *env2, *env3, *env4;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100905
Denys Vlasenko07c59872013-05-22 18:18:51 +0200906 G.last_script_run = G.cur_time;
907
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100908 if (!G.script_name)
909 return;
910
911 argv[0] = (char*) G.script_name;
912 argv[1] = (char*) action;
913 argv[2] = NULL;
914
915 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
916
Denys Vlasenkoae473352010-01-07 11:51:13 +0100917 env1 = xasprintf("%s=%u", "stratum", G.stratum);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100918 putenv(env1);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100919 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100920 putenv(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100921 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
922 putenv(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100923 env4 = xasprintf("%s=%f", "offset", offset);
924 putenv(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100925 /* Other items of potential interest: selected peer,
Denys Vlasenkoae473352010-01-07 11:51:13 +0100926 * rootdelay, reftime, rootdisp, refid, ntp_status,
Denys Vlasenko12628b72010-01-11 01:31:59 +0100927 * last_update_offset, last_update_recv_time, discipline_jitter,
928 * how many peers have reachable_bits = 0?
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100929 */
930
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100931 /* Don't want to wait: it may run hwclock --systohc, and that
932 * may take some time (seconds): */
Denys Vlasenko8531d762010-03-18 22:44:00 +0100933 /*spawn_and_wait(argv);*/
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100934 spawn(argv);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100935
936 unsetenv("stratum");
937 unsetenv("freq_drift_ppm");
Denys Vlasenkoae473352010-01-07 11:51:13 +0100938 unsetenv("poll_interval");
Denys Vlasenko12628b72010-01-11 01:31:59 +0100939 unsetenv("offset");
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100940 free(env1);
941 free(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100942 free(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100943 free(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100944}
945
Denys Vlasenko0b002812010-01-03 08:59:59 +0100946static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100947step_time(double offset)
948{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100949 llist_t *item;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100950 double dtime;
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100951 struct timeval tvc, tvn;
952 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100953 time_t tval;
954
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100955 gettimeofday(&tvc, NULL); /* never fails */
956 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
957 d_to_tv(dtime, &tvn);
958 if (settimeofday(&tvn, NULL) == -1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100959 bb_perror_msg_and_die("settimeofday");
960
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100961 VERB2 {
962 tval = tvc.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100963 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100964 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
965 }
966 tval = tvn.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100967 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100968 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100969
970 /* Correct various fields which contain time-relative values: */
971
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200972 /* Globals: */
973 G.cur_time += offset;
974 G.last_update_recv_time += offset;
975 G.last_script_run += offset;
976
Denys Vlasenko0b002812010-01-03 08:59:59 +0100977 /* p->lastpkt_recv_time, p->next_action_time and such: */
978 for (item = G.ntp_peers; item != NULL; item = item->link) {
979 peer_t *pp = (peer_t *) item->data;
980 reset_peer_stats(pp, offset);
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100981 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200982 // offset, pp->next_action_time, pp->next_action_time + offset);
983 pp->next_action_time += offset;
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200984 if (pp->p_fd >= 0) {
985 /* We wait for reply from this peer too.
986 * But due to step we are doing, reply's data is no longer
987 * useful (in fact, it'll be bogus). Stop waiting for it.
988 */
989 close(pp->p_fd);
990 pp->p_fd = -1;
991 set_next(pp, RETRY_INTERVAL);
992 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100993 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100994}
995
Denys Vlasenkod3fe9602014-09-27 22:56:09 +0200996static void clamp_pollexp_and_set_MAXSTRAT(void)
997{
998 if (G.poll_exp < MINPOLL)
999 G.poll_exp = MINPOLL;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001000 if (G.poll_exp > BIGPOLL)
1001 G.poll_exp = BIGPOLL;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001002 G.polladj_count = 0;
1003 G.stratum = MAXSTRAT;
1004}
1005
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001006
1007/*
1008 * Selection and clustering, and their helpers
1009 */
1010typedef struct {
1011 peer_t *p;
1012 int type;
1013 double edge;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001014 double opt_rd; /* optimization */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001015} point_t;
1016static int
1017compare_point_edge(const void *aa, const void *bb)
1018{
1019 const point_t *a = aa;
1020 const point_t *b = bb;
1021 if (a->edge < b->edge) {
1022 return -1;
1023 }
1024 return (a->edge > b->edge);
1025}
1026typedef struct {
1027 peer_t *p;
1028 double metric;
1029} survivor_t;
1030static int
1031compare_survivor_metric(const void *aa, const void *bb)
1032{
1033 const survivor_t *a = aa;
1034 const survivor_t *b = bb;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001035 if (a->metric < b->metric) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001036 return -1;
Denys Vlasenko510f56a2010-01-03 12:00:26 +01001037 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001038 return (a->metric > b->metric);
1039}
1040static int
1041fit(peer_t *p, double rd)
1042{
Denys Vlasenko0b002812010-01-03 08:59:59 +01001043 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
1044 /* One or zero bits in reachable_bits */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001045 VERB4 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001046 return 0;
1047 }
Denys Vlasenkofb132e42010-10-29 11:46:52 +02001048#if 0 /* we filter out such packets earlier */
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001049 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001050 || p->lastpkt_stratum >= MAXSTRAT
1051 ) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001052 VERB4 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001053 return 0;
1054 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001055#endif
Denys Vlasenko0b002812010-01-03 08:59:59 +01001056 /* rd is root_distance(p) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001057 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001058 VERB4 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001059 return 0;
1060 }
1061//TODO
1062// /* Do we have a loop? */
1063// if (p->refid == p->dstaddr || p->refid == s.refid)
1064// return 0;
Denys Vlasenkob7c9fb22011-02-03 00:05:48 +01001065 return 1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001066}
1067static peer_t*
Denys Vlasenko0b002812010-01-03 08:59:59 +01001068select_and_cluster(void)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001069{
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001070 peer_t *p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001071 llist_t *item;
1072 int i, j;
1073 int size = 3 * G.peer_cnt;
1074 /* for selection algorithm */
1075 point_t point[size];
1076 unsigned num_points, num_candidates;
1077 double low, high;
1078 unsigned num_falsetickers;
1079 /* for cluster algorithm */
1080 survivor_t survivor[size];
1081 unsigned num_survivors;
1082
1083 /* Selection */
1084
1085 num_points = 0;
1086 item = G.ntp_peers;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001087 if (G.initial_poll_complete) while (item != NULL) {
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001088 double rd, offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001089
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001090 p = (peer_t *) item->data;
1091 rd = root_distance(p);
1092 offset = p->filter_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001093 if (!fit(p, rd)) {
1094 item = item->link;
1095 continue;
1096 }
1097
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001098 VERB5 bb_error_msg("interval: [%f %f %f] %s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001099 offset - rd,
1100 offset,
1101 offset + rd,
1102 p->p_dotted
1103 );
1104 point[num_points].p = p;
1105 point[num_points].type = -1;
1106 point[num_points].edge = offset - rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001107 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001108 num_points++;
1109 point[num_points].p = p;
1110 point[num_points].type = 0;
1111 point[num_points].edge = offset;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001112 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001113 num_points++;
1114 point[num_points].p = p;
1115 point[num_points].type = 1;
1116 point[num_points].edge = offset + rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001117 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001118 num_points++;
1119 item = item->link;
1120 }
1121 num_candidates = num_points / 3;
1122 if (num_candidates == 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001123 VERB3 bb_error_msg("no valid datapoints%s", ", no peer selected");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001124 return NULL;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001125 }
1126//TODO: sorting does not seem to be done in reference code
1127 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
1128
1129 /* Start with the assumption that there are no falsetickers.
1130 * Attempt to find a nonempty intersection interval containing
1131 * the midpoints of all truechimers.
1132 * If a nonempty interval cannot be found, increase the number
1133 * of assumed falsetickers by one and try again.
1134 * If a nonempty interval is found and the number of falsetickers
1135 * is less than the number of truechimers, a majority has been found
1136 * and the midpoint of each truechimer represents
1137 * the candidates available to the cluster algorithm.
1138 */
1139 num_falsetickers = 0;
1140 while (1) {
1141 int c;
1142 unsigned num_midpoints = 0;
1143
1144 low = 1 << 9;
1145 high = - (1 << 9);
1146 c = 0;
1147 for (i = 0; i < num_points; i++) {
1148 /* We want to do:
1149 * if (point[i].type == -1) c++;
1150 * if (point[i].type == 1) c--;
1151 * and it's simpler to do it this way:
1152 */
1153 c -= point[i].type;
1154 if (c >= num_candidates - num_falsetickers) {
1155 /* If it was c++ and it got big enough... */
1156 low = point[i].edge;
1157 break;
1158 }
1159 if (point[i].type == 0)
1160 num_midpoints++;
1161 }
1162 c = 0;
1163 for (i = num_points-1; i >= 0; i--) {
1164 c += point[i].type;
1165 if (c >= num_candidates - num_falsetickers) {
1166 high = point[i].edge;
1167 break;
1168 }
1169 if (point[i].type == 0)
1170 num_midpoints++;
1171 }
1172 /* If the number of midpoints is greater than the number
1173 * of allowed falsetickers, the intersection contains at
1174 * least one truechimer with no midpoint - bad.
1175 * Also, interval should be nonempty.
1176 */
1177 if (num_midpoints <= num_falsetickers && low < high)
1178 break;
1179 num_falsetickers++;
1180 if (num_falsetickers * 2 >= num_candidates) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001181 VERB3 bb_error_msg("falsetickers:%d, candidates:%d%s",
1182 num_falsetickers, num_candidates,
1183 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001184 return NULL;
1185 }
1186 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001187 VERB4 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001188 low, high, num_candidates, num_falsetickers);
1189
1190 /* Clustering */
1191
1192 /* Construct a list of survivors (p, metric)
1193 * from the chime list, where metric is dominated
1194 * first by stratum and then by root distance.
1195 * All other things being equal, this is the order of preference.
1196 */
1197 num_survivors = 0;
1198 for (i = 0; i < num_points; i++) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001199 if (point[i].edge < low || point[i].edge > high)
1200 continue;
1201 p = point[i].p;
1202 survivor[num_survivors].p = p;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001203 /* x.opt_rd == root_distance(p); */
1204 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001205 VERB5 bb_error_msg("survivor[%d] metric:%f peer:%s",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001206 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1207 num_survivors++;
1208 }
1209 /* There must be at least MIN_SELECTED survivors to satisfy the
1210 * correctness assertions. Ordinarily, the Byzantine criteria
1211 * require four survivors, but for the demonstration here, one
1212 * is acceptable.
1213 */
1214 if (num_survivors < MIN_SELECTED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001215 VERB3 bb_error_msg("survivors:%d%s",
1216 num_survivors,
1217 ", no peer selected");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001218 return NULL;
1219 }
1220
1221//looks like this is ONLY used by the fact that later we pick survivor[0].
1222//we can avoid sorting then, just find the minimum once!
1223 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1224
1225 /* For each association p in turn, calculate the selection
1226 * jitter p->sjitter as the square root of the sum of squares
1227 * (p->offset - q->offset) over all q associations. The idea is
1228 * to repeatedly discard the survivor with maximum selection
1229 * jitter until a termination condition is met.
1230 */
1231 while (1) {
1232 unsigned max_idx = max_idx;
1233 double max_selection_jitter = max_selection_jitter;
1234 double min_jitter = min_jitter;
1235
1236 if (num_survivors <= MIN_CLUSTERED) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001237 VERB4 bb_error_msg("num_survivors %d <= %d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001238 num_survivors, MIN_CLUSTERED);
1239 break;
1240 }
1241
1242 /* To make sure a few survivors are left
1243 * for the clustering algorithm to chew on,
1244 * we stop if the number of survivors
1245 * is less than or equal to MIN_CLUSTERED (3).
1246 */
1247 for (i = 0; i < num_survivors; i++) {
1248 double selection_jitter_sq;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001249
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001250 p = survivor[i].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001251 if (i == 0 || p->filter_jitter < min_jitter)
1252 min_jitter = p->filter_jitter;
1253
1254 selection_jitter_sq = 0;
1255 for (j = 0; j < num_survivors; j++) {
1256 peer_t *q = survivor[j].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001257 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1258 }
1259 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1260 max_selection_jitter = selection_jitter_sq;
1261 max_idx = i;
1262 }
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001263 VERB6 bb_error_msg("survivor %d selection_jitter^2:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001264 i, selection_jitter_sq);
1265 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001266 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001267 VERB5 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001268 max_idx, max_selection_jitter, min_jitter);
1269
1270 /* If the maximum selection jitter is less than the
1271 * minimum peer jitter, then tossing out more survivors
1272 * will not lower the minimum peer jitter, so we might
1273 * as well stop.
1274 */
1275 if (max_selection_jitter < min_jitter) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001276 VERB4 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001277 max_selection_jitter, min_jitter, num_survivors);
1278 break;
1279 }
1280
1281 /* Delete survivor[max_idx] from the list
1282 * and go around again.
1283 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001284 VERB6 bb_error_msg("dropping survivor %d", max_idx);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001285 num_survivors--;
1286 while (max_idx < num_survivors) {
1287 survivor[max_idx] = survivor[max_idx + 1];
1288 max_idx++;
1289 }
1290 }
1291
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001292 if (0) {
1293 /* Combine the offsets of the clustering algorithm survivors
1294 * using a weighted average with weight determined by the root
1295 * distance. Compute the selection jitter as the weighted RMS
1296 * difference between the first survivor and the remaining
1297 * survivors. In some cases the inherent clock jitter can be
1298 * reduced by not using this algorithm, especially when frequent
1299 * clockhopping is involved. bbox: thus we don't do it.
1300 */
1301 double x, y, z, w;
1302 y = z = w = 0;
1303 for (i = 0; i < num_survivors; i++) {
1304 p = survivor[i].p;
1305 x = root_distance(p);
1306 y += 1 / x;
1307 z += p->filter_offset / x;
1308 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1309 }
1310 //G.cluster_offset = z / y;
1311 //G.cluster_jitter = SQRT(w / y);
1312 }
1313
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001314 /* Pick the best clock. If the old system peer is on the list
1315 * and at the same stratum as the first survivor on the list,
1316 * then don't do a clock hop. Otherwise, select the first
1317 * survivor on the list as the new system peer.
1318 */
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001319 p = survivor[0].p;
1320 if (G.last_update_peer
1321 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1322 ) {
1323 /* Starting from 1 is ok here */
1324 for (i = 1; i < num_survivors; i++) {
1325 if (G.last_update_peer == survivor[i].p) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001326 VERB5 bb_error_msg("keeping old synced peer");
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001327 p = G.last_update_peer;
1328 goto keep_old;
1329 }
1330 }
1331 }
1332 G.last_update_peer = p;
1333 keep_old:
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001334 VERB4 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001335 p->p_dotted,
1336 p->filter_offset,
1337 G.cur_time - p->lastpkt_recv_time
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001338 );
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001339 return p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001340}
1341
1342
1343/*
1344 * Local clock discipline and its helpers
1345 */
1346static void
1347set_new_values(int disc_state, double offset, double recv_time)
1348{
1349 /* Enter new state and set state variables. Note we use the time
1350 * of the last clock filter sample, which must be earlier than
1351 * the current time.
1352 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001353 VERB4 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001354 disc_state, offset, recv_time);
1355 G.discipline_state = disc_state;
1356 G.last_update_offset = offset;
1357 G.last_update_recv_time = recv_time;
1358}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001359/* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001360static NOINLINE int
1361update_local_clock(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001362{
1363 int rc;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001364 struct timex tmx;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001365 /* Note: can use G.cluster_offset instead: */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001366 double offset = p->filter_offset;
1367 double recv_time = p->lastpkt_recv_time;
1368 double abs_offset;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001369#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001370 double freq_drift;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001371#endif
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001372#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001373 double since_last_update;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001374#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001375 double etemp, dtemp;
1376
1377 abs_offset = fabs(offset);
1378
Denys Vlasenko12628b72010-01-11 01:31:59 +01001379#if 0
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001380 /* If needed, -S script can do it by looking at $offset
1381 * env var and killing parent */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001382 /* If the offset is too large, give up and go home */
1383 if (abs_offset > PANIC_THRESHOLD) {
1384 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1385 }
Denys Vlasenko12628b72010-01-11 01:31:59 +01001386#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001387
1388 /* If this is an old update, for instance as the result
1389 * of a system peer change, avoid it. We never use
1390 * an old sample or the same sample twice.
1391 */
1392 if (recv_time <= G.last_update_recv_time) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001393 VERB3 bb_error_msg("update from %s: same or older datapoint, not using it",
1394 p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001395 return 0; /* "leave poll interval as is" */
1396 }
1397
1398 /* Clock state machine transition function. This is where the
1399 * action is and defines how the system reacts to large time
1400 * and frequency errors.
1401 */
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001402#if !USING_KERNEL_PLL_LOOP || USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001403 since_last_update = recv_time - G.reftime;
Bartosz Golaszewski76ad7482014-01-18 15:36:27 +01001404#endif
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001405#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001406 freq_drift = 0;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001407#endif
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001408#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001409 if (G.discipline_state == STATE_FREQ) {
1410 /* Ignore updates until the stepout threshold */
1411 if (since_last_update < WATCH_THRESHOLD) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001412 VERB4 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001413 WATCH_THRESHOLD - since_last_update);
1414 return 0; /* "leave poll interval as is" */
1415 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001416# if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001417 freq_drift = (offset - G.last_update_offset) / since_last_update;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001418# endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001419 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001420#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001421
1422 /* There are two main regimes: when the
1423 * offset exceeds the step threshold and when it does not.
1424 */
1425 if (abs_offset > STEP_THRESHOLD) {
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001426#if 0
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001427 double remains;
1428
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001429// This "spike state" seems to be useless, peer selection already drops
1430// occassional "bad" datapoints. If we are here, there were _many_
1431// large offsets. When a few first large offsets are seen,
1432// we end up in "no valid datapoints, no peer selected" state.
1433// Only when enough of them are seen (which means it's not a fluke),
1434// we end up here. Looks like _our_ clock is off.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001435 switch (G.discipline_state) {
1436 case STATE_SYNC:
1437 /* The first outlyer: ignore it, switch to SPIK state */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001438 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1439 p->p_dotted, offset,
1440 "");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001441 G.discipline_state = STATE_SPIK;
1442 return -1; /* "decrease poll interval" */
1443
1444 case STATE_SPIK:
1445 /* Ignore succeeding outlyers until either an inlyer
1446 * is found or the stepout threshold is exceeded.
1447 */
Denys Vlasenkocb1dc1d2013-12-04 13:19:04 +01001448 remains = WATCH_THRESHOLD - since_last_update;
1449 if (remains > 0) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001450 VERB3 bb_error_msg("update from %s: offset:%+f, spike%s",
1451 p->p_dotted, offset,
1452 ", datapoint ignored");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001453 return -1; /* "decrease poll interval" */
1454 }
1455 /* fall through: we need to step */
1456 } /* switch */
Denys Vlasenko6c46eed2013-12-04 17:12:11 +01001457#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001458
1459 /* Step the time and clamp down the poll interval.
1460 *
1461 * In NSET state an initial frequency correction is
1462 * not available, usually because the frequency file has
1463 * not yet been written. Since the time is outside the
1464 * capture range, the clock is stepped. The frequency
1465 * will be set directly following the stepout interval.
1466 *
1467 * In FSET state the initial frequency has been set
1468 * from the frequency file. Since the time is outside
1469 * the capture range, the clock is stepped immediately,
1470 * rather than after the stepout interval. Guys get
1471 * nervous if it takes 17 minutes to set the clock for
1472 * the first time.
1473 *
1474 * In SPIK state the stepout threshold has expired and
1475 * the phase is still above the step threshold. Note
1476 * that a single spike greater than the step threshold
1477 * is always suppressed, even at the longer poll
1478 * intervals.
1479 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001480 VERB4 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001481 step_time(offset);
1482 if (option_mask32 & OPT_q) {
1483 /* We were only asked to set time once. Done. */
1484 exit(0);
1485 }
1486
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001487 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001488
Denys Vlasenko12628b72010-01-11 01:31:59 +01001489 run_script("step", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001490
Denys Vlasenkocb761132014-01-08 17:17:52 +01001491 recv_time += offset;
1492
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001493#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001494 if (G.discipline_state == STATE_NSET) {
1495 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1496 return 1; /* "ok to increase poll interval" */
1497 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001498#endif
Denys Vlasenko547ee792012-03-05 10:18:00 +01001499 abs_offset = offset = 0;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001500 set_new_values(STATE_SYNC, offset, recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001501
1502 } else { /* abs_offset <= STEP_THRESHOLD */
1503
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001504 /* The ratio is calculated before jitter is updated to make
1505 * poll adjust code more sensitive to large offsets.
1506 */
1507 G.offset_to_jitter_ratio = abs_offset / G.discipline_jitter;
1508
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001509 /* Compute the clock jitter as the RMS of exponentially
1510 * weighted offset differences. Used by the poll adjust code.
1511 */
1512 etemp = SQUARE(G.discipline_jitter);
Denys Vlasenko74584b82012-03-02 01:22:40 +01001513 dtemp = SQUARE(offset - G.last_update_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001514 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
Miroslav Lichvar760d0352014-10-05 03:10:15 +02001515 if (G.discipline_jitter < G_precision_sec)
1516 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001517
1518 switch (G.discipline_state) {
1519 case STATE_NSET:
1520 if (option_mask32 & OPT_q) {
1521 /* We were only asked to set time once.
1522 * The clock is precise enough, no need to step.
1523 */
1524 exit(0);
1525 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001526#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001527 /* This is the first update received and the frequency
1528 * has not been initialized. The first thing to do
1529 * is directly measure the oscillator frequency.
1530 */
1531 set_new_values(STATE_FREQ, offset, recv_time);
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001532#else
1533 set_new_values(STATE_SYNC, offset, recv_time);
1534#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001535 VERB4 bb_error_msg("transitioning to FREQ, datapoint ignored");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001536 return 0; /* "leave poll interval as is" */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001537
1538#if 0 /* this is dead code for now */
1539 case STATE_FSET:
1540 /* This is the first update and the frequency
1541 * has been initialized. Adjust the phase, but
1542 * don't adjust the frequency until the next update.
1543 */
1544 set_new_values(STATE_SYNC, offset, recv_time);
1545 /* freq_drift remains 0 */
1546 break;
1547#endif
1548
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001549#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001550 case STATE_FREQ:
1551 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1552 * Correct the phase and frequency and switch to SYNC state.
1553 * freq_drift was already estimated (see code above)
1554 */
1555 set_new_values(STATE_SYNC, offset, recv_time);
1556 break;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001557#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001558
1559 default:
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001560#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001561 /* Compute freq_drift due to PLL and FLL contributions.
1562 *
1563 * The FLL and PLL frequency gain constants
1564 * depend on the poll interval and Allan
1565 * intercept. The FLL is not used below one-half
1566 * the Allan intercept. Above that the loop gain
1567 * increases in steps to 1 / AVG.
1568 */
1569 if ((1 << G.poll_exp) > ALLAN / 2) {
1570 etemp = FLL - G.poll_exp;
1571 if (etemp < AVG)
1572 etemp = AVG;
1573 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1574 }
1575 /* For the PLL the integration interval
1576 * (numerator) is the minimum of the update
1577 * interval and poll interval. This allows
1578 * oversampling, but not undersampling.
1579 */
1580 etemp = MIND(since_last_update, (1 << G.poll_exp));
1581 dtemp = (4 * PLL) << G.poll_exp;
1582 freq_drift += offset * etemp / SQUARE(dtemp);
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001583#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001584 set_new_values(STATE_SYNC, offset, recv_time);
1585 break;
1586 }
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001587 if (G.stratum != p->lastpkt_stratum + 1) {
1588 G.stratum = p->lastpkt_stratum + 1;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001589 run_script("stratum", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001590 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001591 }
1592
Denys Vlasenko0b002812010-01-03 08:59:59 +01001593 G.reftime = G.cur_time;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001594 G.ntp_status = p->lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001595 G.refid = p->lastpkt_refid;
1596 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001597 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
Denys Vlasenko0b002812010-01-03 08:59:59 +01001598 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001599 G.rootdisp = p->lastpkt_rootdisp + dtemp;
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001600 VERB4 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001601
1602 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1603 * (Any other state does not reach this, they all return earlier)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001604 * By this time, freq_drift and offset are set
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001605 * to values suitable for adjtimex.
Denys Vlasenko61313112010-01-01 19:56:16 +01001606 */
1607#if !USING_KERNEL_PLL_LOOP
1608 /* Calculate the new frequency drift and frequency stability (wander).
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001609 * Compute the clock wander as the RMS of exponentially weighted
1610 * frequency differences. This is not used directly, but can,
1611 * along with the jitter, be a highly useful monitoring and
1612 * debugging tool.
1613 */
1614 dtemp = G.discipline_freq_drift + freq_drift;
Denys Vlasenko61313112010-01-01 19:56:16 +01001615 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001616 etemp = SQUARE(G.discipline_wander);
1617 dtemp = SQUARE(dtemp);
1618 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1619
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001620 VERB4 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
Denys Vlasenko61313112010-01-01 19:56:16 +01001621 G.discipline_freq_drift,
1622 (long)(G.discipline_freq_drift * 65536e6),
1623 freq_drift,
1624 G.discipline_wander);
1625#endif
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001626 VERB4 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001627 memset(&tmx, 0, sizeof(tmx));
1628 if (adjtimex(&tmx) < 0)
1629 bb_perror_msg_and_die("adjtimex");
Denys Vlasenko8be49c32012-03-06 19:16:50 +01001630 bb_error_msg("p adjtimex freq:%ld offset:%+ld status:0x%x tc:%ld",
1631 tmx.freq, tmx.offset, tmx.status, tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001632 }
1633
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001634 memset(&tmx, 0, sizeof(tmx));
1635#if 0
Denys Vlasenko61313112010-01-01 19:56:16 +01001636//doesn't work, offset remains 0 (!) in kernel:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001637//ntpd: set adjtimex freq:1786097 tmx.offset:77487
1638//ntpd: prev adjtimex freq:1786097 tmx.offset:0
1639//ntpd: cur adjtimex freq:1786097 tmx.offset:0
1640 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1641 /* 65536 is one ppm */
1642 tmx.freq = G.discipline_freq_drift * 65536e6;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001643#endif
1644 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001645 tmx.offset = (offset * 1000000); /* usec */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001646 tmx.status = STA_PLL;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001647 if (G.ntp_status & LI_PLUSSEC)
1648 tmx.status |= STA_INS;
1649 if (G.ntp_status & LI_MINUSSEC)
1650 tmx.status |= STA_DEL;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001651
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001652 tmx.constant = G.poll_exp - 4;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001653 /* EXPERIMENTAL.
1654 * The below if statement should be unnecessary, but...
1655 * It looks like Linux kernel's PLL is far too gentle in changing
1656 * tmx.freq in response to clock offset. Offset keeps growing
1657 * and eventually we fall back to smaller poll intervals.
1658 * We can make correction more agressive (about x2) by supplying
1659 * PLL time constant which is one less than the real one.
1660 * To be on a safe side, let's do it only if offset is significantly
1661 * larger than jitter.
1662 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001663 if (tmx.constant > 0 && G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001664 tmx.constant--;
1665
1666 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1667 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001668 rc = adjtimex(&tmx);
1669 if (rc < 0)
1670 bb_perror_msg_and_die("adjtimex");
Denys Vlasenkod9109e32010-01-02 00:36:43 +01001671 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1672 * Not sure why. Perhaps it is normal.
1673 */
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001674 VERB4 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001675 rc, tmx.freq, tmx.offset, tmx.status);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001676 G.kernel_freq_drift = tmx.freq / 65536;
Denys Vlasenko547ee792012-03-05 10:18:00 +01001677 VERB2 bb_error_msg("update from:%s offset:%+f jitter:%f clock drift:%+.3fppm tc:%d",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001678 p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001679
1680 return 1; /* "ok to increase poll interval" */
1681}
1682
1683
1684/*
1685 * We've got a new reply packet from a peer, process it
1686 * (helpers first)
1687 */
1688static unsigned
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001689poll_interval(int upper_bound)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001690{
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001691 unsigned interval, r, mask;
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001692 interval = 1 << G.poll_exp;
1693 if (interval > upper_bound)
1694 interval = upper_bound;
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001695 mask = ((interval-1) >> 4) | 1;
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01001696 r = rand();
Denys Vlasenko3e78f6f2014-02-09 15:35:04 +01001697 interval += r & mask; /* ~ random(0..1) * interval/16 */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001698 VERB4 bb_error_msg("chose poll interval:%u (poll_exp:%d)", interval, G.poll_exp);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001699 return interval;
1700}
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001701static void
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001702adjust_poll(int count)
1703{
1704 G.polladj_count += count;
1705 if (G.polladj_count > POLLADJ_LIMIT) {
1706 G.polladj_count = 0;
1707 if (G.poll_exp < MAXPOLL) {
1708 G.poll_exp++;
1709 VERB4 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1710 G.discipline_jitter, G.poll_exp);
1711 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001712 } else if (G.polladj_count < -POLLADJ_LIMIT || (count < 0 && G.poll_exp > BIGPOLL)) {
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001713 G.polladj_count = 0;
1714 if (G.poll_exp > MINPOLL) {
1715 llist_t *item;
1716
1717 G.poll_exp--;
1718 /* Correct p->next_action_time in each peer
1719 * which waits for sending, so that they send earlier.
1720 * Old pp->next_action_time are on the order
1721 * of t + (1 << old_poll_exp) + small_random,
1722 * we simply need to subtract ~half of that.
1723 */
1724 for (item = G.ntp_peers; item != NULL; item = item->link) {
1725 peer_t *pp = (peer_t *) item->data;
1726 if (pp->p_fd < 0)
1727 pp->next_action_time -= (1 << G.poll_exp);
1728 }
1729 VERB4 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1730 G.discipline_jitter, G.poll_exp);
1731 }
1732 } else {
1733 VERB4 bb_error_msg("polladj: count:%d", G.polladj_count);
1734 }
1735}
1736static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001737recv_and_process_peer_pkt(peer_t *p)
1738{
1739 int rc;
1740 ssize_t size;
1741 msg_t msg;
1742 double T1, T2, T3, T4;
Denys Vlasenkod531f932014-04-19 19:00:16 +02001743 double offset;
1744 double prev_delay, delay;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001745 unsigned interval;
1746 datapoint_t *datapoint;
1747 peer_t *q;
1748
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001749 offset = 0;
1750
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001751 /* We can recvfrom here and check from.IP, but some multihomed
1752 * ntp servers reply from their *other IP*.
1753 * TODO: maybe we should check at least what we can: from.port == 123?
1754 */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001755 recv_again:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001756 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001757 if (size < 0) {
1758 if (errno == EINTR)
1759 /* Signal caught */
1760 goto recv_again;
1761 if (errno == EAGAIN)
1762 /* There was no packet after all
1763 * (poll() returning POLLIN for a fd
1764 * is not a ironclad guarantee that data is there)
1765 */
1766 return;
1767 /*
1768 * If you need a different handling for a specific
1769 * errno, always explain it in comment.
1770 */
1771 bb_perror_msg_and_die("recv(%s) error", p->p_dotted);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001772 }
1773
1774 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1775 bb_error_msg("malformed packet received from %s", p->p_dotted);
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001776 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001777 }
1778
1779 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1780 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1781 ) {
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001782 /* Somebody else's packet */
1783 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001784 }
1785
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001786 /* We do not expect any more packets from this peer for now.
1787 * Closing the socket informs kernel about it.
1788 * We open a new socket when we send a new query.
1789 */
1790 close(p->p_fd);
1791 p->p_fd = -1;
1792
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001793 if ((msg.m_status & LI_ALARM) == LI_ALARM
1794 || msg.m_stratum == 0
1795 || msg.m_stratum > NTP_MAXSTRATUM
1796 ) {
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001797 bb_error_msg("reply from %s: peer is unsynced", p->p_dotted);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001798 /*
1799 * Stratum 0 responses may have commands in 32-bit m_refid field:
1800 * "DENY", "RSTR" - peer does not like us at all,
1801 * "RATE" - peer is overloaded, reduce polling freq.
1802 * If poll interval is small, increase it.
1803 */
1804 if (G.poll_exp < BIGPOLL)
1805 goto increase_interval;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001806 goto pick_normal_interval;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001807 }
1808
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001809// /* Verify valid root distance */
1810// if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1811// return; /* invalid header values */
1812
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001813 /*
1814 * From RFC 2030 (with a correction to the delay math):
1815 *
1816 * Timestamp Name ID When Generated
1817 * ------------------------------------------------------------
1818 * Originate Timestamp T1 time request sent by client
1819 * Receive Timestamp T2 time request received by server
1820 * Transmit Timestamp T3 time reply sent by server
1821 * Destination Timestamp T4 time reply received by client
1822 *
1823 * The roundtrip delay and local clock offset are defined as
1824 *
1825 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1826 */
1827 T1 = p->p_xmttime;
1828 T2 = lfp_to_d(msg.m_rectime);
1829 T3 = lfp_to_d(msg.m_xmttime);
Denys Vlasenko0b002812010-01-03 08:59:59 +01001830 T4 = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001831
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001832 /* The delay calculation is a special case. In cases where the
1833 * server and client clocks are running at different rates and
1834 * with very fast networks, the delay can appear negative. In
1835 * order to avoid violating the Principle of Least Astonishment,
1836 * the delay is clamped not less than the system precision.
1837 */
Denys Vlasenkod531f932014-04-19 19:00:16 +02001838 delay = (T4 - T1) - (T3 - T2);
1839 if (delay < G_precision_sec)
1840 delay = G_precision_sec;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001841 /*
1842 * If this packet's delay is much bigger than the last one,
1843 * it's better to just ignore it than use its much less precise value.
1844 */
Denys Vlasenkod531f932014-04-19 19:00:16 +02001845 prev_delay = p->p_raw_delay;
1846 p->p_raw_delay = delay;
1847 if (p->reachable_bits && delay > prev_delay * BAD_DELAY_GROWTH) {
Denys Vlasenko5a21c852014-04-20 13:04:23 +02001848 bb_error_msg("reply from %s: delay %f is too high, ignoring", p->p_dotted, delay);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001849 goto pick_normal_interval;
1850 }
1851
Denys Vlasenkod531f932014-04-19 19:00:16 +02001852 p->lastpkt_delay = delay;
1853 p->lastpkt_recv_time = T4;
1854 VERB6 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
1855 p->lastpkt_status = msg.m_status;
1856 p->lastpkt_stratum = msg.m_stratum;
1857 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1858 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1859 p->lastpkt_refid = msg.m_refid;
1860
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001861 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1862 datapoint = &p->filter_datapoint[p->datapoint_idx];
1863 datapoint->d_recv_time = T4;
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001864 datapoint->d_offset = offset = ((T2 - T1) + (T3 - T4)) / 2;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001865 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001866 if (!p->reachable_bits) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001867 /* 1st datapoint ever - replicate offset in every element */
1868 int i;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001869 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001870 p->filter_datapoint[i].d_offset = offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001871 }
1872 }
1873
Denys Vlasenko0b002812010-01-03 08:59:59 +01001874 p->reachable_bits |= 1;
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01001875 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
Denys Vlasenko79bec062012-03-08 13:02:52 +01001876 bb_error_msg("reply from %s: offset:%+f delay:%f status:0x%02x strat:%d refid:0x%08x rootdelay:%f reach:0x%02x",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001877 p->p_dotted,
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001878 offset,
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001879 p->lastpkt_delay,
1880 p->lastpkt_status,
1881 p->lastpkt_stratum,
1882 p->lastpkt_refid,
Denys Vlasenkod98dc922012-03-08 03:27:49 +01001883 p->lastpkt_rootdelay,
1884 p->reachable_bits
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001885 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1886 * m_reftime, m_orgtime, m_rectime, m_xmttime
1887 */
1888 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001889 }
1890
1891 /* Muck with statictics and update the clock */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001892 filter_datapoints(p);
1893 q = select_and_cluster();
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001894 rc = 0;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001895 if (q) {
Denys Vlasenko12628b72010-01-11 01:31:59 +01001896 if (!(option_mask32 & OPT_w)) {
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001897 rc = update_local_clock(q);
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001898#if 0
1899//Disabled this because there is a case where largish offsets
1900//are unavoidable: if network round-trip delay is, say, ~0.6s,
1901//error in offset estimation would be ~delay/2 ~= 0.3s.
1902//Thus, offsets will be usually in -0.3...0.3s range.
1903//In this case, this code would keep poll interval small,
1904//but it won't be helping.
1905//BIGOFF check below deals with a case of seeing multi-second offsets.
1906
Denys Vlasenko12628b72010-01-11 01:31:59 +01001907 /* If drift is dangerously large, immediately
1908 * drop poll interval one step down.
1909 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001910 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
Denys Vlasenkoa14958c2013-12-04 16:32:09 +01001911 VERB4 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001912 adjust_poll(-POLLADJ_LIMIT * 3);
1913 rc = 0;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001914 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001915#endif
Denys Vlasenko12628b72010-01-11 01:31:59 +01001916 }
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001917 } else {
1918 /* No peer selected.
1919 * If poll interval is small, increase it.
1920 */
1921 if (G.poll_exp < BIGPOLL)
1922 goto increase_interval;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001923 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001924
1925 if (rc != 0) {
1926 /* Adjust the poll interval by comparing the current offset
1927 * with the clock jitter. If the offset is less than
1928 * the clock jitter times a constant, then the averaging interval
1929 * is increased, otherwise it is decreased. A bit of hysteresis
1930 * helps calm the dance. Works best using burst mode.
1931 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001932 if (rc > 0 && G.offset_to_jitter_ratio <= POLLADJ_GATE) {
Denys Vlasenkobfc2a322010-01-01 18:12:06 +01001933 /* was += G.poll_exp but it is a bit
1934 * too optimistic for my taste at high poll_exp's */
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02001935 increase_interval:
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001936 adjust_poll(MINPOLL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001937 } else {
Miroslav Lichvar590a22c2014-09-18 16:19:05 +02001938 adjust_poll(-G.poll_exp * 2);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001939 }
1940 }
1941
1942 /* Decide when to send new query for this peer */
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001943 pick_normal_interval:
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02001944 interval = poll_interval(INT_MAX);
1945 if (fabs(offset) >= BIGOFF && interval > BIGOFF_INTERVAL) {
Denys Vlasenko0b3a38b2013-12-08 16:11:04 +01001946 /* If we are synced, offsets are less than STEP_THRESHOLD,
1947 * or at the very least not much larger than it.
1948 * Now we see a largish one.
1949 * Either this peer is feeling bad, or packet got corrupted,
1950 * or _our_ clock is wrong now and _all_ peers will show similar
1951 * largish offsets too.
1952 * I observed this with laptop suspend stopping clock.
1953 * In any case, it makes sense to make next request soonish:
1954 * cases 1 and 2: get a better datapoint,
1955 * case 3: allows to resync faster.
1956 */
1957 interval = BIGOFF_INTERVAL;
1958 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001959
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001960 set_next(p, interval);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001961}
1962
1963#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01001964static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001965recv_and_process_client_pkt(void /*int fd*/)
1966{
1967 ssize_t size;
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02001968 //uint8_t version;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001969 len_and_sockaddr *to;
1970 struct sockaddr *from;
1971 msg_t msg;
1972 uint8_t query_status;
1973 l_fixedpt_t query_xmttime;
1974
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001975 to = get_sock_lsa(G_listen_fd);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001976 from = xzalloc(to->len);
1977
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001978 size = recv_from_to(G_listen_fd, &msg, sizeof(msg), MSG_DONTWAIT, from, &to->u.sa, to->len);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001979 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1980 char *addr;
1981 if (size < 0) {
1982 if (errno == EAGAIN)
1983 goto bail;
1984 bb_perror_msg_and_die("recv");
1985 }
1986 addr = xmalloc_sockaddr2dotted_noport(from);
1987 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1988 free(addr);
1989 goto bail;
1990 }
1991
1992 query_status = msg.m_status;
1993 query_xmttime = msg.m_xmttime;
1994
1995 /* Build a reply packet */
1996 memset(&msg, 0, sizeof(msg));
Paul Marksb7841cf2013-01-14 02:39:10 +01001997 msg.m_status = G.stratum < MAXSTRAT ? (G.ntp_status & LI_MASK) : LI_ALARM;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001998 msg.m_status |= (query_status & VERSION_MASK);
1999 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
Denys Vlasenko69675782013-01-14 01:34:48 +01002000 MODE_SERVER : MODE_SYM_PAS;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002001 msg.m_stratum = G.stratum;
2002 msg.m_ppoll = G.poll_exp;
2003 msg.m_precision_exp = G_precision_exp;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002004 /* this time was obtained between poll() and recv() */
2005 msg.m_rectime = d_to_lfp(G.cur_time);
2006 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
Denys Vlasenkod6782572010-10-04 01:20:44 +02002007 if (G.peer_cnt == 0) {
2008 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
2009 G.reftime = G.cur_time;
2010 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002011 msg.m_reftime = d_to_lfp(G.reftime);
2012 msg.m_orgtime = query_xmttime;
2013 msg.m_rootdelay = d_to_sfp(G.rootdelay);
2014//simple code does not do this, fix simple code!
2015 msg.m_rootdisp = d_to_sfp(G.rootdisp);
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02002016 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002017 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
2018
2019 /* We reply from the local address packet was sent to,
2020 * this makes to/from look swapped here: */
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002021 do_sendto(G_listen_fd,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002022 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
2023 &msg, size);
2024
2025 bail:
2026 free(to);
2027 free(from);
2028}
2029#endif
2030
2031/* Upstream ntpd's options:
2032 *
2033 * -4 Force DNS resolution of host names to the IPv4 namespace.
2034 * -6 Force DNS resolution of host names to the IPv6 namespace.
2035 * -a Require cryptographic authentication for broadcast client,
2036 * multicast client and symmetric passive associations.
2037 * This is the default.
2038 * -A Do not require cryptographic authentication for broadcast client,
2039 * multicast client and symmetric passive associations.
2040 * This is almost never a good idea.
2041 * -b Enable the client to synchronize to broadcast servers.
2042 * -c conffile
2043 * Specify the name and path of the configuration file,
2044 * default /etc/ntp.conf
2045 * -d Specify debugging mode. This option may occur more than once,
2046 * with each occurrence indicating greater detail of display.
2047 * -D level
2048 * Specify debugging level directly.
2049 * -f driftfile
2050 * Specify the name and path of the frequency file.
2051 * This is the same operation as the "driftfile FILE"
2052 * configuration command.
2053 * -g Normally, ntpd exits with a message to the system log
2054 * if the offset exceeds the panic threshold, which is 1000 s
2055 * by default. This option allows the time to be set to any value
2056 * without restriction; however, this can happen only once.
2057 * If the threshold is exceeded after that, ntpd will exit
2058 * with a message to the system log. This option can be used
2059 * with the -q and -x options. See the tinker command for other options.
2060 * -i jaildir
2061 * Chroot the server to the directory jaildir. This option also implies
2062 * that the server attempts to drop root privileges at startup
2063 * (otherwise, chroot gives very little additional security).
2064 * You may need to also specify a -u option.
2065 * -k keyfile
2066 * Specify the name and path of the symmetric key file,
2067 * default /etc/ntp/keys. This is the same operation
2068 * as the "keys FILE" configuration command.
2069 * -l logfile
2070 * Specify the name and path of the log file. The default
2071 * is the system log file. This is the same operation as
2072 * the "logfile FILE" configuration command.
2073 * -L Do not listen to virtual IPs. The default is to listen.
2074 * -n Don't fork.
2075 * -N To the extent permitted by the operating system,
2076 * run the ntpd at the highest priority.
2077 * -p pidfile
2078 * Specify the name and path of the file used to record the ntpd
2079 * process ID. This is the same operation as the "pidfile FILE"
2080 * configuration command.
2081 * -P priority
2082 * To the extent permitted by the operating system,
2083 * run the ntpd at the specified priority.
2084 * -q Exit the ntpd just after the first time the clock is set.
2085 * This behavior mimics that of the ntpdate program, which is
2086 * to be retired. The -g and -x options can be used with this option.
2087 * Note: The kernel time discipline is disabled with this option.
2088 * -r broadcastdelay
2089 * Specify the default propagation delay from the broadcast/multicast
2090 * server to this client. This is necessary only if the delay
2091 * cannot be computed automatically by the protocol.
2092 * -s statsdir
2093 * Specify the directory path for files created by the statistics
2094 * facility. This is the same operation as the "statsdir DIR"
2095 * configuration command.
2096 * -t key
2097 * Add a key number to the trusted key list. This option can occur
2098 * more than once.
2099 * -u user[:group]
2100 * Specify a user, and optionally a group, to switch to.
2101 * -v variable
2102 * -V variable
2103 * Add a system variable listed by default.
2104 * -x Normally, the time is slewed if the offset is less than the step
2105 * threshold, which is 128 ms by default, and stepped if above
2106 * the threshold. This option sets the threshold to 600 s, which is
2107 * well within the accuracy window to set the clock manually.
2108 * Note: since the slew rate of typical Unix kernels is limited
2109 * to 0.5 ms/s, each second of adjustment requires an amortization
2110 * interval of 2000 s. Thus, an adjustment as much as 600 s
2111 * will take almost 14 days to complete. This option can be used
2112 * with the -g and -q options. See the tinker command for other options.
2113 * Note: The kernel time discipline is disabled with this option.
2114 */
2115
2116/* By doing init in a separate function we decrease stack usage
2117 * in main loop.
2118 */
2119static NOINLINE void ntp_init(char **argv)
2120{
2121 unsigned opts;
2122 llist_t *peers;
2123
Denys Vlasenko0ed5f7a2014-03-05 18:58:15 +01002124 srand(getpid());
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002125
2126 if (getuid())
2127 bb_error_msg_and_die(bb_msg_you_must_be_root);
2128
2129 /* Set some globals */
Miroslav Lichvar760d0352014-10-05 03:10:15 +02002130 G.discipline_jitter = G_precision_sec;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002131 G.stratum = MAXSTRAT;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002132 if (BURSTPOLL != 0)
2133 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002134 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002135
2136 /* Parse options */
2137 peers = NULL;
Denys Vlasenko278842d2014-07-15 15:06:54 +02002138 opt_complementary = "dd:p::wn" /* -d: counter; -p: list; -w implies -n */
2139 IF_FEATURE_NTPD_SERVER(":Il"); /* -I implies -l */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002140 opts = getopt32(argv,
2141 "nqNx" /* compat */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002142 "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
Denys Vlasenko278842d2014-07-15 15:06:54 +02002143 IF_FEATURE_NTPD_SERVER("I:") /* compat */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002144 "d" /* compat */
2145 "46aAbgL", /* compat, ignored */
Denys Vlasenko278842d2014-07-15 15:06:54 +02002146 &peers,&G.script_name,
2147#if ENABLE_FEATURE_NTPD_SERVER
2148 &G.if_name,
2149#endif
2150 &G.verbose);
Denys Vlasenko504fe452014-03-23 15:06:38 +01002151
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002152// if (opts & OPT_x) /* disable stepping, only slew is allowed */
2153// G.time_was_stepped = 1;
Denys Vlasenkod6782572010-10-04 01:20:44 +02002154 if (peers) {
2155 while (peers)
2156 add_peers(llist_pop(&peers));
Denys Vlasenko504fe452014-03-23 15:06:38 +01002157 }
2158#if ENABLE_FEATURE_NTPD_CONF
2159 else {
2160 parser_t *parser;
2161 char *token[3];
2162
2163 parser = config_open("/etc/ntp.conf");
2164 while (config_read(parser, token, 3, 1, "# \t", PARSE_NORMAL)) {
2165 if (strcmp(token[0], "server") == 0 && token[1]) {
2166 add_peers(token[1]);
2167 continue;
2168 }
2169 bb_error_msg("skipping %s:%u: unimplemented command '%s'",
2170 "/etc/ntp.conf", parser->lineno, token[0]
2171 );
2172 }
2173 config_close(parser);
2174 }
2175#endif
2176 if (G.peer_cnt == 0) {
2177 if (!(opts & OPT_l))
2178 bb_show_usage();
Denys Vlasenkod6782572010-10-04 01:20:44 +02002179 /* -l but no peers: "stratum 1 server" mode */
2180 G.stratum = 1;
2181 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002182#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002183 G_listen_fd = -1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002184 if (opts & OPT_l) {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002185 G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
Denys Vlasenko278842d2014-07-15 15:06:54 +02002186 if (opts & OPT_I) {
2187 if (setsockopt_bindtodevice(G_listen_fd, G.if_name))
2188 xfunc_die();
2189 }
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002190 socket_want_pktinfo(G_listen_fd);
2191 setsockopt(G_listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002192 }
2193#endif
Denys Vlasenko278842d2014-07-15 15:06:54 +02002194 if (!(opts & OPT_n)) {
2195 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
2196 logmode = LOGMODE_NONE;
2197 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002198 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
2199 if (opts & OPT_N)
2200 setpriority(PRIO_PROCESS, 0, -15);
2201
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002202 /* If network is up, syncronization occurs in ~10 seconds.
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002203 * We give "ntpd -q" 10 seconds to get first reply,
2204 * then another 50 seconds to finish syncing.
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002205 *
2206 * I tested ntpd 4.2.6p1 and apparently it never exits
2207 * (will try forever), but it does not feel right.
2208 * The goal of -q is to act like ntpdate: set time
2209 * after a reasonably small period of polling, or fail.
2210 */
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002211 if (opts & OPT_q) {
2212 option_mask32 |= OPT_qq;
2213 alarm(10);
2214 }
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002215
2216 bb_signals(0
2217 | (1 << SIGTERM)
2218 | (1 << SIGINT)
2219 | (1 << SIGALRM)
2220 , record_signo
2221 );
2222 bb_signals(0
2223 | (1 << SIGPIPE)
2224 | (1 << SIGCHLD)
2225 , SIG_IGN
2226 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002227}
2228
2229int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2230int ntpd_main(int argc UNUSED_PARAM, char **argv)
2231{
Denys Vlasenko0b002812010-01-03 08:59:59 +01002232#undef G
2233 struct globals G;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002234 struct pollfd *pfd;
2235 peer_t **idx2peer;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002236 unsigned cnt;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002237
Denys Vlasenko0b002812010-01-03 08:59:59 +01002238 memset(&G, 0, sizeof(G));
2239 SET_PTR_TO_GLOBALS(&G);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002240
2241 ntp_init(argv);
2242
Denys Vlasenko0b002812010-01-03 08:59:59 +01002243 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2244 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2245 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2246 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2247
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002248 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002249 * packets to each peer.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002250 * NB: if some peer is not responding, we may end up sending
2251 * fewer packets to it and more to other peers.
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002252 * NB2: sync usually happens using INITIAL_SAMPLES packets,
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002253 * since last reply does not come back instantaneously.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002254 */
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002255 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002256
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002257 write_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2258
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002259 while (!bb_got_signal) {
2260 llist_t *item;
2261 unsigned i, j;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002262 int nfds, timeout;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002263 double nextaction;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002264
2265 /* Nothing between here and poll() blocks for any significant time */
2266
Denys Vlasenko0b002812010-01-03 08:59:59 +01002267 nextaction = G.cur_time + 3600;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002268
2269 i = 0;
2270#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002271 if (G_listen_fd != -1) {
2272 pfd[0].fd = G_listen_fd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002273 pfd[0].events = POLLIN;
2274 i++;
2275 }
2276#endif
2277 /* Pass over peer list, send requests, time out on receives */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002278 for (item = G.ntp_peers; item != NULL; item = item->link) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002279 peer_t *p = (peer_t *) item->data;
2280
Denys Vlasenko0b002812010-01-03 08:59:59 +01002281 if (p->next_action_time <= G.cur_time) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002282 if (p->p_fd == -1) {
2283 /* Time to send new req */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002284 if (--cnt == 0) {
Miroslav Lichvarfb143f72014-09-18 16:19:03 +02002285 VERB4 bb_error_msg("disabling burst mode");
2286 G.polladj_count = 0;
2287 G.poll_exp = MINPOLL;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002288 G.initial_poll_complete = 1;
2289 }
2290 send_query_to_peer(p);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002291 } else {
2292 /* Timed out waiting for reply */
2293 close(p->p_fd);
2294 p->p_fd = -1;
Miroslav Lichvarb434ce72014-10-02 17:18:43 +02002295 /* If poll interval is small, increase it */
2296 if (G.poll_exp < BIGPOLL)
2297 adjust_poll(MINPOLL);
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002298 timeout = poll_interval(NOREPLY_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002299 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
Denys Vlasenko0b002812010-01-03 08:59:59 +01002300 p->p_dotted, p->reachable_bits, timeout);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002301 set_next(p, timeout);
2302 }
2303 }
2304
2305 if (p->next_action_time < nextaction)
2306 nextaction = p->next_action_time;
2307
2308 if (p->p_fd >= 0) {
2309 /* Wait for reply from this peer */
2310 pfd[i].fd = p->p_fd;
2311 pfd[i].events = POLLIN;
2312 idx2peer[i] = p;
2313 i++;
2314 }
2315 }
2316
Denys Vlasenko0b002812010-01-03 08:59:59 +01002317 timeout = nextaction - G.cur_time;
2318 if (timeout < 0)
2319 timeout = 0;
2320 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002321
2322 /* Here we may block */
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002323 VERB2 {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002324 if (i > (ENABLE_FEATURE_NTPD_SERVER && G_listen_fd != -1)) {
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002325 /* We wait for at least one reply.
2326 * Poll for it, without wasting time for message.
2327 * Since replies often come under 1 second, this also
2328 * reduces clutter in logs.
2329 */
2330 nfds = poll(pfd, i, 1000);
2331 if (nfds != 0)
2332 goto did_poll;
2333 if (--timeout <= 0)
2334 goto did_poll;
2335 }
Denys Vlasenko8be49c32012-03-06 19:16:50 +01002336 bb_error_msg("poll:%us sockets:%u interval:%us", timeout, i, 1 << G.poll_exp);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002337 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002338 nfds = poll(pfd, i, timeout * 1000);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002339 did_poll:
Denys Vlasenko0b002812010-01-03 08:59:59 +01002340 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002341 if (nfds <= 0) {
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002342 if (!bb_got_signal /* poll wasn't interrupted by a signal */
2343 && G.cur_time - G.last_script_run > 11*60
2344 ) {
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002345 /* Useful for updating battery-backed RTC and such */
Denys Vlasenko12628b72010-01-11 01:31:59 +01002346 run_script("periodic", G.last_update_offset);
Denys Vlasenko06667f22010-01-06 13:05:08 +01002347 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002348 }
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002349 goto check_unsync;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002350 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002351
2352 /* Process any received packets */
2353 j = 0;
2354#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01002355 if (G.listen_fd != -1) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002356 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2357 nfds--;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002358 recv_and_process_client_pkt(/*G.listen_fd*/);
2359 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002360 }
2361 j = 1;
2362 }
2363#endif
2364 for (; nfds != 0 && j < i; j++) {
2365 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002366 /*
2367 * At init, alarm was set to 10 sec.
2368 * Now we did get a reply.
2369 * Increase timeout to 50 seconds to finish syncing.
2370 */
2371 if (option_mask32 & OPT_qq) {
2372 option_mask32 &= ~OPT_qq;
2373 alarm(50);
2374 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002375 nfds--;
2376 recv_and_process_peer_pkt(idx2peer[j]);
Denys Vlasenko0b002812010-01-03 08:59:59 +01002377 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002378 }
2379 }
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002380
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002381 check_unsync:
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002382 if (G.ntp_peers && G.stratum != MAXSTRAT) {
2383 for (item = G.ntp_peers; item != NULL; item = item->link) {
2384 peer_t *p = (peer_t *) item->data;
2385 if (p->reachable_bits)
2386 goto have_reachable_peer;
2387 }
2388 /* No peer responded for last 8 packets, panic */
Denys Vlasenkod3fe9602014-09-27 22:56:09 +02002389 clamp_pollexp_and_set_MAXSTRAT();
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02002390 run_script("unsync", 0.0);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002391 have_reachable_peer: ;
2392 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002393 } /* while (!bb_got_signal) */
2394
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002395 remove_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002396 kill_myself_with_sig(bb_got_signal);
2397}
2398
2399
2400
2401
2402
2403
2404/*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2405
2406/*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2407
2408#if 0
2409static double
2410direct_freq(double fp_offset)
2411{
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002412#ifdef KERNEL_PLL
2413 /*
2414 * If the kernel is enabled, we need the residual offset to
2415 * calculate the frequency correction.
2416 */
2417 if (pll_control && kern_enable) {
2418 memset(&ntv, 0, sizeof(ntv));
2419 ntp_adjtime(&ntv);
2420#ifdef STA_NANO
2421 clock_offset = ntv.offset / 1e9;
2422#else /* STA_NANO */
2423 clock_offset = ntv.offset / 1e6;
2424#endif /* STA_NANO */
2425 drift_comp = FREQTOD(ntv.freq);
2426 }
2427#endif /* KERNEL_PLL */
2428 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2429 wander_resid = 0;
2430 return drift_comp;
2431}
2432
2433static void
Denys Vlasenkofb132e42010-10-29 11:46:52 +02002434set_freq(double freq) /* frequency update */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002435{
2436 char tbuf[80];
2437
2438 drift_comp = freq;
2439
2440#ifdef KERNEL_PLL
2441 /*
2442 * If the kernel is enabled, update the kernel frequency.
2443 */
2444 if (pll_control && kern_enable) {
2445 memset(&ntv, 0, sizeof(ntv));
2446 ntv.modes = MOD_FREQUENCY;
2447 ntv.freq = DTOFREQ(drift_comp);
2448 ntp_adjtime(&ntv);
2449 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2450 report_event(EVNT_FSET, NULL, tbuf);
2451 } else {
2452 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2453 report_event(EVNT_FSET, NULL, tbuf);
2454 }
2455#else /* KERNEL_PLL */
2456 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2457 report_event(EVNT_FSET, NULL, tbuf);
2458#endif /* KERNEL_PLL */
2459}
2460
2461...
2462...
2463...
2464
2465#ifdef KERNEL_PLL
2466 /*
2467 * This code segment works when clock adjustments are made using
2468 * precision time kernel support and the ntp_adjtime() system
2469 * call. This support is available in Solaris 2.6 and later,
2470 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2471 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2472 * DECstation 5000/240 and Alpha AXP, additional kernel
2473 * modifications provide a true microsecond clock and nanosecond
2474 * clock, respectively.
2475 *
2476 * Important note: The kernel discipline is used only if the
2477 * step threshold is less than 0.5 s, as anything higher can
2478 * lead to overflow problems. This might occur if some misguided
2479 * lad set the step threshold to something ridiculous.
2480 */
2481 if (pll_control && kern_enable) {
2482
2483#define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2484
2485 /*
2486 * We initialize the structure for the ntp_adjtime()
2487 * system call. We have to convert everything to
2488 * microseconds or nanoseconds first. Do not update the
2489 * system variables if the ext_enable flag is set. In
2490 * this case, the external clock driver will update the
2491 * variables, which will be read later by the local
2492 * clock driver. Afterwards, remember the time and
2493 * frequency offsets for jitter and stability values and
2494 * to update the frequency file.
2495 */
2496 memset(&ntv, 0, sizeof(ntv));
2497 if (ext_enable) {
2498 ntv.modes = MOD_STATUS;
2499 } else {
2500#ifdef STA_NANO
2501 ntv.modes = MOD_BITS | MOD_NANO;
2502#else /* STA_NANO */
2503 ntv.modes = MOD_BITS;
2504#endif /* STA_NANO */
2505 if (clock_offset < 0)
2506 dtemp = -.5;
2507 else
2508 dtemp = .5;
2509#ifdef STA_NANO
2510 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2511 ntv.constant = sys_poll;
2512#else /* STA_NANO */
2513 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2514 ntv.constant = sys_poll - 4;
2515#endif /* STA_NANO */
2516 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2517 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2518 ntv.status = STA_PLL;
2519
2520 /*
2521 * Enable/disable the PPS if requested.
2522 */
2523 if (pps_enable) {
2524 if (!(pll_status & STA_PPSTIME))
2525 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002526 NULL, "PPS enabled");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002527 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2528 } else {
2529 if (pll_status & STA_PPSTIME)
2530 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002531 NULL, "PPS disabled");
2532 ntv.status &= ~(STA_PPSTIME | STA_PPSFREQ);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002533 }
2534 if (sys_leap == LEAP_ADDSECOND)
2535 ntv.status |= STA_INS;
2536 else if (sys_leap == LEAP_DELSECOND)
2537 ntv.status |= STA_DEL;
2538 }
2539
2540 /*
2541 * Pass the stuff to the kernel. If it squeals, turn off
2542 * the pps. In any case, fetch the kernel offset,
2543 * frequency and jitter.
2544 */
2545 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2546 if (!(ntv.status & STA_PPSSIGNAL))
2547 report_event(EVNT_KERN, NULL,
Denys Vlasenko69675782013-01-14 01:34:48 +01002548 "PPS no signal");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002549 }
2550 pll_status = ntv.status;
2551#ifdef STA_NANO
2552 clock_offset = ntv.offset / 1e9;
2553#else /* STA_NANO */
2554 clock_offset = ntv.offset / 1e6;
2555#endif /* STA_NANO */
2556 clock_frequency = FREQTOD(ntv.freq);
2557
2558 /*
2559 * If the kernel PPS is lit, monitor its performance.
2560 */
2561 if (ntv.status & STA_PPSTIME) {
2562#ifdef STA_NANO
2563 clock_jitter = ntv.jitter / 1e9;
2564#else /* STA_NANO */
2565 clock_jitter = ntv.jitter / 1e6;
2566#endif /* STA_NANO */
2567 }
2568
2569#if defined(STA_NANO) && NTP_API == 4
2570 /*
2571 * If the TAI changes, update the kernel TAI.
2572 */
2573 if (loop_tai != sys_tai) {
2574 loop_tai = sys_tai;
2575 ntv.modes = MOD_TAI;
2576 ntv.constant = sys_tai;
2577 ntp_adjtime(&ntv);
2578 }
2579#endif /* STA_NANO */
2580 }
2581#endif /* KERNEL_PLL */
2582#endif