blob: b04391eb5f04397756eb977466b31f7be860cb51 [file] [log] [blame]
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001/*
2 * NTP client/server, based on OpenNTPD 3.9p1
3 *
4 * Author: Adam Tkac <vonsch@gmail.com>
5 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02006 * Licensed under GPLv2, see file LICENSE in this source tree.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01007 *
8 * Parts of OpenNTPD clock syncronization code is replaced by
Denys Vlasenkobfc2a322010-01-01 18:12:06 +01009 * code which is based on ntp-4.2.6, whuch carries the following
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010010 * copyright notice:
11 *
12 ***********************************************************************
13 * *
14 * Copyright (c) University of Delaware 1992-2009 *
15 * *
16 * Permission to use, copy, modify, and distribute this software and *
17 * its documentation for any purpose with or without fee is hereby *
18 * granted, provided that the above copyright notice appears in all *
19 * copies and that both the copyright notice and this permission *
20 * notice appear in supporting documentation, and that the name *
21 * University of Delaware not be used in advertising or publicity *
22 * pertaining to distribution of the software without specific, *
23 * written prior permission. The University of Delaware makes no *
24 * representations about the suitability this software for any *
25 * purpose. It is provided "as is" without express or implied *
26 * warranty. *
27 * *
28 ***********************************************************************
29 */
Pere Orga5bc8c002011-04-11 03:29:49 +020030
31//usage:#define ntpd_trivial_usage
32//usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..."
33//usage:#define ntpd_full_usage "\n\n"
34//usage: "NTP client/server\n"
Pere Orga5bc8c002011-04-11 03:29:49 +020035//usage: "\n -d Verbose"
36//usage: "\n -n Do not daemonize"
37//usage: "\n -q Quit after clock is set"
38//usage: "\n -N Run at high priority"
39//usage: "\n -w Do not set time (only query peers), implies -n"
40//usage: IF_FEATURE_NTPD_SERVER(
41//usage: "\n -l Run as server on port 123"
42//usage: )
43//usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins"
44//usage: "\n -p PEER Obtain time from PEER (may be repeated)"
45
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010046#include "libbb.h"
47#include <math.h>
48#include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */
Mike Frysingerc5fe9f72012-07-05 23:19:09 -040049#include <sys/resource.h> /* setpriority */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010050#include <sys/timex.h>
51#ifndef IPTOS_LOWDELAY
52# define IPTOS_LOWDELAY 0x10
53#endif
54#ifndef IP_PKTINFO
55# error "Sorry, your kernel has to support IP_PKTINFO"
56#endif
57
58
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010059/* Verbosity control (max level of -dddd options accepted).
60 * max 5 is very talkative (and bloated). 2 is non-bloated,
61 * production level setting.
62 */
Denys Vlasenko61313112010-01-01 19:56:16 +010063#define MAX_VERBOSE 2
Denys Vlasenkobfc2a322010-01-01 18:12:06 +010064
65
Denys Vlasenko65d722b2010-01-11 02:14:04 +010066/* High-level description of the algorithm:
67 *
68 * We start running with very small poll_exp, BURSTPOLL,
Leonid Lisovskiy894ef602010-10-20 22:36:51 +020069 * in order to quickly accumulate INITIAL_SAMPLES datapoints
Denys Vlasenko65d722b2010-01-11 02:14:04 +010070 * for each peer. Then, time is stepped if the offset is larger
71 * than STEP_THRESHOLD, otherwise it isn't; anyway, we enlarge
72 * poll_exp to MINPOLL and enter frequency measurement step:
73 * we collect new datapoints but ignore them for WATCH_THRESHOLD
74 * seconds. After WATCH_THRESHOLD seconds we look at accumulated
75 * offset and estimate frequency drift.
76 *
Denys Vlasenko5b9a9102010-01-17 01:05:58 +010077 * (frequency measurement step seems to not be strictly needed,
78 * it is conditionally disabled with USING_INITIAL_FREQ_ESTIMATION
79 * define set to 0)
80 *
Denys Vlasenko65d722b2010-01-11 02:14:04 +010081 * After this, we enter "steady state": we collect a datapoint,
82 * we select the best peer, if this datapoint is not a new one
83 * (IOW: if this datapoint isn't for selected peer), sleep
84 * and collect another one; otherwise, use its offset to update
85 * frequency drift, if offset is somewhat large, reduce poll_exp,
86 * otherwise increase poll_exp.
87 *
88 * If offset is larger than STEP_THRESHOLD, which shouldn't normally
89 * happen, we assume that something "bad" happened (computer
90 * was hibernated, someone set totally wrong date, etc),
91 * then the time is stepped, all datapoints are discarded,
92 * and we go back to steady state.
93 */
94
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010095#define RETRY_INTERVAL 5 /* on error, retry in N secs */
Denys Vlasenko0b002812010-01-03 08:59:59 +010096#define RESPONSE_INTERVAL 15 /* wait for reply up to N secs */
Leonid Lisovskiy894ef602010-10-20 22:36:51 +020097#define INITIAL_SAMPLES 4 /* how many samples do we want for init */
Denys Vlasenkod99ef632013-05-22 17:48:19 +020098#define BAD_DELAY_GROWTH 4 /* drop packet if its delay grew by more than this */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +010099
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100100/* Clock discipline parameters and constants */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100101
102/* Step threshold (sec). std ntpd uses 0.128.
103 * Using exact power of 2 (1/8) results in smaller code */
104#define STEP_THRESHOLD 0.125
105#define WATCH_THRESHOLD 128 /* stepout threshold (sec). std ntpd uses 900 (11 mins (!)) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100106/* NB: set WATCH_THRESHOLD to ~60 when debugging to save time) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100107//UNUSED: #define PANIC_THRESHOLD 1000 /* panic threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100108
109#define FREQ_TOLERANCE 0.000015 /* frequency tolerance (15 PPM) */
Denys Vlasenkofb132e42010-10-29 11:46:52 +0200110#define BURSTPOLL 0 /* initial poll */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100111#define MINPOLL 5 /* minimum poll interval. std ntpd uses 6 (6: 64 sec) */
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100112/* If offset > discipline_jitter * POLLADJ_GATE, and poll interval is >= 2^BIGPOLL,
113 * then it is decreased _at once_. (If < 2^BIGPOLL, it will be decreased _eventually_).
114 */
115#define BIGPOLL 10 /* 2^10 sec ~= 17 min */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100116#define MAXPOLL 12 /* maximum poll interval (12: 1.1h, 17: 36.4h). std ntpd uses 17 */
117/* Actively lower poll when we see such big offsets.
118 * With STEP_THRESHOLD = 0.125, it means we try to sync more aggressively
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100119 * if offset increases over ~0.04 sec */
120#define POLLDOWN_OFFSET (STEP_THRESHOLD / 3)
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100121#define MINDISP 0.01 /* minimum dispersion (sec) */
122#define MAXDISP 16 /* maximum dispersion (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100123#define MAXSTRAT 16 /* maximum stratum (infinity metric) */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100124#define MAXDIST 1 /* distance threshold (sec) */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100125#define MIN_SELECTED 1 /* minimum intersection survivors */
126#define MIN_CLUSTERED 3 /* minimum cluster survivors */
127
128#define MAXDRIFT 0.000500 /* frequency drift we can correct (500 PPM) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100129
130/* Poll-adjust threshold.
131 * When we see that offset is small enough compared to discipline jitter,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100132 * we grow a counter: += MINPOLL. When counter goes over POLLADJ_LIMIT,
Denys Vlasenko61313112010-01-01 19:56:16 +0100133 * we poll_exp++. If offset isn't small, counter -= poll_exp*2,
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100134 * and when it goes below -POLLADJ_LIMIT, we poll_exp--.
135 * (Bumped from 30 to 40 since otherwise I often see poll_exp going *2* steps down)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100136 */
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100137#define POLLADJ_LIMIT 40
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100138/* If offset < discipline_jitter * POLLADJ_GATE, then we decide to increase
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100139 * poll interval (we think we can't improve timekeeping
140 * by staying at smaller poll).
141 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100142#define POLLADJ_GATE 4
Denys Vlasenko132b0442012-03-05 00:51:48 +0100143#define TIMECONST_HACK_GATE 2
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100144/* Compromise Allan intercept (sec). doc uses 1500, std ntpd uses 512 */
Denys Vlasenko61313112010-01-01 19:56:16 +0100145#define ALLAN 512
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100146/* PLL loop gain */
Denys Vlasenko61313112010-01-01 19:56:16 +0100147#define PLL 65536
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100148/* FLL loop gain [why it depends on MAXPOLL??] */
Denys Vlasenko61313112010-01-01 19:56:16 +0100149#define FLL (MAXPOLL + 1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100150/* Parameter averaging constant */
Denys Vlasenko61313112010-01-01 19:56:16 +0100151#define AVG 4
152
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100153
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100154enum {
155 NTP_VERSION = 4,
156 NTP_MAXSTRATUM = 15,
157
158 NTP_DIGESTSIZE = 16,
159 NTP_MSGSIZE_NOAUTH = 48,
160 NTP_MSGSIZE = (NTP_MSGSIZE_NOAUTH + 4 + NTP_DIGESTSIZE),
161
162 /* Status Masks */
163 MODE_MASK = (7 << 0),
164 VERSION_MASK = (7 << 3),
165 VERSION_SHIFT = 3,
166 LI_MASK = (3 << 6),
167
168 /* Leap Second Codes (high order two bits of m_status) */
169 LI_NOWARNING = (0 << 6), /* no warning */
170 LI_PLUSSEC = (1 << 6), /* add a second (61 seconds) */
171 LI_MINUSSEC = (2 << 6), /* minus a second (59 seconds) */
172 LI_ALARM = (3 << 6), /* alarm condition */
173
174 /* Mode values */
175 MODE_RES0 = 0, /* reserved */
176 MODE_SYM_ACT = 1, /* symmetric active */
177 MODE_SYM_PAS = 2, /* symmetric passive */
178 MODE_CLIENT = 3, /* client */
179 MODE_SERVER = 4, /* server */
180 MODE_BROADCAST = 5, /* broadcast */
181 MODE_RES1 = 6, /* reserved for NTP control message */
182 MODE_RES2 = 7, /* reserved for private use */
183};
184
185//TODO: better base selection
186#define OFFSET_1900_1970 2208988800UL /* 1970 - 1900 in seconds */
187
188#define NUM_DATAPOINTS 8
189
190typedef struct {
191 uint32_t int_partl;
192 uint32_t fractionl;
193} l_fixedpt_t;
194
195typedef struct {
196 uint16_t int_parts;
197 uint16_t fractions;
198} s_fixedpt_t;
199
200typedef struct {
201 uint8_t m_status; /* status of local clock and leap info */
202 uint8_t m_stratum;
203 uint8_t m_ppoll; /* poll value */
204 int8_t m_precision_exp;
205 s_fixedpt_t m_rootdelay;
206 s_fixedpt_t m_rootdisp;
207 uint32_t m_refid;
208 l_fixedpt_t m_reftime;
209 l_fixedpt_t m_orgtime;
210 l_fixedpt_t m_rectime;
211 l_fixedpt_t m_xmttime;
212 uint32_t m_keyid;
213 uint8_t m_digest[NTP_DIGESTSIZE];
214} msg_t;
215
216typedef struct {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100217 double d_offset;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100218 double d_recv_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100219 double d_dispersion;
220} datapoint_t;
221
222typedef struct {
223 len_and_sockaddr *p_lsa;
224 char *p_dotted;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100225 int p_fd;
226 int datapoint_idx;
227 uint32_t lastpkt_refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100228 uint8_t lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100229 uint8_t lastpkt_stratum;
Denys Vlasenko0b002812010-01-03 08:59:59 +0100230 uint8_t reachable_bits;
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200231 /* when to send new query (if p_fd == -1)
232 * or when receive times out (if p_fd >= 0): */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100233 double next_action_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100234 double p_xmttime;
235 double lastpkt_recv_time;
236 double lastpkt_delay;
237 double lastpkt_rootdelay;
238 double lastpkt_rootdisp;
239 /* produced by filter algorithm: */
240 double filter_offset;
241 double filter_dispersion;
242 double filter_jitter;
243 datapoint_t filter_datapoint[NUM_DATAPOINTS];
244 /* last sent packet: */
245 msg_t p_xmt_msg;
246} peer_t;
247
248
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100249#define USING_KERNEL_PLL_LOOP 1
250#define USING_INITIAL_FREQ_ESTIMATION 0
251
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100252enum {
253 OPT_n = (1 << 0),
254 OPT_q = (1 << 1),
255 OPT_N = (1 << 2),
256 OPT_x = (1 << 3),
257 /* Insert new options above this line. */
258 /* Non-compat options: */
Denys Vlasenko4168fdd2010-01-04 00:19:13 +0100259 OPT_w = (1 << 4),
260 OPT_p = (1 << 5),
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100261 OPT_S = (1 << 6),
262 OPT_l = (1 << 7) * ENABLE_FEATURE_NTPD_SERVER,
Denys Vlasenko8e23faf2011-04-07 01:45:20 +0200263 /* We hijack some bits for other purposes */
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100264 OPT_qq = (1 << 31),
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100265};
266
267struct globals {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100268 double cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100269 /* total round trip delay to currently selected reference clock */
270 double rootdelay;
271 /* reference timestamp: time when the system clock was last set or corrected */
272 double reftime;
273 /* total dispersion to currently selected reference clock */
274 double rootdisp;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100275
276 double last_script_run;
277 char *script_name;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100278 llist_t *ntp_peers;
279#if ENABLE_FEATURE_NTPD_SERVER
280 int listen_fd;
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +0200281# define G_listen_fd (G.listen_fd)
282#else
283# define G_listen_fd (-1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100284#endif
285 unsigned verbose;
286 unsigned peer_cnt;
287 /* refid: 32-bit code identifying the particular server or reference clock
Denys Vlasenko74584b82012-03-02 01:22:40 +0100288 * in stratum 0 packets this is a four-character ASCII string,
289 * called the kiss code, used for debugging and monitoring
290 * in stratum 1 packets this is a four-character ASCII string
291 * assigned to the reference clock by IANA. Example: "GPS "
292 * in stratum 2+ packets, it's IPv4 address or 4 first bytes
293 * of MD5 hash of IPv6
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100294 */
295 uint32_t refid;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100296 uint8_t ntp_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100297 /* precision is defined as the larger of the resolution and time to
298 * read the clock, in log2 units. For instance, the precision of a
299 * mains-frequency clock incrementing at 60 Hz is 16 ms, even when the
300 * system clock hardware representation is to the nanosecond.
301 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100302 * Delays, jitters of various kinds are clamped down to precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100303 *
304 * If precision_sec is too large, discipline_jitter gets clamped to it
Denys Vlasenko74584b82012-03-02 01:22:40 +0100305 * and if offset is smaller than discipline_jitter * POLLADJ_GATE, poll
306 * interval grows even though we really can benefit from staying at
307 * smaller one, collecting non-lagged datapoits and correcting offset.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100308 * (Lagged datapoits exist when poll_exp is large but we still have
309 * systematic offset error - the time distance between datapoints
Denys Vlasenko74584b82012-03-02 01:22:40 +0100310 * is significant and older datapoints have smaller offsets.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100311 * This makes our offset estimation a bit smaller than reality)
312 * Due to this effect, setting G_precision_sec close to
313 * STEP_THRESHOLD isn't such a good idea - offsets may grow
314 * too big and we will step. I observed it with -6.
315 *
Denys Vlasenko74584b82012-03-02 01:22:40 +0100316 * OTOH, setting precision_sec far too small would result in futile
317 * attempts to syncronize to an unachievable precision.
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100318 *
319 * -6 is 1/64 sec, -7 is 1/128 sec and so on.
Denys Vlasenko74584b82012-03-02 01:22:40 +0100320 * -8 is 1/256 ~= 0.003906 (worked well for me --vda)
321 * -9 is 1/512 ~= 0.001953 (let's try this for some time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100322 */
Denys Vlasenko74584b82012-03-02 01:22:40 +0100323#define G_precision_exp -9
324 /*
325 * G_precision_exp is used only for construction outgoing packets.
326 * It's ok to set G_precision_sec to a slightly different value
327 * (One which is "nicer looking" in logs).
328 * Exact value would be (1.0 / (1 << (- G_precision_exp))):
329 */
330#define G_precision_sec 0.002
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100331 uint8_t stratum;
332 /* Bool. After set to 1, never goes back to 0: */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100333 smallint initial_poll_complete;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100334
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100335#define STATE_NSET 0 /* initial state, "nothing is set" */
336//#define STATE_FSET 1 /* frequency set from file */
337#define STATE_SPIK 2 /* spike detected */
338//#define STATE_FREQ 3 /* initial frequency */
339#define STATE_SYNC 4 /* clock synchronized (normal operation) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100340 uint8_t discipline_state; // doc calls it c.state
341 uint8_t poll_exp; // s.poll
342 int polladj_count; // c.count
Denys Vlasenko61313112010-01-01 19:56:16 +0100343 long kernel_freq_drift;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100344 peer_t *last_update_peer;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100345 double last_update_offset; // c.last
Denys Vlasenko61313112010-01-01 19:56:16 +0100346 double last_update_recv_time; // s.t
347 double discipline_jitter; // c.jitter
Denys Vlasenko547ee792012-03-05 10:18:00 +0100348 /* Since we only compare it with ints, can simplify code
349 * by not making this variable floating point:
350 */
351 unsigned offset_to_jitter_ratio;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100352 //double cluster_offset; // s.offset
353 //double cluster_jitter; // s.jitter
Denys Vlasenko61313112010-01-01 19:56:16 +0100354#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100355 double discipline_freq_drift; // c.freq
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100356 /* Maybe conditionally calculate wander? it's used only for logging */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100357 double discipline_wander; // c.wander
Denys Vlasenko61313112010-01-01 19:56:16 +0100358#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100359};
360#define G (*ptr_to_globals)
361
362static const int const_IPTOS_LOWDELAY = IPTOS_LOWDELAY;
363
364
Denys Vlasenkobfc2a322010-01-01 18:12:06 +0100365#define VERB1 if (MAX_VERBOSE && G.verbose)
366#define VERB2 if (MAX_VERBOSE >= 2 && G.verbose >= 2)
367#define VERB3 if (MAX_VERBOSE >= 3 && G.verbose >= 3)
368#define VERB4 if (MAX_VERBOSE >= 4 && G.verbose >= 4)
369#define VERB5 if (MAX_VERBOSE >= 5 && G.verbose >= 5)
370
371
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100372static double LOG2D(int a)
373{
374 if (a < 0)
375 return 1.0 / (1UL << -a);
376 return 1UL << a;
377}
378static ALWAYS_INLINE double SQUARE(double x)
379{
380 return x * x;
381}
382static ALWAYS_INLINE double MAXD(double a, double b)
383{
384 if (a > b)
385 return a;
386 return b;
387}
388static ALWAYS_INLINE double MIND(double a, double b)
389{
390 if (a < b)
391 return a;
392 return b;
393}
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100394static NOINLINE double my_SQRT(double X)
395{
396 union {
397 float f;
398 int32_t i;
399 } v;
400 double invsqrt;
401 double Xhalf = X * 0.5;
402
403 /* Fast and good approximation to 1/sqrt(X), black magic */
404 v.f = X;
405 /*v.i = 0x5f3759df - (v.i >> 1);*/
406 v.i = 0x5f375a86 - (v.i >> 1); /* - this constant is slightly better */
407 invsqrt = v.f; /* better than 0.2% accuracy */
408
409 /* Refining it using Newton's method: x1 = x0 - f(x0)/f'(x0)
410 * f(x) = 1/(x*x) - X (f==0 when x = 1/sqrt(X))
411 * f'(x) = -2/(x*x*x)
412 * f(x)/f'(x) = (X - 1/(x*x)) / (2/(x*x*x)) = X*x*x*x/2 - x/2
413 * x1 = x0 - (X*x0*x0*x0/2 - x0/2) = 1.5*x0 - X*x0*x0*x0/2 = x0*(1.5 - (X/2)*x0*x0)
414 */
415 invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); /* ~0.05% accuracy */
416 /* invsqrt = invsqrt * (1.5 - Xhalf * invsqrt * invsqrt); 2nd iter: ~0.0001% accuracy */
417 /* With 4 iterations, more than half results will be exact,
418 * at 6th iterations result stabilizes with about 72% results exact.
419 * We are well satisfied with 0.05% accuracy.
420 */
421
422 return X * invsqrt; /* X * 1/sqrt(X) ~= sqrt(X) */
423}
424static ALWAYS_INLINE double SQRT(double X)
425{
426 /* If this arch doesn't use IEEE 754 floats, fall back to using libm */
427 if (sizeof(float) != 4)
428 return sqrt(X);
429
Denys Vlasenko2d3253d2010-01-03 21:52:46 +0100430 /* This avoids needing libm, saves about 0.5k on x86-32 */
Denys Vlasenkod498ff02010-01-03 21:06:27 +0100431 return my_SQRT(X);
432}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100433
434static double
435gettime1900d(void)
436{
437 struct timeval tv;
438 gettimeofday(&tv, NULL); /* never fails */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100439 G.cur_time = tv.tv_sec + (1.0e-6 * tv.tv_usec) + OFFSET_1900_1970;
440 return G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100441}
442
443static void
444d_to_tv(double d, struct timeval *tv)
445{
446 tv->tv_sec = (long)d;
447 tv->tv_usec = (d - tv->tv_sec) * 1000000;
448}
449
450static double
451lfp_to_d(l_fixedpt_t lfp)
452{
453 double ret;
454 lfp.int_partl = ntohl(lfp.int_partl);
455 lfp.fractionl = ntohl(lfp.fractionl);
456 ret = (double)lfp.int_partl + ((double)lfp.fractionl / UINT_MAX);
457 return ret;
458}
459static double
460sfp_to_d(s_fixedpt_t sfp)
461{
462 double ret;
463 sfp.int_parts = ntohs(sfp.int_parts);
464 sfp.fractions = ntohs(sfp.fractions);
465 ret = (double)sfp.int_parts + ((double)sfp.fractions / USHRT_MAX);
466 return ret;
467}
468#if ENABLE_FEATURE_NTPD_SERVER
469static l_fixedpt_t
470d_to_lfp(double d)
471{
472 l_fixedpt_t lfp;
473 lfp.int_partl = (uint32_t)d;
474 lfp.fractionl = (uint32_t)((d - lfp.int_partl) * UINT_MAX);
475 lfp.int_partl = htonl(lfp.int_partl);
476 lfp.fractionl = htonl(lfp.fractionl);
477 return lfp;
478}
479static s_fixedpt_t
480d_to_sfp(double d)
481{
482 s_fixedpt_t sfp;
483 sfp.int_parts = (uint16_t)d;
484 sfp.fractions = (uint16_t)((d - sfp.int_parts) * USHRT_MAX);
485 sfp.int_parts = htons(sfp.int_parts);
486 sfp.fractions = htons(sfp.fractions);
487 return sfp;
488}
489#endif
490
491static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100492dispersion(const datapoint_t *dp)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100493{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100494 return dp->d_dispersion + FREQ_TOLERANCE * (G.cur_time - dp->d_recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100495}
496
497static double
Denys Vlasenko0b002812010-01-03 08:59:59 +0100498root_distance(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100499{
500 /* The root synchronization distance is the maximum error due to
501 * all causes of the local clock relative to the primary server.
502 * It is defined as half the total delay plus total dispersion
503 * plus peer jitter.
504 */
505 return MAXD(MINDISP, p->lastpkt_rootdelay + p->lastpkt_delay) / 2
506 + p->lastpkt_rootdisp
507 + p->filter_dispersion
Denys Vlasenko0b002812010-01-03 08:59:59 +0100508 + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100509 + p->filter_jitter;
510}
511
512static void
513set_next(peer_t *p, unsigned t)
514{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100515 p->next_action_time = G.cur_time + t;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100516}
517
518/*
519 * Peer clock filter and its helpers
520 */
521static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100522filter_datapoints(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100523{
524 int i, idx;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100525 double sum, wavg;
526 datapoint_t *fdp;
527
528#if 0
529/* Simulations have shown that use of *averaged* offset for p->filter_offset
530 * is in fact worse than simply using last received one: with large poll intervals
531 * (>= 2048) averaging code uses offset values which are outdated by hours,
532 * and time/frequency correction goes totally wrong when fed essentially bogus offsets.
533 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100534 int got_newest;
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100535 double minoff, maxoff, w;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100536 double x = x; /* for compiler */
537 double oldest_off = oldest_off;
538 double oldest_age = oldest_age;
539 double newest_off = newest_off;
540 double newest_age = newest_age;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100541
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100542 fdp = p->filter_datapoint;
543
544 minoff = maxoff = fdp[0].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100545 for (i = 1; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100546 if (minoff > fdp[i].d_offset)
547 minoff = fdp[i].d_offset;
548 if (maxoff < fdp[i].d_offset)
549 maxoff = fdp[i].d_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100550 }
551
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100552 idx = p->datapoint_idx; /* most recent datapoint's index */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100553 /* Average offset:
554 * Drop two outliers and take weighted average of the rest:
555 * most_recent/2 + older1/4 + older2/8 ... + older5/32 + older6/32
556 * we use older6/32, not older6/64 since sum of weights should be 1:
557 * 1/2 + 1/4 + 1/8 + 1/16 + 1/32 + 1/32 = 1
558 */
559 wavg = 0;
560 w = 0.5;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100561 /* n-1
562 * --- dispersion(i)
563 * filter_dispersion = \ -------------
564 * / (i+1)
565 * --- 2
566 * i=0
567 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100568 got_newest = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100569 sum = 0;
570 for (i = 0; i < NUM_DATAPOINTS; i++) {
571 VERB4 {
572 bb_error_msg("datapoint[%d]: off:%f disp:%f(%f) age:%f%s",
573 i,
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100574 fdp[idx].d_offset,
575 fdp[idx].d_dispersion, dispersion(&fdp[idx]),
576 G.cur_time - fdp[idx].d_recv_time,
577 (minoff == fdp[idx].d_offset || maxoff == fdp[idx].d_offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100578 ? " (outlier by offset)" : ""
579 );
580 }
581
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100582 sum += dispersion(&fdp[idx]) / (2 << i);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100583
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100584 if (minoff == fdp[idx].d_offset) {
Denys Vlasenkoe4844b82010-01-01 21:59:49 +0100585 minoff -= 1; /* so that we don't match it ever again */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100586 } else
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100587 if (maxoff == fdp[idx].d_offset) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100588 maxoff += 1;
589 } else {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100590 oldest_off = fdp[idx].d_offset;
591 oldest_age = G.cur_time - fdp[idx].d_recv_time;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100592 if (!got_newest) {
593 got_newest = 1;
594 newest_off = oldest_off;
595 newest_age = oldest_age;
596 }
597 x = oldest_off * w;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100598 wavg += x;
599 w /= 2;
600 }
601
602 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
603 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100604 p->filter_dispersion = sum;
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100605 wavg += x; /* add another older6/64 to form older6/32 */
606 /* Fix systematic underestimation with large poll intervals.
607 * Imagine that we still have a bit of uncorrected drift,
608 * and poll interval is big (say, 100 sec). Offsets form a progression:
609 * 0.0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 - 0.7 is most recent.
610 * The algorithm above drops 0.0 and 0.7 as outliers,
611 * and then we have this estimation, ~25% off from 0.7:
612 * 0.1/32 + 0.2/32 + 0.3/16 + 0.4/8 + 0.5/4 + 0.6/2 = 0.503125
613 */
Denys Vlasenko0b002812010-01-03 08:59:59 +0100614 x = oldest_age - newest_age;
615 if (x != 0) {
616 x = newest_age / x; /* in above example, 100 / (600 - 100) */
617 if (x < 1) { /* paranoia check */
618 x = (newest_off - oldest_off) * x; /* 0.5 * 100/500 = 0.1 */
619 wavg += x;
620 }
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100621 }
622 p->filter_offset = wavg;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100623
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100624#else
625
626 fdp = p->filter_datapoint;
627 idx = p->datapoint_idx; /* most recent datapoint's index */
628
629 /* filter_offset: simply use the most recent value */
630 p->filter_offset = fdp[idx].d_offset;
631
632 /* n-1
633 * --- dispersion(i)
634 * filter_dispersion = \ -------------
635 * / (i+1)
636 * --- 2
637 * i=0
638 */
639 wavg = 0;
640 sum = 0;
641 for (i = 0; i < NUM_DATAPOINTS; i++) {
642 sum += dispersion(&fdp[idx]) / (2 << i);
643 wavg += fdp[idx].d_offset;
644 idx = (idx - 1) & (NUM_DATAPOINTS - 1);
645 }
646 wavg /= NUM_DATAPOINTS;
647 p->filter_dispersion = sum;
648#endif
649
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100650 /* +----- -----+ ^ 1/2
651 * | n-1 |
652 * | --- |
653 * | 1 \ 2 |
654 * filter_jitter = | --- * / (avg-offset_j) |
655 * | n --- |
656 * | j=0 |
657 * +----- -----+
658 * where n is the number of valid datapoints in the filter (n > 1);
659 * if filter_jitter < precision then filter_jitter = precision
660 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100661 sum = 0;
662 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100663 sum += SQUARE(wavg - fdp[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100664 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100665 sum = SQRT(sum / NUM_DATAPOINTS);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100666 p->filter_jitter = sum > G_precision_sec ? sum : G_precision_sec;
667
Denys Vlasenkod98dc922012-03-08 03:27:49 +0100668 VERB3 bb_error_msg("filter offset:%+f disp:%f jitter:%f",
669 p->filter_offset,
Denys Vlasenkod9109e32010-01-02 00:36:43 +0100670 p->filter_dispersion,
671 p->filter_jitter);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100672}
673
674static void
Denys Vlasenko0b002812010-01-03 08:59:59 +0100675reset_peer_stats(peer_t *p, double offset)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100676{
677 int i;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100678 bool small_ofs = fabs(offset) < 16 * STEP_THRESHOLD;
679
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100680 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100681 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200682 p->filter_datapoint[i].d_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100683 if (p->filter_datapoint[i].d_offset != 0) {
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100684 p->filter_datapoint[i].d_offset -= offset;
685 //bb_error_msg("p->filter_datapoint[%d].d_offset %f -> %f",
686 // i,
687 // p->filter_datapoint[i].d_offset + offset,
688 // p->filter_datapoint[i].d_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100689 }
690 } else {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100691 p->filter_datapoint[i].d_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100692 p->filter_datapoint[i].d_offset = 0;
693 p->filter_datapoint[i].d_dispersion = MAXDISP;
694 }
695 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +0100696 if (small_ofs) {
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200697 p->lastpkt_recv_time += offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100698 } else {
Denys Vlasenko0b002812010-01-03 08:59:59 +0100699 p->reachable_bits = 0;
700 p->lastpkt_recv_time = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100701 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100702 filter_datapoints(p); /* recalc p->filter_xxx */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100703 VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
704}
705
706static void
707add_peers(char *s)
708{
709 peer_t *p;
710
711 p = xzalloc(sizeof(*p));
712 p->p_lsa = xhost2sockaddr(s, 123);
713 p->p_dotted = xmalloc_sockaddr2dotted_noport(&p->p_lsa->u.sa);
714 p->p_fd = -1;
715 p->p_xmt_msg.m_status = MODE_CLIENT | (NTP_VERSION << 3);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100716 p->next_action_time = G.cur_time; /* = set_next(p, 0); */
717 reset_peer_stats(p, 16 * STEP_THRESHOLD);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100718
719 llist_add_to(&G.ntp_peers, p);
720 G.peer_cnt++;
721}
722
723static int
724do_sendto(int fd,
725 const struct sockaddr *from, const struct sockaddr *to, socklen_t addrlen,
726 msg_t *msg, ssize_t len)
727{
728 ssize_t ret;
729
730 errno = 0;
731 if (!from) {
732 ret = sendto(fd, msg, len, MSG_DONTWAIT, to, addrlen);
733 } else {
734 ret = send_to_from(fd, msg, len, MSG_DONTWAIT, to, from, addrlen);
735 }
736 if (ret != len) {
737 bb_perror_msg("send failed");
738 return -1;
739 }
740 return 0;
741}
742
Denys Vlasenko0b002812010-01-03 08:59:59 +0100743static void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100744send_query_to_peer(peer_t *p)
745{
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100746 /* Why do we need to bind()?
747 * See what happens when we don't bind:
748 *
749 * socket(PF_INET, SOCK_DGRAM, IPPROTO_IP) = 3
750 * setsockopt(3, SOL_IP, IP_TOS, [16], 4) = 0
751 * gettimeofday({1259071266, 327885}, NULL) = 0
752 * sendto(3, "xxx", 48, MSG_DONTWAIT, {sa_family=AF_INET, sin_port=htons(123), sin_addr=inet_addr("10.34.32.125")}, 16) = 48
753 * ^^^ we sent it from some source port picked by kernel.
754 * time(NULL) = 1259071266
755 * write(2, "ntpd: entering poll 15 secs\n", 28) = 28
756 * poll([{fd=3, events=POLLIN}], 1, 15000) = 1 ([{fd=3, revents=POLLIN}])
757 * recv(3, "yyy", 68, MSG_DONTWAIT) = 48
758 * ^^^ this recv will receive packets to any local port!
759 *
760 * Uncomment this and use strace to see it in action:
761 */
762#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 +0100763
764 if (p->p_fd == -1) {
765 int fd, family;
766 len_and_sockaddr *local_lsa;
767
768 family = p->p_lsa->u.sa.sa_family;
769 p->p_fd = fd = xsocket_type(&local_lsa, family, SOCK_DGRAM);
770 /* local_lsa has "null" address and port 0 now.
771 * bind() ensures we have a *particular port* selected by kernel
772 * and remembered in p->p_fd, thus later recv(p->p_fd)
773 * receives only packets sent to this port.
774 */
775 PROBE_LOCAL_ADDR
776 xbind(fd, &local_lsa->u.sa, local_lsa->len);
777 PROBE_LOCAL_ADDR
778#if ENABLE_FEATURE_IPV6
779 if (family == AF_INET)
780#endif
781 setsockopt(fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
782 free(local_lsa);
783 }
784
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +0100785 /* Emit message _before_ attempted send. Think of a very short
786 * roundtrip networks: we need to go back to recv loop ASAP,
787 * to reduce delay. Printing messages after send works against that.
788 */
789 VERB1 bb_error_msg("sending query to %s", p->p_dotted);
790
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100791 /*
792 * Send out a random 64-bit number as our transmit time. The NTP
793 * server will copy said number into the originate field on the
794 * response that it sends us. This is totally legal per the SNTP spec.
795 *
796 * The impact of this is two fold: we no longer send out the current
797 * system time for the world to see (which may aid an attacker), and
798 * it gives us a (not very secure) way of knowing that we're not
799 * getting spoofed by an attacker that can't capture our traffic
800 * but can spoof packets from the NTP server we're communicating with.
801 *
802 * Save the real transmit timestamp locally.
803 */
804 p->p_xmt_msg.m_xmttime.int_partl = random();
805 p->p_xmt_msg.m_xmttime.fractionl = random();
806 p->p_xmttime = gettime1900d();
807
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200808 /* Were doing it only if sendto worked, but
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +0200809 * loss of sync detection needs reachable_bits updated
810 * even if sending fails *locally*:
811 * "network is unreachable" because cable was pulled?
812 * We still need to declare "unsync" if this condition persists.
813 */
814 p->reachable_bits <<= 1;
815
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100816 if (do_sendto(p->p_fd, /*from:*/ NULL, /*to:*/ &p->p_lsa->u.sa, /*addrlen:*/ p->p_lsa->len,
817 &p->p_xmt_msg, NTP_MSGSIZE_NOAUTH) == -1
818 ) {
819 close(p->p_fd);
820 p->p_fd = -1;
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200821 /*
822 * We know that we sent nothing.
823 * We can retry *soon* without fearing
824 * that we are flooding the peer.
825 */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100826 set_next(p, RETRY_INTERVAL);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100827 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100828 }
829
Denys Vlasenko0b002812010-01-03 08:59:59 +0100830 set_next(p, RESPONSE_INTERVAL);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100831}
832
833
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100834/* Note that there is no provision to prevent several run_scripts
Denys Vlasenko5a7e3372013-05-23 16:06:59 +0200835 * to be started in quick succession. In fact, it happens rather often
Denys Vlasenko24928ff2010-01-25 19:30:16 +0100836 * if initial syncronization results in a step.
837 * You will see "step" and then "stratum" script runs, sometimes
838 * as close as only 0.002 seconds apart.
839 * Script should be ready to deal with this.
840 */
Denys Vlasenko12628b72010-01-11 01:31:59 +0100841static void run_script(const char *action, double offset)
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100842{
843 char *argv[3];
Denys Vlasenko12628b72010-01-11 01:31:59 +0100844 char *env1, *env2, *env3, *env4;
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100845
Denys Vlasenko07c59872013-05-22 18:18:51 +0200846 G.last_script_run = G.cur_time;
847
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100848 if (!G.script_name)
849 return;
850
851 argv[0] = (char*) G.script_name;
852 argv[1] = (char*) action;
853 argv[2] = NULL;
854
855 VERB1 bb_error_msg("executing '%s %s'", G.script_name, action);
856
Denys Vlasenkoae473352010-01-07 11:51:13 +0100857 env1 = xasprintf("%s=%u", "stratum", G.stratum);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100858 putenv(env1);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100859 env2 = xasprintf("%s=%ld", "freq_drift_ppm", G.kernel_freq_drift);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100860 putenv(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100861 env3 = xasprintf("%s=%u", "poll_interval", 1 << G.poll_exp);
862 putenv(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100863 env4 = xasprintf("%s=%f", "offset", offset);
864 putenv(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100865 /* Other items of potential interest: selected peer,
Denys Vlasenkoae473352010-01-07 11:51:13 +0100866 * rootdelay, reftime, rootdisp, refid, ntp_status,
Denys Vlasenko12628b72010-01-11 01:31:59 +0100867 * last_update_offset, last_update_recv_time, discipline_jitter,
868 * how many peers have reachable_bits = 0?
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100869 */
870
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100871 /* Don't want to wait: it may run hwclock --systohc, and that
872 * may take some time (seconds): */
Denys Vlasenko8531d762010-03-18 22:44:00 +0100873 /*spawn_and_wait(argv);*/
Denys Vlasenko6959f6b2010-01-07 08:31:46 +0100874 spawn(argv);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100875
876 unsetenv("stratum");
877 unsetenv("freq_drift_ppm");
Denys Vlasenkoae473352010-01-07 11:51:13 +0100878 unsetenv("poll_interval");
Denys Vlasenko12628b72010-01-11 01:31:59 +0100879 unsetenv("offset");
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100880 free(env1);
881 free(env2);
Denys Vlasenkoae473352010-01-07 11:51:13 +0100882 free(env3);
Denys Vlasenko12628b72010-01-11 01:31:59 +0100883 free(env4);
Denys Vlasenkoede737b2010-01-06 12:27:47 +0100884}
885
Denys Vlasenko0b002812010-01-03 08:59:59 +0100886static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100887step_time(double offset)
888{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100889 llist_t *item;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100890 double dtime;
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100891 struct timeval tvc, tvn;
892 char buf[sizeof("yyyy-mm-dd hh:mm:ss") + /*paranoia:*/ 4];
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100893 time_t tval;
894
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100895 gettimeofday(&tvc, NULL); /* never fails */
896 dtime = tvc.tv_sec + (1.0e-6 * tvc.tv_usec) + offset;
897 d_to_tv(dtime, &tvn);
898 if (settimeofday(&tvn, NULL) == -1)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100899 bb_perror_msg_and_die("settimeofday");
900
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100901 VERB2 {
902 tval = tvc.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100903 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100904 bb_error_msg("current time is %s.%06u", buf, (unsigned)tvc.tv_usec);
905 }
906 tval = tvn.tv_sec;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100907 strftime_YYYYMMDDHHMMSS(buf, sizeof(buf), &tval);
Denys Vlasenkofc4ebd02012-02-28 02:45:00 +0100908 bb_error_msg("setting time to %s.%06u (offset %+fs)", buf, (unsigned)tvn.tv_usec, offset);
Denys Vlasenko0b002812010-01-03 08:59:59 +0100909
910 /* Correct various fields which contain time-relative values: */
911
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200912 /* Globals: */
913 G.cur_time += offset;
914 G.last_update_recv_time += offset;
915 G.last_script_run += offset;
916
Denys Vlasenko0b002812010-01-03 08:59:59 +0100917 /* p->lastpkt_recv_time, p->next_action_time and such: */
918 for (item = G.ntp_peers; item != NULL; item = item->link) {
919 peer_t *pp = (peer_t *) item->data;
920 reset_peer_stats(pp, offset);
Denys Vlasenko16c52a52012-02-23 14:28:47 +0100921 //bb_error_msg("offset:%+f pp->next_action_time:%f -> %f",
Denys Vlasenkoeff6d592010-06-24 20:23:40 +0200922 // offset, pp->next_action_time, pp->next_action_time + offset);
923 pp->next_action_time += offset;
Denys Vlasenko4125a6b2012-06-11 11:41:46 +0200924 if (pp->p_fd >= 0) {
925 /* We wait for reply from this peer too.
926 * But due to step we are doing, reply's data is no longer
927 * useful (in fact, it'll be bogus). Stop waiting for it.
928 */
929 close(pp->p_fd);
930 pp->p_fd = -1;
931 set_next(pp, RETRY_INTERVAL);
932 }
Denys Vlasenko0b002812010-01-03 08:59:59 +0100933 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100934}
935
936
937/*
938 * Selection and clustering, and their helpers
939 */
940typedef struct {
941 peer_t *p;
942 int type;
943 double edge;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +0100944 double opt_rd; /* optimization */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100945} point_t;
946static int
947compare_point_edge(const void *aa, const void *bb)
948{
949 const point_t *a = aa;
950 const point_t *b = bb;
951 if (a->edge < b->edge) {
952 return -1;
953 }
954 return (a->edge > b->edge);
955}
956typedef struct {
957 peer_t *p;
958 double metric;
959} survivor_t;
960static int
961compare_survivor_metric(const void *aa, const void *bb)
962{
963 const survivor_t *a = aa;
964 const survivor_t *b = bb;
Denys Vlasenko510f56a2010-01-03 12:00:26 +0100965 if (a->metric < b->metric) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100966 return -1;
Denys Vlasenko510f56a2010-01-03 12:00:26 +0100967 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100968 return (a->metric > b->metric);
969}
970static int
971fit(peer_t *p, double rd)
972{
Denys Vlasenko0b002812010-01-03 08:59:59 +0100973 if ((p->reachable_bits & (p->reachable_bits-1)) == 0) {
974 /* One or zero bits in reachable_bits */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100975 VERB3 bb_error_msg("peer %s unfit for selection: unreachable", p->p_dotted);
976 return 0;
977 }
Denys Vlasenkofb132e42010-10-29 11:46:52 +0200978#if 0 /* we filter out such packets earlier */
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100979 if ((p->lastpkt_status & LI_ALARM) == LI_ALARM
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100980 || p->lastpkt_stratum >= MAXSTRAT
981 ) {
982 VERB3 bb_error_msg("peer %s unfit for selection: bad status/stratum", p->p_dotted);
983 return 0;
984 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +0100985#endif
Denys Vlasenko0b002812010-01-03 08:59:59 +0100986 /* rd is root_distance(p) */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100987 if (rd > MAXDIST + FREQ_TOLERANCE * (1 << G.poll_exp)) {
988 VERB3 bb_error_msg("peer %s unfit for selection: root distance too high", p->p_dotted);
989 return 0;
990 }
991//TODO
992// /* Do we have a loop? */
993// if (p->refid == p->dstaddr || p->refid == s.refid)
994// return 0;
Denys Vlasenkob7c9fb22011-02-03 00:05:48 +0100995 return 1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100996}
997static peer_t*
Denys Vlasenko0b002812010-01-03 08:59:59 +0100998select_and_cluster(void)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +0100999{
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001000 peer_t *p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001001 llist_t *item;
1002 int i, j;
1003 int size = 3 * G.peer_cnt;
1004 /* for selection algorithm */
1005 point_t point[size];
1006 unsigned num_points, num_candidates;
1007 double low, high;
1008 unsigned num_falsetickers;
1009 /* for cluster algorithm */
1010 survivor_t survivor[size];
1011 unsigned num_survivors;
1012
1013 /* Selection */
1014
1015 num_points = 0;
1016 item = G.ntp_peers;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001017 if (G.initial_poll_complete) while (item != NULL) {
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001018 double rd, offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001019
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001020 p = (peer_t *) item->data;
1021 rd = root_distance(p);
1022 offset = p->filter_offset;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001023 if (!fit(p, rd)) {
1024 item = item->link;
1025 continue;
1026 }
1027
1028 VERB4 bb_error_msg("interval: [%f %f %f] %s",
1029 offset - rd,
1030 offset,
1031 offset + rd,
1032 p->p_dotted
1033 );
1034 point[num_points].p = p;
1035 point[num_points].type = -1;
1036 point[num_points].edge = offset - rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001037 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001038 num_points++;
1039 point[num_points].p = p;
1040 point[num_points].type = 0;
1041 point[num_points].edge = offset;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001042 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001043 num_points++;
1044 point[num_points].p = p;
1045 point[num_points].type = 1;
1046 point[num_points].edge = offset + rd;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001047 point[num_points].opt_rd = rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001048 num_points++;
1049 item = item->link;
1050 }
1051 num_candidates = num_points / 3;
1052 if (num_candidates == 0) {
1053 VERB3 bb_error_msg("no valid datapoints, no peer selected");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001054 return NULL;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001055 }
1056//TODO: sorting does not seem to be done in reference code
1057 qsort(point, num_points, sizeof(point[0]), compare_point_edge);
1058
1059 /* Start with the assumption that there are no falsetickers.
1060 * Attempt to find a nonempty intersection interval containing
1061 * the midpoints of all truechimers.
1062 * If a nonempty interval cannot be found, increase the number
1063 * of assumed falsetickers by one and try again.
1064 * If a nonempty interval is found and the number of falsetickers
1065 * is less than the number of truechimers, a majority has been found
1066 * and the midpoint of each truechimer represents
1067 * the candidates available to the cluster algorithm.
1068 */
1069 num_falsetickers = 0;
1070 while (1) {
1071 int c;
1072 unsigned num_midpoints = 0;
1073
1074 low = 1 << 9;
1075 high = - (1 << 9);
1076 c = 0;
1077 for (i = 0; i < num_points; i++) {
1078 /* We want to do:
1079 * if (point[i].type == -1) c++;
1080 * if (point[i].type == 1) c--;
1081 * and it's simpler to do it this way:
1082 */
1083 c -= point[i].type;
1084 if (c >= num_candidates - num_falsetickers) {
1085 /* If it was c++ and it got big enough... */
1086 low = point[i].edge;
1087 break;
1088 }
1089 if (point[i].type == 0)
1090 num_midpoints++;
1091 }
1092 c = 0;
1093 for (i = num_points-1; i >= 0; i--) {
1094 c += point[i].type;
1095 if (c >= num_candidates - num_falsetickers) {
1096 high = point[i].edge;
1097 break;
1098 }
1099 if (point[i].type == 0)
1100 num_midpoints++;
1101 }
1102 /* If the number of midpoints is greater than the number
1103 * of allowed falsetickers, the intersection contains at
1104 * least one truechimer with no midpoint - bad.
1105 * Also, interval should be nonempty.
1106 */
1107 if (num_midpoints <= num_falsetickers && low < high)
1108 break;
1109 num_falsetickers++;
1110 if (num_falsetickers * 2 >= num_candidates) {
1111 VERB3 bb_error_msg("too many falsetickers:%d (candidates:%d), no peer selected",
1112 num_falsetickers, num_candidates);
1113 return NULL;
1114 }
1115 }
1116 VERB3 bb_error_msg("selected interval: [%f, %f]; candidates:%d falsetickers:%d",
1117 low, high, num_candidates, num_falsetickers);
1118
1119 /* Clustering */
1120
1121 /* Construct a list of survivors (p, metric)
1122 * from the chime list, where metric is dominated
1123 * first by stratum and then by root distance.
1124 * All other things being equal, this is the order of preference.
1125 */
1126 num_survivors = 0;
1127 for (i = 0; i < num_points; i++) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001128 if (point[i].edge < low || point[i].edge > high)
1129 continue;
1130 p = point[i].p;
1131 survivor[num_survivors].p = p;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001132 /* x.opt_rd == root_distance(p); */
1133 survivor[num_survivors].metric = MAXDIST * p->lastpkt_stratum + point[i].opt_rd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001134 VERB4 bb_error_msg("survivor[%d] metric:%f peer:%s",
1135 num_survivors, survivor[num_survivors].metric, p->p_dotted);
1136 num_survivors++;
1137 }
1138 /* There must be at least MIN_SELECTED survivors to satisfy the
1139 * correctness assertions. Ordinarily, the Byzantine criteria
1140 * require four survivors, but for the demonstration here, one
1141 * is acceptable.
1142 */
1143 if (num_survivors < MIN_SELECTED) {
1144 VERB3 bb_error_msg("num_survivors %d < %d, no peer selected",
1145 num_survivors, MIN_SELECTED);
1146 return NULL;
1147 }
1148
1149//looks like this is ONLY used by the fact that later we pick survivor[0].
1150//we can avoid sorting then, just find the minimum once!
1151 qsort(survivor, num_survivors, sizeof(survivor[0]), compare_survivor_metric);
1152
1153 /* For each association p in turn, calculate the selection
1154 * jitter p->sjitter as the square root of the sum of squares
1155 * (p->offset - q->offset) over all q associations. The idea is
1156 * to repeatedly discard the survivor with maximum selection
1157 * jitter until a termination condition is met.
1158 */
1159 while (1) {
1160 unsigned max_idx = max_idx;
1161 double max_selection_jitter = max_selection_jitter;
1162 double min_jitter = min_jitter;
1163
1164 if (num_survivors <= MIN_CLUSTERED) {
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001165 VERB3 bb_error_msg("num_survivors %d <= %d, not discarding more",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001166 num_survivors, MIN_CLUSTERED);
1167 break;
1168 }
1169
1170 /* To make sure a few survivors are left
1171 * for the clustering algorithm to chew on,
1172 * we stop if the number of survivors
1173 * is less than or equal to MIN_CLUSTERED (3).
1174 */
1175 for (i = 0; i < num_survivors; i++) {
1176 double selection_jitter_sq;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001177
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001178 p = survivor[i].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001179 if (i == 0 || p->filter_jitter < min_jitter)
1180 min_jitter = p->filter_jitter;
1181
1182 selection_jitter_sq = 0;
1183 for (j = 0; j < num_survivors; j++) {
1184 peer_t *q = survivor[j].p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001185 selection_jitter_sq += SQUARE(p->filter_offset - q->filter_offset);
1186 }
1187 if (i == 0 || selection_jitter_sq > max_selection_jitter) {
1188 max_selection_jitter = selection_jitter_sq;
1189 max_idx = i;
1190 }
1191 VERB5 bb_error_msg("survivor %d selection_jitter^2:%f",
1192 i, selection_jitter_sq);
1193 }
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001194 max_selection_jitter = SQRT(max_selection_jitter / num_survivors);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001195 VERB4 bb_error_msg("max_selection_jitter (at %d):%f min_jitter:%f",
1196 max_idx, max_selection_jitter, min_jitter);
1197
1198 /* If the maximum selection jitter is less than the
1199 * minimum peer jitter, then tossing out more survivors
1200 * will not lower the minimum peer jitter, so we might
1201 * as well stop.
1202 */
1203 if (max_selection_jitter < min_jitter) {
1204 VERB3 bb_error_msg("max_selection_jitter:%f < min_jitter:%f, num_survivors:%d, not discarding more",
1205 max_selection_jitter, min_jitter, num_survivors);
1206 break;
1207 }
1208
1209 /* Delete survivor[max_idx] from the list
1210 * and go around again.
1211 */
1212 VERB5 bb_error_msg("dropping survivor %d", max_idx);
1213 num_survivors--;
1214 while (max_idx < num_survivors) {
1215 survivor[max_idx] = survivor[max_idx + 1];
1216 max_idx++;
1217 }
1218 }
1219
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001220 if (0) {
1221 /* Combine the offsets of the clustering algorithm survivors
1222 * using a weighted average with weight determined by the root
1223 * distance. Compute the selection jitter as the weighted RMS
1224 * difference between the first survivor and the remaining
1225 * survivors. In some cases the inherent clock jitter can be
1226 * reduced by not using this algorithm, especially when frequent
1227 * clockhopping is involved. bbox: thus we don't do it.
1228 */
1229 double x, y, z, w;
1230 y = z = w = 0;
1231 for (i = 0; i < num_survivors; i++) {
1232 p = survivor[i].p;
1233 x = root_distance(p);
1234 y += 1 / x;
1235 z += p->filter_offset / x;
1236 w += SQUARE(p->filter_offset - survivor[0].p->filter_offset) / x;
1237 }
1238 //G.cluster_offset = z / y;
1239 //G.cluster_jitter = SQRT(w / y);
1240 }
1241
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001242 /* Pick the best clock. If the old system peer is on the list
1243 * and at the same stratum as the first survivor on the list,
1244 * then don't do a clock hop. Otherwise, select the first
1245 * survivor on the list as the new system peer.
1246 */
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001247 p = survivor[0].p;
1248 if (G.last_update_peer
1249 && G.last_update_peer->lastpkt_stratum <= p->lastpkt_stratum
1250 ) {
1251 /* Starting from 1 is ok here */
1252 for (i = 1; i < num_survivors; i++) {
1253 if (G.last_update_peer == survivor[i].p) {
1254 VERB4 bb_error_msg("keeping old synced peer");
1255 p = G.last_update_peer;
1256 goto keep_old;
1257 }
1258 }
1259 }
1260 G.last_update_peer = p;
1261 keep_old:
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001262 VERB3 bb_error_msg("selected peer %s filter_offset:%+f age:%f",
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001263 p->p_dotted,
1264 p->filter_offset,
1265 G.cur_time - p->lastpkt_recv_time
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001266 );
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001267 return p;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001268}
1269
1270
1271/*
1272 * Local clock discipline and its helpers
1273 */
1274static void
1275set_new_values(int disc_state, double offset, double recv_time)
1276{
1277 /* Enter new state and set state variables. Note we use the time
1278 * of the last clock filter sample, which must be earlier than
1279 * the current time.
1280 */
Denys Vlasenkod9109e32010-01-02 00:36:43 +01001281 VERB3 bb_error_msg("disc_state=%d last update offset=%f recv_time=%f",
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001282 disc_state, offset, recv_time);
1283 G.discipline_state = disc_state;
1284 G.last_update_offset = offset;
1285 G.last_update_recv_time = recv_time;
1286}
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001287/* Return: -1: decrease poll interval, 0: leave as is, 1: increase */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001288static NOINLINE int
1289update_local_clock(peer_t *p)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001290{
1291 int rc;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001292 struct timex tmx;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001293 /* Note: can use G.cluster_offset instead: */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001294 double offset = p->filter_offset;
1295 double recv_time = p->lastpkt_recv_time;
1296 double abs_offset;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001297#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001298 double freq_drift;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001299#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001300 double since_last_update;
1301 double etemp, dtemp;
1302
1303 abs_offset = fabs(offset);
1304
Denys Vlasenko12628b72010-01-11 01:31:59 +01001305#if 0
Denys Vlasenko24928ff2010-01-25 19:30:16 +01001306 /* If needed, -S script can do it by looking at $offset
1307 * env var and killing parent */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001308 /* If the offset is too large, give up and go home */
1309 if (abs_offset > PANIC_THRESHOLD) {
1310 bb_error_msg_and_die("offset %f far too big, exiting", offset);
1311 }
Denys Vlasenko12628b72010-01-11 01:31:59 +01001312#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001313
1314 /* If this is an old update, for instance as the result
1315 * of a system peer change, avoid it. We never use
1316 * an old sample or the same sample twice.
1317 */
1318 if (recv_time <= G.last_update_recv_time) {
1319 VERB3 bb_error_msg("same or older datapoint: %f >= %f, not using it",
1320 G.last_update_recv_time, recv_time);
1321 return 0; /* "leave poll interval as is" */
1322 }
1323
1324 /* Clock state machine transition function. This is where the
1325 * action is and defines how the system reacts to large time
1326 * and frequency errors.
1327 */
1328 since_last_update = recv_time - G.reftime;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001329#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001330 freq_drift = 0;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001331#endif
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001332#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001333 if (G.discipline_state == STATE_FREQ) {
1334 /* Ignore updates until the stepout threshold */
1335 if (since_last_update < WATCH_THRESHOLD) {
1336 VERB3 bb_error_msg("measuring drift, datapoint ignored, %f sec remains",
1337 WATCH_THRESHOLD - since_last_update);
1338 return 0; /* "leave poll interval as is" */
1339 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001340# if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001341 freq_drift = (offset - G.last_update_offset) / since_last_update;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001342# endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001343 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001344#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001345
1346 /* There are two main regimes: when the
1347 * offset exceeds the step threshold and when it does not.
1348 */
1349 if (abs_offset > STEP_THRESHOLD) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001350 switch (G.discipline_state) {
1351 case STATE_SYNC:
1352 /* The first outlyer: ignore it, switch to SPIK state */
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001353 VERB3 bb_error_msg("offset:%+f - spike detected", offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001354 G.discipline_state = STATE_SPIK;
1355 return -1; /* "decrease poll interval" */
1356
1357 case STATE_SPIK:
1358 /* Ignore succeeding outlyers until either an inlyer
1359 * is found or the stepout threshold is exceeded.
1360 */
1361 if (since_last_update < WATCH_THRESHOLD) {
1362 VERB3 bb_error_msg("spike detected, datapoint ignored, %f sec remains",
1363 WATCH_THRESHOLD - since_last_update);
1364 return -1; /* "decrease poll interval" */
1365 }
1366 /* fall through: we need to step */
1367 } /* switch */
1368
1369 /* Step the time and clamp down the poll interval.
1370 *
1371 * In NSET state an initial frequency correction is
1372 * not available, usually because the frequency file has
1373 * not yet been written. Since the time is outside the
1374 * capture range, the clock is stepped. The frequency
1375 * will be set directly following the stepout interval.
1376 *
1377 * In FSET state the initial frequency has been set
1378 * from the frequency file. Since the time is outside
1379 * the capture range, the clock is stepped immediately,
1380 * rather than after the stepout interval. Guys get
1381 * nervous if it takes 17 minutes to set the clock for
1382 * the first time.
1383 *
1384 * In SPIK state the stepout threshold has expired and
1385 * the phase is still above the step threshold. Note
1386 * that a single spike greater than the step threshold
1387 * is always suppressed, even at the longer poll
1388 * intervals.
1389 */
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001390 VERB3 bb_error_msg("stepping time by %+f; poll_exp=MINPOLL", offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001391 step_time(offset);
1392 if (option_mask32 & OPT_q) {
1393 /* We were only asked to set time once. Done. */
1394 exit(0);
1395 }
1396
1397 G.polladj_count = 0;
1398 G.poll_exp = MINPOLL;
1399 G.stratum = MAXSTRAT;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001400
Denys Vlasenko12628b72010-01-11 01:31:59 +01001401 run_script("step", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001402
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001403#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001404 if (G.discipline_state == STATE_NSET) {
1405 set_new_values(STATE_FREQ, /*offset:*/ 0, recv_time);
1406 return 1; /* "ok to increase poll interval" */
1407 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001408#endif
Denys Vlasenko547ee792012-03-05 10:18:00 +01001409 abs_offset = offset = 0;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001410 set_new_values(STATE_SYNC, offset, recv_time);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001411
1412 } else { /* abs_offset <= STEP_THRESHOLD */
1413
Denys Vlasenko0b002812010-01-03 08:59:59 +01001414 if (G.poll_exp < MINPOLL && G.initial_poll_complete) {
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001415 VERB3 bb_error_msg("small offset:%+f, disabling burst mode", offset);
Denys Vlasenko0b002812010-01-03 08:59:59 +01001416 G.polladj_count = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001417 G.poll_exp = MINPOLL;
1418 }
1419
1420 /* Compute the clock jitter as the RMS of exponentially
1421 * weighted offset differences. Used by the poll adjust code.
1422 */
1423 etemp = SQUARE(G.discipline_jitter);
Denys Vlasenko74584b82012-03-02 01:22:40 +01001424 dtemp = SQUARE(offset - G.last_update_offset);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001425 G.discipline_jitter = SQRT(etemp + (dtemp - etemp) / AVG);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001426
1427 switch (G.discipline_state) {
1428 case STATE_NSET:
1429 if (option_mask32 & OPT_q) {
1430 /* We were only asked to set time once.
1431 * The clock is precise enough, no need to step.
1432 */
1433 exit(0);
1434 }
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001435#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001436 /* This is the first update received and the frequency
1437 * has not been initialized. The first thing to do
1438 * is directly measure the oscillator frequency.
1439 */
1440 set_new_values(STATE_FREQ, offset, recv_time);
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001441#else
1442 set_new_values(STATE_SYNC, offset, recv_time);
1443#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001444 VERB3 bb_error_msg("transitioning to FREQ, datapoint ignored");
Denys Vlasenko0b002812010-01-03 08:59:59 +01001445 return 0; /* "leave poll interval as is" */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001446
1447#if 0 /* this is dead code for now */
1448 case STATE_FSET:
1449 /* This is the first update and the frequency
1450 * has been initialized. Adjust the phase, but
1451 * don't adjust the frequency until the next update.
1452 */
1453 set_new_values(STATE_SYNC, offset, recv_time);
1454 /* freq_drift remains 0 */
1455 break;
1456#endif
1457
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001458#if USING_INITIAL_FREQ_ESTIMATION
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001459 case STATE_FREQ:
1460 /* since_last_update >= WATCH_THRESHOLD, we waited enough.
1461 * Correct the phase and frequency and switch to SYNC state.
1462 * freq_drift was already estimated (see code above)
1463 */
1464 set_new_values(STATE_SYNC, offset, recv_time);
1465 break;
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001466#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001467
1468 default:
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001469#if !USING_KERNEL_PLL_LOOP
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001470 /* Compute freq_drift due to PLL and FLL contributions.
1471 *
1472 * The FLL and PLL frequency gain constants
1473 * depend on the poll interval and Allan
1474 * intercept. The FLL is not used below one-half
1475 * the Allan intercept. Above that the loop gain
1476 * increases in steps to 1 / AVG.
1477 */
1478 if ((1 << G.poll_exp) > ALLAN / 2) {
1479 etemp = FLL - G.poll_exp;
1480 if (etemp < AVG)
1481 etemp = AVG;
1482 freq_drift += (offset - G.last_update_offset) / (MAXD(since_last_update, ALLAN) * etemp);
1483 }
1484 /* For the PLL the integration interval
1485 * (numerator) is the minimum of the update
1486 * interval and poll interval. This allows
1487 * oversampling, but not undersampling.
1488 */
1489 etemp = MIND(since_last_update, (1 << G.poll_exp));
1490 dtemp = (4 * PLL) << G.poll_exp;
1491 freq_drift += offset * etemp / SQUARE(dtemp);
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001492#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001493 set_new_values(STATE_SYNC, offset, recv_time);
1494 break;
1495 }
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001496 if (G.stratum != p->lastpkt_stratum + 1) {
1497 G.stratum = p->lastpkt_stratum + 1;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001498 run_script("stratum", offset);
Denys Vlasenkoede737b2010-01-06 12:27:47 +01001499 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001500 }
1501
Denys Vlasenko547ee792012-03-05 10:18:00 +01001502 if (G.discipline_jitter < G_precision_sec)
1503 G.discipline_jitter = G_precision_sec;
1504 G.offset_to_jitter_ratio = abs_offset / G.discipline_jitter;
1505
Denys Vlasenko0b002812010-01-03 08:59:59 +01001506 G.reftime = G.cur_time;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001507 G.ntp_status = p->lastpkt_status;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001508 G.refid = p->lastpkt_refid;
1509 G.rootdelay = p->lastpkt_rootdelay + p->lastpkt_delay;
Denys Vlasenko9b20adc2010-01-17 02:51:33 +01001510 dtemp = p->filter_jitter; // SQRT(SQUARE(p->filter_jitter) + SQUARE(G.cluster_jitter));
Denys Vlasenko0b002812010-01-03 08:59:59 +01001511 dtemp += MAXD(p->filter_dispersion + FREQ_TOLERANCE * (G.cur_time - p->lastpkt_recv_time) + abs_offset, MINDISP);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001512 G.rootdisp = p->lastpkt_rootdisp + dtemp;
1513 VERB3 bb_error_msg("updating leap/refid/reftime/rootdisp from peer %s", p->p_dotted);
1514
1515 /* We are in STATE_SYNC now, but did not do adjtimex yet.
1516 * (Any other state does not reach this, they all return earlier)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001517 * By this time, freq_drift and offset are set
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001518 * to values suitable for adjtimex.
Denys Vlasenko61313112010-01-01 19:56:16 +01001519 */
1520#if !USING_KERNEL_PLL_LOOP
1521 /* Calculate the new frequency drift and frequency stability (wander).
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001522 * Compute the clock wander as the RMS of exponentially weighted
1523 * frequency differences. This is not used directly, but can,
1524 * along with the jitter, be a highly useful monitoring and
1525 * debugging tool.
1526 */
1527 dtemp = G.discipline_freq_drift + freq_drift;
Denys Vlasenko61313112010-01-01 19:56:16 +01001528 G.discipline_freq_drift = MAXD(MIND(MAXDRIFT, dtemp), -MAXDRIFT);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001529 etemp = SQUARE(G.discipline_wander);
1530 dtemp = SQUARE(dtemp);
1531 G.discipline_wander = SQRT(etemp + (dtemp - etemp) / AVG);
1532
Denys Vlasenko61313112010-01-01 19:56:16 +01001533 VERB3 bb_error_msg("discipline freq_drift=%.9f(int:%ld corr:%e) wander=%f",
1534 G.discipline_freq_drift,
1535 (long)(G.discipline_freq_drift * 65536e6),
1536 freq_drift,
1537 G.discipline_wander);
1538#endif
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001539 VERB3 {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001540 memset(&tmx, 0, sizeof(tmx));
1541 if (adjtimex(&tmx) < 0)
1542 bb_perror_msg_and_die("adjtimex");
Denys Vlasenko8be49c32012-03-06 19:16:50 +01001543 bb_error_msg("p adjtimex freq:%ld offset:%+ld status:0x%x tc:%ld",
1544 tmx.freq, tmx.offset, tmx.status, tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001545 }
1546
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001547 memset(&tmx, 0, sizeof(tmx));
1548#if 0
Denys Vlasenko61313112010-01-01 19:56:16 +01001549//doesn't work, offset remains 0 (!) in kernel:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001550//ntpd: set adjtimex freq:1786097 tmx.offset:77487
1551//ntpd: prev adjtimex freq:1786097 tmx.offset:0
1552//ntpd: cur adjtimex freq:1786097 tmx.offset:0
1553 tmx.modes = ADJ_FREQUENCY | ADJ_OFFSET;
1554 /* 65536 is one ppm */
1555 tmx.freq = G.discipline_freq_drift * 65536e6;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001556#endif
1557 tmx.modes = ADJ_OFFSET | ADJ_STATUS | ADJ_TIMECONST;// | ADJ_MAXERROR | ADJ_ESTERROR;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001558 tmx.offset = (offset * 1000000); /* usec */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001559 tmx.status = STA_PLL;
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001560 if (G.ntp_status & LI_PLUSSEC)
1561 tmx.status |= STA_INS;
1562 if (G.ntp_status & LI_MINUSSEC)
1563 tmx.status |= STA_DEL;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001564
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001565 tmx.constant = G.poll_exp - 4;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001566 /* EXPERIMENTAL.
1567 * The below if statement should be unnecessary, but...
1568 * It looks like Linux kernel's PLL is far too gentle in changing
1569 * tmx.freq in response to clock offset. Offset keeps growing
1570 * and eventually we fall back to smaller poll intervals.
1571 * We can make correction more agressive (about x2) by supplying
1572 * PLL time constant which is one less than the real one.
1573 * To be on a safe side, let's do it only if offset is significantly
1574 * larger than jitter.
1575 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001576 if (tmx.constant > 0 && G.offset_to_jitter_ratio >= TIMECONST_HACK_GATE)
Denys Vlasenko132b0442012-03-05 00:51:48 +01001577 tmx.constant--;
1578
1579 //tmx.esterror = (uint32_t)(clock_jitter * 1e6);
1580 //tmx.maxerror = (uint32_t)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001581 rc = adjtimex(&tmx);
1582 if (rc < 0)
1583 bb_perror_msg_and_die("adjtimex");
Denys Vlasenkod9109e32010-01-02 00:36:43 +01001584 /* NB: here kernel returns constant == G.poll_exp, not == G.poll_exp - 4.
1585 * Not sure why. Perhaps it is normal.
1586 */
Denys Vlasenko132b0442012-03-05 00:51:48 +01001587 VERB3 bb_error_msg("adjtimex:%d freq:%ld offset:%+ld status:0x%x",
1588 rc, tmx.freq, tmx.offset, tmx.status);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001589 G.kernel_freq_drift = tmx.freq / 65536;
Denys Vlasenko547ee792012-03-05 10:18:00 +01001590 VERB2 bb_error_msg("update from:%s offset:%+f jitter:%f clock drift:%+.3fppm tc:%d",
Denys Vlasenko132b0442012-03-05 00:51:48 +01001591 p->p_dotted, offset, G.discipline_jitter, (double)tmx.freq / 65536, (int)tmx.constant);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001592
1593 return 1; /* "ok to increase poll interval" */
1594}
1595
1596
1597/*
1598 * We've got a new reply packet from a peer, process it
1599 * (helpers first)
1600 */
1601static unsigned
1602retry_interval(void)
1603{
1604 /* Local problem, want to retry soon */
1605 unsigned interval, r;
1606 interval = RETRY_INTERVAL;
1607 r = random();
1608 interval += r % (unsigned)(RETRY_INTERVAL / 4);
1609 VERB3 bb_error_msg("chose retry interval:%u", interval);
1610 return interval;
1611}
1612static unsigned
Denys Vlasenko0b002812010-01-03 08:59:59 +01001613poll_interval(int exponent)
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001614{
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001615 unsigned interval, r;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001616 exponent = G.poll_exp + exponent;
1617 if (exponent < 0)
1618 exponent = 0;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001619 interval = 1 << exponent;
1620 r = random();
1621 interval += ((r & (interval-1)) >> 4) + ((r >> 8) & 1); /* + 1/16 of interval, max */
1622 VERB3 bb_error_msg("chose poll interval:%u (poll_exp:%d exp:%d)", interval, G.poll_exp, exponent);
1623 return interval;
1624}
Denys Vlasenko0b002812010-01-03 08:59:59 +01001625static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001626recv_and_process_peer_pkt(peer_t *p)
1627{
1628 int rc;
1629 ssize_t size;
1630 msg_t msg;
1631 double T1, T2, T3, T4;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001632 double dv;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001633 unsigned interval;
1634 datapoint_t *datapoint;
1635 peer_t *q;
1636
1637 /* We can recvfrom here and check from.IP, but some multihomed
1638 * ntp servers reply from their *other IP*.
1639 * TODO: maybe we should check at least what we can: from.port == 123?
1640 */
1641 size = recv(p->p_fd, &msg, sizeof(msg), MSG_DONTWAIT);
1642 if (size == -1) {
1643 bb_perror_msg("recv(%s) error", p->p_dotted);
1644 if (errno == EHOSTUNREACH || errno == EHOSTDOWN
1645 || errno == ENETUNREACH || errno == ENETDOWN
1646 || errno == ECONNREFUSED || errno == EADDRNOTAVAIL
1647 || errno == EAGAIN
1648 ) {
1649//TODO: always do this?
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001650 interval = retry_interval();
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001651 goto set_next_and_ret;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001652 }
1653 xfunc_die();
1654 }
1655
1656 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1657 bb_error_msg("malformed packet received from %s", p->p_dotted);
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001658 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001659 }
1660
1661 if (msg.m_orgtime.int_partl != p->p_xmt_msg.m_xmttime.int_partl
1662 || msg.m_orgtime.fractionl != p->p_xmt_msg.m_xmttime.fractionl
1663 ) {
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001664 /* Somebody else's packet */
1665 return;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001666 }
1667
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001668 /* We do not expect any more packets from this peer for now.
1669 * Closing the socket informs kernel about it.
1670 * We open a new socket when we send a new query.
1671 */
1672 close(p->p_fd);
1673 p->p_fd = -1;
1674
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001675 if ((msg.m_status & LI_ALARM) == LI_ALARM
1676 || msg.m_stratum == 0
1677 || msg.m_stratum > NTP_MAXSTRATUM
1678 ) {
1679// TODO: stratum 0 responses may have commands in 32-bit m_refid field:
1680// "DENY", "RSTR" - peer does not like us at all
1681// "RATE" - peer is overloaded, reduce polling freq
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001682 bb_error_msg("reply from %s: peer is unsynced", p->p_dotted);
1683 goto pick_normal_interval;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001684 }
1685
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001686// /* Verify valid root distance */
1687// if (msg.m_rootdelay / 2 + msg.m_rootdisp >= MAXDISP || p->lastpkt_reftime > msg.m_xmt)
1688// return; /* invalid header values */
1689
Denys Vlasenko1ee5afd2010-01-02 15:57:07 +01001690 p->lastpkt_status = msg.m_status;
1691 p->lastpkt_stratum = msg.m_stratum;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001692 p->lastpkt_rootdelay = sfp_to_d(msg.m_rootdelay);
1693 p->lastpkt_rootdisp = sfp_to_d(msg.m_rootdisp);
1694 p->lastpkt_refid = msg.m_refid;
1695
1696 /*
1697 * From RFC 2030 (with a correction to the delay math):
1698 *
1699 * Timestamp Name ID When Generated
1700 * ------------------------------------------------------------
1701 * Originate Timestamp T1 time request sent by client
1702 * Receive Timestamp T2 time request received by server
1703 * Transmit Timestamp T3 time reply sent by server
1704 * Destination Timestamp T4 time reply received by client
1705 *
1706 * The roundtrip delay and local clock offset are defined as
1707 *
1708 * delay = (T4 - T1) - (T3 - T2); offset = ((T2 - T1) + (T3 - T4)) / 2
1709 */
1710 T1 = p->p_xmttime;
1711 T2 = lfp_to_d(msg.m_rectime);
1712 T3 = lfp_to_d(msg.m_xmttime);
Denys Vlasenko0b002812010-01-03 08:59:59 +01001713 T4 = G.cur_time;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001714
1715 p->lastpkt_recv_time = T4;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001716 VERB5 bb_error_msg("%s->lastpkt_recv_time=%f", p->p_dotted, p->lastpkt_recv_time);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001717
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001718 /* The delay calculation is a special case. In cases where the
1719 * server and client clocks are running at different rates and
1720 * with very fast networks, the delay can appear negative. In
1721 * order to avoid violating the Principle of Least Astonishment,
1722 * the delay is clamped not less than the system precision.
1723 */
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001724 dv = p->lastpkt_delay;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001725 p->lastpkt_delay = (T4 - T1) - (T3 - T2);
Denys Vlasenkoa9aaeda2010-01-01 22:23:27 +01001726 if (p->lastpkt_delay < G_precision_sec)
1727 p->lastpkt_delay = G_precision_sec;
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001728 /*
1729 * If this packet's delay is much bigger than the last one,
1730 * it's better to just ignore it than use its much less precise value.
1731 */
1732 if (p->reachable_bits && p->lastpkt_delay > dv * BAD_DELAY_GROWTH) {
1733 bb_error_msg("reply from %s: delay %f is too high, ignoring", p->p_dotted, p->lastpkt_delay);
1734 goto pick_normal_interval;
1735 }
1736
1737 p->datapoint_idx = p->reachable_bits ? (p->datapoint_idx + 1) % NUM_DATAPOINTS : 0;
1738 datapoint = &p->filter_datapoint[p->datapoint_idx];
1739 datapoint->d_recv_time = T4;
1740 datapoint->d_offset = ((T2 - T1) + (T3 - T4)) / 2;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001741 datapoint->d_dispersion = LOG2D(msg.m_precision_exp) + G_precision_sec;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001742 if (!p->reachable_bits) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001743 /* 1st datapoint ever - replicate offset in every element */
1744 int i;
Denys Vlasenko132b0442012-03-05 00:51:48 +01001745 for (i = 0; i < NUM_DATAPOINTS; i++) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001746 p->filter_datapoint[i].d_offset = datapoint->d_offset;
1747 }
1748 }
1749
Denys Vlasenko0b002812010-01-03 08:59:59 +01001750 p->reachable_bits |= 1;
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01001751 if ((MAX_VERBOSE && G.verbose) || (option_mask32 & OPT_w)) {
Denys Vlasenko79bec062012-03-08 13:02:52 +01001752 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 +01001753 p->p_dotted,
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001754 datapoint->d_offset,
1755 p->lastpkt_delay,
1756 p->lastpkt_status,
1757 p->lastpkt_stratum,
1758 p->lastpkt_refid,
Denys Vlasenkod98dc922012-03-08 03:27:49 +01001759 p->lastpkt_rootdelay,
1760 p->reachable_bits
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001761 /* not shown: m_ppoll, m_precision_exp, m_rootdisp,
1762 * m_reftime, m_orgtime, m_rectime, m_xmttime
1763 */
1764 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001765 }
1766
1767 /* Muck with statictics and update the clock */
Denys Vlasenko0b002812010-01-03 08:59:59 +01001768 filter_datapoints(p);
1769 q = select_and_cluster();
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001770 rc = -1;
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001771 if (q) {
1772 rc = 0;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001773 if (!(option_mask32 & OPT_w)) {
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001774 rc = update_local_clock(q);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001775 /* If drift is dangerously large, immediately
1776 * drop poll interval one step down.
1777 */
Denys Vlasenko5b9a9102010-01-17 01:05:58 +01001778 if (fabs(q->filter_offset) >= POLLDOWN_OFFSET) {
Denys Vlasenko16c52a52012-02-23 14:28:47 +01001779 VERB3 bb_error_msg("offset:%+f > POLLDOWN_OFFSET", q->filter_offset);
Denys Vlasenko12628b72010-01-11 01:31:59 +01001780 goto poll_down;
1781 }
1782 }
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001783 }
Denys Vlasenko12628b72010-01-11 01:31:59 +01001784 /* else: no peer selected, rc = -1: we want to poll more often */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001785
1786 if (rc != 0) {
1787 /* Adjust the poll interval by comparing the current offset
1788 * with the clock jitter. If the offset is less than
1789 * the clock jitter times a constant, then the averaging interval
1790 * is increased, otherwise it is decreased. A bit of hysteresis
1791 * helps calm the dance. Works best using burst mode.
1792 */
Denys Vlasenko547ee792012-03-05 10:18:00 +01001793 if (rc > 0 && G.offset_to_jitter_ratio <= POLLADJ_GATE) {
Denys Vlasenkobfc2a322010-01-01 18:12:06 +01001794 /* was += G.poll_exp but it is a bit
1795 * too optimistic for my taste at high poll_exp's */
1796 G.polladj_count += MINPOLL;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001797 if (G.polladj_count > POLLADJ_LIMIT) {
1798 G.polladj_count = 0;
1799 if (G.poll_exp < MAXPOLL) {
1800 G.poll_exp++;
1801 VERB3 bb_error_msg("polladj: discipline_jitter:%f ++poll_exp=%d",
1802 G.discipline_jitter, G.poll_exp);
1803 }
1804 } else {
1805 VERB3 bb_error_msg("polladj: incr:%d", G.polladj_count);
1806 }
1807 } else {
1808 G.polladj_count -= G.poll_exp * 2;
Denys Vlasenko12628b72010-01-11 01:31:59 +01001809 if (G.polladj_count < -POLLADJ_LIMIT || G.poll_exp >= BIGPOLL) {
1810 poll_down:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001811 G.polladj_count = 0;
1812 if (G.poll_exp > MINPOLL) {
Denys Vlasenko2e36eb82010-01-02 01:50:16 +01001813 llist_t *item;
1814
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001815 G.poll_exp--;
Denys Vlasenko2e36eb82010-01-02 01:50:16 +01001816 /* Correct p->next_action_time in each peer
1817 * which waits for sending, so that they send earlier.
1818 * Old pp->next_action_time are on the order
1819 * of t + (1 << old_poll_exp) + small_random,
1820 * we simply need to subtract ~half of that.
1821 */
1822 for (item = G.ntp_peers; item != NULL; item = item->link) {
1823 peer_t *pp = (peer_t *) item->data;
1824 if (pp->p_fd < 0)
1825 pp->next_action_time -= (1 << G.poll_exp);
1826 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001827 VERB3 bb_error_msg("polladj: discipline_jitter:%f --poll_exp=%d",
1828 G.discipline_jitter, G.poll_exp);
1829 }
1830 } else {
1831 VERB3 bb_error_msg("polladj: decr:%d", G.polladj_count);
1832 }
1833 }
1834 }
1835
1836 /* Decide when to send new query for this peer */
Denys Vlasenkod99ef632013-05-22 17:48:19 +02001837 pick_normal_interval:
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001838 interval = poll_interval(0);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001839
Denys Vlasenko4125a6b2012-06-11 11:41:46 +02001840 set_next_and_ret:
Denys Vlasenko4168fdd2010-01-04 00:19:13 +01001841 set_next(p, interval);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001842}
1843
1844#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01001845static NOINLINE void
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001846recv_and_process_client_pkt(void /*int fd*/)
1847{
1848 ssize_t size;
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02001849 //uint8_t version;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001850 len_and_sockaddr *to;
1851 struct sockaddr *from;
1852 msg_t msg;
1853 uint8_t query_status;
1854 l_fixedpt_t query_xmttime;
1855
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001856 to = get_sock_lsa(G_listen_fd);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001857 from = xzalloc(to->len);
1858
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001859 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 +01001860 if (size != NTP_MSGSIZE_NOAUTH && size != NTP_MSGSIZE) {
1861 char *addr;
1862 if (size < 0) {
1863 if (errno == EAGAIN)
1864 goto bail;
1865 bb_perror_msg_and_die("recv");
1866 }
1867 addr = xmalloc_sockaddr2dotted_noport(from);
1868 bb_error_msg("malformed packet received from %s: size %u", addr, (int)size);
1869 free(addr);
1870 goto bail;
1871 }
1872
1873 query_status = msg.m_status;
1874 query_xmttime = msg.m_xmttime;
1875
1876 /* Build a reply packet */
1877 memset(&msg, 0, sizeof(msg));
Paul Marksb7841cf2013-01-14 02:39:10 +01001878 msg.m_status = G.stratum < MAXSTRAT ? (G.ntp_status & LI_MASK) : LI_ALARM;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001879 msg.m_status |= (query_status & VERSION_MASK);
1880 msg.m_status |= ((query_status & MODE_MASK) == MODE_CLIENT) ?
Denys Vlasenko69675782013-01-14 01:34:48 +01001881 MODE_SERVER : MODE_SYM_PAS;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001882 msg.m_stratum = G.stratum;
1883 msg.m_ppoll = G.poll_exp;
1884 msg.m_precision_exp = G_precision_exp;
Denys Vlasenko0b002812010-01-03 08:59:59 +01001885 /* this time was obtained between poll() and recv() */
1886 msg.m_rectime = d_to_lfp(G.cur_time);
1887 msg.m_xmttime = d_to_lfp(gettime1900d()); /* this instant */
Denys Vlasenkod6782572010-10-04 01:20:44 +02001888 if (G.peer_cnt == 0) {
1889 /* we have no peers: "stratum 1 server" mode. reftime = our own time */
1890 G.reftime = G.cur_time;
1891 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001892 msg.m_reftime = d_to_lfp(G.reftime);
1893 msg.m_orgtime = query_xmttime;
1894 msg.m_rootdelay = d_to_sfp(G.rootdelay);
1895//simple code does not do this, fix simple code!
1896 msg.m_rootdisp = d_to_sfp(G.rootdisp);
Cristian Ionescu-Idbohrn662972a2011-05-16 03:53:00 +02001897 //version = (query_status & VERSION_MASK); /* ... >> VERSION_SHIFT - done below instead */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001898 msg.m_refid = G.refid; // (version > (3 << VERSION_SHIFT)) ? G.refid : G.refid3;
1899
1900 /* We reply from the local address packet was sent to,
1901 * this makes to/from look swapped here: */
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02001902 do_sendto(G_listen_fd,
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01001903 /*from:*/ &to->u.sa, /*to:*/ from, /*addrlen:*/ to->len,
1904 &msg, size);
1905
1906 bail:
1907 free(to);
1908 free(from);
1909}
1910#endif
1911
1912/* Upstream ntpd's options:
1913 *
1914 * -4 Force DNS resolution of host names to the IPv4 namespace.
1915 * -6 Force DNS resolution of host names to the IPv6 namespace.
1916 * -a Require cryptographic authentication for broadcast client,
1917 * multicast client and symmetric passive associations.
1918 * This is the default.
1919 * -A Do not require cryptographic authentication for broadcast client,
1920 * multicast client and symmetric passive associations.
1921 * This is almost never a good idea.
1922 * -b Enable the client to synchronize to broadcast servers.
1923 * -c conffile
1924 * Specify the name and path of the configuration file,
1925 * default /etc/ntp.conf
1926 * -d Specify debugging mode. This option may occur more than once,
1927 * with each occurrence indicating greater detail of display.
1928 * -D level
1929 * Specify debugging level directly.
1930 * -f driftfile
1931 * Specify the name and path of the frequency file.
1932 * This is the same operation as the "driftfile FILE"
1933 * configuration command.
1934 * -g Normally, ntpd exits with a message to the system log
1935 * if the offset exceeds the panic threshold, which is 1000 s
1936 * by default. This option allows the time to be set to any value
1937 * without restriction; however, this can happen only once.
1938 * If the threshold is exceeded after that, ntpd will exit
1939 * with a message to the system log. This option can be used
1940 * with the -q and -x options. See the tinker command for other options.
1941 * -i jaildir
1942 * Chroot the server to the directory jaildir. This option also implies
1943 * that the server attempts to drop root privileges at startup
1944 * (otherwise, chroot gives very little additional security).
1945 * You may need to also specify a -u option.
1946 * -k keyfile
1947 * Specify the name and path of the symmetric key file,
1948 * default /etc/ntp/keys. This is the same operation
1949 * as the "keys FILE" configuration command.
1950 * -l logfile
1951 * Specify the name and path of the log file. The default
1952 * is the system log file. This is the same operation as
1953 * the "logfile FILE" configuration command.
1954 * -L Do not listen to virtual IPs. The default is to listen.
1955 * -n Don't fork.
1956 * -N To the extent permitted by the operating system,
1957 * run the ntpd at the highest priority.
1958 * -p pidfile
1959 * Specify the name and path of the file used to record the ntpd
1960 * process ID. This is the same operation as the "pidfile FILE"
1961 * configuration command.
1962 * -P priority
1963 * To the extent permitted by the operating system,
1964 * run the ntpd at the specified priority.
1965 * -q Exit the ntpd just after the first time the clock is set.
1966 * This behavior mimics that of the ntpdate program, which is
1967 * to be retired. The -g and -x options can be used with this option.
1968 * Note: The kernel time discipline is disabled with this option.
1969 * -r broadcastdelay
1970 * Specify the default propagation delay from the broadcast/multicast
1971 * server to this client. This is necessary only if the delay
1972 * cannot be computed automatically by the protocol.
1973 * -s statsdir
1974 * Specify the directory path for files created by the statistics
1975 * facility. This is the same operation as the "statsdir DIR"
1976 * configuration command.
1977 * -t key
1978 * Add a key number to the trusted key list. This option can occur
1979 * more than once.
1980 * -u user[:group]
1981 * Specify a user, and optionally a group, to switch to.
1982 * -v variable
1983 * -V variable
1984 * Add a system variable listed by default.
1985 * -x Normally, the time is slewed if the offset is less than the step
1986 * threshold, which is 128 ms by default, and stepped if above
1987 * the threshold. This option sets the threshold to 600 s, which is
1988 * well within the accuracy window to set the clock manually.
1989 * Note: since the slew rate of typical Unix kernels is limited
1990 * to 0.5 ms/s, each second of adjustment requires an amortization
1991 * interval of 2000 s. Thus, an adjustment as much as 600 s
1992 * will take almost 14 days to complete. This option can be used
1993 * with the -g and -q options. See the tinker command for other options.
1994 * Note: The kernel time discipline is disabled with this option.
1995 */
1996
1997/* By doing init in a separate function we decrease stack usage
1998 * in main loop.
1999 */
2000static NOINLINE void ntp_init(char **argv)
2001{
2002 unsigned opts;
2003 llist_t *peers;
2004
2005 srandom(getpid());
2006
2007 if (getuid())
2008 bb_error_msg_and_die(bb_msg_you_must_be_root);
2009
2010 /* Set some globals */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002011 G.stratum = MAXSTRAT;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002012 if (BURSTPOLL != 0)
2013 G.poll_exp = BURSTPOLL; /* speeds up initial sync */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002014 G.last_script_run = G.reftime = G.last_update_recv_time = gettime1900d(); /* sets G.cur_time too */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002015
2016 /* Parse options */
2017 peers = NULL;
Denys Vlasenko074e8dc2010-01-04 23:58:13 +01002018 opt_complementary = "dd:p::wn"; /* d: counter; p: list; -w implies -n */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002019 opts = getopt32(argv,
2020 "nqNx" /* compat */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002021 "wp:S:"IF_FEATURE_NTPD_SERVER("l") /* NOT compat */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002022 "d" /* compat */
2023 "46aAbgL", /* compat, ignored */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002024 &peers, &G.script_name, &G.verbose);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002025 if (!(opts & (OPT_p|OPT_l)))
2026 bb_show_usage();
2027// if (opts & OPT_x) /* disable stepping, only slew is allowed */
2028// G.time_was_stepped = 1;
Denys Vlasenkod6782572010-10-04 01:20:44 +02002029 if (peers) {
2030 while (peers)
2031 add_peers(llist_pop(&peers));
2032 } else {
2033 /* -l but no peers: "stratum 1 server" mode */
2034 G.stratum = 1;
2035 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002036 if (!(opts & OPT_n)) {
2037 bb_daemonize_or_rexec(DAEMON_DEVNULL_STDIO, argv);
2038 logmode = LOGMODE_NONE;
2039 }
2040#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002041 G_listen_fd = -1;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002042 if (opts & OPT_l) {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002043 G_listen_fd = create_and_bind_dgram_or_die(NULL, 123);
2044 socket_want_pktinfo(G_listen_fd);
2045 setsockopt(G_listen_fd, IPPROTO_IP, IP_TOS, &const_IPTOS_LOWDELAY, sizeof(const_IPTOS_LOWDELAY));
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002046 }
2047#endif
2048 /* I hesitate to set -20 prio. -15 should be high enough for timekeeping */
2049 if (opts & OPT_N)
2050 setpriority(PRIO_PROCESS, 0, -15);
2051
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002052 /* If network is up, syncronization occurs in ~10 seconds.
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002053 * We give "ntpd -q" 10 seconds to get first reply,
2054 * then another 50 seconds to finish syncing.
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002055 *
2056 * I tested ntpd 4.2.6p1 and apparently it never exits
2057 * (will try forever), but it does not feel right.
2058 * The goal of -q is to act like ntpdate: set time
2059 * after a reasonably small period of polling, or fail.
2060 */
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002061 if (opts & OPT_q) {
2062 option_mask32 |= OPT_qq;
2063 alarm(10);
2064 }
Denys Vlasenko74c992a2010-08-27 02:15:01 +02002065
2066 bb_signals(0
2067 | (1 << SIGTERM)
2068 | (1 << SIGINT)
2069 | (1 << SIGALRM)
2070 , record_signo
2071 );
2072 bb_signals(0
2073 | (1 << SIGPIPE)
2074 | (1 << SIGCHLD)
2075 , SIG_IGN
2076 );
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002077}
2078
2079int ntpd_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
2080int ntpd_main(int argc UNUSED_PARAM, char **argv)
2081{
Denys Vlasenko0b002812010-01-03 08:59:59 +01002082#undef G
2083 struct globals G;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002084 struct pollfd *pfd;
2085 peer_t **idx2peer;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002086 unsigned cnt;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002087
Denys Vlasenko0b002812010-01-03 08:59:59 +01002088 memset(&G, 0, sizeof(G));
2089 SET_PTR_TO_GLOBALS(&G);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002090
2091 ntp_init(argv);
2092
Denys Vlasenko0b002812010-01-03 08:59:59 +01002093 /* If ENABLE_FEATURE_NTPD_SERVER, + 1 for listen_fd: */
2094 cnt = G.peer_cnt + ENABLE_FEATURE_NTPD_SERVER;
2095 idx2peer = xzalloc(sizeof(idx2peer[0]) * cnt);
2096 pfd = xzalloc(sizeof(pfd[0]) * cnt);
2097
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002098 /* Countdown: we never sync before we sent INITIAL_SAMPLES+1
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002099 * packets to each peer.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002100 * NB: if some peer is not responding, we may end up sending
2101 * fewer packets to it and more to other peers.
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002102 * NB2: sync usually happens using INITIAL_SAMPLES packets,
Denys Vlasenko65d722b2010-01-11 02:14:04 +01002103 * since last reply does not come back instantaneously.
Denys Vlasenko0b002812010-01-03 08:59:59 +01002104 */
Leonid Lisovskiy894ef602010-10-20 22:36:51 +02002105 cnt = G.peer_cnt * (INITIAL_SAMPLES + 1);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002106
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002107 write_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
2108
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002109 while (!bb_got_signal) {
2110 llist_t *item;
2111 unsigned i, j;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002112 int nfds, timeout;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002113 double nextaction;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002114
2115 /* Nothing between here and poll() blocks for any significant time */
2116
Denys Vlasenko0b002812010-01-03 08:59:59 +01002117 nextaction = G.cur_time + 3600;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002118
2119 i = 0;
2120#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002121 if (G_listen_fd != -1) {
2122 pfd[0].fd = G_listen_fd;
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002123 pfd[0].events = POLLIN;
2124 i++;
2125 }
2126#endif
2127 /* Pass over peer list, send requests, time out on receives */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002128 for (item = G.ntp_peers; item != NULL; item = item->link) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002129 peer_t *p = (peer_t *) item->data;
2130
Denys Vlasenko0b002812010-01-03 08:59:59 +01002131 if (p->next_action_time <= G.cur_time) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002132 if (p->p_fd == -1) {
2133 /* Time to send new req */
Denys Vlasenko0b002812010-01-03 08:59:59 +01002134 if (--cnt == 0) {
2135 G.initial_poll_complete = 1;
2136 }
2137 send_query_to_peer(p);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002138 } else {
2139 /* Timed out waiting for reply */
2140 close(p->p_fd);
2141 p->p_fd = -1;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002142 timeout = poll_interval(-2); /* -2: try a bit sooner */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002143 bb_error_msg("timed out waiting for %s, reach 0x%02x, next query in %us",
Denys Vlasenko0b002812010-01-03 08:59:59 +01002144 p->p_dotted, p->reachable_bits, timeout);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002145 set_next(p, timeout);
2146 }
2147 }
2148
2149 if (p->next_action_time < nextaction)
2150 nextaction = p->next_action_time;
2151
2152 if (p->p_fd >= 0) {
2153 /* Wait for reply from this peer */
2154 pfd[i].fd = p->p_fd;
2155 pfd[i].events = POLLIN;
2156 idx2peer[i] = p;
2157 i++;
2158 }
2159 }
2160
Denys Vlasenko0b002812010-01-03 08:59:59 +01002161 timeout = nextaction - G.cur_time;
2162 if (timeout < 0)
2163 timeout = 0;
2164 timeout++; /* (nextaction - G.cur_time) rounds down, compensating */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002165
2166 /* Here we may block */
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002167 VERB2 {
Denys Vlasenko3e3a8d52012-04-01 16:31:04 +02002168 if (i > (ENABLE_FEATURE_NTPD_SERVER && G_listen_fd != -1)) {
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002169 /* We wait for at least one reply.
2170 * Poll for it, without wasting time for message.
2171 * Since replies often come under 1 second, this also
2172 * reduces clutter in logs.
2173 */
2174 nfds = poll(pfd, i, 1000);
2175 if (nfds != 0)
2176 goto did_poll;
2177 if (--timeout <= 0)
2178 goto did_poll;
2179 }
Denys Vlasenko8be49c32012-03-06 19:16:50 +01002180 bb_error_msg("poll:%us sockets:%u interval:%us", timeout, i, 1 << G.poll_exp);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002181 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002182 nfds = poll(pfd, i, timeout * 1000);
Denys Vlasenkoe8ce2852012-03-03 12:15:46 +01002183 did_poll:
Denys Vlasenko0b002812010-01-03 08:59:59 +01002184 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002185 if (nfds <= 0) {
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002186 if (!bb_got_signal /* poll wasn't interrupted by a signal */
2187 && G.cur_time - G.last_script_run > 11*60
2188 ) {
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002189 /* Useful for updating battery-backed RTC and such */
Denys Vlasenko12628b72010-01-11 01:31:59 +01002190 run_script("periodic", G.last_update_offset);
Denys Vlasenko06667f22010-01-06 13:05:08 +01002191 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002192 }
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002193 goto check_unsync;
Denys Vlasenkoede737b2010-01-06 12:27:47 +01002194 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002195
2196 /* Process any received packets */
2197 j = 0;
2198#if ENABLE_FEATURE_NTPD_SERVER
Denys Vlasenko0b002812010-01-03 08:59:59 +01002199 if (G.listen_fd != -1) {
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002200 if (pfd[0].revents /* & (POLLIN|POLLERR)*/) {
2201 nfds--;
Denys Vlasenko0b002812010-01-03 08:59:59 +01002202 recv_and_process_client_pkt(/*G.listen_fd*/);
2203 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002204 }
2205 j = 1;
2206 }
2207#endif
2208 for (; nfds != 0 && j < i; j++) {
2209 if (pfd[j].revents /* & (POLLIN|POLLERR)*/) {
Denys Vlasenko8e23faf2011-04-07 01:45:20 +02002210 /*
2211 * At init, alarm was set to 10 sec.
2212 * Now we did get a reply.
2213 * Increase timeout to 50 seconds to finish syncing.
2214 */
2215 if (option_mask32 & OPT_qq) {
2216 option_mask32 &= ~OPT_qq;
2217 alarm(50);
2218 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002219 nfds--;
2220 recv_and_process_peer_pkt(idx2peer[j]);
Denys Vlasenko0b002812010-01-03 08:59:59 +01002221 gettime1900d(); /* sets G.cur_time */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002222 }
2223 }
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002224
Denys Vlasenko5ffdd1d2013-05-22 18:16:34 +02002225 check_unsync:
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002226 if (G.ntp_peers && G.stratum != MAXSTRAT) {
2227 for (item = G.ntp_peers; item != NULL; item = item->link) {
2228 peer_t *p = (peer_t *) item->data;
2229 if (p->reachable_bits)
2230 goto have_reachable_peer;
2231 }
2232 /* No peer responded for last 8 packets, panic */
2233 G.polladj_count = 0;
2234 G.poll_exp = MINPOLL;
2235 G.stratum = MAXSTRAT;
Denys Vlasenko5a7e3372013-05-23 16:06:59 +02002236 run_script("unsync", 0.0);
Denys Vlasenkod99ef632013-05-22 17:48:19 +02002237 have_reachable_peer: ;
2238 }
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002239 } /* while (!bb_got_signal) */
2240
Anthony G. Basile12677ac2012-12-10 14:49:39 -05002241 remove_pidfile(CONFIG_PID_FILE_PATH "/ntpd.pid");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002242 kill_myself_with_sig(bb_got_signal);
2243}
2244
2245
2246
2247
2248
2249
2250/*** openntpd-4.6 uses only adjtime, not adjtimex ***/
2251
2252/*** ntp-4.2.6/ntpd/ntp_loopfilter.c - adjtimex usage ***/
2253
2254#if 0
2255static double
2256direct_freq(double fp_offset)
2257{
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002258#ifdef KERNEL_PLL
2259 /*
2260 * If the kernel is enabled, we need the residual offset to
2261 * calculate the frequency correction.
2262 */
2263 if (pll_control && kern_enable) {
2264 memset(&ntv, 0, sizeof(ntv));
2265 ntp_adjtime(&ntv);
2266#ifdef STA_NANO
2267 clock_offset = ntv.offset / 1e9;
2268#else /* STA_NANO */
2269 clock_offset = ntv.offset / 1e6;
2270#endif /* STA_NANO */
2271 drift_comp = FREQTOD(ntv.freq);
2272 }
2273#endif /* KERNEL_PLL */
2274 set_freq((fp_offset - clock_offset) / (current_time - clock_epoch) + drift_comp);
2275 wander_resid = 0;
2276 return drift_comp;
2277}
2278
2279static void
Denys Vlasenkofb132e42010-10-29 11:46:52 +02002280set_freq(double freq) /* frequency update */
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002281{
2282 char tbuf[80];
2283
2284 drift_comp = freq;
2285
2286#ifdef KERNEL_PLL
2287 /*
2288 * If the kernel is enabled, update the kernel frequency.
2289 */
2290 if (pll_control && kern_enable) {
2291 memset(&ntv, 0, sizeof(ntv));
2292 ntv.modes = MOD_FREQUENCY;
2293 ntv.freq = DTOFREQ(drift_comp);
2294 ntp_adjtime(&ntv);
2295 snprintf(tbuf, sizeof(tbuf), "kernel %.3f PPM", drift_comp * 1e6);
2296 report_event(EVNT_FSET, NULL, tbuf);
2297 } else {
2298 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2299 report_event(EVNT_FSET, NULL, tbuf);
2300 }
2301#else /* KERNEL_PLL */
2302 snprintf(tbuf, sizeof(tbuf), "ntpd %.3f PPM", drift_comp * 1e6);
2303 report_event(EVNT_FSET, NULL, tbuf);
2304#endif /* KERNEL_PLL */
2305}
2306
2307...
2308...
2309...
2310
2311#ifdef KERNEL_PLL
2312 /*
2313 * This code segment works when clock adjustments are made using
2314 * precision time kernel support and the ntp_adjtime() system
2315 * call. This support is available in Solaris 2.6 and later,
2316 * Digital Unix 4.0 and later, FreeBSD, Linux and specially
2317 * modified kernels for HP-UX 9 and Ultrix 4. In the case of the
2318 * DECstation 5000/240 and Alpha AXP, additional kernel
2319 * modifications provide a true microsecond clock and nanosecond
2320 * clock, respectively.
2321 *
2322 * Important note: The kernel discipline is used only if the
2323 * step threshold is less than 0.5 s, as anything higher can
2324 * lead to overflow problems. This might occur if some misguided
2325 * lad set the step threshold to something ridiculous.
2326 */
2327 if (pll_control && kern_enable) {
2328
2329#define MOD_BITS (MOD_OFFSET | MOD_MAXERROR | MOD_ESTERROR | MOD_STATUS | MOD_TIMECONST)
2330
2331 /*
2332 * We initialize the structure for the ntp_adjtime()
2333 * system call. We have to convert everything to
2334 * microseconds or nanoseconds first. Do not update the
2335 * system variables if the ext_enable flag is set. In
2336 * this case, the external clock driver will update the
2337 * variables, which will be read later by the local
2338 * clock driver. Afterwards, remember the time and
2339 * frequency offsets for jitter and stability values and
2340 * to update the frequency file.
2341 */
2342 memset(&ntv, 0, sizeof(ntv));
2343 if (ext_enable) {
2344 ntv.modes = MOD_STATUS;
2345 } else {
2346#ifdef STA_NANO
2347 ntv.modes = MOD_BITS | MOD_NANO;
2348#else /* STA_NANO */
2349 ntv.modes = MOD_BITS;
2350#endif /* STA_NANO */
2351 if (clock_offset < 0)
2352 dtemp = -.5;
2353 else
2354 dtemp = .5;
2355#ifdef STA_NANO
2356 ntv.offset = (int32)(clock_offset * 1e9 + dtemp);
2357 ntv.constant = sys_poll;
2358#else /* STA_NANO */
2359 ntv.offset = (int32)(clock_offset * 1e6 + dtemp);
2360 ntv.constant = sys_poll - 4;
2361#endif /* STA_NANO */
2362 ntv.esterror = (u_int32)(clock_jitter * 1e6);
2363 ntv.maxerror = (u_int32)((sys_rootdelay / 2 + sys_rootdisp) * 1e6);
2364 ntv.status = STA_PLL;
2365
2366 /*
2367 * Enable/disable the PPS if requested.
2368 */
2369 if (pps_enable) {
2370 if (!(pll_status & STA_PPSTIME))
2371 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002372 NULL, "PPS enabled");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002373 ntv.status |= STA_PPSTIME | STA_PPSFREQ;
2374 } else {
2375 if (pll_status & STA_PPSTIME)
2376 report_event(EVNT_KERN,
Denys Vlasenko69675782013-01-14 01:34:48 +01002377 NULL, "PPS disabled");
2378 ntv.status &= ~(STA_PPSTIME | STA_PPSFREQ);
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002379 }
2380 if (sys_leap == LEAP_ADDSECOND)
2381 ntv.status |= STA_INS;
2382 else if (sys_leap == LEAP_DELSECOND)
2383 ntv.status |= STA_DEL;
2384 }
2385
2386 /*
2387 * Pass the stuff to the kernel. If it squeals, turn off
2388 * the pps. In any case, fetch the kernel offset,
2389 * frequency and jitter.
2390 */
2391 if (ntp_adjtime(&ntv) == TIME_ERROR) {
2392 if (!(ntv.status & STA_PPSSIGNAL))
2393 report_event(EVNT_KERN, NULL,
Denys Vlasenko69675782013-01-14 01:34:48 +01002394 "PPS no signal");
Denys Vlasenkodd6673b2010-01-01 16:46:17 +01002395 }
2396 pll_status = ntv.status;
2397#ifdef STA_NANO
2398 clock_offset = ntv.offset / 1e9;
2399#else /* STA_NANO */
2400 clock_offset = ntv.offset / 1e6;
2401#endif /* STA_NANO */
2402 clock_frequency = FREQTOD(ntv.freq);
2403
2404 /*
2405 * If the kernel PPS is lit, monitor its performance.
2406 */
2407 if (ntv.status & STA_PPSTIME) {
2408#ifdef STA_NANO
2409 clock_jitter = ntv.jitter / 1e9;
2410#else /* STA_NANO */
2411 clock_jitter = ntv.jitter / 1e6;
2412#endif /* STA_NANO */
2413 }
2414
2415#if defined(STA_NANO) && NTP_API == 4
2416 /*
2417 * If the TAI changes, update the kernel TAI.
2418 */
2419 if (loop_tai != sys_tai) {
2420 loop_tai = sys_tai;
2421 ntv.modes = MOD_TAI;
2422 ntv.constant = sys_tai;
2423 ntp_adjtime(&ntv);
2424 }
2425#endif /* STA_NANO */
2426 }
2427#endif /* KERNEL_PLL */
2428#endif